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::secp256k1;
38 use chain::{Confirm, ChannelMonitorUpdateErr, Watch, BestBlock};
39 use chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator};
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::{ChannelTypeFeatures, InitFeatures, NodeFeatures};
47 use routing::router::{PaymentParameters, Route, RouteHop, RoutePath, RouteParameters};
49 use ln::msgs::NetAddress;
51 use ln::msgs::{ChannelMessageHandler, DecodeError, LightningError, MAX_VALUE_MSAT, OptionalField};
53 use chain::keysinterface::{Sign, KeysInterface, KeysManager, InMemorySigner, Recipient};
54 use util::config::{UserConfig, ChannelConfig};
55 use util::events::{EventHandler, EventsProvider, MessageSendEvent, MessageSendEventsProvider, ClosureReason};
56 use util::{byte_utils, events};
57 use util::scid_utils::fake_scid;
58 use util::ser::{BigSize, FixedLengthReader, Readable, ReadableArgs, MaybeReadable, Writeable, Writer, VecWriter};
59 use util::logger::{Level, Logger};
60 use util::errors::APIError;
65 use core::cell::RefCell;
67 use sync::{Arc, Condvar, Mutex, MutexGuard, RwLock, RwLockReadGuard};
68 use core::sync::atomic::{AtomicUsize, Ordering};
69 use core::time::Duration;
72 #[cfg(any(test, feature = "std"))]
73 use std::time::Instant;
74 use util::crypto::sign;
76 // We hold various information about HTLC relay in the HTLC objects in Channel itself:
78 // Upon receipt of an HTLC from a peer, we'll give it a PendingHTLCStatus indicating if it should
79 // forward the HTLC with information it will give back to us when it does so, or if it should Fail
80 // the HTLC with the relevant message for the Channel to handle giving to the remote peer.
82 // Once said HTLC is committed in the Channel, if the PendingHTLCStatus indicated Forward, the
83 // Channel will return the PendingHTLCInfo back to us, and we will create an HTLCForwardInfo
84 // with it to track where it came from (in case of onwards-forward error), waiting a random delay
85 // before we forward it.
87 // We will then use HTLCForwardInfo's PendingHTLCInfo to construct an outbound HTLC, with a
88 // relevant HTLCSource::PreviousHopData filled in to indicate where it came from (which we can use
89 // to either fail-backwards or fulfill the HTLC backwards along the relevant path).
90 // Alternatively, we can fill an outbound HTLC with a HTLCSource::OutboundRoute indicating this is
91 // our payment, which we can use to decode errors or inform the user that the payment was sent.
93 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
94 pub(super) enum PendingHTLCRouting {
96 onion_packet: msgs::OnionPacket,
97 /// The SCID from the onion that we should forward to. This could be a "real" SCID, an
98 /// outbound SCID alias, or a phantom node SCID.
99 short_channel_id: u64, // This should be NonZero<u64> eventually when we bump MSRV
102 payment_data: msgs::FinalOnionHopData,
103 incoming_cltv_expiry: u32, // Used to track when we should expire pending HTLCs that go unclaimed
104 phantom_shared_secret: Option<[u8; 32]>,
107 payment_preimage: PaymentPreimage,
108 incoming_cltv_expiry: u32, // Used to track when we should expire pending HTLCs that go unclaimed
112 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
113 pub(super) struct PendingHTLCInfo {
114 pub(super) routing: PendingHTLCRouting,
115 pub(super) incoming_shared_secret: [u8; 32],
116 payment_hash: PaymentHash,
117 pub(super) amt_to_forward: u64,
118 pub(super) outgoing_cltv_value: u32,
121 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
122 pub(super) enum HTLCFailureMsg {
123 Relay(msgs::UpdateFailHTLC),
124 Malformed(msgs::UpdateFailMalformedHTLC),
127 /// Stores whether we can't forward an HTLC or relevant forwarding info
128 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
129 pub(super) enum PendingHTLCStatus {
130 Forward(PendingHTLCInfo),
131 Fail(HTLCFailureMsg),
134 pub(super) enum HTLCForwardInfo {
136 forward_info: PendingHTLCInfo,
138 // These fields are produced in `forward_htlcs()` and consumed in
139 // `process_pending_htlc_forwards()` for constructing the
140 // `HTLCSource::PreviousHopData` for failed and forwarded
143 // Note that this may be an outbound SCID alias for the associated channel.
144 prev_short_channel_id: u64,
146 prev_funding_outpoint: OutPoint,
150 err_packet: msgs::OnionErrorPacket,
154 /// Tracks the inbound corresponding to an outbound HTLC
155 #[derive(Clone, Hash, PartialEq, Eq)]
156 pub(crate) struct HTLCPreviousHopData {
157 // Note that this may be an outbound SCID alias for the associated channel.
158 short_channel_id: u64,
160 incoming_packet_shared_secret: [u8; 32],
161 phantom_shared_secret: Option<[u8; 32]>,
163 // This field is consumed by `claim_funds_from_hop()` when updating a force-closed backwards
164 // channel with a preimage provided by the forward channel.
169 /// Indicates this incoming onion payload is for the purpose of paying an invoice.
171 /// This is only here for backwards-compatibility in serialization, in the future it can be
172 /// removed, breaking clients running 0.0.106 and earlier.
173 _legacy_hop_data: Option<msgs::FinalOnionHopData>,
175 /// Contains the payer-provided preimage.
176 Spontaneous(PaymentPreimage),
179 /// HTLCs that are to us and can be failed/claimed by the user
180 struct ClaimableHTLC {
181 prev_hop: HTLCPreviousHopData,
183 /// The amount (in msats) of this MPP part
185 onion_payload: OnionPayload,
187 /// The sum total of all MPP parts
191 /// A payment identifier used to uniquely identify a payment to LDK.
192 /// (C-not exported) as we just use [u8; 32] directly
193 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
194 pub struct PaymentId(pub [u8; 32]);
196 impl Writeable for PaymentId {
197 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
202 impl Readable for PaymentId {
203 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
204 let buf: [u8; 32] = Readable::read(r)?;
208 /// Tracks the inbound corresponding to an outbound HTLC
209 #[allow(clippy::derive_hash_xor_eq)] // Our Hash is faithful to the data, we just don't have SecretKey::hash
210 #[derive(Clone, PartialEq, Eq)]
211 pub(crate) enum HTLCSource {
212 PreviousHopData(HTLCPreviousHopData),
215 session_priv: SecretKey,
216 /// Technically we can recalculate this from the route, but we cache it here to avoid
217 /// doing a double-pass on route when we get a failure back
218 first_hop_htlc_msat: u64,
219 payment_id: PaymentId,
220 payment_secret: Option<PaymentSecret>,
221 payment_params: Option<PaymentParameters>,
224 #[allow(clippy::derive_hash_xor_eq)] // Our Hash is faithful to the data, we just don't have SecretKey::hash
225 impl core::hash::Hash for HTLCSource {
226 fn hash<H: core::hash::Hasher>(&self, hasher: &mut H) {
228 HTLCSource::PreviousHopData(prev_hop_data) => {
230 prev_hop_data.hash(hasher);
232 HTLCSource::OutboundRoute { path, session_priv, payment_id, payment_secret, first_hop_htlc_msat, payment_params } => {
235 session_priv[..].hash(hasher);
236 payment_id.hash(hasher);
237 payment_secret.hash(hasher);
238 first_hop_htlc_msat.hash(hasher);
239 payment_params.hash(hasher);
244 #[cfg(not(feature = "grind_signatures"))]
247 pub fn dummy() -> Self {
248 HTLCSource::OutboundRoute {
250 session_priv: SecretKey::from_slice(&[1; 32]).unwrap(),
251 first_hop_htlc_msat: 0,
252 payment_id: PaymentId([2; 32]),
253 payment_secret: None,
254 payment_params: None,
259 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
260 pub(super) enum HTLCFailReason {
262 err: msgs::OnionErrorPacket,
270 struct ReceiveError {
276 /// Return value for claim_funds_from_hop
277 enum ClaimFundsFromHop {
279 MonitorUpdateFail(PublicKey, MsgHandleErrInternal, Option<u64>),
284 type ShutdownResult = (Option<(OutPoint, ChannelMonitorUpdate)>, Vec<(HTLCSource, PaymentHash)>);
286 /// Error type returned across the channel_state mutex boundary. When an Err is generated for a
287 /// Channel, we generally end up with a ChannelError::Close for which we have to close the channel
288 /// immediately (ie with no further calls on it made). Thus, this step happens inside a
289 /// channel_state lock. We then return the set of things that need to be done outside the lock in
290 /// this struct and call handle_error!() on it.
292 struct MsgHandleErrInternal {
293 err: msgs::LightningError,
294 chan_id: Option<([u8; 32], u64)>, // If Some a channel of ours has been closed
295 shutdown_finish: Option<(ShutdownResult, Option<msgs::ChannelUpdate>)>,
297 impl MsgHandleErrInternal {
299 fn send_err_msg_no_close(err: String, channel_id: [u8; 32]) -> Self {
301 err: LightningError {
303 action: msgs::ErrorAction::SendErrorMessage {
304 msg: msgs::ErrorMessage {
311 shutdown_finish: None,
315 fn ignore_no_close(err: String) -> Self {
317 err: LightningError {
319 action: msgs::ErrorAction::IgnoreError,
322 shutdown_finish: None,
326 fn from_no_close(err: msgs::LightningError) -> Self {
327 Self { err, chan_id: None, shutdown_finish: None }
330 fn from_finish_shutdown(err: String, channel_id: [u8; 32], user_channel_id: u64, shutdown_res: ShutdownResult, channel_update: Option<msgs::ChannelUpdate>) -> Self {
332 err: LightningError {
334 action: msgs::ErrorAction::SendErrorMessage {
335 msg: msgs::ErrorMessage {
341 chan_id: Some((channel_id, user_channel_id)),
342 shutdown_finish: Some((shutdown_res, channel_update)),
346 fn from_chan_no_close(err: ChannelError, channel_id: [u8; 32]) -> Self {
349 ChannelError::Warn(msg) => LightningError {
351 action: msgs::ErrorAction::SendWarningMessage {
352 msg: msgs::WarningMessage {
356 log_level: Level::Warn,
359 ChannelError::Ignore(msg) => LightningError {
361 action: msgs::ErrorAction::IgnoreError,
363 ChannelError::Close(msg) => LightningError {
365 action: msgs::ErrorAction::SendErrorMessage {
366 msg: msgs::ErrorMessage {
374 shutdown_finish: None,
379 /// We hold back HTLCs we intend to relay for a random interval greater than this (see
380 /// Event::PendingHTLCsForwardable for the API guidelines indicating how long should be waited).
381 /// This provides some limited amount of privacy. Ideally this would range from somewhere like one
382 /// second to 30 seconds, but people expect lightning to be, you know, kinda fast, sadly.
383 const MIN_HTLC_RELAY_HOLDING_CELL_MILLIS: u64 = 100;
385 /// For events which result in both a RevokeAndACK and a CommitmentUpdate, by default they should
386 /// be sent in the order they appear in the return value, however sometimes the order needs to be
387 /// variable at runtime (eg Channel::channel_reestablish needs to re-send messages in the order
388 /// they were originally sent). In those cases, this enum is also returned.
389 #[derive(Clone, PartialEq)]
390 pub(super) enum RAACommitmentOrder {
391 /// Send the CommitmentUpdate messages first
393 /// Send the RevokeAndACK message first
397 // Note this is only exposed in cfg(test):
398 pub(super) struct ChannelHolder<Signer: Sign> {
399 pub(super) by_id: HashMap<[u8; 32], Channel<Signer>>,
400 /// SCIDs (and outbound SCID aliases) -> `counterparty_node_id`s and `channel_id`s.
402 /// Outbound SCID aliases are added here once the channel is available for normal use, with
403 /// SCIDs being added once the funding transaction is confirmed at the channel's required
404 /// confirmation depth.
405 pub(super) short_to_chan_info: HashMap<u64, (PublicKey, [u8; 32])>,
406 /// SCID/SCID Alias -> forward infos. Key of 0 means payments received.
408 /// Note that because we may have an SCID Alias as the key we can have two entries per channel,
409 /// though in practice we probably won't be receiving HTLCs for a channel both via the alias
410 /// and via the classic SCID.
412 /// Note that while this is held in the same mutex as the channels themselves, no consistency
413 /// guarantees are made about the existence of a channel with the short id here, nor the short
414 /// ids in the PendingHTLCInfo!
415 pub(super) forward_htlcs: HashMap<u64, Vec<HTLCForwardInfo>>,
416 /// Map from payment hash to the payment data and any HTLCs which are to us and can be
417 /// failed/claimed by the user.
419 /// Note that while this is held in the same mutex as the channels themselves, no consistency
420 /// guarantees are made about the channels given here actually existing anymore by the time you
422 claimable_htlcs: HashMap<PaymentHash, (events::PaymentPurpose, Vec<ClaimableHTLC>)>,
423 /// Messages to send to peers - pushed to in the same lock that they are generated in (except
424 /// for broadcast messages, where ordering isn't as strict).
425 pub(super) pending_msg_events: Vec<MessageSendEvent>,
428 /// Events which we process internally but cannot be procsesed immediately at the generation site
429 /// for some reason. They are handled in timer_tick_occurred, so may be processed with
430 /// quite some time lag.
431 enum BackgroundEvent {
432 /// Handle a ChannelMonitorUpdate that closes a channel, broadcasting its current latest holder
433 /// commitment transaction.
434 ClosingMonitorUpdate((OutPoint, ChannelMonitorUpdate)),
437 /// State we hold per-peer. In the future we should put channels in here, but for now we only hold
438 /// the latest Init features we heard from the peer.
440 latest_features: InitFeatures,
443 /// Stores a PaymentSecret and any other data we may need to validate an inbound payment is
444 /// actually ours and not some duplicate HTLC sent to us by a node along the route.
446 /// For users who don't want to bother doing their own payment preimage storage, we also store that
449 /// Note that this struct will be removed entirely soon, in favor of storing no inbound payment data
450 /// and instead encoding it in the payment secret.
451 struct PendingInboundPayment {
452 /// The payment secret that the sender must use for us to accept this payment
453 payment_secret: PaymentSecret,
454 /// Time at which this HTLC expires - blocks with a header time above this value will result in
455 /// this payment being removed.
457 /// Arbitrary identifier the user specifies (or not)
458 user_payment_id: u64,
459 // Other required attributes of the payment, optionally enforced:
460 payment_preimage: Option<PaymentPreimage>,
461 min_value_msat: Option<u64>,
464 /// Stores the session_priv for each part of a payment that is still pending. For versions 0.0.102
465 /// and later, also stores information for retrying the payment.
466 pub(crate) enum PendingOutboundPayment {
468 session_privs: HashSet<[u8; 32]>,
471 session_privs: HashSet<[u8; 32]>,
472 payment_hash: PaymentHash,
473 payment_secret: Option<PaymentSecret>,
474 pending_amt_msat: u64,
475 /// Used to track the fee paid. Only present if the payment was serialized on 0.0.103+.
476 pending_fee_msat: Option<u64>,
477 /// The total payment amount across all paths, used to verify that a retry is not overpaying.
479 /// Our best known block height at the time this payment was initiated.
480 starting_block_height: u32,
482 /// When a pending payment is fulfilled, we continue tracking it until all pending HTLCs have
483 /// been resolved. This ensures we don't look up pending payments in ChannelMonitors on restart
484 /// and add a pending payment that was already fulfilled.
486 session_privs: HashSet<[u8; 32]>,
487 payment_hash: Option<PaymentHash>,
489 /// When a payer gives up trying to retry a payment, they inform us, letting us generate a
490 /// `PaymentFailed` event when all HTLCs have irrevocably failed. This avoids a number of race
491 /// conditions in MPP-aware payment retriers (1), where the possibility of multiple
492 /// `PaymentPathFailed` events with `all_paths_failed` can be pending at once, confusing a
493 /// downstream event handler as to when a payment has actually failed.
495 /// (1) https://github.com/lightningdevkit/rust-lightning/issues/1164
497 session_privs: HashSet<[u8; 32]>,
498 payment_hash: PaymentHash,
502 impl PendingOutboundPayment {
503 fn is_retryable(&self) -> bool {
505 PendingOutboundPayment::Retryable { .. } => true,
509 fn is_fulfilled(&self) -> bool {
511 PendingOutboundPayment::Fulfilled { .. } => true,
515 fn abandoned(&self) -> bool {
517 PendingOutboundPayment::Abandoned { .. } => true,
521 fn get_pending_fee_msat(&self) -> Option<u64> {
523 PendingOutboundPayment::Retryable { pending_fee_msat, .. } => pending_fee_msat.clone(),
528 fn payment_hash(&self) -> Option<PaymentHash> {
530 PendingOutboundPayment::Legacy { .. } => None,
531 PendingOutboundPayment::Retryable { payment_hash, .. } => Some(*payment_hash),
532 PendingOutboundPayment::Fulfilled { payment_hash, .. } => *payment_hash,
533 PendingOutboundPayment::Abandoned { payment_hash, .. } => Some(*payment_hash),
537 fn mark_fulfilled(&mut self) {
538 let mut session_privs = HashSet::new();
539 core::mem::swap(&mut session_privs, match self {
540 PendingOutboundPayment::Legacy { session_privs } |
541 PendingOutboundPayment::Retryable { session_privs, .. } |
542 PendingOutboundPayment::Fulfilled { session_privs, .. } |
543 PendingOutboundPayment::Abandoned { session_privs, .. }
546 let payment_hash = self.payment_hash();
547 *self = PendingOutboundPayment::Fulfilled { session_privs, payment_hash };
550 fn mark_abandoned(&mut self) -> Result<(), ()> {
551 let mut session_privs = HashSet::new();
552 let our_payment_hash;
553 core::mem::swap(&mut session_privs, match self {
554 PendingOutboundPayment::Legacy { .. } |
555 PendingOutboundPayment::Fulfilled { .. } =>
557 PendingOutboundPayment::Retryable { session_privs, payment_hash, .. } |
558 PendingOutboundPayment::Abandoned { session_privs, payment_hash, .. } => {
559 our_payment_hash = *payment_hash;
563 *self = PendingOutboundPayment::Abandoned { session_privs, payment_hash: our_payment_hash };
567 /// panics if path is None and !self.is_fulfilled
568 fn remove(&mut self, session_priv: &[u8; 32], path: Option<&Vec<RouteHop>>) -> bool {
569 let remove_res = match self {
570 PendingOutboundPayment::Legacy { session_privs } |
571 PendingOutboundPayment::Retryable { session_privs, .. } |
572 PendingOutboundPayment::Fulfilled { session_privs, .. } |
573 PendingOutboundPayment::Abandoned { session_privs, .. } => {
574 session_privs.remove(session_priv)
578 if let PendingOutboundPayment::Retryable { ref mut pending_amt_msat, ref mut pending_fee_msat, .. } = self {
579 let path = path.expect("Fulfilling a payment should always come with a path");
580 let path_last_hop = path.last().expect("Outbound payments must have had a valid path");
581 *pending_amt_msat -= path_last_hop.fee_msat;
582 if let Some(fee_msat) = pending_fee_msat.as_mut() {
583 *fee_msat -= path.get_path_fees();
590 fn insert(&mut self, session_priv: [u8; 32], path: &Vec<RouteHop>) -> bool {
591 let insert_res = match self {
592 PendingOutboundPayment::Legacy { session_privs } |
593 PendingOutboundPayment::Retryable { session_privs, .. } => {
594 session_privs.insert(session_priv)
596 PendingOutboundPayment::Fulfilled { .. } => false,
597 PendingOutboundPayment::Abandoned { .. } => false,
600 if let PendingOutboundPayment::Retryable { ref mut pending_amt_msat, ref mut pending_fee_msat, .. } = self {
601 let path_last_hop = path.last().expect("Outbound payments must have had a valid path");
602 *pending_amt_msat += path_last_hop.fee_msat;
603 if let Some(fee_msat) = pending_fee_msat.as_mut() {
604 *fee_msat += path.get_path_fees();
611 fn remaining_parts(&self) -> usize {
613 PendingOutboundPayment::Legacy { session_privs } |
614 PendingOutboundPayment::Retryable { session_privs, .. } |
615 PendingOutboundPayment::Fulfilled { session_privs, .. } |
616 PendingOutboundPayment::Abandoned { session_privs, .. } => {
623 /// SimpleArcChannelManager is useful when you need a ChannelManager with a static lifetime, e.g.
624 /// when you're using lightning-net-tokio (since tokio::spawn requires parameters with static
625 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
626 /// SimpleRefChannelManager is the more appropriate type. Defining these type aliases prevents
627 /// issues such as overly long function definitions. Note that the ChannelManager can take any
628 /// type that implements KeysInterface for its keys manager, but this type alias chooses the
629 /// concrete type of the KeysManager.
631 /// (C-not exported) as Arcs don't make sense in bindings
632 pub type SimpleArcChannelManager<M, T, F, L> = ChannelManager<InMemorySigner, Arc<M>, Arc<T>, Arc<KeysManager>, Arc<F>, Arc<L>>;
634 /// SimpleRefChannelManager is a type alias for a ChannelManager reference, and is the reference
635 /// counterpart to the SimpleArcChannelManager type alias. Use this type by default when you don't
636 /// need a ChannelManager with a static lifetime. You'll need a static lifetime in cases such as
637 /// usage of lightning-net-tokio (since tokio::spawn requires parameters with static lifetimes).
638 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
639 /// helps with issues such as long function definitions. Note that the ChannelManager can take any
640 /// type that implements KeysInterface for its keys manager, but this type alias chooses the
641 /// concrete type of the KeysManager.
643 /// (C-not exported) as Arcs don't make sense in bindings
644 pub type SimpleRefChannelManager<'a, 'b, 'c, 'd, 'e, M, T, F, L> = ChannelManager<InMemorySigner, &'a M, &'b T, &'c KeysManager, &'d F, &'e L>;
646 /// Manager which keeps track of a number of channels and sends messages to the appropriate
647 /// channel, also tracking HTLC preimages and forwarding onion packets appropriately.
649 /// Implements ChannelMessageHandler, handling the multi-channel parts and passing things through
650 /// to individual Channels.
652 /// Implements Writeable to write out all channel state to disk. Implies peer_disconnected() for
653 /// all peers during write/read (though does not modify this instance, only the instance being
654 /// serialized). This will result in any channels which have not yet exchanged funding_created (ie
655 /// called funding_transaction_generated for outbound channels).
657 /// Note that you can be a bit lazier about writing out ChannelManager than you can be with
658 /// ChannelMonitors. With ChannelMonitors you MUST write each monitor update out to disk before
659 /// returning from chain::Watch::watch_/update_channel, with ChannelManagers, writing updates
660 /// happens out-of-band (and will prevent any other ChannelManager operations from occurring during
661 /// the serialization process). If the deserialized version is out-of-date compared to the
662 /// ChannelMonitors passed by reference to read(), those channels will be force-closed based on the
663 /// ChannelMonitor state and no funds will be lost (mod on-chain transaction fees).
665 /// Note that the deserializer is only implemented for (BlockHash, ChannelManager), which
666 /// tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
667 /// the "reorg path" (ie call block_disconnected() until you get to a common block and then call
668 /// block_connected() to step towards your best block) upon deserialization before using the
671 /// Note that ChannelManager is responsible for tracking liveness of its channels and generating
672 /// ChannelUpdate messages informing peers that the channel is temporarily disabled. To avoid
673 /// spam due to quick disconnection/reconnection, updates are not sent until the channel has been
674 /// offline for a full minute. In order to track this, you must call
675 /// timer_tick_occurred roughly once per minute, though it doesn't have to be perfect.
677 /// Rather than using a plain ChannelManager, it is preferable to use either a SimpleArcChannelManager
678 /// a SimpleRefChannelManager, for conciseness. See their documentation for more details, but
679 /// essentially you should default to using a SimpleRefChannelManager, and use a
680 /// SimpleArcChannelManager when you require a ChannelManager with a static lifetime, such as when
681 /// you're using lightning-net-tokio.
682 pub struct ChannelManager<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
683 where M::Target: chain::Watch<Signer>,
684 T::Target: BroadcasterInterface,
685 K::Target: KeysInterface<Signer = Signer>,
686 F::Target: FeeEstimator,
689 default_configuration: UserConfig,
690 genesis_hash: BlockHash,
696 pub(super) best_block: RwLock<BestBlock>,
698 best_block: RwLock<BestBlock>,
699 secp_ctx: Secp256k1<secp256k1::All>,
701 #[cfg(any(test, feature = "_test_utils"))]
702 pub(super) channel_state: Mutex<ChannelHolder<Signer>>,
703 #[cfg(not(any(test, feature = "_test_utils")))]
704 channel_state: Mutex<ChannelHolder<Signer>>,
706 /// Storage for PaymentSecrets and any requirements on future inbound payments before we will
707 /// expose them to users via a PaymentReceived event. HTLCs which do not meet the requirements
708 /// here are failed when we process them as pending-forwardable-HTLCs, and entries are removed
709 /// after we generate a PaymentReceived upon receipt of all MPP parts or when they time out.
710 /// Locked *after* channel_state.
711 pending_inbound_payments: Mutex<HashMap<PaymentHash, PendingInboundPayment>>,
713 /// The session_priv bytes and retry metadata of outbound payments which are pending resolution.
714 /// The authoritative state of these HTLCs resides either within Channels or ChannelMonitors
715 /// (if the channel has been force-closed), however we track them here to prevent duplicative
716 /// PaymentSent/PaymentPathFailed events. Specifically, in the case of a duplicative
717 /// update_fulfill_htlc message after a reconnect, we may "claim" a payment twice.
718 /// Additionally, because ChannelMonitors are often not re-serialized after connecting block(s)
719 /// which may generate a claim event, we may receive similar duplicate claim/fail MonitorEvents
720 /// after reloading from disk while replaying blocks against ChannelMonitors.
722 /// See `PendingOutboundPayment` documentation for more info.
724 /// Locked *after* channel_state.
725 pending_outbound_payments: Mutex<HashMap<PaymentId, PendingOutboundPayment>>,
727 /// The set of outbound SCID aliases across all our channels, including unconfirmed channels
728 /// and some closed channels which reached a usable state prior to being closed. This is used
729 /// only to avoid duplicates, and is not persisted explicitly to disk, but rebuilt from the
730 /// active channel list on load.
731 outbound_scid_aliases: Mutex<HashSet<u64>>,
733 our_network_key: SecretKey,
734 our_network_pubkey: PublicKey,
736 inbound_payment_key: inbound_payment::ExpandedKey,
738 /// LDK puts the [fake scids] that it generates into namespaces, to identify the type of an
739 /// incoming payment. To make it harder for a third-party to identify the type of a payment,
740 /// we encrypt the namespace identifier using these bytes.
742 /// [fake scids]: crate::util::scid_utils::fake_scid
743 fake_scid_rand_bytes: [u8; 32],
745 /// Used to track the last value sent in a node_announcement "timestamp" field. We ensure this
746 /// value increases strictly since we don't assume access to a time source.
747 last_node_announcement_serial: AtomicUsize,
749 /// The highest block timestamp we've seen, which is usually a good guess at the current time.
750 /// Assuming most miners are generating blocks with reasonable timestamps, this shouldn't be
751 /// very far in the past, and can only ever be up to two hours in the future.
752 highest_seen_timestamp: AtomicUsize,
754 /// The bulk of our storage will eventually be here (channels and message queues and the like).
755 /// If we are connected to a peer we always at least have an entry here, even if no channels
756 /// are currently open with that peer.
757 /// Because adding or removing an entry is rare, we usually take an outer read lock and then
758 /// operate on the inner value freely. Sadly, this prevents parallel operation when opening a
761 /// If also holding `channel_state` lock, must lock `channel_state` prior to `per_peer_state`.
762 per_peer_state: RwLock<HashMap<PublicKey, Mutex<PeerState>>>,
764 pending_events: Mutex<Vec<events::Event>>,
765 pending_background_events: Mutex<Vec<BackgroundEvent>>,
766 /// Used when we have to take a BIG lock to make sure everything is self-consistent.
767 /// Essentially just when we're serializing ourselves out.
768 /// Taken first everywhere where we are making changes before any other locks.
769 /// When acquiring this lock in read mode, rather than acquiring it directly, call
770 /// `PersistenceNotifierGuard::notify_on_drop(..)` and pass the lock to it, to ensure the
771 /// PersistenceNotifier the lock contains sends out a notification when the lock is released.
772 total_consistency_lock: RwLock<()>,
774 persistence_notifier: PersistenceNotifier,
781 /// Chain-related parameters used to construct a new `ChannelManager`.
783 /// Typically, the block-specific parameters are derived from the best block hash for the network,
784 /// as a newly constructed `ChannelManager` will not have created any channels yet. These parameters
785 /// are not needed when deserializing a previously constructed `ChannelManager`.
786 #[derive(Clone, Copy, PartialEq)]
787 pub struct ChainParameters {
788 /// The network for determining the `chain_hash` in Lightning messages.
789 pub network: Network,
791 /// The hash and height of the latest block successfully connected.
793 /// Used to track on-chain channel funding outputs and send payments with reliable timelocks.
794 pub best_block: BestBlock,
797 #[derive(Copy, Clone, PartialEq)]
803 /// Whenever we release the `ChannelManager`'s `total_consistency_lock`, from read mode, it is
804 /// desirable to notify any listeners on `await_persistable_update_timeout`/
805 /// `await_persistable_update` when new updates are available for persistence. Therefore, this
806 /// struct is responsible for locking the total consistency lock and, upon going out of scope,
807 /// sending the aforementioned notification (since the lock being released indicates that the
808 /// updates are ready for persistence).
810 /// We allow callers to either always notify by constructing with `notify_on_drop` or choose to
811 /// notify or not based on whether relevant changes have been made, providing a closure to
812 /// `optionally_notify` which returns a `NotifyOption`.
813 struct PersistenceNotifierGuard<'a, F: Fn() -> NotifyOption> {
814 persistence_notifier: &'a PersistenceNotifier,
816 // We hold onto this result so the lock doesn't get released immediately.
817 _read_guard: RwLockReadGuard<'a, ()>,
820 impl<'a> PersistenceNotifierGuard<'a, fn() -> NotifyOption> { // We don't care what the concrete F is here, it's unused
821 fn notify_on_drop(lock: &'a RwLock<()>, notifier: &'a PersistenceNotifier) -> PersistenceNotifierGuard<'a, impl Fn() -> NotifyOption> {
822 PersistenceNotifierGuard::optionally_notify(lock, notifier, || -> NotifyOption { NotifyOption::DoPersist })
825 fn optionally_notify<F: Fn() -> NotifyOption>(lock: &'a RwLock<()>, notifier: &'a PersistenceNotifier, persist_check: F) -> PersistenceNotifierGuard<'a, F> {
826 let read_guard = lock.read().unwrap();
828 PersistenceNotifierGuard {
829 persistence_notifier: notifier,
830 should_persist: persist_check,
831 _read_guard: read_guard,
836 impl<'a, F: Fn() -> NotifyOption> Drop for PersistenceNotifierGuard<'a, F> {
838 if (self.should_persist)() == NotifyOption::DoPersist {
839 self.persistence_notifier.notify();
844 /// The amount of time in blocks we require our counterparty wait to claim their money (ie time
845 /// between when we, or our watchtower, must check for them having broadcast a theft transaction).
847 /// This can be increased (but not decreased) through [`ChannelHandshakeConfig::our_to_self_delay`]
849 /// [`ChannelHandshakeConfig::our_to_self_delay`]: crate::util::config::ChannelHandshakeConfig::our_to_self_delay
850 pub const BREAKDOWN_TIMEOUT: u16 = 6 * 24;
851 /// The amount of time in blocks we're willing to wait to claim money back to us. This matches
852 /// the maximum required amount in lnd as of March 2021.
853 pub(crate) const MAX_LOCAL_BREAKDOWN_TIMEOUT: u16 = 2 * 6 * 24 * 7;
855 /// The minimum number of blocks between an inbound HTLC's CLTV and the corresponding outbound
856 /// HTLC's CLTV. The current default represents roughly seven hours of blocks at six blocks/hour.
858 /// This can be increased (but not decreased) through [`ChannelConfig::cltv_expiry_delta`]
860 /// [`ChannelConfig::cltv_expiry_delta`]: crate::util::config::ChannelConfig::cltv_expiry_delta
861 // This should always be a few blocks greater than channelmonitor::CLTV_CLAIM_BUFFER,
862 // i.e. the node we forwarded the payment on to should always have enough room to reliably time out
863 // the HTLC via a full update_fail_htlc/commitment_signed dance before we hit the
864 // CLTV_CLAIM_BUFFER point (we static assert that it's at least 3 blocks more).
865 pub const MIN_CLTV_EXPIRY_DELTA: u16 = 6*7;
866 // This should be long enough to allow a payment path drawn across multiple routing hops with substantial
867 // `cltv_expiry_delta`. Indeed, the length of those values is the reaction delay offered to a routing node
868 // in case of HTLC on-chain settlement. While appearing less competitive, a node operator could decide to
869 // scale them up to suit its security policy. At the network-level, we shouldn't constrain them too much,
870 // while avoiding to introduce a DoS vector. Further, a low CTLV_FAR_FAR_AWAY could be a source of
871 // routing failure for any HTLC sender picking up an LDK node among the first hops.
872 pub(super) const CLTV_FAR_FAR_AWAY: u32 = 14 * 24 * 6;
874 /// Minimum CLTV difference between the current block height and received inbound payments.
875 /// Invoices generated for payment to us must set their `min_final_cltv_expiry` field to at least
877 // Note that we fail if exactly HTLC_FAIL_BACK_BUFFER + 1 was used, so we need to add one for
878 // any payments to succeed. Further, we don't want payments to fail if a block was found while
879 // a payment was being routed, so we add an extra block to be safe.
880 pub const MIN_FINAL_CLTV_EXPIRY: u32 = HTLC_FAIL_BACK_BUFFER + 3;
882 // Check that our CLTV_EXPIRY is at least CLTV_CLAIM_BUFFER + ANTI_REORG_DELAY + LATENCY_GRACE_PERIOD_BLOCKS,
883 // ie that if the next-hop peer fails the HTLC within
884 // LATENCY_GRACE_PERIOD_BLOCKS then we'll still have CLTV_CLAIM_BUFFER left to timeout it onchain,
885 // then waiting ANTI_REORG_DELAY to be reorg-safe on the outbound HLTC and
886 // failing the corresponding htlc backward, and us now seeing the last block of ANTI_REORG_DELAY before
887 // LATENCY_GRACE_PERIOD_BLOCKS.
890 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;
892 // Check for ability of an attacker to make us fail on-chain by delaying an HTLC claim. See
893 // ChannelMonitor::should_broadcast_holder_commitment_txn for a description of why this is needed.
896 const CHECK_CLTV_EXPIRY_SANITY_2: u32 = MIN_CLTV_EXPIRY_DELTA as u32 - LATENCY_GRACE_PERIOD_BLOCKS - 2*CLTV_CLAIM_BUFFER;
898 /// The number of blocks before we consider an outbound payment for expiry if it doesn't have any
899 /// pending HTLCs in flight.
900 pub(crate) const PAYMENT_EXPIRY_BLOCKS: u32 = 3;
902 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] until expiry of incomplete MPPs
903 pub(crate) const MPP_TIMEOUT_TICKS: u8 = 3;
905 /// Information needed for constructing an invoice route hint for this channel.
906 #[derive(Clone, Debug, PartialEq)]
907 pub struct CounterpartyForwardingInfo {
908 /// Base routing fee in millisatoshis.
909 pub fee_base_msat: u32,
910 /// Amount in millionths of a satoshi the channel will charge per transferred satoshi.
911 pub fee_proportional_millionths: u32,
912 /// The minimum difference in cltv_expiry between an ingoing HTLC and its outgoing counterpart,
913 /// such that the outgoing HTLC is forwardable to this counterparty. See `msgs::ChannelUpdate`'s
914 /// `cltv_expiry_delta` for more details.
915 pub cltv_expiry_delta: u16,
918 /// Channel parameters which apply to our counterparty. These are split out from [`ChannelDetails`]
919 /// to better separate parameters.
920 #[derive(Clone, Debug, PartialEq)]
921 pub struct ChannelCounterparty {
922 /// The node_id of our counterparty
923 pub node_id: PublicKey,
924 /// The Features the channel counterparty provided upon last connection.
925 /// Useful for routing as it is the most up-to-date copy of the counterparty's features and
926 /// many routing-relevant features are present in the init context.
927 pub features: InitFeatures,
928 /// The value, in satoshis, that must always be held in the channel for our counterparty. This
929 /// value ensures that if our counterparty broadcasts a revoked state, we can punish them by
930 /// claiming at least this value on chain.
932 /// This value is not included in [`inbound_capacity_msat`] as it can never be spent.
934 /// [`inbound_capacity_msat`]: ChannelDetails::inbound_capacity_msat
935 pub unspendable_punishment_reserve: u64,
936 /// Information on the fees and requirements that the counterparty requires when forwarding
937 /// payments to us through this channel.
938 pub forwarding_info: Option<CounterpartyForwardingInfo>,
939 /// The smallest value HTLC (in msat) the remote peer will accept, for this channel. This field
940 /// is only `None` before we have received either the `OpenChannel` or `AcceptChannel` message
941 /// from the remote peer, or for `ChannelCounterparty` objects serialized prior to LDK 0.0.107.
942 pub outbound_htlc_minimum_msat: Option<u64>,
943 /// The largest value HTLC (in msat) the remote peer currently will accept, for this channel.
944 pub outbound_htlc_maximum_msat: Option<u64>,
947 /// Details of a channel, as returned by ChannelManager::list_channels and ChannelManager::list_usable_channels
948 #[derive(Clone, Debug, PartialEq)]
949 pub struct ChannelDetails {
950 /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
951 /// thereafter this is the txid of the funding transaction xor the funding transaction output).
952 /// Note that this means this value is *not* persistent - it can change once during the
953 /// lifetime of the channel.
954 pub channel_id: [u8; 32],
955 /// Parameters which apply to our counterparty. See individual fields for more information.
956 pub counterparty: ChannelCounterparty,
957 /// The Channel's funding transaction output, if we've negotiated the funding transaction with
958 /// our counterparty already.
960 /// Note that, if this has been set, `channel_id` will be equivalent to
961 /// `funding_txo.unwrap().to_channel_id()`.
962 pub funding_txo: Option<OutPoint>,
963 /// The features which this channel operates with. See individual features for more info.
965 /// `None` until negotiation completes and the channel type is finalized.
966 pub channel_type: Option<ChannelTypeFeatures>,
967 /// The position of the funding transaction in the chain. None if the funding transaction has
968 /// not yet been confirmed and the channel fully opened.
970 /// Note that if [`inbound_scid_alias`] is set, it must be used for invoices and inbound
971 /// payments instead of this. See [`get_inbound_payment_scid`].
973 /// For channels with [`confirmations_required`] set to `Some(0)`, [`outbound_scid_alias`] may
974 /// be used in place of this in outbound routes. See [`get_outbound_payment_scid`].
976 /// [`inbound_scid_alias`]: Self::inbound_scid_alias
977 /// [`outbound_scid_alias`]: Self::outbound_scid_alias
978 /// [`get_inbound_payment_scid`]: Self::get_inbound_payment_scid
979 /// [`get_outbound_payment_scid`]: Self::get_outbound_payment_scid
980 /// [`confirmations_required`]: Self::confirmations_required
981 pub short_channel_id: Option<u64>,
982 /// An optional [`short_channel_id`] alias for this channel, randomly generated by us and
983 /// usable in place of [`short_channel_id`] to reference the channel in outbound routes when
984 /// the channel has not yet been confirmed (as long as [`confirmations_required`] is
987 /// This will be `None` as long as the channel is not available for routing outbound payments.
989 /// [`short_channel_id`]: Self::short_channel_id
990 /// [`confirmations_required`]: Self::confirmations_required
991 pub outbound_scid_alias: Option<u64>,
992 /// An optional [`short_channel_id`] alias for this channel, randomly generated by our
993 /// counterparty and usable in place of [`short_channel_id`] in invoice route hints. Our
994 /// counterparty will recognize the alias provided here in place of the [`short_channel_id`]
995 /// when they see a payment to be routed to us.
997 /// Our counterparty may choose to rotate this value at any time, though will always recognize
998 /// previous values for inbound payment forwarding.
1000 /// [`short_channel_id`]: Self::short_channel_id
1001 pub inbound_scid_alias: Option<u64>,
1002 /// The value, in satoshis, of this channel as appears in the funding output
1003 pub channel_value_satoshis: u64,
1004 /// The value, in satoshis, that must always be held in the channel for us. This value ensures
1005 /// that if we broadcast a revoked state, our counterparty can punish us by claiming at least
1006 /// this value on chain.
1008 /// This value is not included in [`outbound_capacity_msat`] as it can never be spent.
1010 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1012 /// [`outbound_capacity_msat`]: ChannelDetails::outbound_capacity_msat
1013 pub unspendable_punishment_reserve: Option<u64>,
1014 /// The `user_channel_id` passed in to create_channel, or 0 if the channel was inbound.
1015 pub user_channel_id: u64,
1016 /// Our total balance. This is the amount we would get if we close the channel.
1017 /// This value is not exact. Due to various in-flight changes and feerate changes, exactly this
1018 /// amount is not likely to be recoverable on close.
1020 /// This does not include any pending HTLCs which are not yet fully resolved (and, thus, whose
1021 /// balance is not available for inclusion in new outbound HTLCs). This further does not include
1022 /// any pending outgoing HTLCs which are awaiting some other resolution to be sent.
1023 /// This does not consider any on-chain fees.
1025 /// See also [`ChannelDetails::outbound_capacity_msat`]
1026 pub balance_msat: u64,
1027 /// The available outbound capacity for sending HTLCs to the remote peer. This does not include
1028 /// any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1029 /// available for inclusion in new outbound HTLCs). This further does not include any pending
1030 /// outgoing HTLCs which are awaiting some other resolution to be sent.
1032 /// See also [`ChannelDetails::balance_msat`]
1034 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1035 /// conflict-avoidance policy, exactly this amount is not likely to be spendable. However, we
1036 /// should be able to spend nearly this amount.
1037 pub outbound_capacity_msat: u64,
1038 /// The available outbound capacity for sending a single HTLC to the remote peer. This is
1039 /// similar to [`ChannelDetails::outbound_capacity_msat`] but it may be further restricted by
1040 /// the current state and per-HTLC limit(s). This is intended for use when routing, allowing us
1041 /// to use a limit as close as possible to the HTLC limit we can currently send.
1043 /// See also [`ChannelDetails::balance_msat`] and [`ChannelDetails::outbound_capacity_msat`].
1044 pub next_outbound_htlc_limit_msat: u64,
1045 /// The available inbound capacity for the remote peer to send HTLCs to us. This does not
1046 /// include any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1047 /// available for inclusion in new inbound HTLCs).
1048 /// Note that there are some corner cases not fully handled here, so the actual available
1049 /// inbound capacity may be slightly higher than this.
1051 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1052 /// counterparty's conflict-avoidance policy, exactly this amount is not likely to be spendable.
1053 /// However, our counterparty should be able to spend nearly this amount.
1054 pub inbound_capacity_msat: u64,
1055 /// The number of required confirmations on the funding transaction before the funding will be
1056 /// considered "locked". This number is selected by the channel fundee (i.e. us if
1057 /// [`is_outbound`] is *not* set), and can be selected for inbound channels with
1058 /// [`ChannelHandshakeConfig::minimum_depth`] or limited for outbound channels with
1059 /// [`ChannelHandshakeLimits::max_minimum_depth`].
1061 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1063 /// [`is_outbound`]: ChannelDetails::is_outbound
1064 /// [`ChannelHandshakeConfig::minimum_depth`]: crate::util::config::ChannelHandshakeConfig::minimum_depth
1065 /// [`ChannelHandshakeLimits::max_minimum_depth`]: crate::util::config::ChannelHandshakeLimits::max_minimum_depth
1066 pub confirmations_required: Option<u32>,
1067 /// The number of blocks (after our commitment transaction confirms) that we will need to wait
1068 /// until we can claim our funds after we force-close the channel. During this time our
1069 /// counterparty is allowed to punish us if we broadcasted a stale state. If our counterparty
1070 /// force-closes the channel and broadcasts a commitment transaction we do not have to wait any
1071 /// time to claim our non-HTLC-encumbered funds.
1073 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1074 pub force_close_spend_delay: Option<u16>,
1075 /// True if the channel was initiated (and thus funded) by us.
1076 pub is_outbound: bool,
1077 /// True if the channel is confirmed, channel_ready messages have been exchanged, and the
1078 /// channel is not currently being shut down. `channel_ready` message exchange implies the
1079 /// required confirmation count has been reached (and we were connected to the peer at some
1080 /// point after the funding transaction received enough confirmations). The required
1081 /// confirmation count is provided in [`confirmations_required`].
1083 /// [`confirmations_required`]: ChannelDetails::confirmations_required
1084 pub is_channel_ready: bool,
1085 /// True if the channel is (a) confirmed and channel_ready messages have been exchanged, (b)
1086 /// the peer is connected, and (c) the channel is not currently negotiating a shutdown.
1088 /// This is a strict superset of `is_channel_ready`.
1089 pub is_usable: bool,
1090 /// True if this channel is (or will be) publicly-announced.
1091 pub is_public: bool,
1092 /// The smallest value HTLC (in msat) we will accept, for this channel. This field
1093 /// is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.107
1094 pub inbound_htlc_minimum_msat: Option<u64>,
1095 /// The largest value HTLC (in msat) we currently will accept, for this channel.
1096 pub inbound_htlc_maximum_msat: Option<u64>,
1097 /// Set of configurable parameters that affect channel operation.
1099 /// This field is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.109.
1100 pub config: Option<ChannelConfig>,
1103 impl ChannelDetails {
1104 /// Gets the current SCID which should be used to identify this channel for inbound payments.
1105 /// This should be used for providing invoice hints or in any other context where our
1106 /// counterparty will forward a payment to us.
1108 /// This is either the [`ChannelDetails::inbound_scid_alias`], if set, or the
1109 /// [`ChannelDetails::short_channel_id`]. See those for more information.
1110 pub fn get_inbound_payment_scid(&self) -> Option<u64> {
1111 self.inbound_scid_alias.or(self.short_channel_id)
1114 /// Gets the current SCID which should be used to identify this channel for outbound payments.
1115 /// This should be used in [`Route`]s to describe the first hop or in other contexts where
1116 /// we're sending or forwarding a payment outbound over this channel.
1118 /// This is either the [`ChannelDetails::short_channel_id`], if set, or the
1119 /// [`ChannelDetails::outbound_scid_alias`]. See those for more information.
1120 pub fn get_outbound_payment_scid(&self) -> Option<u64> {
1121 self.short_channel_id.or(self.outbound_scid_alias)
1125 /// If a payment fails to send, it can be in one of several states. This enum is returned as the
1126 /// Err() type describing which state the payment is in, see the description of individual enum
1127 /// states for more.
1128 #[derive(Clone, Debug)]
1129 pub enum PaymentSendFailure {
1130 /// A parameter which was passed to send_payment was invalid, preventing us from attempting to
1131 /// send the payment at all. No channel state has been changed or messages sent to peers, and
1132 /// once you've changed the parameter at error, you can freely retry the payment in full.
1133 ParameterError(APIError),
1134 /// A parameter in a single path which was passed to send_payment was invalid, preventing us
1135 /// from attempting to send the payment at all. No channel state has been changed or messages
1136 /// sent to peers, and once you've changed the parameter at error, you can freely retry the
1137 /// payment in full.
1139 /// The results here are ordered the same as the paths in the route object which was passed to
1141 PathParameterError(Vec<Result<(), APIError>>),
1142 /// All paths which were attempted failed to send, with no channel state change taking place.
1143 /// You can freely retry the payment in full (though you probably want to do so over different
1144 /// paths than the ones selected).
1145 AllFailedRetrySafe(Vec<APIError>),
1146 /// Some paths which were attempted failed to send, though possibly not all. At least some
1147 /// paths have irrevocably committed to the HTLC and retrying the payment in full would result
1148 /// in over-/re-payment.
1150 /// The results here are ordered the same as the paths in the route object which was passed to
1151 /// send_payment, and any Errs which are not APIError::MonitorUpdateFailed can be safely
1152 /// retried (though there is currently no API with which to do so).
1154 /// Any entries which contain Err(APIError::MonitorUpdateFailed) or Ok(()) MUST NOT be retried
1155 /// as they will result in over-/re-payment. These HTLCs all either successfully sent (in the
1156 /// case of Ok(())) or will send once channel_monitor_updated is called on the next-hop channel
1157 /// with the latest update_id.
1159 /// The errors themselves, in the same order as the route hops.
1160 results: Vec<Result<(), APIError>>,
1161 /// If some paths failed without irrevocably committing to the new HTLC(s), this will
1162 /// contain a [`RouteParameters`] object which can be used to calculate a new route that
1163 /// will pay all remaining unpaid balance.
1164 failed_paths_retry: Option<RouteParameters>,
1165 /// The payment id for the payment, which is now at least partially pending.
1166 payment_id: PaymentId,
1170 /// Route hints used in constructing invoices for [phantom node payents].
1172 /// [phantom node payments]: crate::chain::keysinterface::PhantomKeysManager
1174 pub struct PhantomRouteHints {
1175 /// The list of channels to be included in the invoice route hints.
1176 pub channels: Vec<ChannelDetails>,
1177 /// A fake scid used for representing the phantom node's fake channel in generating the invoice
1179 pub phantom_scid: u64,
1180 /// The pubkey of the real backing node that would ultimately receive the payment.
1181 pub real_node_pubkey: PublicKey,
1184 macro_rules! handle_error {
1185 ($self: ident, $internal: expr, $counterparty_node_id: expr) => {
1188 Err(MsgHandleErrInternal { err, chan_id, shutdown_finish }) => {
1189 #[cfg(debug_assertions)]
1191 // In testing, ensure there are no deadlocks where the lock is already held upon
1192 // entering the macro.
1193 assert!($self.channel_state.try_lock().is_ok());
1194 assert!($self.pending_events.try_lock().is_ok());
1197 let mut msg_events = Vec::with_capacity(2);
1199 if let Some((shutdown_res, update_option)) = shutdown_finish {
1200 $self.finish_force_close_channel(shutdown_res);
1201 if let Some(update) = update_option {
1202 msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1206 if let Some((channel_id, user_channel_id)) = chan_id {
1207 $self.pending_events.lock().unwrap().push(events::Event::ChannelClosed {
1208 channel_id, user_channel_id,
1209 reason: ClosureReason::ProcessingError { err: err.err.clone() }
1214 log_error!($self.logger, "{}", err.err);
1215 if let msgs::ErrorAction::IgnoreError = err.action {
1217 msg_events.push(events::MessageSendEvent::HandleError {
1218 node_id: $counterparty_node_id,
1219 action: err.action.clone()
1223 if !msg_events.is_empty() {
1224 $self.channel_state.lock().unwrap().pending_msg_events.append(&mut msg_events);
1227 // Return error in case higher-API need one
1234 macro_rules! update_maps_on_chan_removal {
1235 ($self: expr, $short_to_chan_info: expr, $channel: expr) => {
1236 if let Some(short_id) = $channel.get_short_channel_id() {
1237 $short_to_chan_info.remove(&short_id);
1239 // If the channel was never confirmed on-chain prior to its closure, remove the
1240 // outbound SCID alias we used for it from the collision-prevention set. While we
1241 // generally want to avoid ever re-using an outbound SCID alias across all channels, we
1242 // also don't want a counterparty to be able to trivially cause a memory leak by simply
1243 // opening a million channels with us which are closed before we ever reach the funding
1245 let alias_removed = $self.outbound_scid_aliases.lock().unwrap().remove(&$channel.outbound_scid_alias());
1246 debug_assert!(alias_removed);
1248 $short_to_chan_info.remove(&$channel.outbound_scid_alias());
1252 /// Returns (boolean indicating if we should remove the Channel object from memory, a mapped error)
1253 macro_rules! convert_chan_err {
1254 ($self: ident, $err: expr, $short_to_chan_info: expr, $channel: expr, $channel_id: expr) => {
1256 ChannelError::Warn(msg) => {
1257 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Warn(msg), $channel_id.clone()))
1259 ChannelError::Ignore(msg) => {
1260 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore(msg), $channel_id.clone()))
1262 ChannelError::Close(msg) => {
1263 log_error!($self.logger, "Closing channel {} due to close-required error: {}", log_bytes!($channel_id[..]), msg);
1264 update_maps_on_chan_removal!($self, $short_to_chan_info, $channel);
1265 let shutdown_res = $channel.force_shutdown(true);
1266 (true, MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, $channel.get_user_id(),
1267 shutdown_res, $self.get_channel_update_for_broadcast(&$channel).ok()))
1273 macro_rules! break_chan_entry {
1274 ($self: ident, $res: expr, $channel_state: expr, $entry: expr) => {
1278 let (drop, res) = convert_chan_err!($self, e, $channel_state.short_to_chan_info, $entry.get_mut(), $entry.key());
1280 $entry.remove_entry();
1288 macro_rules! try_chan_entry {
1289 ($self: ident, $res: expr, $channel_state: expr, $entry: expr) => {
1293 let (drop, res) = convert_chan_err!($self, e, $channel_state.short_to_chan_info, $entry.get_mut(), $entry.key());
1295 $entry.remove_entry();
1303 macro_rules! remove_channel {
1304 ($self: expr, $channel_state: expr, $entry: expr) => {
1306 let channel = $entry.remove_entry().1;
1307 update_maps_on_chan_removal!($self, $channel_state.short_to_chan_info, channel);
1313 macro_rules! handle_monitor_err {
1314 ($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) => {
1316 ChannelMonitorUpdateErr::PermanentFailure => {
1317 log_error!($self.logger, "Closing channel {} due to monitor update ChannelMonitorUpdateErr::PermanentFailure", log_bytes!($chan_id[..]));
1318 update_maps_on_chan_removal!($self, $short_to_chan_info, $chan);
1319 // TODO: $failed_fails is dropped here, which will cause other channels to hit the
1320 // chain in a confused state! We need to move them into the ChannelMonitor which
1321 // will be responsible for failing backwards once things confirm on-chain.
1322 // It's ok that we drop $failed_forwards here - at this point we'd rather they
1323 // broadcast HTLC-Timeout and pay the associated fees to get their funds back than
1324 // us bother trying to claim it just to forward on to another peer. If we're
1325 // splitting hairs we'd prefer to claim payments that were to us, but we haven't
1326 // given up the preimage yet, so might as well just wait until the payment is
1327 // retried, avoiding the on-chain fees.
1328 let res: Result<(), _> = Err(MsgHandleErrInternal::from_finish_shutdown("ChannelMonitor storage failure".to_owned(), *$chan_id, $chan.get_user_id(),
1329 $chan.force_shutdown(true), $self.get_channel_update_for_broadcast(&$chan).ok() ));
1332 ChannelMonitorUpdateErr::TemporaryFailure => {
1333 log_info!($self.logger, "Disabling channel {} due to monitor update TemporaryFailure. On restore will send {} and process {} forwards, {} fails, and {} fulfill finalizations",
1334 log_bytes!($chan_id[..]),
1335 if $resend_commitment && $resend_raa {
1336 match $action_type {
1337 RAACommitmentOrder::CommitmentFirst => { "commitment then RAA" },
1338 RAACommitmentOrder::RevokeAndACKFirst => { "RAA then commitment" },
1340 } else if $resend_commitment { "commitment" }
1341 else if $resend_raa { "RAA" }
1343 (&$failed_forwards as &Vec<(PendingHTLCInfo, u64)>).len(),
1344 (&$failed_fails as &Vec<(HTLCSource, PaymentHash, HTLCFailReason)>).len(),
1345 (&$failed_finalized_fulfills as &Vec<HTLCSource>).len());
1346 if !$resend_commitment {
1347 debug_assert!($action_type == RAACommitmentOrder::RevokeAndACKFirst || !$resend_raa);
1350 debug_assert!($action_type == RAACommitmentOrder::CommitmentFirst || !$resend_commitment);
1352 $chan.monitor_update_failed($resend_raa, $resend_commitment, $resend_channel_ready, $failed_forwards, $failed_fails, $failed_finalized_fulfills);
1353 (Err(MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore("Failed to update ChannelMonitor".to_owned()), *$chan_id)), false)
1357 ($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) => { {
1358 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());
1360 $entry.remove_entry();
1364 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $chan_id: expr, COMMITMENT_UPDATE_ONLY) => { {
1365 debug_assert!($action_type == RAACommitmentOrder::CommitmentFirst);
1366 handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, false, true, false, Vec::new(), Vec::new(), Vec::new(), $chan_id)
1368 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $chan_id: expr, NO_UPDATE) => {
1369 handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, false, false, false, Vec::new(), Vec::new(), Vec::new(), $chan_id)
1371 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_channel_ready: expr, OPTIONALLY_RESEND_FUNDING_LOCKED) => {
1372 handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, false, false, $resend_channel_ready, Vec::new(), Vec::new(), Vec::new())
1374 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
1375 handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment, false, Vec::new(), Vec::new(), Vec::new())
1377 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr, $failed_forwards: expr, $failed_fails: expr) => {
1378 handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment, false, $failed_forwards, $failed_fails, Vec::new())
1382 macro_rules! return_monitor_err {
1383 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
1384 return handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment);
1386 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr, $failed_forwards: expr, $failed_fails: expr) => {
1387 return handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment, $failed_forwards, $failed_fails);
1391 // Does not break in case of TemporaryFailure!
1392 macro_rules! maybe_break_monitor_err {
1393 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
1394 match (handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment), $err) {
1395 (e, ChannelMonitorUpdateErr::PermanentFailure) => {
1398 (_, ChannelMonitorUpdateErr::TemporaryFailure) => { },
1403 macro_rules! send_channel_ready {
1404 ($short_to_chan_info: expr, $pending_msg_events: expr, $channel: expr, $channel_ready_msg: expr) => {
1405 $pending_msg_events.push(events::MessageSendEvent::SendChannelReady {
1406 node_id: $channel.get_counterparty_node_id(),
1407 msg: $channel_ready_msg,
1409 // Note that we may send a `channel_ready` multiple times for a channel if we reconnect, so
1410 // we allow collisions, but we shouldn't ever be updating the channel ID pointed to.
1411 let outbound_alias_insert = $short_to_chan_info.insert($channel.outbound_scid_alias(), ($channel.get_counterparty_node_id(), $channel.channel_id()));
1412 assert!(outbound_alias_insert.is_none() || outbound_alias_insert.unwrap() == ($channel.get_counterparty_node_id(), $channel.channel_id()),
1413 "SCIDs should never collide - ensure you weren't behind the chain tip by a full month when creating channels");
1414 if let Some(real_scid) = $channel.get_short_channel_id() {
1415 let scid_insert = $short_to_chan_info.insert(real_scid, ($channel.get_counterparty_node_id(), $channel.channel_id()));
1416 assert!(scid_insert.is_none() || scid_insert.unwrap() == ($channel.get_counterparty_node_id(), $channel.channel_id()),
1417 "SCIDs should never collide - ensure you weren't behind the chain tip by a full month when creating channels");
1422 macro_rules! handle_chan_restoration_locked {
1423 ($self: ident, $channel_lock: expr, $channel_state: expr, $channel_entry: expr,
1424 $raa: expr, $commitment_update: expr, $order: expr, $chanmon_update: expr,
1425 $pending_forwards: expr, $funding_broadcastable: expr, $channel_ready: expr, $announcement_sigs: expr) => { {
1426 let mut htlc_forwards = None;
1428 let chanmon_update: Option<ChannelMonitorUpdate> = $chanmon_update; // Force type-checking to resolve
1429 let chanmon_update_is_none = chanmon_update.is_none();
1430 let counterparty_node_id = $channel_entry.get().get_counterparty_node_id();
1432 let forwards: Vec<(PendingHTLCInfo, u64)> = $pending_forwards; // Force type-checking to resolve
1433 if !forwards.is_empty() {
1434 htlc_forwards = Some(($channel_entry.get().get_short_channel_id().unwrap_or($channel_entry.get().outbound_scid_alias()),
1435 $channel_entry.get().get_funding_txo().unwrap(), forwards));
1438 if chanmon_update.is_some() {
1439 // On reconnect, we, by definition, only resend a channel_ready if there have been
1440 // no commitment updates, so the only channel monitor update which could also be
1441 // associated with a channel_ready would be the funding_created/funding_signed
1442 // monitor update. That monitor update failing implies that we won't send
1443 // channel_ready until it's been updated, so we can't have a channel_ready and a
1444 // monitor update here (so we don't bother to handle it correctly below).
1445 assert!($channel_ready.is_none());
1446 // A channel monitor update makes no sense without either a channel_ready or a
1447 // commitment update to process after it. Since we can't have a channel_ready, we
1448 // only bother to handle the monitor-update + commitment_update case below.
1449 assert!($commitment_update.is_some());
1452 if let Some(msg) = $channel_ready {
1453 // Similar to the above, this implies that we're letting the channel_ready fly
1454 // before it should be allowed to.
1455 assert!(chanmon_update.is_none());
1456 send_channel_ready!($channel_state.short_to_chan_info, $channel_state.pending_msg_events, $channel_entry.get(), msg);
1458 if let Some(msg) = $announcement_sigs {
1459 $channel_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
1460 node_id: counterparty_node_id,
1465 let funding_broadcastable: Option<Transaction> = $funding_broadcastable; // Force type-checking to resolve
1466 if let Some(monitor_update) = chanmon_update {
1467 // We only ever broadcast a funding transaction in response to a funding_signed
1468 // message and the resulting monitor update. Thus, on channel_reestablish
1469 // message handling we can't have a funding transaction to broadcast. When
1470 // processing a monitor update finishing resulting in a funding broadcast, we
1471 // cannot have a second monitor update, thus this case would indicate a bug.
1472 assert!(funding_broadcastable.is_none());
1473 // Given we were just reconnected or finished updating a channel monitor, the
1474 // only case where we can get a new ChannelMonitorUpdate would be if we also
1475 // have some commitment updates to send as well.
1476 assert!($commitment_update.is_some());
1477 if let Err(e) = $self.chain_monitor.update_channel($channel_entry.get().get_funding_txo().unwrap(), monitor_update) {
1478 // channel_reestablish doesn't guarantee the order it returns is sensical
1479 // for the messages it returns, but if we're setting what messages to
1480 // re-transmit on monitor update success, we need to make sure it is sane.
1481 let mut order = $order;
1483 order = RAACommitmentOrder::CommitmentFirst;
1485 break handle_monitor_err!($self, e, $channel_state, $channel_entry, order, $raa.is_some(), true);
1489 macro_rules! handle_cs { () => {
1490 if let Some(update) = $commitment_update {
1491 $channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1492 node_id: counterparty_node_id,
1497 macro_rules! handle_raa { () => {
1498 if let Some(revoke_and_ack) = $raa {
1499 $channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
1500 node_id: counterparty_node_id,
1501 msg: revoke_and_ack,
1506 RAACommitmentOrder::CommitmentFirst => {
1510 RAACommitmentOrder::RevokeAndACKFirst => {
1515 if let Some(tx) = funding_broadcastable {
1516 log_info!($self.logger, "Broadcasting funding transaction with txid {}", tx.txid());
1517 $self.tx_broadcaster.broadcast_transaction(&tx);
1522 if chanmon_update_is_none {
1523 // If there was no ChannelMonitorUpdate, we should never generate an Err in the res loop
1524 // above. Doing so would imply calling handle_err!() from channel_monitor_updated() which
1525 // should *never* end up calling back to `chain_monitor.update_channel()`.
1526 assert!(res.is_ok());
1529 (htlc_forwards, res, counterparty_node_id)
1533 macro_rules! post_handle_chan_restoration {
1534 ($self: ident, $locked_res: expr) => { {
1535 let (htlc_forwards, res, counterparty_node_id) = $locked_res;
1537 let _ = handle_error!($self, res, counterparty_node_id);
1539 if let Some(forwards) = htlc_forwards {
1540 $self.forward_htlcs(&mut [forwards][..]);
1545 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<Signer, M, T, K, F, L>
1546 where M::Target: chain::Watch<Signer>,
1547 T::Target: BroadcasterInterface,
1548 K::Target: KeysInterface<Signer = Signer>,
1549 F::Target: FeeEstimator,
1552 /// Constructs a new ChannelManager to hold several channels and route between them.
1554 /// This is the main "logic hub" for all channel-related actions, and implements
1555 /// ChannelMessageHandler.
1557 /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
1559 /// Users need to notify the new ChannelManager when a new block is connected or
1560 /// disconnected using its `block_connected` and `block_disconnected` methods, starting
1561 /// from after `params.latest_hash`.
1562 pub fn new(fee_est: F, chain_monitor: M, tx_broadcaster: T, logger: L, keys_manager: K, config: UserConfig, params: ChainParameters) -> Self {
1563 let mut secp_ctx = Secp256k1::new();
1564 secp_ctx.seeded_randomize(&keys_manager.get_secure_random_bytes());
1565 let inbound_pmt_key_material = keys_manager.get_inbound_payment_key_material();
1566 let expanded_inbound_key = inbound_payment::ExpandedKey::new(&inbound_pmt_key_material);
1568 default_configuration: config.clone(),
1569 genesis_hash: genesis_block(params.network).header.block_hash(),
1570 fee_estimator: fee_est,
1574 best_block: RwLock::new(params.best_block),
1576 channel_state: Mutex::new(ChannelHolder{
1577 by_id: HashMap::new(),
1578 short_to_chan_info: HashMap::new(),
1579 forward_htlcs: HashMap::new(),
1580 claimable_htlcs: HashMap::new(),
1581 pending_msg_events: Vec::new(),
1583 outbound_scid_aliases: Mutex::new(HashSet::new()),
1584 pending_inbound_payments: Mutex::new(HashMap::new()),
1585 pending_outbound_payments: Mutex::new(HashMap::new()),
1587 our_network_key: keys_manager.get_node_secret(Recipient::Node).unwrap(),
1588 our_network_pubkey: PublicKey::from_secret_key(&secp_ctx, &keys_manager.get_node_secret(Recipient::Node).unwrap()),
1591 inbound_payment_key: expanded_inbound_key,
1592 fake_scid_rand_bytes: keys_manager.get_secure_random_bytes(),
1594 last_node_announcement_serial: AtomicUsize::new(0),
1595 highest_seen_timestamp: AtomicUsize::new(0),
1597 per_peer_state: RwLock::new(HashMap::new()),
1599 pending_events: Mutex::new(Vec::new()),
1600 pending_background_events: Mutex::new(Vec::new()),
1601 total_consistency_lock: RwLock::new(()),
1602 persistence_notifier: PersistenceNotifier::new(),
1610 /// Gets the current configuration applied to all new channels, as
1611 pub fn get_current_default_configuration(&self) -> &UserConfig {
1612 &self.default_configuration
1615 fn create_and_insert_outbound_scid_alias(&self) -> u64 {
1616 let height = self.best_block.read().unwrap().height();
1617 let mut outbound_scid_alias = 0;
1620 if cfg!(fuzzing) { // fuzzing chacha20 doesn't use the key at all so we always get the same alias
1621 outbound_scid_alias += 1;
1623 outbound_scid_alias = fake_scid::Namespace::OutboundAlias.get_fake_scid(height, &self.genesis_hash, &self.fake_scid_rand_bytes, &self.keys_manager);
1625 if outbound_scid_alias != 0 && self.outbound_scid_aliases.lock().unwrap().insert(outbound_scid_alias) {
1629 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"); }
1634 /// Creates a new outbound channel to the given remote node and with the given value.
1636 /// `user_channel_id` will be provided back as in
1637 /// [`Event::FundingGenerationReady::user_channel_id`] to allow tracking of which events
1638 /// correspond with which `create_channel` call. Note that the `user_channel_id` defaults to 0
1639 /// for inbound channels, so you may wish to avoid using 0 for `user_channel_id` here.
1640 /// `user_channel_id` has no meaning inside of LDK, it is simply copied to events and otherwise
1643 /// Raises [`APIError::APIMisuseError`] when `channel_value_satoshis` > 2**24 or `push_msat` is
1644 /// greater than `channel_value_satoshis * 1k` or `channel_value_satoshis < 1000`.
1646 /// Note that we do not check if you are currently connected to the given peer. If no
1647 /// connection is available, the outbound `open_channel` message may fail to send, resulting in
1648 /// the channel eventually being silently forgotten (dropped on reload).
1650 /// Returns the new Channel's temporary `channel_id`. This ID will appear as
1651 /// [`Event::FundingGenerationReady::temporary_channel_id`] and in
1652 /// [`ChannelDetails::channel_id`] until after
1653 /// [`ChannelManager::funding_transaction_generated`] is called, swapping the Channel's ID for
1654 /// one derived from the funding transaction's TXID. If the counterparty rejects the channel
1655 /// immediately, this temporary ID will appear in [`Event::ChannelClosed::channel_id`].
1657 /// [`Event::FundingGenerationReady::user_channel_id`]: events::Event::FundingGenerationReady::user_channel_id
1658 /// [`Event::FundingGenerationReady::temporary_channel_id`]: events::Event::FundingGenerationReady::temporary_channel_id
1659 /// [`Event::ChannelClosed::channel_id`]: events::Event::ChannelClosed::channel_id
1660 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> {
1661 if channel_value_satoshis < 1000 {
1662 return Err(APIError::APIMisuseError { err: format!("Channel value must be at least 1000 satoshis. It was {}", channel_value_satoshis) });
1666 let per_peer_state = self.per_peer_state.read().unwrap();
1667 match per_peer_state.get(&their_network_key) {
1668 Some(peer_state) => {
1669 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
1670 let peer_state = peer_state.lock().unwrap();
1671 let their_features = &peer_state.latest_features;
1672 let config = if override_config.is_some() { override_config.as_ref().unwrap() } else { &self.default_configuration };
1673 match Channel::new_outbound(&self.fee_estimator, &self.keys_manager, their_network_key,
1674 their_features, channel_value_satoshis, push_msat, user_channel_id, config,
1675 self.best_block.read().unwrap().height(), outbound_scid_alias)
1679 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
1684 None => return Err(APIError::ChannelUnavailable { err: format!("Not connected to node: {}", their_network_key) }),
1687 let res = channel.get_open_channel(self.genesis_hash.clone());
1689 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1690 // We want to make sure the lock is actually acquired by PersistenceNotifierGuard.
1691 debug_assert!(&self.total_consistency_lock.try_write().is_err());
1693 let temporary_channel_id = channel.channel_id();
1694 let mut channel_state = self.channel_state.lock().unwrap();
1695 match channel_state.by_id.entry(temporary_channel_id) {
1696 hash_map::Entry::Occupied(_) => {
1698 return Err(APIError::APIMisuseError { err: "Fuzzy bad RNG".to_owned() });
1700 panic!("RNG is bad???");
1703 hash_map::Entry::Vacant(entry) => { entry.insert(channel); }
1705 channel_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
1706 node_id: their_network_key,
1709 Ok(temporary_channel_id)
1712 fn list_channels_with_filter<Fn: FnMut(&(&[u8; 32], &Channel<Signer>)) -> bool>(&self, f: Fn) -> Vec<ChannelDetails> {
1713 let mut res = Vec::new();
1715 let channel_state = self.channel_state.lock().unwrap();
1716 res.reserve(channel_state.by_id.len());
1717 for (channel_id, channel) in channel_state.by_id.iter().filter(f) {
1718 let balance = channel.get_available_balances();
1719 let (to_remote_reserve_satoshis, to_self_reserve_satoshis) =
1720 channel.get_holder_counterparty_selected_channel_reserve_satoshis();
1721 res.push(ChannelDetails {
1722 channel_id: (*channel_id).clone(),
1723 counterparty: ChannelCounterparty {
1724 node_id: channel.get_counterparty_node_id(),
1725 features: InitFeatures::empty(),
1726 unspendable_punishment_reserve: to_remote_reserve_satoshis,
1727 forwarding_info: channel.counterparty_forwarding_info(),
1728 // Ensures that we have actually received the `htlc_minimum_msat` value
1729 // from the counterparty through the `OpenChannel` or `AcceptChannel`
1730 // message (as they are always the first message from the counterparty).
1731 // Else `Channel::get_counterparty_htlc_minimum_msat` could return the
1732 // default `0` value set by `Channel::new_outbound`.
1733 outbound_htlc_minimum_msat: if channel.have_received_message() {
1734 Some(channel.get_counterparty_htlc_minimum_msat()) } else { None },
1735 outbound_htlc_maximum_msat: channel.get_counterparty_htlc_maximum_msat(),
1737 funding_txo: channel.get_funding_txo(),
1738 // Note that accept_channel (or open_channel) is always the first message, so
1739 // `have_received_message` indicates that type negotiation has completed.
1740 channel_type: if channel.have_received_message() { Some(channel.get_channel_type().clone()) } else { None },
1741 short_channel_id: channel.get_short_channel_id(),
1742 outbound_scid_alias: if channel.is_usable() { Some(channel.outbound_scid_alias()) } else { None },
1743 inbound_scid_alias: channel.latest_inbound_scid_alias(),
1744 channel_value_satoshis: channel.get_value_satoshis(),
1745 unspendable_punishment_reserve: to_self_reserve_satoshis,
1746 balance_msat: balance.balance_msat,
1747 inbound_capacity_msat: balance.inbound_capacity_msat,
1748 outbound_capacity_msat: balance.outbound_capacity_msat,
1749 next_outbound_htlc_limit_msat: balance.next_outbound_htlc_limit_msat,
1750 user_channel_id: channel.get_user_id(),
1751 confirmations_required: channel.minimum_depth(),
1752 force_close_spend_delay: channel.get_counterparty_selected_contest_delay(),
1753 is_outbound: channel.is_outbound(),
1754 is_channel_ready: channel.is_usable(),
1755 is_usable: channel.is_live(),
1756 is_public: channel.should_announce(),
1757 inbound_htlc_minimum_msat: Some(channel.get_holder_htlc_minimum_msat()),
1758 inbound_htlc_maximum_msat: channel.get_holder_htlc_maximum_msat(),
1759 config: Some(channel.config()),
1763 let per_peer_state = self.per_peer_state.read().unwrap();
1764 for chan in res.iter_mut() {
1765 if let Some(peer_state) = per_peer_state.get(&chan.counterparty.node_id) {
1766 chan.counterparty.features = peer_state.lock().unwrap().latest_features.clone();
1772 /// Gets the list of open channels, in random order. See ChannelDetail field documentation for
1773 /// more information.
1774 pub fn list_channels(&self) -> Vec<ChannelDetails> {
1775 self.list_channels_with_filter(|_| true)
1778 /// Gets the list of usable channels, in random order. Useful as an argument to [`find_route`]
1779 /// to ensure non-announced channels are used.
1781 /// These are guaranteed to have their [`ChannelDetails::is_usable`] value set to true, see the
1782 /// documentation for [`ChannelDetails::is_usable`] for more info on exactly what the criteria
1785 /// [`find_route`]: crate::routing::router::find_route
1786 pub fn list_usable_channels(&self) -> Vec<ChannelDetails> {
1787 // Note we use is_live here instead of usable which leads to somewhat confused
1788 // internal/external nomenclature, but that's ok cause that's probably what the user
1789 // really wanted anyway.
1790 self.list_channels_with_filter(|&(_, ref channel)| channel.is_live())
1793 /// Helper function that issues the channel close events
1794 fn issue_channel_close_events(&self, channel: &Channel<Signer>, closure_reason: ClosureReason) {
1795 let mut pending_events_lock = self.pending_events.lock().unwrap();
1796 match channel.unbroadcasted_funding() {
1797 Some(transaction) => {
1798 pending_events_lock.push(events::Event::DiscardFunding { channel_id: channel.channel_id(), transaction })
1802 pending_events_lock.push(events::Event::ChannelClosed {
1803 channel_id: channel.channel_id(),
1804 user_channel_id: channel.get_user_id(),
1805 reason: closure_reason
1809 fn close_channel_internal(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey, target_feerate_sats_per_1000_weight: Option<u32>) -> Result<(), APIError> {
1810 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1812 let mut failed_htlcs: Vec<(HTLCSource, PaymentHash)>;
1813 let result: Result<(), _> = loop {
1814 let mut channel_state_lock = self.channel_state.lock().unwrap();
1815 let channel_state = &mut *channel_state_lock;
1816 match channel_state.by_id.entry(channel_id.clone()) {
1817 hash_map::Entry::Occupied(mut chan_entry) => {
1818 if *counterparty_node_id != chan_entry.get().get_counterparty_node_id(){
1819 return Err(APIError::APIMisuseError { err: "The passed counterparty_node_id doesn't match the channel's counterparty node_id".to_owned() });
1821 let per_peer_state = self.per_peer_state.read().unwrap();
1822 let (shutdown_msg, monitor_update, htlcs) = match per_peer_state.get(&counterparty_node_id) {
1823 Some(peer_state) => {
1824 let peer_state = peer_state.lock().unwrap();
1825 let their_features = &peer_state.latest_features;
1826 chan_entry.get_mut().get_shutdown(&self.keys_manager, their_features, target_feerate_sats_per_1000_weight)?
1828 None => return Err(APIError::ChannelUnavailable { err: format!("Not connected to node: {}", counterparty_node_id) }),
1830 failed_htlcs = htlcs;
1832 // Update the monitor with the shutdown script if necessary.
1833 if let Some(monitor_update) = monitor_update {
1834 if let Err(e) = self.chain_monitor.update_channel(chan_entry.get().get_funding_txo().unwrap(), monitor_update) {
1835 let (result, is_permanent) =
1836 handle_monitor_err!(self, e, channel_state.short_to_chan_info, chan_entry.get_mut(), RAACommitmentOrder::CommitmentFirst, chan_entry.key(), NO_UPDATE);
1838 remove_channel!(self, channel_state, chan_entry);
1844 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
1845 node_id: *counterparty_node_id,
1849 if chan_entry.get().is_shutdown() {
1850 let channel = remove_channel!(self, channel_state, chan_entry);
1851 if let Ok(channel_update) = self.get_channel_update_for_broadcast(&channel) {
1852 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1856 self.issue_channel_close_events(&channel, ClosureReason::HolderForceClosed);
1860 hash_map::Entry::Vacant(_) => return Err(APIError::ChannelUnavailable{err: "No such channel".to_owned()})
1864 for htlc_source in failed_htlcs.drain(..) {
1865 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() });
1868 let _ = handle_error!(self, result, *counterparty_node_id);
1872 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
1873 /// will be accepted on the given channel, and after additional timeout/the closing of all
1874 /// pending HTLCs, the channel will be closed on chain.
1876 /// * If we are the channel initiator, we will pay between our [`Background`] and
1877 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
1879 /// * If our counterparty is the channel initiator, we will require a channel closing
1880 /// transaction feerate of at least our [`Background`] feerate or the feerate which
1881 /// would appear on a force-closure transaction, whichever is lower. We will allow our
1882 /// counterparty to pay as much fee as they'd like, however.
1884 /// May generate a SendShutdown message event on success, which should be relayed.
1886 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
1887 /// [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
1888 /// [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
1889 pub fn close_channel(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey) -> Result<(), APIError> {
1890 self.close_channel_internal(channel_id, counterparty_node_id, None)
1893 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
1894 /// will be accepted on the given channel, and after additional timeout/the closing of all
1895 /// pending HTLCs, the channel will be closed on chain.
1897 /// `target_feerate_sat_per_1000_weight` has different meanings depending on if we initiated
1898 /// the channel being closed or not:
1899 /// * If we are the channel initiator, we will pay at least this feerate on the closing
1900 /// transaction. The upper-bound is set by
1901 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
1902 /// estimate (or `target_feerate_sat_per_1000_weight`, if it is greater).
1903 /// * If our counterparty is the channel initiator, we will refuse to accept a channel closure
1904 /// transaction feerate below `target_feerate_sat_per_1000_weight` (or the feerate which
1905 /// will appear on a force-closure transaction, whichever is lower).
1907 /// May generate a SendShutdown message event on success, which should be relayed.
1909 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
1910 /// [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
1911 /// [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
1912 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> {
1913 self.close_channel_internal(channel_id, counterparty_node_id, Some(target_feerate_sats_per_1000_weight))
1917 fn finish_force_close_channel(&self, shutdown_res: ShutdownResult) {
1918 let (monitor_update_option, mut failed_htlcs) = shutdown_res;
1919 log_debug!(self.logger, "Finishing force-closure of channel with {} HTLCs to fail", failed_htlcs.len());
1920 for htlc_source in failed_htlcs.drain(..) {
1921 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() });
1923 if let Some((funding_txo, monitor_update)) = monitor_update_option {
1924 // There isn't anything we can do if we get an update failure - we're already
1925 // force-closing. The monitor update on the required in-memory copy should broadcast
1926 // the latest local state, which is the best we can do anyway. Thus, it is safe to
1927 // ignore the result here.
1928 let _ = self.chain_monitor.update_channel(funding_txo, monitor_update);
1932 /// `peer_msg` should be set when we receive a message from a peer, but not set when the
1933 /// user closes, which will be re-exposed as the `ChannelClosed` reason.
1934 fn force_close_channel_with_peer(&self, channel_id: &[u8; 32], peer_node_id: &PublicKey, peer_msg: Option<&String>, broadcast: bool)
1935 -> Result<PublicKey, APIError> {
1937 let mut channel_state_lock = self.channel_state.lock().unwrap();
1938 let channel_state = &mut *channel_state_lock;
1939 if let hash_map::Entry::Occupied(chan) = channel_state.by_id.entry(channel_id.clone()) {
1940 if chan.get().get_counterparty_node_id() != *peer_node_id {
1941 return Err(APIError::ChannelUnavailable{err: "No such channel".to_owned()});
1943 if let Some(peer_msg) = peer_msg {
1944 self.issue_channel_close_events(chan.get(),ClosureReason::CounterpartyForceClosed { peer_msg: peer_msg.to_string() });
1946 self.issue_channel_close_events(chan.get(),ClosureReason::HolderForceClosed);
1948 remove_channel!(self, channel_state, chan)
1950 return Err(APIError::ChannelUnavailable{err: "No such channel".to_owned()});
1953 log_error!(self.logger, "Force-closing channel {}", log_bytes!(channel_id[..]));
1954 self.finish_force_close_channel(chan.force_shutdown(broadcast));
1955 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
1956 let mut channel_state = self.channel_state.lock().unwrap();
1957 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1962 Ok(chan.get_counterparty_node_id())
1965 fn force_close_sending_error(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey, broadcast: bool) -> Result<(), APIError> {
1966 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1967 match self.force_close_channel_with_peer(channel_id, counterparty_node_id, None, broadcast) {
1968 Ok(counterparty_node_id) => {
1969 self.channel_state.lock().unwrap().pending_msg_events.push(
1970 events::MessageSendEvent::HandleError {
1971 node_id: counterparty_node_id,
1972 action: msgs::ErrorAction::SendErrorMessage {
1973 msg: msgs::ErrorMessage { channel_id: *channel_id, data: "Channel force-closed".to_owned() }
1983 /// Force closes a channel, immediately broadcasting the latest local transaction(s) and
1984 /// rejecting new HTLCs on the given channel. Fails if `channel_id` is unknown to
1985 /// the manager, or if the `counterparty_node_id` isn't the counterparty of the corresponding
1987 pub fn force_close_broadcasting_latest_txn(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey)
1988 -> Result<(), APIError> {
1989 self.force_close_sending_error(channel_id, counterparty_node_id, true)
1992 /// Force closes a channel, rejecting new HTLCs on the given channel but skips broadcasting
1993 /// the latest local transaction(s). Fails if `channel_id` is unknown to the manager, or if the
1994 /// `counterparty_node_id` isn't the counterparty of the corresponding channel.
1996 /// You can always get the latest local transaction(s) to broadcast from
1997 /// [`ChannelMonitor::get_latest_holder_commitment_txn`].
1998 pub fn force_close_without_broadcasting_txn(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey)
1999 -> Result<(), APIError> {
2000 self.force_close_sending_error(channel_id, counterparty_node_id, false)
2003 /// Force close all channels, immediately broadcasting the latest local commitment transaction
2004 /// for each to the chain and rejecting new HTLCs on each.
2005 pub fn force_close_all_channels_broadcasting_latest_txn(&self) {
2006 for chan in self.list_channels() {
2007 let _ = self.force_close_broadcasting_latest_txn(&chan.channel_id, &chan.counterparty.node_id);
2011 /// Force close all channels rejecting new HTLCs on each but without broadcasting the latest
2012 /// local transaction(s).
2013 pub fn force_close_all_channels_without_broadcasting_txn(&self) {
2014 for chan in self.list_channels() {
2015 let _ = self.force_close_without_broadcasting_txn(&chan.channel_id, &chan.counterparty.node_id);
2019 fn construct_recv_pending_htlc_info(&self, hop_data: msgs::OnionHopData, shared_secret: [u8; 32],
2020 payment_hash: PaymentHash, amt_msat: u64, cltv_expiry: u32, phantom_shared_secret: Option<[u8; 32]>) -> Result<PendingHTLCInfo, ReceiveError>
2022 // final_incorrect_cltv_expiry
2023 if hop_data.outgoing_cltv_value != cltv_expiry {
2024 return Err(ReceiveError {
2025 msg: "Upstream node set CLTV to the wrong value",
2027 err_data: byte_utils::be32_to_array(cltv_expiry).to_vec()
2030 // final_expiry_too_soon
2031 // We have to have some headroom to broadcast on chain if we have the preimage, so make sure
2032 // we have at least HTLC_FAIL_BACK_BUFFER blocks to go.
2033 // Also, ensure that, in the case of an unknown preimage for the received payment hash, our
2034 // payment logic has enough time to fail the HTLC backward before our onchain logic triggers a
2035 // channel closure (see HTLC_FAIL_BACK_BUFFER rationale).
2036 if (hop_data.outgoing_cltv_value as u64) <= self.best_block.read().unwrap().height() as u64 + HTLC_FAIL_BACK_BUFFER as u64 + 1 {
2037 return Err(ReceiveError {
2039 err_data: Vec::new(),
2040 msg: "The final CLTV expiry is too soon to handle",
2043 if hop_data.amt_to_forward > amt_msat {
2044 return Err(ReceiveError {
2046 err_data: byte_utils::be64_to_array(amt_msat).to_vec(),
2047 msg: "Upstream node sent less than we were supposed to receive in payment",
2051 let routing = match hop_data.format {
2052 msgs::OnionHopDataFormat::Legacy { .. } => {
2053 return Err(ReceiveError {
2054 err_code: 0x4000|0x2000|3,
2055 err_data: Vec::new(),
2056 msg: "We require payment_secrets",
2059 msgs::OnionHopDataFormat::NonFinalNode { .. } => {
2060 return Err(ReceiveError {
2061 err_code: 0x4000|22,
2062 err_data: Vec::new(),
2063 msg: "Got non final data with an HMAC of 0",
2066 msgs::OnionHopDataFormat::FinalNode { payment_data, keysend_preimage } => {
2067 if payment_data.is_some() && keysend_preimage.is_some() {
2068 return Err(ReceiveError {
2069 err_code: 0x4000|22,
2070 err_data: Vec::new(),
2071 msg: "We don't support MPP keysend payments",
2073 } else if let Some(data) = payment_data {
2074 PendingHTLCRouting::Receive {
2076 incoming_cltv_expiry: hop_data.outgoing_cltv_value,
2077 phantom_shared_secret,
2079 } else if let Some(payment_preimage) = keysend_preimage {
2080 // We need to check that the sender knows the keysend preimage before processing this
2081 // payment further. Otherwise, an intermediary routing hop forwarding non-keysend-HTLC X
2082 // could discover the final destination of X, by probing the adjacent nodes on the route
2083 // with a keysend payment of identical payment hash to X and observing the processing
2084 // time discrepancies due to a hash collision with X.
2085 let hashed_preimage = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
2086 if hashed_preimage != payment_hash {
2087 return Err(ReceiveError {
2088 err_code: 0x4000|22,
2089 err_data: Vec::new(),
2090 msg: "Payment preimage didn't match payment hash",
2094 PendingHTLCRouting::ReceiveKeysend {
2096 incoming_cltv_expiry: hop_data.outgoing_cltv_value,
2099 return Err(ReceiveError {
2100 err_code: 0x4000|0x2000|3,
2101 err_data: Vec::new(),
2102 msg: "We require payment_secrets",
2107 Ok(PendingHTLCInfo {
2110 incoming_shared_secret: shared_secret,
2111 amt_to_forward: amt_msat,
2112 outgoing_cltv_value: hop_data.outgoing_cltv_value,
2116 fn decode_update_add_htlc_onion(&self, msg: &msgs::UpdateAddHTLC) -> (PendingHTLCStatus, MutexGuard<ChannelHolder<Signer>>) {
2117 macro_rules! return_malformed_err {
2118 ($msg: expr, $err_code: expr) => {
2120 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
2121 return (PendingHTLCStatus::Fail(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
2122 channel_id: msg.channel_id,
2123 htlc_id: msg.htlc_id,
2124 sha256_of_onion: Sha256::hash(&msg.onion_routing_packet.hop_data).into_inner(),
2125 failure_code: $err_code,
2126 })), self.channel_state.lock().unwrap());
2131 if let Err(_) = msg.onion_routing_packet.public_key {
2132 return_malformed_err!("invalid ephemeral pubkey", 0x8000 | 0x4000 | 6);
2135 let shared_secret = SharedSecret::new(&msg.onion_routing_packet.public_key.unwrap(), &self.our_network_key).secret_bytes();
2137 if msg.onion_routing_packet.version != 0 {
2138 //TODO: Spec doesn't indicate if we should only hash hop_data here (and in other
2139 //sha256_of_onion error data packets), or the entire onion_routing_packet. Either way,
2140 //the hash doesn't really serve any purpose - in the case of hashing all data, the
2141 //receiving node would have to brute force to figure out which version was put in the
2142 //packet by the node that send us the message, in the case of hashing the hop_data, the
2143 //node knows the HMAC matched, so they already know what is there...
2144 return_malformed_err!("Unknown onion packet version", 0x8000 | 0x4000 | 4);
2147 let mut channel_state = None;
2148 macro_rules! return_err {
2149 ($msg: expr, $err_code: expr, $data: expr) => {
2151 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
2152 if channel_state.is_none() {
2153 channel_state = Some(self.channel_state.lock().unwrap());
2155 return (PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
2156 channel_id: msg.channel_id,
2157 htlc_id: msg.htlc_id,
2158 reason: onion_utils::build_first_hop_failure_packet(&shared_secret, $err_code, $data),
2159 })), channel_state.unwrap());
2164 let next_hop = match onion_utils::decode_next_hop(shared_secret, &msg.onion_routing_packet.hop_data[..], msg.onion_routing_packet.hmac, msg.payment_hash) {
2166 Err(onion_utils::OnionDecodeErr::Malformed { err_msg, err_code }) => {
2167 return_malformed_err!(err_msg, err_code);
2169 Err(onion_utils::OnionDecodeErr::Relay { err_msg, err_code }) => {
2170 return_err!(err_msg, err_code, &[0; 0]);
2174 let pending_forward_info = match next_hop {
2175 onion_utils::Hop::Receive(next_hop_data) => {
2177 match self.construct_recv_pending_htlc_info(next_hop_data, shared_secret, msg.payment_hash, msg.amount_msat, msg.cltv_expiry, None) {
2179 // Note that we could obviously respond immediately with an update_fulfill_htlc
2180 // message, however that would leak that we are the recipient of this payment, so
2181 // instead we stay symmetric with the forwarding case, only responding (after a
2182 // delay) once they've send us a commitment_signed!
2183 PendingHTLCStatus::Forward(info)
2185 Err(ReceiveError { err_code, err_data, msg }) => return_err!(msg, err_code, &err_data)
2188 onion_utils::Hop::Forward { next_hop_data, next_hop_hmac, new_packet_bytes } => {
2189 let new_pubkey = msg.onion_routing_packet.public_key.unwrap();
2190 let outgoing_packet = msgs::OnionPacket {
2192 public_key: onion_utils::next_hop_packet_pubkey(&self.secp_ctx, new_pubkey, &shared_secret),
2193 hop_data: new_packet_bytes,
2194 hmac: next_hop_hmac.clone(),
2197 let short_channel_id = match next_hop_data.format {
2198 msgs::OnionHopDataFormat::Legacy { short_channel_id } => short_channel_id,
2199 msgs::OnionHopDataFormat::NonFinalNode { short_channel_id } => short_channel_id,
2200 msgs::OnionHopDataFormat::FinalNode { .. } => {
2201 return_err!("Final Node OnionHopData provided for us as an intermediary node", 0x4000 | 22, &[0;0]);
2205 PendingHTLCStatus::Forward(PendingHTLCInfo {
2206 routing: PendingHTLCRouting::Forward {
2207 onion_packet: outgoing_packet,
2210 payment_hash: msg.payment_hash.clone(),
2211 incoming_shared_secret: shared_secret,
2212 amt_to_forward: next_hop_data.amt_to_forward,
2213 outgoing_cltv_value: next_hop_data.outgoing_cltv_value,
2218 channel_state = Some(self.channel_state.lock().unwrap());
2219 if let &PendingHTLCStatus::Forward(PendingHTLCInfo { ref routing, ref amt_to_forward, ref outgoing_cltv_value, .. }) = &pending_forward_info {
2220 // If short_channel_id is 0 here, we'll reject the HTLC as there cannot be a channel
2221 // with a short_channel_id of 0. This is important as various things later assume
2222 // short_channel_id is non-0 in any ::Forward.
2223 if let &PendingHTLCRouting::Forward { ref short_channel_id, .. } = routing {
2224 let id_option = channel_state.as_ref().unwrap().short_to_chan_info.get(&short_channel_id).cloned();
2225 if let Some((err, code, chan_update)) = loop {
2226 let forwarding_id_opt = match id_option {
2227 None => { // unknown_next_peer
2228 // Note that this is likely a timing oracle for detecting whether an scid is a
2230 if fake_scid::is_valid_phantom(&self.fake_scid_rand_bytes, *short_channel_id) {
2233 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
2236 Some((_cp_id, chan_id)) => Some(chan_id.clone()),
2238 let chan_update_opt = if let Some(forwarding_id) = forwarding_id_opt {
2239 let chan = channel_state.as_mut().unwrap().by_id.get_mut(&forwarding_id).unwrap();
2240 if !chan.should_announce() && !self.default_configuration.accept_forwards_to_priv_channels {
2241 // Note that the behavior here should be identical to the above block - we
2242 // should NOT reveal the existence or non-existence of a private channel if
2243 // we don't allow forwards outbound over them.
2244 break Some(("Refusing to forward to a private channel based on our config.", 0x4000 | 10, None));
2246 if chan.get_channel_type().supports_scid_privacy() && *short_channel_id != chan.outbound_scid_alias() {
2247 // `option_scid_alias` (referred to in LDK as `scid_privacy`) means
2248 // "refuse to forward unless the SCID alias was used", so we pretend
2249 // we don't have the channel here.
2250 break Some(("Refusing to forward over real channel SCID as our counterparty requested.", 0x4000 | 10, None));
2252 let chan_update_opt = self.get_channel_update_for_onion(*short_channel_id, chan).ok();
2254 // Note that we could technically not return an error yet here and just hope
2255 // that the connection is reestablished or monitor updated by the time we get
2256 // around to doing the actual forward, but better to fail early if we can and
2257 // hopefully an attacker trying to path-trace payments cannot make this occur
2258 // on a small/per-node/per-channel scale.
2259 if !chan.is_live() { // channel_disabled
2260 break Some(("Forwarding channel is not in a ready state.", 0x1000 | 20, chan_update_opt));
2262 if *amt_to_forward < chan.get_counterparty_htlc_minimum_msat() { // amount_below_minimum
2263 break Some(("HTLC amount was below the htlc_minimum_msat", 0x1000 | 11, chan_update_opt));
2265 if let Err((err, code)) = chan.htlc_satisfies_config(&msg, *amt_to_forward, *outgoing_cltv_value) {
2266 break Some((err, code, chan_update_opt));
2270 if (msg.cltv_expiry as u64) < (*outgoing_cltv_value) as u64 + MIN_CLTV_EXPIRY_DELTA as u64 { // incorrect_cltv_expiry
2272 "Forwarding node has tampered with the intended HTLC values or origin node has an obsolete cltv_expiry_delta",
2279 let cur_height = self.best_block.read().unwrap().height() + 1;
2280 // Theoretically, channel counterparty shouldn't send us a HTLC expiring now,
2281 // but we want to be robust wrt to counterparty packet sanitization (see
2282 // HTLC_FAIL_BACK_BUFFER rationale).
2283 if msg.cltv_expiry <= cur_height + HTLC_FAIL_BACK_BUFFER as u32 { // expiry_too_soon
2284 break Some(("CLTV expiry is too close", 0x1000 | 14, chan_update_opt));
2286 if msg.cltv_expiry > cur_height + CLTV_FAR_FAR_AWAY as u32 { // expiry_too_far
2287 break Some(("CLTV expiry is too far in the future", 21, None));
2289 // If the HTLC expires ~now, don't bother trying to forward it to our
2290 // counterparty. They should fail it anyway, but we don't want to bother with
2291 // the round-trips or risk them deciding they definitely want the HTLC and
2292 // force-closing to ensure they get it if we're offline.
2293 // We previously had a much more aggressive check here which tried to ensure
2294 // our counterparty receives an HTLC which has *our* risk threshold met on it,
2295 // but there is no need to do that, and since we're a bit conservative with our
2296 // risk threshold it just results in failing to forward payments.
2297 if (*outgoing_cltv_value) as u64 <= (cur_height + LATENCY_GRACE_PERIOD_BLOCKS) as u64 {
2298 break Some(("Outgoing CLTV value is too soon", 0x1000 | 14, chan_update_opt));
2304 let mut res = VecWriter(Vec::with_capacity(chan_update.serialized_length() + 2 + 8 + 2));
2305 if let Some(chan_update) = chan_update {
2306 if code == 0x1000 | 11 || code == 0x1000 | 12 {
2307 msg.amount_msat.write(&mut res).expect("Writes cannot fail");
2309 else if code == 0x1000 | 13 {
2310 msg.cltv_expiry.write(&mut res).expect("Writes cannot fail");
2312 else if code == 0x1000 | 20 {
2313 // TODO: underspecified, follow https://github.com/lightning/bolts/issues/791
2314 0u16.write(&mut res).expect("Writes cannot fail");
2316 (chan_update.serialized_length() as u16 + 2).write(&mut res).expect("Writes cannot fail");
2317 msgs::ChannelUpdate::TYPE.write(&mut res).expect("Writes cannot fail");
2318 chan_update.write(&mut res).expect("Writes cannot fail");
2320 return_err!(err, code, &res.0[..]);
2325 (pending_forward_info, channel_state.unwrap())
2328 /// Gets the current channel_update for the given channel. This first checks if the channel is
2329 /// public, and thus should be called whenever the result is going to be passed out in a
2330 /// [`MessageSendEvent::BroadcastChannelUpdate`] event.
2332 /// May be called with channel_state already locked!
2333 fn get_channel_update_for_broadcast(&self, chan: &Channel<Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
2334 if !chan.should_announce() {
2335 return Err(LightningError {
2336 err: "Cannot broadcast a channel_update for a private channel".to_owned(),
2337 action: msgs::ErrorAction::IgnoreError
2340 if chan.get_short_channel_id().is_none() {
2341 return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError});
2343 log_trace!(self.logger, "Attempting to generate broadcast channel update for channel {}", log_bytes!(chan.channel_id()));
2344 self.get_channel_update_for_unicast(chan)
2347 /// Gets the current channel_update for the given channel. This does not check if the channel
2348 /// is public (only returning an Err if the channel does not yet have an assigned short_id),
2349 /// and thus MUST NOT be called unless the recipient of the resulting message has already
2350 /// provided evidence that they know about the existence of the channel.
2351 /// May be called with channel_state already locked!
2352 fn get_channel_update_for_unicast(&self, chan: &Channel<Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
2353 log_trace!(self.logger, "Attempting to generate channel update for channel {}", log_bytes!(chan.channel_id()));
2354 let short_channel_id = match chan.get_short_channel_id().or(chan.latest_inbound_scid_alias()) {
2355 None => return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError}),
2359 self.get_channel_update_for_onion(short_channel_id, chan)
2361 fn get_channel_update_for_onion(&self, short_channel_id: u64, chan: &Channel<Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
2362 log_trace!(self.logger, "Generating channel update for channel {}", log_bytes!(chan.channel_id()));
2363 let were_node_one = PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key).serialize()[..] < chan.get_counterparty_node_id().serialize()[..];
2365 let unsigned = msgs::UnsignedChannelUpdate {
2366 chain_hash: self.genesis_hash,
2368 timestamp: chan.get_update_time_counter(),
2369 flags: (!were_node_one) as u8 | ((!chan.is_live() as u8) << 1),
2370 cltv_expiry_delta: chan.get_cltv_expiry_delta(),
2371 htlc_minimum_msat: chan.get_counterparty_htlc_minimum_msat(),
2372 htlc_maximum_msat: OptionalField::Present(chan.get_announced_htlc_max_msat()),
2373 fee_base_msat: chan.get_outbound_forwarding_fee_base_msat(),
2374 fee_proportional_millionths: chan.get_fee_proportional_millionths(),
2375 excess_data: Vec::new(),
2378 let msg_hash = Sha256dHash::hash(&unsigned.encode()[..]);
2379 let sig = self.secp_ctx.sign_ecdsa(&hash_to_message!(&msg_hash[..]), &self.our_network_key);
2381 Ok(msgs::ChannelUpdate {
2387 // Only public for testing, this should otherwise never be called direcly
2388 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> {
2389 log_trace!(self.logger, "Attempting to send payment for path with next hop {}", path.first().unwrap().short_channel_id);
2390 let prng_seed = self.keys_manager.get_secure_random_bytes();
2391 let session_priv_bytes = self.keys_manager.get_secure_random_bytes();
2392 let session_priv = SecretKey::from_slice(&session_priv_bytes[..]).expect("RNG is busted");
2394 let onion_keys = onion_utils::construct_onion_keys(&self.secp_ctx, &path, &session_priv)
2395 .map_err(|_| APIError::RouteError{err: "Pubkey along hop was maliciously selected"})?;
2396 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(path, total_value, payment_secret, cur_height, keysend_preimage)?;
2397 if onion_utils::route_size_insane(&onion_payloads) {
2398 return Err(APIError::RouteError{err: "Route size too large considering onion data"});
2400 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, prng_seed, payment_hash);
2402 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2404 let err: Result<(), _> = loop {
2405 let mut channel_lock = self.channel_state.lock().unwrap();
2407 let mut pending_outbounds = self.pending_outbound_payments.lock().unwrap();
2408 let payment_entry = pending_outbounds.entry(payment_id);
2409 if let hash_map::Entry::Occupied(payment) = &payment_entry {
2410 if !payment.get().is_retryable() {
2411 return Err(APIError::RouteError {
2412 err: "Payment already completed"
2417 let id = match channel_lock.short_to_chan_info.get(&path.first().unwrap().short_channel_id) {
2418 None => return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()}),
2419 Some((_cp_id, chan_id)) => chan_id.clone(),
2422 macro_rules! insert_outbound_payment {
2424 let payment = payment_entry.or_insert_with(|| PendingOutboundPayment::Retryable {
2425 session_privs: HashSet::new(),
2426 pending_amt_msat: 0,
2427 pending_fee_msat: Some(0),
2428 payment_hash: *payment_hash,
2429 payment_secret: *payment_secret,
2430 starting_block_height: self.best_block.read().unwrap().height(),
2431 total_msat: total_value,
2433 assert!(payment.insert(session_priv_bytes, path));
2437 let channel_state = &mut *channel_lock;
2438 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(id) {
2440 if chan.get().get_counterparty_node_id() != path.first().unwrap().pubkey {
2441 return Err(APIError::RouteError{err: "Node ID mismatch on first hop!"});
2443 if !chan.get().is_live() {
2444 return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected/pending monitor update!".to_owned()});
2446 break_chan_entry!(self, chan.get_mut().send_htlc_and_commit(
2447 htlc_msat, payment_hash.clone(), htlc_cltv, HTLCSource::OutboundRoute {
2449 session_priv: session_priv.clone(),
2450 first_hop_htlc_msat: htlc_msat,
2452 payment_secret: payment_secret.clone(),
2453 payment_params: payment_params.clone(),
2454 }, onion_packet, &self.logger),
2455 channel_state, chan)
2457 Some((update_add, commitment_signed, monitor_update)) => {
2458 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
2459 maybe_break_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, true);
2460 // Note that MonitorUpdateFailed here indicates (per function docs)
2461 // that we will resend the commitment update once monitor updating
2462 // is restored. Therefore, we must return an error indicating that
2463 // it is unsafe to retry the payment wholesale, which we do in the
2464 // send_payment check for MonitorUpdateFailed, below.
2465 insert_outbound_payment!(); // Only do this after possibly break'ing on Perm failure above.
2466 return Err(APIError::MonitorUpdateFailed);
2468 insert_outbound_payment!();
2470 log_debug!(self.logger, "Sending payment along path resulted in a commitment_signed for channel {}", log_bytes!(chan.get().channel_id()));
2471 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2472 node_id: path.first().unwrap().pubkey,
2473 updates: msgs::CommitmentUpdate {
2474 update_add_htlcs: vec![update_add],
2475 update_fulfill_htlcs: Vec::new(),
2476 update_fail_htlcs: Vec::new(),
2477 update_fail_malformed_htlcs: Vec::new(),
2483 None => { insert_outbound_payment!(); },
2485 } else { unreachable!(); }
2489 match handle_error!(self, err, path.first().unwrap().pubkey) {
2490 Ok(_) => unreachable!(),
2492 Err(APIError::ChannelUnavailable { err: e.err })
2497 /// Sends a payment along a given route.
2499 /// Value parameters are provided via the last hop in route, see documentation for RouteHop
2500 /// fields for more info.
2502 /// Note that if the payment_hash already exists elsewhere (eg you're sending a duplicative
2503 /// payment), we don't do anything to stop you! We always try to ensure that if the provided
2504 /// next hop knows the preimage to payment_hash they can claim an additional amount as
2505 /// specified in the last hop in the route! Thus, you should probably do your own
2506 /// payment_preimage tracking (which you should already be doing as they represent "proof of
2507 /// payment") and prevent double-sends yourself.
2509 /// May generate SendHTLCs message(s) event on success, which should be relayed.
2511 /// Each path may have a different return value, and PaymentSendValue may return a Vec with
2512 /// each entry matching the corresponding-index entry in the route paths, see
2513 /// PaymentSendFailure for more info.
2515 /// In general, a path may raise:
2516 /// * APIError::RouteError when an invalid route or forwarding parameter (cltv_delta, fee,
2517 /// node public key) is specified.
2518 /// * APIError::ChannelUnavailable if the next-hop channel is not available for updates
2519 /// (including due to previous monitor update failure or new permanent monitor update
2521 /// * APIError::MonitorUpdateFailed if a new monitor update failure prevented sending the
2522 /// relevant updates.
2524 /// Note that depending on the type of the PaymentSendFailure the HTLC may have been
2525 /// irrevocably committed to on our end. In such a case, do NOT retry the payment with a
2526 /// different route unless you intend to pay twice!
2528 /// payment_secret is unrelated to payment_hash (or PaymentPreimage) and exists to authenticate
2529 /// the sender to the recipient and prevent payment-probing (deanonymization) attacks. For
2530 /// newer nodes, it will be provided to you in the invoice. If you do not have one, the Route
2531 /// must not contain multiple paths as multi-path payments require a recipient-provided
2533 /// If a payment_secret *is* provided, we assume that the invoice had the payment_secret feature
2534 /// bit set (either as required or as available). If multiple paths are present in the Route,
2535 /// we assume the invoice had the basic_mpp feature set.
2536 pub fn send_payment(&self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>) -> Result<PaymentId, PaymentSendFailure> {
2537 self.send_payment_internal(route, payment_hash, payment_secret, None, None, None)
2540 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> {
2541 if route.paths.len() < 1 {
2542 return Err(PaymentSendFailure::ParameterError(APIError::RouteError{err: "There must be at least one path to send over"}));
2544 if payment_secret.is_none() && route.paths.len() > 1 {
2545 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError{err: "Payment secret is required for multi-path payments".to_string()}));
2547 let mut total_value = 0;
2548 let our_node_id = self.get_our_node_id();
2549 let mut path_errs = Vec::with_capacity(route.paths.len());
2550 let payment_id = if let Some(id) = payment_id { id } else { PaymentId(self.keys_manager.get_secure_random_bytes()) };
2551 'path_check: for path in route.paths.iter() {
2552 if path.len() < 1 || path.len() > 20 {
2553 path_errs.push(Err(APIError::RouteError{err: "Path didn't go anywhere/had bogus size"}));
2554 continue 'path_check;
2556 for (idx, hop) in path.iter().enumerate() {
2557 if idx != path.len() - 1 && hop.pubkey == our_node_id {
2558 path_errs.push(Err(APIError::RouteError{err: "Path went through us but wasn't a simple rebalance loop to us"}));
2559 continue 'path_check;
2562 total_value += path.last().unwrap().fee_msat;
2563 path_errs.push(Ok(()));
2565 if path_errs.iter().any(|e| e.is_err()) {
2566 return Err(PaymentSendFailure::PathParameterError(path_errs));
2568 if let Some(amt_msat) = recv_value_msat {
2569 debug_assert!(amt_msat >= total_value);
2570 total_value = amt_msat;
2573 let cur_height = self.best_block.read().unwrap().height() + 1;
2574 let mut results = Vec::new();
2575 for path in route.paths.iter() {
2576 results.push(self.send_payment_along_path(&path, &route.payment_params, &payment_hash, payment_secret, total_value, cur_height, payment_id, &keysend_preimage));
2578 let mut has_ok = false;
2579 let mut has_err = false;
2580 let mut pending_amt_unsent = 0;
2581 let mut max_unsent_cltv_delta = 0;
2582 for (res, path) in results.iter().zip(route.paths.iter()) {
2583 if res.is_ok() { has_ok = true; }
2584 if res.is_err() { has_err = true; }
2585 if let &Err(APIError::MonitorUpdateFailed) = res {
2586 // MonitorUpdateFailed is inherently unsafe to retry, so we call it a
2590 } else if res.is_err() {
2591 pending_amt_unsent += path.last().unwrap().fee_msat;
2592 max_unsent_cltv_delta = cmp::max(max_unsent_cltv_delta, path.last().unwrap().cltv_expiry_delta);
2595 if has_err && has_ok {
2596 Err(PaymentSendFailure::PartialFailure {
2599 failed_paths_retry: if pending_amt_unsent != 0 {
2600 if let Some(payment_params) = &route.payment_params {
2601 Some(RouteParameters {
2602 payment_params: payment_params.clone(),
2603 final_value_msat: pending_amt_unsent,
2604 final_cltv_expiry_delta: max_unsent_cltv_delta,
2610 // If we failed to send any paths, we shouldn't have inserted the new PaymentId into
2611 // our `pending_outbound_payments` map at all.
2612 debug_assert!(self.pending_outbound_payments.lock().unwrap().get(&payment_id).is_none());
2613 Err(PaymentSendFailure::AllFailedRetrySafe(results.drain(..).map(|r| r.unwrap_err()).collect()))
2619 /// Retries a payment along the given [`Route`].
2621 /// Errors returned are a superset of those returned from [`send_payment`], so see
2622 /// [`send_payment`] documentation for more details on errors. This method will also error if the
2623 /// retry amount puts the payment more than 10% over the payment's total amount, if the payment
2624 /// for the given `payment_id` cannot be found (likely due to timeout or success), or if
2625 /// further retries have been disabled with [`abandon_payment`].
2627 /// [`send_payment`]: [`ChannelManager::send_payment`]
2628 /// [`abandon_payment`]: [`ChannelManager::abandon_payment`]
2629 pub fn retry_payment(&self, route: &Route, payment_id: PaymentId) -> Result<(), PaymentSendFailure> {
2630 const RETRY_OVERFLOW_PERCENTAGE: u64 = 10;
2631 for path in route.paths.iter() {
2632 if path.len() == 0 {
2633 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
2634 err: "length-0 path in route".to_string()
2639 let (total_msat, payment_hash, payment_secret) = {
2640 let outbounds = self.pending_outbound_payments.lock().unwrap();
2641 if let Some(payment) = outbounds.get(&payment_id) {
2643 PendingOutboundPayment::Retryable {
2644 total_msat, payment_hash, payment_secret, pending_amt_msat, ..
2646 let retry_amt_msat: u64 = route.paths.iter().map(|path| path.last().unwrap().fee_msat).sum();
2647 if retry_amt_msat + *pending_amt_msat > *total_msat * (100 + RETRY_OVERFLOW_PERCENTAGE) / 100 {
2648 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
2649 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()
2652 (*total_msat, *payment_hash, *payment_secret)
2654 PendingOutboundPayment::Legacy { .. } => {
2655 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
2656 err: "Unable to retry payments that were initially sent on LDK versions prior to 0.0.102".to_string()
2659 PendingOutboundPayment::Fulfilled { .. } => {
2660 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
2661 err: "Payment already completed".to_owned()
2664 PendingOutboundPayment::Abandoned { .. } => {
2665 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
2666 err: "Payment already abandoned (with some HTLCs still pending)".to_owned()
2671 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
2672 err: format!("Payment with ID {} not found", log_bytes!(payment_id.0)),
2676 return self.send_payment_internal(route, payment_hash, &payment_secret, None, Some(payment_id), Some(total_msat)).map(|_| ())
2679 /// Signals that no further retries for the given payment will occur.
2681 /// After this method returns, any future calls to [`retry_payment`] for the given `payment_id`
2682 /// will fail with [`PaymentSendFailure::ParameterError`]. If no such event has been generated,
2683 /// an [`Event::PaymentFailed`] event will be generated as soon as there are no remaining
2684 /// pending HTLCs for this payment.
2686 /// Note that calling this method does *not* prevent a payment from succeeding. You must still
2687 /// wait until you receive either a [`Event::PaymentFailed`] or [`Event::PaymentSent`] event to
2688 /// determine the ultimate status of a payment.
2690 /// [`retry_payment`]: Self::retry_payment
2691 /// [`Event::PaymentFailed`]: events::Event::PaymentFailed
2692 /// [`Event::PaymentSent`]: events::Event::PaymentSent
2693 pub fn abandon_payment(&self, payment_id: PaymentId) {
2694 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2696 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
2697 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
2698 if let Ok(()) = payment.get_mut().mark_abandoned() {
2699 if payment.get().remaining_parts() == 0 {
2700 self.pending_events.lock().unwrap().push(events::Event::PaymentFailed {
2702 payment_hash: payment.get().payment_hash().expect("PendingOutboundPayments::RetriesExceeded always has a payment hash set"),
2710 /// Send a spontaneous payment, which is a payment that does not require the recipient to have
2711 /// generated an invoice. Optionally, you may specify the preimage. If you do choose to specify
2712 /// the preimage, it must be a cryptographically secure random value that no intermediate node
2713 /// would be able to guess -- otherwise, an intermediate node may claim the payment and it will
2714 /// never reach the recipient.
2716 /// See [`send_payment`] documentation for more details on the return value of this function.
2718 /// Similar to regular payments, you MUST NOT reuse a `payment_preimage` value. See
2719 /// [`send_payment`] for more information about the risks of duplicate preimage usage.
2721 /// Note that `route` must have exactly one path.
2723 /// [`send_payment`]: Self::send_payment
2724 pub fn send_spontaneous_payment(&self, route: &Route, payment_preimage: Option<PaymentPreimage>) -> Result<(PaymentHash, PaymentId), PaymentSendFailure> {
2725 let preimage = match payment_preimage {
2727 None => PaymentPreimage(self.keys_manager.get_secure_random_bytes()),
2729 let payment_hash = PaymentHash(Sha256::hash(&preimage.0).into_inner());
2730 match self.send_payment_internal(route, payment_hash, &None, Some(preimage), None, None) {
2731 Ok(payment_id) => Ok((payment_hash, payment_id)),
2736 /// Handles the generation of a funding transaction, optionally (for tests) with a function
2737 /// which checks the correctness of the funding transaction given the associated channel.
2738 fn funding_transaction_generated_intern<FundingOutput: Fn(&Channel<Signer>, &Transaction) -> Result<OutPoint, APIError>>(
2739 &self, temporary_channel_id: &[u8; 32], _counterparty_node_id: &PublicKey, funding_transaction: Transaction, find_funding_output: FundingOutput
2740 ) -> Result<(), APIError> {
2742 let (res, chan) = match self.channel_state.lock().unwrap().by_id.remove(temporary_channel_id) {
2744 let funding_txo = find_funding_output(&chan, &funding_transaction)?;
2746 (chan.get_outbound_funding_created(funding_transaction, funding_txo, &self.logger)
2747 .map_err(|e| if let ChannelError::Close(msg) = e {
2748 MsgHandleErrInternal::from_finish_shutdown(msg, chan.channel_id(), chan.get_user_id(), chan.force_shutdown(true), None)
2749 } else { unreachable!(); })
2752 None => { return Err(APIError::ChannelUnavailable { err: "No such channel".to_owned() }) },
2754 match handle_error!(self, res, chan.get_counterparty_node_id()) {
2755 Ok(funding_msg) => {
2758 Err(_) => { return Err(APIError::ChannelUnavailable {
2759 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()
2764 let mut channel_state = self.channel_state.lock().unwrap();
2765 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
2766 node_id: chan.get_counterparty_node_id(),
2769 match channel_state.by_id.entry(chan.channel_id()) {
2770 hash_map::Entry::Occupied(_) => {
2771 panic!("Generated duplicate funding txid?");
2773 hash_map::Entry::Vacant(e) => {
2781 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> {
2782 self.funding_transaction_generated_intern(temporary_channel_id, counterparty_node_id, funding_transaction, |_, tx| {
2783 Ok(OutPoint { txid: tx.txid(), index: output_index })
2787 /// Call this upon creation of a funding transaction for the given channel.
2789 /// Returns an [`APIError::APIMisuseError`] if the funding_transaction spent non-SegWit outputs
2790 /// or if no output was found which matches the parameters in [`Event::FundingGenerationReady`].
2792 /// Returns [`APIError::APIMisuseError`] if the funding transaction is not final for propagation
2793 /// across the p2p network.
2795 /// Returns [`APIError::ChannelUnavailable`] if a funding transaction has already been provided
2796 /// for the channel or if the channel has been closed as indicated by [`Event::ChannelClosed`].
2798 /// May panic if the output found in the funding transaction is duplicative with some other
2799 /// channel (note that this should be trivially prevented by using unique funding transaction
2800 /// keys per-channel).
2802 /// Do NOT broadcast the funding transaction yourself. When we have safely received our
2803 /// counterparty's signature the funding transaction will automatically be broadcast via the
2804 /// [`BroadcasterInterface`] provided when this `ChannelManager` was constructed.
2806 /// Note that this includes RBF or similar transaction replacement strategies - lightning does
2807 /// not currently support replacing a funding transaction on an existing channel. Instead,
2808 /// create a new channel with a conflicting funding transaction.
2810 /// Note to keep the miner incentives aligned in moving the blockchain forward, we recommend
2811 /// the wallet software generating the funding transaction to apply anti-fee sniping as
2812 /// implemented by Bitcoin Core wallet. See <https://bitcoinops.org/en/topics/fee-sniping/>
2813 /// for more details.
2815 /// [`Event::FundingGenerationReady`]: crate::util::events::Event::FundingGenerationReady
2816 /// [`Event::ChannelClosed`]: crate::util::events::Event::ChannelClosed
2817 pub fn funding_transaction_generated(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, funding_transaction: Transaction) -> Result<(), APIError> {
2818 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2820 for inp in funding_transaction.input.iter() {
2821 if inp.witness.is_empty() {
2822 return Err(APIError::APIMisuseError {
2823 err: "Funding transaction must be fully signed and spend Segwit outputs".to_owned()
2828 let height = self.best_block.read().unwrap().height();
2829 // Transactions are evaluated as final by network mempools at the next block. However, the modules
2830 // constituting our Lightning node might not have perfect sync about their blockchain views. Thus, if
2831 // the wallet module is in advance on the LDK view, allow one more block of headroom.
2832 // TODO: updated if/when https://github.com/rust-bitcoin/rust-bitcoin/pull/994 landed and rust-bitcoin bumped.
2833 if !funding_transaction.input.iter().all(|input| input.sequence == 0xffffffff) && funding_transaction.lock_time < 500_000_000 && funding_transaction.lock_time > height + 2 {
2834 return Err(APIError::APIMisuseError {
2835 err: "Funding transaction absolute timelock is non-final".to_owned()
2839 self.funding_transaction_generated_intern(temporary_channel_id, counterparty_node_id, funding_transaction, |chan, tx| {
2840 let mut output_index = None;
2841 let expected_spk = chan.get_funding_redeemscript().to_v0_p2wsh();
2842 for (idx, outp) in tx.output.iter().enumerate() {
2843 if outp.script_pubkey == expected_spk && outp.value == chan.get_value_satoshis() {
2844 if output_index.is_some() {
2845 return Err(APIError::APIMisuseError {
2846 err: "Multiple outputs matched the expected script and value".to_owned()
2849 if idx > u16::max_value() as usize {
2850 return Err(APIError::APIMisuseError {
2851 err: "Transaction had more than 2^16 outputs, which is not supported".to_owned()
2854 output_index = Some(idx as u16);
2857 if output_index.is_none() {
2858 return Err(APIError::APIMisuseError {
2859 err: "No output matched the script_pubkey and value in the FundingGenerationReady event".to_owned()
2862 Ok(OutPoint { txid: tx.txid(), index: output_index.unwrap() })
2867 // Messages of up to 64KB should never end up more than half full with addresses, as that would
2868 // be absurd. We ensure this by checking that at least 100 (our stated public contract on when
2869 // broadcast_node_announcement panics) of the maximum-length addresses would fit in a 64KB
2871 const HALF_MESSAGE_IS_ADDRS: u32 = ::core::u16::MAX as u32 / (NetAddress::MAX_LEN as u32 + 1) / 2;
2874 // ...by failing to compile if the number of addresses that would be half of a message is
2875 // smaller than 100:
2876 const STATIC_ASSERT: u32 = Self::HALF_MESSAGE_IS_ADDRS - 100;
2878 /// Regenerates channel_announcements and generates a signed node_announcement from the given
2879 /// arguments, providing them in corresponding events via
2880 /// [`get_and_clear_pending_msg_events`], if at least one public channel has been confirmed
2881 /// on-chain. This effectively re-broadcasts all channel announcements and sends our node
2882 /// announcement to ensure that the lightning P2P network is aware of the channels we have and
2883 /// our network addresses.
2885 /// `rgb` is a node "color" and `alias` is a printable human-readable string to describe this
2886 /// node to humans. They carry no in-protocol meaning.
2888 /// `addresses` represent the set (possibly empty) of socket addresses on which this node
2889 /// accepts incoming connections. These will be included in the node_announcement, publicly
2890 /// tying these addresses together and to this node. If you wish to preserve user privacy,
2891 /// addresses should likely contain only Tor Onion addresses.
2893 /// Panics if `addresses` is absurdly large (more than 100).
2895 /// [`get_and_clear_pending_msg_events`]: MessageSendEventsProvider::get_and_clear_pending_msg_events
2896 pub fn broadcast_node_announcement(&self, rgb: [u8; 3], alias: [u8; 32], mut addresses: Vec<NetAddress>) {
2897 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2899 if addresses.len() > 100 {
2900 panic!("More than half the message size was taken up by public addresses!");
2903 // While all existing nodes handle unsorted addresses just fine, the spec requires that
2904 // addresses be sorted for future compatibility.
2905 addresses.sort_by_key(|addr| addr.get_id());
2907 let announcement = msgs::UnsignedNodeAnnouncement {
2908 features: NodeFeatures::known(),
2909 timestamp: self.last_node_announcement_serial.fetch_add(1, Ordering::AcqRel) as u32,
2910 node_id: self.get_our_node_id(),
2911 rgb, alias, addresses,
2912 excess_address_data: Vec::new(),
2913 excess_data: Vec::new(),
2915 let msghash = hash_to_message!(&Sha256dHash::hash(&announcement.encode()[..])[..]);
2916 let node_announce_sig = sign(&self.secp_ctx, &msghash, &self.our_network_key);
2918 let mut channel_state_lock = self.channel_state.lock().unwrap();
2919 let channel_state = &mut *channel_state_lock;
2921 let mut announced_chans = false;
2922 for (_, chan) in channel_state.by_id.iter() {
2923 if let Some(msg) = chan.get_signed_channel_announcement(self.get_our_node_id(), self.genesis_hash.clone(), self.best_block.read().unwrap().height()) {
2924 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
2926 update_msg: match self.get_channel_update_for_broadcast(chan) {
2931 announced_chans = true;
2933 // If the channel is not public or has not yet reached channel_ready, check the
2934 // next channel. If we don't yet have any public channels, we'll skip the broadcast
2935 // below as peers may not accept it without channels on chain first.
2939 if announced_chans {
2940 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastNodeAnnouncement {
2941 msg: msgs::NodeAnnouncement {
2942 signature: node_announce_sig,
2943 contents: announcement
2949 /// Atomically updates the [`ChannelConfig`] for the given channels.
2951 /// Once the updates are applied, each eligible channel (advertised with a known short channel
2952 /// ID and a change in [`forwarding_fee_proportional_millionths`], [`forwarding_fee_base_msat`],
2953 /// or [`cltv_expiry_delta`]) has a [`BroadcastChannelUpdate`] event message generated
2954 /// containing the new [`ChannelUpdate`] message which should be broadcast to the network.
2956 /// Returns [`ChannelUnavailable`] when a channel is not found or an incorrect
2957 /// `counterparty_node_id` is provided.
2959 /// Returns [`APIMisuseError`] when a [`cltv_expiry_delta`] update is to be applied with a value
2960 /// below [`MIN_CLTV_EXPIRY_DELTA`].
2962 /// If an error is returned, none of the updates should be considered applied.
2964 /// [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
2965 /// [`forwarding_fee_base_msat`]: ChannelConfig::forwarding_fee_base_msat
2966 /// [`cltv_expiry_delta`]: ChannelConfig::cltv_expiry_delta
2967 /// [`BroadcastChannelUpdate`]: events::MessageSendEvent::BroadcastChannelUpdate
2968 /// [`ChannelUpdate`]: msgs::ChannelUpdate
2969 /// [`ChannelUnavailable`]: APIError::ChannelUnavailable
2970 /// [`APIMisuseError`]: APIError::APIMisuseError
2971 pub fn update_channel_config(
2972 &self, counterparty_node_id: &PublicKey, channel_ids: &[[u8; 32]], config: &ChannelConfig,
2973 ) -> Result<(), APIError> {
2974 if config.cltv_expiry_delta < MIN_CLTV_EXPIRY_DELTA {
2975 return Err(APIError::APIMisuseError {
2976 err: format!("The chosen CLTV expiry delta is below the minimum of {}", MIN_CLTV_EXPIRY_DELTA),
2980 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(
2981 &self.total_consistency_lock, &self.persistence_notifier,
2984 let mut channel_state_lock = self.channel_state.lock().unwrap();
2985 let channel_state = &mut *channel_state_lock;
2986 for channel_id in channel_ids {
2987 let channel_counterparty_node_id = channel_state.by_id.get(channel_id)
2988 .ok_or(APIError::ChannelUnavailable {
2989 err: format!("Channel with ID {} was not found", log_bytes!(*channel_id)),
2991 .get_counterparty_node_id();
2992 if channel_counterparty_node_id != *counterparty_node_id {
2993 return Err(APIError::APIMisuseError {
2994 err: "counterparty node id mismatch".to_owned(),
2998 for channel_id in channel_ids {
2999 let channel = channel_state.by_id.get_mut(channel_id).unwrap();
3000 if !channel.update_config(config) {
3003 if let Ok(msg) = self.get_channel_update_for_broadcast(channel) {
3004 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate { msg });
3005 } else if let Ok(msg) = self.get_channel_update_for_unicast(channel) {
3006 channel_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
3007 node_id: channel.get_counterparty_node_id(),
3016 /// Processes HTLCs which are pending waiting on random forward delay.
3018 /// Should only really ever be called in response to a PendingHTLCsForwardable event.
3019 /// Will likely generate further events.
3020 pub fn process_pending_htlc_forwards(&self) {
3021 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
3023 let mut new_events = Vec::new();
3024 let mut failed_forwards = Vec::new();
3025 let mut phantom_receives: Vec<(u64, OutPoint, Vec<(PendingHTLCInfo, u64)>)> = Vec::new();
3026 let mut handle_errors = Vec::new();
3028 let mut channel_state_lock = self.channel_state.lock().unwrap();
3029 let channel_state = &mut *channel_state_lock;
3031 for (short_chan_id, mut pending_forwards) in channel_state.forward_htlcs.drain() {
3032 if short_chan_id != 0 {
3033 let forward_chan_id = match channel_state.short_to_chan_info.get(&short_chan_id) {
3034 Some((_cp_id, chan_id)) => chan_id.clone(),
3036 for forward_info in pending_forwards.drain(..) {
3037 match forward_info {
3038 HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info: PendingHTLCInfo {
3039 routing, incoming_shared_secret, payment_hash, amt_to_forward, outgoing_cltv_value },
3040 prev_funding_outpoint } => {
3041 macro_rules! fail_forward {
3042 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr) => {
3044 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
3045 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
3046 short_channel_id: prev_short_channel_id,
3047 outpoint: prev_funding_outpoint,
3048 htlc_id: prev_htlc_id,
3049 incoming_packet_shared_secret: incoming_shared_secret,
3050 phantom_shared_secret: $phantom_ss,
3052 failed_forwards.push((htlc_source, payment_hash,
3053 HTLCFailReason::Reason { failure_code: $err_code, data: $err_data }
3059 if let PendingHTLCRouting::Forward { onion_packet, .. } = routing {
3060 let phantom_secret_res = self.keys_manager.get_node_secret(Recipient::PhantomNode);
3061 if phantom_secret_res.is_ok() && fake_scid::is_valid_phantom(&self.fake_scid_rand_bytes, short_chan_id) {
3062 let phantom_shared_secret = SharedSecret::new(&onion_packet.public_key.unwrap(), &phantom_secret_res.unwrap()).secret_bytes();
3063 let next_hop = match onion_utils::decode_next_hop(phantom_shared_secret, &onion_packet.hop_data, onion_packet.hmac, payment_hash) {
3065 Err(onion_utils::OnionDecodeErr::Malformed { err_msg, err_code }) => {
3066 let sha256_of_onion = Sha256::hash(&onion_packet.hop_data).into_inner();
3067 // In this scenario, the phantom would have sent us an
3068 // `update_fail_malformed_htlc`, meaning here we encrypt the error as
3069 // if it came from us (the second-to-last hop) but contains the sha256
3071 fail_forward!(err_msg, err_code, sha256_of_onion.to_vec(), None);
3073 Err(onion_utils::OnionDecodeErr::Relay { err_msg, err_code }) => {
3074 fail_forward!(err_msg, err_code, Vec::new(), Some(phantom_shared_secret));
3078 onion_utils::Hop::Receive(hop_data) => {
3079 match self.construct_recv_pending_htlc_info(hop_data, incoming_shared_secret, payment_hash, amt_to_forward, outgoing_cltv_value, Some(phantom_shared_secret)) {
3080 Ok(info) => phantom_receives.push((prev_short_channel_id, prev_funding_outpoint, vec![(info, prev_htlc_id)])),
3081 Err(ReceiveError { err_code, err_data, msg }) => fail_forward!(msg, err_code, err_data, Some(phantom_shared_secret))
3087 fail_forward!(format!("Unknown short channel id {} for forward HTLC", short_chan_id), 0x4000 | 10, Vec::new(), None);
3090 fail_forward!(format!("Unknown short channel id {} for forward HTLC", short_chan_id), 0x4000 | 10, Vec::new(), None);
3093 HTLCForwardInfo::FailHTLC { .. } => {
3094 // Channel went away before we could fail it. This implies
3095 // the channel is now on chain and our counterparty is
3096 // trying to broadcast the HTLC-Timeout, but that's their
3097 // problem, not ours.
3104 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(forward_chan_id) {
3105 let mut add_htlc_msgs = Vec::new();
3106 let mut fail_htlc_msgs = Vec::new();
3107 for forward_info in pending_forwards.drain(..) {
3108 match forward_info {
3109 HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info: PendingHTLCInfo {
3110 routing: PendingHTLCRouting::Forward {
3112 }, incoming_shared_secret, payment_hash, amt_to_forward, outgoing_cltv_value },
3113 prev_funding_outpoint } => {
3114 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);
3115 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
3116 short_channel_id: prev_short_channel_id,
3117 outpoint: prev_funding_outpoint,
3118 htlc_id: prev_htlc_id,
3119 incoming_packet_shared_secret: incoming_shared_secret,
3120 // Phantom payments are only PendingHTLCRouting::Receive.
3121 phantom_shared_secret: None,
3123 match chan.get_mut().send_htlc(amt_to_forward, payment_hash, outgoing_cltv_value, htlc_source.clone(), onion_packet, &self.logger) {
3125 if let ChannelError::Ignore(msg) = e {
3126 log_trace!(self.logger, "Failed to forward HTLC with payment_hash {}: {}", log_bytes!(payment_hash.0), msg);
3128 panic!("Stated return value requirements in send_htlc() were not met");
3130 let (failure_code, data) = self.get_htlc_temp_fail_err_and_data(0x1000|7, short_chan_id, chan.get());
3131 failed_forwards.push((htlc_source, payment_hash,
3132 HTLCFailReason::Reason { failure_code, data }
3138 Some(msg) => { add_htlc_msgs.push(msg); },
3140 // Nothing to do here...we're waiting on a remote
3141 // revoke_and_ack before we can add anymore HTLCs. The Channel
3142 // will automatically handle building the update_add_htlc and
3143 // commitment_signed messages when we can.
3144 // TODO: Do some kind of timer to set the channel as !is_live()
3145 // as we don't really want others relying on us relaying through
3146 // this channel currently :/.
3152 HTLCForwardInfo::AddHTLC { .. } => {
3153 panic!("short_channel_id != 0 should imply any pending_forward entries are of type Forward");
3155 HTLCForwardInfo::FailHTLC { htlc_id, err_packet } => {
3156 log_trace!(self.logger, "Failing HTLC back to channel with short id {} (backward HTLC ID {}) after delay", short_chan_id, htlc_id);
3157 match chan.get_mut().get_update_fail_htlc(htlc_id, err_packet, &self.logger) {
3159 if let ChannelError::Ignore(msg) = e {
3160 log_trace!(self.logger, "Failed to fail HTLC with ID {} backwards to short_id {}: {}", htlc_id, short_chan_id, msg);
3162 panic!("Stated return value requirements in get_update_fail_htlc() were not met");
3164 // fail-backs are best-effort, we probably already have one
3165 // pending, and if not that's OK, if not, the channel is on
3166 // the chain and sending the HTLC-Timeout is their problem.
3169 Ok(Some(msg)) => { fail_htlc_msgs.push(msg); },
3171 // Nothing to do here...we're waiting on a remote
3172 // revoke_and_ack before we can update the commitment
3173 // transaction. The Channel will automatically handle
3174 // building the update_fail_htlc and commitment_signed
3175 // messages when we can.
3176 // We don't need any kind of timer here as they should fail
3177 // the channel onto the chain if they can't get our
3178 // update_fail_htlc in time, it's not our problem.
3185 if !add_htlc_msgs.is_empty() || !fail_htlc_msgs.is_empty() {
3186 let (commitment_msg, monitor_update) = match chan.get_mut().send_commitment(&self.logger) {
3189 // We surely failed send_commitment due to bad keys, in that case
3190 // close channel and then send error message to peer.
3191 let counterparty_node_id = chan.get().get_counterparty_node_id();
3192 let err: Result<(), _> = match e {
3193 ChannelError::Ignore(_) | ChannelError::Warn(_) => {
3194 panic!("Stated return value requirements in send_commitment() were not met");
3196 ChannelError::Close(msg) => {
3197 log_trace!(self.logger, "Closing channel {} due to Close-required error: {}", log_bytes!(chan.key()[..]), msg);
3198 let mut channel = remove_channel!(self, channel_state, chan);
3199 // ChannelClosed event is generated by handle_error for us.
3200 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()))
3203 handle_errors.push((counterparty_node_id, err));
3207 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
3208 handle_errors.push((chan.get().get_counterparty_node_id(), handle_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, true)));
3211 log_debug!(self.logger, "Forwarding HTLCs resulted in a commitment update with {} HTLCs added and {} HTLCs failed for channel {}",
3212 add_htlc_msgs.len(), fail_htlc_msgs.len(), log_bytes!(chan.get().channel_id()));
3213 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
3214 node_id: chan.get().get_counterparty_node_id(),
3215 updates: msgs::CommitmentUpdate {
3216 update_add_htlcs: add_htlc_msgs,
3217 update_fulfill_htlcs: Vec::new(),
3218 update_fail_htlcs: fail_htlc_msgs,
3219 update_fail_malformed_htlcs: Vec::new(),
3221 commitment_signed: commitment_msg,
3229 for forward_info in pending_forwards.drain(..) {
3230 match forward_info {
3231 HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info: PendingHTLCInfo {
3232 routing, incoming_shared_secret, payment_hash, amt_to_forward, .. },
3233 prev_funding_outpoint } => {
3234 let (cltv_expiry, onion_payload, payment_data, phantom_shared_secret) = match routing {
3235 PendingHTLCRouting::Receive { payment_data, incoming_cltv_expiry, phantom_shared_secret } => {
3236 let _legacy_hop_data = Some(payment_data.clone());
3237 (incoming_cltv_expiry, OnionPayload::Invoice { _legacy_hop_data }, Some(payment_data), phantom_shared_secret)
3239 PendingHTLCRouting::ReceiveKeysend { payment_preimage, incoming_cltv_expiry } =>
3240 (incoming_cltv_expiry, OnionPayload::Spontaneous(payment_preimage), None, None),
3242 panic!("short_channel_id == 0 should imply any pending_forward entries are of type Receive");
3245 let claimable_htlc = ClaimableHTLC {
3246 prev_hop: HTLCPreviousHopData {
3247 short_channel_id: prev_short_channel_id,
3248 outpoint: prev_funding_outpoint,
3249 htlc_id: prev_htlc_id,
3250 incoming_packet_shared_secret: incoming_shared_secret,
3251 phantom_shared_secret,
3253 value: amt_to_forward,
3255 total_msat: if let Some(data) = &payment_data { data.total_msat } else { amt_to_forward },
3260 macro_rules! fail_htlc {
3262 let mut htlc_msat_height_data = byte_utils::be64_to_array($htlc.value).to_vec();
3263 htlc_msat_height_data.extend_from_slice(
3264 &byte_utils::be32_to_array(self.best_block.read().unwrap().height()),
3266 failed_forwards.push((HTLCSource::PreviousHopData(HTLCPreviousHopData {
3267 short_channel_id: $htlc.prev_hop.short_channel_id,
3268 outpoint: prev_funding_outpoint,
3269 htlc_id: $htlc.prev_hop.htlc_id,
3270 incoming_packet_shared_secret: $htlc.prev_hop.incoming_packet_shared_secret,
3271 phantom_shared_secret,
3273 HTLCFailReason::Reason { failure_code: 0x4000 | 15, data: htlc_msat_height_data }
3278 macro_rules! check_total_value {
3279 ($payment_data: expr, $payment_preimage: expr) => {{
3280 let mut payment_received_generated = false;
3282 events::PaymentPurpose::InvoicePayment {
3283 payment_preimage: $payment_preimage,
3284 payment_secret: $payment_data.payment_secret,
3287 let (_, htlcs) = channel_state.claimable_htlcs.entry(payment_hash)
3288 .or_insert_with(|| (purpose(), Vec::new()));
3289 if htlcs.len() == 1 {
3290 if let OnionPayload::Spontaneous(_) = htlcs[0].onion_payload {
3291 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));
3292 fail_htlc!(claimable_htlc);
3296 let mut total_value = claimable_htlc.value;
3297 for htlc in htlcs.iter() {
3298 total_value += htlc.value;
3299 match &htlc.onion_payload {
3300 OnionPayload::Invoice { .. } => {
3301 if htlc.total_msat != $payment_data.total_msat {
3302 log_trace!(self.logger, "Failing HTLCs with payment_hash {} as the HTLCs had inconsistent total values (eg {} and {})",
3303 log_bytes!(payment_hash.0), $payment_data.total_msat, htlc.total_msat);
3304 total_value = msgs::MAX_VALUE_MSAT;
3306 if total_value >= msgs::MAX_VALUE_MSAT { break; }
3308 _ => unreachable!(),
3311 if total_value >= msgs::MAX_VALUE_MSAT || total_value > $payment_data.total_msat {
3312 log_trace!(self.logger, "Failing HTLCs with payment_hash {} as the total value {} ran over expected value {} (or HTLCs were inconsistent)",
3313 log_bytes!(payment_hash.0), total_value, $payment_data.total_msat);
3314 fail_htlc!(claimable_htlc);
3315 } else if total_value == $payment_data.total_msat {
3316 htlcs.push(claimable_htlc);
3317 new_events.push(events::Event::PaymentReceived {
3320 amount_msat: total_value,
3322 payment_received_generated = true;
3324 // Nothing to do - we haven't reached the total
3325 // payment value yet, wait until we receive more
3327 htlcs.push(claimable_htlc);
3329 payment_received_generated
3333 // Check that the payment hash and secret are known. Note that we
3334 // MUST take care to handle the "unknown payment hash" and
3335 // "incorrect payment secret" cases here identically or we'd expose
3336 // that we are the ultimate recipient of the given payment hash.
3337 // Further, we must not expose whether we have any other HTLCs
3338 // associated with the same payment_hash pending or not.
3339 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
3340 match payment_secrets.entry(payment_hash) {
3341 hash_map::Entry::Vacant(_) => {
3342 match claimable_htlc.onion_payload {
3343 OnionPayload::Invoice { .. } => {
3344 let payment_data = payment_data.unwrap();
3345 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) {
3346 Ok(payment_preimage) => payment_preimage,
3348 fail_htlc!(claimable_htlc);
3352 check_total_value!(payment_data, payment_preimage);
3354 OnionPayload::Spontaneous(preimage) => {
3355 match channel_state.claimable_htlcs.entry(payment_hash) {
3356 hash_map::Entry::Vacant(e) => {
3357 let purpose = events::PaymentPurpose::SpontaneousPayment(preimage);
3358 e.insert((purpose.clone(), vec![claimable_htlc]));
3359 new_events.push(events::Event::PaymentReceived {
3361 amount_msat: amt_to_forward,
3365 hash_map::Entry::Occupied(_) => {
3366 log_trace!(self.logger, "Failing new keysend HTLC with payment_hash {} for a duplicative payment hash", log_bytes!(payment_hash.0));
3367 fail_htlc!(claimable_htlc);
3373 hash_map::Entry::Occupied(inbound_payment) => {
3374 if payment_data.is_none() {
3375 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));
3376 fail_htlc!(claimable_htlc);
3379 let payment_data = payment_data.unwrap();
3380 if inbound_payment.get().payment_secret != payment_data.payment_secret {
3381 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our expected payment secret.", log_bytes!(payment_hash.0));
3382 fail_htlc!(claimable_htlc);
3383 } else if inbound_payment.get().min_value_msat.is_some() && payment_data.total_msat < inbound_payment.get().min_value_msat.unwrap() {
3384 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our minimum value (had {}, needed {}).",
3385 log_bytes!(payment_hash.0), payment_data.total_msat, inbound_payment.get().min_value_msat.unwrap());
3386 fail_htlc!(claimable_htlc);
3388 let payment_received_generated = check_total_value!(payment_data, inbound_payment.get().payment_preimage);
3389 if payment_received_generated {
3390 inbound_payment.remove_entry();
3396 HTLCForwardInfo::FailHTLC { .. } => {
3397 panic!("Got pending fail of our own HTLC");
3405 for (htlc_source, payment_hash, failure_reason) in failed_forwards.drain(..) {
3406 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source, &payment_hash, failure_reason);
3408 self.forward_htlcs(&mut phantom_receives);
3410 for (counterparty_node_id, err) in handle_errors.drain(..) {
3411 let _ = handle_error!(self, err, counterparty_node_id);
3414 if new_events.is_empty() { return }
3415 let mut events = self.pending_events.lock().unwrap();
3416 events.append(&mut new_events);
3419 /// Free the background events, generally called from timer_tick_occurred.
3421 /// Exposed for testing to allow us to process events quickly without generating accidental
3422 /// BroadcastChannelUpdate events in timer_tick_occurred.
3424 /// Expects the caller to have a total_consistency_lock read lock.
3425 fn process_background_events(&self) -> bool {
3426 let mut background_events = Vec::new();
3427 mem::swap(&mut *self.pending_background_events.lock().unwrap(), &mut background_events);
3428 if background_events.is_empty() {
3432 for event in background_events.drain(..) {
3434 BackgroundEvent::ClosingMonitorUpdate((funding_txo, update)) => {
3435 // The channel has already been closed, so no use bothering to care about the
3436 // monitor updating completing.
3437 let _ = self.chain_monitor.update_channel(funding_txo, update);
3444 #[cfg(any(test, feature = "_test_utils"))]
3445 /// Process background events, for functional testing
3446 pub fn test_process_background_events(&self) {
3447 self.process_background_events();
3450 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>) {
3451 if !chan.is_outbound() { return (true, NotifyOption::SkipPersist, Ok(())); }
3452 // If the feerate has decreased by less than half, don't bother
3453 if new_feerate <= chan.get_feerate() && new_feerate * 2 > chan.get_feerate() {
3454 log_trace!(self.logger, "Channel {} does not qualify for a feerate change from {} to {}.",
3455 log_bytes!(chan_id[..]), chan.get_feerate(), new_feerate);
3456 return (true, NotifyOption::SkipPersist, Ok(()));
3458 if !chan.is_live() {
3459 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).",
3460 log_bytes!(chan_id[..]), chan.get_feerate(), new_feerate);
3461 return (true, NotifyOption::SkipPersist, Ok(()));
3463 log_trace!(self.logger, "Channel {} qualifies for a feerate change from {} to {}.",
3464 log_bytes!(chan_id[..]), chan.get_feerate(), new_feerate);
3466 let mut retain_channel = true;
3467 let res = match chan.send_update_fee_and_commit(new_feerate, &self.logger) {
3470 let (drop, res) = convert_chan_err!(self, e, short_to_chan_info, chan, chan_id);
3471 if drop { retain_channel = false; }
3475 let ret_err = match res {
3476 Ok(Some((update_fee, commitment_signed, monitor_update))) => {
3477 if let Err(e) = self.chain_monitor.update_channel(chan.get_funding_txo().unwrap(), monitor_update) {
3478 let (res, drop) = handle_monitor_err!(self, e, short_to_chan_info, chan, RAACommitmentOrder::CommitmentFirst, chan_id, COMMITMENT_UPDATE_ONLY);
3479 if drop { retain_channel = false; }
3482 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
3483 node_id: chan.get_counterparty_node_id(),
3484 updates: msgs::CommitmentUpdate {
3485 update_add_htlcs: Vec::new(),
3486 update_fulfill_htlcs: Vec::new(),
3487 update_fail_htlcs: Vec::new(),
3488 update_fail_malformed_htlcs: Vec::new(),
3489 update_fee: Some(update_fee),
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.get_est_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.get_est_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 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), HTLCSource::PreviousHopData(htlc_source.0), &htlc_source.1, HTLCFailReason::Reason { failure_code: 23, data: Vec::new() });
3632 for (err, counterparty_node_id) in handle_errors.drain(..) {
3633 let _ = handle_error!(self, err, counterparty_node_id);
3639 /// Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
3640 /// after a PaymentReceived event, failing the HTLC back to its origin and freeing resources
3641 /// along the path (including in our own channel on which we received it).
3643 /// Note that in some cases around unclean shutdown, it is possible the payment may have
3644 /// already been claimed by you via [`ChannelManager::claim_funds`] prior to you seeing (a
3645 /// second copy of) the [`events::Event::PaymentReceived`] event. Alternatively, the payment
3646 /// may have already been failed automatically by LDK if it was nearing its expiration time.
3648 /// While LDK will never claim a payment automatically on your behalf (i.e. without you calling
3649 /// [`ChannelManager::claim_funds`]), you should still monitor for
3650 /// [`events::Event::PaymentClaimed`] events even for payments you intend to fail, especially on
3651 /// startup during which time claims that were in-progress at shutdown may be replayed.
3652 pub fn fail_htlc_backwards(&self, payment_hash: &PaymentHash) {
3653 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
3655 let mut channel_state = Some(self.channel_state.lock().unwrap());
3656 let removed_source = channel_state.as_mut().unwrap().claimable_htlcs.remove(payment_hash);
3657 if let Some((_, mut sources)) = removed_source {
3658 for htlc in sources.drain(..) {
3659 if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
3660 let mut htlc_msat_height_data = byte_utils::be64_to_array(htlc.value).to_vec();
3661 htlc_msat_height_data.extend_from_slice(&byte_utils::be32_to_array(
3662 self.best_block.read().unwrap().height()));
3663 self.fail_htlc_backwards_internal(channel_state.take().unwrap(),
3664 HTLCSource::PreviousHopData(htlc.prev_hop), payment_hash,
3665 HTLCFailReason::Reason { failure_code: 0x4000 | 15, data: htlc_msat_height_data });
3670 /// Gets an HTLC onion failure code and error data for an `UPDATE` error, given the error code
3671 /// that we want to return and a channel.
3673 /// This is for failures on the channel on which the HTLC was *received*, not failures
3675 fn get_htlc_inbound_temp_fail_err_and_data(&self, desired_err_code: u16, chan: &Channel<Signer>) -> (u16, Vec<u8>) {
3676 // We can't be sure what SCID was used when relaying inbound towards us, so we have to
3677 // guess somewhat. If its a public channel, we figure best to just use the real SCID (as
3678 // we're not leaking that we have a channel with the counterparty), otherwise we try to use
3679 // an inbound SCID alias before the real SCID.
3680 let scid_pref = if chan.should_announce() {
3681 chan.get_short_channel_id().or(chan.latest_inbound_scid_alias())
3683 chan.latest_inbound_scid_alias().or(chan.get_short_channel_id())
3685 if let Some(scid) = scid_pref {
3686 self.get_htlc_temp_fail_err_and_data(desired_err_code, scid, chan)
3688 (0x4000|10, Vec::new())
3693 /// Gets an HTLC onion failure code and error data for an `UPDATE` error, given the error code
3694 /// that we want to return and a channel.
3695 fn get_htlc_temp_fail_err_and_data(&self, desired_err_code: u16, scid: u64, chan: &Channel<Signer>) -> (u16, Vec<u8>) {
3696 debug_assert_eq!(desired_err_code & 0x1000, 0x1000);
3697 if let Ok(upd) = self.get_channel_update_for_onion(scid, chan) {
3698 let mut enc = VecWriter(Vec::with_capacity(upd.serialized_length() + 6));
3699 if desired_err_code == 0x1000 | 20 {
3700 // TODO: underspecified, follow https://github.com/lightning/bolts/issues/791
3701 0u16.write(&mut enc).expect("Writes cannot fail");
3703 (upd.serialized_length() as u16 + 2).write(&mut enc).expect("Writes cannot fail");
3704 msgs::ChannelUpdate::TYPE.write(&mut enc).expect("Writes cannot fail");
3705 upd.write(&mut enc).expect("Writes cannot fail");
3706 (desired_err_code, enc.0)
3708 // If we fail to get a unicast channel_update, it implies we don't yet have an SCID,
3709 // which means we really shouldn't have gotten a payment to be forwarded over this
3710 // channel yet, or if we did it's from a route hint. Either way, returning an error of
3711 // PERM|no_such_channel should be fine.
3712 (0x4000|10, Vec::new())
3716 // Fail a list of HTLCs that were just freed from the holding cell. The HTLCs need to be
3717 // failed backwards or, if they were one of our outgoing HTLCs, then their failure needs to
3718 // be surfaced to the user.
3719 fn fail_holding_cell_htlcs(
3720 &self, mut htlcs_to_fail: Vec<(HTLCSource, PaymentHash)>, channel_id: [u8; 32],
3721 _counterparty_node_id: &PublicKey
3723 for (htlc_src, payment_hash) in htlcs_to_fail.drain(..) {
3725 HTLCSource::PreviousHopData(HTLCPreviousHopData { .. }) => {
3726 let (failure_code, onion_failure_data) =
3727 match self.channel_state.lock().unwrap().by_id.entry(channel_id) {
3728 hash_map::Entry::Occupied(chan_entry) => {
3729 self.get_htlc_inbound_temp_fail_err_and_data(0x1000|7, &chan_entry.get())
3731 hash_map::Entry::Vacant(_) => (0x4000|10, Vec::new())
3733 let channel_state = self.channel_state.lock().unwrap();
3734 self.fail_htlc_backwards_internal(channel_state,
3735 htlc_src, &payment_hash, HTLCFailReason::Reason { failure_code, data: onion_failure_data});
3737 HTLCSource::OutboundRoute { session_priv, payment_id, path, payment_params, .. } => {
3738 let mut session_priv_bytes = [0; 32];
3739 session_priv_bytes.copy_from_slice(&session_priv[..]);
3740 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
3741 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
3742 if payment.get_mut().remove(&session_priv_bytes, Some(&path)) && !payment.get().is_fulfilled() {
3743 let retry = if let Some(payment_params_data) = payment_params {
3744 let path_last_hop = path.last().expect("Outbound payments must have had a valid path");
3745 Some(RouteParameters {
3746 payment_params: payment_params_data,
3747 final_value_msat: path_last_hop.fee_msat,
3748 final_cltv_expiry_delta: path_last_hop.cltv_expiry_delta,
3751 let mut pending_events = self.pending_events.lock().unwrap();
3752 pending_events.push(events::Event::PaymentPathFailed {
3753 payment_id: Some(payment_id),
3755 rejected_by_dest: false,
3756 network_update: None,
3757 all_paths_failed: payment.get().remaining_parts() == 0,
3759 short_channel_id: None,
3766 if payment.get().abandoned() && payment.get().remaining_parts() == 0 {
3767 pending_events.push(events::Event::PaymentFailed {
3769 payment_hash: payment.get().payment_hash().expect("PendingOutboundPayments::RetriesExceeded always has a payment hash set"),
3775 log_trace!(self.logger, "Received duplicative fail for HTLC with payment_hash {}", log_bytes!(payment_hash.0));
3782 /// Fails an HTLC backwards to the sender of it to us.
3783 /// Note that while we take a channel_state lock as input, we do *not* assume consistency here.
3784 /// There are several callsites that do stupid things like loop over a list of payment_hashes
3785 /// to fail and take the channel_state lock for each iteration (as we take ownership and may
3786 /// drop it). In other words, no assumptions are made that entries in claimable_htlcs point to
3787 /// still-available channels.
3788 fn fail_htlc_backwards_internal(&self, mut channel_state_lock: MutexGuard<ChannelHolder<Signer>>, source: HTLCSource, payment_hash: &PaymentHash, onion_error: HTLCFailReason) {
3789 //TODO: There is a timing attack here where if a node fails an HTLC back to us they can
3790 //identify whether we sent it or not based on the (I presume) very different runtime
3791 //between the branches here. We should make this async and move it into the forward HTLCs
3794 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
3795 // from block_connected which may run during initialization prior to the chain_monitor
3796 // being fully configured. See the docs for `ChannelManagerReadArgs` for more.
3798 HTLCSource::OutboundRoute { ref path, session_priv, payment_id, ref payment_params, .. } => {
3799 let mut session_priv_bytes = [0; 32];
3800 session_priv_bytes.copy_from_slice(&session_priv[..]);
3801 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
3802 let mut all_paths_failed = false;
3803 let mut full_failure_ev = None;
3804 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
3805 if !payment.get_mut().remove(&session_priv_bytes, Some(&path)) {
3806 log_trace!(self.logger, "Received duplicative fail for HTLC with payment_hash {}", log_bytes!(payment_hash.0));
3809 if payment.get().is_fulfilled() {
3810 log_trace!(self.logger, "Received failure of HTLC with payment_hash {} after payment completion", log_bytes!(payment_hash.0));
3813 if payment.get().remaining_parts() == 0 {
3814 all_paths_failed = true;
3815 if payment.get().abandoned() {
3816 full_failure_ev = Some(events::Event::PaymentFailed {
3818 payment_hash: payment.get().payment_hash().expect("PendingOutboundPayments::RetriesExceeded always has a payment hash set"),
3824 log_trace!(self.logger, "Received duplicative fail for HTLC with payment_hash {}", log_bytes!(payment_hash.0));
3827 mem::drop(channel_state_lock);
3828 let retry = if let Some(payment_params_data) = payment_params {
3829 let path_last_hop = path.last().expect("Outbound payments must have had a valid path");
3830 Some(RouteParameters {
3831 payment_params: payment_params_data.clone(),
3832 final_value_msat: path_last_hop.fee_msat,
3833 final_cltv_expiry_delta: path_last_hop.cltv_expiry_delta,
3836 log_trace!(self.logger, "Failing outbound payment HTLC with payment_hash {}", log_bytes!(payment_hash.0));
3838 let path_failure = match &onion_error {
3839 &HTLCFailReason::LightningError { ref err } => {
3841 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());
3843 let (network_update, short_channel_id, payment_retryable, _, _) = onion_utils::process_onion_failure(&self.secp_ctx, &self.logger, &source, err.data.clone());
3844 // TODO: If we decided to blame ourselves (or one of our channels) in
3845 // process_onion_failure we should close that channel as it implies our
3846 // next-hop is needlessly blaming us!
3847 events::Event::PaymentPathFailed {
3848 payment_id: Some(payment_id),
3849 payment_hash: payment_hash.clone(),
3850 rejected_by_dest: !payment_retryable,
3857 error_code: onion_error_code,
3859 error_data: onion_error_data
3862 &HTLCFailReason::Reason {
3868 // we get a fail_malformed_htlc from the first hop
3869 // TODO: We'd like to generate a NetworkUpdate for temporary
3870 // failures here, but that would be insufficient as find_route
3871 // generally ignores its view of our own channels as we provide them via
3873 // TODO: For non-temporary failures, we really should be closing the
3874 // channel here as we apparently can't relay through them anyway.
3875 events::Event::PaymentPathFailed {
3876 payment_id: Some(payment_id),
3877 payment_hash: payment_hash.clone(),
3878 rejected_by_dest: path.len() == 1,
3879 network_update: None,
3882 short_channel_id: Some(path.first().unwrap().short_channel_id),
3885 error_code: Some(*failure_code),
3887 error_data: Some(data.clone()),
3891 let mut pending_events = self.pending_events.lock().unwrap();
3892 pending_events.push(path_failure);
3893 if let Some(ev) = full_failure_ev { pending_events.push(ev); }
3895 HTLCSource::PreviousHopData(HTLCPreviousHopData { short_channel_id, htlc_id, incoming_packet_shared_secret, phantom_shared_secret, .. }) => {
3896 let err_packet = match onion_error {
3897 HTLCFailReason::Reason { failure_code, data } => {
3898 log_trace!(self.logger, "Failing HTLC with payment_hash {} backwards from us with code {}", log_bytes!(payment_hash.0), failure_code);
3899 if let Some(phantom_ss) = phantom_shared_secret {
3900 let phantom_packet = onion_utils::build_failure_packet(&phantom_ss, failure_code, &data[..]).encode();
3901 let encrypted_phantom_packet = onion_utils::encrypt_failure_packet(&phantom_ss, &phantom_packet);
3902 onion_utils::encrypt_failure_packet(&incoming_packet_shared_secret, &encrypted_phantom_packet.data[..])
3904 let packet = onion_utils::build_failure_packet(&incoming_packet_shared_secret, failure_code, &data[..]).encode();
3905 onion_utils::encrypt_failure_packet(&incoming_packet_shared_secret, &packet)
3908 HTLCFailReason::LightningError { err } => {
3909 log_trace!(self.logger, "Failing HTLC with payment_hash {} backwards with pre-built LightningError", log_bytes!(payment_hash.0));
3910 onion_utils::encrypt_failure_packet(&incoming_packet_shared_secret, &err.data)
3914 let mut forward_event = None;
3915 if channel_state_lock.forward_htlcs.is_empty() {
3916 forward_event = Some(Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS));
3918 match channel_state_lock.forward_htlcs.entry(short_channel_id) {
3919 hash_map::Entry::Occupied(mut entry) => {
3920 entry.get_mut().push(HTLCForwardInfo::FailHTLC { htlc_id, err_packet });
3922 hash_map::Entry::Vacant(entry) => {
3923 entry.insert(vec!(HTLCForwardInfo::FailHTLC { htlc_id, err_packet }));
3926 mem::drop(channel_state_lock);
3927 if let Some(time) = forward_event {
3928 let mut pending_events = self.pending_events.lock().unwrap();
3929 pending_events.push(events::Event::PendingHTLCsForwardable {
3930 time_forwardable: time
3937 /// Provides a payment preimage in response to [`Event::PaymentReceived`], generating any
3938 /// [`MessageSendEvent`]s needed to claim the payment.
3940 /// Note that calling this method does *not* guarantee that the payment has been claimed. You
3941 /// *must* wait for an [`Event::PaymentClaimed`] event which upon a successful claim will be
3942 /// provided to your [`EventHandler`] when [`process_pending_events`] is next called.
3944 /// Note that if you did not set an `amount_msat` when calling [`create_inbound_payment`] or
3945 /// [`create_inbound_payment_for_hash`] you must check that the amount in the `PaymentReceived`
3946 /// event matches your expectation. If you fail to do so and call this method, you may provide
3947 /// the sender "proof-of-payment" when they did not fulfill the full expected payment.
3949 /// [`Event::PaymentReceived`]: crate::util::events::Event::PaymentReceived
3950 /// [`Event::PaymentClaimed`]: crate::util::events::Event::PaymentClaimed
3951 /// [`process_pending_events`]: EventsProvider::process_pending_events
3952 /// [`create_inbound_payment`]: Self::create_inbound_payment
3953 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
3954 /// [`get_and_clear_pending_msg_events`]: MessageSendEventsProvider::get_and_clear_pending_msg_events
3955 pub fn claim_funds(&self, payment_preimage: PaymentPreimage) {
3956 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
3958 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
3960 let mut channel_state = Some(self.channel_state.lock().unwrap());
3961 let removed_source = channel_state.as_mut().unwrap().claimable_htlcs.remove(&payment_hash);
3962 if let Some((payment_purpose, mut sources)) = removed_source {
3963 assert!(!sources.is_empty());
3965 // If we are claiming an MPP payment, we have to take special care to ensure that each
3966 // channel exists before claiming all of the payments (inside one lock).
3967 // Note that channel existance is sufficient as we should always get a monitor update
3968 // which will take care of the real HTLC claim enforcement.
3970 // If we find an HTLC which we would need to claim but for which we do not have a
3971 // channel, we will fail all parts of the MPP payment. While we could wait and see if
3972 // the sender retries the already-failed path(s), it should be a pretty rare case where
3973 // we got all the HTLCs and then a channel closed while we were waiting for the user to
3974 // provide the preimage, so worrying too much about the optimal handling isn't worth
3976 let mut claimable_amt_msat = 0;
3977 let mut expected_amt_msat = None;
3978 let mut valid_mpp = true;
3979 for htlc in sources.iter() {
3980 if let None = channel_state.as_ref().unwrap().short_to_chan_info.get(&htlc.prev_hop.short_channel_id) {
3984 if expected_amt_msat.is_some() && expected_amt_msat != Some(htlc.total_msat) {
3985 log_error!(self.logger, "Somehow ended up with an MPP payment with different total amounts - this should not be reachable!");
3986 debug_assert!(false);
3990 expected_amt_msat = Some(htlc.total_msat);
3991 if let OnionPayload::Spontaneous(_) = &htlc.onion_payload {
3992 // We don't currently support MPP for spontaneous payments, so just check
3993 // that there's one payment here and move on.
3994 if sources.len() != 1 {
3995 log_error!(self.logger, "Somehow ended up with an MPP spontaneous payment - this should not be reachable!");
3996 debug_assert!(false);
4002 claimable_amt_msat += htlc.value;
4004 if sources.is_empty() || expected_amt_msat.is_none() {
4005 log_info!(self.logger, "Attempted to claim an incomplete payment which no longer had any available HTLCs!");
4008 if claimable_amt_msat != expected_amt_msat.unwrap() {
4009 log_info!(self.logger, "Attempted to claim an incomplete payment, expected {} msat, had {} available to claim.",
4010 expected_amt_msat.unwrap(), claimable_amt_msat);
4014 let mut errs = Vec::new();
4015 let mut claimed_any_htlcs = false;
4016 for htlc in sources.drain(..) {
4018 if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
4019 let mut htlc_msat_height_data = byte_utils::be64_to_array(htlc.value).to_vec();
4020 htlc_msat_height_data.extend_from_slice(&byte_utils::be32_to_array(
4021 self.best_block.read().unwrap().height()));
4022 self.fail_htlc_backwards_internal(channel_state.take().unwrap(),
4023 HTLCSource::PreviousHopData(htlc.prev_hop), &payment_hash,
4024 HTLCFailReason::Reason { failure_code: 0x4000|15, data: htlc_msat_height_data });
4026 match self.claim_funds_from_hop(channel_state.as_mut().unwrap(), htlc.prev_hop, payment_preimage) {
4027 ClaimFundsFromHop::MonitorUpdateFail(pk, err, _) => {
4028 if let msgs::ErrorAction::IgnoreError = err.err.action {
4029 // We got a temporary failure updating monitor, but will claim the
4030 // HTLC when the monitor updating is restored (or on chain).
4031 log_error!(self.logger, "Temporary failure claiming HTLC, treating as success: {}", err.err.err);
4032 claimed_any_htlcs = true;
4033 } else { errs.push((pk, err)); }
4035 ClaimFundsFromHop::PrevHopForceClosed => unreachable!("We already checked for channel existence, we can't fail here!"),
4036 ClaimFundsFromHop::DuplicateClaim => {
4037 // While we should never get here in most cases, if we do, it likely
4038 // indicates that the HTLC was timed out some time ago and is no longer
4039 // available to be claimed. Thus, it does not make sense to set
4040 // `claimed_any_htlcs`.
4042 ClaimFundsFromHop::Success(_) => claimed_any_htlcs = true,
4047 if claimed_any_htlcs {
4048 self.pending_events.lock().unwrap().push(events::Event::PaymentClaimed {
4050 purpose: payment_purpose,
4051 amount_msat: claimable_amt_msat,
4055 // Now that we've done the entire above loop in one lock, we can handle any errors
4056 // which were generated.
4057 channel_state.take();
4059 for (counterparty_node_id, err) in errs.drain(..) {
4060 let res: Result<(), _> = Err(err);
4061 let _ = handle_error!(self, res, counterparty_node_id);
4066 fn claim_funds_from_hop(&self, channel_state_lock: &mut MutexGuard<ChannelHolder<Signer>>, prev_hop: HTLCPreviousHopData, payment_preimage: PaymentPreimage) -> ClaimFundsFromHop {
4067 //TODO: Delay the claimed_funds relaying just like we do outbound relay!
4068 let channel_state = &mut **channel_state_lock;
4069 let chan_id = match channel_state.short_to_chan_info.get(&prev_hop.short_channel_id) {
4070 Some((_cp_id, chan_id)) => chan_id.clone(),
4072 return ClaimFundsFromHop::PrevHopForceClosed
4076 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(chan_id) {
4077 match chan.get_mut().get_update_fulfill_htlc_and_commit(prev_hop.htlc_id, payment_preimage, &self.logger) {
4078 Ok(msgs_monitor_option) => {
4079 if let UpdateFulfillCommitFetch::NewClaim { msgs, htlc_value_msat, monitor_update } = msgs_monitor_option {
4080 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
4081 log_given_level!(self.logger, if e == ChannelMonitorUpdateErr::PermanentFailure { Level::Error } else { Level::Debug },
4082 "Failed to update channel monitor with preimage {:?}: {:?}",
4083 payment_preimage, e);
4084 return ClaimFundsFromHop::MonitorUpdateFail(
4085 chan.get().get_counterparty_node_id(),
4086 handle_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, msgs.is_some()).unwrap_err(),
4087 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 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
4112 log_given_level!(self.logger, if e == ChannelMonitorUpdateErr::PermanentFailure { Level::Error } else { Level::Info },
4113 "Failed to update channel monitor with preimage {:?} immediately prior to force-close: {:?}",
4114 payment_preimage, e);
4116 let counterparty_node_id = chan.get().get_counterparty_node_id();
4117 let (drop, res) = convert_chan_err!(self, e, channel_state.short_to_chan_info, chan.get_mut(), &chan_id);
4119 chan.remove_entry();
4121 return ClaimFundsFromHop::MonitorUpdateFail(counterparty_node_id, res, None);
4124 } else { unreachable!(); }
4127 fn finalize_claims(&self, mut sources: Vec<HTLCSource>) {
4128 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
4129 let mut pending_events = self.pending_events.lock().unwrap();
4130 for source in sources.drain(..) {
4131 if let HTLCSource::OutboundRoute { session_priv, payment_id, path, .. } = source {
4132 let mut session_priv_bytes = [0; 32];
4133 session_priv_bytes.copy_from_slice(&session_priv[..]);
4134 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
4135 assert!(payment.get().is_fulfilled());
4136 if payment.get_mut().remove(&session_priv_bytes, None) {
4137 pending_events.push(
4138 events::Event::PaymentPathSuccessful {
4140 payment_hash: payment.get().payment_hash(),
4145 if payment.get().remaining_parts() == 0 {
4153 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]) {
4155 HTLCSource::OutboundRoute { session_priv, payment_id, path, .. } => {
4156 mem::drop(channel_state_lock);
4157 let mut session_priv_bytes = [0; 32];
4158 session_priv_bytes.copy_from_slice(&session_priv[..]);
4159 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
4160 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
4161 let mut pending_events = self.pending_events.lock().unwrap();
4162 if !payment.get().is_fulfilled() {
4163 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
4164 let fee_paid_msat = payment.get().get_pending_fee_msat();
4165 pending_events.push(
4166 events::Event::PaymentSent {
4167 payment_id: Some(payment_id),
4173 payment.get_mut().mark_fulfilled();
4177 // We currently immediately remove HTLCs which were fulfilled on-chain.
4178 // This could potentially lead to removing a pending payment too early,
4179 // with a reorg of one block causing us to re-add the fulfilled payment on
4181 // TODO: We should have a second monitor event that informs us of payments
4182 // irrevocably fulfilled.
4183 if payment.get_mut().remove(&session_priv_bytes, Some(&path)) {
4184 let payment_hash = Some(PaymentHash(Sha256::hash(&payment_preimage.0).into_inner()));
4185 pending_events.push(
4186 events::Event::PaymentPathSuccessful {
4194 if payment.get().remaining_parts() == 0 {
4199 log_trace!(self.logger, "Received duplicative fulfill for HTLC with payment_preimage {}", log_bytes!(payment_preimage.0));
4202 HTLCSource::PreviousHopData(hop_data) => {
4203 let prev_outpoint = hop_data.outpoint;
4204 let res = self.claim_funds_from_hop(&mut channel_state_lock, hop_data, payment_preimage);
4205 let claimed_htlc = if let ClaimFundsFromHop::DuplicateClaim = res { false } else { true };
4206 let htlc_claim_value_msat = match res {
4207 ClaimFundsFromHop::MonitorUpdateFail(_, _, amt_opt) => amt_opt,
4208 ClaimFundsFromHop::Success(amt) => Some(amt),
4211 if let ClaimFundsFromHop::PrevHopForceClosed = res {
4212 let preimage_update = ChannelMonitorUpdate {
4213 update_id: CLOSED_CHANNEL_UPDATE_ID,
4214 updates: vec![ChannelMonitorUpdateStep::PaymentPreimage {
4215 payment_preimage: payment_preimage.clone(),
4218 // We update the ChannelMonitor on the backward link, after
4219 // receiving an offchain preimage event from the forward link (the
4220 // event being update_fulfill_htlc).
4221 if let Err(e) = self.chain_monitor.update_channel(prev_outpoint, preimage_update) {
4222 log_error!(self.logger, "Critical error: failed to update channel monitor with preimage {:?}: {:?}",
4223 payment_preimage, e);
4225 // Note that we do *not* set `claimed_htlc` to false here. In fact, this
4226 // totally could be a duplicate claim, but we have no way of knowing
4227 // without interrogating the `ChannelMonitor` we've provided the above
4228 // update to. Instead, we simply document in `PaymentForwarded` that this
4231 mem::drop(channel_state_lock);
4232 if let ClaimFundsFromHop::MonitorUpdateFail(pk, err, _) = res {
4233 let result: Result<(), _> = Err(err);
4234 let _ = handle_error!(self, result, pk);
4238 if let Some(forwarded_htlc_value) = forwarded_htlc_value_msat {
4239 let fee_earned_msat = if let Some(claimed_htlc_value) = htlc_claim_value_msat {
4240 Some(claimed_htlc_value - forwarded_htlc_value)
4243 let mut pending_events = self.pending_events.lock().unwrap();
4244 let prev_channel_id = Some(prev_outpoint.to_channel_id());
4245 let next_channel_id = Some(next_channel_id);
4247 pending_events.push(events::Event::PaymentForwarded {
4249 claim_from_onchain_tx: from_onchain,
4259 /// Gets the node_id held by this ChannelManager
4260 pub fn get_our_node_id(&self) -> PublicKey {
4261 self.our_network_pubkey.clone()
4264 fn channel_monitor_updated(&self, funding_txo: &OutPoint, highest_applied_update_id: u64) {
4265 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4267 let chan_restoration_res;
4268 let (mut pending_failures, finalized_claims) = {
4269 let mut channel_lock = self.channel_state.lock().unwrap();
4270 let channel_state = &mut *channel_lock;
4271 let mut channel = match channel_state.by_id.entry(funding_txo.to_channel_id()) {
4272 hash_map::Entry::Occupied(chan) => chan,
4273 hash_map::Entry::Vacant(_) => return,
4275 if !channel.get().is_awaiting_monitor_update() || channel.get().get_latest_monitor_update_id() != highest_applied_update_id {
4279 let updates = channel.get_mut().monitor_updating_restored(&self.logger, self.get_our_node_id(), self.genesis_hash, self.best_block.read().unwrap().height());
4280 let channel_update = if updates.channel_ready.is_some() && channel.get().is_usable() {
4281 // We only send a channel_update in the case where we are just now sending a
4282 // channel_ready and the channel is in a usable state. We may re-send a
4283 // channel_update later through the announcement_signatures process for public
4284 // channels, but there's no reason not to just inform our counterparty of our fees
4286 if let Ok(msg) = self.get_channel_update_for_unicast(channel.get()) {
4287 Some(events::MessageSendEvent::SendChannelUpdate {
4288 node_id: channel.get().get_counterparty_node_id(),
4293 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);
4294 if let Some(upd) = channel_update {
4295 channel_state.pending_msg_events.push(upd);
4297 (updates.failed_htlcs, updates.finalized_claimed_htlcs)
4299 post_handle_chan_restoration!(self, chan_restoration_res);
4300 self.finalize_claims(finalized_claims);
4301 for failure in pending_failures.drain(..) {
4302 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), failure.0, &failure.1, failure.2);
4306 /// Accepts a request to open a channel after a [`Event::OpenChannelRequest`].
4308 /// The `temporary_channel_id` parameter indicates which inbound channel should be accepted,
4309 /// and the `counterparty_node_id` parameter is the id of the peer which has requested to open
4312 /// The `user_channel_id` parameter will be provided back in
4313 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
4314 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
4316 /// Note that this method will return an error and reject the channel, if it requires support
4317 /// for zero confirmations. Instead, `accept_inbound_channel_from_trusted_peer_0conf` must be
4318 /// used to accept such channels.
4320 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
4321 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
4322 pub fn accept_inbound_channel(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, user_channel_id: u64) -> Result<(), APIError> {
4323 self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, false, user_channel_id)
4326 /// Accepts a request to open a channel after a [`events::Event::OpenChannelRequest`], treating
4327 /// it as confirmed immediately.
4329 /// The `user_channel_id` parameter will be provided back in
4330 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
4331 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
4333 /// Unlike [`ChannelManager::accept_inbound_channel`], this method accepts the incoming channel
4334 /// and (if the counterparty agrees), enables forwarding of payments immediately.
4336 /// This fully trusts that the counterparty has honestly and correctly constructed the funding
4337 /// transaction and blindly assumes that it will eventually confirm.
4339 /// If it does not confirm before we decide to close the channel, or if the funding transaction
4340 /// does not pay to the correct script the correct amount, *you will lose funds*.
4342 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
4343 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
4344 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> {
4345 self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, true, user_channel_id)
4348 fn do_accept_inbound_channel(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, accept_0conf: bool, user_channel_id: u64) -> Result<(), APIError> {
4349 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4351 let mut channel_state_lock = self.channel_state.lock().unwrap();
4352 let channel_state = &mut *channel_state_lock;
4353 match channel_state.by_id.entry(temporary_channel_id.clone()) {
4354 hash_map::Entry::Occupied(mut channel) => {
4355 if !channel.get().inbound_is_awaiting_accept() {
4356 return Err(APIError::APIMisuseError { err: "The channel isn't currently awaiting to be accepted.".to_owned() });
4358 if *counterparty_node_id != channel.get().get_counterparty_node_id() {
4359 return Err(APIError::APIMisuseError { err: "The passed counterparty_node_id doesn't match the channel's counterparty node_id".to_owned() });
4362 channel.get_mut().set_0conf();
4363 } else if channel.get().get_channel_type().requires_zero_conf() {
4364 let send_msg_err_event = events::MessageSendEvent::HandleError {
4365 node_id: channel.get().get_counterparty_node_id(),
4366 action: msgs::ErrorAction::SendErrorMessage{
4367 msg: msgs::ErrorMessage { channel_id: temporary_channel_id.clone(), data: "No zero confirmation channels accepted".to_owned(), }
4370 channel_state.pending_msg_events.push(send_msg_err_event);
4371 let _ = remove_channel!(self, channel_state, channel);
4372 return Err(APIError::APIMisuseError { err: "Please use accept_inbound_channel_from_trusted_peer_0conf to accept channels with zero confirmations.".to_owned() });
4375 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
4376 node_id: channel.get().get_counterparty_node_id(),
4377 msg: channel.get_mut().accept_inbound_channel(user_channel_id),
4380 hash_map::Entry::Vacant(_) => {
4381 return Err(APIError::ChannelUnavailable { err: "Can't accept a channel that doesn't exist".to_owned() });
4387 fn internal_open_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::OpenChannel) -> Result<(), MsgHandleErrInternal> {
4388 if msg.chain_hash != self.genesis_hash {
4389 return Err(MsgHandleErrInternal::send_err_msg_no_close("Unknown genesis block hash".to_owned(), msg.temporary_channel_id.clone()));
4392 if !self.default_configuration.accept_inbound_channels {
4393 return Err(MsgHandleErrInternal::send_err_msg_no_close("No inbound channels accepted".to_owned(), msg.temporary_channel_id.clone()));
4396 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
4397 let mut channel = match Channel::new_from_req(&self.fee_estimator, &self.keys_manager,
4398 counterparty_node_id.clone(), &their_features, msg, 0, &self.default_configuration,
4399 self.best_block.read().unwrap().height(), &self.logger, outbound_scid_alias)
4402 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
4403 return Err(MsgHandleErrInternal::from_chan_no_close(e, msg.temporary_channel_id));
4407 let mut channel_state_lock = self.channel_state.lock().unwrap();
4408 let channel_state = &mut *channel_state_lock;
4409 match channel_state.by_id.entry(channel.channel_id()) {
4410 hash_map::Entry::Occupied(_) => {
4411 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
4412 return Err(MsgHandleErrInternal::send_err_msg_no_close("temporary_channel_id collision!".to_owned(), msg.temporary_channel_id.clone()))
4414 hash_map::Entry::Vacant(entry) => {
4415 if !self.default_configuration.manually_accept_inbound_channels {
4416 if channel.get_channel_type().requires_zero_conf() {
4417 return Err(MsgHandleErrInternal::send_err_msg_no_close("No zero confirmation channels accepted".to_owned(), msg.temporary_channel_id.clone()));
4419 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
4420 node_id: counterparty_node_id.clone(),
4421 msg: channel.accept_inbound_channel(0),
4424 let mut pending_events = self.pending_events.lock().unwrap();
4425 pending_events.push(
4426 events::Event::OpenChannelRequest {
4427 temporary_channel_id: msg.temporary_channel_id.clone(),
4428 counterparty_node_id: counterparty_node_id.clone(),
4429 funding_satoshis: msg.funding_satoshis,
4430 push_msat: msg.push_msat,
4431 channel_type: channel.get_channel_type().clone(),
4436 entry.insert(channel);
4442 fn internal_accept_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::AcceptChannel) -> Result<(), MsgHandleErrInternal> {
4443 let (value, output_script, user_id) = {
4444 let mut channel_lock = self.channel_state.lock().unwrap();
4445 let channel_state = &mut *channel_lock;
4446 match channel_state.by_id.entry(msg.temporary_channel_id) {
4447 hash_map::Entry::Occupied(mut chan) => {
4448 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4449 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.temporary_channel_id));
4451 try_chan_entry!(self, chan.get_mut().accept_channel(&msg, &self.default_configuration.channel_handshake_limits, &their_features), channel_state, chan);
4452 (chan.get().get_value_satoshis(), chan.get().get_funding_redeemscript().to_v0_p2wsh(), chan.get().get_user_id())
4454 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.temporary_channel_id))
4457 let mut pending_events = self.pending_events.lock().unwrap();
4458 pending_events.push(events::Event::FundingGenerationReady {
4459 temporary_channel_id: msg.temporary_channel_id,
4460 counterparty_node_id: *counterparty_node_id,
4461 channel_value_satoshis: value,
4463 user_channel_id: user_id,
4468 fn internal_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), MsgHandleErrInternal> {
4469 let ((funding_msg, monitor, mut channel_ready), mut chan) = {
4470 let best_block = *self.best_block.read().unwrap();
4471 let mut channel_lock = self.channel_state.lock().unwrap();
4472 let channel_state = &mut *channel_lock;
4473 match channel_state.by_id.entry(msg.temporary_channel_id.clone()) {
4474 hash_map::Entry::Occupied(mut chan) => {
4475 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4476 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.temporary_channel_id));
4478 (try_chan_entry!(self, chan.get_mut().funding_created(msg, best_block, &self.logger), channel_state, chan), chan.remove())
4480 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.temporary_channel_id))
4483 // Because we have exclusive ownership of the channel here we can release the channel_state
4484 // lock before watch_channel
4485 if let Err(e) = self.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor) {
4487 ChannelMonitorUpdateErr::PermanentFailure => {
4488 // Note that we reply with the new channel_id in error messages if we gave up on the
4489 // channel, not the temporary_channel_id. This is compatible with ourselves, but the
4490 // spec is somewhat ambiguous here. Not a huge deal since we'll send error messages for
4491 // any messages referencing a previously-closed channel anyway.
4492 // We do not do a force-close here as that would generate a monitor update for
4493 // a monitor that we didn't manage to store (and that we don't care about - we
4494 // don't respond with the funding_signed so the channel can never go on chain).
4495 let (_monitor_update, failed_htlcs) = chan.force_shutdown(true);
4496 assert!(failed_htlcs.is_empty());
4497 return Err(MsgHandleErrInternal::send_err_msg_no_close("ChannelMonitor storage failure".to_owned(), funding_msg.channel_id));
4499 ChannelMonitorUpdateErr::TemporaryFailure => {
4500 // There's no problem signing a counterparty's funding transaction if our monitor
4501 // hasn't persisted to disk yet - we can't lose money on a transaction that we haven't
4502 // accepted payment from yet. We do, however, need to wait to send our channel_ready
4503 // until we have persisted our monitor.
4504 chan.monitor_update_failed(false, false, channel_ready.is_some(), Vec::new(), Vec::new(), Vec::new());
4505 channel_ready = None; // Don't send the channel_ready now
4509 let mut channel_state_lock = self.channel_state.lock().unwrap();
4510 let channel_state = &mut *channel_state_lock;
4511 match channel_state.by_id.entry(funding_msg.channel_id) {
4512 hash_map::Entry::Occupied(_) => {
4513 return Err(MsgHandleErrInternal::send_err_msg_no_close("Already had channel with the new channel_id".to_owned(), funding_msg.channel_id))
4515 hash_map::Entry::Vacant(e) => {
4516 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
4517 node_id: counterparty_node_id.clone(),
4520 if let Some(msg) = channel_ready {
4521 send_channel_ready!(channel_state.short_to_chan_info, channel_state.pending_msg_events, chan, msg);
4529 fn internal_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), MsgHandleErrInternal> {
4531 let best_block = *self.best_block.read().unwrap();
4532 let mut channel_lock = self.channel_state.lock().unwrap();
4533 let channel_state = &mut *channel_lock;
4534 match channel_state.by_id.entry(msg.channel_id) {
4535 hash_map::Entry::Occupied(mut chan) => {
4536 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4537 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4539 let (monitor, funding_tx, channel_ready) = match chan.get_mut().funding_signed(&msg, best_block, &self.logger) {
4540 Ok(update) => update,
4541 Err(e) => try_chan_entry!(self, Err(e), channel_state, chan),
4543 if let Err(e) = self.chain_monitor.watch_channel(chan.get().get_funding_txo().unwrap(), monitor) {
4544 let mut res = handle_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::RevokeAndACKFirst, channel_ready.is_some(), OPTIONALLY_RESEND_FUNDING_LOCKED);
4545 if let Err(MsgHandleErrInternal { ref mut shutdown_finish, .. }) = res {
4546 // We weren't able to watch the channel to begin with, so no updates should be made on
4547 // it. Previously, full_stack_target found an (unreachable) panic when the
4548 // monitor update contained within `shutdown_finish` was applied.
4549 if let Some((ref mut shutdown_finish, _)) = shutdown_finish {
4550 shutdown_finish.0.take();
4555 if let Some(msg) = channel_ready {
4556 send_channel_ready!(channel_state.short_to_chan_info, channel_state.pending_msg_events, chan.get(), msg);
4560 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4563 log_info!(self.logger, "Broadcasting funding transaction with txid {}", funding_tx.txid());
4564 self.tx_broadcaster.broadcast_transaction(&funding_tx);
4568 fn internal_channel_ready(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReady) -> Result<(), MsgHandleErrInternal> {
4569 let mut channel_state_lock = self.channel_state.lock().unwrap();
4570 let channel_state = &mut *channel_state_lock;
4571 match channel_state.by_id.entry(msg.channel_id) {
4572 hash_map::Entry::Occupied(mut chan) => {
4573 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4574 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4576 let announcement_sigs_opt = try_chan_entry!(self, chan.get_mut().channel_ready(&msg, self.get_our_node_id(),
4577 self.genesis_hash.clone(), &self.best_block.read().unwrap(), &self.logger), channel_state, chan);
4578 if let Some(announcement_sigs) = announcement_sigs_opt {
4579 log_trace!(self.logger, "Sending announcement_signatures for channel {}", log_bytes!(chan.get().channel_id()));
4580 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
4581 node_id: counterparty_node_id.clone(),
4582 msg: announcement_sigs,
4584 } else if chan.get().is_usable() {
4585 // If we're sending an announcement_signatures, we'll send the (public)
4586 // channel_update after sending a channel_announcement when we receive our
4587 // counterparty's announcement_signatures. Thus, we only bother to send a
4588 // channel_update here if the channel is not public, i.e. we're not sending an
4589 // announcement_signatures.
4590 log_trace!(self.logger, "Sending private initial channel_update for our counterparty on channel {}", log_bytes!(chan.get().channel_id()));
4591 if let Ok(msg) = self.get_channel_update_for_unicast(chan.get()) {
4592 channel_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
4593 node_id: counterparty_node_id.clone(),
4600 hash_map::Entry::Vacant(_) => Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4604 fn internal_shutdown(&self, counterparty_node_id: &PublicKey, their_features: &InitFeatures, msg: &msgs::Shutdown) -> Result<(), MsgHandleErrInternal> {
4605 let mut dropped_htlcs: Vec<(HTLCSource, PaymentHash)>;
4606 let result: Result<(), _> = loop {
4607 let mut channel_state_lock = self.channel_state.lock().unwrap();
4608 let channel_state = &mut *channel_state_lock;
4610 match channel_state.by_id.entry(msg.channel_id.clone()) {
4611 hash_map::Entry::Occupied(mut chan_entry) => {
4612 if chan_entry.get().get_counterparty_node_id() != *counterparty_node_id {
4613 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4616 if !chan_entry.get().received_shutdown() {
4617 log_info!(self.logger, "Received a shutdown message from our counterparty for channel {}{}.",
4618 log_bytes!(msg.channel_id),
4619 if chan_entry.get().sent_shutdown() { " after we initiated shutdown" } else { "" });
4622 let (shutdown, monitor_update, htlcs) = try_chan_entry!(self, chan_entry.get_mut().shutdown(&self.keys_manager, &their_features, &msg), channel_state, chan_entry);
4623 dropped_htlcs = htlcs;
4625 // Update the monitor with the shutdown script if necessary.
4626 if let Some(monitor_update) = monitor_update {
4627 if let Err(e) = self.chain_monitor.update_channel(chan_entry.get().get_funding_txo().unwrap(), monitor_update) {
4628 let (result, is_permanent) =
4629 handle_monitor_err!(self, e, channel_state.short_to_chan_info, chan_entry.get_mut(), RAACommitmentOrder::CommitmentFirst, chan_entry.key(), NO_UPDATE);
4631 remove_channel!(self, channel_state, chan_entry);
4637 if let Some(msg) = shutdown {
4638 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
4639 node_id: *counterparty_node_id,
4646 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4649 for htlc_source in dropped_htlcs.drain(..) {
4650 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() });
4653 let _ = handle_error!(self, result, *counterparty_node_id);
4657 fn internal_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<(), MsgHandleErrInternal> {
4658 let (tx, chan_option) = {
4659 let mut channel_state_lock = self.channel_state.lock().unwrap();
4660 let channel_state = &mut *channel_state_lock;
4661 match channel_state.by_id.entry(msg.channel_id.clone()) {
4662 hash_map::Entry::Occupied(mut chan_entry) => {
4663 if chan_entry.get().get_counterparty_node_id() != *counterparty_node_id {
4664 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4666 let (closing_signed, tx) = try_chan_entry!(self, chan_entry.get_mut().closing_signed(&self.fee_estimator, &msg), channel_state, chan_entry);
4667 if let Some(msg) = closing_signed {
4668 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
4669 node_id: counterparty_node_id.clone(),
4674 // We're done with this channel, we've got a signed closing transaction and
4675 // will send the closing_signed back to the remote peer upon return. This
4676 // also implies there are no pending HTLCs left on the channel, so we can
4677 // fully delete it from tracking (the channel monitor is still around to
4678 // watch for old state broadcasts)!
4679 (tx, Some(remove_channel!(self, channel_state, chan_entry)))
4680 } else { (tx, None) }
4682 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4685 if let Some(broadcast_tx) = tx {
4686 log_info!(self.logger, "Broadcasting {}", log_tx!(broadcast_tx));
4687 self.tx_broadcaster.broadcast_transaction(&broadcast_tx);
4689 if let Some(chan) = chan_option {
4690 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
4691 let mut channel_state = self.channel_state.lock().unwrap();
4692 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
4696 self.issue_channel_close_events(&chan, ClosureReason::CooperativeClosure);
4701 fn internal_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), MsgHandleErrInternal> {
4702 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
4703 //determine the state of the payment based on our response/if we forward anything/the time
4704 //we take to respond. We should take care to avoid allowing such an attack.
4706 //TODO: There exists a further attack where a node may garble the onion data, forward it to
4707 //us repeatedly garbled in different ways, and compare our error messages, which are
4708 //encrypted with the same key. It's not immediately obvious how to usefully exploit that,
4709 //but we should prevent it anyway.
4711 let (pending_forward_info, mut channel_state_lock) = self.decode_update_add_htlc_onion(msg);
4712 let channel_state = &mut *channel_state_lock;
4714 match channel_state.by_id.entry(msg.channel_id) {
4715 hash_map::Entry::Occupied(mut chan) => {
4716 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4717 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4720 let create_pending_htlc_status = |chan: &Channel<Signer>, pending_forward_info: PendingHTLCStatus, error_code: u16| {
4721 // If the update_add is completely bogus, the call will Err and we will close,
4722 // but if we've sent a shutdown and they haven't acknowledged it yet, we just
4723 // want to reject the new HTLC and fail it backwards instead of forwarding.
4724 match pending_forward_info {
4725 PendingHTLCStatus::Forward(PendingHTLCInfo { ref incoming_shared_secret, .. }) => {
4726 let reason = if (error_code & 0x1000) != 0 {
4727 let (real_code, error_data) = self.get_htlc_inbound_temp_fail_err_and_data(error_code, chan);
4728 onion_utils::build_first_hop_failure_packet(incoming_shared_secret, real_code, &error_data)
4730 onion_utils::build_first_hop_failure_packet(incoming_shared_secret, error_code, &[])
4732 let msg = msgs::UpdateFailHTLC {
4733 channel_id: msg.channel_id,
4734 htlc_id: msg.htlc_id,
4737 PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msg))
4739 _ => pending_forward_info
4742 try_chan_entry!(self, chan.get_mut().update_add_htlc(&msg, pending_forward_info, create_pending_htlc_status, &self.logger), channel_state, chan);
4744 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4749 fn internal_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), MsgHandleErrInternal> {
4750 let mut channel_lock = self.channel_state.lock().unwrap();
4751 let (htlc_source, forwarded_htlc_value) = {
4752 let channel_state = &mut *channel_lock;
4753 match channel_state.by_id.entry(msg.channel_id) {
4754 hash_map::Entry::Occupied(mut chan) => {
4755 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4756 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4758 try_chan_entry!(self, chan.get_mut().update_fulfill_htlc(&msg), channel_state, chan)
4760 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4763 self.claim_funds_internal(channel_lock, htlc_source, msg.payment_preimage.clone(), Some(forwarded_htlc_value), false, msg.channel_id);
4767 fn internal_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), MsgHandleErrInternal> {
4768 let mut channel_lock = self.channel_state.lock().unwrap();
4769 let channel_state = &mut *channel_lock;
4770 match channel_state.by_id.entry(msg.channel_id) {
4771 hash_map::Entry::Occupied(mut chan) => {
4772 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4773 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4775 try_chan_entry!(self, chan.get_mut().update_fail_htlc(&msg, HTLCFailReason::LightningError { err: msg.reason.clone() }), channel_state, chan);
4777 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4782 fn internal_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), MsgHandleErrInternal> {
4783 let mut channel_lock = self.channel_state.lock().unwrap();
4784 let channel_state = &mut *channel_lock;
4785 match channel_state.by_id.entry(msg.channel_id) {
4786 hash_map::Entry::Occupied(mut chan) => {
4787 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4788 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4790 if (msg.failure_code & 0x8000) == 0 {
4791 let chan_err: ChannelError = ChannelError::Close("Got update_fail_malformed_htlc with BADONION not set".to_owned());
4792 try_chan_entry!(self, Err(chan_err), channel_state, chan);
4794 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);
4797 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4801 fn internal_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), MsgHandleErrInternal> {
4802 let mut channel_state_lock = self.channel_state.lock().unwrap();
4803 let channel_state = &mut *channel_state_lock;
4804 match channel_state.by_id.entry(msg.channel_id) {
4805 hash_map::Entry::Occupied(mut chan) => {
4806 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4807 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4809 let (revoke_and_ack, commitment_signed, monitor_update) =
4810 match chan.get_mut().commitment_signed(&msg, &self.logger) {
4811 Err((None, e)) => try_chan_entry!(self, Err(e), channel_state, chan),
4812 Err((Some(update), e)) => {
4813 assert!(chan.get().is_awaiting_monitor_update());
4814 let _ = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), update);
4815 try_chan_entry!(self, Err(e), channel_state, chan);
4820 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
4821 return_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::RevokeAndACKFirst, true, commitment_signed.is_some());
4823 channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
4824 node_id: counterparty_node_id.clone(),
4825 msg: revoke_and_ack,
4827 if let Some(msg) = commitment_signed {
4828 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
4829 node_id: counterparty_node_id.clone(),
4830 updates: msgs::CommitmentUpdate {
4831 update_add_htlcs: Vec::new(),
4832 update_fulfill_htlcs: Vec::new(),
4833 update_fail_htlcs: Vec::new(),
4834 update_fail_malformed_htlcs: Vec::new(),
4836 commitment_signed: msg,
4842 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4847 fn forward_htlcs(&self, per_source_pending_forwards: &mut [(u64, OutPoint, Vec<(PendingHTLCInfo, u64)>)]) {
4848 for &mut (prev_short_channel_id, prev_funding_outpoint, ref mut pending_forwards) in per_source_pending_forwards {
4849 let mut forward_event = None;
4850 if !pending_forwards.is_empty() {
4851 let mut channel_state = self.channel_state.lock().unwrap();
4852 if channel_state.forward_htlcs.is_empty() {
4853 forward_event = Some(Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS))
4855 for (forward_info, prev_htlc_id) in pending_forwards.drain(..) {
4856 match channel_state.forward_htlcs.entry(match forward_info.routing {
4857 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
4858 PendingHTLCRouting::Receive { .. } => 0,
4859 PendingHTLCRouting::ReceiveKeysend { .. } => 0,
4861 hash_map::Entry::Occupied(mut entry) => {
4862 entry.get_mut().push(HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_funding_outpoint,
4863 prev_htlc_id, forward_info });
4865 hash_map::Entry::Vacant(entry) => {
4866 entry.insert(vec!(HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_funding_outpoint,
4867 prev_htlc_id, forward_info }));
4872 match forward_event {
4874 let mut pending_events = self.pending_events.lock().unwrap();
4875 pending_events.push(events::Event::PendingHTLCsForwardable {
4876 time_forwardable: time
4884 fn internal_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), MsgHandleErrInternal> {
4885 let mut htlcs_to_fail = Vec::new();
4887 let mut channel_state_lock = self.channel_state.lock().unwrap();
4888 let channel_state = &mut *channel_state_lock;
4889 match channel_state.by_id.entry(msg.channel_id) {
4890 hash_map::Entry::Occupied(mut chan) => {
4891 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4892 break Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4894 let was_frozen_for_monitor = chan.get().is_awaiting_monitor_update();
4895 let raa_updates = break_chan_entry!(self,
4896 chan.get_mut().revoke_and_ack(&msg, &self.logger), channel_state, chan);
4897 htlcs_to_fail = raa_updates.holding_cell_failed_htlcs;
4898 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), raa_updates.monitor_update) {
4899 if was_frozen_for_monitor {
4900 assert!(raa_updates.commitment_update.is_none());
4901 assert!(raa_updates.accepted_htlcs.is_empty());
4902 assert!(raa_updates.failed_htlcs.is_empty());
4903 assert!(raa_updates.finalized_claimed_htlcs.is_empty());
4904 break Err(MsgHandleErrInternal::ignore_no_close("Previous monitor update failure prevented responses to RAA".to_owned()));
4906 if let Err(e) = handle_monitor_err!(self, e, channel_state, chan,
4907 RAACommitmentOrder::CommitmentFirst, false,
4908 raa_updates.commitment_update.is_some(), false,
4909 raa_updates.accepted_htlcs, raa_updates.failed_htlcs,
4910 raa_updates.finalized_claimed_htlcs) {
4912 } else { unreachable!(); }
4915 if let Some(updates) = raa_updates.commitment_update {
4916 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
4917 node_id: counterparty_node_id.clone(),
4921 break Ok((raa_updates.accepted_htlcs, raa_updates.failed_htlcs,
4922 raa_updates.finalized_claimed_htlcs,
4923 chan.get().get_short_channel_id()
4924 .unwrap_or(chan.get().outbound_scid_alias()),
4925 chan.get().get_funding_txo().unwrap()))
4927 hash_map::Entry::Vacant(_) => break Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4930 self.fail_holding_cell_htlcs(htlcs_to_fail, msg.channel_id, counterparty_node_id);
4932 Ok((pending_forwards, mut pending_failures, finalized_claim_htlcs,
4933 short_channel_id, channel_outpoint)) =>
4935 for failure in pending_failures.drain(..) {
4936 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), failure.0, &failure.1, failure.2);
4938 self.forward_htlcs(&mut [(short_channel_id, channel_outpoint, pending_forwards)]);
4939 self.finalize_claims(finalized_claim_htlcs);
4946 fn internal_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), MsgHandleErrInternal> {
4947 let mut channel_lock = self.channel_state.lock().unwrap();
4948 let channel_state = &mut *channel_lock;
4949 match channel_state.by_id.entry(msg.channel_id) {
4950 hash_map::Entry::Occupied(mut chan) => {
4951 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4952 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4954 try_chan_entry!(self, chan.get_mut().update_fee(&self.fee_estimator, &msg), channel_state, chan);
4956 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4961 fn internal_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), MsgHandleErrInternal> {
4962 let mut channel_state_lock = self.channel_state.lock().unwrap();
4963 let channel_state = &mut *channel_state_lock;
4965 match channel_state.by_id.entry(msg.channel_id) {
4966 hash_map::Entry::Occupied(mut chan) => {
4967 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4968 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4970 if !chan.get().is_usable() {
4971 return Err(MsgHandleErrInternal::from_no_close(LightningError{err: "Got an announcement_signatures before we were ready for it".to_owned(), action: msgs::ErrorAction::IgnoreError}));
4974 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
4975 msg: try_chan_entry!(self, chan.get_mut().announcement_signatures(
4976 self.get_our_node_id(), self.genesis_hash.clone(), self.best_block.read().unwrap().height(), msg), channel_state, chan),
4977 // Note that announcement_signatures fails if the channel cannot be announced,
4978 // so get_channel_update_for_broadcast will never fail by the time we get here.
4979 update_msg: self.get_channel_update_for_broadcast(chan.get()).unwrap(),
4982 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4987 /// Returns ShouldPersist if anything changed, otherwise either SkipPersist or an Err.
4988 fn internal_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) -> Result<NotifyOption, MsgHandleErrInternal> {
4989 let mut channel_state_lock = self.channel_state.lock().unwrap();
4990 let channel_state = &mut *channel_state_lock;
4991 let chan_id = match channel_state.short_to_chan_info.get(&msg.contents.short_channel_id) {
4992 Some((_cp_id, chan_id)) => chan_id.clone(),
4994 // It's not a local channel
4995 return Ok(NotifyOption::SkipPersist)
4998 match channel_state.by_id.entry(chan_id) {
4999 hash_map::Entry::Occupied(mut chan) => {
5000 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
5001 if chan.get().should_announce() {
5002 // If the announcement is about a channel of ours which is public, some
5003 // other peer may simply be forwarding all its gossip to us. Don't provide
5004 // a scary-looking error message and return Ok instead.
5005 return Ok(NotifyOption::SkipPersist);
5007 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));
5009 let were_node_one = self.get_our_node_id().serialize()[..] < chan.get().get_counterparty_node_id().serialize()[..];
5010 let msg_from_node_one = msg.contents.flags & 1 == 0;
5011 if were_node_one == msg_from_node_one {
5012 return Ok(NotifyOption::SkipPersist);
5014 try_chan_entry!(self, chan.get_mut().channel_update(&msg), channel_state, chan);
5017 hash_map::Entry::Vacant(_) => unreachable!()
5019 Ok(NotifyOption::DoPersist)
5022 fn internal_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<(), MsgHandleErrInternal> {
5023 let chan_restoration_res;
5024 let (htlcs_failed_forward, need_lnd_workaround) = {
5025 let mut channel_state_lock = self.channel_state.lock().unwrap();
5026 let channel_state = &mut *channel_state_lock;
5028 match channel_state.by_id.entry(msg.channel_id) {
5029 hash_map::Entry::Occupied(mut chan) => {
5030 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
5031 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
5033 // Currently, we expect all holding cell update_adds to be dropped on peer
5034 // disconnect, so Channel's reestablish will never hand us any holding cell
5035 // freed HTLCs to fail backwards. If in the future we no longer drop pending
5036 // add-HTLCs on disconnect, we may be handed HTLCs to fail backwards here.
5037 let responses = try_chan_entry!(self, chan.get_mut().channel_reestablish(
5038 msg, &self.logger, self.our_network_pubkey.clone(), self.genesis_hash,
5039 &*self.best_block.read().unwrap()), channel_state, chan);
5040 let mut channel_update = None;
5041 if let Some(msg) = responses.shutdown_msg {
5042 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
5043 node_id: counterparty_node_id.clone(),
5046 } else if chan.get().is_usable() {
5047 // If the channel is in a usable state (ie the channel is not being shut
5048 // down), send a unicast channel_update to our counterparty to make sure
5049 // they have the latest channel parameters.
5050 if let Ok(msg) = self.get_channel_update_for_unicast(chan.get()) {
5051 channel_update = Some(events::MessageSendEvent::SendChannelUpdate {
5052 node_id: chan.get().get_counterparty_node_id(),
5057 let need_lnd_workaround = chan.get_mut().workaround_lnd_bug_4006.take();
5058 chan_restoration_res = handle_chan_restoration_locked!(
5059 self, channel_state_lock, channel_state, chan, responses.raa, responses.commitment_update, responses.order,
5060 responses.mon_update, Vec::new(), None, responses.channel_ready, responses.announcement_sigs);
5061 if let Some(upd) = channel_update {
5062 channel_state.pending_msg_events.push(upd);
5064 (responses.holding_cell_failed_htlcs, need_lnd_workaround)
5066 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
5069 post_handle_chan_restoration!(self, chan_restoration_res);
5070 self.fail_holding_cell_htlcs(htlcs_failed_forward, msg.channel_id, counterparty_node_id);
5072 if let Some(channel_ready_msg) = need_lnd_workaround {
5073 self.internal_channel_ready(counterparty_node_id, &channel_ready_msg)?;
5078 /// Process pending events from the `chain::Watch`, returning whether any events were processed.
5079 fn process_pending_monitor_events(&self) -> bool {
5080 let mut failed_channels = Vec::new();
5081 let mut pending_monitor_events = self.chain_monitor.release_pending_monitor_events();
5082 let has_pending_monitor_events = !pending_monitor_events.is_empty();
5083 for (funding_outpoint, mut monitor_events) in pending_monitor_events.drain(..) {
5084 for monitor_event in monitor_events.drain(..) {
5085 match monitor_event {
5086 MonitorEvent::HTLCEvent(htlc_update) => {
5087 if let Some(preimage) = htlc_update.payment_preimage {
5088 log_trace!(self.logger, "Claiming HTLC with preimage {} from our monitor", log_bytes!(preimage.0));
5089 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());
5091 log_trace!(self.logger, "Failing HTLC with hash {} from our monitor", log_bytes!(htlc_update.payment_hash.0));
5092 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() });
5095 MonitorEvent::CommitmentTxConfirmed(funding_outpoint) |
5096 MonitorEvent::UpdateFailed(funding_outpoint) => {
5097 let mut channel_lock = self.channel_state.lock().unwrap();
5098 let channel_state = &mut *channel_lock;
5099 let by_id = &mut channel_state.by_id;
5100 let pending_msg_events = &mut channel_state.pending_msg_events;
5101 if let hash_map::Entry::Occupied(chan_entry) = by_id.entry(funding_outpoint.to_channel_id()) {
5102 let mut chan = remove_channel!(self, channel_state, chan_entry);
5103 failed_channels.push(chan.force_shutdown(false));
5104 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
5105 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
5109 let reason = if let MonitorEvent::UpdateFailed(_) = monitor_event {
5110 ClosureReason::ProcessingError { err: "Failed to persist ChannelMonitor update during chain sync".to_string() }
5112 ClosureReason::CommitmentTxConfirmed
5114 self.issue_channel_close_events(&chan, reason);
5115 pending_msg_events.push(events::MessageSendEvent::HandleError {
5116 node_id: chan.get_counterparty_node_id(),
5117 action: msgs::ErrorAction::SendErrorMessage {
5118 msg: msgs::ErrorMessage { channel_id: chan.channel_id(), data: "Channel force-closed".to_owned() }
5123 MonitorEvent::UpdateCompleted { funding_txo, monitor_update_id } => {
5124 self.channel_monitor_updated(&funding_txo, monitor_update_id);
5130 for failure in failed_channels.drain(..) {
5131 self.finish_force_close_channel(failure);
5134 has_pending_monitor_events
5137 /// In chanmon_consistency_target, we'd like to be able to restore monitor updating without
5138 /// handling all pending events (i.e. not PendingHTLCsForwardable). Thus, we expose monitor
5139 /// update events as a separate process method here.
5141 pub fn process_monitor_events(&self) {
5142 self.process_pending_monitor_events();
5145 /// Check the holding cell in each channel and free any pending HTLCs in them if possible.
5146 /// Returns whether there were any updates such as if pending HTLCs were freed or a monitor
5147 /// update was applied.
5149 /// This should only apply to HTLCs which were added to the holding cell because we were
5150 /// waiting on a monitor update to finish. In that case, we don't want to free the holding cell
5151 /// directly in `channel_monitor_updated` as it may introduce deadlocks calling back into user
5152 /// code to inform them of a channel monitor update.
5153 fn check_free_holding_cells(&self) -> bool {
5154 let mut has_monitor_update = false;
5155 let mut failed_htlcs = Vec::new();
5156 let mut handle_errors = Vec::new();
5158 let mut channel_state_lock = self.channel_state.lock().unwrap();
5159 let channel_state = &mut *channel_state_lock;
5160 let by_id = &mut channel_state.by_id;
5161 let short_to_chan_info = &mut channel_state.short_to_chan_info;
5162 let pending_msg_events = &mut channel_state.pending_msg_events;
5164 by_id.retain(|channel_id, chan| {
5165 match chan.maybe_free_holding_cell_htlcs(&self.logger) {
5166 Ok((commitment_opt, holding_cell_failed_htlcs)) => {
5167 if !holding_cell_failed_htlcs.is_empty() {
5169 holding_cell_failed_htlcs,
5171 chan.get_counterparty_node_id()
5174 if let Some((commitment_update, monitor_update)) = commitment_opt {
5175 if let Err(e) = self.chain_monitor.update_channel(chan.get_funding_txo().unwrap(), monitor_update) {
5176 has_monitor_update = true;
5177 let (res, close_channel) = handle_monitor_err!(self, e, short_to_chan_info, chan, RAACommitmentOrder::CommitmentFirst, channel_id, COMMITMENT_UPDATE_ONLY);
5178 handle_errors.push((chan.get_counterparty_node_id(), res));
5179 if close_channel { return false; }
5181 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
5182 node_id: chan.get_counterparty_node_id(),
5183 updates: commitment_update,
5190 let (close_channel, res) = convert_chan_err!(self, e, short_to_chan_info, chan, channel_id);
5191 handle_errors.push((chan.get_counterparty_node_id(), Err(res)));
5192 // ChannelClosed event is generated by handle_error for us
5199 let has_update = has_monitor_update || !failed_htlcs.is_empty() || !handle_errors.is_empty();
5200 for (failures, channel_id, counterparty_node_id) in failed_htlcs.drain(..) {
5201 self.fail_holding_cell_htlcs(failures, channel_id, &counterparty_node_id);
5204 for (counterparty_node_id, err) in handle_errors.drain(..) {
5205 let _ = handle_error!(self, err, counterparty_node_id);
5211 /// Check whether any channels have finished removing all pending updates after a shutdown
5212 /// exchange and can now send a closing_signed.
5213 /// Returns whether any closing_signed messages were generated.
5214 fn maybe_generate_initial_closing_signed(&self) -> bool {
5215 let mut handle_errors: Vec<(PublicKey, Result<(), _>)> = Vec::new();
5216 let mut has_update = false;
5218 let mut channel_state_lock = self.channel_state.lock().unwrap();
5219 let channel_state = &mut *channel_state_lock;
5220 let by_id = &mut channel_state.by_id;
5221 let short_to_chan_info = &mut channel_state.short_to_chan_info;
5222 let pending_msg_events = &mut channel_state.pending_msg_events;
5224 by_id.retain(|channel_id, chan| {
5225 match chan.maybe_propose_closing_signed(&self.fee_estimator, &self.logger) {
5226 Ok((msg_opt, tx_opt)) => {
5227 if let Some(msg) = msg_opt {
5229 pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
5230 node_id: chan.get_counterparty_node_id(), msg,
5233 if let Some(tx) = tx_opt {
5234 // We're done with this channel. We got a closing_signed and sent back
5235 // a closing_signed with a closing transaction to broadcast.
5236 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
5237 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
5242 self.issue_channel_close_events(chan, ClosureReason::CooperativeClosure);
5244 log_info!(self.logger, "Broadcasting {}", log_tx!(tx));
5245 self.tx_broadcaster.broadcast_transaction(&tx);
5246 update_maps_on_chan_removal!(self, short_to_chan_info, chan);
5252 let (close_channel, res) = convert_chan_err!(self, e, short_to_chan_info, chan, channel_id);
5253 handle_errors.push((chan.get_counterparty_node_id(), Err(res)));
5260 for (counterparty_node_id, err) in handle_errors.drain(..) {
5261 let _ = handle_error!(self, err, counterparty_node_id);
5267 /// Handle a list of channel failures during a block_connected or block_disconnected call,
5268 /// pushing the channel monitor update (if any) to the background events queue and removing the
5270 fn handle_init_event_channel_failures(&self, mut failed_channels: Vec<ShutdownResult>) {
5271 for mut failure in failed_channels.drain(..) {
5272 // Either a commitment transactions has been confirmed on-chain or
5273 // Channel::block_disconnected detected that the funding transaction has been
5274 // reorganized out of the main chain.
5275 // We cannot broadcast our latest local state via monitor update (as
5276 // Channel::force_shutdown tries to make us do) as we may still be in initialization,
5277 // so we track the update internally and handle it when the user next calls
5278 // timer_tick_occurred, guaranteeing we're running normally.
5279 if let Some((funding_txo, update)) = failure.0.take() {
5280 assert_eq!(update.updates.len(), 1);
5281 if let ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } = update.updates[0] {
5282 assert!(should_broadcast);
5283 } else { unreachable!(); }
5284 self.pending_background_events.lock().unwrap().push(BackgroundEvent::ClosingMonitorUpdate((funding_txo, update)));
5286 self.finish_force_close_channel(failure);
5290 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> {
5291 assert!(invoice_expiry_delta_secs <= 60*60*24*365); // Sadly bitcoin timestamps are u32s, so panic before 2106
5293 if min_value_msat.is_some() && min_value_msat.unwrap() > MAX_VALUE_MSAT {
5294 return Err(APIError::APIMisuseError { err: format!("min_value_msat of {} greater than total 21 million bitcoin supply", min_value_msat.unwrap()) });
5297 let payment_secret = PaymentSecret(self.keys_manager.get_secure_random_bytes());
5299 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5300 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
5301 match payment_secrets.entry(payment_hash) {
5302 hash_map::Entry::Vacant(e) => {
5303 e.insert(PendingInboundPayment {
5304 payment_secret, min_value_msat, payment_preimage,
5305 user_payment_id: 0, // For compatibility with version 0.0.103 and earlier
5306 // We assume that highest_seen_timestamp is pretty close to the current time -
5307 // it's updated when we receive a new block with the maximum time we've seen in
5308 // a header. It should never be more than two hours in the future.
5309 // Thus, we add two hours here as a buffer to ensure we absolutely
5310 // never fail a payment too early.
5311 // Note that we assume that received blocks have reasonably up-to-date
5313 expiry_time: self.highest_seen_timestamp.load(Ordering::Acquire) as u64 + invoice_expiry_delta_secs as u64 + 7200,
5316 hash_map::Entry::Occupied(_) => return Err(APIError::APIMisuseError { err: "Duplicate payment hash".to_owned() }),
5321 /// Gets a payment secret and payment hash for use in an invoice given to a third party wishing
5324 /// This differs from [`create_inbound_payment_for_hash`] only in that it generates the
5325 /// [`PaymentHash`] and [`PaymentPreimage`] for you.
5327 /// The [`PaymentPreimage`] will ultimately be returned to you in the [`PaymentReceived`], which
5328 /// will have the [`PaymentReceived::payment_preimage`] field filled in. That should then be
5329 /// passed directly to [`claim_funds`].
5331 /// See [`create_inbound_payment_for_hash`] for detailed documentation on behavior and requirements.
5333 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
5334 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
5338 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
5339 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
5341 /// Errors if `min_value_msat` is greater than total bitcoin supply.
5343 /// [`claim_funds`]: Self::claim_funds
5344 /// [`PaymentReceived`]: events::Event::PaymentReceived
5345 /// [`PaymentReceived::payment_preimage`]: events::Event::PaymentReceived::payment_preimage
5346 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
5347 pub fn create_inbound_payment(&self, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32) -> Result<(PaymentHash, PaymentSecret), ()> {
5348 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)
5351 /// Legacy version of [`create_inbound_payment`]. Use this method if you wish to share
5352 /// serialized state with LDK node(s) running 0.0.103 and earlier.
5354 /// May panic if `invoice_expiry_delta_secs` is greater than one year.
5357 /// This method is deprecated and will be removed soon.
5359 /// [`create_inbound_payment`]: Self::create_inbound_payment
5361 pub fn create_inbound_payment_legacy(&self, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32) -> Result<(PaymentHash, PaymentSecret), APIError> {
5362 let payment_preimage = PaymentPreimage(self.keys_manager.get_secure_random_bytes());
5363 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
5364 let payment_secret = self.set_payment_hash_secret_map(payment_hash, Some(payment_preimage), min_value_msat, invoice_expiry_delta_secs)?;
5365 Ok((payment_hash, payment_secret))
5368 /// Gets a [`PaymentSecret`] for a given [`PaymentHash`], for which the payment preimage is
5369 /// stored external to LDK.
5371 /// A [`PaymentReceived`] event will only be generated if the [`PaymentSecret`] matches a
5372 /// payment secret fetched via this method or [`create_inbound_payment`], and which is at least
5373 /// the `min_value_msat` provided here, if one is provided.
5375 /// The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) should be globally unique, though
5376 /// note that LDK will not stop you from registering duplicate payment hashes for inbound
5379 /// `min_value_msat` should be set if the invoice being generated contains a value. Any payment
5380 /// received for the returned [`PaymentHash`] will be required to be at least `min_value_msat`
5381 /// before a [`PaymentReceived`] event will be generated, ensuring that we do not provide the
5382 /// sender "proof-of-payment" unless they have paid the required amount.
5384 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
5385 /// in excess of the current time. This should roughly match the expiry time set in the invoice.
5386 /// After this many seconds, we will remove the inbound payment, resulting in any attempts to
5387 /// pay the invoice failing. The BOLT spec suggests 3,600 secs as a default validity time for
5388 /// invoices when no timeout is set.
5390 /// Note that we use block header time to time-out pending inbound payments (with some margin
5391 /// to compensate for the inaccuracy of block header timestamps). Thus, in practice we will
5392 /// accept a payment and generate a [`PaymentReceived`] event for some time after the expiry.
5393 /// If you need exact expiry semantics, you should enforce them upon receipt of
5394 /// [`PaymentReceived`].
5396 /// Note that invoices generated for inbound payments should have their `min_final_cltv_expiry`
5397 /// set to at least [`MIN_FINAL_CLTV_EXPIRY`].
5399 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
5400 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
5404 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
5405 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
5407 /// Errors if `min_value_msat` is greater than total bitcoin supply.
5409 /// [`create_inbound_payment`]: Self::create_inbound_payment
5410 /// [`PaymentReceived`]: events::Event::PaymentReceived
5411 pub fn create_inbound_payment_for_hash(&self, payment_hash: PaymentHash, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32) -> Result<PaymentSecret, ()> {
5412 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)
5415 /// Legacy version of [`create_inbound_payment_for_hash`]. Use this method if you wish to share
5416 /// serialized state with LDK node(s) running 0.0.103 and earlier.
5418 /// May panic if `invoice_expiry_delta_secs` is greater than one year.
5421 /// This method is deprecated and will be removed soon.
5423 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
5425 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> {
5426 self.set_payment_hash_secret_map(payment_hash, None, min_value_msat, invoice_expiry_delta_secs)
5429 /// Gets an LDK-generated payment preimage from a payment hash and payment secret that were
5430 /// previously returned from [`create_inbound_payment`].
5432 /// [`create_inbound_payment`]: Self::create_inbound_payment
5433 pub fn get_payment_preimage(&self, payment_hash: PaymentHash, payment_secret: PaymentSecret) -> Result<PaymentPreimage, APIError> {
5434 inbound_payment::get_payment_preimage(payment_hash, payment_secret, &self.inbound_payment_key)
5437 /// Gets a fake short channel id for use in receiving [phantom node payments]. These fake scids
5438 /// are used when constructing the phantom invoice's route hints.
5440 /// [phantom node payments]: crate::chain::keysinterface::PhantomKeysManager
5441 pub fn get_phantom_scid(&self) -> u64 {
5442 let mut channel_state = self.channel_state.lock().unwrap();
5443 let best_block = self.best_block.read().unwrap();
5445 let scid_candidate = fake_scid::Namespace::Phantom.get_fake_scid(best_block.height(), &self.genesis_hash, &self.fake_scid_rand_bytes, &self.keys_manager);
5446 // Ensure the generated scid doesn't conflict with a real channel.
5447 match channel_state.short_to_chan_info.entry(scid_candidate) {
5448 hash_map::Entry::Occupied(_) => continue,
5449 hash_map::Entry::Vacant(_) => return scid_candidate
5454 /// Gets route hints for use in receiving [phantom node payments].
5456 /// [phantom node payments]: crate::chain::keysinterface::PhantomKeysManager
5457 pub fn get_phantom_route_hints(&self) -> PhantomRouteHints {
5459 channels: self.list_usable_channels(),
5460 phantom_scid: self.get_phantom_scid(),
5461 real_node_pubkey: self.get_our_node_id(),
5465 #[cfg(any(test, fuzzing, feature = "_test_utils"))]
5466 pub fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
5467 let events = core::cell::RefCell::new(Vec::new());
5468 let event_handler = |event: &events::Event| events.borrow_mut().push(event.clone());
5469 self.process_pending_events(&event_handler);
5474 pub fn has_pending_payments(&self) -> bool {
5475 !self.pending_outbound_payments.lock().unwrap().is_empty()
5479 pub fn clear_pending_payments(&self) {
5480 self.pending_outbound_payments.lock().unwrap().clear()
5484 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> MessageSendEventsProvider for ChannelManager<Signer, M, T, K, F, L>
5485 where M::Target: chain::Watch<Signer>,
5486 T::Target: BroadcasterInterface,
5487 K::Target: KeysInterface<Signer = Signer>,
5488 F::Target: FeeEstimator,
5491 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
5492 let events = RefCell::new(Vec::new());
5493 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
5494 let mut result = NotifyOption::SkipPersist;
5496 // TODO: This behavior should be documented. It's unintuitive that we query
5497 // ChannelMonitors when clearing other events.
5498 if self.process_pending_monitor_events() {
5499 result = NotifyOption::DoPersist;
5502 if self.check_free_holding_cells() {
5503 result = NotifyOption::DoPersist;
5505 if self.maybe_generate_initial_closing_signed() {
5506 result = NotifyOption::DoPersist;
5509 let mut pending_events = Vec::new();
5510 let mut channel_state = self.channel_state.lock().unwrap();
5511 mem::swap(&mut pending_events, &mut channel_state.pending_msg_events);
5513 if !pending_events.is_empty() {
5514 events.replace(pending_events);
5523 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> EventsProvider for ChannelManager<Signer, M, T, K, F, L>
5525 M::Target: chain::Watch<Signer>,
5526 T::Target: BroadcasterInterface,
5527 K::Target: KeysInterface<Signer = Signer>,
5528 F::Target: FeeEstimator,
5531 /// Processes events that must be periodically handled.
5533 /// An [`EventHandler`] may safely call back to the provider in order to handle an event.
5534 /// However, it must not call [`Writeable::write`] as doing so would result in a deadlock.
5536 /// Pending events are persisted as part of [`ChannelManager`]. While these events are cleared
5537 /// when processed, an [`EventHandler`] must be able to handle previously seen events when
5538 /// restarting from an old state.
5539 fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler {
5540 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
5541 let mut result = NotifyOption::SkipPersist;
5543 // TODO: This behavior should be documented. It's unintuitive that we query
5544 // ChannelMonitors when clearing other events.
5545 if self.process_pending_monitor_events() {
5546 result = NotifyOption::DoPersist;
5549 let mut pending_events = mem::replace(&mut *self.pending_events.lock().unwrap(), vec![]);
5550 if !pending_events.is_empty() {
5551 result = NotifyOption::DoPersist;
5554 for event in pending_events.drain(..) {
5555 handler.handle_event(&event);
5563 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> chain::Listen for ChannelManager<Signer, M, T, K, F, L>
5565 M::Target: chain::Watch<Signer>,
5566 T::Target: BroadcasterInterface,
5567 K::Target: KeysInterface<Signer = Signer>,
5568 F::Target: FeeEstimator,
5571 fn filtered_block_connected(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
5573 let best_block = self.best_block.read().unwrap();
5574 assert_eq!(best_block.block_hash(), header.prev_blockhash,
5575 "Blocks must be connected in chain-order - the connected header must build on the last connected header");
5576 assert_eq!(best_block.height(), height - 1,
5577 "Blocks must be connected in chain-order - the connected block height must be one greater than the previous height");
5580 self.transactions_confirmed(header, txdata, height);
5581 self.best_block_updated(header, height);
5584 fn block_disconnected(&self, header: &BlockHeader, height: u32) {
5585 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5586 let new_height = height - 1;
5588 let mut best_block = self.best_block.write().unwrap();
5589 assert_eq!(best_block.block_hash(), header.block_hash(),
5590 "Blocks must be disconnected in chain-order - the disconnected header must be the last connected header");
5591 assert_eq!(best_block.height(), height,
5592 "Blocks must be disconnected in chain-order - the disconnected block must have the correct height");
5593 *best_block = BestBlock::new(header.prev_blockhash, new_height)
5596 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));
5600 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> chain::Confirm for ChannelManager<Signer, M, T, K, F, L>
5602 M::Target: chain::Watch<Signer>,
5603 T::Target: BroadcasterInterface,
5604 K::Target: KeysInterface<Signer = Signer>,
5605 F::Target: FeeEstimator,
5608 fn transactions_confirmed(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
5609 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
5610 // during initialization prior to the chain_monitor being fully configured in some cases.
5611 // See the docs for `ChannelManagerReadArgs` for more.
5613 let block_hash = header.block_hash();
5614 log_trace!(self.logger, "{} transactions included in block {} at height {} provided", txdata.len(), block_hash, height);
5616 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5617 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)
5618 .map(|(a, b)| (a, Vec::new(), b)));
5620 let last_best_block_height = self.best_block.read().unwrap().height();
5621 if height < last_best_block_height {
5622 let timestamp = self.highest_seen_timestamp.load(Ordering::Acquire);
5623 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));
5627 fn best_block_updated(&self, header: &BlockHeader, height: u32) {
5628 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
5629 // during initialization prior to the chain_monitor being fully configured in some cases.
5630 // See the docs for `ChannelManagerReadArgs` for more.
5632 let block_hash = header.block_hash();
5633 log_trace!(self.logger, "New best block: {} at height {}", block_hash, height);
5635 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5637 *self.best_block.write().unwrap() = BestBlock::new(block_hash, height);
5639 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));
5641 macro_rules! max_time {
5642 ($timestamp: expr) => {
5644 // Update $timestamp to be the max of its current value and the block
5645 // timestamp. This should keep us close to the current time without relying on
5646 // having an explicit local time source.
5647 // Just in case we end up in a race, we loop until we either successfully
5648 // update $timestamp or decide we don't need to.
5649 let old_serial = $timestamp.load(Ordering::Acquire);
5650 if old_serial >= header.time as usize { break; }
5651 if $timestamp.compare_exchange(old_serial, header.time as usize, Ordering::AcqRel, Ordering::Relaxed).is_ok() {
5657 max_time!(self.last_node_announcement_serial);
5658 max_time!(self.highest_seen_timestamp);
5659 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
5660 payment_secrets.retain(|_, inbound_payment| {
5661 inbound_payment.expiry_time > header.time as u64
5664 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
5665 let mut pending_events = self.pending_events.lock().unwrap();
5666 outbounds.retain(|payment_id, payment| {
5667 if payment.remaining_parts() != 0 { return true }
5668 if let PendingOutboundPayment::Retryable { starting_block_height, payment_hash, .. } = payment {
5669 if *starting_block_height + PAYMENT_EXPIRY_BLOCKS <= height {
5670 log_info!(self.logger, "Timing out payment with id {} and hash {}", log_bytes!(payment_id.0), log_bytes!(payment_hash.0));
5671 pending_events.push(events::Event::PaymentFailed {
5672 payment_id: *payment_id, payment_hash: *payment_hash,
5680 fn get_relevant_txids(&self) -> Vec<Txid> {
5681 let channel_state = self.channel_state.lock().unwrap();
5682 let mut res = Vec::with_capacity(channel_state.short_to_chan_info.len());
5683 for chan in channel_state.by_id.values() {
5684 if let Some(funding_txo) = chan.get_funding_txo() {
5685 res.push(funding_txo.txid);
5691 fn transaction_unconfirmed(&self, txid: &Txid) {
5692 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5693 self.do_chain_event(None, |channel| {
5694 if let Some(funding_txo) = channel.get_funding_txo() {
5695 if funding_txo.txid == *txid {
5696 channel.funding_transaction_unconfirmed(&self.logger).map(|()| (None, Vec::new(), None))
5697 } else { Ok((None, Vec::new(), None)) }
5698 } else { Ok((None, Vec::new(), None)) }
5703 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<Signer, M, T, K, F, L>
5705 M::Target: chain::Watch<Signer>,
5706 T::Target: BroadcasterInterface,
5707 K::Target: KeysInterface<Signer = Signer>,
5708 F::Target: FeeEstimator,
5711 /// Calls a function which handles an on-chain event (blocks dis/connected, transactions
5712 /// un/confirmed, etc) on each channel, handling any resulting errors or messages generated by
5714 fn do_chain_event<FN: Fn(&mut Channel<Signer>) -> Result<(Option<msgs::ChannelReady>, Vec<(HTLCSource, PaymentHash)>, Option<msgs::AnnouncementSignatures>), ClosureReason>>
5715 (&self, height_opt: Option<u32>, f: FN) {
5716 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
5717 // during initialization prior to the chain_monitor being fully configured in some cases.
5718 // See the docs for `ChannelManagerReadArgs` for more.
5720 let mut failed_channels = Vec::new();
5721 let mut timed_out_htlcs = Vec::new();
5723 let mut channel_lock = self.channel_state.lock().unwrap();
5724 let channel_state = &mut *channel_lock;
5725 let short_to_chan_info = &mut channel_state.short_to_chan_info;
5726 let pending_msg_events = &mut channel_state.pending_msg_events;
5727 channel_state.by_id.retain(|_, channel| {
5728 let res = f(channel);
5729 if let Ok((channel_ready_opt, mut timed_out_pending_htlcs, announcement_sigs)) = res {
5730 for (source, payment_hash) in timed_out_pending_htlcs.drain(..) {
5731 let (failure_code, data) = self.get_htlc_inbound_temp_fail_err_and_data(0x1000|14 /* expiry_too_soon */, &channel);
5732 timed_out_htlcs.push((source, payment_hash, HTLCFailReason::Reason {
5736 if let Some(channel_ready) = channel_ready_opt {
5737 send_channel_ready!(short_to_chan_info, pending_msg_events, channel, channel_ready);
5738 if channel.is_usable() {
5739 log_trace!(self.logger, "Sending channel_ready with private initial channel_update for our counterparty on channel {}", log_bytes!(channel.channel_id()));
5740 if let Ok(msg) = self.get_channel_update_for_unicast(channel) {
5741 pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
5742 node_id: channel.get_counterparty_node_id(),
5747 log_trace!(self.logger, "Sending channel_ready WITHOUT channel_update for {}", log_bytes!(channel.channel_id()));
5750 if let Some(announcement_sigs) = announcement_sigs {
5751 log_trace!(self.logger, "Sending announcement_signatures for channel {}", log_bytes!(channel.channel_id()));
5752 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
5753 node_id: channel.get_counterparty_node_id(),
5754 msg: announcement_sigs,
5756 if let Some(height) = height_opt {
5757 if let Some(announcement) = channel.get_signed_channel_announcement(self.get_our_node_id(), self.genesis_hash, height) {
5758 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
5760 // Note that announcement_signatures fails if the channel cannot be announced,
5761 // so get_channel_update_for_broadcast will never fail by the time we get here.
5762 update_msg: self.get_channel_update_for_broadcast(channel).unwrap(),
5767 if channel.is_our_channel_ready() {
5768 if let Some(real_scid) = channel.get_short_channel_id() {
5769 // If we sent a 0conf channel_ready, and now have an SCID, we add it
5770 // to the short_to_chan_info map here. Note that we check whether we
5771 // can relay using the real SCID at relay-time (i.e.
5772 // enforce option_scid_alias then), and if the funding tx is ever
5773 // un-confirmed we force-close the channel, ensuring short_to_chan_info
5774 // is always consistent.
5775 let scid_insert = short_to_chan_info.insert(real_scid, (channel.get_counterparty_node_id(), channel.channel_id()));
5776 assert!(scid_insert.is_none() || scid_insert.unwrap() == (channel.get_counterparty_node_id(), channel.channel_id()),
5777 "SCIDs should never collide - ensure you weren't behind by a full {} blocks when creating channels",
5778 fake_scid::MAX_SCID_BLOCKS_FROM_NOW);
5781 } else if let Err(reason) = res {
5782 update_maps_on_chan_removal!(self, short_to_chan_info, channel);
5783 // It looks like our counterparty went on-chain or funding transaction was
5784 // reorged out of the main chain. Close the channel.
5785 failed_channels.push(channel.force_shutdown(true));
5786 if let Ok(update) = self.get_channel_update_for_broadcast(&channel) {
5787 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
5791 let reason_message = format!("{}", reason);
5792 self.issue_channel_close_events(channel, reason);
5793 pending_msg_events.push(events::MessageSendEvent::HandleError {
5794 node_id: channel.get_counterparty_node_id(),
5795 action: msgs::ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage {
5796 channel_id: channel.channel_id(),
5797 data: reason_message,
5805 if let Some(height) = height_opt {
5806 channel_state.claimable_htlcs.retain(|payment_hash, (_, htlcs)| {
5807 htlcs.retain(|htlc| {
5808 // If height is approaching the number of blocks we think it takes us to get
5809 // our commitment transaction confirmed before the HTLC expires, plus the
5810 // number of blocks we generally consider it to take to do a commitment update,
5811 // just give up on it and fail the HTLC.
5812 if height >= htlc.cltv_expiry - HTLC_FAIL_BACK_BUFFER {
5813 let mut htlc_msat_height_data = byte_utils::be64_to_array(htlc.value).to_vec();
5814 htlc_msat_height_data.extend_from_slice(&byte_utils::be32_to_array(height));
5815 timed_out_htlcs.push((HTLCSource::PreviousHopData(htlc.prev_hop.clone()), payment_hash.clone(), HTLCFailReason::Reason {
5816 failure_code: 0x4000 | 15,
5817 data: htlc_msat_height_data
5822 !htlcs.is_empty() // Only retain this entry if htlcs has at least one entry.
5827 self.handle_init_event_channel_failures(failed_channels);
5829 for (source, payment_hash, reason) in timed_out_htlcs.drain(..) {
5830 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), source, &payment_hash, reason);
5834 /// Blocks until ChannelManager needs to be persisted or a timeout is reached. It returns a bool
5835 /// indicating whether persistence is necessary. Only one listener on
5836 /// `await_persistable_update` or `await_persistable_update_timeout` is guaranteed to be woken
5839 /// Note that this method is not available with the `no-std` feature.
5840 #[cfg(any(test, feature = "std"))]
5841 pub fn await_persistable_update_timeout(&self, max_wait: Duration) -> bool {
5842 self.persistence_notifier.wait_timeout(max_wait)
5845 /// Blocks until ChannelManager needs to be persisted. Only one listener on
5846 /// `await_persistable_update` or `await_persistable_update_timeout` is guaranteed to be woken
5848 pub fn await_persistable_update(&self) {
5849 self.persistence_notifier.wait()
5852 #[cfg(any(test, feature = "_test_utils"))]
5853 pub fn get_persistence_condvar_value(&self) -> bool {
5854 let mutcond = &self.persistence_notifier.persistence_lock;
5855 let &(ref mtx, _) = mutcond;
5856 let guard = mtx.lock().unwrap();
5860 /// Gets the latest best block which was connected either via the [`chain::Listen`] or
5861 /// [`chain::Confirm`] interfaces.
5862 pub fn current_best_block(&self) -> BestBlock {
5863 self.best_block.read().unwrap().clone()
5867 impl<Signer: Sign, M: Deref , T: Deref , K: Deref , F: Deref , L: Deref >
5868 ChannelMessageHandler for ChannelManager<Signer, M, T, K, F, L>
5869 where M::Target: chain::Watch<Signer>,
5870 T::Target: BroadcasterInterface,
5871 K::Target: KeysInterface<Signer = Signer>,
5872 F::Target: FeeEstimator,
5875 fn handle_open_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::OpenChannel) {
5876 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5877 let _ = handle_error!(self, self.internal_open_channel(counterparty_node_id, their_features, msg), *counterparty_node_id);
5880 fn handle_accept_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::AcceptChannel) {
5881 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5882 let _ = handle_error!(self, self.internal_accept_channel(counterparty_node_id, their_features, msg), *counterparty_node_id);
5885 fn handle_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) {
5886 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5887 let _ = handle_error!(self, self.internal_funding_created(counterparty_node_id, msg), *counterparty_node_id);
5890 fn handle_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) {
5891 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5892 let _ = handle_error!(self, self.internal_funding_signed(counterparty_node_id, msg), *counterparty_node_id);
5895 fn handle_channel_ready(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReady) {
5896 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5897 let _ = handle_error!(self, self.internal_channel_ready(counterparty_node_id, msg), *counterparty_node_id);
5900 fn handle_shutdown(&self, counterparty_node_id: &PublicKey, their_features: &InitFeatures, msg: &msgs::Shutdown) {
5901 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5902 let _ = handle_error!(self, self.internal_shutdown(counterparty_node_id, their_features, msg), *counterparty_node_id);
5905 fn handle_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
5906 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5907 let _ = handle_error!(self, self.internal_closing_signed(counterparty_node_id, msg), *counterparty_node_id);
5910 fn handle_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
5911 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5912 let _ = handle_error!(self, self.internal_update_add_htlc(counterparty_node_id, msg), *counterparty_node_id);
5915 fn handle_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
5916 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5917 let _ = handle_error!(self, self.internal_update_fulfill_htlc(counterparty_node_id, msg), *counterparty_node_id);
5920 fn handle_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
5921 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5922 let _ = handle_error!(self, self.internal_update_fail_htlc(counterparty_node_id, msg), *counterparty_node_id);
5925 fn handle_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
5926 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5927 let _ = handle_error!(self, self.internal_update_fail_malformed_htlc(counterparty_node_id, msg), *counterparty_node_id);
5930 fn handle_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
5931 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5932 let _ = handle_error!(self, self.internal_commitment_signed(counterparty_node_id, msg), *counterparty_node_id);
5935 fn handle_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
5936 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5937 let _ = handle_error!(self, self.internal_revoke_and_ack(counterparty_node_id, msg), *counterparty_node_id);
5940 fn handle_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) {
5941 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5942 let _ = handle_error!(self, self.internal_update_fee(counterparty_node_id, msg), *counterparty_node_id);
5945 fn handle_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
5946 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5947 let _ = handle_error!(self, self.internal_announcement_signatures(counterparty_node_id, msg), *counterparty_node_id);
5950 fn handle_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) {
5951 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
5952 if let Ok(persist) = handle_error!(self, self.internal_channel_update(counterparty_node_id, msg), *counterparty_node_id) {
5955 NotifyOption::SkipPersist
5960 fn handle_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
5961 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5962 let _ = handle_error!(self, self.internal_channel_reestablish(counterparty_node_id, msg), *counterparty_node_id);
5965 fn peer_disconnected(&self, counterparty_node_id: &PublicKey, no_connection_possible: bool) {
5966 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5967 let mut failed_channels = Vec::new();
5968 let mut no_channels_remain = true;
5970 let mut channel_state_lock = self.channel_state.lock().unwrap();
5971 let channel_state = &mut *channel_state_lock;
5972 let pending_msg_events = &mut channel_state.pending_msg_events;
5973 let short_to_chan_info = &mut channel_state.short_to_chan_info;
5974 log_debug!(self.logger, "Marking channels with {} disconnected and generating channel_updates. We believe we {} make future connections to this peer.",
5975 log_pubkey!(counterparty_node_id), if no_connection_possible { "cannot" } else { "can" });
5976 channel_state.by_id.retain(|_, chan| {
5977 if chan.get_counterparty_node_id() == *counterparty_node_id {
5978 chan.remove_uncommitted_htlcs_and_mark_paused(&self.logger);
5979 if chan.is_shutdown() {
5980 update_maps_on_chan_removal!(self, short_to_chan_info, chan);
5981 self.issue_channel_close_events(chan, ClosureReason::DisconnectedPeer);
5984 no_channels_remain = false;
5989 pending_msg_events.retain(|msg| {
5991 &events::MessageSendEvent::SendAcceptChannel { ref node_id, .. } => node_id != counterparty_node_id,
5992 &events::MessageSendEvent::SendOpenChannel { ref node_id, .. } => node_id != counterparty_node_id,
5993 &events::MessageSendEvent::SendFundingCreated { ref node_id, .. } => node_id != counterparty_node_id,
5994 &events::MessageSendEvent::SendFundingSigned { ref node_id, .. } => node_id != counterparty_node_id,
5995 &events::MessageSendEvent::SendChannelReady { ref node_id, .. } => node_id != counterparty_node_id,
5996 &events::MessageSendEvent::SendAnnouncementSignatures { ref node_id, .. } => node_id != counterparty_node_id,
5997 &events::MessageSendEvent::UpdateHTLCs { ref node_id, .. } => node_id != counterparty_node_id,
5998 &events::MessageSendEvent::SendRevokeAndACK { ref node_id, .. } => node_id != counterparty_node_id,
5999 &events::MessageSendEvent::SendClosingSigned { ref node_id, .. } => node_id != counterparty_node_id,
6000 &events::MessageSendEvent::SendShutdown { ref node_id, .. } => node_id != counterparty_node_id,
6001 &events::MessageSendEvent::SendChannelReestablish { ref node_id, .. } => node_id != counterparty_node_id,
6002 &events::MessageSendEvent::BroadcastChannelAnnouncement { .. } => true,
6003 &events::MessageSendEvent::BroadcastNodeAnnouncement { .. } => true,
6004 &events::MessageSendEvent::BroadcastChannelUpdate { .. } => true,
6005 &events::MessageSendEvent::SendChannelUpdate { ref node_id, .. } => node_id != counterparty_node_id,
6006 &events::MessageSendEvent::HandleError { ref node_id, .. } => node_id != counterparty_node_id,
6007 &events::MessageSendEvent::SendChannelRangeQuery { .. } => false,
6008 &events::MessageSendEvent::SendShortIdsQuery { .. } => false,
6009 &events::MessageSendEvent::SendReplyChannelRange { .. } => false,
6010 &events::MessageSendEvent::SendGossipTimestampFilter { .. } => false,
6014 if no_channels_remain {
6015 self.per_peer_state.write().unwrap().remove(counterparty_node_id);
6018 for failure in failed_channels.drain(..) {
6019 self.finish_force_close_channel(failure);
6023 fn peer_connected(&self, counterparty_node_id: &PublicKey, init_msg: &msgs::Init) {
6024 log_debug!(self.logger, "Generating channel_reestablish events for {}", log_pubkey!(counterparty_node_id));
6026 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6029 let mut peer_state_lock = self.per_peer_state.write().unwrap();
6030 match peer_state_lock.entry(counterparty_node_id.clone()) {
6031 hash_map::Entry::Vacant(e) => {
6032 e.insert(Mutex::new(PeerState {
6033 latest_features: init_msg.features.clone(),
6036 hash_map::Entry::Occupied(e) => {
6037 e.get().lock().unwrap().latest_features = init_msg.features.clone();
6042 let mut channel_state_lock = self.channel_state.lock().unwrap();
6043 let channel_state = &mut *channel_state_lock;
6044 let pending_msg_events = &mut channel_state.pending_msg_events;
6045 channel_state.by_id.retain(|_, chan| {
6046 if chan.get_counterparty_node_id() == *counterparty_node_id {
6047 if !chan.have_received_message() {
6048 // If we created this (outbound) channel while we were disconnected from the
6049 // peer we probably failed to send the open_channel message, which is now
6050 // lost. We can't have had anything pending related to this channel, so we just
6054 pending_msg_events.push(events::MessageSendEvent::SendChannelReestablish {
6055 node_id: chan.get_counterparty_node_id(),
6056 msg: chan.get_channel_reestablish(&self.logger),
6062 //TODO: Also re-broadcast announcement_signatures
6065 fn handle_error(&self, counterparty_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
6066 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6068 if msg.channel_id == [0; 32] {
6069 for chan in self.list_channels() {
6070 if chan.counterparty.node_id == *counterparty_node_id {
6071 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
6072 let _ = self.force_close_channel_with_peer(&chan.channel_id, counterparty_node_id, Some(&msg.data), true);
6077 // First check if we can advance the channel type and try again.
6078 let mut channel_state = self.channel_state.lock().unwrap();
6079 if let Some(chan) = channel_state.by_id.get_mut(&msg.channel_id) {
6080 if chan.get_counterparty_node_id() != *counterparty_node_id {
6083 if let Ok(msg) = chan.maybe_handle_error_without_close(self.genesis_hash) {
6084 channel_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
6085 node_id: *counterparty_node_id,
6093 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
6094 let _ = self.force_close_channel_with_peer(&msg.channel_id, counterparty_node_id, Some(&msg.data), true);
6099 /// Used to signal to the ChannelManager persister that the manager needs to be re-persisted to
6100 /// disk/backups, through `await_persistable_update_timeout` and `await_persistable_update`.
6101 struct PersistenceNotifier {
6102 /// Users won't access the persistence_lock directly, but rather wait on its bool using
6103 /// `wait_timeout` and `wait`.
6104 persistence_lock: (Mutex<bool>, Condvar),
6107 impl PersistenceNotifier {
6110 persistence_lock: (Mutex::new(false), Condvar::new()),
6116 let &(ref mtx, ref cvar) = &self.persistence_lock;
6117 let mut guard = mtx.lock().unwrap();
6122 guard = cvar.wait(guard).unwrap();
6123 let result = *guard;
6131 #[cfg(any(test, feature = "std"))]
6132 fn wait_timeout(&self, max_wait: Duration) -> bool {
6133 let current_time = Instant::now();
6135 let &(ref mtx, ref cvar) = &self.persistence_lock;
6136 let mut guard = mtx.lock().unwrap();
6141 guard = cvar.wait_timeout(guard, max_wait).unwrap().0;
6142 // Due to spurious wakeups that can happen on `wait_timeout`, here we need to check if the
6143 // desired wait time has actually passed, and if not then restart the loop with a reduced wait
6144 // time. Note that this logic can be highly simplified through the use of
6145 // `Condvar::wait_while` and `Condvar::wait_timeout_while`, if and when our MSRV is raised to
6147 let elapsed = current_time.elapsed();
6148 let result = *guard;
6149 if result || elapsed >= max_wait {
6153 match max_wait.checked_sub(elapsed) {
6154 None => return result,
6160 // Signal to the ChannelManager persister that there are updates necessitating persisting to disk.
6162 let &(ref persist_mtx, ref cnd) = &self.persistence_lock;
6163 let mut persistence_lock = persist_mtx.lock().unwrap();
6164 *persistence_lock = true;
6165 mem::drop(persistence_lock);
6170 const SERIALIZATION_VERSION: u8 = 1;
6171 const MIN_SERIALIZATION_VERSION: u8 = 1;
6173 impl_writeable_tlv_based!(CounterpartyForwardingInfo, {
6174 (2, fee_base_msat, required),
6175 (4, fee_proportional_millionths, required),
6176 (6, cltv_expiry_delta, required),
6179 impl_writeable_tlv_based!(ChannelCounterparty, {
6180 (2, node_id, required),
6181 (4, features, required),
6182 (6, unspendable_punishment_reserve, required),
6183 (8, forwarding_info, option),
6184 (9, outbound_htlc_minimum_msat, option),
6185 (11, outbound_htlc_maximum_msat, option),
6188 impl_writeable_tlv_based!(ChannelDetails, {
6189 (1, inbound_scid_alias, option),
6190 (2, channel_id, required),
6191 (3, channel_type, option),
6192 (4, counterparty, required),
6193 (5, outbound_scid_alias, option),
6194 (6, funding_txo, option),
6195 (7, config, option),
6196 (8, short_channel_id, option),
6197 (10, channel_value_satoshis, required),
6198 (12, unspendable_punishment_reserve, option),
6199 (14, user_channel_id, required),
6200 (16, balance_msat, required),
6201 (18, outbound_capacity_msat, required),
6202 // Note that by the time we get past the required read above, outbound_capacity_msat will be
6203 // filled in, so we can safely unwrap it here.
6204 (19, next_outbound_htlc_limit_msat, (default_value, outbound_capacity_msat.0.unwrap() as u64)),
6205 (20, inbound_capacity_msat, required),
6206 (22, confirmations_required, option),
6207 (24, force_close_spend_delay, option),
6208 (26, is_outbound, required),
6209 (28, is_channel_ready, required),
6210 (30, is_usable, required),
6211 (32, is_public, required),
6212 (33, inbound_htlc_minimum_msat, option),
6213 (35, inbound_htlc_maximum_msat, option),
6216 impl_writeable_tlv_based!(PhantomRouteHints, {
6217 (2, channels, vec_type),
6218 (4, phantom_scid, required),
6219 (6, real_node_pubkey, required),
6222 impl_writeable_tlv_based_enum!(PendingHTLCRouting,
6224 (0, onion_packet, required),
6225 (2, short_channel_id, required),
6228 (0, payment_data, required),
6229 (1, phantom_shared_secret, option),
6230 (2, incoming_cltv_expiry, required),
6232 (2, ReceiveKeysend) => {
6233 (0, payment_preimage, required),
6234 (2, incoming_cltv_expiry, required),
6238 impl_writeable_tlv_based!(PendingHTLCInfo, {
6239 (0, routing, required),
6240 (2, incoming_shared_secret, required),
6241 (4, payment_hash, required),
6242 (6, amt_to_forward, required),
6243 (8, outgoing_cltv_value, required)
6247 impl Writeable for HTLCFailureMsg {
6248 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6250 HTLCFailureMsg::Relay(msgs::UpdateFailHTLC { channel_id, htlc_id, reason }) => {
6252 channel_id.write(writer)?;
6253 htlc_id.write(writer)?;
6254 reason.write(writer)?;
6256 HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
6257 channel_id, htlc_id, sha256_of_onion, failure_code
6260 channel_id.write(writer)?;
6261 htlc_id.write(writer)?;
6262 sha256_of_onion.write(writer)?;
6263 failure_code.write(writer)?;
6270 impl Readable for HTLCFailureMsg {
6271 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
6272 let id: u8 = Readable::read(reader)?;
6275 Ok(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
6276 channel_id: Readable::read(reader)?,
6277 htlc_id: Readable::read(reader)?,
6278 reason: Readable::read(reader)?,
6282 Ok(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
6283 channel_id: Readable::read(reader)?,
6284 htlc_id: Readable::read(reader)?,
6285 sha256_of_onion: Readable::read(reader)?,
6286 failure_code: Readable::read(reader)?,
6289 // In versions prior to 0.0.101, HTLCFailureMsg objects were written with type 0 or 1 but
6290 // weren't length-prefixed and thus didn't support reading the TLV stream suffix of the network
6291 // messages contained in the variants.
6292 // In version 0.0.101, support for reading the variants with these types was added, and
6293 // we should migrate to writing these variants when UpdateFailHTLC or
6294 // UpdateFailMalformedHTLC get TLV fields.
6296 let length: BigSize = Readable::read(reader)?;
6297 let mut s = FixedLengthReader::new(reader, length.0);
6298 let res = Readable::read(&mut s)?;
6299 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
6300 Ok(HTLCFailureMsg::Relay(res))
6303 let length: BigSize = Readable::read(reader)?;
6304 let mut s = FixedLengthReader::new(reader, length.0);
6305 let res = Readable::read(&mut s)?;
6306 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
6307 Ok(HTLCFailureMsg::Malformed(res))
6309 _ => Err(DecodeError::UnknownRequiredFeature),
6314 impl_writeable_tlv_based_enum!(PendingHTLCStatus, ;
6319 impl_writeable_tlv_based!(HTLCPreviousHopData, {
6320 (0, short_channel_id, required),
6321 (1, phantom_shared_secret, option),
6322 (2, outpoint, required),
6323 (4, htlc_id, required),
6324 (6, incoming_packet_shared_secret, required)
6327 impl Writeable for ClaimableHTLC {
6328 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6329 let (payment_data, keysend_preimage) = match &self.onion_payload {
6330 OnionPayload::Invoice { _legacy_hop_data } => (_legacy_hop_data.as_ref(), None),
6331 OnionPayload::Spontaneous(preimage) => (None, Some(preimage)),
6333 write_tlv_fields!(writer, {
6334 (0, self.prev_hop, required),
6335 (1, self.total_msat, required),
6336 (2, self.value, required),
6337 (4, payment_data, option),
6338 (6, self.cltv_expiry, required),
6339 (8, keysend_preimage, option),
6345 impl Readable for ClaimableHTLC {
6346 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
6347 let mut prev_hop = ::util::ser::OptionDeserWrapper(None);
6349 let mut payment_data: Option<msgs::FinalOnionHopData> = None;
6350 let mut cltv_expiry = 0;
6351 let mut total_msat = None;
6352 let mut keysend_preimage: Option<PaymentPreimage> = None;
6353 read_tlv_fields!(reader, {
6354 (0, prev_hop, required),
6355 (1, total_msat, option),
6356 (2, value, required),
6357 (4, payment_data, option),
6358 (6, cltv_expiry, required),
6359 (8, keysend_preimage, option)
6361 let onion_payload = match keysend_preimage {
6363 if payment_data.is_some() {
6364 return Err(DecodeError::InvalidValue)
6366 if total_msat.is_none() {
6367 total_msat = Some(value);
6369 OnionPayload::Spontaneous(p)
6372 if total_msat.is_none() {
6373 if payment_data.is_none() {
6374 return Err(DecodeError::InvalidValue)
6376 total_msat = Some(payment_data.as_ref().unwrap().total_msat);
6378 OnionPayload::Invoice { _legacy_hop_data: payment_data }
6382 prev_hop: prev_hop.0.unwrap(),
6385 total_msat: total_msat.unwrap(),
6392 impl Readable for HTLCSource {
6393 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
6394 let id: u8 = Readable::read(reader)?;
6397 let mut session_priv: ::util::ser::OptionDeserWrapper<SecretKey> = ::util::ser::OptionDeserWrapper(None);
6398 let mut first_hop_htlc_msat: u64 = 0;
6399 let mut path = Some(Vec::new());
6400 let mut payment_id = None;
6401 let mut payment_secret = None;
6402 let mut payment_params = None;
6403 read_tlv_fields!(reader, {
6404 (0, session_priv, required),
6405 (1, payment_id, option),
6406 (2, first_hop_htlc_msat, required),
6407 (3, payment_secret, option),
6408 (4, path, vec_type),
6409 (5, payment_params, option),
6411 if payment_id.is_none() {
6412 // For backwards compat, if there was no payment_id written, use the session_priv bytes
6414 payment_id = Some(PaymentId(*session_priv.0.unwrap().as_ref()));
6416 Ok(HTLCSource::OutboundRoute {
6417 session_priv: session_priv.0.unwrap(),
6418 first_hop_htlc_msat: first_hop_htlc_msat,
6419 path: path.unwrap(),
6420 payment_id: payment_id.unwrap(),
6425 1 => Ok(HTLCSource::PreviousHopData(Readable::read(reader)?)),
6426 _ => Err(DecodeError::UnknownRequiredFeature),
6431 impl Writeable for HTLCSource {
6432 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::io::Error> {
6434 HTLCSource::OutboundRoute { ref session_priv, ref first_hop_htlc_msat, ref path, payment_id, payment_secret, payment_params } => {
6436 let payment_id_opt = Some(payment_id);
6437 write_tlv_fields!(writer, {
6438 (0, session_priv, required),
6439 (1, payment_id_opt, option),
6440 (2, first_hop_htlc_msat, required),
6441 (3, payment_secret, option),
6442 (4, path, vec_type),
6443 (5, payment_params, option),
6446 HTLCSource::PreviousHopData(ref field) => {
6448 field.write(writer)?;
6455 impl_writeable_tlv_based_enum!(HTLCFailReason,
6456 (0, LightningError) => {
6460 (0, failure_code, required),
6461 (2, data, vec_type),
6465 impl_writeable_tlv_based_enum!(HTLCForwardInfo,
6467 (0, forward_info, required),
6468 (2, prev_short_channel_id, required),
6469 (4, prev_htlc_id, required),
6470 (6, prev_funding_outpoint, required),
6473 (0, htlc_id, required),
6474 (2, err_packet, required),
6478 impl_writeable_tlv_based!(PendingInboundPayment, {
6479 (0, payment_secret, required),
6480 (2, expiry_time, required),
6481 (4, user_payment_id, required),
6482 (6, payment_preimage, required),
6483 (8, min_value_msat, required),
6486 impl_writeable_tlv_based_enum_upgradable!(PendingOutboundPayment,
6488 (0, session_privs, required),
6491 (0, session_privs, required),
6492 (1, payment_hash, option),
6495 (0, session_privs, required),
6496 (1, pending_fee_msat, option),
6497 (2, payment_hash, required),
6498 (4, payment_secret, option),
6499 (6, total_msat, required),
6500 (8, pending_amt_msat, required),
6501 (10, starting_block_height, required),
6504 (0, session_privs, required),
6505 (2, payment_hash, required),
6509 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> Writeable for ChannelManager<Signer, M, T, K, F, L>
6510 where M::Target: chain::Watch<Signer>,
6511 T::Target: BroadcasterInterface,
6512 K::Target: KeysInterface<Signer = Signer>,
6513 F::Target: FeeEstimator,
6516 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6517 let _consistency_lock = self.total_consistency_lock.write().unwrap();
6519 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
6521 self.genesis_hash.write(writer)?;
6523 let best_block = self.best_block.read().unwrap();
6524 best_block.height().write(writer)?;
6525 best_block.block_hash().write(writer)?;
6528 let channel_state = self.channel_state.lock().unwrap();
6529 let mut unfunded_channels = 0;
6530 for (_, channel) in channel_state.by_id.iter() {
6531 if !channel.is_funding_initiated() {
6532 unfunded_channels += 1;
6535 ((channel_state.by_id.len() - unfunded_channels) as u64).write(writer)?;
6536 for (_, channel) in channel_state.by_id.iter() {
6537 if channel.is_funding_initiated() {
6538 channel.write(writer)?;
6542 (channel_state.forward_htlcs.len() as u64).write(writer)?;
6543 for (short_channel_id, pending_forwards) in channel_state.forward_htlcs.iter() {
6544 short_channel_id.write(writer)?;
6545 (pending_forwards.len() as u64).write(writer)?;
6546 for forward in pending_forwards {
6547 forward.write(writer)?;
6551 let mut htlc_purposes: Vec<&events::PaymentPurpose> = Vec::new();
6552 (channel_state.claimable_htlcs.len() as u64).write(writer)?;
6553 for (payment_hash, (purpose, previous_hops)) in channel_state.claimable_htlcs.iter() {
6554 payment_hash.write(writer)?;
6555 (previous_hops.len() as u64).write(writer)?;
6556 for htlc in previous_hops.iter() {
6557 htlc.write(writer)?;
6559 htlc_purposes.push(purpose);
6562 let per_peer_state = self.per_peer_state.write().unwrap();
6563 (per_peer_state.len() as u64).write(writer)?;
6564 for (peer_pubkey, peer_state_mutex) in per_peer_state.iter() {
6565 peer_pubkey.write(writer)?;
6566 let peer_state = peer_state_mutex.lock().unwrap();
6567 peer_state.latest_features.write(writer)?;
6570 let pending_inbound_payments = self.pending_inbound_payments.lock().unwrap();
6571 let pending_outbound_payments = self.pending_outbound_payments.lock().unwrap();
6572 let events = self.pending_events.lock().unwrap();
6573 (events.len() as u64).write(writer)?;
6574 for event in events.iter() {
6575 event.write(writer)?;
6578 let background_events = self.pending_background_events.lock().unwrap();
6579 (background_events.len() as u64).write(writer)?;
6580 for event in background_events.iter() {
6582 BackgroundEvent::ClosingMonitorUpdate((funding_txo, monitor_update)) => {
6584 funding_txo.write(writer)?;
6585 monitor_update.write(writer)?;
6590 (self.last_node_announcement_serial.load(Ordering::Acquire) as u32).write(writer)?;
6591 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
6593 (pending_inbound_payments.len() as u64).write(writer)?;
6594 for (hash, pending_payment) in pending_inbound_payments.iter() {
6595 hash.write(writer)?;
6596 pending_payment.write(writer)?;
6599 // For backwards compat, write the session privs and their total length.
6600 let mut num_pending_outbounds_compat: u64 = 0;
6601 for (_, outbound) in pending_outbound_payments.iter() {
6602 if !outbound.is_fulfilled() && !outbound.abandoned() {
6603 num_pending_outbounds_compat += outbound.remaining_parts() as u64;
6606 num_pending_outbounds_compat.write(writer)?;
6607 for (_, outbound) in pending_outbound_payments.iter() {
6609 PendingOutboundPayment::Legacy { session_privs } |
6610 PendingOutboundPayment::Retryable { session_privs, .. } => {
6611 for session_priv in session_privs.iter() {
6612 session_priv.write(writer)?;
6615 PendingOutboundPayment::Fulfilled { .. } => {},
6616 PendingOutboundPayment::Abandoned { .. } => {},
6620 // Encode without retry info for 0.0.101 compatibility.
6621 let mut pending_outbound_payments_no_retry: HashMap<PaymentId, HashSet<[u8; 32]>> = HashMap::new();
6622 for (id, outbound) in pending_outbound_payments.iter() {
6624 PendingOutboundPayment::Legacy { session_privs } |
6625 PendingOutboundPayment::Retryable { session_privs, .. } => {
6626 pending_outbound_payments_no_retry.insert(*id, session_privs.clone());
6631 write_tlv_fields!(writer, {
6632 (1, pending_outbound_payments_no_retry, required),
6633 (3, pending_outbound_payments, required),
6634 (5, self.our_network_pubkey, required),
6635 (7, self.fake_scid_rand_bytes, required),
6636 (9, htlc_purposes, vec_type),
6643 /// Arguments for the creation of a ChannelManager that are not deserialized.
6645 /// At a high-level, the process for deserializing a ChannelManager and resuming normal operation
6647 /// 1) Deserialize all stored [`ChannelMonitor`]s.
6648 /// 2) Deserialize the [`ChannelManager`] by filling in this struct and calling:
6649 /// `<(BlockHash, ChannelManager)>::read(reader, args)`
6650 /// This may result in closing some channels if the [`ChannelMonitor`] is newer than the stored
6651 /// [`ChannelManager`] state to ensure no loss of funds. Thus, transactions may be broadcasted.
6652 /// 3) If you are not fetching full blocks, register all relevant [`ChannelMonitor`] outpoints the
6653 /// same way you would handle a [`chain::Filter`] call using
6654 /// [`ChannelMonitor::get_outputs_to_watch`] and [`ChannelMonitor::get_funding_txo`].
6655 /// 4) Reconnect blocks on your [`ChannelMonitor`]s.
6656 /// 5) Disconnect/connect blocks on the [`ChannelManager`].
6657 /// 6) Re-persist the [`ChannelMonitor`]s to ensure the latest state is on disk.
6658 /// Note that if you're using a [`ChainMonitor`] for your [`chain::Watch`] implementation, you
6659 /// will likely accomplish this as a side-effect of calling [`chain::Watch::watch_channel`] in
6661 /// 7) Move the [`ChannelMonitor`]s into your local [`chain::Watch`]. If you're using a
6662 /// [`ChainMonitor`], this is done by calling [`chain::Watch::watch_channel`].
6664 /// Note that the ordering of #4-7 is not of importance, however all four must occur before you
6665 /// call any other methods on the newly-deserialized [`ChannelManager`].
6667 /// Note that because some channels may be closed during deserialization, it is critical that you
6668 /// always deserialize only the latest version of a ChannelManager and ChannelMonitors available to
6669 /// you. If you deserialize an old ChannelManager (during which force-closure transactions may be
6670 /// broadcast), and then later deserialize a newer version of the same ChannelManager (which will
6671 /// not force-close the same channels but consider them live), you may end up revoking a state for
6672 /// which you've already broadcasted the transaction.
6674 /// [`ChainMonitor`]: crate::chain::chainmonitor::ChainMonitor
6675 pub struct ChannelManagerReadArgs<'a, Signer: 'a + Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
6676 where M::Target: chain::Watch<Signer>,
6677 T::Target: BroadcasterInterface,
6678 K::Target: KeysInterface<Signer = Signer>,
6679 F::Target: FeeEstimator,
6682 /// The keys provider which will give us relevant keys. Some keys will be loaded during
6683 /// deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
6685 pub keys_manager: K,
6687 /// The fee_estimator for use in the ChannelManager in the future.
6689 /// No calls to the FeeEstimator will be made during deserialization.
6690 pub fee_estimator: F,
6691 /// The chain::Watch for use in the ChannelManager in the future.
6693 /// No calls to the chain::Watch will be made during deserialization. It is assumed that
6694 /// you have deserialized ChannelMonitors separately and will add them to your
6695 /// chain::Watch after deserializing this ChannelManager.
6696 pub chain_monitor: M,
6698 /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
6699 /// used to broadcast the latest local commitment transactions of channels which must be
6700 /// force-closed during deserialization.
6701 pub tx_broadcaster: T,
6702 /// The Logger for use in the ChannelManager and which may be used to log information during
6703 /// deserialization.
6705 /// Default settings used for new channels. Any existing channels will continue to use the
6706 /// runtime settings which were stored when the ChannelManager was serialized.
6707 pub default_config: UserConfig,
6709 /// A map from channel funding outpoints to ChannelMonitors for those channels (ie
6710 /// value.get_funding_txo() should be the key).
6712 /// If a monitor is inconsistent with the channel state during deserialization the channel will
6713 /// be force-closed using the data in the ChannelMonitor and the channel will be dropped. This
6714 /// is true for missing channels as well. If there is a monitor missing for which we find
6715 /// channel data Err(DecodeError::InvalidValue) will be returned.
6717 /// In such cases the latest local transactions will be sent to the tx_broadcaster included in
6720 /// (C-not exported) because we have no HashMap bindings
6721 pub channel_monitors: HashMap<OutPoint, &'a mut ChannelMonitor<Signer>>,
6724 impl<'a, Signer: 'a + Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
6725 ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>
6726 where M::Target: chain::Watch<Signer>,
6727 T::Target: BroadcasterInterface,
6728 K::Target: KeysInterface<Signer = Signer>,
6729 F::Target: FeeEstimator,
6732 /// Simple utility function to create a ChannelManagerReadArgs which creates the monitor
6733 /// HashMap for you. This is primarily useful for C bindings where it is not practical to
6734 /// populate a HashMap directly from C.
6735 pub fn new(keys_manager: K, fee_estimator: F, chain_monitor: M, tx_broadcaster: T, logger: L, default_config: UserConfig,
6736 mut channel_monitors: Vec<&'a mut ChannelMonitor<Signer>>) -> Self {
6738 keys_manager, fee_estimator, chain_monitor, tx_broadcaster, logger, default_config,
6739 channel_monitors: channel_monitors.drain(..).map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect()
6744 // Implement ReadableArgs for an Arc'd ChannelManager to make it a bit easier to work with the
6745 // SipmleArcChannelManager type:
6746 impl<'a, Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
6747 ReadableArgs<ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>> for (BlockHash, Arc<ChannelManager<Signer, M, T, K, F, L>>)
6748 where M::Target: chain::Watch<Signer>,
6749 T::Target: BroadcasterInterface,
6750 K::Target: KeysInterface<Signer = Signer>,
6751 F::Target: FeeEstimator,
6754 fn read<R: io::Read>(reader: &mut R, args: ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>) -> Result<Self, DecodeError> {
6755 let (blockhash, chan_manager) = <(BlockHash, ChannelManager<Signer, M, T, K, F, L>)>::read(reader, args)?;
6756 Ok((blockhash, Arc::new(chan_manager)))
6760 impl<'a, Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
6761 ReadableArgs<ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>> for (BlockHash, ChannelManager<Signer, M, T, K, F, L>)
6762 where M::Target: chain::Watch<Signer>,
6763 T::Target: BroadcasterInterface,
6764 K::Target: KeysInterface<Signer = Signer>,
6765 F::Target: FeeEstimator,
6768 fn read<R: io::Read>(reader: &mut R, mut args: ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>) -> Result<Self, DecodeError> {
6769 let _ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
6771 let genesis_hash: BlockHash = Readable::read(reader)?;
6772 let best_block_height: u32 = Readable::read(reader)?;
6773 let best_block_hash: BlockHash = Readable::read(reader)?;
6775 let mut failed_htlcs = Vec::new();
6777 let channel_count: u64 = Readable::read(reader)?;
6778 let mut funding_txo_set = HashSet::with_capacity(cmp::min(channel_count as usize, 128));
6779 let mut by_id = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
6780 let mut short_to_chan_info = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
6781 let mut channel_closures = Vec::new();
6782 for _ in 0..channel_count {
6783 let mut channel: Channel<Signer> = Channel::read(reader, (&args.keys_manager, best_block_height))?;
6784 let funding_txo = channel.get_funding_txo().ok_or(DecodeError::InvalidValue)?;
6785 funding_txo_set.insert(funding_txo.clone());
6786 if let Some(ref mut monitor) = args.channel_monitors.get_mut(&funding_txo) {
6787 if channel.get_cur_holder_commitment_transaction_number() < monitor.get_cur_holder_commitment_number() ||
6788 channel.get_revoked_counterparty_commitment_transaction_number() < monitor.get_min_seen_secret() ||
6789 channel.get_cur_counterparty_commitment_transaction_number() < monitor.get_cur_counterparty_commitment_number() ||
6790 channel.get_latest_monitor_update_id() > monitor.get_latest_update_id() {
6791 // If the channel is ahead of the monitor, return InvalidValue:
6792 log_error!(args.logger, "A ChannelMonitor is stale compared to the current ChannelManager! This indicates a potentially-critical violation of the chain::Watch API!");
6793 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
6794 log_bytes!(channel.channel_id()), monitor.get_latest_update_id(), channel.get_latest_monitor_update_id());
6795 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
6796 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
6797 log_error!(args.logger, " Without the latest ChannelMonitor we cannot continue without risking funds.");
6798 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");
6799 return Err(DecodeError::InvalidValue);
6800 } else if channel.get_cur_holder_commitment_transaction_number() > monitor.get_cur_holder_commitment_number() ||
6801 channel.get_revoked_counterparty_commitment_transaction_number() > monitor.get_min_seen_secret() ||
6802 channel.get_cur_counterparty_commitment_transaction_number() > monitor.get_cur_counterparty_commitment_number() ||
6803 channel.get_latest_monitor_update_id() < monitor.get_latest_update_id() {
6804 // But if the channel is behind of the monitor, close the channel:
6805 log_error!(args.logger, "A ChannelManager is stale compared to the current ChannelMonitor!");
6806 log_error!(args.logger, " The channel will be force-closed and the latest commitment transaction from the ChannelMonitor broadcast.");
6807 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
6808 log_bytes!(channel.channel_id()), monitor.get_latest_update_id(), channel.get_latest_monitor_update_id());
6809 let (_, mut new_failed_htlcs) = channel.force_shutdown(true);
6810 failed_htlcs.append(&mut new_failed_htlcs);
6811 monitor.broadcast_latest_holder_commitment_txn(&args.tx_broadcaster, &args.logger);
6812 channel_closures.push(events::Event::ChannelClosed {
6813 channel_id: channel.channel_id(),
6814 user_channel_id: channel.get_user_id(),
6815 reason: ClosureReason::OutdatedChannelManager
6818 log_info!(args.logger, "Successfully loaded channel {}", log_bytes!(channel.channel_id()));
6819 if let Some(short_channel_id) = channel.get_short_channel_id() {
6820 short_to_chan_info.insert(short_channel_id, (channel.get_counterparty_node_id(), channel.channel_id()));
6822 by_id.insert(channel.channel_id(), channel);
6825 log_error!(args.logger, "Missing ChannelMonitor for channel {} needed by ChannelManager.", log_bytes!(channel.channel_id()));
6826 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
6827 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
6828 log_error!(args.logger, " Without the ChannelMonitor we cannot continue without risking funds.");
6829 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");
6830 return Err(DecodeError::InvalidValue);
6834 for (ref funding_txo, ref mut monitor) in args.channel_monitors.iter_mut() {
6835 if !funding_txo_set.contains(funding_txo) {
6836 log_info!(args.logger, "Broadcasting latest holder commitment transaction for closed channel {}", log_bytes!(funding_txo.to_channel_id()));
6837 monitor.broadcast_latest_holder_commitment_txn(&args.tx_broadcaster, &args.logger);
6841 const MAX_ALLOC_SIZE: usize = 1024 * 64;
6842 let forward_htlcs_count: u64 = Readable::read(reader)?;
6843 let mut forward_htlcs = HashMap::with_capacity(cmp::min(forward_htlcs_count as usize, 128));
6844 for _ in 0..forward_htlcs_count {
6845 let short_channel_id = Readable::read(reader)?;
6846 let pending_forwards_count: u64 = Readable::read(reader)?;
6847 let mut pending_forwards = Vec::with_capacity(cmp::min(pending_forwards_count as usize, MAX_ALLOC_SIZE/mem::size_of::<HTLCForwardInfo>()));
6848 for _ in 0..pending_forwards_count {
6849 pending_forwards.push(Readable::read(reader)?);
6851 forward_htlcs.insert(short_channel_id, pending_forwards);
6854 let claimable_htlcs_count: u64 = Readable::read(reader)?;
6855 let mut claimable_htlcs_list = Vec::with_capacity(cmp::min(claimable_htlcs_count as usize, 128));
6856 for _ in 0..claimable_htlcs_count {
6857 let payment_hash = Readable::read(reader)?;
6858 let previous_hops_len: u64 = Readable::read(reader)?;
6859 let mut previous_hops = Vec::with_capacity(cmp::min(previous_hops_len as usize, MAX_ALLOC_SIZE/mem::size_of::<ClaimableHTLC>()));
6860 for _ in 0..previous_hops_len {
6861 previous_hops.push(<ClaimableHTLC as Readable>::read(reader)?);
6863 claimable_htlcs_list.push((payment_hash, previous_hops));
6866 let peer_count: u64 = Readable::read(reader)?;
6867 let mut per_peer_state = HashMap::with_capacity(cmp::min(peer_count as usize, MAX_ALLOC_SIZE/mem::size_of::<(PublicKey, Mutex<PeerState>)>()));
6868 for _ in 0..peer_count {
6869 let peer_pubkey = Readable::read(reader)?;
6870 let peer_state = PeerState {
6871 latest_features: Readable::read(reader)?,
6873 per_peer_state.insert(peer_pubkey, Mutex::new(peer_state));
6876 let event_count: u64 = Readable::read(reader)?;
6877 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>()));
6878 for _ in 0..event_count {
6879 match MaybeReadable::read(reader)? {
6880 Some(event) => pending_events_read.push(event),
6884 if forward_htlcs_count > 0 {
6885 // If we have pending HTLCs to forward, assume we either dropped a
6886 // `PendingHTLCsForwardable` or the user received it but never processed it as they
6887 // shut down before the timer hit. Either way, set the time_forwardable to a small
6888 // constant as enough time has likely passed that we should simply handle the forwards
6889 // now, or at least after the user gets a chance to reconnect to our peers.
6890 pending_events_read.push(events::Event::PendingHTLCsForwardable {
6891 time_forwardable: Duration::from_secs(2),
6895 let background_event_count: u64 = Readable::read(reader)?;
6896 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>()));
6897 for _ in 0..background_event_count {
6898 match <u8 as Readable>::read(reader)? {
6899 0 => pending_background_events_read.push(BackgroundEvent::ClosingMonitorUpdate((Readable::read(reader)?, Readable::read(reader)?))),
6900 _ => return Err(DecodeError::InvalidValue),
6904 let last_node_announcement_serial: u32 = Readable::read(reader)?;
6905 let highest_seen_timestamp: u32 = Readable::read(reader)?;
6907 let pending_inbound_payment_count: u64 = Readable::read(reader)?;
6908 let mut pending_inbound_payments: HashMap<PaymentHash, PendingInboundPayment> = HashMap::with_capacity(cmp::min(pending_inbound_payment_count as usize, MAX_ALLOC_SIZE/(3*32)));
6909 for _ in 0..pending_inbound_payment_count {
6910 if pending_inbound_payments.insert(Readable::read(reader)?, Readable::read(reader)?).is_some() {
6911 return Err(DecodeError::InvalidValue);
6915 let pending_outbound_payments_count_compat: u64 = Readable::read(reader)?;
6916 let mut pending_outbound_payments_compat: HashMap<PaymentId, PendingOutboundPayment> =
6917 HashMap::with_capacity(cmp::min(pending_outbound_payments_count_compat as usize, MAX_ALLOC_SIZE/32));
6918 for _ in 0..pending_outbound_payments_count_compat {
6919 let session_priv = Readable::read(reader)?;
6920 let payment = PendingOutboundPayment::Legacy {
6921 session_privs: [session_priv].iter().cloned().collect()
6923 if pending_outbound_payments_compat.insert(PaymentId(session_priv), payment).is_some() {
6924 return Err(DecodeError::InvalidValue)
6928 // pending_outbound_payments_no_retry is for compatibility with 0.0.101 clients.
6929 let mut pending_outbound_payments_no_retry: Option<HashMap<PaymentId, HashSet<[u8; 32]>>> = None;
6930 let mut pending_outbound_payments = None;
6931 let mut received_network_pubkey: Option<PublicKey> = None;
6932 let mut fake_scid_rand_bytes: Option<[u8; 32]> = None;
6933 let mut claimable_htlc_purposes = None;
6934 read_tlv_fields!(reader, {
6935 (1, pending_outbound_payments_no_retry, option),
6936 (3, pending_outbound_payments, option),
6937 (5, received_network_pubkey, option),
6938 (7, fake_scid_rand_bytes, option),
6939 (9, claimable_htlc_purposes, vec_type),
6941 if fake_scid_rand_bytes.is_none() {
6942 fake_scid_rand_bytes = Some(args.keys_manager.get_secure_random_bytes());
6945 if pending_outbound_payments.is_none() && pending_outbound_payments_no_retry.is_none() {
6946 pending_outbound_payments = Some(pending_outbound_payments_compat);
6947 } else if pending_outbound_payments.is_none() {
6948 let mut outbounds = HashMap::new();
6949 for (id, session_privs) in pending_outbound_payments_no_retry.unwrap().drain() {
6950 outbounds.insert(id, PendingOutboundPayment::Legacy { session_privs });
6952 pending_outbound_payments = Some(outbounds);
6954 // If we're tracking pending payments, ensure we haven't lost any by looking at the
6955 // ChannelMonitor data for any channels for which we do not have authorative state
6956 // (i.e. those for which we just force-closed above or we otherwise don't have a
6957 // corresponding `Channel` at all).
6958 // This avoids several edge-cases where we would otherwise "forget" about pending
6959 // payments which are still in-flight via their on-chain state.
6960 // We only rebuild the pending payments map if we were most recently serialized by
6962 for (_, monitor) in args.channel_monitors.iter() {
6963 if by_id.get(&monitor.get_funding_txo().0.to_channel_id()).is_none() {
6964 for (htlc_source, htlc) in monitor.get_pending_outbound_htlcs() {
6965 if let HTLCSource::OutboundRoute { payment_id, session_priv, path, payment_secret, .. } = htlc_source {
6966 if path.is_empty() {
6967 log_error!(args.logger, "Got an empty path for a pending payment");
6968 return Err(DecodeError::InvalidValue);
6970 let path_amt = path.last().unwrap().fee_msat;
6971 let mut session_priv_bytes = [0; 32];
6972 session_priv_bytes[..].copy_from_slice(&session_priv[..]);
6973 match pending_outbound_payments.as_mut().unwrap().entry(payment_id) {
6974 hash_map::Entry::Occupied(mut entry) => {
6975 let newly_added = entry.get_mut().insert(session_priv_bytes, &path);
6976 log_info!(args.logger, "{} a pending payment path for {} msat for session priv {} on an existing pending payment with payment hash {}",
6977 if newly_added { "Added" } else { "Had" }, path_amt, log_bytes!(session_priv_bytes), log_bytes!(htlc.payment_hash.0));
6979 hash_map::Entry::Vacant(entry) => {
6980 let path_fee = path.get_path_fees();
6981 entry.insert(PendingOutboundPayment::Retryable {
6982 session_privs: [session_priv_bytes].iter().map(|a| *a).collect(),
6983 payment_hash: htlc.payment_hash,
6985 pending_amt_msat: path_amt,
6986 pending_fee_msat: Some(path_fee),
6987 total_msat: path_amt,
6988 starting_block_height: best_block_height,
6990 log_info!(args.logger, "Added a pending payment for {} msat with payment hash {} for path with session priv {}",
6991 path_amt, log_bytes!(htlc.payment_hash.0), log_bytes!(session_priv_bytes));
7000 let inbound_pmt_key_material = args.keys_manager.get_inbound_payment_key_material();
7001 let expanded_inbound_key = inbound_payment::ExpandedKey::new(&inbound_pmt_key_material);
7003 let mut claimable_htlcs = HashMap::with_capacity(claimable_htlcs_list.len());
7004 if let Some(mut purposes) = claimable_htlc_purposes {
7005 if purposes.len() != claimable_htlcs_list.len() {
7006 return Err(DecodeError::InvalidValue);
7008 for (purpose, (payment_hash, previous_hops)) in purposes.drain(..).zip(claimable_htlcs_list.drain(..)) {
7009 claimable_htlcs.insert(payment_hash, (purpose, previous_hops));
7012 // LDK versions prior to 0.0.107 did not write a `pending_htlc_purposes`, but do
7013 // include a `_legacy_hop_data` in the `OnionPayload`.
7014 for (payment_hash, previous_hops) in claimable_htlcs_list.drain(..) {
7015 if previous_hops.is_empty() {
7016 return Err(DecodeError::InvalidValue);
7018 let purpose = match &previous_hops[0].onion_payload {
7019 OnionPayload::Invoice { _legacy_hop_data } => {
7020 if let Some(hop_data) = _legacy_hop_data {
7021 events::PaymentPurpose::InvoicePayment {
7022 payment_preimage: match pending_inbound_payments.get(&payment_hash) {
7023 Some(inbound_payment) => inbound_payment.payment_preimage,
7024 None => match inbound_payment::verify(payment_hash, &hop_data, 0, &expanded_inbound_key, &args.logger) {
7025 Ok(payment_preimage) => payment_preimage,
7027 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));
7028 return Err(DecodeError::InvalidValue);
7032 payment_secret: hop_data.payment_secret,
7034 } else { return Err(DecodeError::InvalidValue); }
7036 OnionPayload::Spontaneous(payment_preimage) =>
7037 events::PaymentPurpose::SpontaneousPayment(*payment_preimage),
7039 claimable_htlcs.insert(payment_hash, (purpose, previous_hops));
7043 let mut secp_ctx = Secp256k1::new();
7044 secp_ctx.seeded_randomize(&args.keys_manager.get_secure_random_bytes());
7046 if !channel_closures.is_empty() {
7047 pending_events_read.append(&mut channel_closures);
7050 let our_network_key = match args.keys_manager.get_node_secret(Recipient::Node) {
7052 Err(()) => return Err(DecodeError::InvalidValue)
7054 let our_network_pubkey = PublicKey::from_secret_key(&secp_ctx, &our_network_key);
7055 if let Some(network_pubkey) = received_network_pubkey {
7056 if network_pubkey != our_network_pubkey {
7057 log_error!(args.logger, "Key that was generated does not match the existing key.");
7058 return Err(DecodeError::InvalidValue);
7062 let mut outbound_scid_aliases = HashSet::new();
7063 for (chan_id, chan) in by_id.iter_mut() {
7064 if chan.outbound_scid_alias() == 0 {
7065 let mut outbound_scid_alias;
7067 outbound_scid_alias = fake_scid::Namespace::OutboundAlias
7068 .get_fake_scid(best_block_height, &genesis_hash, fake_scid_rand_bytes.as_ref().unwrap(), &args.keys_manager);
7069 if outbound_scid_aliases.insert(outbound_scid_alias) { break; }
7071 chan.set_outbound_scid_alias(outbound_scid_alias);
7072 } else if !outbound_scid_aliases.insert(chan.outbound_scid_alias()) {
7073 // Note that in rare cases its possible to hit this while reading an older
7074 // channel if we just happened to pick a colliding outbound alias above.
7075 log_error!(args.logger, "Got duplicate outbound SCID alias; {}", chan.outbound_scid_alias());
7076 return Err(DecodeError::InvalidValue);
7078 if chan.is_usable() {
7079 if short_to_chan_info.insert(chan.outbound_scid_alias(), (chan.get_counterparty_node_id(), *chan_id)).is_some() {
7080 // Note that in rare cases its possible to hit this while reading an older
7081 // channel if we just happened to pick a colliding outbound alias above.
7082 log_error!(args.logger, "Got duplicate outbound SCID alias; {}", chan.outbound_scid_alias());
7083 return Err(DecodeError::InvalidValue);
7088 for (_, monitor) in args.channel_monitors.iter() {
7089 for (payment_hash, payment_preimage) in monitor.get_stored_preimages() {
7090 if let Some((payment_purpose, claimable_htlcs)) = claimable_htlcs.remove(&payment_hash) {
7091 log_info!(args.logger, "Re-claiming HTLCs with payment hash {} as we've released the preimage to a ChannelMonitor!", log_bytes!(payment_hash.0));
7092 let mut claimable_amt_msat = 0;
7093 for claimable_htlc in claimable_htlcs {
7094 claimable_amt_msat += claimable_htlc.value;
7096 // Add a holding-cell claim of the payment to the Channel, which should be
7097 // applied ~immediately on peer reconnection. Because it won't generate a
7098 // new commitment transaction we can just provide the payment preimage to
7099 // the corresponding ChannelMonitor and nothing else.
7101 // We do so directly instead of via the normal ChannelMonitor update
7102 // procedure as the ChainMonitor hasn't yet been initialized, implying
7103 // we're not allowed to call it directly yet. Further, we do the update
7104 // without incrementing the ChannelMonitor update ID as there isn't any
7106 // If we were to generate a new ChannelMonitor update ID here and then
7107 // crash before the user finishes block connect we'd end up force-closing
7108 // this channel as well. On the flip side, there's no harm in restarting
7109 // without the new monitor persisted - we'll end up right back here on
7111 let previous_channel_id = claimable_htlc.prev_hop.outpoint.to_channel_id();
7112 if let Some(channel) = by_id.get_mut(&previous_channel_id) {
7113 channel.claim_htlc_while_disconnected_dropping_mon_update(claimable_htlc.prev_hop.htlc_id, payment_preimage, &args.logger);
7115 if let Some(previous_hop_monitor) = args.channel_monitors.get(&claimable_htlc.prev_hop.outpoint) {
7116 previous_hop_monitor.provide_payment_preimage(&payment_hash, &payment_preimage, &args.tx_broadcaster, &args.fee_estimator, &args.logger);
7119 pending_events_read.push(events::Event::PaymentClaimed {
7121 purpose: payment_purpose,
7122 amount_msat: claimable_amt_msat,
7128 let channel_manager = ChannelManager {
7130 fee_estimator: args.fee_estimator,
7131 chain_monitor: args.chain_monitor,
7132 tx_broadcaster: args.tx_broadcaster,
7134 best_block: RwLock::new(BestBlock::new(best_block_hash, best_block_height)),
7136 channel_state: Mutex::new(ChannelHolder {
7141 pending_msg_events: Vec::new(),
7143 inbound_payment_key: expanded_inbound_key,
7144 pending_inbound_payments: Mutex::new(pending_inbound_payments),
7145 pending_outbound_payments: Mutex::new(pending_outbound_payments.unwrap()),
7147 outbound_scid_aliases: Mutex::new(outbound_scid_aliases),
7148 fake_scid_rand_bytes: fake_scid_rand_bytes.unwrap(),
7154 last_node_announcement_serial: AtomicUsize::new(last_node_announcement_serial as usize),
7155 highest_seen_timestamp: AtomicUsize::new(highest_seen_timestamp as usize),
7157 per_peer_state: RwLock::new(per_peer_state),
7159 pending_events: Mutex::new(pending_events_read),
7160 pending_background_events: Mutex::new(pending_background_events_read),
7161 total_consistency_lock: RwLock::new(()),
7162 persistence_notifier: PersistenceNotifier::new(),
7164 keys_manager: args.keys_manager,
7165 logger: args.logger,
7166 default_configuration: args.default_config,
7169 for htlc_source in failed_htlcs.drain(..) {
7170 channel_manager.fail_htlc_backwards_internal(channel_manager.channel_state.lock().unwrap(), htlc_source.0, &htlc_source.1, HTLCFailReason::Reason { failure_code: 0x4000 | 8, data: Vec::new() });
7173 //TODO: Broadcast channel update for closed channels, but only after we've made a
7174 //connection or two.
7176 Ok((best_block_hash.clone(), channel_manager))
7182 use bitcoin::hashes::Hash;
7183 use bitcoin::hashes::sha256::Hash as Sha256;
7184 use core::time::Duration;
7185 use core::sync::atomic::Ordering;
7186 use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
7187 use ln::channelmanager::{PaymentId, PaymentSendFailure};
7188 use ln::channelmanager::inbound_payment;
7189 use ln::features::InitFeatures;
7190 use ln::functional_test_utils::*;
7192 use ln::msgs::ChannelMessageHandler;
7193 use routing::router::{PaymentParameters, RouteParameters, find_route};
7194 use util::errors::APIError;
7195 use util::events::{Event, MessageSendEvent, MessageSendEventsProvider};
7196 use util::test_utils;
7197 use chain::keysinterface::KeysInterface;
7199 #[cfg(feature = "std")]
7201 fn test_wait_timeout() {
7202 use ln::channelmanager::PersistenceNotifier;
7204 use core::sync::atomic::AtomicBool;
7207 let persistence_notifier = Arc::new(PersistenceNotifier::new());
7208 let thread_notifier = Arc::clone(&persistence_notifier);
7210 let exit_thread = Arc::new(AtomicBool::new(false));
7211 let exit_thread_clone = exit_thread.clone();
7212 thread::spawn(move || {
7214 let &(ref persist_mtx, ref cnd) = &thread_notifier.persistence_lock;
7215 let mut persistence_lock = persist_mtx.lock().unwrap();
7216 *persistence_lock = true;
7219 if exit_thread_clone.load(Ordering::SeqCst) {
7225 // Check that we can block indefinitely until updates are available.
7226 let _ = persistence_notifier.wait();
7228 // Check that the PersistenceNotifier will return after the given duration if updates are
7231 if persistence_notifier.wait_timeout(Duration::from_millis(100)) {
7236 exit_thread.store(true, Ordering::SeqCst);
7238 // Check that the PersistenceNotifier will return after the given duration even if no updates
7241 if !persistence_notifier.wait_timeout(Duration::from_millis(100)) {
7248 fn test_notify_limits() {
7249 // Check that a few cases which don't require the persistence of a new ChannelManager,
7250 // indeed, do not cause the persistence of a new ChannelManager.
7251 let chanmon_cfgs = create_chanmon_cfgs(3);
7252 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7253 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7254 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7256 // All nodes start with a persistable update pending as `create_network` connects each node
7257 // with all other nodes to make most tests simpler.
7258 assert!(nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7259 assert!(nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7260 assert!(nodes[2].node.await_persistable_update_timeout(Duration::from_millis(1)));
7262 let mut chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7264 // We check that the channel info nodes have doesn't change too early, even though we try
7265 // to connect messages with new values
7266 chan.0.contents.fee_base_msat *= 2;
7267 chan.1.contents.fee_base_msat *= 2;
7268 let node_a_chan_info = nodes[0].node.list_channels()[0].clone();
7269 let node_b_chan_info = nodes[1].node.list_channels()[0].clone();
7271 // The first two nodes (which opened a channel) should now require fresh persistence
7272 assert!(nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7273 assert!(nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7274 // ... but the last node should not.
7275 assert!(!nodes[2].node.await_persistable_update_timeout(Duration::from_millis(1)));
7276 // After persisting the first two nodes they should no longer need fresh persistence.
7277 assert!(!nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7278 assert!(!nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7280 // Node 3, unrelated to the only channel, shouldn't care if it receives a channel_update
7281 // about the channel.
7282 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.0);
7283 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.1);
7284 assert!(!nodes[2].node.await_persistable_update_timeout(Duration::from_millis(1)));
7286 // The nodes which are a party to the channel should also ignore messages from unrelated
7288 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
7289 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
7290 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
7291 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
7292 assert!(!nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7293 assert!(!nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7295 // At this point the channel info given by peers should still be the same.
7296 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
7297 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
7299 // An earlier version of handle_channel_update didn't check the directionality of the
7300 // update message and would always update the local fee info, even if our peer was
7301 // (spuriously) forwarding us our own channel_update.
7302 let as_node_one = nodes[0].node.get_our_node_id().serialize()[..] < nodes[1].node.get_our_node_id().serialize()[..];
7303 let as_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.0 } else { &chan.1 };
7304 let bs_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.1 } else { &chan.0 };
7306 // First deliver each peers' own message, checking that the node doesn't need to be
7307 // persisted and that its channel info remains the same.
7308 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &as_update);
7309 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &bs_update);
7310 assert!(!nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7311 assert!(!nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7312 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
7313 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
7315 // Finally, deliver the other peers' message, ensuring each node needs to be persisted and
7316 // the channel info has updated.
7317 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &bs_update);
7318 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &as_update);
7319 assert!(nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7320 assert!(nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7321 assert_ne!(nodes[0].node.list_channels()[0], node_a_chan_info);
7322 assert_ne!(nodes[1].node.list_channels()[0], node_b_chan_info);
7326 fn test_keysend_dup_hash_partial_mpp() {
7327 // Test that a keysend payment with a duplicate hash to an existing partial MPP payment fails as
7329 let chanmon_cfgs = create_chanmon_cfgs(2);
7330 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7331 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7332 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7333 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7335 // First, send a partial MPP payment.
7336 let (route, our_payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[1], 100_000);
7337 let payment_id = PaymentId([42; 32]);
7338 // Use the utility function send_payment_along_path to send the payment with MPP data which
7339 // indicates there are more HTLCs coming.
7340 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.
7341 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();
7342 check_added_monitors!(nodes[0], 1);
7343 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7344 assert_eq!(events.len(), 1);
7345 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false, None);
7347 // Next, send a keysend payment with the same payment_hash and make sure it fails.
7348 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage)).unwrap();
7349 check_added_monitors!(nodes[0], 1);
7350 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7351 assert_eq!(events.len(), 1);
7352 let ev = events.drain(..).next().unwrap();
7353 let payment_event = SendEvent::from_event(ev);
7354 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7355 check_added_monitors!(nodes[1], 0);
7356 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7357 expect_pending_htlcs_forwardable!(nodes[1]);
7358 expect_pending_htlcs_forwardable!(nodes[1]);
7359 check_added_monitors!(nodes[1], 1);
7360 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7361 assert!(updates.update_add_htlcs.is_empty());
7362 assert!(updates.update_fulfill_htlcs.is_empty());
7363 assert_eq!(updates.update_fail_htlcs.len(), 1);
7364 assert!(updates.update_fail_malformed_htlcs.is_empty());
7365 assert!(updates.update_fee.is_none());
7366 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
7367 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
7368 expect_payment_failed!(nodes[0], our_payment_hash, true);
7370 // Send the second half of the original MPP payment.
7371 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();
7372 check_added_monitors!(nodes[0], 1);
7373 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7374 assert_eq!(events.len(), 1);
7375 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), true, None);
7377 // Claim the full MPP payment. Note that we can't use a test utility like
7378 // claim_funds_along_route because the ordering of the messages causes the second half of the
7379 // payment to be put in the holding cell, which confuses the test utilities. So we exchange the
7380 // lightning messages manually.
7381 nodes[1].node.claim_funds(payment_preimage);
7382 expect_payment_claimed!(nodes[1], our_payment_hash, 200_000);
7383 check_added_monitors!(nodes[1], 2);
7385 let bs_first_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7386 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_first_updates.update_fulfill_htlcs[0]);
7387 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_first_updates.commitment_signed);
7388 check_added_monitors!(nodes[0], 1);
7389 let (as_first_raa, as_first_cs) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7390 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_first_raa);
7391 check_added_monitors!(nodes[1], 1);
7392 let bs_second_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7393 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_first_cs);
7394 check_added_monitors!(nodes[1], 1);
7395 let bs_first_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
7396 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_second_updates.update_fulfill_htlcs[0]);
7397 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_updates.commitment_signed);
7398 check_added_monitors!(nodes[0], 1);
7399 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
7400 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
7401 let as_second_updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7402 check_added_monitors!(nodes[0], 1);
7403 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
7404 check_added_monitors!(nodes[1], 1);
7405 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_updates.commitment_signed);
7406 check_added_monitors!(nodes[1], 1);
7407 let bs_third_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
7408 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_third_raa);
7409 check_added_monitors!(nodes[0], 1);
7411 // Note that successful MPP payments will generate a single PaymentSent event upon the first
7412 // path's success and a PaymentPathSuccessful event for each path's success.
7413 let events = nodes[0].node.get_and_clear_pending_events();
7414 assert_eq!(events.len(), 3);
7416 Event::PaymentSent { payment_id: ref id, payment_preimage: ref preimage, payment_hash: ref hash, .. } => {
7417 assert_eq!(Some(payment_id), *id);
7418 assert_eq!(payment_preimage, *preimage);
7419 assert_eq!(our_payment_hash, *hash);
7421 _ => panic!("Unexpected event"),
7424 Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
7425 assert_eq!(payment_id, *actual_payment_id);
7426 assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
7427 assert_eq!(route.paths[0], *path);
7429 _ => panic!("Unexpected event"),
7432 Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
7433 assert_eq!(payment_id, *actual_payment_id);
7434 assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
7435 assert_eq!(route.paths[0], *path);
7437 _ => panic!("Unexpected event"),
7442 fn test_keysend_dup_payment_hash() {
7443 // (1): Test that a keysend payment with a duplicate payment hash to an existing pending
7444 // outbound regular payment fails as expected.
7445 // (2): Test that a regular payment with a duplicate payment hash to an existing keysend payment
7446 // fails as expected.
7447 let chanmon_cfgs = create_chanmon_cfgs(2);
7448 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7449 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7450 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7451 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7452 let scorer = test_utils::TestScorer::with_penalty(0);
7453 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
7455 // To start (1), send a regular payment but don't claim it.
7456 let expected_route = [&nodes[1]];
7457 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &expected_route, 100_000);
7459 // Next, attempt a keysend payment and make sure it fails.
7460 let route_params = RouteParameters {
7461 payment_params: PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id()),
7462 final_value_msat: 100_000,
7463 final_cltv_expiry_delta: TEST_FINAL_CLTV,
7465 let route = find_route(
7466 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
7467 None, nodes[0].logger, &scorer, &random_seed_bytes
7469 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage)).unwrap();
7470 check_added_monitors!(nodes[0], 1);
7471 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7472 assert_eq!(events.len(), 1);
7473 let ev = events.drain(..).next().unwrap();
7474 let payment_event = SendEvent::from_event(ev);
7475 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7476 check_added_monitors!(nodes[1], 0);
7477 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7478 expect_pending_htlcs_forwardable!(nodes[1]);
7479 expect_pending_htlcs_forwardable!(nodes[1]);
7480 check_added_monitors!(nodes[1], 1);
7481 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7482 assert!(updates.update_add_htlcs.is_empty());
7483 assert!(updates.update_fulfill_htlcs.is_empty());
7484 assert_eq!(updates.update_fail_htlcs.len(), 1);
7485 assert!(updates.update_fail_malformed_htlcs.is_empty());
7486 assert!(updates.update_fee.is_none());
7487 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
7488 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
7489 expect_payment_failed!(nodes[0], payment_hash, true);
7491 // Finally, claim the original payment.
7492 claim_payment(&nodes[0], &expected_route, payment_preimage);
7494 // To start (2), send a keysend payment but don't claim it.
7495 let payment_preimage = PaymentPreimage([42; 32]);
7496 let route = find_route(
7497 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
7498 None, nodes[0].logger, &scorer, &random_seed_bytes
7500 let (payment_hash, _) = nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage)).unwrap();
7501 check_added_monitors!(nodes[0], 1);
7502 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7503 assert_eq!(events.len(), 1);
7504 let event = events.pop().unwrap();
7505 let path = vec![&nodes[1]];
7506 pass_along_path(&nodes[0], &path, 100_000, payment_hash, None, event, true, Some(payment_preimage));
7508 // Next, attempt a regular payment and make sure it fails.
7509 let payment_secret = PaymentSecret([43; 32]);
7510 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
7511 check_added_monitors!(nodes[0], 1);
7512 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7513 assert_eq!(events.len(), 1);
7514 let ev = events.drain(..).next().unwrap();
7515 let payment_event = SendEvent::from_event(ev);
7516 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7517 check_added_monitors!(nodes[1], 0);
7518 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7519 expect_pending_htlcs_forwardable!(nodes[1]);
7520 expect_pending_htlcs_forwardable!(nodes[1]);
7521 check_added_monitors!(nodes[1], 1);
7522 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7523 assert!(updates.update_add_htlcs.is_empty());
7524 assert!(updates.update_fulfill_htlcs.is_empty());
7525 assert_eq!(updates.update_fail_htlcs.len(), 1);
7526 assert!(updates.update_fail_malformed_htlcs.is_empty());
7527 assert!(updates.update_fee.is_none());
7528 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
7529 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
7530 expect_payment_failed!(nodes[0], payment_hash, true);
7532 // Finally, succeed the keysend payment.
7533 claim_payment(&nodes[0], &expected_route, payment_preimage);
7537 fn test_keysend_hash_mismatch() {
7538 // Test that if we receive a keysend `update_add_htlc` msg, we fail as expected if the keysend
7539 // preimage doesn't match the msg's payment hash.
7540 let chanmon_cfgs = create_chanmon_cfgs(2);
7541 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7542 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7543 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7545 let payer_pubkey = nodes[0].node.get_our_node_id();
7546 let payee_pubkey = nodes[1].node.get_our_node_id();
7547 nodes[0].node.peer_connected(&payee_pubkey, &msgs::Init { features: InitFeatures::known(), remote_network_address: None });
7548 nodes[1].node.peer_connected(&payer_pubkey, &msgs::Init { features: InitFeatures::known(), remote_network_address: None });
7550 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
7551 let route_params = RouteParameters {
7552 payment_params: PaymentParameters::for_keysend(payee_pubkey),
7553 final_value_msat: 10000,
7554 final_cltv_expiry_delta: 40,
7556 let network_graph = nodes[0].network_graph;
7557 let first_hops = nodes[0].node.list_usable_channels();
7558 let scorer = test_utils::TestScorer::with_penalty(0);
7559 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
7560 let route = find_route(
7561 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
7562 nodes[0].logger, &scorer, &random_seed_bytes
7565 let test_preimage = PaymentPreimage([42; 32]);
7566 let mismatch_payment_hash = PaymentHash([43; 32]);
7567 let _ = nodes[0].node.send_payment_internal(&route, mismatch_payment_hash, &None, Some(test_preimage), None, None).unwrap();
7568 check_added_monitors!(nodes[0], 1);
7570 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7571 assert_eq!(updates.update_add_htlcs.len(), 1);
7572 assert!(updates.update_fulfill_htlcs.is_empty());
7573 assert!(updates.update_fail_htlcs.is_empty());
7574 assert!(updates.update_fail_malformed_htlcs.is_empty());
7575 assert!(updates.update_fee.is_none());
7576 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7578 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Payment preimage didn't match payment hash".to_string(), 1);
7582 fn test_keysend_msg_with_secret_err() {
7583 // Test that we error as expected if we receive a keysend payment that includes a payment secret.
7584 let chanmon_cfgs = create_chanmon_cfgs(2);
7585 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7586 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7587 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7589 let payer_pubkey = nodes[0].node.get_our_node_id();
7590 let payee_pubkey = nodes[1].node.get_our_node_id();
7591 nodes[0].node.peer_connected(&payee_pubkey, &msgs::Init { features: InitFeatures::known(), remote_network_address: None });
7592 nodes[1].node.peer_connected(&payer_pubkey, &msgs::Init { features: InitFeatures::known(), remote_network_address: None });
7594 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
7595 let route_params = RouteParameters {
7596 payment_params: PaymentParameters::for_keysend(payee_pubkey),
7597 final_value_msat: 10000,
7598 final_cltv_expiry_delta: 40,
7600 let network_graph = nodes[0].network_graph;
7601 let first_hops = nodes[0].node.list_usable_channels();
7602 let scorer = test_utils::TestScorer::with_penalty(0);
7603 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
7604 let route = find_route(
7605 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
7606 nodes[0].logger, &scorer, &random_seed_bytes
7609 let test_preimage = PaymentPreimage([42; 32]);
7610 let test_secret = PaymentSecret([43; 32]);
7611 let payment_hash = PaymentHash(Sha256::hash(&test_preimage.0).into_inner());
7612 let _ = nodes[0].node.send_payment_internal(&route, payment_hash, &Some(test_secret), Some(test_preimage), None, None).unwrap();
7613 check_added_monitors!(nodes[0], 1);
7615 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7616 assert_eq!(updates.update_add_htlcs.len(), 1);
7617 assert!(updates.update_fulfill_htlcs.is_empty());
7618 assert!(updates.update_fail_htlcs.is_empty());
7619 assert!(updates.update_fail_malformed_htlcs.is_empty());
7620 assert!(updates.update_fee.is_none());
7621 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7623 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "We don't support MPP keysend payments".to_string(), 1);
7627 fn test_multi_hop_missing_secret() {
7628 let chanmon_cfgs = create_chanmon_cfgs(4);
7629 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
7630 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
7631 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
7633 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7634 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7635 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7636 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7638 // Marshall an MPP route.
7639 let (mut route, payment_hash, _, _) = get_route_and_payment_hash!(&nodes[0], nodes[3], 100000);
7640 let path = route.paths[0].clone();
7641 route.paths.push(path);
7642 route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
7643 route.paths[0][0].short_channel_id = chan_1_id;
7644 route.paths[0][1].short_channel_id = chan_3_id;
7645 route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
7646 route.paths[1][0].short_channel_id = chan_2_id;
7647 route.paths[1][1].short_channel_id = chan_4_id;
7649 match nodes[0].node.send_payment(&route, payment_hash, &None).unwrap_err() {
7650 PaymentSendFailure::ParameterError(APIError::APIMisuseError { ref err }) => {
7651 assert!(regex::Regex::new(r"Payment secret is required for multi-path payments").unwrap().is_match(err)) },
7652 _ => panic!("unexpected error")
7657 fn bad_inbound_payment_hash() {
7658 // Add coverage for checking that a user-provided payment hash matches the payment secret.
7659 let chanmon_cfgs = create_chanmon_cfgs(2);
7660 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7661 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7662 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7664 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[0]);
7665 let payment_data = msgs::FinalOnionHopData {
7667 total_msat: 100_000,
7670 // Ensure that if the payment hash given to `inbound_payment::verify` differs from the original,
7671 // payment verification fails as expected.
7672 let mut bad_payment_hash = payment_hash.clone();
7673 bad_payment_hash.0[0] += 1;
7674 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) {
7675 Ok(_) => panic!("Unexpected ok"),
7677 nodes[0].logger.assert_log_contains("lightning::ln::inbound_payment".to_string(), "Failing HTLC with user-generated payment_hash".to_string(), 1);
7681 // Check that using the original payment hash succeeds.
7682 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());
7686 #[cfg(all(any(test, feature = "_test_utils"), feature = "_bench_unstable"))]
7689 use chain::chainmonitor::{ChainMonitor, Persist};
7690 use chain::keysinterface::{KeysManager, KeysInterface, InMemorySigner};
7691 use ln::channelmanager::{BestBlock, ChainParameters, ChannelManager, PaymentHash, PaymentPreimage};
7692 use ln::features::{InitFeatures, InvoiceFeatures};
7693 use ln::functional_test_utils::*;
7694 use ln::msgs::{ChannelMessageHandler, Init};
7695 use routing::gossip::NetworkGraph;
7696 use routing::router::{PaymentParameters, get_route};
7697 use util::test_utils;
7698 use util::config::UserConfig;
7699 use util::events::{Event, MessageSendEvent, MessageSendEventsProvider};
7701 use bitcoin::hashes::Hash;
7702 use bitcoin::hashes::sha256::Hash as Sha256;
7703 use bitcoin::{Block, BlockHeader, Transaction, TxOut};
7705 use sync::{Arc, Mutex};
7709 struct NodeHolder<'a, P: Persist<InMemorySigner>> {
7710 node: &'a ChannelManager<InMemorySigner,
7711 &'a ChainMonitor<InMemorySigner, &'a test_utils::TestChainSource,
7712 &'a test_utils::TestBroadcaster, &'a test_utils::TestFeeEstimator,
7713 &'a test_utils::TestLogger, &'a P>,
7714 &'a test_utils::TestBroadcaster, &'a KeysManager,
7715 &'a test_utils::TestFeeEstimator, &'a test_utils::TestLogger>
7720 fn bench_sends(bench: &mut Bencher) {
7721 bench_two_sends(bench, test_utils::TestPersister::new(), test_utils::TestPersister::new());
7724 pub fn bench_two_sends<P: Persist<InMemorySigner>>(bench: &mut Bencher, persister_a: P, persister_b: P) {
7725 // Do a simple benchmark of sending a payment back and forth between two nodes.
7726 // Note that this is unrealistic as each payment send will require at least two fsync
7728 let network = bitcoin::Network::Testnet;
7729 let genesis_hash = bitcoin::blockdata::constants::genesis_block(network).header.block_hash();
7731 let tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), blocks: Arc::new(Mutex::new(Vec::new()))};
7732 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
7734 let mut config: UserConfig = Default::default();
7735 config.channel_handshake_config.minimum_depth = 1;
7737 let logger_a = test_utils::TestLogger::with_id("node a".to_owned());
7738 let chain_monitor_a = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_a);
7739 let seed_a = [1u8; 32];
7740 let keys_manager_a = KeysManager::new(&seed_a, 42, 42);
7741 let node_a = ChannelManager::new(&fee_estimator, &chain_monitor_a, &tx_broadcaster, &logger_a, &keys_manager_a, config.clone(), ChainParameters {
7743 best_block: BestBlock::from_genesis(network),
7745 let node_a_holder = NodeHolder { node: &node_a };
7747 let logger_b = test_utils::TestLogger::with_id("node a".to_owned());
7748 let chain_monitor_b = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_b);
7749 let seed_b = [2u8; 32];
7750 let keys_manager_b = KeysManager::new(&seed_b, 42, 42);
7751 let node_b = ChannelManager::new(&fee_estimator, &chain_monitor_b, &tx_broadcaster, &logger_b, &keys_manager_b, config.clone(), ChainParameters {
7753 best_block: BestBlock::from_genesis(network),
7755 let node_b_holder = NodeHolder { node: &node_b };
7757 node_a.peer_connected(&node_b.get_our_node_id(), &Init { features: InitFeatures::known(), remote_network_address: None });
7758 node_b.peer_connected(&node_a.get_our_node_id(), &Init { features: InitFeatures::known(), remote_network_address: None });
7759 node_a.create_channel(node_b.get_our_node_id(), 8_000_000, 100_000_000, 42, None).unwrap();
7760 node_b.handle_open_channel(&node_a.get_our_node_id(), InitFeatures::known(), &get_event_msg!(node_a_holder, MessageSendEvent::SendOpenChannel, node_b.get_our_node_id()));
7761 node_a.handle_accept_channel(&node_b.get_our_node_id(), InitFeatures::known(), &get_event_msg!(node_b_holder, MessageSendEvent::SendAcceptChannel, node_a.get_our_node_id()));
7764 if let Event::FundingGenerationReady { temporary_channel_id, output_script, .. } = get_event!(node_a_holder, Event::FundingGenerationReady) {
7765 tx = Transaction { version: 2, lock_time: 0, input: Vec::new(), output: vec![TxOut {
7766 value: 8_000_000, script_pubkey: output_script,
7768 node_a.funding_transaction_generated(&temporary_channel_id, &node_b.get_our_node_id(), tx.clone()).unwrap();
7769 } else { panic!(); }
7771 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()));
7772 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()));
7774 assert_eq!(&tx_broadcaster.txn_broadcasted.lock().unwrap()[..], &[tx.clone()]);
7777 header: BlockHeader { version: 0x20000000, prev_blockhash: genesis_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
7780 Listen::block_connected(&node_a, &block, 1);
7781 Listen::block_connected(&node_b, &block, 1);
7783 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()));
7784 let msg_events = node_a.get_and_clear_pending_msg_events();
7785 assert_eq!(msg_events.len(), 2);
7786 match msg_events[0] {
7787 MessageSendEvent::SendChannelReady { ref msg, .. } => {
7788 node_b.handle_channel_ready(&node_a.get_our_node_id(), msg);
7789 get_event_msg!(node_b_holder, MessageSendEvent::SendChannelUpdate, node_a.get_our_node_id());
7793 match msg_events[1] {
7794 MessageSendEvent::SendChannelUpdate { .. } => {},
7798 let dummy_graph = NetworkGraph::new(genesis_hash, &logger_a);
7800 let mut payment_count: u64 = 0;
7801 macro_rules! send_payment {
7802 ($node_a: expr, $node_b: expr) => {
7803 let usable_channels = $node_a.list_usable_channels();
7804 let payment_params = PaymentParameters::from_node_id($node_b.get_our_node_id())
7805 .with_features(InvoiceFeatures::known());
7806 let scorer = test_utils::TestScorer::with_penalty(0);
7807 let seed = [3u8; 32];
7808 let keys_manager = KeysManager::new(&seed, 42, 42);
7809 let random_seed_bytes = keys_manager.get_secure_random_bytes();
7810 let route = get_route(&$node_a.get_our_node_id(), &payment_params, &dummy_graph.read_only(),
7811 Some(&usable_channels.iter().map(|r| r).collect::<Vec<_>>()), 10_000, TEST_FINAL_CLTV, &logger_a, &scorer, &random_seed_bytes).unwrap();
7813 let mut payment_preimage = PaymentPreimage([0; 32]);
7814 payment_preimage.0[0..8].copy_from_slice(&payment_count.to_le_bytes());
7816 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
7817 let payment_secret = $node_b.create_inbound_payment_for_hash(payment_hash, None, 7200).unwrap();
7819 $node_a.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
7820 let payment_event = SendEvent::from_event($node_a.get_and_clear_pending_msg_events().pop().unwrap());
7821 $node_b.handle_update_add_htlc(&$node_a.get_our_node_id(), &payment_event.msgs[0]);
7822 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &payment_event.commitment_msg);
7823 let (raa, cs) = get_revoke_commit_msgs!(NodeHolder { node: &$node_b }, $node_a.get_our_node_id());
7824 $node_a.handle_revoke_and_ack(&$node_b.get_our_node_id(), &raa);
7825 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &cs);
7826 $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()));
7828 expect_pending_htlcs_forwardable!(NodeHolder { node: &$node_b });
7829 expect_payment_received!(NodeHolder { node: &$node_b }, payment_hash, payment_secret, 10_000);
7830 $node_b.claim_funds(payment_preimage);
7831 expect_payment_claimed!(NodeHolder { node: &$node_b }, payment_hash, 10_000);
7833 match $node_b.get_and_clear_pending_msg_events().pop().unwrap() {
7834 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
7835 assert_eq!(node_id, $node_a.get_our_node_id());
7836 $node_a.handle_update_fulfill_htlc(&$node_b.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
7837 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &updates.commitment_signed);
7839 _ => panic!("Failed to generate claim event"),
7842 let (raa, cs) = get_revoke_commit_msgs!(NodeHolder { node: &$node_a }, $node_b.get_our_node_id());
7843 $node_b.handle_revoke_and_ack(&$node_a.get_our_node_id(), &raa);
7844 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &cs);
7845 $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()));
7847 expect_payment_sent!(NodeHolder { node: &$node_a }, payment_preimage);
7852 send_payment!(node_a, node_b);
7853 send_payment!(node_b, node_a);