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, HashEngine};
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;
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 {
372 ChannelError::CloseDelayBroadcast(msg) => LightningError {
374 action: msgs::ErrorAction::SendErrorMessage {
375 msg: msgs::ErrorMessage {
383 shutdown_finish: None,
388 /// We hold back HTLCs we intend to relay for a random interval greater than this (see
389 /// Event::PendingHTLCsForwardable for the API guidelines indicating how long should be waited).
390 /// This provides some limited amount of privacy. Ideally this would range from somewhere like one
391 /// second to 30 seconds, but people expect lightning to be, you know, kinda fast, sadly.
392 const MIN_HTLC_RELAY_HOLDING_CELL_MILLIS: u64 = 100;
394 /// For events which result in both a RevokeAndACK and a CommitmentUpdate, by default they should
395 /// be sent in the order they appear in the return value, however sometimes the order needs to be
396 /// variable at runtime (eg Channel::channel_reestablish needs to re-send messages in the order
397 /// they were originally sent). In those cases, this enum is also returned.
398 #[derive(Clone, PartialEq)]
399 pub(super) enum RAACommitmentOrder {
400 /// Send the CommitmentUpdate messages first
402 /// Send the RevokeAndACK message first
406 // Note this is only exposed in cfg(test):
407 pub(super) struct ChannelHolder<Signer: Sign> {
408 pub(super) by_id: HashMap<[u8; 32], Channel<Signer>>,
409 /// SCIDs (and outbound SCID aliases) to the real channel id. Outbound SCID aliases are added
410 /// here once the channel is available for normal use, with SCIDs being added once the funding
411 /// transaction is confirmed at the channel's required confirmation depth.
412 pub(super) short_to_id: HashMap<u64, [u8; 32]>,
413 /// SCID/SCID Alias -> forward infos. Key of 0 means payments received.
415 /// Note that because we may have an SCID Alias as the key we can have two entries per channel,
416 /// though in practice we probably won't be receiving HTLCs for a channel both via the alias
417 /// and via the classic SCID.
419 /// Note that while this is held in the same mutex as the channels themselves, no consistency
420 /// guarantees are made about the existence of a channel with the short id here, nor the short
421 /// ids in the PendingHTLCInfo!
422 pub(super) forward_htlcs: HashMap<u64, Vec<HTLCForwardInfo>>,
423 /// Map from payment hash to the payment data and any HTLCs which are to us and can be
424 /// failed/claimed by the user.
426 /// Note that while this is held in the same mutex as the channels themselves, no consistency
427 /// guarantees are made about the channels given here actually existing anymore by the time you
429 claimable_htlcs: HashMap<PaymentHash, (events::PaymentPurpose, Vec<ClaimableHTLC>)>,
430 /// Messages to send to peers - pushed to in the same lock that they are generated in (except
431 /// for broadcast messages, where ordering isn't as strict).
432 pub(super) pending_msg_events: Vec<MessageSendEvent>,
435 /// Events which we process internally but cannot be procsesed immediately at the generation site
436 /// for some reason. They are handled in timer_tick_occurred, so may be processed with
437 /// quite some time lag.
438 enum BackgroundEvent {
439 /// Handle a ChannelMonitorUpdate that closes a channel, broadcasting its current latest holder
440 /// commitment transaction.
441 ClosingMonitorUpdate((OutPoint, ChannelMonitorUpdate)),
444 /// State we hold per-peer. In the future we should put channels in here, but for now we only hold
445 /// the latest Init features we heard from the peer.
447 latest_features: InitFeatures,
450 /// Stores a PaymentSecret and any other data we may need to validate an inbound payment is
451 /// actually ours and not some duplicate HTLC sent to us by a node along the route.
453 /// For users who don't want to bother doing their own payment preimage storage, we also store that
456 /// Note that this struct will be removed entirely soon, in favor of storing no inbound payment data
457 /// and instead encoding it in the payment secret.
458 struct PendingInboundPayment {
459 /// The payment secret that the sender must use for us to accept this payment
460 payment_secret: PaymentSecret,
461 /// Time at which this HTLC expires - blocks with a header time above this value will result in
462 /// this payment being removed.
464 /// Arbitrary identifier the user specifies (or not)
465 user_payment_id: u64,
466 // Other required attributes of the payment, optionally enforced:
467 payment_preimage: Option<PaymentPreimage>,
468 min_value_msat: Option<u64>,
471 /// Stores the session_priv for each part of a payment that is still pending. For versions 0.0.102
472 /// and later, also stores information for retrying the payment.
473 pub(crate) enum PendingOutboundPayment {
475 session_privs: HashSet<[u8; 32]>,
478 session_privs: HashSet<[u8; 32]>,
479 payment_hash: PaymentHash,
480 payment_secret: Option<PaymentSecret>,
481 pending_amt_msat: u64,
482 /// Used to track the fee paid. Only present if the payment was serialized on 0.0.103+.
483 pending_fee_msat: Option<u64>,
484 /// The total payment amount across all paths, used to verify that a retry is not overpaying.
486 /// Our best known block height at the time this payment was initiated.
487 starting_block_height: u32,
489 /// When a pending payment is fulfilled, we continue tracking it until all pending HTLCs have
490 /// been resolved. This ensures we don't look up pending payments in ChannelMonitors on restart
491 /// and add a pending payment that was already fulfilled.
493 session_privs: HashSet<[u8; 32]>,
494 payment_hash: Option<PaymentHash>,
496 /// When a payer gives up trying to retry a payment, they inform us, letting us generate a
497 /// `PaymentFailed` event when all HTLCs have irrevocably failed. This avoids a number of race
498 /// conditions in MPP-aware payment retriers (1), where the possibility of multiple
499 /// `PaymentPathFailed` events with `all_paths_failed` can be pending at once, confusing a
500 /// downstream event handler as to when a payment has actually failed.
502 /// (1) https://github.com/lightningdevkit/rust-lightning/issues/1164
504 session_privs: HashSet<[u8; 32]>,
505 payment_hash: PaymentHash,
509 impl PendingOutboundPayment {
510 fn is_retryable(&self) -> bool {
512 PendingOutboundPayment::Retryable { .. } => true,
516 fn is_fulfilled(&self) -> bool {
518 PendingOutboundPayment::Fulfilled { .. } => true,
522 fn abandoned(&self) -> bool {
524 PendingOutboundPayment::Abandoned { .. } => true,
528 fn get_pending_fee_msat(&self) -> Option<u64> {
530 PendingOutboundPayment::Retryable { pending_fee_msat, .. } => pending_fee_msat.clone(),
535 fn payment_hash(&self) -> Option<PaymentHash> {
537 PendingOutboundPayment::Legacy { .. } => None,
538 PendingOutboundPayment::Retryable { payment_hash, .. } => Some(*payment_hash),
539 PendingOutboundPayment::Fulfilled { payment_hash, .. } => *payment_hash,
540 PendingOutboundPayment::Abandoned { payment_hash, .. } => Some(*payment_hash),
544 fn mark_fulfilled(&mut self) {
545 let mut session_privs = HashSet::new();
546 core::mem::swap(&mut session_privs, match self {
547 PendingOutboundPayment::Legacy { session_privs } |
548 PendingOutboundPayment::Retryable { session_privs, .. } |
549 PendingOutboundPayment::Fulfilled { session_privs, .. } |
550 PendingOutboundPayment::Abandoned { session_privs, .. }
553 let payment_hash = self.payment_hash();
554 *self = PendingOutboundPayment::Fulfilled { session_privs, payment_hash };
557 fn mark_abandoned(&mut self) -> Result<(), ()> {
558 let mut session_privs = HashSet::new();
559 let our_payment_hash;
560 core::mem::swap(&mut session_privs, match self {
561 PendingOutboundPayment::Legacy { .. } |
562 PendingOutboundPayment::Fulfilled { .. } =>
564 PendingOutboundPayment::Retryable { session_privs, payment_hash, .. } |
565 PendingOutboundPayment::Abandoned { session_privs, payment_hash, .. } => {
566 our_payment_hash = *payment_hash;
570 *self = PendingOutboundPayment::Abandoned { session_privs, payment_hash: our_payment_hash };
574 /// panics if path is None and !self.is_fulfilled
575 fn remove(&mut self, session_priv: &[u8; 32], path: Option<&Vec<RouteHop>>) -> bool {
576 let remove_res = match self {
577 PendingOutboundPayment::Legacy { session_privs } |
578 PendingOutboundPayment::Retryable { session_privs, .. } |
579 PendingOutboundPayment::Fulfilled { session_privs, .. } |
580 PendingOutboundPayment::Abandoned { session_privs, .. } => {
581 session_privs.remove(session_priv)
585 if let PendingOutboundPayment::Retryable { ref mut pending_amt_msat, ref mut pending_fee_msat, .. } = self {
586 let path = path.expect("Fulfilling a payment should always come with a path");
587 let path_last_hop = path.last().expect("Outbound payments must have had a valid path");
588 *pending_amt_msat -= path_last_hop.fee_msat;
589 if let Some(fee_msat) = pending_fee_msat.as_mut() {
590 *fee_msat -= path.get_path_fees();
597 fn insert(&mut self, session_priv: [u8; 32], path: &Vec<RouteHop>) -> bool {
598 let insert_res = match self {
599 PendingOutboundPayment::Legacy { session_privs } |
600 PendingOutboundPayment::Retryable { session_privs, .. } => {
601 session_privs.insert(session_priv)
603 PendingOutboundPayment::Fulfilled { .. } => false,
604 PendingOutboundPayment::Abandoned { .. } => false,
607 if let PendingOutboundPayment::Retryable { ref mut pending_amt_msat, ref mut pending_fee_msat, .. } = self {
608 let path_last_hop = path.last().expect("Outbound payments must have had a valid path");
609 *pending_amt_msat += path_last_hop.fee_msat;
610 if let Some(fee_msat) = pending_fee_msat.as_mut() {
611 *fee_msat += path.get_path_fees();
618 fn remaining_parts(&self) -> usize {
620 PendingOutboundPayment::Legacy { session_privs } |
621 PendingOutboundPayment::Retryable { session_privs, .. } |
622 PendingOutboundPayment::Fulfilled { session_privs, .. } |
623 PendingOutboundPayment::Abandoned { session_privs, .. } => {
630 /// SimpleArcChannelManager is useful when you need a ChannelManager with a static lifetime, e.g.
631 /// when you're using lightning-net-tokio (since tokio::spawn requires parameters with static
632 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
633 /// SimpleRefChannelManager is the more appropriate type. Defining these type aliases prevents
634 /// issues such as overly long function definitions. Note that the ChannelManager can take any
635 /// type that implements KeysInterface for its keys manager, but this type alias chooses the
636 /// concrete type of the KeysManager.
638 /// (C-not exported) as Arcs don't make sense in bindings
639 pub type SimpleArcChannelManager<M, T, F, L> = ChannelManager<InMemorySigner, Arc<M>, Arc<T>, Arc<KeysManager>, Arc<F>, Arc<L>>;
641 /// SimpleRefChannelManager is a type alias for a ChannelManager reference, and is the reference
642 /// counterpart to the SimpleArcChannelManager type alias. Use this type by default when you don't
643 /// need a ChannelManager with a static lifetime. You'll need a static lifetime in cases such as
644 /// usage of lightning-net-tokio (since tokio::spawn requires parameters with static lifetimes).
645 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
646 /// helps with issues such as long function definitions. Note that the ChannelManager can take any
647 /// type that implements KeysInterface for its keys manager, but this type alias chooses the
648 /// concrete type of the KeysManager.
650 /// (C-not exported) as Arcs don't make sense in bindings
651 pub type SimpleRefChannelManager<'a, 'b, 'c, 'd, 'e, M, T, F, L> = ChannelManager<InMemorySigner, &'a M, &'b T, &'c KeysManager, &'d F, &'e L>;
653 /// Manager which keeps track of a number of channels and sends messages to the appropriate
654 /// channel, also tracking HTLC preimages and forwarding onion packets appropriately.
656 /// Implements ChannelMessageHandler, handling the multi-channel parts and passing things through
657 /// to individual Channels.
659 /// Implements Writeable to write out all channel state to disk. Implies peer_disconnected() for
660 /// all peers during write/read (though does not modify this instance, only the instance being
661 /// serialized). This will result in any channels which have not yet exchanged funding_created (ie
662 /// called funding_transaction_generated for outbound channels).
664 /// Note that you can be a bit lazier about writing out ChannelManager than you can be with
665 /// ChannelMonitors. With ChannelMonitors you MUST write each monitor update out to disk before
666 /// returning from chain::Watch::watch_/update_channel, with ChannelManagers, writing updates
667 /// happens out-of-band (and will prevent any other ChannelManager operations from occurring during
668 /// the serialization process). If the deserialized version is out-of-date compared to the
669 /// ChannelMonitors passed by reference to read(), those channels will be force-closed based on the
670 /// ChannelMonitor state and no funds will be lost (mod on-chain transaction fees).
672 /// Note that the deserializer is only implemented for (BlockHash, ChannelManager), which
673 /// tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
674 /// the "reorg path" (ie call block_disconnected() until you get to a common block and then call
675 /// block_connected() to step towards your best block) upon deserialization before using the
678 /// Note that ChannelManager is responsible for tracking liveness of its channels and generating
679 /// ChannelUpdate messages informing peers that the channel is temporarily disabled. To avoid
680 /// spam due to quick disconnection/reconnection, updates are not sent until the channel has been
681 /// offline for a full minute. In order to track this, you must call
682 /// timer_tick_occurred roughly once per minute, though it doesn't have to be perfect.
684 /// Rather than using a plain ChannelManager, it is preferable to use either a SimpleArcChannelManager
685 /// a SimpleRefChannelManager, for conciseness. See their documentation for more details, but
686 /// essentially you should default to using a SimpleRefChannelManager, and use a
687 /// SimpleArcChannelManager when you require a ChannelManager with a static lifetime, such as when
688 /// you're using lightning-net-tokio.
689 pub struct ChannelManager<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
690 where M::Target: chain::Watch<Signer>,
691 T::Target: BroadcasterInterface,
692 K::Target: KeysInterface<Signer = Signer>,
693 F::Target: FeeEstimator,
696 default_configuration: UserConfig,
697 genesis_hash: BlockHash,
703 pub(super) best_block: RwLock<BestBlock>,
705 best_block: RwLock<BestBlock>,
706 secp_ctx: Secp256k1<secp256k1::All>,
708 #[cfg(any(test, feature = "_test_utils"))]
709 pub(super) channel_state: Mutex<ChannelHolder<Signer>>,
710 #[cfg(not(any(test, feature = "_test_utils")))]
711 channel_state: Mutex<ChannelHolder<Signer>>,
713 /// Storage for PaymentSecrets and any requirements on future inbound payments before we will
714 /// expose them to users via a PaymentReceived event. HTLCs which do not meet the requirements
715 /// here are failed when we process them as pending-forwardable-HTLCs, and entries are removed
716 /// after we generate a PaymentReceived upon receipt of all MPP parts or when they time out.
717 /// Locked *after* channel_state.
718 pending_inbound_payments: Mutex<HashMap<PaymentHash, PendingInboundPayment>>,
720 /// The session_priv bytes and retry metadata of outbound payments which are pending resolution.
721 /// The authoritative state of these HTLCs resides either within Channels or ChannelMonitors
722 /// (if the channel has been force-closed), however we track them here to prevent duplicative
723 /// PaymentSent/PaymentPathFailed events. Specifically, in the case of a duplicative
724 /// update_fulfill_htlc message after a reconnect, we may "claim" a payment twice.
725 /// Additionally, because ChannelMonitors are often not re-serialized after connecting block(s)
726 /// which may generate a claim event, we may receive similar duplicate claim/fail MonitorEvents
727 /// after reloading from disk while replaying blocks against ChannelMonitors.
729 /// See `PendingOutboundPayment` documentation for more info.
731 /// Locked *after* channel_state.
732 pending_outbound_payments: Mutex<HashMap<PaymentId, PendingOutboundPayment>>,
734 /// The set of outbound SCID aliases across all our channels, including unconfirmed channels
735 /// and some closed channels which reached a usable state prior to being closed. This is used
736 /// only to avoid duplicates, and is not persisted explicitly to disk, but rebuilt from the
737 /// active channel list on load.
738 outbound_scid_aliases: Mutex<HashSet<u64>>,
740 our_network_key: SecretKey,
741 our_network_pubkey: PublicKey,
743 inbound_payment_key: inbound_payment::ExpandedKey,
745 /// LDK puts the [fake scids] that it generates into namespaces, to identify the type of an
746 /// incoming payment. To make it harder for a third-party to identify the type of a payment,
747 /// we encrypt the namespace identifier using these bytes.
749 /// [fake scids]: crate::util::scid_utils::fake_scid
750 fake_scid_rand_bytes: [u8; 32],
752 /// Used to track the last value sent in a node_announcement "timestamp" field. We ensure this
753 /// value increases strictly since we don't assume access to a time source.
754 last_node_announcement_serial: AtomicUsize,
756 /// The highest block timestamp we've seen, which is usually a good guess at the current time.
757 /// Assuming most miners are generating blocks with reasonable timestamps, this shouldn't be
758 /// very far in the past, and can only ever be up to two hours in the future.
759 highest_seen_timestamp: AtomicUsize,
761 /// The bulk of our storage will eventually be here (channels and message queues and the like).
762 /// If we are connected to a peer we always at least have an entry here, even if no channels
763 /// are currently open with that peer.
764 /// Because adding or removing an entry is rare, we usually take an outer read lock and then
765 /// operate on the inner value freely. Sadly, this prevents parallel operation when opening a
768 /// If also holding `channel_state` lock, must lock `channel_state` prior to `per_peer_state`.
769 per_peer_state: RwLock<HashMap<PublicKey, Mutex<PeerState>>>,
771 pending_events: Mutex<Vec<events::Event>>,
772 pending_background_events: Mutex<Vec<BackgroundEvent>>,
773 /// Used when we have to take a BIG lock to make sure everything is self-consistent.
774 /// Essentially just when we're serializing ourselves out.
775 /// Taken first everywhere where we are making changes before any other locks.
776 /// When acquiring this lock in read mode, rather than acquiring it directly, call
777 /// `PersistenceNotifierGuard::notify_on_drop(..)` and pass the lock to it, to ensure the
778 /// PersistenceNotifier the lock contains sends out a notification when the lock is released.
779 total_consistency_lock: RwLock<()>,
781 persistence_notifier: PersistenceNotifier,
788 /// Chain-related parameters used to construct a new `ChannelManager`.
790 /// Typically, the block-specific parameters are derived from the best block hash for the network,
791 /// as a newly constructed `ChannelManager` will not have created any channels yet. These parameters
792 /// are not needed when deserializing a previously constructed `ChannelManager`.
793 #[derive(Clone, Copy, PartialEq)]
794 pub struct ChainParameters {
795 /// The network for determining the `chain_hash` in Lightning messages.
796 pub network: Network,
798 /// The hash and height of the latest block successfully connected.
800 /// Used to track on-chain channel funding outputs and send payments with reliable timelocks.
801 pub best_block: BestBlock,
804 #[derive(Copy, Clone, PartialEq)]
810 /// Whenever we release the `ChannelManager`'s `total_consistency_lock`, from read mode, it is
811 /// desirable to notify any listeners on `await_persistable_update_timeout`/
812 /// `await_persistable_update` when new updates are available for persistence. Therefore, this
813 /// struct is responsible for locking the total consistency lock and, upon going out of scope,
814 /// sending the aforementioned notification (since the lock being released indicates that the
815 /// updates are ready for persistence).
817 /// We allow callers to either always notify by constructing with `notify_on_drop` or choose to
818 /// notify or not based on whether relevant changes have been made, providing a closure to
819 /// `optionally_notify` which returns a `NotifyOption`.
820 struct PersistenceNotifierGuard<'a, F: Fn() -> NotifyOption> {
821 persistence_notifier: &'a PersistenceNotifier,
823 // We hold onto this result so the lock doesn't get released immediately.
824 _read_guard: RwLockReadGuard<'a, ()>,
827 impl<'a> PersistenceNotifierGuard<'a, fn() -> NotifyOption> { // We don't care what the concrete F is here, it's unused
828 fn notify_on_drop(lock: &'a RwLock<()>, notifier: &'a PersistenceNotifier) -> PersistenceNotifierGuard<'a, impl Fn() -> NotifyOption> {
829 PersistenceNotifierGuard::optionally_notify(lock, notifier, || -> NotifyOption { NotifyOption::DoPersist })
832 fn optionally_notify<F: Fn() -> NotifyOption>(lock: &'a RwLock<()>, notifier: &'a PersistenceNotifier, persist_check: F) -> PersistenceNotifierGuard<'a, F> {
833 let read_guard = lock.read().unwrap();
835 PersistenceNotifierGuard {
836 persistence_notifier: notifier,
837 should_persist: persist_check,
838 _read_guard: read_guard,
843 impl<'a, F: Fn() -> NotifyOption> Drop for PersistenceNotifierGuard<'a, F> {
845 if (self.should_persist)() == NotifyOption::DoPersist {
846 self.persistence_notifier.notify();
851 /// The amount of time in blocks we require our counterparty wait to claim their money (ie time
852 /// between when we, or our watchtower, must check for them having broadcast a theft transaction).
854 /// This can be increased (but not decreased) through [`ChannelHandshakeConfig::our_to_self_delay`]
856 /// [`ChannelHandshakeConfig::our_to_self_delay`]: crate::util::config::ChannelHandshakeConfig::our_to_self_delay
857 pub const BREAKDOWN_TIMEOUT: u16 = 6 * 24;
858 /// The amount of time in blocks we're willing to wait to claim money back to us. This matches
859 /// the maximum required amount in lnd as of March 2021.
860 pub(crate) const MAX_LOCAL_BREAKDOWN_TIMEOUT: u16 = 2 * 6 * 24 * 7;
862 /// The minimum number of blocks between an inbound HTLC's CLTV and the corresponding outbound
863 /// HTLC's CLTV. The current default represents roughly seven hours of blocks at six blocks/hour.
865 /// This can be increased (but not decreased) through [`ChannelConfig::cltv_expiry_delta`]
867 /// [`ChannelConfig::cltv_expiry_delta`]: crate::util::config::ChannelConfig::cltv_expiry_delta
868 // This should always be a few blocks greater than channelmonitor::CLTV_CLAIM_BUFFER,
869 // i.e. the node we forwarded the payment on to should always have enough room to reliably time out
870 // the HTLC via a full update_fail_htlc/commitment_signed dance before we hit the
871 // CLTV_CLAIM_BUFFER point (we static assert that it's at least 3 blocks more).
872 pub const MIN_CLTV_EXPIRY_DELTA: u16 = 6*7;
873 // This should be long enough to allow a payment path drawn across multiple routing hops with substantial
874 // `cltv_expiry_delta`. Indeed, the length of those values is the reaction delay offered to a routing node
875 // in case of HTLC on-chain settlement. While appearing less competitive, a node operator could decide to
876 // scale them up to suit its security policy. At the network-level, we shouldn't constrain them too much,
877 // while avoiding to introduce a DoS vector. Further, a low CTLV_FAR_FAR_AWAY could be a source of
878 // routing failure for any HTLC sender picking up an LDK node among the first hops.
879 pub(super) const CLTV_FAR_FAR_AWAY: u32 = 14 * 24 * 6;
881 /// Minimum CLTV difference between the current block height and received inbound payments.
882 /// Invoices generated for payment to us must set their `min_final_cltv_expiry` field to at least
884 // Note that we fail if exactly HTLC_FAIL_BACK_BUFFER + 1 was used, so we need to add one for
885 // any payments to succeed. Further, we don't want payments to fail if a block was found while
886 // a payment was being routed, so we add an extra block to be safe.
887 pub const MIN_FINAL_CLTV_EXPIRY: u32 = HTLC_FAIL_BACK_BUFFER + 3;
889 // Check that our CLTV_EXPIRY is at least CLTV_CLAIM_BUFFER + ANTI_REORG_DELAY + LATENCY_GRACE_PERIOD_BLOCKS,
890 // ie that if the next-hop peer fails the HTLC within
891 // LATENCY_GRACE_PERIOD_BLOCKS then we'll still have CLTV_CLAIM_BUFFER left to timeout it onchain,
892 // then waiting ANTI_REORG_DELAY to be reorg-safe on the outbound HLTC and
893 // failing the corresponding htlc backward, and us now seeing the last block of ANTI_REORG_DELAY before
894 // LATENCY_GRACE_PERIOD_BLOCKS.
897 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;
899 // Check for ability of an attacker to make us fail on-chain by delaying an HTLC claim. See
900 // ChannelMonitor::should_broadcast_holder_commitment_txn for a description of why this is needed.
903 const CHECK_CLTV_EXPIRY_SANITY_2: u32 = MIN_CLTV_EXPIRY_DELTA as u32 - LATENCY_GRACE_PERIOD_BLOCKS - 2*CLTV_CLAIM_BUFFER;
905 /// The number of blocks before we consider an outbound payment for expiry if it doesn't have any
906 /// pending HTLCs in flight.
907 pub(crate) const PAYMENT_EXPIRY_BLOCKS: u32 = 3;
909 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] until expiry of incomplete MPPs
910 pub(crate) const MPP_TIMEOUT_TICKS: u8 = 3;
912 /// Information needed for constructing an invoice route hint for this channel.
913 #[derive(Clone, Debug, PartialEq)]
914 pub struct CounterpartyForwardingInfo {
915 /// Base routing fee in millisatoshis.
916 pub fee_base_msat: u32,
917 /// Amount in millionths of a satoshi the channel will charge per transferred satoshi.
918 pub fee_proportional_millionths: u32,
919 /// The minimum difference in cltv_expiry between an ingoing HTLC and its outgoing counterpart,
920 /// such that the outgoing HTLC is forwardable to this counterparty. See `msgs::ChannelUpdate`'s
921 /// `cltv_expiry_delta` for more details.
922 pub cltv_expiry_delta: u16,
925 /// Channel parameters which apply to our counterparty. These are split out from [`ChannelDetails`]
926 /// to better separate parameters.
927 #[derive(Clone, Debug, PartialEq)]
928 pub struct ChannelCounterparty {
929 /// The node_id of our counterparty
930 pub node_id: PublicKey,
931 /// The Features the channel counterparty provided upon last connection.
932 /// Useful for routing as it is the most up-to-date copy of the counterparty's features and
933 /// many routing-relevant features are present in the init context.
934 pub features: InitFeatures,
935 /// The value, in satoshis, that must always be held in the channel for our counterparty. This
936 /// value ensures that if our counterparty broadcasts a revoked state, we can punish them by
937 /// claiming at least this value on chain.
939 /// This value is not included in [`inbound_capacity_msat`] as it can never be spent.
941 /// [`inbound_capacity_msat`]: ChannelDetails::inbound_capacity_msat
942 pub unspendable_punishment_reserve: u64,
943 /// Information on the fees and requirements that the counterparty requires when forwarding
944 /// payments to us through this channel.
945 pub forwarding_info: Option<CounterpartyForwardingInfo>,
946 /// The smallest value HTLC (in msat) the remote peer will accept, for this channel. This field
947 /// is only `None` before we have received either the `OpenChannel` or `AcceptChannel` message
948 /// from the remote peer, or for `ChannelCounterparty` objects serialized prior to LDK 0.0.107.
949 pub outbound_htlc_minimum_msat: Option<u64>,
950 /// The largest value HTLC (in msat) the remote peer currently will accept, for this channel.
951 pub outbound_htlc_maximum_msat: Option<u64>,
954 /// Details of a channel, as returned by ChannelManager::list_channels and ChannelManager::list_usable_channels
955 #[derive(Clone, Debug, PartialEq)]
956 pub struct ChannelDetails {
957 /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
958 /// thereafter this is the txid of the funding transaction xor the funding transaction output).
959 /// Note that this means this value is *not* persistent - it can change once during the
960 /// lifetime of the channel.
961 pub channel_id: [u8; 32],
962 /// Parameters which apply to our counterparty. See individual fields for more information.
963 pub counterparty: ChannelCounterparty,
964 /// The Channel's funding transaction output, if we've negotiated the funding transaction with
965 /// our counterparty already.
967 /// Note that, if this has been set, `channel_id` will be equivalent to
968 /// `funding_txo.unwrap().to_channel_id()`.
969 pub funding_txo: Option<OutPoint>,
970 /// The features which this channel operates with. See individual features for more info.
972 /// `None` until negotiation completes and the channel type is finalized.
973 pub channel_type: Option<ChannelTypeFeatures>,
974 /// The position of the funding transaction in the chain. None if the funding transaction has
975 /// not yet been confirmed and the channel fully opened.
977 /// Note that if [`inbound_scid_alias`] is set, it must be used for invoices and inbound
978 /// payments instead of this. See [`get_inbound_payment_scid`].
980 /// For channels with [`confirmations_required`] set to `Some(0)`, [`outbound_scid_alias`] may
981 /// be used in place of this in outbound routes. See [`get_outbound_payment_scid`].
983 /// [`inbound_scid_alias`]: Self::inbound_scid_alias
984 /// [`outbound_scid_alias`]: Self::outbound_scid_alias
985 /// [`get_inbound_payment_scid`]: Self::get_inbound_payment_scid
986 /// [`get_outbound_payment_scid`]: Self::get_outbound_payment_scid
987 /// [`confirmations_required`]: Self::confirmations_required
988 pub short_channel_id: Option<u64>,
989 /// An optional [`short_channel_id`] alias for this channel, randomly generated by us and
990 /// usable in place of [`short_channel_id`] to reference the channel in outbound routes when
991 /// the channel has not yet been confirmed (as long as [`confirmations_required`] is
994 /// This will be `None` as long as the channel is not available for routing outbound payments.
996 /// [`short_channel_id`]: Self::short_channel_id
997 /// [`confirmations_required`]: Self::confirmations_required
998 pub outbound_scid_alias: Option<u64>,
999 /// An optional [`short_channel_id`] alias for this channel, randomly generated by our
1000 /// counterparty and usable in place of [`short_channel_id`] in invoice route hints. Our
1001 /// counterparty will recognize the alias provided here in place of the [`short_channel_id`]
1002 /// when they see a payment to be routed to us.
1004 /// Our counterparty may choose to rotate this value at any time, though will always recognize
1005 /// previous values for inbound payment forwarding.
1007 /// [`short_channel_id`]: Self::short_channel_id
1008 pub inbound_scid_alias: Option<u64>,
1009 /// The value, in satoshis, of this channel as appears in the funding output
1010 pub channel_value_satoshis: u64,
1011 /// The value, in satoshis, that must always be held in the channel for us. This value ensures
1012 /// that if we broadcast a revoked state, our counterparty can punish us by claiming at least
1013 /// this value on chain.
1015 /// This value is not included in [`outbound_capacity_msat`] as it can never be spent.
1017 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1019 /// [`outbound_capacity_msat`]: ChannelDetails::outbound_capacity_msat
1020 pub unspendable_punishment_reserve: Option<u64>,
1021 /// The `user_channel_id` passed in to create_channel, or 0 if the channel was inbound.
1022 pub user_channel_id: u64,
1023 /// Our total balance. This is the amount we would get if we close the channel.
1024 /// This value is not exact. Due to various in-flight changes and feerate changes, exactly this
1025 /// amount is not likely to be recoverable on close.
1027 /// This does not include any pending HTLCs which are not yet fully resolved (and, thus, whose
1028 /// balance is not available for inclusion in new outbound HTLCs). This further does not include
1029 /// any pending outgoing HTLCs which are awaiting some other resolution to be sent.
1030 /// This does not consider any on-chain fees.
1032 /// See also [`ChannelDetails::outbound_capacity_msat`]
1033 pub balance_msat: u64,
1034 /// The available outbound capacity for sending HTLCs to the remote peer. This does not include
1035 /// any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1036 /// available for inclusion in new outbound HTLCs). This further does not include any pending
1037 /// outgoing HTLCs which are awaiting some other resolution to be sent.
1039 /// See also [`ChannelDetails::balance_msat`]
1041 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1042 /// conflict-avoidance policy, exactly this amount is not likely to be spendable. However, we
1043 /// should be able to spend nearly this amount.
1044 pub outbound_capacity_msat: u64,
1045 /// The available outbound capacity for sending a single HTLC to the remote peer. This is
1046 /// similar to [`ChannelDetails::outbound_capacity_msat`] but it may be further restricted by
1047 /// the current state and per-HTLC limit(s). This is intended for use when routing, allowing us
1048 /// to use a limit as close as possible to the HTLC limit we can currently send.
1050 /// See also [`ChannelDetails::balance_msat`] and [`ChannelDetails::outbound_capacity_msat`].
1051 pub next_outbound_htlc_limit_msat: u64,
1052 /// The available inbound capacity for the remote peer to send HTLCs to us. This does not
1053 /// include any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1054 /// available for inclusion in new inbound HTLCs).
1055 /// Note that there are some corner cases not fully handled here, so the actual available
1056 /// inbound capacity may be slightly higher than this.
1058 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1059 /// counterparty's conflict-avoidance policy, exactly this amount is not likely to be spendable.
1060 /// However, our counterparty should be able to spend nearly this amount.
1061 pub inbound_capacity_msat: u64,
1062 /// The number of required confirmations on the funding transaction before the funding will be
1063 /// considered "locked". This number is selected by the channel fundee (i.e. us if
1064 /// [`is_outbound`] is *not* set), and can be selected for inbound channels with
1065 /// [`ChannelHandshakeConfig::minimum_depth`] or limited for outbound channels with
1066 /// [`ChannelHandshakeLimits::max_minimum_depth`].
1068 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1070 /// [`is_outbound`]: ChannelDetails::is_outbound
1071 /// [`ChannelHandshakeConfig::minimum_depth`]: crate::util::config::ChannelHandshakeConfig::minimum_depth
1072 /// [`ChannelHandshakeLimits::max_minimum_depth`]: crate::util::config::ChannelHandshakeLimits::max_minimum_depth
1073 pub confirmations_required: Option<u32>,
1074 /// The number of blocks (after our commitment transaction confirms) that we will need to wait
1075 /// until we can claim our funds after we force-close the channel. During this time our
1076 /// counterparty is allowed to punish us if we broadcasted a stale state. If our counterparty
1077 /// force-closes the channel and broadcasts a commitment transaction we do not have to wait any
1078 /// time to claim our non-HTLC-encumbered funds.
1080 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1081 pub force_close_spend_delay: Option<u16>,
1082 /// True if the channel was initiated (and thus funded) by us.
1083 pub is_outbound: bool,
1084 /// True if the channel is confirmed, channel_ready messages have been exchanged, and the
1085 /// channel is not currently being shut down. `channel_ready` message exchange implies the
1086 /// required confirmation count has been reached (and we were connected to the peer at some
1087 /// point after the funding transaction received enough confirmations). The required
1088 /// confirmation count is provided in [`confirmations_required`].
1090 /// [`confirmations_required`]: ChannelDetails::confirmations_required
1091 pub is_channel_ready: bool,
1092 /// True if the channel is (a) confirmed and channel_ready messages have been exchanged, (b)
1093 /// the peer is connected, and (c) the channel is not currently negotiating a shutdown.
1095 /// This is a strict superset of `is_channel_ready`.
1096 pub is_usable: bool,
1097 /// True if this channel is (or will be) publicly-announced.
1098 pub is_public: bool,
1099 /// The smallest value HTLC (in msat) we will accept, for this channel. This field
1100 /// is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.107
1101 pub inbound_htlc_minimum_msat: Option<u64>,
1102 /// The largest value HTLC (in msat) we currently will accept, for this channel.
1103 pub inbound_htlc_maximum_msat: Option<u64>,
1106 impl ChannelDetails {
1107 /// Gets the current SCID which should be used to identify this channel for inbound payments.
1108 /// This should be used for providing invoice hints or in any other context where our
1109 /// counterparty will forward a payment to us.
1111 /// This is either the [`ChannelDetails::inbound_scid_alias`], if set, or the
1112 /// [`ChannelDetails::short_channel_id`]. See those for more information.
1113 pub fn get_inbound_payment_scid(&self) -> Option<u64> {
1114 self.inbound_scid_alias.or(self.short_channel_id)
1117 /// Gets the current SCID which should be used to identify this channel for outbound payments.
1118 /// This should be used in [`Route`]s to describe the first hop or in other contexts where
1119 /// we're sending or forwarding a payment outbound over this channel.
1121 /// This is either the [`ChannelDetails::short_channel_id`], if set, or the
1122 /// [`ChannelDetails::outbound_scid_alias`]. See those for more information.
1123 pub fn get_outbound_payment_scid(&self) -> Option<u64> {
1124 self.short_channel_id.or(self.outbound_scid_alias)
1128 /// If a payment fails to send, it can be in one of several states. This enum is returned as the
1129 /// Err() type describing which state the payment is in, see the description of individual enum
1130 /// states for more.
1131 #[derive(Clone, Debug)]
1132 pub enum PaymentSendFailure {
1133 /// A parameter which was passed to send_payment was invalid, preventing us from attempting to
1134 /// send the payment at all. No channel state has been changed or messages sent to peers, and
1135 /// once you've changed the parameter at error, you can freely retry the payment in full.
1136 ParameterError(APIError),
1137 /// A parameter in a single path which was passed to send_payment was invalid, preventing us
1138 /// from attempting to send the payment at all. No channel state has been changed or messages
1139 /// sent to peers, and once you've changed the parameter at error, you can freely retry the
1140 /// payment in full.
1142 /// The results here are ordered the same as the paths in the route object which was passed to
1144 PathParameterError(Vec<Result<(), APIError>>),
1145 /// All paths which were attempted failed to send, with no channel state change taking place.
1146 /// You can freely retry the payment in full (though you probably want to do so over different
1147 /// paths than the ones selected).
1148 AllFailedRetrySafe(Vec<APIError>),
1149 /// Some paths which were attempted failed to send, though possibly not all. At least some
1150 /// paths have irrevocably committed to the HTLC and retrying the payment in full would result
1151 /// in over-/re-payment.
1153 /// The results here are ordered the same as the paths in the route object which was passed to
1154 /// send_payment, and any Errs which are not APIError::MonitorUpdateFailed can be safely
1155 /// retried (though there is currently no API with which to do so).
1157 /// Any entries which contain Err(APIError::MonitorUpdateFailed) or Ok(()) MUST NOT be retried
1158 /// as they will result in over-/re-payment. These HTLCs all either successfully sent (in the
1159 /// case of Ok(())) or will send once channel_monitor_updated is called on the next-hop channel
1160 /// with the latest update_id.
1162 /// The errors themselves, in the same order as the route hops.
1163 results: Vec<Result<(), APIError>>,
1164 /// If some paths failed without irrevocably committing to the new HTLC(s), this will
1165 /// contain a [`RouteParameters`] object which can be used to calculate a new route that
1166 /// will pay all remaining unpaid balance.
1167 failed_paths_retry: Option<RouteParameters>,
1168 /// The payment id for the payment, which is now at least partially pending.
1169 payment_id: PaymentId,
1173 /// Route hints used in constructing invoices for [phantom node payents].
1175 /// [phantom node payments]: crate::chain::keysinterface::PhantomKeysManager
1177 pub struct PhantomRouteHints {
1178 /// The list of channels to be included in the invoice route hints.
1179 pub channels: Vec<ChannelDetails>,
1180 /// A fake scid used for representing the phantom node's fake channel in generating the invoice
1182 pub phantom_scid: u64,
1183 /// The pubkey of the real backing node that would ultimately receive the payment.
1184 pub real_node_pubkey: PublicKey,
1187 macro_rules! handle_error {
1188 ($self: ident, $internal: expr, $counterparty_node_id: expr) => {
1191 Err(MsgHandleErrInternal { err, chan_id, shutdown_finish }) => {
1192 #[cfg(debug_assertions)]
1194 // In testing, ensure there are no deadlocks where the lock is already held upon
1195 // entering the macro.
1196 assert!($self.channel_state.try_lock().is_ok());
1197 assert!($self.pending_events.try_lock().is_ok());
1200 let mut msg_events = Vec::with_capacity(2);
1202 if let Some((shutdown_res, update_option)) = shutdown_finish {
1203 $self.finish_force_close_channel(shutdown_res);
1204 if let Some(update) = update_option {
1205 msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1209 if let Some((channel_id, user_channel_id)) = chan_id {
1210 $self.pending_events.lock().unwrap().push(events::Event::ChannelClosed {
1211 channel_id, user_channel_id,
1212 reason: ClosureReason::ProcessingError { err: err.err.clone() }
1217 log_error!($self.logger, "{}", err.err);
1218 if let msgs::ErrorAction::IgnoreError = err.action {
1220 msg_events.push(events::MessageSendEvent::HandleError {
1221 node_id: $counterparty_node_id,
1222 action: err.action.clone()
1226 if !msg_events.is_empty() {
1227 $self.channel_state.lock().unwrap().pending_msg_events.append(&mut msg_events);
1230 // Return error in case higher-API need one
1237 macro_rules! update_maps_on_chan_removal {
1238 ($self: expr, $short_to_id: expr, $channel: expr) => {
1239 if let Some(short_id) = $channel.get_short_channel_id() {
1240 $short_to_id.remove(&short_id);
1242 // If the channel was never confirmed on-chain prior to its closure, remove the
1243 // outbound SCID alias we used for it from the collision-prevention set. While we
1244 // generally want to avoid ever re-using an outbound SCID alias across all channels, we
1245 // also don't want a counterparty to be able to trivially cause a memory leak by simply
1246 // opening a million channels with us which are closed before we ever reach the funding
1248 let alias_removed = $self.outbound_scid_aliases.lock().unwrap().remove(&$channel.outbound_scid_alias());
1249 debug_assert!(alias_removed);
1251 $short_to_id.remove(&$channel.outbound_scid_alias());
1255 /// Returns (boolean indicating if we should remove the Channel object from memory, a mapped error)
1256 macro_rules! convert_chan_err {
1257 ($self: ident, $err: expr, $short_to_id: expr, $channel: expr, $channel_id: expr) => {
1259 ChannelError::Warn(msg) => {
1260 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Warn(msg), $channel_id.clone()))
1262 ChannelError::Ignore(msg) => {
1263 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore(msg), $channel_id.clone()))
1265 ChannelError::Close(msg) => {
1266 log_error!($self.logger, "Closing channel {} due to close-required error: {}", log_bytes!($channel_id[..]), msg);
1267 update_maps_on_chan_removal!($self, $short_to_id, $channel);
1268 let shutdown_res = $channel.force_shutdown(true);
1269 (true, MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, $channel.get_user_id(),
1270 shutdown_res, $self.get_channel_update_for_broadcast(&$channel).ok()))
1272 ChannelError::CloseDelayBroadcast(msg) => {
1273 log_error!($self.logger, "Channel {} need to be shutdown but closing transactions not broadcast due to {}", log_bytes!($channel_id[..]), msg);
1274 update_maps_on_chan_removal!($self, $short_to_id, $channel);
1275 let shutdown_res = $channel.force_shutdown(false);
1276 (true, MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, $channel.get_user_id(),
1277 shutdown_res, $self.get_channel_update_for_broadcast(&$channel).ok()))
1283 macro_rules! break_chan_entry {
1284 ($self: ident, $res: expr, $channel_state: expr, $entry: expr) => {
1288 let (drop, res) = convert_chan_err!($self, e, $channel_state.short_to_id, $entry.get_mut(), $entry.key());
1290 $entry.remove_entry();
1298 macro_rules! try_chan_entry {
1299 ($self: ident, $res: expr, $channel_state: expr, $entry: expr) => {
1303 let (drop, res) = convert_chan_err!($self, e, $channel_state.short_to_id, $entry.get_mut(), $entry.key());
1305 $entry.remove_entry();
1313 macro_rules! remove_channel {
1314 ($self: expr, $channel_state: expr, $entry: expr) => {
1316 let channel = $entry.remove_entry().1;
1317 update_maps_on_chan_removal!($self, $channel_state.short_to_id, channel);
1323 macro_rules! handle_monitor_err {
1324 ($self: ident, $err: expr, $short_to_id: 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) => {
1326 ChannelMonitorUpdateErr::PermanentFailure => {
1327 log_error!($self.logger, "Closing channel {} due to monitor update ChannelMonitorUpdateErr::PermanentFailure", log_bytes!($chan_id[..]));
1328 update_maps_on_chan_removal!($self, $short_to_id, $chan);
1329 // TODO: $failed_fails is dropped here, which will cause other channels to hit the
1330 // chain in a confused state! We need to move them into the ChannelMonitor which
1331 // will be responsible for failing backwards once things confirm on-chain.
1332 // It's ok that we drop $failed_forwards here - at this point we'd rather they
1333 // broadcast HTLC-Timeout and pay the associated fees to get their funds back than
1334 // us bother trying to claim it just to forward on to another peer. If we're
1335 // splitting hairs we'd prefer to claim payments that were to us, but we haven't
1336 // given up the preimage yet, so might as well just wait until the payment is
1337 // retried, avoiding the on-chain fees.
1338 let res: Result<(), _> = Err(MsgHandleErrInternal::from_finish_shutdown("ChannelMonitor storage failure".to_owned(), *$chan_id, $chan.get_user_id(),
1339 $chan.force_shutdown(true), $self.get_channel_update_for_broadcast(&$chan).ok() ));
1342 ChannelMonitorUpdateErr::TemporaryFailure => {
1343 log_info!($self.logger, "Disabling channel {} due to monitor update TemporaryFailure. On restore will send {} and process {} forwards, {} fails, and {} fulfill finalizations",
1344 log_bytes!($chan_id[..]),
1345 if $resend_commitment && $resend_raa {
1346 match $action_type {
1347 RAACommitmentOrder::CommitmentFirst => { "commitment then RAA" },
1348 RAACommitmentOrder::RevokeAndACKFirst => { "RAA then commitment" },
1350 } else if $resend_commitment { "commitment" }
1351 else if $resend_raa { "RAA" }
1353 (&$failed_forwards as &Vec<(PendingHTLCInfo, u64)>).len(),
1354 (&$failed_fails as &Vec<(HTLCSource, PaymentHash, HTLCFailReason)>).len(),
1355 (&$failed_finalized_fulfills as &Vec<HTLCSource>).len());
1356 if !$resend_commitment {
1357 debug_assert!($action_type == RAACommitmentOrder::RevokeAndACKFirst || !$resend_raa);
1360 debug_assert!($action_type == RAACommitmentOrder::CommitmentFirst || !$resend_commitment);
1362 $chan.monitor_update_failed($resend_raa, $resend_commitment, $resend_channel_ready, $failed_forwards, $failed_fails, $failed_finalized_fulfills);
1363 (Err(MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore("Failed to update ChannelMonitor".to_owned()), *$chan_id)), false)
1367 ($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) => { {
1368 let (res, drop) = handle_monitor_err!($self, $err, $channel_state.short_to_id, $entry.get_mut(), $action_type, $resend_raa, $resend_commitment, $resend_channel_ready, $failed_forwards, $failed_fails, $failed_finalized_fulfills, $entry.key());
1370 $entry.remove_entry();
1374 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $chan_id: expr, COMMITMENT_UPDATE_ONLY) => { {
1375 debug_assert!($action_type == RAACommitmentOrder::CommitmentFirst);
1376 handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, false, true, false, Vec::new(), Vec::new(), Vec::new(), $chan_id)
1378 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $chan_id: expr, NO_UPDATE) => {
1379 handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, false, false, false, Vec::new(), Vec::new(), Vec::new(), $chan_id)
1381 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_channel_ready: expr, OPTIONALLY_RESEND_FUNDING_LOCKED) => {
1382 handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, false, false, $resend_channel_ready, Vec::new(), Vec::new(), Vec::new())
1384 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
1385 handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment, false, Vec::new(), Vec::new(), Vec::new())
1387 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr, $failed_forwards: expr, $failed_fails: expr) => {
1388 handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment, false, $failed_forwards, $failed_fails, Vec::new())
1392 macro_rules! return_monitor_err {
1393 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
1394 return handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment);
1396 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr, $failed_forwards: expr, $failed_fails: expr) => {
1397 return handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment, $failed_forwards, $failed_fails);
1401 // Does not break in case of TemporaryFailure!
1402 macro_rules! maybe_break_monitor_err {
1403 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
1404 match (handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment), $err) {
1405 (e, ChannelMonitorUpdateErr::PermanentFailure) => {
1408 (_, ChannelMonitorUpdateErr::TemporaryFailure) => { },
1413 macro_rules! send_channel_ready {
1414 ($short_to_id: expr, $pending_msg_events: expr, $channel: expr, $channel_ready_msg: expr) => {
1415 $pending_msg_events.push(events::MessageSendEvent::SendChannelReady {
1416 node_id: $channel.get_counterparty_node_id(),
1417 msg: $channel_ready_msg,
1419 // Note that we may send a `channel_ready` multiple times for a channel if we reconnect, so
1420 // we allow collisions, but we shouldn't ever be updating the channel ID pointed to.
1421 let outbound_alias_insert = $short_to_id.insert($channel.outbound_scid_alias(), $channel.channel_id());
1422 assert!(outbound_alias_insert.is_none() || outbound_alias_insert.unwrap() == $channel.channel_id(),
1423 "SCIDs should never collide - ensure you weren't behind the chain tip by a full month when creating channels");
1424 if let Some(real_scid) = $channel.get_short_channel_id() {
1425 let scid_insert = $short_to_id.insert(real_scid, $channel.channel_id());
1426 assert!(scid_insert.is_none() || scid_insert.unwrap() == $channel.channel_id(),
1427 "SCIDs should never collide - ensure you weren't behind the chain tip by a full month when creating channels");
1432 macro_rules! handle_chan_restoration_locked {
1433 ($self: ident, $channel_lock: expr, $channel_state: expr, $channel_entry: expr,
1434 $raa: expr, $commitment_update: expr, $order: expr, $chanmon_update: expr,
1435 $pending_forwards: expr, $funding_broadcastable: expr, $channel_ready: expr, $announcement_sigs: expr) => { {
1436 let mut htlc_forwards = None;
1438 let chanmon_update: Option<ChannelMonitorUpdate> = $chanmon_update; // Force type-checking to resolve
1439 let chanmon_update_is_none = chanmon_update.is_none();
1440 let counterparty_node_id = $channel_entry.get().get_counterparty_node_id();
1442 let forwards: Vec<(PendingHTLCInfo, u64)> = $pending_forwards; // Force type-checking to resolve
1443 if !forwards.is_empty() {
1444 htlc_forwards = Some(($channel_entry.get().get_short_channel_id().unwrap_or($channel_entry.get().outbound_scid_alias()),
1445 $channel_entry.get().get_funding_txo().unwrap(), forwards));
1448 if chanmon_update.is_some() {
1449 // On reconnect, we, by definition, only resend a channel_ready if there have been
1450 // no commitment updates, so the only channel monitor update which could also be
1451 // associated with a channel_ready would be the funding_created/funding_signed
1452 // monitor update. That monitor update failing implies that we won't send
1453 // channel_ready until it's been updated, so we can't have a channel_ready and a
1454 // monitor update here (so we don't bother to handle it correctly below).
1455 assert!($channel_ready.is_none());
1456 // A channel monitor update makes no sense without either a channel_ready or a
1457 // commitment update to process after it. Since we can't have a channel_ready, we
1458 // only bother to handle the monitor-update + commitment_update case below.
1459 assert!($commitment_update.is_some());
1462 if let Some(msg) = $channel_ready {
1463 // Similar to the above, this implies that we're letting the channel_ready fly
1464 // before it should be allowed to.
1465 assert!(chanmon_update.is_none());
1466 send_channel_ready!($channel_state.short_to_id, $channel_state.pending_msg_events, $channel_entry.get(), msg);
1468 if let Some(msg) = $announcement_sigs {
1469 $channel_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
1470 node_id: counterparty_node_id,
1475 let funding_broadcastable: Option<Transaction> = $funding_broadcastable; // Force type-checking to resolve
1476 if let Some(monitor_update) = chanmon_update {
1477 // We only ever broadcast a funding transaction in response to a funding_signed
1478 // message and the resulting monitor update. Thus, on channel_reestablish
1479 // message handling we can't have a funding transaction to broadcast. When
1480 // processing a monitor update finishing resulting in a funding broadcast, we
1481 // cannot have a second monitor update, thus this case would indicate a bug.
1482 assert!(funding_broadcastable.is_none());
1483 // Given we were just reconnected or finished updating a channel monitor, the
1484 // only case where we can get a new ChannelMonitorUpdate would be if we also
1485 // have some commitment updates to send as well.
1486 assert!($commitment_update.is_some());
1487 if let Err(e) = $self.chain_monitor.update_channel($channel_entry.get().get_funding_txo().unwrap(), monitor_update) {
1488 // channel_reestablish doesn't guarantee the order it returns is sensical
1489 // for the messages it returns, but if we're setting what messages to
1490 // re-transmit on monitor update success, we need to make sure it is sane.
1491 let mut order = $order;
1493 order = RAACommitmentOrder::CommitmentFirst;
1495 break handle_monitor_err!($self, e, $channel_state, $channel_entry, order, $raa.is_some(), true);
1499 macro_rules! handle_cs { () => {
1500 if let Some(update) = $commitment_update {
1501 $channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1502 node_id: counterparty_node_id,
1507 macro_rules! handle_raa { () => {
1508 if let Some(revoke_and_ack) = $raa {
1509 $channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
1510 node_id: counterparty_node_id,
1511 msg: revoke_and_ack,
1516 RAACommitmentOrder::CommitmentFirst => {
1520 RAACommitmentOrder::RevokeAndACKFirst => {
1525 if let Some(tx) = funding_broadcastable {
1526 log_info!($self.logger, "Broadcasting funding transaction with txid {}", tx.txid());
1527 $self.tx_broadcaster.broadcast_transaction(&tx);
1532 if chanmon_update_is_none {
1533 // If there was no ChannelMonitorUpdate, we should never generate an Err in the res loop
1534 // above. Doing so would imply calling handle_err!() from channel_monitor_updated() which
1535 // should *never* end up calling back to `chain_monitor.update_channel()`.
1536 assert!(res.is_ok());
1539 (htlc_forwards, res, counterparty_node_id)
1543 macro_rules! post_handle_chan_restoration {
1544 ($self: ident, $locked_res: expr) => { {
1545 let (htlc_forwards, res, counterparty_node_id) = $locked_res;
1547 let _ = handle_error!($self, res, counterparty_node_id);
1549 if let Some(forwards) = htlc_forwards {
1550 $self.forward_htlcs(&mut [forwards][..]);
1555 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<Signer, M, T, K, F, L>
1556 where M::Target: chain::Watch<Signer>,
1557 T::Target: BroadcasterInterface,
1558 K::Target: KeysInterface<Signer = Signer>,
1559 F::Target: FeeEstimator,
1562 /// Constructs a new ChannelManager to hold several channels and route between them.
1564 /// This is the main "logic hub" for all channel-related actions, and implements
1565 /// ChannelMessageHandler.
1567 /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
1569 /// Users need to notify the new ChannelManager when a new block is connected or
1570 /// disconnected using its `block_connected` and `block_disconnected` methods, starting
1571 /// from after `params.latest_hash`.
1572 pub fn new(fee_est: F, chain_monitor: M, tx_broadcaster: T, logger: L, keys_manager: K, config: UserConfig, params: ChainParameters) -> Self {
1573 let mut secp_ctx = Secp256k1::new();
1574 secp_ctx.seeded_randomize(&keys_manager.get_secure_random_bytes());
1575 let inbound_pmt_key_material = keys_manager.get_inbound_payment_key_material();
1576 let expanded_inbound_key = inbound_payment::ExpandedKey::new(&inbound_pmt_key_material);
1578 default_configuration: config.clone(),
1579 genesis_hash: genesis_block(params.network).header.block_hash(),
1580 fee_estimator: fee_est,
1584 best_block: RwLock::new(params.best_block),
1586 channel_state: Mutex::new(ChannelHolder{
1587 by_id: HashMap::new(),
1588 short_to_id: HashMap::new(),
1589 forward_htlcs: HashMap::new(),
1590 claimable_htlcs: HashMap::new(),
1591 pending_msg_events: Vec::new(),
1593 outbound_scid_aliases: Mutex::new(HashSet::new()),
1594 pending_inbound_payments: Mutex::new(HashMap::new()),
1595 pending_outbound_payments: Mutex::new(HashMap::new()),
1597 our_network_key: keys_manager.get_node_secret(Recipient::Node).unwrap(),
1598 our_network_pubkey: PublicKey::from_secret_key(&secp_ctx, &keys_manager.get_node_secret(Recipient::Node).unwrap()),
1601 inbound_payment_key: expanded_inbound_key,
1602 fake_scid_rand_bytes: keys_manager.get_secure_random_bytes(),
1604 last_node_announcement_serial: AtomicUsize::new(0),
1605 highest_seen_timestamp: AtomicUsize::new(0),
1607 per_peer_state: RwLock::new(HashMap::new()),
1609 pending_events: Mutex::new(Vec::new()),
1610 pending_background_events: Mutex::new(Vec::new()),
1611 total_consistency_lock: RwLock::new(()),
1612 persistence_notifier: PersistenceNotifier::new(),
1620 /// Gets the current configuration applied to all new channels, as
1621 pub fn get_current_default_configuration(&self) -> &UserConfig {
1622 &self.default_configuration
1625 fn create_and_insert_outbound_scid_alias(&self) -> u64 {
1626 let height = self.best_block.read().unwrap().height();
1627 let mut outbound_scid_alias = 0;
1630 if cfg!(fuzzing) { // fuzzing chacha20 doesn't use the key at all so we always get the same alias
1631 outbound_scid_alias += 1;
1633 outbound_scid_alias = fake_scid::Namespace::OutboundAlias.get_fake_scid(height, &self.genesis_hash, &self.fake_scid_rand_bytes, &self.keys_manager);
1635 if outbound_scid_alias != 0 && self.outbound_scid_aliases.lock().unwrap().insert(outbound_scid_alias) {
1639 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"); }
1644 /// Creates a new outbound channel to the given remote node and with the given value.
1646 /// `user_channel_id` will be provided back as in
1647 /// [`Event::FundingGenerationReady::user_channel_id`] to allow tracking of which events
1648 /// correspond with which `create_channel` call. Note that the `user_channel_id` defaults to 0
1649 /// for inbound channels, so you may wish to avoid using 0 for `user_channel_id` here.
1650 /// `user_channel_id` has no meaning inside of LDK, it is simply copied to events and otherwise
1653 /// Raises [`APIError::APIMisuseError`] when `channel_value_satoshis` > 2**24 or `push_msat` is
1654 /// greater than `channel_value_satoshis * 1k` or `channel_value_satoshis < 1000`.
1656 /// Note that we do not check if you are currently connected to the given peer. If no
1657 /// connection is available, the outbound `open_channel` message may fail to send, resulting in
1658 /// the channel eventually being silently forgotten (dropped on reload).
1660 /// Returns the new Channel's temporary `channel_id`. This ID will appear as
1661 /// [`Event::FundingGenerationReady::temporary_channel_id`] and in
1662 /// [`ChannelDetails::channel_id`] until after
1663 /// [`ChannelManager::funding_transaction_generated`] is called, swapping the Channel's ID for
1664 /// one derived from the funding transaction's TXID. If the counterparty rejects the channel
1665 /// immediately, this temporary ID will appear in [`Event::ChannelClosed::channel_id`].
1667 /// [`Event::FundingGenerationReady::user_channel_id`]: events::Event::FundingGenerationReady::user_channel_id
1668 /// [`Event::FundingGenerationReady::temporary_channel_id`]: events::Event::FundingGenerationReady::temporary_channel_id
1669 /// [`Event::ChannelClosed::channel_id`]: events::Event::ChannelClosed::channel_id
1670 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> {
1671 if channel_value_satoshis < 1000 {
1672 return Err(APIError::APIMisuseError { err: format!("Channel value must be at least 1000 satoshis. It was {}", channel_value_satoshis) });
1676 let per_peer_state = self.per_peer_state.read().unwrap();
1677 match per_peer_state.get(&their_network_key) {
1678 Some(peer_state) => {
1679 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
1680 let peer_state = peer_state.lock().unwrap();
1681 let their_features = &peer_state.latest_features;
1682 let config = if override_config.is_some() { override_config.as_ref().unwrap() } else { &self.default_configuration };
1683 match Channel::new_outbound(&self.fee_estimator, &self.keys_manager, their_network_key,
1684 their_features, channel_value_satoshis, push_msat, user_channel_id, config,
1685 self.best_block.read().unwrap().height(), outbound_scid_alias)
1689 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
1694 None => return Err(APIError::ChannelUnavailable { err: format!("Not connected to node: {}", their_network_key) }),
1697 let res = channel.get_open_channel(self.genesis_hash.clone());
1699 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1700 // We want to make sure the lock is actually acquired by PersistenceNotifierGuard.
1701 debug_assert!(&self.total_consistency_lock.try_write().is_err());
1703 let temporary_channel_id = channel.channel_id();
1704 let mut channel_state = self.channel_state.lock().unwrap();
1705 match channel_state.by_id.entry(temporary_channel_id) {
1706 hash_map::Entry::Occupied(_) => {
1708 return Err(APIError::APIMisuseError { err: "Fuzzy bad RNG".to_owned() });
1710 panic!("RNG is bad???");
1713 hash_map::Entry::Vacant(entry) => { entry.insert(channel); }
1715 channel_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
1716 node_id: their_network_key,
1719 Ok(temporary_channel_id)
1722 fn list_channels_with_filter<Fn: FnMut(&(&[u8; 32], &Channel<Signer>)) -> bool>(&self, f: Fn) -> Vec<ChannelDetails> {
1723 let mut res = Vec::new();
1725 let channel_state = self.channel_state.lock().unwrap();
1726 res.reserve(channel_state.by_id.len());
1727 for (channel_id, channel) in channel_state.by_id.iter().filter(f) {
1728 let balance = channel.get_available_balances();
1729 let (to_remote_reserve_satoshis, to_self_reserve_satoshis) =
1730 channel.get_holder_counterparty_selected_channel_reserve_satoshis();
1731 res.push(ChannelDetails {
1732 channel_id: (*channel_id).clone(),
1733 counterparty: ChannelCounterparty {
1734 node_id: channel.get_counterparty_node_id(),
1735 features: InitFeatures::empty(),
1736 unspendable_punishment_reserve: to_remote_reserve_satoshis,
1737 forwarding_info: channel.counterparty_forwarding_info(),
1738 // Ensures that we have actually received the `htlc_minimum_msat` value
1739 // from the counterparty through the `OpenChannel` or `AcceptChannel`
1740 // message (as they are always the first message from the counterparty).
1741 // Else `Channel::get_counterparty_htlc_minimum_msat` could return the
1742 // default `0` value set by `Channel::new_outbound`.
1743 outbound_htlc_minimum_msat: if channel.have_received_message() {
1744 Some(channel.get_counterparty_htlc_minimum_msat()) } else { None },
1745 outbound_htlc_maximum_msat: channel.get_counterparty_htlc_maximum_msat(),
1747 funding_txo: channel.get_funding_txo(),
1748 // Note that accept_channel (or open_channel) is always the first message, so
1749 // `have_received_message` indicates that type negotiation has completed.
1750 channel_type: if channel.have_received_message() { Some(channel.get_channel_type().clone()) } else { None },
1751 short_channel_id: channel.get_short_channel_id(),
1752 outbound_scid_alias: if channel.is_usable() { Some(channel.outbound_scid_alias()) } else { None },
1753 inbound_scid_alias: channel.latest_inbound_scid_alias(),
1754 channel_value_satoshis: channel.get_value_satoshis(),
1755 unspendable_punishment_reserve: to_self_reserve_satoshis,
1756 balance_msat: balance.balance_msat,
1757 inbound_capacity_msat: balance.inbound_capacity_msat,
1758 outbound_capacity_msat: balance.outbound_capacity_msat,
1759 next_outbound_htlc_limit_msat: balance.next_outbound_htlc_limit_msat,
1760 user_channel_id: channel.get_user_id(),
1761 confirmations_required: channel.minimum_depth(),
1762 force_close_spend_delay: channel.get_counterparty_selected_contest_delay(),
1763 is_outbound: channel.is_outbound(),
1764 is_channel_ready: channel.is_usable(),
1765 is_usable: channel.is_live(),
1766 is_public: channel.should_announce(),
1767 inbound_htlc_minimum_msat: Some(channel.get_holder_htlc_minimum_msat()),
1768 inbound_htlc_maximum_msat: channel.get_holder_htlc_maximum_msat()
1772 let per_peer_state = self.per_peer_state.read().unwrap();
1773 for chan in res.iter_mut() {
1774 if let Some(peer_state) = per_peer_state.get(&chan.counterparty.node_id) {
1775 chan.counterparty.features = peer_state.lock().unwrap().latest_features.clone();
1781 /// Gets the list of open channels, in random order. See ChannelDetail field documentation for
1782 /// more information.
1783 pub fn list_channels(&self) -> Vec<ChannelDetails> {
1784 self.list_channels_with_filter(|_| true)
1787 /// Gets the list of usable channels, in random order. Useful as an argument to [`find_route`]
1788 /// to ensure non-announced channels are used.
1790 /// These are guaranteed to have their [`ChannelDetails::is_usable`] value set to true, see the
1791 /// documentation for [`ChannelDetails::is_usable`] for more info on exactly what the criteria
1794 /// [`find_route`]: crate::routing::router::find_route
1795 pub fn list_usable_channels(&self) -> Vec<ChannelDetails> {
1796 // Note we use is_live here instead of usable which leads to somewhat confused
1797 // internal/external nomenclature, but that's ok cause that's probably what the user
1798 // really wanted anyway.
1799 self.list_channels_with_filter(|&(_, ref channel)| channel.is_live())
1802 /// Helper function that issues the channel close events
1803 fn issue_channel_close_events(&self, channel: &Channel<Signer>, closure_reason: ClosureReason) {
1804 let mut pending_events_lock = self.pending_events.lock().unwrap();
1805 match channel.unbroadcasted_funding() {
1806 Some(transaction) => {
1807 pending_events_lock.push(events::Event::DiscardFunding { channel_id: channel.channel_id(), transaction })
1811 pending_events_lock.push(events::Event::ChannelClosed {
1812 channel_id: channel.channel_id(),
1813 user_channel_id: channel.get_user_id(),
1814 reason: closure_reason
1818 fn close_channel_internal(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey, target_feerate_sats_per_1000_weight: Option<u32>) -> Result<(), APIError> {
1819 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1821 let mut failed_htlcs: Vec<(HTLCSource, PaymentHash)>;
1822 let result: Result<(), _> = loop {
1823 let mut channel_state_lock = self.channel_state.lock().unwrap();
1824 let channel_state = &mut *channel_state_lock;
1825 match channel_state.by_id.entry(channel_id.clone()) {
1826 hash_map::Entry::Occupied(mut chan_entry) => {
1827 if *counterparty_node_id != chan_entry.get().get_counterparty_node_id(){
1828 return Err(APIError::APIMisuseError { err: "The passed counterparty_node_id doesn't match the channel's counterparty node_id".to_owned() });
1830 let per_peer_state = self.per_peer_state.read().unwrap();
1831 let (shutdown_msg, monitor_update, htlcs) = match per_peer_state.get(&counterparty_node_id) {
1832 Some(peer_state) => {
1833 let peer_state = peer_state.lock().unwrap();
1834 let their_features = &peer_state.latest_features;
1835 chan_entry.get_mut().get_shutdown(&self.keys_manager, their_features, target_feerate_sats_per_1000_weight)?
1837 None => return Err(APIError::ChannelUnavailable { err: format!("Not connected to node: {}", counterparty_node_id) }),
1839 failed_htlcs = htlcs;
1841 // Update the monitor with the shutdown script if necessary.
1842 if let Some(monitor_update) = monitor_update {
1843 if let Err(e) = self.chain_monitor.update_channel(chan_entry.get().get_funding_txo().unwrap(), monitor_update) {
1844 let (result, is_permanent) =
1845 handle_monitor_err!(self, e, channel_state.short_to_id, chan_entry.get_mut(), RAACommitmentOrder::CommitmentFirst, chan_entry.key(), NO_UPDATE);
1847 remove_channel!(self, channel_state, chan_entry);
1853 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
1854 node_id: *counterparty_node_id,
1858 if chan_entry.get().is_shutdown() {
1859 let channel = remove_channel!(self, channel_state, chan_entry);
1860 if let Ok(channel_update) = self.get_channel_update_for_broadcast(&channel) {
1861 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1865 self.issue_channel_close_events(&channel, ClosureReason::HolderForceClosed);
1869 hash_map::Entry::Vacant(_) => return Err(APIError::ChannelUnavailable{err: "No such channel".to_owned()})
1873 for htlc_source in failed_htlcs.drain(..) {
1874 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() });
1877 let _ = handle_error!(self, result, *counterparty_node_id);
1881 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
1882 /// will be accepted on the given channel, and after additional timeout/the closing of all
1883 /// pending HTLCs, the channel will be closed on chain.
1885 /// * If we are the channel initiator, we will pay between our [`Background`] and
1886 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
1888 /// * If our counterparty is the channel initiator, we will require a channel closing
1889 /// transaction feerate of at least our [`Background`] feerate or the feerate which
1890 /// would appear on a force-closure transaction, whichever is lower. We will allow our
1891 /// counterparty to pay as much fee as they'd like, however.
1893 /// May generate a SendShutdown message event on success, which should be relayed.
1895 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
1896 /// [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
1897 /// [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
1898 pub fn close_channel(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey) -> Result<(), APIError> {
1899 self.close_channel_internal(channel_id, counterparty_node_id, None)
1902 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
1903 /// will be accepted on the given channel, and after additional timeout/the closing of all
1904 /// pending HTLCs, the channel will be closed on chain.
1906 /// `target_feerate_sat_per_1000_weight` has different meanings depending on if we initiated
1907 /// the channel being closed or not:
1908 /// * If we are the channel initiator, we will pay at least this feerate on the closing
1909 /// transaction. The upper-bound is set by
1910 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
1911 /// estimate (or `target_feerate_sat_per_1000_weight`, if it is greater).
1912 /// * If our counterparty is the channel initiator, we will refuse to accept a channel closure
1913 /// transaction feerate below `target_feerate_sat_per_1000_weight` (or the feerate which
1914 /// will appear on a force-closure transaction, whichever is lower).
1916 /// May generate a SendShutdown message event on success, which should be relayed.
1918 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
1919 /// [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
1920 /// [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
1921 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> {
1922 self.close_channel_internal(channel_id, counterparty_node_id, Some(target_feerate_sats_per_1000_weight))
1926 fn finish_force_close_channel(&self, shutdown_res: ShutdownResult) {
1927 let (monitor_update_option, mut failed_htlcs) = shutdown_res;
1928 log_debug!(self.logger, "Finishing force-closure of channel with {} HTLCs to fail", failed_htlcs.len());
1929 for htlc_source in failed_htlcs.drain(..) {
1930 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() });
1932 if let Some((funding_txo, monitor_update)) = monitor_update_option {
1933 // There isn't anything we can do if we get an update failure - we're already
1934 // force-closing. The monitor update on the required in-memory copy should broadcast
1935 // the latest local state, which is the best we can do anyway. Thus, it is safe to
1936 // ignore the result here.
1937 let _ = self.chain_monitor.update_channel(funding_txo, monitor_update);
1941 /// `peer_msg` should be set when we receive a message from a peer, but not set when the
1942 /// user closes, which will be re-exposed as the `ChannelClosed` reason.
1943 fn force_close_channel_with_peer(&self, channel_id: &[u8; 32], peer_node_id: &PublicKey, peer_msg: Option<&String>) -> Result<PublicKey, APIError> {
1945 let mut channel_state_lock = self.channel_state.lock().unwrap();
1946 let channel_state = &mut *channel_state_lock;
1947 if let hash_map::Entry::Occupied(chan) = channel_state.by_id.entry(channel_id.clone()) {
1948 if chan.get().get_counterparty_node_id() != *peer_node_id {
1949 return Err(APIError::ChannelUnavailable{err: "No such channel".to_owned()});
1951 if let Some(peer_msg) = peer_msg {
1952 self.issue_channel_close_events(chan.get(),ClosureReason::CounterpartyForceClosed { peer_msg: peer_msg.to_string() });
1954 self.issue_channel_close_events(chan.get(),ClosureReason::HolderForceClosed);
1956 remove_channel!(self, channel_state, chan)
1958 return Err(APIError::ChannelUnavailable{err: "No such channel".to_owned()});
1961 log_error!(self.logger, "Force-closing channel {}", log_bytes!(channel_id[..]));
1962 self.finish_force_close_channel(chan.force_shutdown(true));
1963 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
1964 let mut channel_state = self.channel_state.lock().unwrap();
1965 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1970 Ok(chan.get_counterparty_node_id())
1973 /// Force closes a channel, immediately broadcasting the latest local commitment transaction to
1974 /// the chain and rejecting new HTLCs on the given channel. Fails if `channel_id` is unknown to
1975 /// the manager, or if the `counterparty_node_id` isn't the counterparty of the corresponding
1977 pub fn force_close_channel(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey) -> Result<(), APIError> {
1978 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1979 match self.force_close_channel_with_peer(channel_id, counterparty_node_id, None) {
1980 Ok(counterparty_node_id) => {
1981 self.channel_state.lock().unwrap().pending_msg_events.push(
1982 events::MessageSendEvent::HandleError {
1983 node_id: counterparty_node_id,
1984 action: msgs::ErrorAction::SendErrorMessage {
1985 msg: msgs::ErrorMessage { channel_id: *channel_id, data: "Channel force-closed".to_owned() }
1995 /// Force close all channels, immediately broadcasting the latest local commitment transaction
1996 /// for each to the chain and rejecting new HTLCs on each.
1997 pub fn force_close_all_channels(&self) {
1998 for chan in self.list_channels() {
1999 let _ = self.force_close_channel(&chan.channel_id, &chan.counterparty.node_id);
2003 fn construct_recv_pending_htlc_info(&self, hop_data: msgs::OnionHopData, shared_secret: [u8; 32],
2004 payment_hash: PaymentHash, amt_msat: u64, cltv_expiry: u32, phantom_shared_secret: Option<[u8; 32]>) -> Result<PendingHTLCInfo, ReceiveError>
2006 // final_incorrect_cltv_expiry
2007 if hop_data.outgoing_cltv_value != cltv_expiry {
2008 return Err(ReceiveError {
2009 msg: "Upstream node set CLTV to the wrong value",
2011 err_data: byte_utils::be32_to_array(cltv_expiry).to_vec()
2014 // final_expiry_too_soon
2015 // We have to have some headroom to broadcast on chain if we have the preimage, so make sure
2016 // we have at least HTLC_FAIL_BACK_BUFFER blocks to go.
2017 // Also, ensure that, in the case of an unknown preimage for the received payment hash, our
2018 // payment logic has enough time to fail the HTLC backward before our onchain logic triggers a
2019 // channel closure (see HTLC_FAIL_BACK_BUFFER rationale).
2020 if (hop_data.outgoing_cltv_value as u64) <= self.best_block.read().unwrap().height() as u64 + HTLC_FAIL_BACK_BUFFER as u64 + 1 {
2021 return Err(ReceiveError {
2023 err_data: Vec::new(),
2024 msg: "The final CLTV expiry is too soon to handle",
2027 if hop_data.amt_to_forward > amt_msat {
2028 return Err(ReceiveError {
2030 err_data: byte_utils::be64_to_array(amt_msat).to_vec(),
2031 msg: "Upstream node sent less than we were supposed to receive in payment",
2035 let routing = match hop_data.format {
2036 msgs::OnionHopDataFormat::Legacy { .. } => {
2037 return Err(ReceiveError {
2038 err_code: 0x4000|0x2000|3,
2039 err_data: Vec::new(),
2040 msg: "We require payment_secrets",
2043 msgs::OnionHopDataFormat::NonFinalNode { .. } => {
2044 return Err(ReceiveError {
2045 err_code: 0x4000|22,
2046 err_data: Vec::new(),
2047 msg: "Got non final data with an HMAC of 0",
2050 msgs::OnionHopDataFormat::FinalNode { payment_data, keysend_preimage } => {
2051 if payment_data.is_some() && keysend_preimage.is_some() {
2052 return Err(ReceiveError {
2053 err_code: 0x4000|22,
2054 err_data: Vec::new(),
2055 msg: "We don't support MPP keysend payments",
2057 } else if let Some(data) = payment_data {
2058 PendingHTLCRouting::Receive {
2060 incoming_cltv_expiry: hop_data.outgoing_cltv_value,
2061 phantom_shared_secret,
2063 } else if let Some(payment_preimage) = keysend_preimage {
2064 // We need to check that the sender knows the keysend preimage before processing this
2065 // payment further. Otherwise, an intermediary routing hop forwarding non-keysend-HTLC X
2066 // could discover the final destination of X, by probing the adjacent nodes on the route
2067 // with a keysend payment of identical payment hash to X and observing the processing
2068 // time discrepancies due to a hash collision with X.
2069 let hashed_preimage = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
2070 if hashed_preimage != payment_hash {
2071 return Err(ReceiveError {
2072 err_code: 0x4000|22,
2073 err_data: Vec::new(),
2074 msg: "Payment preimage didn't match payment hash",
2078 PendingHTLCRouting::ReceiveKeysend {
2080 incoming_cltv_expiry: hop_data.outgoing_cltv_value,
2083 return Err(ReceiveError {
2084 err_code: 0x4000|0x2000|3,
2085 err_data: Vec::new(),
2086 msg: "We require payment_secrets",
2091 Ok(PendingHTLCInfo {
2094 incoming_shared_secret: shared_secret,
2095 amt_to_forward: amt_msat,
2096 outgoing_cltv_value: hop_data.outgoing_cltv_value,
2100 fn decode_update_add_htlc_onion(&self, msg: &msgs::UpdateAddHTLC) -> (PendingHTLCStatus, MutexGuard<ChannelHolder<Signer>>) {
2101 macro_rules! return_malformed_err {
2102 ($msg: expr, $err_code: expr) => {
2104 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
2105 return (PendingHTLCStatus::Fail(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
2106 channel_id: msg.channel_id,
2107 htlc_id: msg.htlc_id,
2108 sha256_of_onion: Sha256::hash(&msg.onion_routing_packet.hop_data).into_inner(),
2109 failure_code: $err_code,
2110 })), self.channel_state.lock().unwrap());
2115 if let Err(_) = msg.onion_routing_packet.public_key {
2116 return_malformed_err!("invalid ephemeral pubkey", 0x8000 | 0x4000 | 6);
2119 let shared_secret = SharedSecret::new(&msg.onion_routing_packet.public_key.unwrap(), &self.our_network_key).secret_bytes();
2121 if msg.onion_routing_packet.version != 0 {
2122 //TODO: Spec doesn't indicate if we should only hash hop_data here (and in other
2123 //sha256_of_onion error data packets), or the entire onion_routing_packet. Either way,
2124 //the hash doesn't really serve any purpose - in the case of hashing all data, the
2125 //receiving node would have to brute force to figure out which version was put in the
2126 //packet by the node that send us the message, in the case of hashing the hop_data, the
2127 //node knows the HMAC matched, so they already know what is there...
2128 return_malformed_err!("Unknown onion packet version", 0x8000 | 0x4000 | 4);
2131 let mut channel_state = None;
2132 macro_rules! return_err {
2133 ($msg: expr, $err_code: expr, $data: expr) => {
2135 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
2136 if channel_state.is_none() {
2137 channel_state = Some(self.channel_state.lock().unwrap());
2139 return (PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
2140 channel_id: msg.channel_id,
2141 htlc_id: msg.htlc_id,
2142 reason: onion_utils::build_first_hop_failure_packet(&shared_secret, $err_code, $data),
2143 })), channel_state.unwrap());
2148 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) {
2150 Err(onion_utils::OnionDecodeErr::Malformed { err_msg, err_code }) => {
2151 return_malformed_err!(err_msg, err_code);
2153 Err(onion_utils::OnionDecodeErr::Relay { err_msg, err_code }) => {
2154 return_err!(err_msg, err_code, &[0; 0]);
2158 let pending_forward_info = match next_hop {
2159 onion_utils::Hop::Receive(next_hop_data) => {
2161 match self.construct_recv_pending_htlc_info(next_hop_data, shared_secret, msg.payment_hash, msg.amount_msat, msg.cltv_expiry, None) {
2163 // Note that we could obviously respond immediately with an update_fulfill_htlc
2164 // message, however that would leak that we are the recipient of this payment, so
2165 // instead we stay symmetric with the forwarding case, only responding (after a
2166 // delay) once they've send us a commitment_signed!
2167 PendingHTLCStatus::Forward(info)
2169 Err(ReceiveError { err_code, err_data, msg }) => return_err!(msg, err_code, &err_data)
2172 onion_utils::Hop::Forward { next_hop_data, next_hop_hmac, new_packet_bytes } => {
2173 let mut new_pubkey = msg.onion_routing_packet.public_key.unwrap();
2175 let blinding_factor = {
2176 let mut sha = Sha256::engine();
2177 sha.input(&new_pubkey.serialize()[..]);
2178 sha.input(&shared_secret);
2179 Sha256::from_engine(sha).into_inner()
2182 let public_key = if let Err(e) = new_pubkey.mul_assign(&self.secp_ctx, &blinding_factor[..]) {
2184 } else { Ok(new_pubkey) };
2186 let outgoing_packet = msgs::OnionPacket {
2189 hop_data: new_packet_bytes,
2190 hmac: next_hop_hmac.clone(),
2193 let short_channel_id = match next_hop_data.format {
2194 msgs::OnionHopDataFormat::Legacy { short_channel_id } => short_channel_id,
2195 msgs::OnionHopDataFormat::NonFinalNode { short_channel_id } => short_channel_id,
2196 msgs::OnionHopDataFormat::FinalNode { .. } => {
2197 return_err!("Final Node OnionHopData provided for us as an intermediary node", 0x4000 | 22, &[0;0]);
2201 PendingHTLCStatus::Forward(PendingHTLCInfo {
2202 routing: PendingHTLCRouting::Forward {
2203 onion_packet: outgoing_packet,
2206 payment_hash: msg.payment_hash.clone(),
2207 incoming_shared_secret: shared_secret,
2208 amt_to_forward: next_hop_data.amt_to_forward,
2209 outgoing_cltv_value: next_hop_data.outgoing_cltv_value,
2214 channel_state = Some(self.channel_state.lock().unwrap());
2215 if let &PendingHTLCStatus::Forward(PendingHTLCInfo { ref routing, ref amt_to_forward, ref outgoing_cltv_value, .. }) = &pending_forward_info {
2216 // If short_channel_id is 0 here, we'll reject the HTLC as there cannot be a channel
2217 // with a short_channel_id of 0. This is important as various things later assume
2218 // short_channel_id is non-0 in any ::Forward.
2219 if let &PendingHTLCRouting::Forward { ref short_channel_id, .. } = routing {
2220 let id_option = channel_state.as_ref().unwrap().short_to_id.get(&short_channel_id).cloned();
2221 if let Some((err, code, chan_update)) = loop {
2222 let forwarding_id_opt = match id_option {
2223 None => { // unknown_next_peer
2224 // Note that this is likely a timing oracle for detecting whether an scid is a
2226 if fake_scid::is_valid_phantom(&self.fake_scid_rand_bytes, *short_channel_id) {
2229 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
2232 Some(id) => Some(id.clone()),
2234 let (chan_update_opt, forwardee_cltv_expiry_delta) = if let Some(forwarding_id) = forwarding_id_opt {
2235 let chan = channel_state.as_mut().unwrap().by_id.get_mut(&forwarding_id).unwrap();
2236 if !chan.should_announce() && !self.default_configuration.accept_forwards_to_priv_channels {
2237 // Note that the behavior here should be identical to the above block - we
2238 // should NOT reveal the existence or non-existence of a private channel if
2239 // we don't allow forwards outbound over them.
2240 break Some(("Refusing to forward to a private channel based on our config.", 0x4000 | 10, None));
2242 if chan.get_channel_type().supports_scid_privacy() && *short_channel_id != chan.outbound_scid_alias() {
2243 // `option_scid_alias` (referred to in LDK as `scid_privacy`) means
2244 // "refuse to forward unless the SCID alias was used", so we pretend
2245 // we don't have the channel here.
2246 break Some(("Refusing to forward over real channel SCID as our counterparty requested.", 0x4000 | 10, None));
2248 let chan_update_opt = self.get_channel_update_for_onion(*short_channel_id, chan).ok();
2250 // Note that we could technically not return an error yet here and just hope
2251 // that the connection is reestablished or monitor updated by the time we get
2252 // around to doing the actual forward, but better to fail early if we can and
2253 // hopefully an attacker trying to path-trace payments cannot make this occur
2254 // on a small/per-node/per-channel scale.
2255 if !chan.is_live() { // channel_disabled
2256 break Some(("Forwarding channel is not in a ready state.", 0x1000 | 20, chan_update_opt));
2258 if *amt_to_forward < chan.get_counterparty_htlc_minimum_msat() { // amount_below_minimum
2259 break Some(("HTLC amount was below the htlc_minimum_msat", 0x1000 | 11, chan_update_opt));
2261 let fee = amt_to_forward.checked_mul(chan.get_fee_proportional_millionths() as u64)
2262 .and_then(|prop_fee| { (prop_fee / 1000000)
2263 .checked_add(chan.get_outbound_forwarding_fee_base_msat() as u64) });
2264 if fee.is_none() || msg.amount_msat < fee.unwrap() || (msg.amount_msat - fee.unwrap()) < *amt_to_forward { // fee_insufficient
2265 break Some(("Prior hop has deviated from specified fees parameters or origin node has obsolete ones", 0x1000 | 12, chan_update_opt));
2267 (chan_update_opt, chan.get_cltv_expiry_delta())
2268 } else { (None, MIN_CLTV_EXPIRY_DELTA) };
2270 if (msg.cltv_expiry as u64) < (*outgoing_cltv_value) as u64 + forwardee_cltv_expiry_delta as u64 { // incorrect_cltv_expiry
2271 break Some(("Forwarding node has tampered with the intended HTLC values or origin node has an obsolete cltv_expiry_delta", 0x1000 | 13, chan_update_opt));
2273 let cur_height = self.best_block.read().unwrap().height() + 1;
2274 // Theoretically, channel counterparty shouldn't send us a HTLC expiring now,
2275 // but we want to be robust wrt to counterparty packet sanitization (see
2276 // HTLC_FAIL_BACK_BUFFER rationale).
2277 if msg.cltv_expiry <= cur_height + HTLC_FAIL_BACK_BUFFER as u32 { // expiry_too_soon
2278 break Some(("CLTV expiry is too close", 0x1000 | 14, chan_update_opt));
2280 if msg.cltv_expiry > cur_height + CLTV_FAR_FAR_AWAY as u32 { // expiry_too_far
2281 break Some(("CLTV expiry is too far in the future", 21, None));
2283 // If the HTLC expires ~now, don't bother trying to forward it to our
2284 // counterparty. They should fail it anyway, but we don't want to bother with
2285 // the round-trips or risk them deciding they definitely want the HTLC and
2286 // force-closing to ensure they get it if we're offline.
2287 // We previously had a much more aggressive check here which tried to ensure
2288 // our counterparty receives an HTLC which has *our* risk threshold met on it,
2289 // but there is no need to do that, and since we're a bit conservative with our
2290 // risk threshold it just results in failing to forward payments.
2291 if (*outgoing_cltv_value) as u64 <= (cur_height + LATENCY_GRACE_PERIOD_BLOCKS) as u64 {
2292 break Some(("Outgoing CLTV value is too soon", 0x1000 | 14, chan_update_opt));
2298 let mut res = VecWriter(Vec::with_capacity(chan_update.serialized_length() + 2 + 8 + 2));
2299 if let Some(chan_update) = chan_update {
2300 if code == 0x1000 | 11 || code == 0x1000 | 12 {
2301 msg.amount_msat.write(&mut res).expect("Writes cannot fail");
2303 else if code == 0x1000 | 13 {
2304 msg.cltv_expiry.write(&mut res).expect("Writes cannot fail");
2306 else if code == 0x1000 | 20 {
2307 // TODO: underspecified, follow https://github.com/lightning/bolts/issues/791
2308 0u16.write(&mut res).expect("Writes cannot fail");
2310 (chan_update.serialized_length() as u16 + 2).write(&mut res).expect("Writes cannot fail");
2311 msgs::ChannelUpdate::TYPE.write(&mut res).expect("Writes cannot fail");
2312 chan_update.write(&mut res).expect("Writes cannot fail");
2314 return_err!(err, code, &res.0[..]);
2319 (pending_forward_info, channel_state.unwrap())
2322 /// Gets the current channel_update for the given channel. This first checks if the channel is
2323 /// public, and thus should be called whenever the result is going to be passed out in a
2324 /// [`MessageSendEvent::BroadcastChannelUpdate`] event.
2326 /// May be called with channel_state already locked!
2327 fn get_channel_update_for_broadcast(&self, chan: &Channel<Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
2328 if !chan.should_announce() {
2329 return Err(LightningError {
2330 err: "Cannot broadcast a channel_update for a private channel".to_owned(),
2331 action: msgs::ErrorAction::IgnoreError
2334 if chan.get_short_channel_id().is_none() {
2335 return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError});
2337 log_trace!(self.logger, "Attempting to generate broadcast channel update for channel {}", log_bytes!(chan.channel_id()));
2338 self.get_channel_update_for_unicast(chan)
2341 /// Gets the current channel_update for the given channel. This does not check if the channel
2342 /// is public (only returning an Err if the channel does not yet have an assigned short_id),
2343 /// and thus MUST NOT be called unless the recipient of the resulting message has already
2344 /// provided evidence that they know about the existence of the channel.
2345 /// May be called with channel_state already locked!
2346 fn get_channel_update_for_unicast(&self, chan: &Channel<Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
2347 log_trace!(self.logger, "Attempting to generate channel update for channel {}", log_bytes!(chan.channel_id()));
2348 let short_channel_id = match chan.get_short_channel_id().or(chan.latest_inbound_scid_alias()) {
2349 None => return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError}),
2353 self.get_channel_update_for_onion(short_channel_id, chan)
2355 fn get_channel_update_for_onion(&self, short_channel_id: u64, chan: &Channel<Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
2356 log_trace!(self.logger, "Generating channel update for channel {}", log_bytes!(chan.channel_id()));
2357 let were_node_one = PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key).serialize()[..] < chan.get_counterparty_node_id().serialize()[..];
2359 let unsigned = msgs::UnsignedChannelUpdate {
2360 chain_hash: self.genesis_hash,
2362 timestamp: chan.get_update_time_counter(),
2363 flags: (!were_node_one) as u8 | ((!chan.is_live() as u8) << 1),
2364 cltv_expiry_delta: chan.get_cltv_expiry_delta(),
2365 htlc_minimum_msat: chan.get_counterparty_htlc_minimum_msat(),
2366 htlc_maximum_msat: OptionalField::Present(chan.get_announced_htlc_max_msat()),
2367 fee_base_msat: chan.get_outbound_forwarding_fee_base_msat(),
2368 fee_proportional_millionths: chan.get_fee_proportional_millionths(),
2369 excess_data: Vec::new(),
2372 let msg_hash = Sha256dHash::hash(&unsigned.encode()[..]);
2373 let sig = self.secp_ctx.sign_ecdsa(&hash_to_message!(&msg_hash[..]), &self.our_network_key);
2375 Ok(msgs::ChannelUpdate {
2381 // Only public for testing, this should otherwise never be called direcly
2382 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> {
2383 log_trace!(self.logger, "Attempting to send payment for path with next hop {}", path.first().unwrap().short_channel_id);
2384 let prng_seed = self.keys_manager.get_secure_random_bytes();
2385 let session_priv_bytes = self.keys_manager.get_secure_random_bytes();
2386 let session_priv = SecretKey::from_slice(&session_priv_bytes[..]).expect("RNG is busted");
2388 let onion_keys = onion_utils::construct_onion_keys(&self.secp_ctx, &path, &session_priv)
2389 .map_err(|_| APIError::RouteError{err: "Pubkey along hop was maliciously selected"})?;
2390 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(path, total_value, payment_secret, cur_height, keysend_preimage)?;
2391 if onion_utils::route_size_insane(&onion_payloads) {
2392 return Err(APIError::RouteError{err: "Route size too large considering onion data"});
2394 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, prng_seed, payment_hash);
2396 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2398 let err: Result<(), _> = loop {
2399 let mut channel_lock = self.channel_state.lock().unwrap();
2401 let mut pending_outbounds = self.pending_outbound_payments.lock().unwrap();
2402 let payment_entry = pending_outbounds.entry(payment_id);
2403 if let hash_map::Entry::Occupied(payment) = &payment_entry {
2404 if !payment.get().is_retryable() {
2405 return Err(APIError::RouteError {
2406 err: "Payment already completed"
2411 let id = match channel_lock.short_to_id.get(&path.first().unwrap().short_channel_id) {
2412 None => return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()}),
2413 Some(id) => id.clone(),
2416 macro_rules! insert_outbound_payment {
2418 let payment = payment_entry.or_insert_with(|| PendingOutboundPayment::Retryable {
2419 session_privs: HashSet::new(),
2420 pending_amt_msat: 0,
2421 pending_fee_msat: Some(0),
2422 payment_hash: *payment_hash,
2423 payment_secret: *payment_secret,
2424 starting_block_height: self.best_block.read().unwrap().height(),
2425 total_msat: total_value,
2427 assert!(payment.insert(session_priv_bytes, path));
2431 let channel_state = &mut *channel_lock;
2432 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(id) {
2434 if chan.get().get_counterparty_node_id() != path.first().unwrap().pubkey {
2435 return Err(APIError::RouteError{err: "Node ID mismatch on first hop!"});
2437 if !chan.get().is_live() {
2438 return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected/pending monitor update!".to_owned()});
2440 break_chan_entry!(self, chan.get_mut().send_htlc_and_commit(
2441 htlc_msat, payment_hash.clone(), htlc_cltv, HTLCSource::OutboundRoute {
2443 session_priv: session_priv.clone(),
2444 first_hop_htlc_msat: htlc_msat,
2446 payment_secret: payment_secret.clone(),
2447 payment_params: payment_params.clone(),
2448 }, onion_packet, &self.logger),
2449 channel_state, chan)
2451 Some((update_add, commitment_signed, monitor_update)) => {
2452 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
2453 maybe_break_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, true);
2454 // Note that MonitorUpdateFailed here indicates (per function docs)
2455 // that we will resend the commitment update once monitor updating
2456 // is restored. Therefore, we must return an error indicating that
2457 // it is unsafe to retry the payment wholesale, which we do in the
2458 // send_payment check for MonitorUpdateFailed, below.
2459 insert_outbound_payment!(); // Only do this after possibly break'ing on Perm failure above.
2460 return Err(APIError::MonitorUpdateFailed);
2462 insert_outbound_payment!();
2464 log_debug!(self.logger, "Sending payment along path resulted in a commitment_signed for channel {}", log_bytes!(chan.get().channel_id()));
2465 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2466 node_id: path.first().unwrap().pubkey,
2467 updates: msgs::CommitmentUpdate {
2468 update_add_htlcs: vec![update_add],
2469 update_fulfill_htlcs: Vec::new(),
2470 update_fail_htlcs: Vec::new(),
2471 update_fail_malformed_htlcs: Vec::new(),
2477 None => { insert_outbound_payment!(); },
2479 } else { unreachable!(); }
2483 match handle_error!(self, err, path.first().unwrap().pubkey) {
2484 Ok(_) => unreachable!(),
2486 Err(APIError::ChannelUnavailable { err: e.err })
2491 /// Sends a payment along a given route.
2493 /// Value parameters are provided via the last hop in route, see documentation for RouteHop
2494 /// fields for more info.
2496 /// Note that if the payment_hash already exists elsewhere (eg you're sending a duplicative
2497 /// payment), we don't do anything to stop you! We always try to ensure that if the provided
2498 /// next hop knows the preimage to payment_hash they can claim an additional amount as
2499 /// specified in the last hop in the route! Thus, you should probably do your own
2500 /// payment_preimage tracking (which you should already be doing as they represent "proof of
2501 /// payment") and prevent double-sends yourself.
2503 /// May generate SendHTLCs message(s) event on success, which should be relayed.
2505 /// Each path may have a different return value, and PaymentSendValue may return a Vec with
2506 /// each entry matching the corresponding-index entry in the route paths, see
2507 /// PaymentSendFailure for more info.
2509 /// In general, a path may raise:
2510 /// * APIError::RouteError when an invalid route or forwarding parameter (cltv_delta, fee,
2511 /// node public key) is specified.
2512 /// * APIError::ChannelUnavailable if the next-hop channel is not available for updates
2513 /// (including due to previous monitor update failure or new permanent monitor update
2515 /// * APIError::MonitorUpdateFailed if a new monitor update failure prevented sending the
2516 /// relevant updates.
2518 /// Note that depending on the type of the PaymentSendFailure the HTLC may have been
2519 /// irrevocably committed to on our end. In such a case, do NOT retry the payment with a
2520 /// different route unless you intend to pay twice!
2522 /// payment_secret is unrelated to payment_hash (or PaymentPreimage) and exists to authenticate
2523 /// the sender to the recipient and prevent payment-probing (deanonymization) attacks. For
2524 /// newer nodes, it will be provided to you in the invoice. If you do not have one, the Route
2525 /// must not contain multiple paths as multi-path payments require a recipient-provided
2527 /// If a payment_secret *is* provided, we assume that the invoice had the payment_secret feature
2528 /// bit set (either as required or as available). If multiple paths are present in the Route,
2529 /// we assume the invoice had the basic_mpp feature set.
2530 pub fn send_payment(&self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>) -> Result<PaymentId, PaymentSendFailure> {
2531 self.send_payment_internal(route, payment_hash, payment_secret, None, None, None)
2534 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> {
2535 if route.paths.len() < 1 {
2536 return Err(PaymentSendFailure::ParameterError(APIError::RouteError{err: "There must be at least one path to send over"}));
2538 if payment_secret.is_none() && route.paths.len() > 1 {
2539 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError{err: "Payment secret is required for multi-path payments".to_string()}));
2541 let mut total_value = 0;
2542 let our_node_id = self.get_our_node_id();
2543 let mut path_errs = Vec::with_capacity(route.paths.len());
2544 let payment_id = if let Some(id) = payment_id { id } else { PaymentId(self.keys_manager.get_secure_random_bytes()) };
2545 'path_check: for path in route.paths.iter() {
2546 if path.len() < 1 || path.len() > 20 {
2547 path_errs.push(Err(APIError::RouteError{err: "Path didn't go anywhere/had bogus size"}));
2548 continue 'path_check;
2550 for (idx, hop) in path.iter().enumerate() {
2551 if idx != path.len() - 1 && hop.pubkey == our_node_id {
2552 path_errs.push(Err(APIError::RouteError{err: "Path went through us but wasn't a simple rebalance loop to us"}));
2553 continue 'path_check;
2556 total_value += path.last().unwrap().fee_msat;
2557 path_errs.push(Ok(()));
2559 if path_errs.iter().any(|e| e.is_err()) {
2560 return Err(PaymentSendFailure::PathParameterError(path_errs));
2562 if let Some(amt_msat) = recv_value_msat {
2563 debug_assert!(amt_msat >= total_value);
2564 total_value = amt_msat;
2567 let cur_height = self.best_block.read().unwrap().height() + 1;
2568 let mut results = Vec::new();
2569 for path in route.paths.iter() {
2570 results.push(self.send_payment_along_path(&path, &route.payment_params, &payment_hash, payment_secret, total_value, cur_height, payment_id, &keysend_preimage));
2572 let mut has_ok = false;
2573 let mut has_err = false;
2574 let mut pending_amt_unsent = 0;
2575 let mut max_unsent_cltv_delta = 0;
2576 for (res, path) in results.iter().zip(route.paths.iter()) {
2577 if res.is_ok() { has_ok = true; }
2578 if res.is_err() { has_err = true; }
2579 if let &Err(APIError::MonitorUpdateFailed) = res {
2580 // MonitorUpdateFailed is inherently unsafe to retry, so we call it a
2584 } else if res.is_err() {
2585 pending_amt_unsent += path.last().unwrap().fee_msat;
2586 max_unsent_cltv_delta = cmp::max(max_unsent_cltv_delta, path.last().unwrap().cltv_expiry_delta);
2589 if has_err && has_ok {
2590 Err(PaymentSendFailure::PartialFailure {
2593 failed_paths_retry: if pending_amt_unsent != 0 {
2594 if let Some(payment_params) = &route.payment_params {
2595 Some(RouteParameters {
2596 payment_params: payment_params.clone(),
2597 final_value_msat: pending_amt_unsent,
2598 final_cltv_expiry_delta: max_unsent_cltv_delta,
2604 // If we failed to send any paths, we shouldn't have inserted the new PaymentId into
2605 // our `pending_outbound_payments` map at all.
2606 debug_assert!(self.pending_outbound_payments.lock().unwrap().get(&payment_id).is_none());
2607 Err(PaymentSendFailure::AllFailedRetrySafe(results.drain(..).map(|r| r.unwrap_err()).collect()))
2613 /// Retries a payment along the given [`Route`].
2615 /// Errors returned are a superset of those returned from [`send_payment`], so see
2616 /// [`send_payment`] documentation for more details on errors. This method will also error if the
2617 /// retry amount puts the payment more than 10% over the payment's total amount, if the payment
2618 /// for the given `payment_id` cannot be found (likely due to timeout or success), or if
2619 /// further retries have been disabled with [`abandon_payment`].
2621 /// [`send_payment`]: [`ChannelManager::send_payment`]
2622 /// [`abandon_payment`]: [`ChannelManager::abandon_payment`]
2623 pub fn retry_payment(&self, route: &Route, payment_id: PaymentId) -> Result<(), PaymentSendFailure> {
2624 const RETRY_OVERFLOW_PERCENTAGE: u64 = 10;
2625 for path in route.paths.iter() {
2626 if path.len() == 0 {
2627 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
2628 err: "length-0 path in route".to_string()
2633 let (total_msat, payment_hash, payment_secret) = {
2634 let outbounds = self.pending_outbound_payments.lock().unwrap();
2635 if let Some(payment) = outbounds.get(&payment_id) {
2637 PendingOutboundPayment::Retryable {
2638 total_msat, payment_hash, payment_secret, pending_amt_msat, ..
2640 let retry_amt_msat: u64 = route.paths.iter().map(|path| path.last().unwrap().fee_msat).sum();
2641 if retry_amt_msat + *pending_amt_msat > *total_msat * (100 + RETRY_OVERFLOW_PERCENTAGE) / 100 {
2642 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
2643 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()
2646 (*total_msat, *payment_hash, *payment_secret)
2648 PendingOutboundPayment::Legacy { .. } => {
2649 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
2650 err: "Unable to retry payments that were initially sent on LDK versions prior to 0.0.102".to_string()
2653 PendingOutboundPayment::Fulfilled { .. } => {
2654 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
2655 err: "Payment already completed".to_owned()
2658 PendingOutboundPayment::Abandoned { .. } => {
2659 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
2660 err: "Payment already abandoned (with some HTLCs still pending)".to_owned()
2665 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
2666 err: format!("Payment with ID {} not found", log_bytes!(payment_id.0)),
2670 return self.send_payment_internal(route, payment_hash, &payment_secret, None, Some(payment_id), Some(total_msat)).map(|_| ())
2673 /// Signals that no further retries for the given payment will occur.
2675 /// After this method returns, any future calls to [`retry_payment`] for the given `payment_id`
2676 /// will fail with [`PaymentSendFailure::ParameterError`]. If no such event has been generated,
2677 /// an [`Event::PaymentFailed`] event will be generated as soon as there are no remaining
2678 /// pending HTLCs for this payment.
2680 /// Note that calling this method does *not* prevent a payment from succeeding. You must still
2681 /// wait until you receive either a [`Event::PaymentFailed`] or [`Event::PaymentSent`] event to
2682 /// determine the ultimate status of a payment.
2684 /// [`retry_payment`]: Self::retry_payment
2685 /// [`Event::PaymentFailed`]: events::Event::PaymentFailed
2686 /// [`Event::PaymentSent`]: events::Event::PaymentSent
2687 pub fn abandon_payment(&self, payment_id: PaymentId) {
2688 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2690 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
2691 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
2692 if let Ok(()) = payment.get_mut().mark_abandoned() {
2693 if payment.get().remaining_parts() == 0 {
2694 self.pending_events.lock().unwrap().push(events::Event::PaymentFailed {
2696 payment_hash: payment.get().payment_hash().expect("PendingOutboundPayments::RetriesExceeded always has a payment hash set"),
2704 /// Send a spontaneous payment, which is a payment that does not require the recipient to have
2705 /// generated an invoice. Optionally, you may specify the preimage. If you do choose to specify
2706 /// the preimage, it must be a cryptographically secure random value that no intermediate node
2707 /// would be able to guess -- otherwise, an intermediate node may claim the payment and it will
2708 /// never reach the recipient.
2710 /// See [`send_payment`] documentation for more details on the return value of this function.
2712 /// Similar to regular payments, you MUST NOT reuse a `payment_preimage` value. See
2713 /// [`send_payment`] for more information about the risks of duplicate preimage usage.
2715 /// Note that `route` must have exactly one path.
2717 /// [`send_payment`]: Self::send_payment
2718 pub fn send_spontaneous_payment(&self, route: &Route, payment_preimage: Option<PaymentPreimage>) -> Result<(PaymentHash, PaymentId), PaymentSendFailure> {
2719 let preimage = match payment_preimage {
2721 None => PaymentPreimage(self.keys_manager.get_secure_random_bytes()),
2723 let payment_hash = PaymentHash(Sha256::hash(&preimage.0).into_inner());
2724 match self.send_payment_internal(route, payment_hash, &None, Some(preimage), None, None) {
2725 Ok(payment_id) => Ok((payment_hash, payment_id)),
2730 /// Handles the generation of a funding transaction, optionally (for tests) with a function
2731 /// which checks the correctness of the funding transaction given the associated channel.
2732 fn funding_transaction_generated_intern<FundingOutput: Fn(&Channel<Signer>, &Transaction) -> Result<OutPoint, APIError>>(
2733 &self, temporary_channel_id: &[u8; 32], _counterparty_node_id: &PublicKey, funding_transaction: Transaction, find_funding_output: FundingOutput
2734 ) -> Result<(), APIError> {
2736 let (res, chan) = match self.channel_state.lock().unwrap().by_id.remove(temporary_channel_id) {
2738 let funding_txo = find_funding_output(&chan, &funding_transaction)?;
2740 (chan.get_outbound_funding_created(funding_transaction, funding_txo, &self.logger)
2741 .map_err(|e| if let ChannelError::Close(msg) = e {
2742 MsgHandleErrInternal::from_finish_shutdown(msg, chan.channel_id(), chan.get_user_id(), chan.force_shutdown(true), None)
2743 } else { unreachable!(); })
2746 None => { return Err(APIError::ChannelUnavailable { err: "No such channel".to_owned() }) },
2748 match handle_error!(self, res, chan.get_counterparty_node_id()) {
2749 Ok(funding_msg) => {
2752 Err(_) => { return Err(APIError::ChannelUnavailable {
2753 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()
2758 let mut channel_state = self.channel_state.lock().unwrap();
2759 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
2760 node_id: chan.get_counterparty_node_id(),
2763 match channel_state.by_id.entry(chan.channel_id()) {
2764 hash_map::Entry::Occupied(_) => {
2765 panic!("Generated duplicate funding txid?");
2767 hash_map::Entry::Vacant(e) => {
2775 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> {
2776 self.funding_transaction_generated_intern(temporary_channel_id, counterparty_node_id, funding_transaction, |_, tx| {
2777 Ok(OutPoint { txid: tx.txid(), index: output_index })
2781 /// Call this upon creation of a funding transaction for the given channel.
2783 /// Returns an [`APIError::APIMisuseError`] if the funding_transaction spent non-SegWit outputs
2784 /// or if no output was found which matches the parameters in [`Event::FundingGenerationReady`].
2786 /// Returns [`APIError::APIMisuseError`] if the funding transaction is not final for propagation
2787 /// across the p2p network.
2789 /// Returns [`APIError::ChannelUnavailable`] if a funding transaction has already been provided
2790 /// for the channel or if the channel has been closed as indicated by [`Event::ChannelClosed`].
2792 /// May panic if the output found in the funding transaction is duplicative with some other
2793 /// channel (note that this should be trivially prevented by using unique funding transaction
2794 /// keys per-channel).
2796 /// Do NOT broadcast the funding transaction yourself. When we have safely received our
2797 /// counterparty's signature the funding transaction will automatically be broadcast via the
2798 /// [`BroadcasterInterface`] provided when this `ChannelManager` was constructed.
2800 /// Note that this includes RBF or similar transaction replacement strategies - lightning does
2801 /// not currently support replacing a funding transaction on an existing channel. Instead,
2802 /// create a new channel with a conflicting funding transaction.
2804 /// Note to keep the miner incentives aligned in moving the blockchain forward, we recommend
2805 /// the wallet software generating the funding transaction to apply anti-fee sniping as
2806 /// implemented by Bitcoin Core wallet. See <https://bitcoinops.org/en/topics/fee-sniping/>
2807 /// for more details.
2809 /// [`Event::FundingGenerationReady`]: crate::util::events::Event::FundingGenerationReady
2810 /// [`Event::ChannelClosed`]: crate::util::events::Event::ChannelClosed
2811 pub fn funding_transaction_generated(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, funding_transaction: Transaction) -> Result<(), APIError> {
2812 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2814 for inp in funding_transaction.input.iter() {
2815 if inp.witness.is_empty() {
2816 return Err(APIError::APIMisuseError {
2817 err: "Funding transaction must be fully signed and spend Segwit outputs".to_owned()
2822 let height = self.best_block.read().unwrap().height();
2823 // Transactions are evaluated as final by network mempools at the next block. However, the modules
2824 // constituting our Lightning node might not have perfect sync about their blockchain views. Thus, if
2825 // the wallet module is in advance on the LDK view, allow one more block of headroom.
2826 // TODO: updated if/when https://github.com/rust-bitcoin/rust-bitcoin/pull/994 landed and rust-bitcoin bumped.
2827 if !funding_transaction.input.iter().all(|input| input.sequence == 0xffffffff) && funding_transaction.lock_time < 500_000_000 && funding_transaction.lock_time > height + 2 {
2828 return Err(APIError::APIMisuseError {
2829 err: "Funding transaction absolute timelock is non-final".to_owned()
2833 self.funding_transaction_generated_intern(temporary_channel_id, counterparty_node_id, funding_transaction, |chan, tx| {
2834 let mut output_index = None;
2835 let expected_spk = chan.get_funding_redeemscript().to_v0_p2wsh();
2836 for (idx, outp) in tx.output.iter().enumerate() {
2837 if outp.script_pubkey == expected_spk && outp.value == chan.get_value_satoshis() {
2838 if output_index.is_some() {
2839 return Err(APIError::APIMisuseError {
2840 err: "Multiple outputs matched the expected script and value".to_owned()
2843 if idx > u16::max_value() as usize {
2844 return Err(APIError::APIMisuseError {
2845 err: "Transaction had more than 2^16 outputs, which is not supported".to_owned()
2848 output_index = Some(idx as u16);
2851 if output_index.is_none() {
2852 return Err(APIError::APIMisuseError {
2853 err: "No output matched the script_pubkey and value in the FundingGenerationReady event".to_owned()
2856 Ok(OutPoint { txid: tx.txid(), index: output_index.unwrap() })
2861 // Messages of up to 64KB should never end up more than half full with addresses, as that would
2862 // be absurd. We ensure this by checking that at least 500 (our stated public contract on when
2863 // broadcast_node_announcement panics) of the maximum-length addresses would fit in a 64KB
2865 const HALF_MESSAGE_IS_ADDRS: u32 = ::core::u16::MAX as u32 / (NetAddress::MAX_LEN as u32 + 1) / 2;
2868 // ...by failing to compile if the number of addresses that would be half of a message is
2869 // smaller than 500:
2870 const STATIC_ASSERT: u32 = Self::HALF_MESSAGE_IS_ADDRS - 500;
2872 /// Regenerates channel_announcements and generates a signed node_announcement from the given
2873 /// arguments, providing them in corresponding events via
2874 /// [`get_and_clear_pending_msg_events`], if at least one public channel has been confirmed
2875 /// on-chain. This effectively re-broadcasts all channel announcements and sends our node
2876 /// announcement to ensure that the lightning P2P network is aware of the channels we have and
2877 /// our network addresses.
2879 /// `rgb` is a node "color" and `alias` is a printable human-readable string to describe this
2880 /// node to humans. They carry no in-protocol meaning.
2882 /// `addresses` represent the set (possibly empty) of socket addresses on which this node
2883 /// accepts incoming connections. These will be included in the node_announcement, publicly
2884 /// tying these addresses together and to this node. If you wish to preserve user privacy,
2885 /// addresses should likely contain only Tor Onion addresses.
2887 /// Panics if `addresses` is absurdly large (more than 500).
2889 /// [`get_and_clear_pending_msg_events`]: MessageSendEventsProvider::get_and_clear_pending_msg_events
2890 pub fn broadcast_node_announcement(&self, rgb: [u8; 3], alias: [u8; 32], mut addresses: Vec<NetAddress>) {
2891 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2893 if addresses.len() > 500 {
2894 panic!("More than half the message size was taken up by public addresses!");
2897 // While all existing nodes handle unsorted addresses just fine, the spec requires that
2898 // addresses be sorted for future compatibility.
2899 addresses.sort_by_key(|addr| addr.get_id());
2901 let announcement = msgs::UnsignedNodeAnnouncement {
2902 features: NodeFeatures::known(),
2903 timestamp: self.last_node_announcement_serial.fetch_add(1, Ordering::AcqRel) as u32,
2904 node_id: self.get_our_node_id(),
2905 rgb, alias, addresses,
2906 excess_address_data: Vec::new(),
2907 excess_data: Vec::new(),
2909 let msghash = hash_to_message!(&Sha256dHash::hash(&announcement.encode()[..])[..]);
2910 let node_announce_sig = sign(&self.secp_ctx, &msghash, &self.our_network_key);
2912 let mut channel_state_lock = self.channel_state.lock().unwrap();
2913 let channel_state = &mut *channel_state_lock;
2915 let mut announced_chans = false;
2916 for (_, chan) in channel_state.by_id.iter() {
2917 if let Some(msg) = chan.get_signed_channel_announcement(self.get_our_node_id(), self.genesis_hash.clone(), self.best_block.read().unwrap().height()) {
2918 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
2920 update_msg: match self.get_channel_update_for_broadcast(chan) {
2925 announced_chans = true;
2927 // If the channel is not public or has not yet reached channel_ready, check the
2928 // next channel. If we don't yet have any public channels, we'll skip the broadcast
2929 // below as peers may not accept it without channels on chain first.
2933 if announced_chans {
2934 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastNodeAnnouncement {
2935 msg: msgs::NodeAnnouncement {
2936 signature: node_announce_sig,
2937 contents: announcement
2943 /// Processes HTLCs which are pending waiting on random forward delay.
2945 /// Should only really ever be called in response to a PendingHTLCsForwardable event.
2946 /// Will likely generate further events.
2947 pub fn process_pending_htlc_forwards(&self) {
2948 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2950 let mut new_events = Vec::new();
2951 let mut failed_forwards = Vec::new();
2952 let mut phantom_receives: Vec<(u64, OutPoint, Vec<(PendingHTLCInfo, u64)>)> = Vec::new();
2953 let mut handle_errors = Vec::new();
2955 let mut channel_state_lock = self.channel_state.lock().unwrap();
2956 let channel_state = &mut *channel_state_lock;
2958 for (short_chan_id, mut pending_forwards) in channel_state.forward_htlcs.drain() {
2959 if short_chan_id != 0 {
2960 let forward_chan_id = match channel_state.short_to_id.get(&short_chan_id) {
2961 Some(chan_id) => chan_id.clone(),
2963 for forward_info in pending_forwards.drain(..) {
2964 match forward_info {
2965 HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info: PendingHTLCInfo {
2966 routing, incoming_shared_secret, payment_hash, amt_to_forward, outgoing_cltv_value },
2967 prev_funding_outpoint } => {
2968 macro_rules! fail_forward {
2969 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr) => {
2971 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
2972 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
2973 short_channel_id: prev_short_channel_id,
2974 outpoint: prev_funding_outpoint,
2975 htlc_id: prev_htlc_id,
2976 incoming_packet_shared_secret: incoming_shared_secret,
2977 phantom_shared_secret: $phantom_ss,
2979 failed_forwards.push((htlc_source, payment_hash,
2980 HTLCFailReason::Reason { failure_code: $err_code, data: $err_data }
2986 if let PendingHTLCRouting::Forward { onion_packet, .. } = routing {
2987 let phantom_secret_res = self.keys_manager.get_node_secret(Recipient::PhantomNode);
2988 if phantom_secret_res.is_ok() && fake_scid::is_valid_phantom(&self.fake_scid_rand_bytes, short_chan_id) {
2989 let phantom_shared_secret = SharedSecret::new(&onion_packet.public_key.unwrap(), &phantom_secret_res.unwrap()).secret_bytes();
2990 let next_hop = match onion_utils::decode_next_hop(phantom_shared_secret, &onion_packet.hop_data, onion_packet.hmac, payment_hash) {
2992 Err(onion_utils::OnionDecodeErr::Malformed { err_msg, err_code }) => {
2993 let sha256_of_onion = Sha256::hash(&onion_packet.hop_data).into_inner();
2994 // In this scenario, the phantom would have sent us an
2995 // `update_fail_malformed_htlc`, meaning here we encrypt the error as
2996 // if it came from us (the second-to-last hop) but contains the sha256
2998 fail_forward!(err_msg, err_code, sha256_of_onion.to_vec(), None);
3000 Err(onion_utils::OnionDecodeErr::Relay { err_msg, err_code }) => {
3001 fail_forward!(err_msg, err_code, Vec::new(), Some(phantom_shared_secret));
3005 onion_utils::Hop::Receive(hop_data) => {
3006 match self.construct_recv_pending_htlc_info(hop_data, incoming_shared_secret, payment_hash, amt_to_forward, outgoing_cltv_value, Some(phantom_shared_secret)) {
3007 Ok(info) => phantom_receives.push((prev_short_channel_id, prev_funding_outpoint, vec![(info, prev_htlc_id)])),
3008 Err(ReceiveError { err_code, err_data, msg }) => fail_forward!(msg, err_code, err_data, Some(phantom_shared_secret))
3014 fail_forward!(format!("Unknown short channel id {} for forward HTLC", short_chan_id), 0x4000 | 10, Vec::new(), None);
3017 fail_forward!(format!("Unknown short channel id {} for forward HTLC", short_chan_id), 0x4000 | 10, Vec::new(), None);
3020 HTLCForwardInfo::FailHTLC { .. } => {
3021 // Channel went away before we could fail it. This implies
3022 // the channel is now on chain and our counterparty is
3023 // trying to broadcast the HTLC-Timeout, but that's their
3024 // problem, not ours.
3031 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(forward_chan_id) {
3032 let mut add_htlc_msgs = Vec::new();
3033 let mut fail_htlc_msgs = Vec::new();
3034 for forward_info in pending_forwards.drain(..) {
3035 match forward_info {
3036 HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info: PendingHTLCInfo {
3037 routing: PendingHTLCRouting::Forward {
3039 }, incoming_shared_secret, payment_hash, amt_to_forward, outgoing_cltv_value },
3040 prev_funding_outpoint } => {
3041 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);
3042 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
3043 short_channel_id: prev_short_channel_id,
3044 outpoint: prev_funding_outpoint,
3045 htlc_id: prev_htlc_id,
3046 incoming_packet_shared_secret: incoming_shared_secret,
3047 // Phantom payments are only PendingHTLCRouting::Receive.
3048 phantom_shared_secret: None,
3050 match chan.get_mut().send_htlc(amt_to_forward, payment_hash, outgoing_cltv_value, htlc_source.clone(), onion_packet, &self.logger) {
3052 if let ChannelError::Ignore(msg) = e {
3053 log_trace!(self.logger, "Failed to forward HTLC with payment_hash {}: {}", log_bytes!(payment_hash.0), msg);
3055 panic!("Stated return value requirements in send_htlc() were not met");
3057 let (failure_code, data) = self.get_htlc_temp_fail_err_and_data(0x1000|7, short_chan_id, chan.get());
3058 failed_forwards.push((htlc_source, payment_hash,
3059 HTLCFailReason::Reason { failure_code, data }
3065 Some(msg) => { add_htlc_msgs.push(msg); },
3067 // Nothing to do here...we're waiting on a remote
3068 // revoke_and_ack before we can add anymore HTLCs. The Channel
3069 // will automatically handle building the update_add_htlc and
3070 // commitment_signed messages when we can.
3071 // TODO: Do some kind of timer to set the channel as !is_live()
3072 // as we don't really want others relying on us relaying through
3073 // this channel currently :/.
3079 HTLCForwardInfo::AddHTLC { .. } => {
3080 panic!("short_channel_id != 0 should imply any pending_forward entries are of type Forward");
3082 HTLCForwardInfo::FailHTLC { htlc_id, err_packet } => {
3083 log_trace!(self.logger, "Failing HTLC back to channel with short id {} (backward HTLC ID {}) after delay", short_chan_id, htlc_id);
3084 match chan.get_mut().get_update_fail_htlc(htlc_id, err_packet, &self.logger) {
3086 if let ChannelError::Ignore(msg) = e {
3087 log_trace!(self.logger, "Failed to fail HTLC with ID {} backwards to short_id {}: {}", htlc_id, short_chan_id, msg);
3089 panic!("Stated return value requirements in get_update_fail_htlc() were not met");
3091 // fail-backs are best-effort, we probably already have one
3092 // pending, and if not that's OK, if not, the channel is on
3093 // the chain and sending the HTLC-Timeout is their problem.
3096 Ok(Some(msg)) => { fail_htlc_msgs.push(msg); },
3098 // Nothing to do here...we're waiting on a remote
3099 // revoke_and_ack before we can update the commitment
3100 // transaction. The Channel will automatically handle
3101 // building the update_fail_htlc and commitment_signed
3102 // messages when we can.
3103 // We don't need any kind of timer here as they should fail
3104 // the channel onto the chain if they can't get our
3105 // update_fail_htlc in time, it's not our problem.
3112 if !add_htlc_msgs.is_empty() || !fail_htlc_msgs.is_empty() {
3113 let (commitment_msg, monitor_update) = match chan.get_mut().send_commitment(&self.logger) {
3116 // We surely failed send_commitment due to bad keys, in that case
3117 // close channel and then send error message to peer.
3118 let counterparty_node_id = chan.get().get_counterparty_node_id();
3119 let err: Result<(), _> = match e {
3120 ChannelError::Ignore(_) | ChannelError::Warn(_) => {
3121 panic!("Stated return value requirements in send_commitment() were not met");
3123 ChannelError::Close(msg) => {
3124 log_trace!(self.logger, "Closing channel {} due to Close-required error: {}", log_bytes!(chan.key()[..]), msg);
3125 let mut channel = remove_channel!(self, channel_state, chan);
3126 // ChannelClosed event is generated by handle_error for us.
3127 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()))
3129 ChannelError::CloseDelayBroadcast(_) => { panic!("Wait is only generated on receipt of channel_reestablish, which is handled by try_chan_entry, we don't bother to support it here"); }
3131 handle_errors.push((counterparty_node_id, err));
3135 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
3136 handle_errors.push((chan.get().get_counterparty_node_id(), handle_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, true)));
3139 log_debug!(self.logger, "Forwarding HTLCs resulted in a commitment update with {} HTLCs added and {} HTLCs failed for channel {}",
3140 add_htlc_msgs.len(), fail_htlc_msgs.len(), log_bytes!(chan.get().channel_id()));
3141 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
3142 node_id: chan.get().get_counterparty_node_id(),
3143 updates: msgs::CommitmentUpdate {
3144 update_add_htlcs: add_htlc_msgs,
3145 update_fulfill_htlcs: Vec::new(),
3146 update_fail_htlcs: fail_htlc_msgs,
3147 update_fail_malformed_htlcs: Vec::new(),
3149 commitment_signed: commitment_msg,
3157 for forward_info in pending_forwards.drain(..) {
3158 match forward_info {
3159 HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info: PendingHTLCInfo {
3160 routing, incoming_shared_secret, payment_hash, amt_to_forward, .. },
3161 prev_funding_outpoint } => {
3162 let (cltv_expiry, onion_payload, payment_data, phantom_shared_secret) = match routing {
3163 PendingHTLCRouting::Receive { payment_data, incoming_cltv_expiry, phantom_shared_secret } => {
3164 let _legacy_hop_data = Some(payment_data.clone());
3165 (incoming_cltv_expiry, OnionPayload::Invoice { _legacy_hop_data }, Some(payment_data), phantom_shared_secret)
3167 PendingHTLCRouting::ReceiveKeysend { payment_preimage, incoming_cltv_expiry } =>
3168 (incoming_cltv_expiry, OnionPayload::Spontaneous(payment_preimage), None, None),
3170 panic!("short_channel_id == 0 should imply any pending_forward entries are of type Receive");
3173 let claimable_htlc = ClaimableHTLC {
3174 prev_hop: HTLCPreviousHopData {
3175 short_channel_id: prev_short_channel_id,
3176 outpoint: prev_funding_outpoint,
3177 htlc_id: prev_htlc_id,
3178 incoming_packet_shared_secret: incoming_shared_secret,
3179 phantom_shared_secret,
3181 value: amt_to_forward,
3183 total_msat: if let Some(data) = &payment_data { data.total_msat } else { amt_to_forward },
3188 macro_rules! fail_htlc {
3190 let mut htlc_msat_height_data = byte_utils::be64_to_array($htlc.value).to_vec();
3191 htlc_msat_height_data.extend_from_slice(
3192 &byte_utils::be32_to_array(self.best_block.read().unwrap().height()),
3194 failed_forwards.push((HTLCSource::PreviousHopData(HTLCPreviousHopData {
3195 short_channel_id: $htlc.prev_hop.short_channel_id,
3196 outpoint: prev_funding_outpoint,
3197 htlc_id: $htlc.prev_hop.htlc_id,
3198 incoming_packet_shared_secret: $htlc.prev_hop.incoming_packet_shared_secret,
3199 phantom_shared_secret,
3201 HTLCFailReason::Reason { failure_code: 0x4000 | 15, data: htlc_msat_height_data }
3206 macro_rules! check_total_value {
3207 ($payment_data: expr, $payment_preimage: expr) => {{
3208 let mut payment_received_generated = false;
3210 events::PaymentPurpose::InvoicePayment {
3211 payment_preimage: $payment_preimage,
3212 payment_secret: $payment_data.payment_secret,
3215 let (_, htlcs) = channel_state.claimable_htlcs.entry(payment_hash)
3216 .or_insert_with(|| (purpose(), Vec::new()));
3217 if htlcs.len() == 1 {
3218 if let OnionPayload::Spontaneous(_) = htlcs[0].onion_payload {
3219 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));
3220 fail_htlc!(claimable_htlc);
3224 let mut total_value = claimable_htlc.value;
3225 for htlc in htlcs.iter() {
3226 total_value += htlc.value;
3227 match &htlc.onion_payload {
3228 OnionPayload::Invoice { .. } => {
3229 if htlc.total_msat != $payment_data.total_msat {
3230 log_trace!(self.logger, "Failing HTLCs with payment_hash {} as the HTLCs had inconsistent total values (eg {} and {})",
3231 log_bytes!(payment_hash.0), $payment_data.total_msat, htlc.total_msat);
3232 total_value = msgs::MAX_VALUE_MSAT;
3234 if total_value >= msgs::MAX_VALUE_MSAT { break; }
3236 _ => unreachable!(),
3239 if total_value >= msgs::MAX_VALUE_MSAT || total_value > $payment_data.total_msat {
3240 log_trace!(self.logger, "Failing HTLCs with payment_hash {} as the total value {} ran over expected value {} (or HTLCs were inconsistent)",
3241 log_bytes!(payment_hash.0), total_value, $payment_data.total_msat);
3242 fail_htlc!(claimable_htlc);
3243 } else if total_value == $payment_data.total_msat {
3244 htlcs.push(claimable_htlc);
3245 new_events.push(events::Event::PaymentReceived {
3248 amount_msat: total_value,
3250 payment_received_generated = true;
3252 // Nothing to do - we haven't reached the total
3253 // payment value yet, wait until we receive more
3255 htlcs.push(claimable_htlc);
3257 payment_received_generated
3261 // Check that the payment hash and secret are known. Note that we
3262 // MUST take care to handle the "unknown payment hash" and
3263 // "incorrect payment secret" cases here identically or we'd expose
3264 // that we are the ultimate recipient of the given payment hash.
3265 // Further, we must not expose whether we have any other HTLCs
3266 // associated with the same payment_hash pending or not.
3267 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
3268 match payment_secrets.entry(payment_hash) {
3269 hash_map::Entry::Vacant(_) => {
3270 match claimable_htlc.onion_payload {
3271 OnionPayload::Invoice { .. } => {
3272 let payment_data = payment_data.unwrap();
3273 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) {
3274 Ok(payment_preimage) => payment_preimage,
3276 fail_htlc!(claimable_htlc);
3280 check_total_value!(payment_data, payment_preimage);
3282 OnionPayload::Spontaneous(preimage) => {
3283 match channel_state.claimable_htlcs.entry(payment_hash) {
3284 hash_map::Entry::Vacant(e) => {
3285 let purpose = events::PaymentPurpose::SpontaneousPayment(preimage);
3286 e.insert((purpose.clone(), vec![claimable_htlc]));
3287 new_events.push(events::Event::PaymentReceived {
3289 amount_msat: amt_to_forward,
3293 hash_map::Entry::Occupied(_) => {
3294 log_trace!(self.logger, "Failing new keysend HTLC with payment_hash {} for a duplicative payment hash", log_bytes!(payment_hash.0));
3295 fail_htlc!(claimable_htlc);
3301 hash_map::Entry::Occupied(inbound_payment) => {
3302 if payment_data.is_none() {
3303 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));
3304 fail_htlc!(claimable_htlc);
3307 let payment_data = payment_data.unwrap();
3308 if inbound_payment.get().payment_secret != payment_data.payment_secret {
3309 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our expected payment secret.", log_bytes!(payment_hash.0));
3310 fail_htlc!(claimable_htlc);
3311 } else if inbound_payment.get().min_value_msat.is_some() && payment_data.total_msat < inbound_payment.get().min_value_msat.unwrap() {
3312 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our minimum value (had {}, needed {}).",
3313 log_bytes!(payment_hash.0), payment_data.total_msat, inbound_payment.get().min_value_msat.unwrap());
3314 fail_htlc!(claimable_htlc);
3316 let payment_received_generated = check_total_value!(payment_data, inbound_payment.get().payment_preimage);
3317 if payment_received_generated {
3318 inbound_payment.remove_entry();
3324 HTLCForwardInfo::FailHTLC { .. } => {
3325 panic!("Got pending fail of our own HTLC");
3333 for (htlc_source, payment_hash, failure_reason) in failed_forwards.drain(..) {
3334 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source, &payment_hash, failure_reason);
3336 self.forward_htlcs(&mut phantom_receives);
3338 for (counterparty_node_id, err) in handle_errors.drain(..) {
3339 let _ = handle_error!(self, err, counterparty_node_id);
3342 if new_events.is_empty() { return }
3343 let mut events = self.pending_events.lock().unwrap();
3344 events.append(&mut new_events);
3347 /// Free the background events, generally called from timer_tick_occurred.
3349 /// Exposed for testing to allow us to process events quickly without generating accidental
3350 /// BroadcastChannelUpdate events in timer_tick_occurred.
3352 /// Expects the caller to have a total_consistency_lock read lock.
3353 fn process_background_events(&self) -> bool {
3354 let mut background_events = Vec::new();
3355 mem::swap(&mut *self.pending_background_events.lock().unwrap(), &mut background_events);
3356 if background_events.is_empty() {
3360 for event in background_events.drain(..) {
3362 BackgroundEvent::ClosingMonitorUpdate((funding_txo, update)) => {
3363 // The channel has already been closed, so no use bothering to care about the
3364 // monitor updating completing.
3365 let _ = self.chain_monitor.update_channel(funding_txo, update);
3372 #[cfg(any(test, feature = "_test_utils"))]
3373 /// Process background events, for functional testing
3374 pub fn test_process_background_events(&self) {
3375 self.process_background_events();
3378 fn update_channel_fee(&self, short_to_id: &mut HashMap<u64, [u8; 32]>, pending_msg_events: &mut Vec<events::MessageSendEvent>, chan_id: &[u8; 32], chan: &mut Channel<Signer>, new_feerate: u32) -> (bool, NotifyOption, Result<(), MsgHandleErrInternal>) {
3379 if !chan.is_outbound() { return (true, NotifyOption::SkipPersist, Ok(())); }
3380 // If the feerate has decreased by less than half, don't bother
3381 if new_feerate <= chan.get_feerate() && new_feerate * 2 > chan.get_feerate() {
3382 log_trace!(self.logger, "Channel {} does not qualify for a feerate change from {} to {}.",
3383 log_bytes!(chan_id[..]), chan.get_feerate(), new_feerate);
3384 return (true, NotifyOption::SkipPersist, Ok(()));
3386 if !chan.is_live() {
3387 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).",
3388 log_bytes!(chan_id[..]), chan.get_feerate(), new_feerate);
3389 return (true, NotifyOption::SkipPersist, Ok(()));
3391 log_trace!(self.logger, "Channel {} qualifies for a feerate change from {} to {}.",
3392 log_bytes!(chan_id[..]), chan.get_feerate(), new_feerate);
3394 let mut retain_channel = true;
3395 let res = match chan.send_update_fee_and_commit(new_feerate, &self.logger) {
3398 let (drop, res) = convert_chan_err!(self, e, short_to_id, chan, chan_id);
3399 if drop { retain_channel = false; }
3403 let ret_err = match res {
3404 Ok(Some((update_fee, commitment_signed, monitor_update))) => {
3405 if let Err(e) = self.chain_monitor.update_channel(chan.get_funding_txo().unwrap(), monitor_update) {
3406 let (res, drop) = handle_monitor_err!(self, e, short_to_id, chan, RAACommitmentOrder::CommitmentFirst, chan_id, COMMITMENT_UPDATE_ONLY);
3407 if drop { retain_channel = false; }
3410 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
3411 node_id: chan.get_counterparty_node_id(),
3412 updates: msgs::CommitmentUpdate {
3413 update_add_htlcs: Vec::new(),
3414 update_fulfill_htlcs: Vec::new(),
3415 update_fail_htlcs: Vec::new(),
3416 update_fail_malformed_htlcs: Vec::new(),
3417 update_fee: Some(update_fee),
3427 (retain_channel, NotifyOption::DoPersist, ret_err)
3431 /// In chanmon_consistency we want to sometimes do the channel fee updates done in
3432 /// timer_tick_occurred, but we can't generate the disabled channel updates as it considers
3433 /// these a fuzz failure (as they usually indicate a channel force-close, which is exactly what
3434 /// it wants to detect). Thus, we have a variant exposed here for its benefit.
3435 pub fn maybe_update_chan_fees(&self) {
3436 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
3437 let mut should_persist = NotifyOption::SkipPersist;
3439 let new_feerate = self.fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
3441 let mut handle_errors = Vec::new();
3443 let mut channel_state_lock = self.channel_state.lock().unwrap();
3444 let channel_state = &mut *channel_state_lock;
3445 let pending_msg_events = &mut channel_state.pending_msg_events;
3446 let short_to_id = &mut channel_state.short_to_id;
3447 channel_state.by_id.retain(|chan_id, chan| {
3448 let (retain_channel, chan_needs_persist, err) = self.update_channel_fee(short_to_id, pending_msg_events, chan_id, chan, new_feerate);
3449 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
3451 handle_errors.push(err);
3461 /// Performs actions which should happen on startup and roughly once per minute thereafter.
3463 /// This currently includes:
3464 /// * Increasing or decreasing the on-chain feerate estimates for our outbound channels,
3465 /// * Broadcasting `ChannelUpdate` messages if we've been disconnected from our peer for more
3466 /// than a minute, informing the network that they should no longer attempt to route over
3469 /// Note that this may cause reentrancy through `chain::Watch::update_channel` calls or feerate
3470 /// estimate fetches.
3471 pub fn timer_tick_occurred(&self) {
3472 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
3473 let mut should_persist = NotifyOption::SkipPersist;
3474 if self.process_background_events() { should_persist = NotifyOption::DoPersist; }
3476 let new_feerate = self.fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
3478 let mut handle_errors = Vec::new();
3479 let mut timed_out_mpp_htlcs = Vec::new();
3481 let mut channel_state_lock = self.channel_state.lock().unwrap();
3482 let channel_state = &mut *channel_state_lock;
3483 let pending_msg_events = &mut channel_state.pending_msg_events;
3484 let short_to_id = &mut channel_state.short_to_id;
3485 channel_state.by_id.retain(|chan_id, chan| {
3486 let counterparty_node_id = chan.get_counterparty_node_id();
3487 let (retain_channel, chan_needs_persist, err) = self.update_channel_fee(short_to_id, pending_msg_events, chan_id, chan, new_feerate);
3488 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
3490 handle_errors.push((err, counterparty_node_id));
3492 if !retain_channel { return false; }
3494 if let Err(e) = chan.timer_check_closing_negotiation_progress() {
3495 let (needs_close, err) = convert_chan_err!(self, e, short_to_id, chan, chan_id);
3496 handle_errors.push((Err(err), chan.get_counterparty_node_id()));
3497 if needs_close { return false; }
3500 match chan.channel_update_status() {
3501 ChannelUpdateStatus::Enabled if !chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::DisabledStaged),
3502 ChannelUpdateStatus::Disabled if chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::EnabledStaged),
3503 ChannelUpdateStatus::DisabledStaged if chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::Enabled),
3504 ChannelUpdateStatus::EnabledStaged if !chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::Disabled),
3505 ChannelUpdateStatus::DisabledStaged if !chan.is_live() => {
3506 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
3507 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
3511 should_persist = NotifyOption::DoPersist;
3512 chan.set_channel_update_status(ChannelUpdateStatus::Disabled);
3514 ChannelUpdateStatus::EnabledStaged if chan.is_live() => {
3515 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
3516 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
3520 should_persist = NotifyOption::DoPersist;
3521 chan.set_channel_update_status(ChannelUpdateStatus::Enabled);
3529 channel_state.claimable_htlcs.retain(|payment_hash, (_, htlcs)| {
3530 if htlcs.is_empty() {
3531 // This should be unreachable
3532 debug_assert!(false);
3535 if let OnionPayload::Invoice { .. } = htlcs[0].onion_payload {
3536 // Check if we've received all the parts we need for an MPP (the value of the parts adds to total_msat).
3537 // In this case we're not going to handle any timeouts of the parts here.
3538 if htlcs[0].total_msat == htlcs.iter().fold(0, |total, htlc| total + htlc.value) {
3540 } else if htlcs.into_iter().any(|htlc| {
3541 htlc.timer_ticks += 1;
3542 return htlc.timer_ticks >= MPP_TIMEOUT_TICKS
3544 timed_out_mpp_htlcs.extend(htlcs.into_iter().map(|htlc| (htlc.prev_hop.clone(), payment_hash.clone())));
3552 for htlc_source in timed_out_mpp_htlcs.drain(..) {
3553 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() });
3556 for (err, counterparty_node_id) in handle_errors.drain(..) {
3557 let _ = handle_error!(self, err, counterparty_node_id);
3563 /// Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
3564 /// after a PaymentReceived event, failing the HTLC back to its origin and freeing resources
3565 /// along the path (including in our own channel on which we received it).
3567 /// Note that in some cases around unclean shutdown, it is possible the payment may have
3568 /// already been claimed by you via [`ChannelManager::claim_funds`] prior to you seeing (a
3569 /// second copy of) the [`events::Event::PaymentReceived`] event. Alternatively, the payment
3570 /// may have already been failed automatically by LDK if it was nearing its expiration time.
3572 /// While LDK will never claim a payment automatically on your behalf (i.e. without you calling
3573 /// [`ChannelManager::claim_funds`]), you should still monitor for
3574 /// [`events::Event::PaymentClaimed`] events even for payments you intend to fail, especially on
3575 /// startup during which time claims that were in-progress at shutdown may be replayed.
3576 pub fn fail_htlc_backwards(&self, payment_hash: &PaymentHash) {
3577 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
3579 let mut channel_state = Some(self.channel_state.lock().unwrap());
3580 let removed_source = channel_state.as_mut().unwrap().claimable_htlcs.remove(payment_hash);
3581 if let Some((_, mut sources)) = removed_source {
3582 for htlc in sources.drain(..) {
3583 if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
3584 let mut htlc_msat_height_data = byte_utils::be64_to_array(htlc.value).to_vec();
3585 htlc_msat_height_data.extend_from_slice(&byte_utils::be32_to_array(
3586 self.best_block.read().unwrap().height()));
3587 self.fail_htlc_backwards_internal(channel_state.take().unwrap(),
3588 HTLCSource::PreviousHopData(htlc.prev_hop), payment_hash,
3589 HTLCFailReason::Reason { failure_code: 0x4000 | 15, data: htlc_msat_height_data });
3594 /// Gets an HTLC onion failure code and error data for an `UPDATE` error, given the error code
3595 /// that we want to return and a channel.
3597 /// This is for failures on the channel on which the HTLC was *received*, not failures
3599 fn get_htlc_inbound_temp_fail_err_and_data(&self, desired_err_code: u16, chan: &Channel<Signer>) -> (u16, Vec<u8>) {
3600 // We can't be sure what SCID was used when relaying inbound towards us, so we have to
3601 // guess somewhat. If its a public channel, we figure best to just use the real SCID (as
3602 // we're not leaking that we have a channel with the counterparty), otherwise we try to use
3603 // an inbound SCID alias before the real SCID.
3604 let scid_pref = if chan.should_announce() {
3605 chan.get_short_channel_id().or(chan.latest_inbound_scid_alias())
3607 chan.latest_inbound_scid_alias().or(chan.get_short_channel_id())
3609 if let Some(scid) = scid_pref {
3610 self.get_htlc_temp_fail_err_and_data(desired_err_code, scid, chan)
3612 (0x4000|10, Vec::new())
3617 /// Gets an HTLC onion failure code and error data for an `UPDATE` error, given the error code
3618 /// that we want to return and a channel.
3619 fn get_htlc_temp_fail_err_and_data(&self, desired_err_code: u16, scid: u64, chan: &Channel<Signer>) -> (u16, Vec<u8>) {
3620 debug_assert_eq!(desired_err_code & 0x1000, 0x1000);
3621 if let Ok(upd) = self.get_channel_update_for_onion(scid, chan) {
3622 let mut enc = VecWriter(Vec::with_capacity(upd.serialized_length() + 6));
3623 if desired_err_code == 0x1000 | 20 {
3624 // TODO: underspecified, follow https://github.com/lightning/bolts/issues/791
3625 0u16.write(&mut enc).expect("Writes cannot fail");
3627 (upd.serialized_length() as u16 + 2).write(&mut enc).expect("Writes cannot fail");
3628 msgs::ChannelUpdate::TYPE.write(&mut enc).expect("Writes cannot fail");
3629 upd.write(&mut enc).expect("Writes cannot fail");
3630 (desired_err_code, enc.0)
3632 // If we fail to get a unicast channel_update, it implies we don't yet have an SCID,
3633 // which means we really shouldn't have gotten a payment to be forwarded over this
3634 // channel yet, or if we did it's from a route hint. Either way, returning an error of
3635 // PERM|no_such_channel should be fine.
3636 (0x4000|10, Vec::new())
3640 // Fail a list of HTLCs that were just freed from the holding cell. The HTLCs need to be
3641 // failed backwards or, if they were one of our outgoing HTLCs, then their failure needs to
3642 // be surfaced to the user.
3643 fn fail_holding_cell_htlcs(
3644 &self, mut htlcs_to_fail: Vec<(HTLCSource, PaymentHash)>, channel_id: [u8; 32],
3645 _counterparty_node_id: &PublicKey
3647 for (htlc_src, payment_hash) in htlcs_to_fail.drain(..) {
3649 HTLCSource::PreviousHopData(HTLCPreviousHopData { .. }) => {
3650 let (failure_code, onion_failure_data) =
3651 match self.channel_state.lock().unwrap().by_id.entry(channel_id) {
3652 hash_map::Entry::Occupied(chan_entry) => {
3653 self.get_htlc_inbound_temp_fail_err_and_data(0x1000|7, &chan_entry.get())
3655 hash_map::Entry::Vacant(_) => (0x4000|10, Vec::new())
3657 let channel_state = self.channel_state.lock().unwrap();
3658 self.fail_htlc_backwards_internal(channel_state,
3659 htlc_src, &payment_hash, HTLCFailReason::Reason { failure_code, data: onion_failure_data});
3661 HTLCSource::OutboundRoute { session_priv, payment_id, path, payment_params, .. } => {
3662 let mut session_priv_bytes = [0; 32];
3663 session_priv_bytes.copy_from_slice(&session_priv[..]);
3664 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
3665 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
3666 if payment.get_mut().remove(&session_priv_bytes, Some(&path)) && !payment.get().is_fulfilled() {
3667 let retry = if let Some(payment_params_data) = payment_params {
3668 let path_last_hop = path.last().expect("Outbound payments must have had a valid path");
3669 Some(RouteParameters {
3670 payment_params: payment_params_data,
3671 final_value_msat: path_last_hop.fee_msat,
3672 final_cltv_expiry_delta: path_last_hop.cltv_expiry_delta,
3675 let mut pending_events = self.pending_events.lock().unwrap();
3676 pending_events.push(events::Event::PaymentPathFailed {
3677 payment_id: Some(payment_id),
3679 rejected_by_dest: false,
3680 network_update: None,
3681 all_paths_failed: payment.get().remaining_parts() == 0,
3683 short_channel_id: None,
3690 if payment.get().abandoned() && payment.get().remaining_parts() == 0 {
3691 pending_events.push(events::Event::PaymentFailed {
3693 payment_hash: payment.get().payment_hash().expect("PendingOutboundPayments::RetriesExceeded always has a payment hash set"),
3699 log_trace!(self.logger, "Received duplicative fail for HTLC with payment_hash {}", log_bytes!(payment_hash.0));
3706 /// Fails an HTLC backwards to the sender of it to us.
3707 /// Note that while we take a channel_state lock as input, we do *not* assume consistency here.
3708 /// There are several callsites that do stupid things like loop over a list of payment_hashes
3709 /// to fail and take the channel_state lock for each iteration (as we take ownership and may
3710 /// drop it). In other words, no assumptions are made that entries in claimable_htlcs point to
3711 /// still-available channels.
3712 fn fail_htlc_backwards_internal(&self, mut channel_state_lock: MutexGuard<ChannelHolder<Signer>>, source: HTLCSource, payment_hash: &PaymentHash, onion_error: HTLCFailReason) {
3713 //TODO: There is a timing attack here where if a node fails an HTLC back to us they can
3714 //identify whether we sent it or not based on the (I presume) very different runtime
3715 //between the branches here. We should make this async and move it into the forward HTLCs
3718 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
3719 // from block_connected which may run during initialization prior to the chain_monitor
3720 // being fully configured. See the docs for `ChannelManagerReadArgs` for more.
3722 HTLCSource::OutboundRoute { ref path, session_priv, payment_id, ref payment_params, .. } => {
3723 let mut session_priv_bytes = [0; 32];
3724 session_priv_bytes.copy_from_slice(&session_priv[..]);
3725 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
3726 let mut all_paths_failed = false;
3727 let mut full_failure_ev = None;
3728 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
3729 if !payment.get_mut().remove(&session_priv_bytes, Some(&path)) {
3730 log_trace!(self.logger, "Received duplicative fail for HTLC with payment_hash {}", log_bytes!(payment_hash.0));
3733 if payment.get().is_fulfilled() {
3734 log_trace!(self.logger, "Received failure of HTLC with payment_hash {} after payment completion", log_bytes!(payment_hash.0));
3737 if payment.get().remaining_parts() == 0 {
3738 all_paths_failed = true;
3739 if payment.get().abandoned() {
3740 full_failure_ev = Some(events::Event::PaymentFailed {
3742 payment_hash: payment.get().payment_hash().expect("PendingOutboundPayments::RetriesExceeded always has a payment hash set"),
3748 log_trace!(self.logger, "Received duplicative fail for HTLC with payment_hash {}", log_bytes!(payment_hash.0));
3751 mem::drop(channel_state_lock);
3752 let retry = if let Some(payment_params_data) = payment_params {
3753 let path_last_hop = path.last().expect("Outbound payments must have had a valid path");
3754 Some(RouteParameters {
3755 payment_params: payment_params_data.clone(),
3756 final_value_msat: path_last_hop.fee_msat,
3757 final_cltv_expiry_delta: path_last_hop.cltv_expiry_delta,
3760 log_trace!(self.logger, "Failing outbound payment HTLC with payment_hash {}", log_bytes!(payment_hash.0));
3762 let path_failure = match &onion_error {
3763 &HTLCFailReason::LightningError { ref err } => {
3765 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());
3767 let (network_update, short_channel_id, payment_retryable, _, _) = onion_utils::process_onion_failure(&self.secp_ctx, &self.logger, &source, err.data.clone());
3768 // TODO: If we decided to blame ourselves (or one of our channels) in
3769 // process_onion_failure we should close that channel as it implies our
3770 // next-hop is needlessly blaming us!
3771 events::Event::PaymentPathFailed {
3772 payment_id: Some(payment_id),
3773 payment_hash: payment_hash.clone(),
3774 rejected_by_dest: !payment_retryable,
3781 error_code: onion_error_code,
3783 error_data: onion_error_data
3786 &HTLCFailReason::Reason {
3792 // we get a fail_malformed_htlc from the first hop
3793 // TODO: We'd like to generate a NetworkUpdate for temporary
3794 // failures here, but that would be insufficient as find_route
3795 // generally ignores its view of our own channels as we provide them via
3797 // TODO: For non-temporary failures, we really should be closing the
3798 // channel here as we apparently can't relay through them anyway.
3799 events::Event::PaymentPathFailed {
3800 payment_id: Some(payment_id),
3801 payment_hash: payment_hash.clone(),
3802 rejected_by_dest: path.len() == 1,
3803 network_update: None,
3806 short_channel_id: Some(path.first().unwrap().short_channel_id),
3809 error_code: Some(*failure_code),
3811 error_data: Some(data.clone()),
3815 let mut pending_events = self.pending_events.lock().unwrap();
3816 pending_events.push(path_failure);
3817 if let Some(ev) = full_failure_ev { pending_events.push(ev); }
3819 HTLCSource::PreviousHopData(HTLCPreviousHopData { short_channel_id, htlc_id, incoming_packet_shared_secret, phantom_shared_secret, .. }) => {
3820 let err_packet = match onion_error {
3821 HTLCFailReason::Reason { failure_code, data } => {
3822 log_trace!(self.logger, "Failing HTLC with payment_hash {} backwards from us with code {}", log_bytes!(payment_hash.0), failure_code);
3823 if let Some(phantom_ss) = phantom_shared_secret {
3824 let phantom_packet = onion_utils::build_failure_packet(&phantom_ss, failure_code, &data[..]).encode();
3825 let encrypted_phantom_packet = onion_utils::encrypt_failure_packet(&phantom_ss, &phantom_packet);
3826 onion_utils::encrypt_failure_packet(&incoming_packet_shared_secret, &encrypted_phantom_packet.data[..])
3828 let packet = onion_utils::build_failure_packet(&incoming_packet_shared_secret, failure_code, &data[..]).encode();
3829 onion_utils::encrypt_failure_packet(&incoming_packet_shared_secret, &packet)
3832 HTLCFailReason::LightningError { err } => {
3833 log_trace!(self.logger, "Failing HTLC with payment_hash {} backwards with pre-built LightningError", log_bytes!(payment_hash.0));
3834 onion_utils::encrypt_failure_packet(&incoming_packet_shared_secret, &err.data)
3838 let mut forward_event = None;
3839 if channel_state_lock.forward_htlcs.is_empty() {
3840 forward_event = Some(Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS));
3842 match channel_state_lock.forward_htlcs.entry(short_channel_id) {
3843 hash_map::Entry::Occupied(mut entry) => {
3844 entry.get_mut().push(HTLCForwardInfo::FailHTLC { htlc_id, err_packet });
3846 hash_map::Entry::Vacant(entry) => {
3847 entry.insert(vec!(HTLCForwardInfo::FailHTLC { htlc_id, err_packet }));
3850 mem::drop(channel_state_lock);
3851 if let Some(time) = forward_event {
3852 let mut pending_events = self.pending_events.lock().unwrap();
3853 pending_events.push(events::Event::PendingHTLCsForwardable {
3854 time_forwardable: time
3861 /// Provides a payment preimage in response to [`Event::PaymentReceived`], generating any
3862 /// [`MessageSendEvent`]s needed to claim the payment.
3864 /// Note that calling this method does *not* guarantee that the payment has been claimed. You
3865 /// *must* wait for an [`Event::PaymentClaimed`] event which upon a successful claim will be
3866 /// provided to your [`EventHandler`] when [`process_pending_events`] is next called.
3868 /// Note that if you did not set an `amount_msat` when calling [`create_inbound_payment`] or
3869 /// [`create_inbound_payment_for_hash`] you must check that the amount in the `PaymentReceived`
3870 /// event matches your expectation. If you fail to do so and call this method, you may provide
3871 /// the sender "proof-of-payment" when they did not fulfill the full expected payment.
3873 /// [`Event::PaymentReceived`]: crate::util::events::Event::PaymentReceived
3874 /// [`Event::PaymentClaimed`]: crate::util::events::Event::PaymentClaimed
3875 /// [`process_pending_events`]: EventsProvider::process_pending_events
3876 /// [`create_inbound_payment`]: Self::create_inbound_payment
3877 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
3878 /// [`get_and_clear_pending_msg_events`]: MessageSendEventsProvider::get_and_clear_pending_msg_events
3879 pub fn claim_funds(&self, payment_preimage: PaymentPreimage) {
3880 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
3882 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
3884 let mut channel_state = Some(self.channel_state.lock().unwrap());
3885 let removed_source = channel_state.as_mut().unwrap().claimable_htlcs.remove(&payment_hash);
3886 if let Some((payment_purpose, mut sources)) = removed_source {
3887 assert!(!sources.is_empty());
3889 // If we are claiming an MPP payment, we have to take special care to ensure that each
3890 // channel exists before claiming all of the payments (inside one lock).
3891 // Note that channel existance is sufficient as we should always get a monitor update
3892 // which will take care of the real HTLC claim enforcement.
3894 // If we find an HTLC which we would need to claim but for which we do not have a
3895 // channel, we will fail all parts of the MPP payment. While we could wait and see if
3896 // the sender retries the already-failed path(s), it should be a pretty rare case where
3897 // we got all the HTLCs and then a channel closed while we were waiting for the user to
3898 // provide the preimage, so worrying too much about the optimal handling isn't worth
3900 let mut claimable_amt_msat = 0;
3901 let mut expected_amt_msat = None;
3902 let mut valid_mpp = true;
3903 for htlc in sources.iter() {
3904 if let None = channel_state.as_ref().unwrap().short_to_id.get(&htlc.prev_hop.short_channel_id) {
3908 if expected_amt_msat.is_some() && expected_amt_msat != Some(htlc.total_msat) {
3909 log_error!(self.logger, "Somehow ended up with an MPP payment with different total amounts - this should not be reachable!");
3910 debug_assert!(false);
3914 expected_amt_msat = Some(htlc.total_msat);
3915 if let OnionPayload::Spontaneous(_) = &htlc.onion_payload {
3916 // We don't currently support MPP for spontaneous payments, so just check
3917 // that there's one payment here and move on.
3918 if sources.len() != 1 {
3919 log_error!(self.logger, "Somehow ended up with an MPP spontaneous payment - this should not be reachable!");
3920 debug_assert!(false);
3926 claimable_amt_msat += htlc.value;
3928 if sources.is_empty() || expected_amt_msat.is_none() {
3929 log_info!(self.logger, "Attempted to claim an incomplete payment which no longer had any available HTLCs!");
3932 if claimable_amt_msat != expected_amt_msat.unwrap() {
3933 log_info!(self.logger, "Attempted to claim an incomplete payment, expected {} msat, had {} available to claim.",
3934 expected_amt_msat.unwrap(), claimable_amt_msat);
3938 let mut errs = Vec::new();
3939 let mut claimed_any_htlcs = false;
3940 for htlc in sources.drain(..) {
3942 if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
3943 let mut htlc_msat_height_data = byte_utils::be64_to_array(htlc.value).to_vec();
3944 htlc_msat_height_data.extend_from_slice(&byte_utils::be32_to_array(
3945 self.best_block.read().unwrap().height()));
3946 self.fail_htlc_backwards_internal(channel_state.take().unwrap(),
3947 HTLCSource::PreviousHopData(htlc.prev_hop), &payment_hash,
3948 HTLCFailReason::Reason { failure_code: 0x4000|15, data: htlc_msat_height_data });
3950 match self.claim_funds_from_hop(channel_state.as_mut().unwrap(), htlc.prev_hop, payment_preimage) {
3951 ClaimFundsFromHop::MonitorUpdateFail(pk, err, _) => {
3952 if let msgs::ErrorAction::IgnoreError = err.err.action {
3953 // We got a temporary failure updating monitor, but will claim the
3954 // HTLC when the monitor updating is restored (or on chain).
3955 log_error!(self.logger, "Temporary failure claiming HTLC, treating as success: {}", err.err.err);
3956 claimed_any_htlcs = true;
3957 } else { errs.push((pk, err)); }
3959 ClaimFundsFromHop::PrevHopForceClosed => unreachable!("We already checked for channel existence, we can't fail here!"),
3960 ClaimFundsFromHop::DuplicateClaim => {
3961 // While we should never get here in most cases, if we do, it likely
3962 // indicates that the HTLC was timed out some time ago and is no longer
3963 // available to be claimed. Thus, it does not make sense to set
3964 // `claimed_any_htlcs`.
3966 ClaimFundsFromHop::Success(_) => claimed_any_htlcs = true,
3971 if claimed_any_htlcs {
3972 self.pending_events.lock().unwrap().push(events::Event::PaymentClaimed {
3974 purpose: payment_purpose,
3975 amount_msat: claimable_amt_msat,
3979 // Now that we've done the entire above loop in one lock, we can handle any errors
3980 // which were generated.
3981 channel_state.take();
3983 for (counterparty_node_id, err) in errs.drain(..) {
3984 let res: Result<(), _> = Err(err);
3985 let _ = handle_error!(self, res, counterparty_node_id);
3990 fn claim_funds_from_hop(&self, channel_state_lock: &mut MutexGuard<ChannelHolder<Signer>>, prev_hop: HTLCPreviousHopData, payment_preimage: PaymentPreimage) -> ClaimFundsFromHop {
3991 //TODO: Delay the claimed_funds relaying just like we do outbound relay!
3992 let channel_state = &mut **channel_state_lock;
3993 let chan_id = match channel_state.short_to_id.get(&prev_hop.short_channel_id) {
3994 Some(chan_id) => chan_id.clone(),
3996 return ClaimFundsFromHop::PrevHopForceClosed
4000 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(chan_id) {
4001 match chan.get_mut().get_update_fulfill_htlc_and_commit(prev_hop.htlc_id, payment_preimage, &self.logger) {
4002 Ok(msgs_monitor_option) => {
4003 if let UpdateFulfillCommitFetch::NewClaim { msgs, htlc_value_msat, monitor_update } = msgs_monitor_option {
4004 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
4005 log_given_level!(self.logger, if e == ChannelMonitorUpdateErr::PermanentFailure { Level::Error } else { Level::Debug },
4006 "Failed to update channel monitor with preimage {:?}: {:?}",
4007 payment_preimage, e);
4008 return ClaimFundsFromHop::MonitorUpdateFail(
4009 chan.get().get_counterparty_node_id(),
4010 handle_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, msgs.is_some()).unwrap_err(),
4011 Some(htlc_value_msat)
4014 if let Some((msg, commitment_signed)) = msgs {
4015 log_debug!(self.logger, "Claiming funds for HTLC with preimage {} resulted in a commitment_signed for channel {}",
4016 log_bytes!(payment_preimage.0), log_bytes!(chan.get().channel_id()));
4017 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
4018 node_id: chan.get().get_counterparty_node_id(),
4019 updates: msgs::CommitmentUpdate {
4020 update_add_htlcs: Vec::new(),
4021 update_fulfill_htlcs: vec![msg],
4022 update_fail_htlcs: Vec::new(),
4023 update_fail_malformed_htlcs: Vec::new(),
4029 return ClaimFundsFromHop::Success(htlc_value_msat);
4031 return ClaimFundsFromHop::DuplicateClaim;
4034 Err((e, monitor_update)) => {
4035 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
4036 log_given_level!(self.logger, if e == ChannelMonitorUpdateErr::PermanentFailure { Level::Error } else { Level::Info },
4037 "Failed to update channel monitor with preimage {:?} immediately prior to force-close: {:?}",
4038 payment_preimage, e);
4040 let counterparty_node_id = chan.get().get_counterparty_node_id();
4041 let (drop, res) = convert_chan_err!(self, e, channel_state.short_to_id, chan.get_mut(), &chan_id);
4043 chan.remove_entry();
4045 return ClaimFundsFromHop::MonitorUpdateFail(counterparty_node_id, res, None);
4048 } else { unreachable!(); }
4051 fn finalize_claims(&self, mut sources: Vec<HTLCSource>) {
4052 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
4053 let mut pending_events = self.pending_events.lock().unwrap();
4054 for source in sources.drain(..) {
4055 if let HTLCSource::OutboundRoute { session_priv, payment_id, path, .. } = source {
4056 let mut session_priv_bytes = [0; 32];
4057 session_priv_bytes.copy_from_slice(&session_priv[..]);
4058 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
4059 assert!(payment.get().is_fulfilled());
4060 if payment.get_mut().remove(&session_priv_bytes, None) {
4061 pending_events.push(
4062 events::Event::PaymentPathSuccessful {
4064 payment_hash: payment.get().payment_hash(),
4069 if payment.get().remaining_parts() == 0 {
4077 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]) {
4079 HTLCSource::OutboundRoute { session_priv, payment_id, path, .. } => {
4080 mem::drop(channel_state_lock);
4081 let mut session_priv_bytes = [0; 32];
4082 session_priv_bytes.copy_from_slice(&session_priv[..]);
4083 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
4084 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
4085 let mut pending_events = self.pending_events.lock().unwrap();
4086 if !payment.get().is_fulfilled() {
4087 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
4088 let fee_paid_msat = payment.get().get_pending_fee_msat();
4089 pending_events.push(
4090 events::Event::PaymentSent {
4091 payment_id: Some(payment_id),
4097 payment.get_mut().mark_fulfilled();
4101 // We currently immediately remove HTLCs which were fulfilled on-chain.
4102 // This could potentially lead to removing a pending payment too early,
4103 // with a reorg of one block causing us to re-add the fulfilled payment on
4105 // TODO: We should have a second monitor event that informs us of payments
4106 // irrevocably fulfilled.
4107 if payment.get_mut().remove(&session_priv_bytes, Some(&path)) {
4108 let payment_hash = Some(PaymentHash(Sha256::hash(&payment_preimage.0).into_inner()));
4109 pending_events.push(
4110 events::Event::PaymentPathSuccessful {
4118 if payment.get().remaining_parts() == 0 {
4123 log_trace!(self.logger, "Received duplicative fulfill for HTLC with payment_preimage {}", log_bytes!(payment_preimage.0));
4126 HTLCSource::PreviousHopData(hop_data) => {
4127 let prev_outpoint = hop_data.outpoint;
4128 let res = self.claim_funds_from_hop(&mut channel_state_lock, hop_data, payment_preimage);
4129 let claimed_htlc = if let ClaimFundsFromHop::DuplicateClaim = res { false } else { true };
4130 let htlc_claim_value_msat = match res {
4131 ClaimFundsFromHop::MonitorUpdateFail(_, _, amt_opt) => amt_opt,
4132 ClaimFundsFromHop::Success(amt) => Some(amt),
4135 if let ClaimFundsFromHop::PrevHopForceClosed = res {
4136 let preimage_update = ChannelMonitorUpdate {
4137 update_id: CLOSED_CHANNEL_UPDATE_ID,
4138 updates: vec![ChannelMonitorUpdateStep::PaymentPreimage {
4139 payment_preimage: payment_preimage.clone(),
4142 // We update the ChannelMonitor on the backward link, after
4143 // receiving an offchain preimage event from the forward link (the
4144 // event being update_fulfill_htlc).
4145 if let Err(e) = self.chain_monitor.update_channel(prev_outpoint, preimage_update) {
4146 log_error!(self.logger, "Critical error: failed to update channel monitor with preimage {:?}: {:?}",
4147 payment_preimage, e);
4149 // Note that we do *not* set `claimed_htlc` to false here. In fact, this
4150 // totally could be a duplicate claim, but we have no way of knowing
4151 // without interrogating the `ChannelMonitor` we've provided the above
4152 // update to. Instead, we simply document in `PaymentForwarded` that this
4155 mem::drop(channel_state_lock);
4156 if let ClaimFundsFromHop::MonitorUpdateFail(pk, err, _) = res {
4157 let result: Result<(), _> = Err(err);
4158 let _ = handle_error!(self, result, pk);
4162 if let Some(forwarded_htlc_value) = forwarded_htlc_value_msat {
4163 let fee_earned_msat = if let Some(claimed_htlc_value) = htlc_claim_value_msat {
4164 Some(claimed_htlc_value - forwarded_htlc_value)
4167 let mut pending_events = self.pending_events.lock().unwrap();
4168 let prev_channel_id = Some(prev_outpoint.to_channel_id());
4169 let next_channel_id = Some(next_channel_id);
4171 pending_events.push(events::Event::PaymentForwarded {
4173 claim_from_onchain_tx: from_onchain,
4183 /// Gets the node_id held by this ChannelManager
4184 pub fn get_our_node_id(&self) -> PublicKey {
4185 self.our_network_pubkey.clone()
4188 fn channel_monitor_updated(&self, funding_txo: &OutPoint, highest_applied_update_id: u64) {
4189 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4191 let chan_restoration_res;
4192 let (mut pending_failures, finalized_claims) = {
4193 let mut channel_lock = self.channel_state.lock().unwrap();
4194 let channel_state = &mut *channel_lock;
4195 let mut channel = match channel_state.by_id.entry(funding_txo.to_channel_id()) {
4196 hash_map::Entry::Occupied(chan) => chan,
4197 hash_map::Entry::Vacant(_) => return,
4199 if !channel.get().is_awaiting_monitor_update() || channel.get().get_latest_monitor_update_id() != highest_applied_update_id {
4203 let updates = channel.get_mut().monitor_updating_restored(&self.logger, self.get_our_node_id(), self.genesis_hash, self.best_block.read().unwrap().height());
4204 let channel_update = if updates.channel_ready.is_some() && channel.get().is_usable() {
4205 // We only send a channel_update in the case where we are just now sending a
4206 // channel_ready and the channel is in a usable state. We may re-send a
4207 // channel_update later through the announcement_signatures process for public
4208 // channels, but there's no reason not to just inform our counterparty of our fees
4210 if let Ok(msg) = self.get_channel_update_for_unicast(channel.get()) {
4211 Some(events::MessageSendEvent::SendChannelUpdate {
4212 node_id: channel.get().get_counterparty_node_id(),
4217 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);
4218 if let Some(upd) = channel_update {
4219 channel_state.pending_msg_events.push(upd);
4221 (updates.failed_htlcs, updates.finalized_claimed_htlcs)
4223 post_handle_chan_restoration!(self, chan_restoration_res);
4224 self.finalize_claims(finalized_claims);
4225 for failure in pending_failures.drain(..) {
4226 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), failure.0, &failure.1, failure.2);
4230 /// Accepts a request to open a channel after a [`Event::OpenChannelRequest`].
4232 /// The `temporary_channel_id` parameter indicates which inbound channel should be accepted,
4233 /// and the `counterparty_node_id` parameter is the id of the peer which has requested to open
4236 /// The `user_channel_id` parameter will be provided back in
4237 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
4238 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
4240 /// Note that this method will return an error and reject the channel, if it requires support
4241 /// for zero confirmations. Instead, `accept_inbound_channel_from_trusted_peer_0conf` must be
4242 /// used to accept such channels.
4244 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
4245 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
4246 pub fn accept_inbound_channel(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, user_channel_id: u64) -> Result<(), APIError> {
4247 self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, false, user_channel_id)
4250 /// Accepts a request to open a channel after a [`events::Event::OpenChannelRequest`], treating
4251 /// it as confirmed immediately.
4253 /// The `user_channel_id` parameter will be provided back in
4254 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
4255 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
4257 /// Unlike [`ChannelManager::accept_inbound_channel`], this method accepts the incoming channel
4258 /// and (if the counterparty agrees), enables forwarding of payments immediately.
4260 /// This fully trusts that the counterparty has honestly and correctly constructed the funding
4261 /// transaction and blindly assumes that it will eventually confirm.
4263 /// If it does not confirm before we decide to close the channel, or if the funding transaction
4264 /// does not pay to the correct script the correct amount, *you will lose funds*.
4266 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
4267 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
4268 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> {
4269 self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, true, user_channel_id)
4272 fn do_accept_inbound_channel(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, accept_0conf: bool, user_channel_id: u64) -> Result<(), APIError> {
4273 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4275 let mut channel_state_lock = self.channel_state.lock().unwrap();
4276 let channel_state = &mut *channel_state_lock;
4277 match channel_state.by_id.entry(temporary_channel_id.clone()) {
4278 hash_map::Entry::Occupied(mut channel) => {
4279 if !channel.get().inbound_is_awaiting_accept() {
4280 return Err(APIError::APIMisuseError { err: "The channel isn't currently awaiting to be accepted.".to_owned() });
4282 if *counterparty_node_id != channel.get().get_counterparty_node_id() {
4283 return Err(APIError::APIMisuseError { err: "The passed counterparty_node_id doesn't match the channel's counterparty node_id".to_owned() });
4286 channel.get_mut().set_0conf();
4287 } else if channel.get().get_channel_type().requires_zero_conf() {
4288 let send_msg_err_event = events::MessageSendEvent::HandleError {
4289 node_id: channel.get().get_counterparty_node_id(),
4290 action: msgs::ErrorAction::SendErrorMessage{
4291 msg: msgs::ErrorMessage { channel_id: temporary_channel_id.clone(), data: "No zero confirmation channels accepted".to_owned(), }
4294 channel_state.pending_msg_events.push(send_msg_err_event);
4295 let _ = remove_channel!(self, channel_state, channel);
4296 return Err(APIError::APIMisuseError { err: "Please use accept_inbound_channel_from_trusted_peer_0conf to accept channels with zero confirmations.".to_owned() });
4299 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
4300 node_id: channel.get().get_counterparty_node_id(),
4301 msg: channel.get_mut().accept_inbound_channel(user_channel_id),
4304 hash_map::Entry::Vacant(_) => {
4305 return Err(APIError::ChannelUnavailable { err: "Can't accept a channel that doesn't exist".to_owned() });
4311 fn internal_open_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::OpenChannel) -> Result<(), MsgHandleErrInternal> {
4312 if msg.chain_hash != self.genesis_hash {
4313 return Err(MsgHandleErrInternal::send_err_msg_no_close("Unknown genesis block hash".to_owned(), msg.temporary_channel_id.clone()));
4316 if !self.default_configuration.accept_inbound_channels {
4317 return Err(MsgHandleErrInternal::send_err_msg_no_close("No inbound channels accepted".to_owned(), msg.temporary_channel_id.clone()));
4320 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
4321 let mut channel = match Channel::new_from_req(&self.fee_estimator, &self.keys_manager,
4322 counterparty_node_id.clone(), &their_features, msg, 0, &self.default_configuration,
4323 self.best_block.read().unwrap().height(), &self.logger, outbound_scid_alias)
4326 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
4327 return Err(MsgHandleErrInternal::from_chan_no_close(e, msg.temporary_channel_id));
4331 let mut channel_state_lock = self.channel_state.lock().unwrap();
4332 let channel_state = &mut *channel_state_lock;
4333 match channel_state.by_id.entry(channel.channel_id()) {
4334 hash_map::Entry::Occupied(_) => {
4335 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
4336 return Err(MsgHandleErrInternal::send_err_msg_no_close("temporary_channel_id collision!".to_owned(), msg.temporary_channel_id.clone()))
4338 hash_map::Entry::Vacant(entry) => {
4339 if !self.default_configuration.manually_accept_inbound_channels {
4340 if channel.get_channel_type().requires_zero_conf() {
4341 return Err(MsgHandleErrInternal::send_err_msg_no_close("No zero confirmation channels accepted".to_owned(), msg.temporary_channel_id.clone()));
4343 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
4344 node_id: counterparty_node_id.clone(),
4345 msg: channel.accept_inbound_channel(0),
4348 let mut pending_events = self.pending_events.lock().unwrap();
4349 pending_events.push(
4350 events::Event::OpenChannelRequest {
4351 temporary_channel_id: msg.temporary_channel_id.clone(),
4352 counterparty_node_id: counterparty_node_id.clone(),
4353 funding_satoshis: msg.funding_satoshis,
4354 push_msat: msg.push_msat,
4355 channel_type: channel.get_channel_type().clone(),
4360 entry.insert(channel);
4366 fn internal_accept_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::AcceptChannel) -> Result<(), MsgHandleErrInternal> {
4367 let (value, output_script, user_id) = {
4368 let mut channel_lock = self.channel_state.lock().unwrap();
4369 let channel_state = &mut *channel_lock;
4370 match channel_state.by_id.entry(msg.temporary_channel_id) {
4371 hash_map::Entry::Occupied(mut chan) => {
4372 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4373 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.temporary_channel_id));
4375 try_chan_entry!(self, chan.get_mut().accept_channel(&msg, &self.default_configuration.channel_handshake_limits, &their_features), channel_state, chan);
4376 (chan.get().get_value_satoshis(), chan.get().get_funding_redeemscript().to_v0_p2wsh(), chan.get().get_user_id())
4378 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.temporary_channel_id))
4381 let mut pending_events = self.pending_events.lock().unwrap();
4382 pending_events.push(events::Event::FundingGenerationReady {
4383 temporary_channel_id: msg.temporary_channel_id,
4384 counterparty_node_id: *counterparty_node_id,
4385 channel_value_satoshis: value,
4387 user_channel_id: user_id,
4392 fn internal_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), MsgHandleErrInternal> {
4393 let ((funding_msg, monitor, mut channel_ready), mut chan) = {
4394 let best_block = *self.best_block.read().unwrap();
4395 let mut channel_lock = self.channel_state.lock().unwrap();
4396 let channel_state = &mut *channel_lock;
4397 match channel_state.by_id.entry(msg.temporary_channel_id.clone()) {
4398 hash_map::Entry::Occupied(mut chan) => {
4399 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4400 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.temporary_channel_id));
4402 (try_chan_entry!(self, chan.get_mut().funding_created(msg, best_block, &self.logger), channel_state, chan), chan.remove())
4404 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.temporary_channel_id))
4407 // Because we have exclusive ownership of the channel here we can release the channel_state
4408 // lock before watch_channel
4409 if let Err(e) = self.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor) {
4411 ChannelMonitorUpdateErr::PermanentFailure => {
4412 // Note that we reply with the new channel_id in error messages if we gave up on the
4413 // channel, not the temporary_channel_id. This is compatible with ourselves, but the
4414 // spec is somewhat ambiguous here. Not a huge deal since we'll send error messages for
4415 // any messages referencing a previously-closed channel anyway.
4416 // We do not do a force-close here as that would generate a monitor update for
4417 // a monitor that we didn't manage to store (and that we don't care about - we
4418 // don't respond with the funding_signed so the channel can never go on chain).
4419 let (_monitor_update, failed_htlcs) = chan.force_shutdown(true);
4420 assert!(failed_htlcs.is_empty());
4421 return Err(MsgHandleErrInternal::send_err_msg_no_close("ChannelMonitor storage failure".to_owned(), funding_msg.channel_id));
4423 ChannelMonitorUpdateErr::TemporaryFailure => {
4424 // There's no problem signing a counterparty's funding transaction if our monitor
4425 // hasn't persisted to disk yet - we can't lose money on a transaction that we haven't
4426 // accepted payment from yet. We do, however, need to wait to send our channel_ready
4427 // until we have persisted our monitor.
4428 chan.monitor_update_failed(false, false, channel_ready.is_some(), Vec::new(), Vec::new(), Vec::new());
4429 channel_ready = None; // Don't send the channel_ready now
4433 let mut channel_state_lock = self.channel_state.lock().unwrap();
4434 let channel_state = &mut *channel_state_lock;
4435 match channel_state.by_id.entry(funding_msg.channel_id) {
4436 hash_map::Entry::Occupied(_) => {
4437 return Err(MsgHandleErrInternal::send_err_msg_no_close("Already had channel with the new channel_id".to_owned(), funding_msg.channel_id))
4439 hash_map::Entry::Vacant(e) => {
4440 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
4441 node_id: counterparty_node_id.clone(),
4444 if let Some(msg) = channel_ready {
4445 send_channel_ready!(channel_state.short_to_id, channel_state.pending_msg_events, chan, msg);
4453 fn internal_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), MsgHandleErrInternal> {
4455 let best_block = *self.best_block.read().unwrap();
4456 let mut channel_lock = self.channel_state.lock().unwrap();
4457 let channel_state = &mut *channel_lock;
4458 match channel_state.by_id.entry(msg.channel_id) {
4459 hash_map::Entry::Occupied(mut chan) => {
4460 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4461 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4463 let (monitor, funding_tx, channel_ready) = match chan.get_mut().funding_signed(&msg, best_block, &self.logger) {
4464 Ok(update) => update,
4465 Err(e) => try_chan_entry!(self, Err(e), channel_state, chan),
4467 if let Err(e) = self.chain_monitor.watch_channel(chan.get().get_funding_txo().unwrap(), monitor) {
4468 let mut res = handle_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::RevokeAndACKFirst, channel_ready.is_some(), OPTIONALLY_RESEND_FUNDING_LOCKED);
4469 if let Err(MsgHandleErrInternal { ref mut shutdown_finish, .. }) = res {
4470 // We weren't able to watch the channel to begin with, so no updates should be made on
4471 // it. Previously, full_stack_target found an (unreachable) panic when the
4472 // monitor update contained within `shutdown_finish` was applied.
4473 if let Some((ref mut shutdown_finish, _)) = shutdown_finish {
4474 shutdown_finish.0.take();
4479 if let Some(msg) = channel_ready {
4480 send_channel_ready!(channel_state.short_to_id, channel_state.pending_msg_events, chan.get(), msg);
4484 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4487 log_info!(self.logger, "Broadcasting funding transaction with txid {}", funding_tx.txid());
4488 self.tx_broadcaster.broadcast_transaction(&funding_tx);
4492 fn internal_channel_ready(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReady) -> Result<(), MsgHandleErrInternal> {
4493 let mut channel_state_lock = self.channel_state.lock().unwrap();
4494 let channel_state = &mut *channel_state_lock;
4495 match channel_state.by_id.entry(msg.channel_id) {
4496 hash_map::Entry::Occupied(mut chan) => {
4497 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4498 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4500 let announcement_sigs_opt = try_chan_entry!(self, chan.get_mut().channel_ready(&msg, self.get_our_node_id(),
4501 self.genesis_hash.clone(), &self.best_block.read().unwrap(), &self.logger), channel_state, chan);
4502 if let Some(announcement_sigs) = announcement_sigs_opt {
4503 log_trace!(self.logger, "Sending announcement_signatures for channel {}", log_bytes!(chan.get().channel_id()));
4504 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
4505 node_id: counterparty_node_id.clone(),
4506 msg: announcement_sigs,
4508 } else if chan.get().is_usable() {
4509 // If we're sending an announcement_signatures, we'll send the (public)
4510 // channel_update after sending a channel_announcement when we receive our
4511 // counterparty's announcement_signatures. Thus, we only bother to send a
4512 // channel_update here if the channel is not public, i.e. we're not sending an
4513 // announcement_signatures.
4514 log_trace!(self.logger, "Sending private initial channel_update for our counterparty on channel {}", log_bytes!(chan.get().channel_id()));
4515 if let Ok(msg) = self.get_channel_update_for_unicast(chan.get()) {
4516 channel_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
4517 node_id: counterparty_node_id.clone(),
4524 hash_map::Entry::Vacant(_) => Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4528 fn internal_shutdown(&self, counterparty_node_id: &PublicKey, their_features: &InitFeatures, msg: &msgs::Shutdown) -> Result<(), MsgHandleErrInternal> {
4529 let mut dropped_htlcs: Vec<(HTLCSource, PaymentHash)>;
4530 let result: Result<(), _> = loop {
4531 let mut channel_state_lock = self.channel_state.lock().unwrap();
4532 let channel_state = &mut *channel_state_lock;
4534 match channel_state.by_id.entry(msg.channel_id.clone()) {
4535 hash_map::Entry::Occupied(mut chan_entry) => {
4536 if chan_entry.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));
4540 if !chan_entry.get().received_shutdown() {
4541 log_info!(self.logger, "Received a shutdown message from our counterparty for channel {}{}.",
4542 log_bytes!(msg.channel_id),
4543 if chan_entry.get().sent_shutdown() { " after we initiated shutdown" } else { "" });
4546 let (shutdown, monitor_update, htlcs) = try_chan_entry!(self, chan_entry.get_mut().shutdown(&self.keys_manager, &their_features, &msg), channel_state, chan_entry);
4547 dropped_htlcs = htlcs;
4549 // Update the monitor with the shutdown script if necessary.
4550 if let Some(monitor_update) = monitor_update {
4551 if let Err(e) = self.chain_monitor.update_channel(chan_entry.get().get_funding_txo().unwrap(), monitor_update) {
4552 let (result, is_permanent) =
4553 handle_monitor_err!(self, e, channel_state.short_to_id, chan_entry.get_mut(), RAACommitmentOrder::CommitmentFirst, chan_entry.key(), NO_UPDATE);
4555 remove_channel!(self, channel_state, chan_entry);
4561 if let Some(msg) = shutdown {
4562 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
4563 node_id: *counterparty_node_id,
4570 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4573 for htlc_source in dropped_htlcs.drain(..) {
4574 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() });
4577 let _ = handle_error!(self, result, *counterparty_node_id);
4581 fn internal_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<(), MsgHandleErrInternal> {
4582 let (tx, chan_option) = {
4583 let mut channel_state_lock = self.channel_state.lock().unwrap();
4584 let channel_state = &mut *channel_state_lock;
4585 match channel_state.by_id.entry(msg.channel_id.clone()) {
4586 hash_map::Entry::Occupied(mut chan_entry) => {
4587 if chan_entry.get().get_counterparty_node_id() != *counterparty_node_id {
4588 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4590 let (closing_signed, tx) = try_chan_entry!(self, chan_entry.get_mut().closing_signed(&self.fee_estimator, &msg), channel_state, chan_entry);
4591 if let Some(msg) = closing_signed {
4592 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
4593 node_id: counterparty_node_id.clone(),
4598 // We're done with this channel, we've got a signed closing transaction and
4599 // will send the closing_signed back to the remote peer upon return. This
4600 // also implies there are no pending HTLCs left on the channel, so we can
4601 // fully delete it from tracking (the channel monitor is still around to
4602 // watch for old state broadcasts)!
4603 (tx, Some(remove_channel!(self, channel_state, chan_entry)))
4604 } else { (tx, None) }
4606 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4609 if let Some(broadcast_tx) = tx {
4610 log_info!(self.logger, "Broadcasting {}", log_tx!(broadcast_tx));
4611 self.tx_broadcaster.broadcast_transaction(&broadcast_tx);
4613 if let Some(chan) = chan_option {
4614 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
4615 let mut channel_state = self.channel_state.lock().unwrap();
4616 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
4620 self.issue_channel_close_events(&chan, ClosureReason::CooperativeClosure);
4625 fn internal_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), MsgHandleErrInternal> {
4626 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
4627 //determine the state of the payment based on our response/if we forward anything/the time
4628 //we take to respond. We should take care to avoid allowing such an attack.
4630 //TODO: There exists a further attack where a node may garble the onion data, forward it to
4631 //us repeatedly garbled in different ways, and compare our error messages, which are
4632 //encrypted with the same key. It's not immediately obvious how to usefully exploit that,
4633 //but we should prevent it anyway.
4635 let (pending_forward_info, mut channel_state_lock) = self.decode_update_add_htlc_onion(msg);
4636 let channel_state = &mut *channel_state_lock;
4638 match channel_state.by_id.entry(msg.channel_id) {
4639 hash_map::Entry::Occupied(mut chan) => {
4640 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4641 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4644 let create_pending_htlc_status = |chan: &Channel<Signer>, pending_forward_info: PendingHTLCStatus, error_code: u16| {
4645 // If the update_add is completely bogus, the call will Err and we will close,
4646 // but if we've sent a shutdown and they haven't acknowledged it yet, we just
4647 // want to reject the new HTLC and fail it backwards instead of forwarding.
4648 match pending_forward_info {
4649 PendingHTLCStatus::Forward(PendingHTLCInfo { ref incoming_shared_secret, .. }) => {
4650 let reason = if (error_code & 0x1000) != 0 {
4651 let (real_code, error_data) = self.get_htlc_inbound_temp_fail_err_and_data(error_code, chan);
4652 onion_utils::build_first_hop_failure_packet(incoming_shared_secret, real_code, &error_data)
4654 onion_utils::build_first_hop_failure_packet(incoming_shared_secret, error_code, &[])
4656 let msg = msgs::UpdateFailHTLC {
4657 channel_id: msg.channel_id,
4658 htlc_id: msg.htlc_id,
4661 PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msg))
4663 _ => pending_forward_info
4666 try_chan_entry!(self, chan.get_mut().update_add_htlc(&msg, pending_forward_info, create_pending_htlc_status, &self.logger), channel_state, chan);
4668 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4673 fn internal_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), MsgHandleErrInternal> {
4674 let mut channel_lock = self.channel_state.lock().unwrap();
4675 let (htlc_source, forwarded_htlc_value) = {
4676 let channel_state = &mut *channel_lock;
4677 match channel_state.by_id.entry(msg.channel_id) {
4678 hash_map::Entry::Occupied(mut chan) => {
4679 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4680 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4682 try_chan_entry!(self, chan.get_mut().update_fulfill_htlc(&msg), channel_state, chan)
4684 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4687 self.claim_funds_internal(channel_lock, htlc_source, msg.payment_preimage.clone(), Some(forwarded_htlc_value), false, msg.channel_id);
4691 fn internal_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), MsgHandleErrInternal> {
4692 let mut channel_lock = self.channel_state.lock().unwrap();
4693 let channel_state = &mut *channel_lock;
4694 match channel_state.by_id.entry(msg.channel_id) {
4695 hash_map::Entry::Occupied(mut chan) => {
4696 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4697 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4699 try_chan_entry!(self, chan.get_mut().update_fail_htlc(&msg, HTLCFailReason::LightningError { err: msg.reason.clone() }), channel_state, chan);
4701 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4706 fn internal_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), MsgHandleErrInternal> {
4707 let mut channel_lock = self.channel_state.lock().unwrap();
4708 let channel_state = &mut *channel_lock;
4709 match channel_state.by_id.entry(msg.channel_id) {
4710 hash_map::Entry::Occupied(mut chan) => {
4711 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4712 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4714 if (msg.failure_code & 0x8000) == 0 {
4715 let chan_err: ChannelError = ChannelError::Close("Got update_fail_malformed_htlc with BADONION not set".to_owned());
4716 try_chan_entry!(self, Err(chan_err), channel_state, chan);
4718 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);
4721 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4725 fn internal_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), MsgHandleErrInternal> {
4726 let mut channel_state_lock = self.channel_state.lock().unwrap();
4727 let channel_state = &mut *channel_state_lock;
4728 match channel_state.by_id.entry(msg.channel_id) {
4729 hash_map::Entry::Occupied(mut chan) => {
4730 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4731 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4733 let (revoke_and_ack, commitment_signed, monitor_update) =
4734 match chan.get_mut().commitment_signed(&msg, &self.logger) {
4735 Err((None, e)) => try_chan_entry!(self, Err(e), channel_state, chan),
4736 Err((Some(update), e)) => {
4737 assert!(chan.get().is_awaiting_monitor_update());
4738 let _ = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), update);
4739 try_chan_entry!(self, Err(e), channel_state, chan);
4744 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
4745 return_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::RevokeAndACKFirst, true, commitment_signed.is_some());
4747 channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
4748 node_id: counterparty_node_id.clone(),
4749 msg: revoke_and_ack,
4751 if let Some(msg) = commitment_signed {
4752 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
4753 node_id: counterparty_node_id.clone(),
4754 updates: msgs::CommitmentUpdate {
4755 update_add_htlcs: Vec::new(),
4756 update_fulfill_htlcs: Vec::new(),
4757 update_fail_htlcs: Vec::new(),
4758 update_fail_malformed_htlcs: Vec::new(),
4760 commitment_signed: msg,
4766 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4771 fn forward_htlcs(&self, per_source_pending_forwards: &mut [(u64, OutPoint, Vec<(PendingHTLCInfo, u64)>)]) {
4772 for &mut (prev_short_channel_id, prev_funding_outpoint, ref mut pending_forwards) in per_source_pending_forwards {
4773 let mut forward_event = None;
4774 if !pending_forwards.is_empty() {
4775 let mut channel_state = self.channel_state.lock().unwrap();
4776 if channel_state.forward_htlcs.is_empty() {
4777 forward_event = Some(Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS))
4779 for (forward_info, prev_htlc_id) in pending_forwards.drain(..) {
4780 match channel_state.forward_htlcs.entry(match forward_info.routing {
4781 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
4782 PendingHTLCRouting::Receive { .. } => 0,
4783 PendingHTLCRouting::ReceiveKeysend { .. } => 0,
4785 hash_map::Entry::Occupied(mut entry) => {
4786 entry.get_mut().push(HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_funding_outpoint,
4787 prev_htlc_id, forward_info });
4789 hash_map::Entry::Vacant(entry) => {
4790 entry.insert(vec!(HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_funding_outpoint,
4791 prev_htlc_id, forward_info }));
4796 match forward_event {
4798 let mut pending_events = self.pending_events.lock().unwrap();
4799 pending_events.push(events::Event::PendingHTLCsForwardable {
4800 time_forwardable: time
4808 fn internal_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), MsgHandleErrInternal> {
4809 let mut htlcs_to_fail = Vec::new();
4811 let mut channel_state_lock = self.channel_state.lock().unwrap();
4812 let channel_state = &mut *channel_state_lock;
4813 match channel_state.by_id.entry(msg.channel_id) {
4814 hash_map::Entry::Occupied(mut chan) => {
4815 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4816 break Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4818 let was_frozen_for_monitor = chan.get().is_awaiting_monitor_update();
4819 let raa_updates = break_chan_entry!(self,
4820 chan.get_mut().revoke_and_ack(&msg, &self.logger), channel_state, chan);
4821 htlcs_to_fail = raa_updates.holding_cell_failed_htlcs;
4822 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), raa_updates.monitor_update) {
4823 if was_frozen_for_monitor {
4824 assert!(raa_updates.commitment_update.is_none());
4825 assert!(raa_updates.accepted_htlcs.is_empty());
4826 assert!(raa_updates.failed_htlcs.is_empty());
4827 assert!(raa_updates.finalized_claimed_htlcs.is_empty());
4828 break Err(MsgHandleErrInternal::ignore_no_close("Previous monitor update failure prevented responses to RAA".to_owned()));
4830 if let Err(e) = handle_monitor_err!(self, e, channel_state, chan,
4831 RAACommitmentOrder::CommitmentFirst, false,
4832 raa_updates.commitment_update.is_some(), false,
4833 raa_updates.accepted_htlcs, raa_updates.failed_htlcs,
4834 raa_updates.finalized_claimed_htlcs) {
4836 } else { unreachable!(); }
4839 if let Some(updates) = raa_updates.commitment_update {
4840 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
4841 node_id: counterparty_node_id.clone(),
4845 break Ok((raa_updates.accepted_htlcs, raa_updates.failed_htlcs,
4846 raa_updates.finalized_claimed_htlcs,
4847 chan.get().get_short_channel_id()
4848 .unwrap_or(chan.get().outbound_scid_alias()),
4849 chan.get().get_funding_txo().unwrap()))
4851 hash_map::Entry::Vacant(_) => break Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4854 self.fail_holding_cell_htlcs(htlcs_to_fail, msg.channel_id, counterparty_node_id);
4856 Ok((pending_forwards, mut pending_failures, finalized_claim_htlcs,
4857 short_channel_id, channel_outpoint)) =>
4859 for failure in pending_failures.drain(..) {
4860 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), failure.0, &failure.1, failure.2);
4862 self.forward_htlcs(&mut [(short_channel_id, channel_outpoint, pending_forwards)]);
4863 self.finalize_claims(finalized_claim_htlcs);
4870 fn internal_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), MsgHandleErrInternal> {
4871 let mut channel_lock = self.channel_state.lock().unwrap();
4872 let channel_state = &mut *channel_lock;
4873 match channel_state.by_id.entry(msg.channel_id) {
4874 hash_map::Entry::Occupied(mut chan) => {
4875 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4876 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4878 try_chan_entry!(self, chan.get_mut().update_fee(&self.fee_estimator, &msg), channel_state, chan);
4880 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4885 fn internal_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), MsgHandleErrInternal> {
4886 let mut channel_state_lock = self.channel_state.lock().unwrap();
4887 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 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4894 if !chan.get().is_usable() {
4895 return Err(MsgHandleErrInternal::from_no_close(LightningError{err: "Got an announcement_signatures before we were ready for it".to_owned(), action: msgs::ErrorAction::IgnoreError}));
4898 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
4899 msg: try_chan_entry!(self, chan.get_mut().announcement_signatures(
4900 self.get_our_node_id(), self.genesis_hash.clone(), self.best_block.read().unwrap().height(), msg), channel_state, chan),
4901 // Note that announcement_signatures fails if the channel cannot be announced,
4902 // so get_channel_update_for_broadcast will never fail by the time we get here.
4903 update_msg: self.get_channel_update_for_broadcast(chan.get()).unwrap(),
4906 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4911 /// Returns ShouldPersist if anything changed, otherwise either SkipPersist or an Err.
4912 fn internal_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) -> Result<NotifyOption, MsgHandleErrInternal> {
4913 let mut channel_state_lock = self.channel_state.lock().unwrap();
4914 let channel_state = &mut *channel_state_lock;
4915 let chan_id = match channel_state.short_to_id.get(&msg.contents.short_channel_id) {
4916 Some(chan_id) => chan_id.clone(),
4918 // It's not a local channel
4919 return Ok(NotifyOption::SkipPersist)
4922 match channel_state.by_id.entry(chan_id) {
4923 hash_map::Entry::Occupied(mut chan) => {
4924 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4925 if chan.get().should_announce() {
4926 // If the announcement is about a channel of ours which is public, some
4927 // other peer may simply be forwarding all its gossip to us. Don't provide
4928 // a scary-looking error message and return Ok instead.
4929 return Ok(NotifyOption::SkipPersist);
4931 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));
4933 let were_node_one = self.get_our_node_id().serialize()[..] < chan.get().get_counterparty_node_id().serialize()[..];
4934 let msg_from_node_one = msg.contents.flags & 1 == 0;
4935 if were_node_one == msg_from_node_one {
4936 return Ok(NotifyOption::SkipPersist);
4938 try_chan_entry!(self, chan.get_mut().channel_update(&msg), channel_state, chan);
4941 hash_map::Entry::Vacant(_) => unreachable!()
4943 Ok(NotifyOption::DoPersist)
4946 fn internal_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<(), MsgHandleErrInternal> {
4947 let chan_restoration_res;
4948 let (htlcs_failed_forward, need_lnd_workaround) = {
4949 let mut channel_state_lock = self.channel_state.lock().unwrap();
4950 let channel_state = &mut *channel_state_lock;
4952 match channel_state.by_id.entry(msg.channel_id) {
4953 hash_map::Entry::Occupied(mut chan) => {
4954 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4955 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4957 // Currently, we expect all holding cell update_adds to be dropped on peer
4958 // disconnect, so Channel's reestablish will never hand us any holding cell
4959 // freed HTLCs to fail backwards. If in the future we no longer drop pending
4960 // add-HTLCs on disconnect, we may be handed HTLCs to fail backwards here.
4961 let responses = try_chan_entry!(self, chan.get_mut().channel_reestablish(
4962 msg, &self.logger, self.our_network_pubkey.clone(), self.genesis_hash,
4963 &*self.best_block.read().unwrap()), channel_state, chan);
4964 let mut channel_update = None;
4965 if let Some(msg) = responses.shutdown_msg {
4966 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
4967 node_id: counterparty_node_id.clone(),
4970 } else if chan.get().is_usable() {
4971 // If the channel is in a usable state (ie the channel is not being shut
4972 // down), send a unicast channel_update to our counterparty to make sure
4973 // they have the latest channel parameters.
4974 if let Ok(msg) = self.get_channel_update_for_unicast(chan.get()) {
4975 channel_update = Some(events::MessageSendEvent::SendChannelUpdate {
4976 node_id: chan.get().get_counterparty_node_id(),
4981 let need_lnd_workaround = chan.get_mut().workaround_lnd_bug_4006.take();
4982 chan_restoration_res = handle_chan_restoration_locked!(
4983 self, channel_state_lock, channel_state, chan, responses.raa, responses.commitment_update, responses.order,
4984 responses.mon_update, Vec::new(), None, responses.channel_ready, responses.announcement_sigs);
4985 if let Some(upd) = channel_update {
4986 channel_state.pending_msg_events.push(upd);
4988 (responses.holding_cell_failed_htlcs, need_lnd_workaround)
4990 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4993 post_handle_chan_restoration!(self, chan_restoration_res);
4994 self.fail_holding_cell_htlcs(htlcs_failed_forward, msg.channel_id, counterparty_node_id);
4996 if let Some(channel_ready_msg) = need_lnd_workaround {
4997 self.internal_channel_ready(counterparty_node_id, &channel_ready_msg)?;
5002 /// Process pending events from the `chain::Watch`, returning whether any events were processed.
5003 fn process_pending_monitor_events(&self) -> bool {
5004 let mut failed_channels = Vec::new();
5005 let mut pending_monitor_events = self.chain_monitor.release_pending_monitor_events();
5006 let has_pending_monitor_events = !pending_monitor_events.is_empty();
5007 for (funding_outpoint, mut monitor_events) in pending_monitor_events.drain(..) {
5008 for monitor_event in monitor_events.drain(..) {
5009 match monitor_event {
5010 MonitorEvent::HTLCEvent(htlc_update) => {
5011 if let Some(preimage) = htlc_update.payment_preimage {
5012 log_trace!(self.logger, "Claiming HTLC with preimage {} from our monitor", log_bytes!(preimage.0));
5013 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());
5015 log_trace!(self.logger, "Failing HTLC with hash {} from our monitor", log_bytes!(htlc_update.payment_hash.0));
5016 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() });
5019 MonitorEvent::CommitmentTxConfirmed(funding_outpoint) |
5020 MonitorEvent::UpdateFailed(funding_outpoint) => {
5021 let mut channel_lock = self.channel_state.lock().unwrap();
5022 let channel_state = &mut *channel_lock;
5023 let by_id = &mut channel_state.by_id;
5024 let pending_msg_events = &mut channel_state.pending_msg_events;
5025 if let hash_map::Entry::Occupied(chan_entry) = by_id.entry(funding_outpoint.to_channel_id()) {
5026 let mut chan = remove_channel!(self, channel_state, chan_entry);
5027 failed_channels.push(chan.force_shutdown(false));
5028 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
5029 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
5033 let reason = if let MonitorEvent::UpdateFailed(_) = monitor_event {
5034 ClosureReason::ProcessingError { err: "Failed to persist ChannelMonitor update during chain sync".to_string() }
5036 ClosureReason::CommitmentTxConfirmed
5038 self.issue_channel_close_events(&chan, reason);
5039 pending_msg_events.push(events::MessageSendEvent::HandleError {
5040 node_id: chan.get_counterparty_node_id(),
5041 action: msgs::ErrorAction::SendErrorMessage {
5042 msg: msgs::ErrorMessage { channel_id: chan.channel_id(), data: "Channel force-closed".to_owned() }
5047 MonitorEvent::UpdateCompleted { funding_txo, monitor_update_id } => {
5048 self.channel_monitor_updated(&funding_txo, monitor_update_id);
5054 for failure in failed_channels.drain(..) {
5055 self.finish_force_close_channel(failure);
5058 has_pending_monitor_events
5061 /// In chanmon_consistency_target, we'd like to be able to restore monitor updating without
5062 /// handling all pending events (i.e. not PendingHTLCsForwardable). Thus, we expose monitor
5063 /// update events as a separate process method here.
5065 pub fn process_monitor_events(&self) {
5066 self.process_pending_monitor_events();
5069 /// Check the holding cell in each channel and free any pending HTLCs in them if possible.
5070 /// Returns whether there were any updates such as if pending HTLCs were freed or a monitor
5071 /// update was applied.
5073 /// This should only apply to HTLCs which were added to the holding cell because we were
5074 /// waiting on a monitor update to finish. In that case, we don't want to free the holding cell
5075 /// directly in `channel_monitor_updated` as it may introduce deadlocks calling back into user
5076 /// code to inform them of a channel monitor update.
5077 fn check_free_holding_cells(&self) -> bool {
5078 let mut has_monitor_update = false;
5079 let mut failed_htlcs = Vec::new();
5080 let mut handle_errors = Vec::new();
5082 let mut channel_state_lock = self.channel_state.lock().unwrap();
5083 let channel_state = &mut *channel_state_lock;
5084 let by_id = &mut channel_state.by_id;
5085 let short_to_id = &mut channel_state.short_to_id;
5086 let pending_msg_events = &mut channel_state.pending_msg_events;
5088 by_id.retain(|channel_id, chan| {
5089 match chan.maybe_free_holding_cell_htlcs(&self.logger) {
5090 Ok((commitment_opt, holding_cell_failed_htlcs)) => {
5091 if !holding_cell_failed_htlcs.is_empty() {
5093 holding_cell_failed_htlcs,
5095 chan.get_counterparty_node_id()
5098 if let Some((commitment_update, monitor_update)) = commitment_opt {
5099 if let Err(e) = self.chain_monitor.update_channel(chan.get_funding_txo().unwrap(), monitor_update) {
5100 has_monitor_update = true;
5101 let (res, close_channel) = handle_monitor_err!(self, e, short_to_id, chan, RAACommitmentOrder::CommitmentFirst, channel_id, COMMITMENT_UPDATE_ONLY);
5102 handle_errors.push((chan.get_counterparty_node_id(), res));
5103 if close_channel { return false; }
5105 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
5106 node_id: chan.get_counterparty_node_id(),
5107 updates: commitment_update,
5114 let (close_channel, res) = convert_chan_err!(self, e, short_to_id, chan, channel_id);
5115 handle_errors.push((chan.get_counterparty_node_id(), Err(res)));
5116 // ChannelClosed event is generated by handle_error for us
5123 let has_update = has_monitor_update || !failed_htlcs.is_empty() || !handle_errors.is_empty();
5124 for (failures, channel_id, counterparty_node_id) in failed_htlcs.drain(..) {
5125 self.fail_holding_cell_htlcs(failures, channel_id, &counterparty_node_id);
5128 for (counterparty_node_id, err) in handle_errors.drain(..) {
5129 let _ = handle_error!(self, err, counterparty_node_id);
5135 /// Check whether any channels have finished removing all pending updates after a shutdown
5136 /// exchange and can now send a closing_signed.
5137 /// Returns whether any closing_signed messages were generated.
5138 fn maybe_generate_initial_closing_signed(&self) -> bool {
5139 let mut handle_errors: Vec<(PublicKey, Result<(), _>)> = Vec::new();
5140 let mut has_update = false;
5142 let mut channel_state_lock = self.channel_state.lock().unwrap();
5143 let channel_state = &mut *channel_state_lock;
5144 let by_id = &mut channel_state.by_id;
5145 let short_to_id = &mut channel_state.short_to_id;
5146 let pending_msg_events = &mut channel_state.pending_msg_events;
5148 by_id.retain(|channel_id, chan| {
5149 match chan.maybe_propose_closing_signed(&self.fee_estimator, &self.logger) {
5150 Ok((msg_opt, tx_opt)) => {
5151 if let Some(msg) = msg_opt {
5153 pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
5154 node_id: chan.get_counterparty_node_id(), msg,
5157 if let Some(tx) = tx_opt {
5158 // We're done with this channel. We got a closing_signed and sent back
5159 // a closing_signed with a closing transaction to broadcast.
5160 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
5161 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
5166 self.issue_channel_close_events(chan, ClosureReason::CooperativeClosure);
5168 log_info!(self.logger, "Broadcasting {}", log_tx!(tx));
5169 self.tx_broadcaster.broadcast_transaction(&tx);
5170 update_maps_on_chan_removal!(self, short_to_id, chan);
5176 let (close_channel, res) = convert_chan_err!(self, e, short_to_id, chan, channel_id);
5177 handle_errors.push((chan.get_counterparty_node_id(), Err(res)));
5184 for (counterparty_node_id, err) in handle_errors.drain(..) {
5185 let _ = handle_error!(self, err, counterparty_node_id);
5191 /// Handle a list of channel failures during a block_connected or block_disconnected call,
5192 /// pushing the channel monitor update (if any) to the background events queue and removing the
5194 fn handle_init_event_channel_failures(&self, mut failed_channels: Vec<ShutdownResult>) {
5195 for mut failure in failed_channels.drain(..) {
5196 // Either a commitment transactions has been confirmed on-chain or
5197 // Channel::block_disconnected detected that the funding transaction has been
5198 // reorganized out of the main chain.
5199 // We cannot broadcast our latest local state via monitor update (as
5200 // Channel::force_shutdown tries to make us do) as we may still be in initialization,
5201 // so we track the update internally and handle it when the user next calls
5202 // timer_tick_occurred, guaranteeing we're running normally.
5203 if let Some((funding_txo, update)) = failure.0.take() {
5204 assert_eq!(update.updates.len(), 1);
5205 if let ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } = update.updates[0] {
5206 assert!(should_broadcast);
5207 } else { unreachable!(); }
5208 self.pending_background_events.lock().unwrap().push(BackgroundEvent::ClosingMonitorUpdate((funding_txo, update)));
5210 self.finish_force_close_channel(failure);
5214 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> {
5215 assert!(invoice_expiry_delta_secs <= 60*60*24*365); // Sadly bitcoin timestamps are u32s, so panic before 2106
5217 if min_value_msat.is_some() && min_value_msat.unwrap() > MAX_VALUE_MSAT {
5218 return Err(APIError::APIMisuseError { err: format!("min_value_msat of {} greater than total 21 million bitcoin supply", min_value_msat.unwrap()) });
5221 let payment_secret = PaymentSecret(self.keys_manager.get_secure_random_bytes());
5223 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5224 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
5225 match payment_secrets.entry(payment_hash) {
5226 hash_map::Entry::Vacant(e) => {
5227 e.insert(PendingInboundPayment {
5228 payment_secret, min_value_msat, payment_preimage,
5229 user_payment_id: 0, // For compatibility with version 0.0.103 and earlier
5230 // We assume that highest_seen_timestamp is pretty close to the current time -
5231 // it's updated when we receive a new block with the maximum time we've seen in
5232 // a header. It should never be more than two hours in the future.
5233 // Thus, we add two hours here as a buffer to ensure we absolutely
5234 // never fail a payment too early.
5235 // Note that we assume that received blocks have reasonably up-to-date
5237 expiry_time: self.highest_seen_timestamp.load(Ordering::Acquire) as u64 + invoice_expiry_delta_secs as u64 + 7200,
5240 hash_map::Entry::Occupied(_) => return Err(APIError::APIMisuseError { err: "Duplicate payment hash".to_owned() }),
5245 /// Gets a payment secret and payment hash for use in an invoice given to a third party wishing
5248 /// This differs from [`create_inbound_payment_for_hash`] only in that it generates the
5249 /// [`PaymentHash`] and [`PaymentPreimage`] for you.
5251 /// The [`PaymentPreimage`] will ultimately be returned to you in the [`PaymentReceived`], which
5252 /// will have the [`PaymentReceived::payment_preimage`] field filled in. That should then be
5253 /// passed directly to [`claim_funds`].
5255 /// See [`create_inbound_payment_for_hash`] for detailed documentation on behavior and requirements.
5257 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
5258 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
5262 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
5263 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
5265 /// Errors if `min_value_msat` is greater than total bitcoin supply.
5267 /// [`claim_funds`]: Self::claim_funds
5268 /// [`PaymentReceived`]: events::Event::PaymentReceived
5269 /// [`PaymentReceived::payment_preimage`]: events::Event::PaymentReceived::payment_preimage
5270 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
5271 pub fn create_inbound_payment(&self, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32) -> Result<(PaymentHash, PaymentSecret), ()> {
5272 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)
5275 /// Legacy version of [`create_inbound_payment`]. Use this method if you wish to share
5276 /// serialized state with LDK node(s) running 0.0.103 and earlier.
5278 /// May panic if `invoice_expiry_delta_secs` is greater than one year.
5281 /// This method is deprecated and will be removed soon.
5283 /// [`create_inbound_payment`]: Self::create_inbound_payment
5285 pub fn create_inbound_payment_legacy(&self, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32) -> Result<(PaymentHash, PaymentSecret), APIError> {
5286 let payment_preimage = PaymentPreimage(self.keys_manager.get_secure_random_bytes());
5287 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
5288 let payment_secret = self.set_payment_hash_secret_map(payment_hash, Some(payment_preimage), min_value_msat, invoice_expiry_delta_secs)?;
5289 Ok((payment_hash, payment_secret))
5292 /// Gets a [`PaymentSecret`] for a given [`PaymentHash`], for which the payment preimage is
5293 /// stored external to LDK.
5295 /// A [`PaymentReceived`] event will only be generated if the [`PaymentSecret`] matches a
5296 /// payment secret fetched via this method or [`create_inbound_payment`], and which is at least
5297 /// the `min_value_msat` provided here, if one is provided.
5299 /// The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) should be globally unique, though
5300 /// note that LDK will not stop you from registering duplicate payment hashes for inbound
5303 /// `min_value_msat` should be set if the invoice being generated contains a value. Any payment
5304 /// received for the returned [`PaymentHash`] will be required to be at least `min_value_msat`
5305 /// before a [`PaymentReceived`] event will be generated, ensuring that we do not provide the
5306 /// sender "proof-of-payment" unless they have paid the required amount.
5308 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
5309 /// in excess of the current time. This should roughly match the expiry time set in the invoice.
5310 /// After this many seconds, we will remove the inbound payment, resulting in any attempts to
5311 /// pay the invoice failing. The BOLT spec suggests 3,600 secs as a default validity time for
5312 /// invoices when no timeout is set.
5314 /// Note that we use block header time to time-out pending inbound payments (with some margin
5315 /// to compensate for the inaccuracy of block header timestamps). Thus, in practice we will
5316 /// accept a payment and generate a [`PaymentReceived`] event for some time after the expiry.
5317 /// If you need exact expiry semantics, you should enforce them upon receipt of
5318 /// [`PaymentReceived`].
5320 /// Note that invoices generated for inbound payments should have their `min_final_cltv_expiry`
5321 /// set to at least [`MIN_FINAL_CLTV_EXPIRY`].
5323 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
5324 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
5328 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
5329 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
5331 /// Errors if `min_value_msat` is greater than total bitcoin supply.
5333 /// [`create_inbound_payment`]: Self::create_inbound_payment
5334 /// [`PaymentReceived`]: events::Event::PaymentReceived
5335 pub fn create_inbound_payment_for_hash(&self, payment_hash: PaymentHash, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32) -> Result<PaymentSecret, ()> {
5336 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)
5339 /// Legacy version of [`create_inbound_payment_for_hash`]. Use this method if you wish to share
5340 /// serialized state with LDK node(s) running 0.0.103 and earlier.
5342 /// May panic if `invoice_expiry_delta_secs` is greater than one year.
5345 /// This method is deprecated and will be removed soon.
5347 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
5349 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> {
5350 self.set_payment_hash_secret_map(payment_hash, None, min_value_msat, invoice_expiry_delta_secs)
5353 /// Gets an LDK-generated payment preimage from a payment hash and payment secret that were
5354 /// previously returned from [`create_inbound_payment`].
5356 /// [`create_inbound_payment`]: Self::create_inbound_payment
5357 pub fn get_payment_preimage(&self, payment_hash: PaymentHash, payment_secret: PaymentSecret) -> Result<PaymentPreimage, APIError> {
5358 inbound_payment::get_payment_preimage(payment_hash, payment_secret, &self.inbound_payment_key)
5361 /// Gets a fake short channel id for use in receiving [phantom node payments]. These fake scids
5362 /// are used when constructing the phantom invoice's route hints.
5364 /// [phantom node payments]: crate::chain::keysinterface::PhantomKeysManager
5365 pub fn get_phantom_scid(&self) -> u64 {
5366 let mut channel_state = self.channel_state.lock().unwrap();
5367 let best_block = self.best_block.read().unwrap();
5369 let scid_candidate = fake_scid::Namespace::Phantom.get_fake_scid(best_block.height(), &self.genesis_hash, &self.fake_scid_rand_bytes, &self.keys_manager);
5370 // Ensure the generated scid doesn't conflict with a real channel.
5371 match channel_state.short_to_id.entry(scid_candidate) {
5372 hash_map::Entry::Occupied(_) => continue,
5373 hash_map::Entry::Vacant(_) => return scid_candidate
5378 /// Gets route hints for use in receiving [phantom node payments].
5380 /// [phantom node payments]: crate::chain::keysinterface::PhantomKeysManager
5381 pub fn get_phantom_route_hints(&self) -> PhantomRouteHints {
5383 channels: self.list_usable_channels(),
5384 phantom_scid: self.get_phantom_scid(),
5385 real_node_pubkey: self.get_our_node_id(),
5389 #[cfg(any(test, fuzzing, feature = "_test_utils"))]
5390 pub fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
5391 let events = core::cell::RefCell::new(Vec::new());
5392 let event_handler = |event: &events::Event| events.borrow_mut().push(event.clone());
5393 self.process_pending_events(&event_handler);
5398 pub fn has_pending_payments(&self) -> bool {
5399 !self.pending_outbound_payments.lock().unwrap().is_empty()
5403 pub fn clear_pending_payments(&self) {
5404 self.pending_outbound_payments.lock().unwrap().clear()
5408 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> MessageSendEventsProvider for ChannelManager<Signer, M, T, K, F, L>
5409 where M::Target: chain::Watch<Signer>,
5410 T::Target: BroadcasterInterface,
5411 K::Target: KeysInterface<Signer = Signer>,
5412 F::Target: FeeEstimator,
5415 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
5416 let events = RefCell::new(Vec::new());
5417 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
5418 let mut result = NotifyOption::SkipPersist;
5420 // TODO: This behavior should be documented. It's unintuitive that we query
5421 // ChannelMonitors when clearing other events.
5422 if self.process_pending_monitor_events() {
5423 result = NotifyOption::DoPersist;
5426 if self.check_free_holding_cells() {
5427 result = NotifyOption::DoPersist;
5429 if self.maybe_generate_initial_closing_signed() {
5430 result = NotifyOption::DoPersist;
5433 let mut pending_events = Vec::new();
5434 let mut channel_state = self.channel_state.lock().unwrap();
5435 mem::swap(&mut pending_events, &mut channel_state.pending_msg_events);
5437 if !pending_events.is_empty() {
5438 events.replace(pending_events);
5447 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> EventsProvider for ChannelManager<Signer, M, T, K, F, L>
5449 M::Target: chain::Watch<Signer>,
5450 T::Target: BroadcasterInterface,
5451 K::Target: KeysInterface<Signer = Signer>,
5452 F::Target: FeeEstimator,
5455 /// Processes events that must be periodically handled.
5457 /// An [`EventHandler`] may safely call back to the provider in order to handle an event.
5458 /// However, it must not call [`Writeable::write`] as doing so would result in a deadlock.
5460 /// Pending events are persisted as part of [`ChannelManager`]. While these events are cleared
5461 /// when processed, an [`EventHandler`] must be able to handle previously seen events when
5462 /// restarting from an old state.
5463 fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler {
5464 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
5465 let mut result = NotifyOption::SkipPersist;
5467 // TODO: This behavior should be documented. It's unintuitive that we query
5468 // ChannelMonitors when clearing other events.
5469 if self.process_pending_monitor_events() {
5470 result = NotifyOption::DoPersist;
5473 let mut pending_events = mem::replace(&mut *self.pending_events.lock().unwrap(), vec![]);
5474 if !pending_events.is_empty() {
5475 result = NotifyOption::DoPersist;
5478 for event in pending_events.drain(..) {
5479 handler.handle_event(&event);
5487 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> chain::Listen for ChannelManager<Signer, M, T, K, F, L>
5489 M::Target: chain::Watch<Signer>,
5490 T::Target: BroadcasterInterface,
5491 K::Target: KeysInterface<Signer = Signer>,
5492 F::Target: FeeEstimator,
5495 fn filtered_block_connected(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
5497 let best_block = self.best_block.read().unwrap();
5498 assert_eq!(best_block.block_hash(), header.prev_blockhash,
5499 "Blocks must be connected in chain-order - the connected header must build on the last connected header");
5500 assert_eq!(best_block.height(), height - 1,
5501 "Blocks must be connected in chain-order - the connected block height must be one greater than the previous height");
5504 self.transactions_confirmed(header, txdata, height);
5505 self.best_block_updated(header, height);
5508 fn block_disconnected(&self, header: &BlockHeader, height: u32) {
5509 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5510 let new_height = height - 1;
5512 let mut best_block = self.best_block.write().unwrap();
5513 assert_eq!(best_block.block_hash(), header.block_hash(),
5514 "Blocks must be disconnected in chain-order - the disconnected header must be the last connected header");
5515 assert_eq!(best_block.height(), height,
5516 "Blocks must be disconnected in chain-order - the disconnected block must have the correct height");
5517 *best_block = BestBlock::new(header.prev_blockhash, new_height)
5520 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));
5524 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> chain::Confirm for ChannelManager<Signer, M, T, K, F, L>
5526 M::Target: chain::Watch<Signer>,
5527 T::Target: BroadcasterInterface,
5528 K::Target: KeysInterface<Signer = Signer>,
5529 F::Target: FeeEstimator,
5532 fn transactions_confirmed(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
5533 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
5534 // during initialization prior to the chain_monitor being fully configured in some cases.
5535 // See the docs for `ChannelManagerReadArgs` for more.
5537 let block_hash = header.block_hash();
5538 log_trace!(self.logger, "{} transactions included in block {} at height {} provided", txdata.len(), block_hash, height);
5540 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5541 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)
5542 .map(|(a, b)| (a, Vec::new(), b)));
5544 let last_best_block_height = self.best_block.read().unwrap().height();
5545 if height < last_best_block_height {
5546 let timestamp = self.highest_seen_timestamp.load(Ordering::Acquire);
5547 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));
5551 fn best_block_updated(&self, header: &BlockHeader, height: u32) {
5552 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
5553 // during initialization prior to the chain_monitor being fully configured in some cases.
5554 // See the docs for `ChannelManagerReadArgs` for more.
5556 let block_hash = header.block_hash();
5557 log_trace!(self.logger, "New best block: {} at height {}", block_hash, height);
5559 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5561 *self.best_block.write().unwrap() = BestBlock::new(block_hash, height);
5563 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));
5565 macro_rules! max_time {
5566 ($timestamp: expr) => {
5568 // Update $timestamp to be the max of its current value and the block
5569 // timestamp. This should keep us close to the current time without relying on
5570 // having an explicit local time source.
5571 // Just in case we end up in a race, we loop until we either successfully
5572 // update $timestamp or decide we don't need to.
5573 let old_serial = $timestamp.load(Ordering::Acquire);
5574 if old_serial >= header.time as usize { break; }
5575 if $timestamp.compare_exchange(old_serial, header.time as usize, Ordering::AcqRel, Ordering::Relaxed).is_ok() {
5581 max_time!(self.last_node_announcement_serial);
5582 max_time!(self.highest_seen_timestamp);
5583 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
5584 payment_secrets.retain(|_, inbound_payment| {
5585 inbound_payment.expiry_time > header.time as u64
5588 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
5589 let mut pending_events = self.pending_events.lock().unwrap();
5590 outbounds.retain(|payment_id, payment| {
5591 if payment.remaining_parts() != 0 { return true }
5592 if let PendingOutboundPayment::Retryable { starting_block_height, payment_hash, .. } = payment {
5593 if *starting_block_height + PAYMENT_EXPIRY_BLOCKS <= height {
5594 log_info!(self.logger, "Timing out payment with id {} and hash {}", log_bytes!(payment_id.0), log_bytes!(payment_hash.0));
5595 pending_events.push(events::Event::PaymentFailed {
5596 payment_id: *payment_id, payment_hash: *payment_hash,
5604 fn get_relevant_txids(&self) -> Vec<Txid> {
5605 let channel_state = self.channel_state.lock().unwrap();
5606 let mut res = Vec::with_capacity(channel_state.short_to_id.len());
5607 for chan in channel_state.by_id.values() {
5608 if let Some(funding_txo) = chan.get_funding_txo() {
5609 res.push(funding_txo.txid);
5615 fn transaction_unconfirmed(&self, txid: &Txid) {
5616 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5617 self.do_chain_event(None, |channel| {
5618 if let Some(funding_txo) = channel.get_funding_txo() {
5619 if funding_txo.txid == *txid {
5620 channel.funding_transaction_unconfirmed(&self.logger).map(|()| (None, Vec::new(), None))
5621 } else { Ok((None, Vec::new(), None)) }
5622 } else { Ok((None, Vec::new(), None)) }
5627 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<Signer, M, T, K, F, L>
5629 M::Target: chain::Watch<Signer>,
5630 T::Target: BroadcasterInterface,
5631 K::Target: KeysInterface<Signer = Signer>,
5632 F::Target: FeeEstimator,
5635 /// Calls a function which handles an on-chain event (blocks dis/connected, transactions
5636 /// un/confirmed, etc) on each channel, handling any resulting errors or messages generated by
5638 fn do_chain_event<FN: Fn(&mut Channel<Signer>) -> Result<(Option<msgs::ChannelReady>, Vec<(HTLCSource, PaymentHash)>, Option<msgs::AnnouncementSignatures>), ClosureReason>>
5639 (&self, height_opt: Option<u32>, f: FN) {
5640 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
5641 // during initialization prior to the chain_monitor being fully configured in some cases.
5642 // See the docs for `ChannelManagerReadArgs` for more.
5644 let mut failed_channels = Vec::new();
5645 let mut timed_out_htlcs = Vec::new();
5647 let mut channel_lock = self.channel_state.lock().unwrap();
5648 let channel_state = &mut *channel_lock;
5649 let short_to_id = &mut channel_state.short_to_id;
5650 let pending_msg_events = &mut channel_state.pending_msg_events;
5651 channel_state.by_id.retain(|_, channel| {
5652 let res = f(channel);
5653 if let Ok((channel_ready_opt, mut timed_out_pending_htlcs, announcement_sigs)) = res {
5654 for (source, payment_hash) in timed_out_pending_htlcs.drain(..) {
5655 let (failure_code, data) = self.get_htlc_inbound_temp_fail_err_and_data(0x1000|14 /* expiry_too_soon */, &channel);
5656 timed_out_htlcs.push((source, payment_hash, HTLCFailReason::Reason {
5660 if let Some(channel_ready) = channel_ready_opt {
5661 send_channel_ready!(short_to_id, pending_msg_events, channel, channel_ready);
5662 if channel.is_usable() {
5663 log_trace!(self.logger, "Sending channel_ready with private initial channel_update for our counterparty on channel {}", log_bytes!(channel.channel_id()));
5664 if let Ok(msg) = self.get_channel_update_for_unicast(channel) {
5665 pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
5666 node_id: channel.get_counterparty_node_id(),
5671 log_trace!(self.logger, "Sending channel_ready WITHOUT channel_update for {}", log_bytes!(channel.channel_id()));
5674 if let Some(announcement_sigs) = announcement_sigs {
5675 log_trace!(self.logger, "Sending announcement_signatures for channel {}", log_bytes!(channel.channel_id()));
5676 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
5677 node_id: channel.get_counterparty_node_id(),
5678 msg: announcement_sigs,
5680 if let Some(height) = height_opt {
5681 if let Some(announcement) = channel.get_signed_channel_announcement(self.get_our_node_id(), self.genesis_hash, height) {
5682 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
5684 // Note that announcement_signatures fails if the channel cannot be announced,
5685 // so get_channel_update_for_broadcast will never fail by the time we get here.
5686 update_msg: self.get_channel_update_for_broadcast(channel).unwrap(),
5691 if channel.is_our_channel_ready() {
5692 if let Some(real_scid) = channel.get_short_channel_id() {
5693 // If we sent a 0conf channel_ready, and now have an SCID, we add it
5694 // to the short_to_id map here. Note that we check whether we can relay
5695 // using the real SCID at relay-time (i.e. enforce option_scid_alias
5696 // then), and if the funding tx is ever un-confirmed we force-close the
5697 // channel, ensuring short_to_id is always consistent.
5698 let scid_insert = short_to_id.insert(real_scid, channel.channel_id());
5699 assert!(scid_insert.is_none() || scid_insert.unwrap() == channel.channel_id(),
5700 "SCIDs should never collide - ensure you weren't behind by a full {} blocks when creating channels",
5701 fake_scid::MAX_SCID_BLOCKS_FROM_NOW);
5704 } else if let Err(reason) = res {
5705 update_maps_on_chan_removal!(self, short_to_id, channel);
5706 // It looks like our counterparty went on-chain or funding transaction was
5707 // reorged out of the main chain. Close the channel.
5708 failed_channels.push(channel.force_shutdown(true));
5709 if let Ok(update) = self.get_channel_update_for_broadcast(&channel) {
5710 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
5714 let reason_message = format!("{}", reason);
5715 self.issue_channel_close_events(channel, reason);
5716 pending_msg_events.push(events::MessageSendEvent::HandleError {
5717 node_id: channel.get_counterparty_node_id(),
5718 action: msgs::ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage {
5719 channel_id: channel.channel_id(),
5720 data: reason_message,
5728 if let Some(height) = height_opt {
5729 channel_state.claimable_htlcs.retain(|payment_hash, (_, htlcs)| {
5730 htlcs.retain(|htlc| {
5731 // If height is approaching the number of blocks we think it takes us to get
5732 // our commitment transaction confirmed before the HTLC expires, plus the
5733 // number of blocks we generally consider it to take to do a commitment update,
5734 // just give up on it and fail the HTLC.
5735 if height >= htlc.cltv_expiry - HTLC_FAIL_BACK_BUFFER {
5736 let mut htlc_msat_height_data = byte_utils::be64_to_array(htlc.value).to_vec();
5737 htlc_msat_height_data.extend_from_slice(&byte_utils::be32_to_array(height));
5738 timed_out_htlcs.push((HTLCSource::PreviousHopData(htlc.prev_hop.clone()), payment_hash.clone(), HTLCFailReason::Reason {
5739 failure_code: 0x4000 | 15,
5740 data: htlc_msat_height_data
5745 !htlcs.is_empty() // Only retain this entry if htlcs has at least one entry.
5750 self.handle_init_event_channel_failures(failed_channels);
5752 for (source, payment_hash, reason) in timed_out_htlcs.drain(..) {
5753 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), source, &payment_hash, reason);
5757 /// Blocks until ChannelManager needs to be persisted or a timeout is reached. It returns a bool
5758 /// indicating whether persistence is necessary. Only one listener on
5759 /// `await_persistable_update` or `await_persistable_update_timeout` is guaranteed to be woken
5762 /// Note that this method is not available with the `no-std` feature.
5763 #[cfg(any(test, feature = "std"))]
5764 pub fn await_persistable_update_timeout(&self, max_wait: Duration) -> bool {
5765 self.persistence_notifier.wait_timeout(max_wait)
5768 /// Blocks until ChannelManager needs to be persisted. Only one listener on
5769 /// `await_persistable_update` or `await_persistable_update_timeout` is guaranteed to be woken
5771 pub fn await_persistable_update(&self) {
5772 self.persistence_notifier.wait()
5775 #[cfg(any(test, feature = "_test_utils"))]
5776 pub fn get_persistence_condvar_value(&self) -> bool {
5777 let mutcond = &self.persistence_notifier.persistence_lock;
5778 let &(ref mtx, _) = mutcond;
5779 let guard = mtx.lock().unwrap();
5783 /// Gets the latest best block which was connected either via the [`chain::Listen`] or
5784 /// [`chain::Confirm`] interfaces.
5785 pub fn current_best_block(&self) -> BestBlock {
5786 self.best_block.read().unwrap().clone()
5790 impl<Signer: Sign, M: Deref , T: Deref , K: Deref , F: Deref , L: Deref >
5791 ChannelMessageHandler for ChannelManager<Signer, M, T, K, F, L>
5792 where M::Target: chain::Watch<Signer>,
5793 T::Target: BroadcasterInterface,
5794 K::Target: KeysInterface<Signer = Signer>,
5795 F::Target: FeeEstimator,
5798 fn handle_open_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::OpenChannel) {
5799 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5800 let _ = handle_error!(self, self.internal_open_channel(counterparty_node_id, their_features, msg), *counterparty_node_id);
5803 fn handle_accept_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::AcceptChannel) {
5804 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5805 let _ = handle_error!(self, self.internal_accept_channel(counterparty_node_id, their_features, msg), *counterparty_node_id);
5808 fn handle_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) {
5809 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5810 let _ = handle_error!(self, self.internal_funding_created(counterparty_node_id, msg), *counterparty_node_id);
5813 fn handle_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) {
5814 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5815 let _ = handle_error!(self, self.internal_funding_signed(counterparty_node_id, msg), *counterparty_node_id);
5818 fn handle_channel_ready(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReady) {
5819 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5820 let _ = handle_error!(self, self.internal_channel_ready(counterparty_node_id, msg), *counterparty_node_id);
5823 fn handle_shutdown(&self, counterparty_node_id: &PublicKey, their_features: &InitFeatures, msg: &msgs::Shutdown) {
5824 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5825 let _ = handle_error!(self, self.internal_shutdown(counterparty_node_id, their_features, msg), *counterparty_node_id);
5828 fn handle_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
5829 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5830 let _ = handle_error!(self, self.internal_closing_signed(counterparty_node_id, msg), *counterparty_node_id);
5833 fn handle_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
5834 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5835 let _ = handle_error!(self, self.internal_update_add_htlc(counterparty_node_id, msg), *counterparty_node_id);
5838 fn handle_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
5839 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5840 let _ = handle_error!(self, self.internal_update_fulfill_htlc(counterparty_node_id, msg), *counterparty_node_id);
5843 fn handle_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
5844 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5845 let _ = handle_error!(self, self.internal_update_fail_htlc(counterparty_node_id, msg), *counterparty_node_id);
5848 fn handle_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
5849 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5850 let _ = handle_error!(self, self.internal_update_fail_malformed_htlc(counterparty_node_id, msg), *counterparty_node_id);
5853 fn handle_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
5854 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5855 let _ = handle_error!(self, self.internal_commitment_signed(counterparty_node_id, msg), *counterparty_node_id);
5858 fn handle_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
5859 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5860 let _ = handle_error!(self, self.internal_revoke_and_ack(counterparty_node_id, msg), *counterparty_node_id);
5863 fn handle_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) {
5864 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5865 let _ = handle_error!(self, self.internal_update_fee(counterparty_node_id, msg), *counterparty_node_id);
5868 fn handle_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
5869 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5870 let _ = handle_error!(self, self.internal_announcement_signatures(counterparty_node_id, msg), *counterparty_node_id);
5873 fn handle_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) {
5874 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
5875 if let Ok(persist) = handle_error!(self, self.internal_channel_update(counterparty_node_id, msg), *counterparty_node_id) {
5878 NotifyOption::SkipPersist
5883 fn handle_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
5884 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5885 let _ = handle_error!(self, self.internal_channel_reestablish(counterparty_node_id, msg), *counterparty_node_id);
5888 fn peer_disconnected(&self, counterparty_node_id: &PublicKey, no_connection_possible: bool) {
5889 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5890 let mut failed_channels = Vec::new();
5891 let mut no_channels_remain = true;
5893 let mut channel_state_lock = self.channel_state.lock().unwrap();
5894 let channel_state = &mut *channel_state_lock;
5895 let pending_msg_events = &mut channel_state.pending_msg_events;
5896 let short_to_id = &mut channel_state.short_to_id;
5897 log_debug!(self.logger, "Marking channels with {} disconnected and generating channel_updates. We believe we {} make future connections to this peer.",
5898 log_pubkey!(counterparty_node_id), if no_connection_possible { "cannot" } else { "can" });
5899 channel_state.by_id.retain(|_, chan| {
5900 if chan.get_counterparty_node_id() == *counterparty_node_id {
5901 chan.remove_uncommitted_htlcs_and_mark_paused(&self.logger);
5902 if chan.is_shutdown() {
5903 update_maps_on_chan_removal!(self, short_to_id, chan);
5904 self.issue_channel_close_events(chan, ClosureReason::DisconnectedPeer);
5907 no_channels_remain = false;
5912 pending_msg_events.retain(|msg| {
5914 &events::MessageSendEvent::SendAcceptChannel { ref node_id, .. } => node_id != counterparty_node_id,
5915 &events::MessageSendEvent::SendOpenChannel { ref node_id, .. } => node_id != counterparty_node_id,
5916 &events::MessageSendEvent::SendFundingCreated { ref node_id, .. } => node_id != counterparty_node_id,
5917 &events::MessageSendEvent::SendFundingSigned { ref node_id, .. } => node_id != counterparty_node_id,
5918 &events::MessageSendEvent::SendChannelReady { ref node_id, .. } => node_id != counterparty_node_id,
5919 &events::MessageSendEvent::SendAnnouncementSignatures { ref node_id, .. } => node_id != counterparty_node_id,
5920 &events::MessageSendEvent::UpdateHTLCs { ref node_id, .. } => node_id != counterparty_node_id,
5921 &events::MessageSendEvent::SendRevokeAndACK { ref node_id, .. } => node_id != counterparty_node_id,
5922 &events::MessageSendEvent::SendClosingSigned { ref node_id, .. } => node_id != counterparty_node_id,
5923 &events::MessageSendEvent::SendShutdown { ref node_id, .. } => node_id != counterparty_node_id,
5924 &events::MessageSendEvent::SendChannelReestablish { ref node_id, .. } => node_id != counterparty_node_id,
5925 &events::MessageSendEvent::BroadcastChannelAnnouncement { .. } => true,
5926 &events::MessageSendEvent::BroadcastNodeAnnouncement { .. } => true,
5927 &events::MessageSendEvent::BroadcastChannelUpdate { .. } => true,
5928 &events::MessageSendEvent::SendChannelUpdate { ref node_id, .. } => node_id != counterparty_node_id,
5929 &events::MessageSendEvent::HandleError { ref node_id, .. } => node_id != counterparty_node_id,
5930 &events::MessageSendEvent::SendChannelRangeQuery { .. } => false,
5931 &events::MessageSendEvent::SendShortIdsQuery { .. } => false,
5932 &events::MessageSendEvent::SendReplyChannelRange { .. } => false,
5933 &events::MessageSendEvent::SendGossipTimestampFilter { .. } => false,
5937 if no_channels_remain {
5938 self.per_peer_state.write().unwrap().remove(counterparty_node_id);
5941 for failure in failed_channels.drain(..) {
5942 self.finish_force_close_channel(failure);
5946 fn peer_connected(&self, counterparty_node_id: &PublicKey, init_msg: &msgs::Init) {
5947 log_debug!(self.logger, "Generating channel_reestablish events for {}", log_pubkey!(counterparty_node_id));
5949 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5952 let mut peer_state_lock = self.per_peer_state.write().unwrap();
5953 match peer_state_lock.entry(counterparty_node_id.clone()) {
5954 hash_map::Entry::Vacant(e) => {
5955 e.insert(Mutex::new(PeerState {
5956 latest_features: init_msg.features.clone(),
5959 hash_map::Entry::Occupied(e) => {
5960 e.get().lock().unwrap().latest_features = init_msg.features.clone();
5965 let mut channel_state_lock = self.channel_state.lock().unwrap();
5966 let channel_state = &mut *channel_state_lock;
5967 let pending_msg_events = &mut channel_state.pending_msg_events;
5968 channel_state.by_id.retain(|_, chan| {
5969 if chan.get_counterparty_node_id() == *counterparty_node_id {
5970 if !chan.have_received_message() {
5971 // If we created this (outbound) channel while we were disconnected from the
5972 // peer we probably failed to send the open_channel message, which is now
5973 // lost. We can't have had anything pending related to this channel, so we just
5977 pending_msg_events.push(events::MessageSendEvent::SendChannelReestablish {
5978 node_id: chan.get_counterparty_node_id(),
5979 msg: chan.get_channel_reestablish(&self.logger),
5985 //TODO: Also re-broadcast announcement_signatures
5988 fn handle_error(&self, counterparty_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
5989 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5991 if msg.channel_id == [0; 32] {
5992 for chan in self.list_channels() {
5993 if chan.counterparty.node_id == *counterparty_node_id {
5994 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
5995 let _ = self.force_close_channel_with_peer(&chan.channel_id, counterparty_node_id, Some(&msg.data));
6000 // First check if we can advance the channel type and try again.
6001 let mut channel_state = self.channel_state.lock().unwrap();
6002 if let Some(chan) = channel_state.by_id.get_mut(&msg.channel_id) {
6003 if chan.get_counterparty_node_id() != *counterparty_node_id {
6006 if let Ok(msg) = chan.maybe_handle_error_without_close(self.genesis_hash) {
6007 channel_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
6008 node_id: *counterparty_node_id,
6016 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
6017 let _ = self.force_close_channel_with_peer(&msg.channel_id, counterparty_node_id, Some(&msg.data));
6022 /// Used to signal to the ChannelManager persister that the manager needs to be re-persisted to
6023 /// disk/backups, through `await_persistable_update_timeout` and `await_persistable_update`.
6024 struct PersistenceNotifier {
6025 /// Users won't access the persistence_lock directly, but rather wait on its bool using
6026 /// `wait_timeout` and `wait`.
6027 persistence_lock: (Mutex<bool>, Condvar),
6030 impl PersistenceNotifier {
6033 persistence_lock: (Mutex::new(false), Condvar::new()),
6039 let &(ref mtx, ref cvar) = &self.persistence_lock;
6040 let mut guard = mtx.lock().unwrap();
6045 guard = cvar.wait(guard).unwrap();
6046 let result = *guard;
6054 #[cfg(any(test, feature = "std"))]
6055 fn wait_timeout(&self, max_wait: Duration) -> bool {
6056 let current_time = Instant::now();
6058 let &(ref mtx, ref cvar) = &self.persistence_lock;
6059 let mut guard = mtx.lock().unwrap();
6064 guard = cvar.wait_timeout(guard, max_wait).unwrap().0;
6065 // Due to spurious wakeups that can happen on `wait_timeout`, here we need to check if the
6066 // desired wait time has actually passed, and if not then restart the loop with a reduced wait
6067 // time. Note that this logic can be highly simplified through the use of
6068 // `Condvar::wait_while` and `Condvar::wait_timeout_while`, if and when our MSRV is raised to
6070 let elapsed = current_time.elapsed();
6071 let result = *guard;
6072 if result || elapsed >= max_wait {
6076 match max_wait.checked_sub(elapsed) {
6077 None => return result,
6083 // Signal to the ChannelManager persister that there are updates necessitating persisting to disk.
6085 let &(ref persist_mtx, ref cnd) = &self.persistence_lock;
6086 let mut persistence_lock = persist_mtx.lock().unwrap();
6087 *persistence_lock = true;
6088 mem::drop(persistence_lock);
6093 const SERIALIZATION_VERSION: u8 = 1;
6094 const MIN_SERIALIZATION_VERSION: u8 = 1;
6096 impl_writeable_tlv_based!(CounterpartyForwardingInfo, {
6097 (2, fee_base_msat, required),
6098 (4, fee_proportional_millionths, required),
6099 (6, cltv_expiry_delta, required),
6102 impl_writeable_tlv_based!(ChannelCounterparty, {
6103 (2, node_id, required),
6104 (4, features, required),
6105 (6, unspendable_punishment_reserve, required),
6106 (8, forwarding_info, option),
6107 (9, outbound_htlc_minimum_msat, option),
6108 (11, outbound_htlc_maximum_msat, option),
6111 impl_writeable_tlv_based!(ChannelDetails, {
6112 (1, inbound_scid_alias, option),
6113 (2, channel_id, required),
6114 (3, channel_type, option),
6115 (4, counterparty, required),
6116 (5, outbound_scid_alias, option),
6117 (6, funding_txo, option),
6118 (8, short_channel_id, option),
6119 (10, channel_value_satoshis, required),
6120 (12, unspendable_punishment_reserve, option),
6121 (14, user_channel_id, required),
6122 (16, balance_msat, required),
6123 (18, outbound_capacity_msat, required),
6124 // Note that by the time we get past the required read above, outbound_capacity_msat will be
6125 // filled in, so we can safely unwrap it here.
6126 (19, next_outbound_htlc_limit_msat, (default_value, outbound_capacity_msat.0.unwrap())),
6127 (20, inbound_capacity_msat, required),
6128 (22, confirmations_required, option),
6129 (24, force_close_spend_delay, option),
6130 (26, is_outbound, required),
6131 (28, is_channel_ready, required),
6132 (30, is_usable, required),
6133 (32, is_public, required),
6134 (33, inbound_htlc_minimum_msat, option),
6135 (35, inbound_htlc_maximum_msat, option),
6138 impl_writeable_tlv_based!(PhantomRouteHints, {
6139 (2, channels, vec_type),
6140 (4, phantom_scid, required),
6141 (6, real_node_pubkey, required),
6144 impl_writeable_tlv_based_enum!(PendingHTLCRouting,
6146 (0, onion_packet, required),
6147 (2, short_channel_id, required),
6150 (0, payment_data, required),
6151 (1, phantom_shared_secret, option),
6152 (2, incoming_cltv_expiry, required),
6154 (2, ReceiveKeysend) => {
6155 (0, payment_preimage, required),
6156 (2, incoming_cltv_expiry, required),
6160 impl_writeable_tlv_based!(PendingHTLCInfo, {
6161 (0, routing, required),
6162 (2, incoming_shared_secret, required),
6163 (4, payment_hash, required),
6164 (6, amt_to_forward, required),
6165 (8, outgoing_cltv_value, required)
6169 impl Writeable for HTLCFailureMsg {
6170 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6172 HTLCFailureMsg::Relay(msgs::UpdateFailHTLC { channel_id, htlc_id, reason }) => {
6174 channel_id.write(writer)?;
6175 htlc_id.write(writer)?;
6176 reason.write(writer)?;
6178 HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
6179 channel_id, htlc_id, sha256_of_onion, failure_code
6182 channel_id.write(writer)?;
6183 htlc_id.write(writer)?;
6184 sha256_of_onion.write(writer)?;
6185 failure_code.write(writer)?;
6192 impl Readable for HTLCFailureMsg {
6193 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
6194 let id: u8 = Readable::read(reader)?;
6197 Ok(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
6198 channel_id: Readable::read(reader)?,
6199 htlc_id: Readable::read(reader)?,
6200 reason: Readable::read(reader)?,
6204 Ok(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
6205 channel_id: Readable::read(reader)?,
6206 htlc_id: Readable::read(reader)?,
6207 sha256_of_onion: Readable::read(reader)?,
6208 failure_code: Readable::read(reader)?,
6211 // In versions prior to 0.0.101, HTLCFailureMsg objects were written with type 0 or 1 but
6212 // weren't length-prefixed and thus didn't support reading the TLV stream suffix of the network
6213 // messages contained in the variants.
6214 // In version 0.0.101, support for reading the variants with these types was added, and
6215 // we should migrate to writing these variants when UpdateFailHTLC or
6216 // UpdateFailMalformedHTLC get TLV fields.
6218 let length: BigSize = Readable::read(reader)?;
6219 let mut s = FixedLengthReader::new(reader, length.0);
6220 let res = Readable::read(&mut s)?;
6221 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
6222 Ok(HTLCFailureMsg::Relay(res))
6225 let length: BigSize = Readable::read(reader)?;
6226 let mut s = FixedLengthReader::new(reader, length.0);
6227 let res = Readable::read(&mut s)?;
6228 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
6229 Ok(HTLCFailureMsg::Malformed(res))
6231 _ => Err(DecodeError::UnknownRequiredFeature),
6236 impl_writeable_tlv_based_enum!(PendingHTLCStatus, ;
6241 impl_writeable_tlv_based!(HTLCPreviousHopData, {
6242 (0, short_channel_id, required),
6243 (1, phantom_shared_secret, option),
6244 (2, outpoint, required),
6245 (4, htlc_id, required),
6246 (6, incoming_packet_shared_secret, required)
6249 impl Writeable for ClaimableHTLC {
6250 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6251 let (payment_data, keysend_preimage) = match &self.onion_payload {
6252 OnionPayload::Invoice { _legacy_hop_data } => (_legacy_hop_data.as_ref(), None),
6253 OnionPayload::Spontaneous(preimage) => (None, Some(preimage)),
6255 write_tlv_fields!(writer, {
6256 (0, self.prev_hop, required),
6257 (1, self.total_msat, required),
6258 (2, self.value, required),
6259 (4, payment_data, option),
6260 (6, self.cltv_expiry, required),
6261 (8, keysend_preimage, option),
6267 impl Readable for ClaimableHTLC {
6268 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
6269 let mut prev_hop = ::util::ser::OptionDeserWrapper(None);
6271 let mut payment_data: Option<msgs::FinalOnionHopData> = None;
6272 let mut cltv_expiry = 0;
6273 let mut total_msat = None;
6274 let mut keysend_preimage: Option<PaymentPreimage> = None;
6275 read_tlv_fields!(reader, {
6276 (0, prev_hop, required),
6277 (1, total_msat, option),
6278 (2, value, required),
6279 (4, payment_data, option),
6280 (6, cltv_expiry, required),
6281 (8, keysend_preimage, option)
6283 let onion_payload = match keysend_preimage {
6285 if payment_data.is_some() {
6286 return Err(DecodeError::InvalidValue)
6288 if total_msat.is_none() {
6289 total_msat = Some(value);
6291 OnionPayload::Spontaneous(p)
6294 if total_msat.is_none() {
6295 if payment_data.is_none() {
6296 return Err(DecodeError::InvalidValue)
6298 total_msat = Some(payment_data.as_ref().unwrap().total_msat);
6300 OnionPayload::Invoice { _legacy_hop_data: payment_data }
6304 prev_hop: prev_hop.0.unwrap(),
6307 total_msat: total_msat.unwrap(),
6314 impl Readable for HTLCSource {
6315 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
6316 let id: u8 = Readable::read(reader)?;
6319 let mut session_priv: ::util::ser::OptionDeserWrapper<SecretKey> = ::util::ser::OptionDeserWrapper(None);
6320 let mut first_hop_htlc_msat: u64 = 0;
6321 let mut path = Some(Vec::new());
6322 let mut payment_id = None;
6323 let mut payment_secret = None;
6324 let mut payment_params = None;
6325 read_tlv_fields!(reader, {
6326 (0, session_priv, required),
6327 (1, payment_id, option),
6328 (2, first_hop_htlc_msat, required),
6329 (3, payment_secret, option),
6330 (4, path, vec_type),
6331 (5, payment_params, option),
6333 if payment_id.is_none() {
6334 // For backwards compat, if there was no payment_id written, use the session_priv bytes
6336 payment_id = Some(PaymentId(*session_priv.0.unwrap().as_ref()));
6338 Ok(HTLCSource::OutboundRoute {
6339 session_priv: session_priv.0.unwrap(),
6340 first_hop_htlc_msat: first_hop_htlc_msat,
6341 path: path.unwrap(),
6342 payment_id: payment_id.unwrap(),
6347 1 => Ok(HTLCSource::PreviousHopData(Readable::read(reader)?)),
6348 _ => Err(DecodeError::UnknownRequiredFeature),
6353 impl Writeable for HTLCSource {
6354 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::io::Error> {
6356 HTLCSource::OutboundRoute { ref session_priv, ref first_hop_htlc_msat, ref path, payment_id, payment_secret, payment_params } => {
6358 let payment_id_opt = Some(payment_id);
6359 write_tlv_fields!(writer, {
6360 (0, session_priv, required),
6361 (1, payment_id_opt, option),
6362 (2, first_hop_htlc_msat, required),
6363 (3, payment_secret, option),
6364 (4, path, vec_type),
6365 (5, payment_params, option),
6368 HTLCSource::PreviousHopData(ref field) => {
6370 field.write(writer)?;
6377 impl_writeable_tlv_based_enum!(HTLCFailReason,
6378 (0, LightningError) => {
6382 (0, failure_code, required),
6383 (2, data, vec_type),
6387 impl_writeable_tlv_based_enum!(HTLCForwardInfo,
6389 (0, forward_info, required),
6390 (2, prev_short_channel_id, required),
6391 (4, prev_htlc_id, required),
6392 (6, prev_funding_outpoint, required),
6395 (0, htlc_id, required),
6396 (2, err_packet, required),
6400 impl_writeable_tlv_based!(PendingInboundPayment, {
6401 (0, payment_secret, required),
6402 (2, expiry_time, required),
6403 (4, user_payment_id, required),
6404 (6, payment_preimage, required),
6405 (8, min_value_msat, required),
6408 impl_writeable_tlv_based_enum_upgradable!(PendingOutboundPayment,
6410 (0, session_privs, required),
6413 (0, session_privs, required),
6414 (1, payment_hash, option),
6417 (0, session_privs, required),
6418 (1, pending_fee_msat, option),
6419 (2, payment_hash, required),
6420 (4, payment_secret, option),
6421 (6, total_msat, required),
6422 (8, pending_amt_msat, required),
6423 (10, starting_block_height, required),
6426 (0, session_privs, required),
6427 (2, payment_hash, required),
6431 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> Writeable for ChannelManager<Signer, M, T, K, F, L>
6432 where M::Target: chain::Watch<Signer>,
6433 T::Target: BroadcasterInterface,
6434 K::Target: KeysInterface<Signer = Signer>,
6435 F::Target: FeeEstimator,
6438 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6439 let _consistency_lock = self.total_consistency_lock.write().unwrap();
6441 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
6443 self.genesis_hash.write(writer)?;
6445 let best_block = self.best_block.read().unwrap();
6446 best_block.height().write(writer)?;
6447 best_block.block_hash().write(writer)?;
6450 let channel_state = self.channel_state.lock().unwrap();
6451 let mut unfunded_channels = 0;
6452 for (_, channel) in channel_state.by_id.iter() {
6453 if !channel.is_funding_initiated() {
6454 unfunded_channels += 1;
6457 ((channel_state.by_id.len() - unfunded_channels) as u64).write(writer)?;
6458 for (_, channel) in channel_state.by_id.iter() {
6459 if channel.is_funding_initiated() {
6460 channel.write(writer)?;
6464 (channel_state.forward_htlcs.len() as u64).write(writer)?;
6465 for (short_channel_id, pending_forwards) in channel_state.forward_htlcs.iter() {
6466 short_channel_id.write(writer)?;
6467 (pending_forwards.len() as u64).write(writer)?;
6468 for forward in pending_forwards {
6469 forward.write(writer)?;
6473 let mut htlc_purposes: Vec<&events::PaymentPurpose> = Vec::new();
6474 (channel_state.claimable_htlcs.len() as u64).write(writer)?;
6475 for (payment_hash, (purpose, previous_hops)) in channel_state.claimable_htlcs.iter() {
6476 payment_hash.write(writer)?;
6477 (previous_hops.len() as u64).write(writer)?;
6478 for htlc in previous_hops.iter() {
6479 htlc.write(writer)?;
6481 htlc_purposes.push(purpose);
6484 let per_peer_state = self.per_peer_state.write().unwrap();
6485 (per_peer_state.len() as u64).write(writer)?;
6486 for (peer_pubkey, peer_state_mutex) in per_peer_state.iter() {
6487 peer_pubkey.write(writer)?;
6488 let peer_state = peer_state_mutex.lock().unwrap();
6489 peer_state.latest_features.write(writer)?;
6492 let pending_inbound_payments = self.pending_inbound_payments.lock().unwrap();
6493 let pending_outbound_payments = self.pending_outbound_payments.lock().unwrap();
6494 let events = self.pending_events.lock().unwrap();
6495 (events.len() as u64).write(writer)?;
6496 for event in events.iter() {
6497 event.write(writer)?;
6500 let background_events = self.pending_background_events.lock().unwrap();
6501 (background_events.len() as u64).write(writer)?;
6502 for event in background_events.iter() {
6504 BackgroundEvent::ClosingMonitorUpdate((funding_txo, monitor_update)) => {
6506 funding_txo.write(writer)?;
6507 monitor_update.write(writer)?;
6512 (self.last_node_announcement_serial.load(Ordering::Acquire) as u32).write(writer)?;
6513 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
6515 (pending_inbound_payments.len() as u64).write(writer)?;
6516 for (hash, pending_payment) in pending_inbound_payments.iter() {
6517 hash.write(writer)?;
6518 pending_payment.write(writer)?;
6521 // For backwards compat, write the session privs and their total length.
6522 let mut num_pending_outbounds_compat: u64 = 0;
6523 for (_, outbound) in pending_outbound_payments.iter() {
6524 if !outbound.is_fulfilled() && !outbound.abandoned() {
6525 num_pending_outbounds_compat += outbound.remaining_parts() as u64;
6528 num_pending_outbounds_compat.write(writer)?;
6529 for (_, outbound) in pending_outbound_payments.iter() {
6531 PendingOutboundPayment::Legacy { session_privs } |
6532 PendingOutboundPayment::Retryable { session_privs, .. } => {
6533 for session_priv in session_privs.iter() {
6534 session_priv.write(writer)?;
6537 PendingOutboundPayment::Fulfilled { .. } => {},
6538 PendingOutboundPayment::Abandoned { .. } => {},
6542 // Encode without retry info for 0.0.101 compatibility.
6543 let mut pending_outbound_payments_no_retry: HashMap<PaymentId, HashSet<[u8; 32]>> = HashMap::new();
6544 for (id, outbound) in pending_outbound_payments.iter() {
6546 PendingOutboundPayment::Legacy { session_privs } |
6547 PendingOutboundPayment::Retryable { session_privs, .. } => {
6548 pending_outbound_payments_no_retry.insert(*id, session_privs.clone());
6553 write_tlv_fields!(writer, {
6554 (1, pending_outbound_payments_no_retry, required),
6555 (3, pending_outbound_payments, required),
6556 (5, self.our_network_pubkey, required),
6557 (7, self.fake_scid_rand_bytes, required),
6558 (9, htlc_purposes, vec_type),
6565 /// Arguments for the creation of a ChannelManager that are not deserialized.
6567 /// At a high-level, the process for deserializing a ChannelManager and resuming normal operation
6569 /// 1) Deserialize all stored [`ChannelMonitor`]s.
6570 /// 2) Deserialize the [`ChannelManager`] by filling in this struct and calling:
6571 /// `<(BlockHash, ChannelManager)>::read(reader, args)`
6572 /// This may result in closing some channels if the [`ChannelMonitor`] is newer than the stored
6573 /// [`ChannelManager`] state to ensure no loss of funds. Thus, transactions may be broadcasted.
6574 /// 3) If you are not fetching full blocks, register all relevant [`ChannelMonitor`] outpoints the
6575 /// same way you would handle a [`chain::Filter`] call using
6576 /// [`ChannelMonitor::get_outputs_to_watch`] and [`ChannelMonitor::get_funding_txo`].
6577 /// 4) Reconnect blocks on your [`ChannelMonitor`]s.
6578 /// 5) Disconnect/connect blocks on the [`ChannelManager`].
6579 /// 6) Re-persist the [`ChannelMonitor`]s to ensure the latest state is on disk.
6580 /// Note that if you're using a [`ChainMonitor`] for your [`chain::Watch`] implementation, you
6581 /// will likely accomplish this as a side-effect of calling [`chain::Watch::watch_channel`] in
6583 /// 7) Move the [`ChannelMonitor`]s into your local [`chain::Watch`]. If you're using a
6584 /// [`ChainMonitor`], this is done by calling [`chain::Watch::watch_channel`].
6586 /// Note that the ordering of #4-7 is not of importance, however all four must occur before you
6587 /// call any other methods on the newly-deserialized [`ChannelManager`].
6589 /// Note that because some channels may be closed during deserialization, it is critical that you
6590 /// always deserialize only the latest version of a ChannelManager and ChannelMonitors available to
6591 /// you. If you deserialize an old ChannelManager (during which force-closure transactions may be
6592 /// broadcast), and then later deserialize a newer version of the same ChannelManager (which will
6593 /// not force-close the same channels but consider them live), you may end up revoking a state for
6594 /// which you've already broadcasted the transaction.
6596 /// [`ChainMonitor`]: crate::chain::chainmonitor::ChainMonitor
6597 pub struct ChannelManagerReadArgs<'a, Signer: 'a + Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
6598 where M::Target: chain::Watch<Signer>,
6599 T::Target: BroadcasterInterface,
6600 K::Target: KeysInterface<Signer = Signer>,
6601 F::Target: FeeEstimator,
6604 /// The keys provider which will give us relevant keys. Some keys will be loaded during
6605 /// deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
6607 pub keys_manager: K,
6609 /// The fee_estimator for use in the ChannelManager in the future.
6611 /// No calls to the FeeEstimator will be made during deserialization.
6612 pub fee_estimator: F,
6613 /// The chain::Watch for use in the ChannelManager in the future.
6615 /// No calls to the chain::Watch will be made during deserialization. It is assumed that
6616 /// you have deserialized ChannelMonitors separately and will add them to your
6617 /// chain::Watch after deserializing this ChannelManager.
6618 pub chain_monitor: M,
6620 /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
6621 /// used to broadcast the latest local commitment transactions of channels which must be
6622 /// force-closed during deserialization.
6623 pub tx_broadcaster: T,
6624 /// The Logger for use in the ChannelManager and which may be used to log information during
6625 /// deserialization.
6627 /// Default settings used for new channels. Any existing channels will continue to use the
6628 /// runtime settings which were stored when the ChannelManager was serialized.
6629 pub default_config: UserConfig,
6631 /// A map from channel funding outpoints to ChannelMonitors for those channels (ie
6632 /// value.get_funding_txo() should be the key).
6634 /// If a monitor is inconsistent with the channel state during deserialization the channel will
6635 /// be force-closed using the data in the ChannelMonitor and the channel will be dropped. This
6636 /// is true for missing channels as well. If there is a monitor missing for which we find
6637 /// channel data Err(DecodeError::InvalidValue) will be returned.
6639 /// In such cases the latest local transactions will be sent to the tx_broadcaster included in
6642 /// (C-not exported) because we have no HashMap bindings
6643 pub channel_monitors: HashMap<OutPoint, &'a mut ChannelMonitor<Signer>>,
6646 impl<'a, Signer: 'a + Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
6647 ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>
6648 where M::Target: chain::Watch<Signer>,
6649 T::Target: BroadcasterInterface,
6650 K::Target: KeysInterface<Signer = Signer>,
6651 F::Target: FeeEstimator,
6654 /// Simple utility function to create a ChannelManagerReadArgs which creates the monitor
6655 /// HashMap for you. This is primarily useful for C bindings where it is not practical to
6656 /// populate a HashMap directly from C.
6657 pub fn new(keys_manager: K, fee_estimator: F, chain_monitor: M, tx_broadcaster: T, logger: L, default_config: UserConfig,
6658 mut channel_monitors: Vec<&'a mut ChannelMonitor<Signer>>) -> Self {
6660 keys_manager, fee_estimator, chain_monitor, tx_broadcaster, logger, default_config,
6661 channel_monitors: channel_monitors.drain(..).map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect()
6666 // Implement ReadableArgs for an Arc'd ChannelManager to make it a bit easier to work with the
6667 // SipmleArcChannelManager type:
6668 impl<'a, Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
6669 ReadableArgs<ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>> for (BlockHash, Arc<ChannelManager<Signer, M, T, K, F, L>>)
6670 where M::Target: chain::Watch<Signer>,
6671 T::Target: BroadcasterInterface,
6672 K::Target: KeysInterface<Signer = Signer>,
6673 F::Target: FeeEstimator,
6676 fn read<R: io::Read>(reader: &mut R, args: ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>) -> Result<Self, DecodeError> {
6677 let (blockhash, chan_manager) = <(BlockHash, ChannelManager<Signer, M, T, K, F, L>)>::read(reader, args)?;
6678 Ok((blockhash, Arc::new(chan_manager)))
6682 impl<'a, Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
6683 ReadableArgs<ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>> for (BlockHash, ChannelManager<Signer, M, T, K, F, L>)
6684 where M::Target: chain::Watch<Signer>,
6685 T::Target: BroadcasterInterface,
6686 K::Target: KeysInterface<Signer = Signer>,
6687 F::Target: FeeEstimator,
6690 fn read<R: io::Read>(reader: &mut R, mut args: ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>) -> Result<Self, DecodeError> {
6691 let _ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
6693 let genesis_hash: BlockHash = Readable::read(reader)?;
6694 let best_block_height: u32 = Readable::read(reader)?;
6695 let best_block_hash: BlockHash = Readable::read(reader)?;
6697 let mut failed_htlcs = Vec::new();
6699 let channel_count: u64 = Readable::read(reader)?;
6700 let mut funding_txo_set = HashSet::with_capacity(cmp::min(channel_count as usize, 128));
6701 let mut by_id = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
6702 let mut short_to_id = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
6703 let mut channel_closures = Vec::new();
6704 for _ in 0..channel_count {
6705 let mut channel: Channel<Signer> = Channel::read(reader, (&args.keys_manager, best_block_height))?;
6706 let funding_txo = channel.get_funding_txo().ok_or(DecodeError::InvalidValue)?;
6707 funding_txo_set.insert(funding_txo.clone());
6708 if let Some(ref mut monitor) = args.channel_monitors.get_mut(&funding_txo) {
6709 if channel.get_cur_holder_commitment_transaction_number() < monitor.get_cur_holder_commitment_number() ||
6710 channel.get_revoked_counterparty_commitment_transaction_number() < monitor.get_min_seen_secret() ||
6711 channel.get_cur_counterparty_commitment_transaction_number() < monitor.get_cur_counterparty_commitment_number() ||
6712 channel.get_latest_monitor_update_id() > monitor.get_latest_update_id() {
6713 // If the channel is ahead of the monitor, return InvalidValue:
6714 log_error!(args.logger, "A ChannelMonitor is stale compared to the current ChannelManager! This indicates a potentially-critical violation of the chain::Watch API!");
6715 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
6716 log_bytes!(channel.channel_id()), monitor.get_latest_update_id(), channel.get_latest_monitor_update_id());
6717 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
6718 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
6719 log_error!(args.logger, " Without the latest ChannelMonitor we cannot continue without risking funds.");
6720 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");
6721 return Err(DecodeError::InvalidValue);
6722 } else if channel.get_cur_holder_commitment_transaction_number() > monitor.get_cur_holder_commitment_number() ||
6723 channel.get_revoked_counterparty_commitment_transaction_number() > monitor.get_min_seen_secret() ||
6724 channel.get_cur_counterparty_commitment_transaction_number() > monitor.get_cur_counterparty_commitment_number() ||
6725 channel.get_latest_monitor_update_id() < monitor.get_latest_update_id() {
6726 // But if the channel is behind of the monitor, close the channel:
6727 log_error!(args.logger, "A ChannelManager is stale compared to the current ChannelMonitor!");
6728 log_error!(args.logger, " The channel will be force-closed and the latest commitment transaction from the ChannelMonitor broadcast.");
6729 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
6730 log_bytes!(channel.channel_id()), monitor.get_latest_update_id(), channel.get_latest_monitor_update_id());
6731 let (_, mut new_failed_htlcs) = channel.force_shutdown(true);
6732 failed_htlcs.append(&mut new_failed_htlcs);
6733 monitor.broadcast_latest_holder_commitment_txn(&args.tx_broadcaster, &args.logger);
6734 channel_closures.push(events::Event::ChannelClosed {
6735 channel_id: channel.channel_id(),
6736 user_channel_id: channel.get_user_id(),
6737 reason: ClosureReason::OutdatedChannelManager
6740 log_info!(args.logger, "Successfully loaded channel {}", log_bytes!(channel.channel_id()));
6741 if let Some(short_channel_id) = channel.get_short_channel_id() {
6742 short_to_id.insert(short_channel_id, channel.channel_id());
6744 by_id.insert(channel.channel_id(), channel);
6747 log_error!(args.logger, "Missing ChannelMonitor for channel {} needed by ChannelManager.", log_bytes!(channel.channel_id()));
6748 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
6749 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
6750 log_error!(args.logger, " Without the ChannelMonitor we cannot continue without risking funds.");
6751 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");
6752 return Err(DecodeError::InvalidValue);
6756 for (ref funding_txo, ref mut monitor) in args.channel_monitors.iter_mut() {
6757 if !funding_txo_set.contains(funding_txo) {
6758 log_info!(args.logger, "Broadcasting latest holder commitment transaction for closed channel {}", log_bytes!(funding_txo.to_channel_id()));
6759 monitor.broadcast_latest_holder_commitment_txn(&args.tx_broadcaster, &args.logger);
6763 const MAX_ALLOC_SIZE: usize = 1024 * 64;
6764 let forward_htlcs_count: u64 = Readable::read(reader)?;
6765 let mut forward_htlcs = HashMap::with_capacity(cmp::min(forward_htlcs_count as usize, 128));
6766 for _ in 0..forward_htlcs_count {
6767 let short_channel_id = Readable::read(reader)?;
6768 let pending_forwards_count: u64 = Readable::read(reader)?;
6769 let mut pending_forwards = Vec::with_capacity(cmp::min(pending_forwards_count as usize, MAX_ALLOC_SIZE/mem::size_of::<HTLCForwardInfo>()));
6770 for _ in 0..pending_forwards_count {
6771 pending_forwards.push(Readable::read(reader)?);
6773 forward_htlcs.insert(short_channel_id, pending_forwards);
6776 let claimable_htlcs_count: u64 = Readable::read(reader)?;
6777 let mut claimable_htlcs_list = Vec::with_capacity(cmp::min(claimable_htlcs_count as usize, 128));
6778 for _ in 0..claimable_htlcs_count {
6779 let payment_hash = Readable::read(reader)?;
6780 let previous_hops_len: u64 = Readable::read(reader)?;
6781 let mut previous_hops = Vec::with_capacity(cmp::min(previous_hops_len as usize, MAX_ALLOC_SIZE/mem::size_of::<ClaimableHTLC>()));
6782 for _ in 0..previous_hops_len {
6783 previous_hops.push(<ClaimableHTLC as Readable>::read(reader)?);
6785 claimable_htlcs_list.push((payment_hash, previous_hops));
6788 let peer_count: u64 = Readable::read(reader)?;
6789 let mut per_peer_state = HashMap::with_capacity(cmp::min(peer_count as usize, MAX_ALLOC_SIZE/mem::size_of::<(PublicKey, Mutex<PeerState>)>()));
6790 for _ in 0..peer_count {
6791 let peer_pubkey = Readable::read(reader)?;
6792 let peer_state = PeerState {
6793 latest_features: Readable::read(reader)?,
6795 per_peer_state.insert(peer_pubkey, Mutex::new(peer_state));
6798 let event_count: u64 = Readable::read(reader)?;
6799 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>()));
6800 for _ in 0..event_count {
6801 match MaybeReadable::read(reader)? {
6802 Some(event) => pending_events_read.push(event),
6806 if forward_htlcs_count > 0 {
6807 // If we have pending HTLCs to forward, assume we either dropped a
6808 // `PendingHTLCsForwardable` or the user received it but never processed it as they
6809 // shut down before the timer hit. Either way, set the time_forwardable to a small
6810 // constant as enough time has likely passed that we should simply handle the forwards
6811 // now, or at least after the user gets a chance to reconnect to our peers.
6812 pending_events_read.push(events::Event::PendingHTLCsForwardable {
6813 time_forwardable: Duration::from_secs(2),
6817 let background_event_count: u64 = Readable::read(reader)?;
6818 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>()));
6819 for _ in 0..background_event_count {
6820 match <u8 as Readable>::read(reader)? {
6821 0 => pending_background_events_read.push(BackgroundEvent::ClosingMonitorUpdate((Readable::read(reader)?, Readable::read(reader)?))),
6822 _ => return Err(DecodeError::InvalidValue),
6826 let last_node_announcement_serial: u32 = Readable::read(reader)?;
6827 let highest_seen_timestamp: u32 = Readable::read(reader)?;
6829 let pending_inbound_payment_count: u64 = Readable::read(reader)?;
6830 let mut pending_inbound_payments: HashMap<PaymentHash, PendingInboundPayment> = HashMap::with_capacity(cmp::min(pending_inbound_payment_count as usize, MAX_ALLOC_SIZE/(3*32)));
6831 for _ in 0..pending_inbound_payment_count {
6832 if pending_inbound_payments.insert(Readable::read(reader)?, Readable::read(reader)?).is_some() {
6833 return Err(DecodeError::InvalidValue);
6837 let pending_outbound_payments_count_compat: u64 = Readable::read(reader)?;
6838 let mut pending_outbound_payments_compat: HashMap<PaymentId, PendingOutboundPayment> =
6839 HashMap::with_capacity(cmp::min(pending_outbound_payments_count_compat as usize, MAX_ALLOC_SIZE/32));
6840 for _ in 0..pending_outbound_payments_count_compat {
6841 let session_priv = Readable::read(reader)?;
6842 let payment = PendingOutboundPayment::Legacy {
6843 session_privs: [session_priv].iter().cloned().collect()
6845 if pending_outbound_payments_compat.insert(PaymentId(session_priv), payment).is_some() {
6846 return Err(DecodeError::InvalidValue)
6850 // pending_outbound_payments_no_retry is for compatibility with 0.0.101 clients.
6851 let mut pending_outbound_payments_no_retry: Option<HashMap<PaymentId, HashSet<[u8; 32]>>> = None;
6852 let mut pending_outbound_payments = None;
6853 let mut received_network_pubkey: Option<PublicKey> = None;
6854 let mut fake_scid_rand_bytes: Option<[u8; 32]> = None;
6855 let mut claimable_htlc_purposes = None;
6856 read_tlv_fields!(reader, {
6857 (1, pending_outbound_payments_no_retry, option),
6858 (3, pending_outbound_payments, option),
6859 (5, received_network_pubkey, option),
6860 (7, fake_scid_rand_bytes, option),
6861 (9, claimable_htlc_purposes, vec_type),
6863 if fake_scid_rand_bytes.is_none() {
6864 fake_scid_rand_bytes = Some(args.keys_manager.get_secure_random_bytes());
6867 if pending_outbound_payments.is_none() && pending_outbound_payments_no_retry.is_none() {
6868 pending_outbound_payments = Some(pending_outbound_payments_compat);
6869 } else if pending_outbound_payments.is_none() {
6870 let mut outbounds = HashMap::new();
6871 for (id, session_privs) in pending_outbound_payments_no_retry.unwrap().drain() {
6872 outbounds.insert(id, PendingOutboundPayment::Legacy { session_privs });
6874 pending_outbound_payments = Some(outbounds);
6876 // If we're tracking pending payments, ensure we haven't lost any by looking at the
6877 // ChannelMonitor data for any channels for which we do not have authorative state
6878 // (i.e. those for which we just force-closed above or we otherwise don't have a
6879 // corresponding `Channel` at all).
6880 // This avoids several edge-cases where we would otherwise "forget" about pending
6881 // payments which are still in-flight via their on-chain state.
6882 // We only rebuild the pending payments map if we were most recently serialized by
6884 for (_, monitor) in args.channel_monitors.iter() {
6885 if by_id.get(&monitor.get_funding_txo().0.to_channel_id()).is_none() {
6886 for (htlc_source, htlc) in monitor.get_pending_outbound_htlcs() {
6887 if let HTLCSource::OutboundRoute { payment_id, session_priv, path, payment_secret, .. } = htlc_source {
6888 if path.is_empty() {
6889 log_error!(args.logger, "Got an empty path for a pending payment");
6890 return Err(DecodeError::InvalidValue);
6892 let path_amt = path.last().unwrap().fee_msat;
6893 let mut session_priv_bytes = [0; 32];
6894 session_priv_bytes[..].copy_from_slice(&session_priv[..]);
6895 match pending_outbound_payments.as_mut().unwrap().entry(payment_id) {
6896 hash_map::Entry::Occupied(mut entry) => {
6897 let newly_added = entry.get_mut().insert(session_priv_bytes, &path);
6898 log_info!(args.logger, "{} a pending payment path for {} msat for session priv {} on an existing pending payment with payment hash {}",
6899 if newly_added { "Added" } else { "Had" }, path_amt, log_bytes!(session_priv_bytes), log_bytes!(htlc.payment_hash.0));
6901 hash_map::Entry::Vacant(entry) => {
6902 let path_fee = path.get_path_fees();
6903 entry.insert(PendingOutboundPayment::Retryable {
6904 session_privs: [session_priv_bytes].iter().map(|a| *a).collect(),
6905 payment_hash: htlc.payment_hash,
6907 pending_amt_msat: path_amt,
6908 pending_fee_msat: Some(path_fee),
6909 total_msat: path_amt,
6910 starting_block_height: best_block_height,
6912 log_info!(args.logger, "Added a pending payment for {} msat with payment hash {} for path with session priv {}",
6913 path_amt, log_bytes!(htlc.payment_hash.0), log_bytes!(session_priv_bytes));
6922 let inbound_pmt_key_material = args.keys_manager.get_inbound_payment_key_material();
6923 let expanded_inbound_key = inbound_payment::ExpandedKey::new(&inbound_pmt_key_material);
6925 let mut claimable_htlcs = HashMap::with_capacity(claimable_htlcs_list.len());
6926 if let Some(mut purposes) = claimable_htlc_purposes {
6927 if purposes.len() != claimable_htlcs_list.len() {
6928 return Err(DecodeError::InvalidValue);
6930 for (purpose, (payment_hash, previous_hops)) in purposes.drain(..).zip(claimable_htlcs_list.drain(..)) {
6931 claimable_htlcs.insert(payment_hash, (purpose, previous_hops));
6934 // LDK versions prior to 0.0.107 did not write a `pending_htlc_purposes`, but do
6935 // include a `_legacy_hop_data` in the `OnionPayload`.
6936 for (payment_hash, previous_hops) in claimable_htlcs_list.drain(..) {
6937 if previous_hops.is_empty() {
6938 return Err(DecodeError::InvalidValue);
6940 let purpose = match &previous_hops[0].onion_payload {
6941 OnionPayload::Invoice { _legacy_hop_data } => {
6942 if let Some(hop_data) = _legacy_hop_data {
6943 events::PaymentPurpose::InvoicePayment {
6944 payment_preimage: match pending_inbound_payments.get(&payment_hash) {
6945 Some(inbound_payment) => inbound_payment.payment_preimage,
6946 None => match inbound_payment::verify(payment_hash, &hop_data, 0, &expanded_inbound_key, &args.logger) {
6947 Ok(payment_preimage) => payment_preimage,
6949 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));
6950 return Err(DecodeError::InvalidValue);
6954 payment_secret: hop_data.payment_secret,
6956 } else { return Err(DecodeError::InvalidValue); }
6958 OnionPayload::Spontaneous(payment_preimage) =>
6959 events::PaymentPurpose::SpontaneousPayment(*payment_preimage),
6961 claimable_htlcs.insert(payment_hash, (purpose, previous_hops));
6965 let mut secp_ctx = Secp256k1::new();
6966 secp_ctx.seeded_randomize(&args.keys_manager.get_secure_random_bytes());
6968 if !channel_closures.is_empty() {
6969 pending_events_read.append(&mut channel_closures);
6972 let our_network_key = match args.keys_manager.get_node_secret(Recipient::Node) {
6974 Err(()) => return Err(DecodeError::InvalidValue)
6976 let our_network_pubkey = PublicKey::from_secret_key(&secp_ctx, &our_network_key);
6977 if let Some(network_pubkey) = received_network_pubkey {
6978 if network_pubkey != our_network_pubkey {
6979 log_error!(args.logger, "Key that was generated does not match the existing key.");
6980 return Err(DecodeError::InvalidValue);
6984 let mut outbound_scid_aliases = HashSet::new();
6985 for (chan_id, chan) in by_id.iter_mut() {
6986 if chan.outbound_scid_alias() == 0 {
6987 let mut outbound_scid_alias;
6989 outbound_scid_alias = fake_scid::Namespace::OutboundAlias
6990 .get_fake_scid(best_block_height, &genesis_hash, fake_scid_rand_bytes.as_ref().unwrap(), &args.keys_manager);
6991 if outbound_scid_aliases.insert(outbound_scid_alias) { break; }
6993 chan.set_outbound_scid_alias(outbound_scid_alias);
6994 } else if !outbound_scid_aliases.insert(chan.outbound_scid_alias()) {
6995 // Note that in rare cases its possible to hit this while reading an older
6996 // channel if we just happened to pick a colliding outbound alias above.
6997 log_error!(args.logger, "Got duplicate outbound SCID alias; {}", chan.outbound_scid_alias());
6998 return Err(DecodeError::InvalidValue);
7000 if chan.is_usable() {
7001 if short_to_id.insert(chan.outbound_scid_alias(), *chan_id).is_some() {
7002 // Note that in rare cases its possible to hit this while reading an older
7003 // channel if we just happened to pick a colliding outbound alias above.
7004 log_error!(args.logger, "Got duplicate outbound SCID alias; {}", chan.outbound_scid_alias());
7005 return Err(DecodeError::InvalidValue);
7010 for (_, monitor) in args.channel_monitors.iter() {
7011 for (payment_hash, payment_preimage) in monitor.get_stored_preimages() {
7012 if let Some((payment_purpose, claimable_htlcs)) = claimable_htlcs.remove(&payment_hash) {
7013 log_info!(args.logger, "Re-claiming HTLCs with payment hash {} as we've released the preimage to a ChannelMonitor!", log_bytes!(payment_hash.0));
7014 let mut claimable_amt_msat = 0;
7015 for claimable_htlc in claimable_htlcs {
7016 claimable_amt_msat += claimable_htlc.value;
7018 // Add a holding-cell claim of the payment to the Channel, which should be
7019 // applied ~immediately on peer reconnection. Because it won't generate a
7020 // new commitment transaction we can just provide the payment preimage to
7021 // the corresponding ChannelMonitor and nothing else.
7023 // We do so directly instead of via the normal ChannelMonitor update
7024 // procedure as the ChainMonitor hasn't yet been initialized, implying
7025 // we're not allowed to call it directly yet. Further, we do the update
7026 // without incrementing the ChannelMonitor update ID as there isn't any
7028 // If we were to generate a new ChannelMonitor update ID here and then
7029 // crash before the user finishes block connect we'd end up force-closing
7030 // this channel as well. On the flip side, there's no harm in restarting
7031 // without the new monitor persisted - we'll end up right back here on
7033 let previous_channel_id = claimable_htlc.prev_hop.outpoint.to_channel_id();
7034 if let Some(channel) = by_id.get_mut(&previous_channel_id) {
7035 channel.claim_htlc_while_disconnected_dropping_mon_update(claimable_htlc.prev_hop.htlc_id, payment_preimage, &args.logger);
7037 if let Some(previous_hop_monitor) = args.channel_monitors.get(&claimable_htlc.prev_hop.outpoint) {
7038 previous_hop_monitor.provide_payment_preimage(&payment_hash, &payment_preimage, &args.tx_broadcaster, &args.fee_estimator, &args.logger);
7041 pending_events_read.push(events::Event::PaymentClaimed {
7043 purpose: payment_purpose,
7044 amount_msat: claimable_amt_msat,
7050 let channel_manager = ChannelManager {
7052 fee_estimator: args.fee_estimator,
7053 chain_monitor: args.chain_monitor,
7054 tx_broadcaster: args.tx_broadcaster,
7056 best_block: RwLock::new(BestBlock::new(best_block_hash, best_block_height)),
7058 channel_state: Mutex::new(ChannelHolder {
7063 pending_msg_events: Vec::new(),
7065 inbound_payment_key: expanded_inbound_key,
7066 pending_inbound_payments: Mutex::new(pending_inbound_payments),
7067 pending_outbound_payments: Mutex::new(pending_outbound_payments.unwrap()),
7069 outbound_scid_aliases: Mutex::new(outbound_scid_aliases),
7070 fake_scid_rand_bytes: fake_scid_rand_bytes.unwrap(),
7076 last_node_announcement_serial: AtomicUsize::new(last_node_announcement_serial as usize),
7077 highest_seen_timestamp: AtomicUsize::new(highest_seen_timestamp as usize),
7079 per_peer_state: RwLock::new(per_peer_state),
7081 pending_events: Mutex::new(pending_events_read),
7082 pending_background_events: Mutex::new(pending_background_events_read),
7083 total_consistency_lock: RwLock::new(()),
7084 persistence_notifier: PersistenceNotifier::new(),
7086 keys_manager: args.keys_manager,
7087 logger: args.logger,
7088 default_configuration: args.default_config,
7091 for htlc_source in failed_htlcs.drain(..) {
7092 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() });
7095 //TODO: Broadcast channel update for closed channels, but only after we've made a
7096 //connection or two.
7098 Ok((best_block_hash.clone(), channel_manager))
7104 use bitcoin::hashes::Hash;
7105 use bitcoin::hashes::sha256::Hash as Sha256;
7106 use core::time::Duration;
7107 use core::sync::atomic::Ordering;
7108 use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
7109 use ln::channelmanager::{PaymentId, PaymentSendFailure};
7110 use ln::channelmanager::inbound_payment;
7111 use ln::features::InitFeatures;
7112 use ln::functional_test_utils::*;
7114 use ln::msgs::ChannelMessageHandler;
7115 use routing::router::{PaymentParameters, RouteParameters, find_route};
7116 use util::errors::APIError;
7117 use util::events::{Event, MessageSendEvent, MessageSendEventsProvider};
7118 use util::test_utils;
7119 use chain::keysinterface::KeysInterface;
7121 #[cfg(feature = "std")]
7123 fn test_wait_timeout() {
7124 use ln::channelmanager::PersistenceNotifier;
7126 use core::sync::atomic::AtomicBool;
7129 let persistence_notifier = Arc::new(PersistenceNotifier::new());
7130 let thread_notifier = Arc::clone(&persistence_notifier);
7132 let exit_thread = Arc::new(AtomicBool::new(false));
7133 let exit_thread_clone = exit_thread.clone();
7134 thread::spawn(move || {
7136 let &(ref persist_mtx, ref cnd) = &thread_notifier.persistence_lock;
7137 let mut persistence_lock = persist_mtx.lock().unwrap();
7138 *persistence_lock = true;
7141 if exit_thread_clone.load(Ordering::SeqCst) {
7147 // Check that we can block indefinitely until updates are available.
7148 let _ = persistence_notifier.wait();
7150 // Check that the PersistenceNotifier will return after the given duration if updates are
7153 if persistence_notifier.wait_timeout(Duration::from_millis(100)) {
7158 exit_thread.store(true, Ordering::SeqCst);
7160 // Check that the PersistenceNotifier will return after the given duration even if no updates
7163 if !persistence_notifier.wait_timeout(Duration::from_millis(100)) {
7170 fn test_notify_limits() {
7171 // Check that a few cases which don't require the persistence of a new ChannelManager,
7172 // indeed, do not cause the persistence of a new ChannelManager.
7173 let chanmon_cfgs = create_chanmon_cfgs(3);
7174 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7175 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7176 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7178 // All nodes start with a persistable update pending as `create_network` connects each node
7179 // with all other nodes to make most tests simpler.
7180 assert!(nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7181 assert!(nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7182 assert!(nodes[2].node.await_persistable_update_timeout(Duration::from_millis(1)));
7184 let mut chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7186 // We check that the channel info nodes have doesn't change too early, even though we try
7187 // to connect messages with new values
7188 chan.0.contents.fee_base_msat *= 2;
7189 chan.1.contents.fee_base_msat *= 2;
7190 let node_a_chan_info = nodes[0].node.list_channels()[0].clone();
7191 let node_b_chan_info = nodes[1].node.list_channels()[0].clone();
7193 // The first two nodes (which opened a channel) should now require fresh persistence
7194 assert!(nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7195 assert!(nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7196 // ... but the last node should not.
7197 assert!(!nodes[2].node.await_persistable_update_timeout(Duration::from_millis(1)));
7198 // After persisting the first two nodes they should no longer need fresh persistence.
7199 assert!(!nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7200 assert!(!nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7202 // Node 3, unrelated to the only channel, shouldn't care if it receives a channel_update
7203 // about the channel.
7204 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.0);
7205 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.1);
7206 assert!(!nodes[2].node.await_persistable_update_timeout(Duration::from_millis(1)));
7208 // The nodes which are a party to the channel should also ignore messages from unrelated
7210 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
7211 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
7212 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
7213 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
7214 assert!(!nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7215 assert!(!nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7217 // At this point the channel info given by peers should still be the same.
7218 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
7219 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
7221 // An earlier version of handle_channel_update didn't check the directionality of the
7222 // update message and would always update the local fee info, even if our peer was
7223 // (spuriously) forwarding us our own channel_update.
7224 let as_node_one = nodes[0].node.get_our_node_id().serialize()[..] < nodes[1].node.get_our_node_id().serialize()[..];
7225 let as_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.0 } else { &chan.1 };
7226 let bs_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.1 } else { &chan.0 };
7228 // First deliver each peers' own message, checking that the node doesn't need to be
7229 // persisted and that its channel info remains the same.
7230 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &as_update);
7231 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &bs_update);
7232 assert!(!nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7233 assert!(!nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7234 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
7235 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
7237 // Finally, deliver the other peers' message, ensuring each node needs to be persisted and
7238 // the channel info has updated.
7239 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &bs_update);
7240 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &as_update);
7241 assert!(nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7242 assert!(nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7243 assert_ne!(nodes[0].node.list_channels()[0], node_a_chan_info);
7244 assert_ne!(nodes[1].node.list_channels()[0], node_b_chan_info);
7248 fn test_keysend_dup_hash_partial_mpp() {
7249 // Test that a keysend payment with a duplicate hash to an existing partial MPP payment fails as
7251 let chanmon_cfgs = create_chanmon_cfgs(2);
7252 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7253 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7254 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7255 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7257 // First, send a partial MPP payment.
7258 let (route, our_payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[1], 100_000);
7259 let payment_id = PaymentId([42; 32]);
7260 // Use the utility function send_payment_along_path to send the payment with MPP data which
7261 // indicates there are more HTLCs coming.
7262 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.
7263 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();
7264 check_added_monitors!(nodes[0], 1);
7265 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7266 assert_eq!(events.len(), 1);
7267 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false, None);
7269 // Next, send a keysend payment with the same payment_hash and make sure it fails.
7270 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage)).unwrap();
7271 check_added_monitors!(nodes[0], 1);
7272 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7273 assert_eq!(events.len(), 1);
7274 let ev = events.drain(..).next().unwrap();
7275 let payment_event = SendEvent::from_event(ev);
7276 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7277 check_added_monitors!(nodes[1], 0);
7278 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7279 expect_pending_htlcs_forwardable!(nodes[1]);
7280 expect_pending_htlcs_forwardable!(nodes[1]);
7281 check_added_monitors!(nodes[1], 1);
7282 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7283 assert!(updates.update_add_htlcs.is_empty());
7284 assert!(updates.update_fulfill_htlcs.is_empty());
7285 assert_eq!(updates.update_fail_htlcs.len(), 1);
7286 assert!(updates.update_fail_malformed_htlcs.is_empty());
7287 assert!(updates.update_fee.is_none());
7288 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
7289 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
7290 expect_payment_failed!(nodes[0], our_payment_hash, true);
7292 // Send the second half of the original MPP payment.
7293 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();
7294 check_added_monitors!(nodes[0], 1);
7295 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7296 assert_eq!(events.len(), 1);
7297 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), true, None);
7299 // Claim the full MPP payment. Note that we can't use a test utility like
7300 // claim_funds_along_route because the ordering of the messages causes the second half of the
7301 // payment to be put in the holding cell, which confuses the test utilities. So we exchange the
7302 // lightning messages manually.
7303 nodes[1].node.claim_funds(payment_preimage);
7304 expect_payment_claimed!(nodes[1], our_payment_hash, 200_000);
7305 check_added_monitors!(nodes[1], 2);
7307 let bs_first_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7308 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_first_updates.update_fulfill_htlcs[0]);
7309 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_first_updates.commitment_signed);
7310 check_added_monitors!(nodes[0], 1);
7311 let (as_first_raa, as_first_cs) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7312 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_first_raa);
7313 check_added_monitors!(nodes[1], 1);
7314 let bs_second_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7315 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_first_cs);
7316 check_added_monitors!(nodes[1], 1);
7317 let bs_first_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
7318 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_second_updates.update_fulfill_htlcs[0]);
7319 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_updates.commitment_signed);
7320 check_added_monitors!(nodes[0], 1);
7321 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
7322 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
7323 let as_second_updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7324 check_added_monitors!(nodes[0], 1);
7325 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
7326 check_added_monitors!(nodes[1], 1);
7327 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_updates.commitment_signed);
7328 check_added_monitors!(nodes[1], 1);
7329 let bs_third_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
7330 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_third_raa);
7331 check_added_monitors!(nodes[0], 1);
7333 // Note that successful MPP payments will generate a single PaymentSent event upon the first
7334 // path's success and a PaymentPathSuccessful event for each path's success.
7335 let events = nodes[0].node.get_and_clear_pending_events();
7336 assert_eq!(events.len(), 3);
7338 Event::PaymentSent { payment_id: ref id, payment_preimage: ref preimage, payment_hash: ref hash, .. } => {
7339 assert_eq!(Some(payment_id), *id);
7340 assert_eq!(payment_preimage, *preimage);
7341 assert_eq!(our_payment_hash, *hash);
7343 _ => panic!("Unexpected event"),
7346 Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
7347 assert_eq!(payment_id, *actual_payment_id);
7348 assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
7349 assert_eq!(route.paths[0], *path);
7351 _ => panic!("Unexpected event"),
7354 Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
7355 assert_eq!(payment_id, *actual_payment_id);
7356 assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
7357 assert_eq!(route.paths[0], *path);
7359 _ => panic!("Unexpected event"),
7364 fn test_keysend_dup_payment_hash() {
7365 // (1): Test that a keysend payment with a duplicate payment hash to an existing pending
7366 // outbound regular payment fails as expected.
7367 // (2): Test that a regular payment with a duplicate payment hash to an existing keysend payment
7368 // fails as expected.
7369 let chanmon_cfgs = create_chanmon_cfgs(2);
7370 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7371 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7372 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7373 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7374 let scorer = test_utils::TestScorer::with_penalty(0);
7375 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
7377 // To start (1), send a regular payment but don't claim it.
7378 let expected_route = [&nodes[1]];
7379 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &expected_route, 100_000);
7381 // Next, attempt a keysend payment and make sure it fails.
7382 let route_params = RouteParameters {
7383 payment_params: PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id()),
7384 final_value_msat: 100_000,
7385 final_cltv_expiry_delta: TEST_FINAL_CLTV,
7387 let route = find_route(
7388 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph.read_only(),
7389 None, nodes[0].logger, &scorer, &random_seed_bytes
7391 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage)).unwrap();
7392 check_added_monitors!(nodes[0], 1);
7393 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7394 assert_eq!(events.len(), 1);
7395 let ev = events.drain(..).next().unwrap();
7396 let payment_event = SendEvent::from_event(ev);
7397 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7398 check_added_monitors!(nodes[1], 0);
7399 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7400 expect_pending_htlcs_forwardable!(nodes[1]);
7401 expect_pending_htlcs_forwardable!(nodes[1]);
7402 check_added_monitors!(nodes[1], 1);
7403 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7404 assert!(updates.update_add_htlcs.is_empty());
7405 assert!(updates.update_fulfill_htlcs.is_empty());
7406 assert_eq!(updates.update_fail_htlcs.len(), 1);
7407 assert!(updates.update_fail_malformed_htlcs.is_empty());
7408 assert!(updates.update_fee.is_none());
7409 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
7410 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
7411 expect_payment_failed!(nodes[0], payment_hash, true);
7413 // Finally, claim the original payment.
7414 claim_payment(&nodes[0], &expected_route, payment_preimage);
7416 // To start (2), send a keysend payment but don't claim it.
7417 let payment_preimage = PaymentPreimage([42; 32]);
7418 let route = find_route(
7419 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph.read_only(),
7420 None, nodes[0].logger, &scorer, &random_seed_bytes
7422 let (payment_hash, _) = nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage)).unwrap();
7423 check_added_monitors!(nodes[0], 1);
7424 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7425 assert_eq!(events.len(), 1);
7426 let event = events.pop().unwrap();
7427 let path = vec![&nodes[1]];
7428 pass_along_path(&nodes[0], &path, 100_000, payment_hash, None, event, true, Some(payment_preimage));
7430 // Next, attempt a regular payment and make sure it fails.
7431 let payment_secret = PaymentSecret([43; 32]);
7432 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
7433 check_added_monitors!(nodes[0], 1);
7434 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7435 assert_eq!(events.len(), 1);
7436 let ev = events.drain(..).next().unwrap();
7437 let payment_event = SendEvent::from_event(ev);
7438 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7439 check_added_monitors!(nodes[1], 0);
7440 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7441 expect_pending_htlcs_forwardable!(nodes[1]);
7442 expect_pending_htlcs_forwardable!(nodes[1]);
7443 check_added_monitors!(nodes[1], 1);
7444 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7445 assert!(updates.update_add_htlcs.is_empty());
7446 assert!(updates.update_fulfill_htlcs.is_empty());
7447 assert_eq!(updates.update_fail_htlcs.len(), 1);
7448 assert!(updates.update_fail_malformed_htlcs.is_empty());
7449 assert!(updates.update_fee.is_none());
7450 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
7451 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
7452 expect_payment_failed!(nodes[0], payment_hash, true);
7454 // Finally, succeed the keysend payment.
7455 claim_payment(&nodes[0], &expected_route, payment_preimage);
7459 fn test_keysend_hash_mismatch() {
7460 // Test that if we receive a keysend `update_add_htlc` msg, we fail as expected if the keysend
7461 // preimage doesn't match the msg's payment hash.
7462 let chanmon_cfgs = create_chanmon_cfgs(2);
7463 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7464 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7465 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7467 let payer_pubkey = nodes[0].node.get_our_node_id();
7468 let payee_pubkey = nodes[1].node.get_our_node_id();
7469 nodes[0].node.peer_connected(&payee_pubkey, &msgs::Init { features: InitFeatures::known(), remote_network_address: None });
7470 nodes[1].node.peer_connected(&payer_pubkey, &msgs::Init { features: InitFeatures::known(), remote_network_address: None });
7472 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
7473 let route_params = RouteParameters {
7474 payment_params: PaymentParameters::for_keysend(payee_pubkey),
7475 final_value_msat: 10000,
7476 final_cltv_expiry_delta: 40,
7478 let network_graph = nodes[0].network_graph;
7479 let first_hops = nodes[0].node.list_usable_channels();
7480 let scorer = test_utils::TestScorer::with_penalty(0);
7481 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
7482 let route = find_route(
7483 &payer_pubkey, &route_params, &network_graph.read_only(),
7484 Some(&first_hops.iter().collect::<Vec<_>>()), nodes[0].logger, &scorer,
7488 let test_preimage = PaymentPreimage([42; 32]);
7489 let mismatch_payment_hash = PaymentHash([43; 32]);
7490 let _ = nodes[0].node.send_payment_internal(&route, mismatch_payment_hash, &None, Some(test_preimage), None, None).unwrap();
7491 check_added_monitors!(nodes[0], 1);
7493 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7494 assert_eq!(updates.update_add_htlcs.len(), 1);
7495 assert!(updates.update_fulfill_htlcs.is_empty());
7496 assert!(updates.update_fail_htlcs.is_empty());
7497 assert!(updates.update_fail_malformed_htlcs.is_empty());
7498 assert!(updates.update_fee.is_none());
7499 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7501 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Payment preimage didn't match payment hash".to_string(), 1);
7505 fn test_keysend_msg_with_secret_err() {
7506 // Test that we error as expected if we receive a keysend payment that includes a payment secret.
7507 let chanmon_cfgs = create_chanmon_cfgs(2);
7508 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7509 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7510 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7512 let payer_pubkey = nodes[0].node.get_our_node_id();
7513 let payee_pubkey = nodes[1].node.get_our_node_id();
7514 nodes[0].node.peer_connected(&payee_pubkey, &msgs::Init { features: InitFeatures::known(), remote_network_address: None });
7515 nodes[1].node.peer_connected(&payer_pubkey, &msgs::Init { features: InitFeatures::known(), remote_network_address: None });
7517 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
7518 let route_params = RouteParameters {
7519 payment_params: PaymentParameters::for_keysend(payee_pubkey),
7520 final_value_msat: 10000,
7521 final_cltv_expiry_delta: 40,
7523 let network_graph = nodes[0].network_graph;
7524 let first_hops = nodes[0].node.list_usable_channels();
7525 let scorer = test_utils::TestScorer::with_penalty(0);
7526 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
7527 let route = find_route(
7528 &payer_pubkey, &route_params, &network_graph.read_only(),
7529 Some(&first_hops.iter().collect::<Vec<_>>()), nodes[0].logger, &scorer,
7533 let test_preimage = PaymentPreimage([42; 32]);
7534 let test_secret = PaymentSecret([43; 32]);
7535 let payment_hash = PaymentHash(Sha256::hash(&test_preimage.0).into_inner());
7536 let _ = nodes[0].node.send_payment_internal(&route, payment_hash, &Some(test_secret), Some(test_preimage), None, None).unwrap();
7537 check_added_monitors!(nodes[0], 1);
7539 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7540 assert_eq!(updates.update_add_htlcs.len(), 1);
7541 assert!(updates.update_fulfill_htlcs.is_empty());
7542 assert!(updates.update_fail_htlcs.is_empty());
7543 assert!(updates.update_fail_malformed_htlcs.is_empty());
7544 assert!(updates.update_fee.is_none());
7545 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7547 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "We don't support MPP keysend payments".to_string(), 1);
7551 fn test_multi_hop_missing_secret() {
7552 let chanmon_cfgs = create_chanmon_cfgs(4);
7553 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
7554 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
7555 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
7557 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7558 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7559 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7560 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7562 // Marshall an MPP route.
7563 let (mut route, payment_hash, _, _) = get_route_and_payment_hash!(&nodes[0], nodes[3], 100000);
7564 let path = route.paths[0].clone();
7565 route.paths.push(path);
7566 route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
7567 route.paths[0][0].short_channel_id = chan_1_id;
7568 route.paths[0][1].short_channel_id = chan_3_id;
7569 route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
7570 route.paths[1][0].short_channel_id = chan_2_id;
7571 route.paths[1][1].short_channel_id = chan_4_id;
7573 match nodes[0].node.send_payment(&route, payment_hash, &None).unwrap_err() {
7574 PaymentSendFailure::ParameterError(APIError::APIMisuseError { ref err }) => {
7575 assert!(regex::Regex::new(r"Payment secret is required for multi-path payments").unwrap().is_match(err)) },
7576 _ => panic!("unexpected error")
7581 fn bad_inbound_payment_hash() {
7582 // Add coverage for checking that a user-provided payment hash matches the payment secret.
7583 let chanmon_cfgs = create_chanmon_cfgs(2);
7584 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7585 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7586 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7588 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[0]);
7589 let payment_data = msgs::FinalOnionHopData {
7591 total_msat: 100_000,
7594 // Ensure that if the payment hash given to `inbound_payment::verify` differs from the original,
7595 // payment verification fails as expected.
7596 let mut bad_payment_hash = payment_hash.clone();
7597 bad_payment_hash.0[0] += 1;
7598 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) {
7599 Ok(_) => panic!("Unexpected ok"),
7601 nodes[0].logger.assert_log_contains("lightning::ln::inbound_payment".to_string(), "Failing HTLC with user-generated payment_hash".to_string(), 1);
7605 // Check that using the original payment hash succeeds.
7606 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());
7610 #[cfg(all(any(test, feature = "_test_utils"), feature = "_bench_unstable"))]
7613 use chain::chainmonitor::{ChainMonitor, Persist};
7614 use chain::keysinterface::{KeysManager, KeysInterface, InMemorySigner};
7615 use ln::channelmanager::{BestBlock, ChainParameters, ChannelManager, PaymentHash, PaymentPreimage};
7616 use ln::features::{InitFeatures, InvoiceFeatures};
7617 use ln::functional_test_utils::*;
7618 use ln::msgs::{ChannelMessageHandler, Init};
7619 use routing::gossip::NetworkGraph;
7620 use routing::router::{PaymentParameters, get_route};
7621 use util::test_utils;
7622 use util::config::UserConfig;
7623 use util::events::{Event, MessageSendEvent, MessageSendEventsProvider};
7625 use bitcoin::hashes::Hash;
7626 use bitcoin::hashes::sha256::Hash as Sha256;
7627 use bitcoin::{Block, BlockHeader, Transaction, TxOut};
7629 use sync::{Arc, Mutex};
7633 struct NodeHolder<'a, P: Persist<InMemorySigner>> {
7634 node: &'a ChannelManager<InMemorySigner,
7635 &'a ChainMonitor<InMemorySigner, &'a test_utils::TestChainSource,
7636 &'a test_utils::TestBroadcaster, &'a test_utils::TestFeeEstimator,
7637 &'a test_utils::TestLogger, &'a P>,
7638 &'a test_utils::TestBroadcaster, &'a KeysManager,
7639 &'a test_utils::TestFeeEstimator, &'a test_utils::TestLogger>
7644 fn bench_sends(bench: &mut Bencher) {
7645 bench_two_sends(bench, test_utils::TestPersister::new(), test_utils::TestPersister::new());
7648 pub fn bench_two_sends<P: Persist<InMemorySigner>>(bench: &mut Bencher, persister_a: P, persister_b: P) {
7649 // Do a simple benchmark of sending a payment back and forth between two nodes.
7650 // Note that this is unrealistic as each payment send will require at least two fsync
7652 let network = bitcoin::Network::Testnet;
7653 let genesis_hash = bitcoin::blockdata::constants::genesis_block(network).header.block_hash();
7655 let tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), blocks: Arc::new(Mutex::new(Vec::new()))};
7656 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
7658 let mut config: UserConfig = Default::default();
7659 config.channel_handshake_config.minimum_depth = 1;
7661 let logger_a = test_utils::TestLogger::with_id("node a".to_owned());
7662 let chain_monitor_a = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_a);
7663 let seed_a = [1u8; 32];
7664 let keys_manager_a = KeysManager::new(&seed_a, 42, 42);
7665 let node_a = ChannelManager::new(&fee_estimator, &chain_monitor_a, &tx_broadcaster, &logger_a, &keys_manager_a, config.clone(), ChainParameters {
7667 best_block: BestBlock::from_genesis(network),
7669 let node_a_holder = NodeHolder { node: &node_a };
7671 let logger_b = test_utils::TestLogger::with_id("node a".to_owned());
7672 let chain_monitor_b = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_b);
7673 let seed_b = [2u8; 32];
7674 let keys_manager_b = KeysManager::new(&seed_b, 42, 42);
7675 let node_b = ChannelManager::new(&fee_estimator, &chain_monitor_b, &tx_broadcaster, &logger_b, &keys_manager_b, config.clone(), ChainParameters {
7677 best_block: BestBlock::from_genesis(network),
7679 let node_b_holder = NodeHolder { node: &node_b };
7681 node_a.peer_connected(&node_b.get_our_node_id(), &Init { features: InitFeatures::known(), remote_network_address: None });
7682 node_b.peer_connected(&node_a.get_our_node_id(), &Init { features: InitFeatures::known(), remote_network_address: None });
7683 node_a.create_channel(node_b.get_our_node_id(), 8_000_000, 100_000_000, 42, None).unwrap();
7684 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()));
7685 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()));
7688 if let Event::FundingGenerationReady { temporary_channel_id, output_script, .. } = get_event!(node_a_holder, Event::FundingGenerationReady) {
7689 tx = Transaction { version: 2, lock_time: 0, input: Vec::new(), output: vec![TxOut {
7690 value: 8_000_000, script_pubkey: output_script,
7692 node_a.funding_transaction_generated(&temporary_channel_id, &node_b.get_our_node_id(), tx.clone()).unwrap();
7693 } else { panic!(); }
7695 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()));
7696 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()));
7698 assert_eq!(&tx_broadcaster.txn_broadcasted.lock().unwrap()[..], &[tx.clone()]);
7701 header: BlockHeader { version: 0x20000000, prev_blockhash: genesis_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
7704 Listen::block_connected(&node_a, &block, 1);
7705 Listen::block_connected(&node_b, &block, 1);
7707 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()));
7708 let msg_events = node_a.get_and_clear_pending_msg_events();
7709 assert_eq!(msg_events.len(), 2);
7710 match msg_events[0] {
7711 MessageSendEvent::SendChannelReady { ref msg, .. } => {
7712 node_b.handle_channel_ready(&node_a.get_our_node_id(), msg);
7713 get_event_msg!(node_b_holder, MessageSendEvent::SendChannelUpdate, node_a.get_our_node_id());
7717 match msg_events[1] {
7718 MessageSendEvent::SendChannelUpdate { .. } => {},
7722 let dummy_graph = NetworkGraph::new(genesis_hash, &logger_a);
7724 let mut payment_count: u64 = 0;
7725 macro_rules! send_payment {
7726 ($node_a: expr, $node_b: expr) => {
7727 let usable_channels = $node_a.list_usable_channels();
7728 let payment_params = PaymentParameters::from_node_id($node_b.get_our_node_id())
7729 .with_features(InvoiceFeatures::known());
7730 let scorer = test_utils::TestScorer::with_penalty(0);
7731 let seed = [3u8; 32];
7732 let keys_manager = KeysManager::new(&seed, 42, 42);
7733 let random_seed_bytes = keys_manager.get_secure_random_bytes();
7734 let route = get_route(&$node_a.get_our_node_id(), &payment_params, &dummy_graph.read_only(),
7735 Some(&usable_channels.iter().map(|r| r).collect::<Vec<_>>()), 10_000, TEST_FINAL_CLTV, &logger_a, &scorer, &random_seed_bytes).unwrap();
7737 let mut payment_preimage = PaymentPreimage([0; 32]);
7738 payment_preimage.0[0..8].copy_from_slice(&payment_count.to_le_bytes());
7740 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
7741 let payment_secret = $node_b.create_inbound_payment_for_hash(payment_hash, None, 7200).unwrap();
7743 $node_a.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
7744 let payment_event = SendEvent::from_event($node_a.get_and_clear_pending_msg_events().pop().unwrap());
7745 $node_b.handle_update_add_htlc(&$node_a.get_our_node_id(), &payment_event.msgs[0]);
7746 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &payment_event.commitment_msg);
7747 let (raa, cs) = get_revoke_commit_msgs!(NodeHolder { node: &$node_b }, $node_a.get_our_node_id());
7748 $node_a.handle_revoke_and_ack(&$node_b.get_our_node_id(), &raa);
7749 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &cs);
7750 $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()));
7752 expect_pending_htlcs_forwardable!(NodeHolder { node: &$node_b });
7753 expect_payment_received!(NodeHolder { node: &$node_b }, payment_hash, payment_secret, 10_000);
7754 $node_b.claim_funds(payment_preimage);
7755 expect_payment_claimed!(NodeHolder { node: &$node_b }, payment_hash, 10_000);
7757 match $node_b.get_and_clear_pending_msg_events().pop().unwrap() {
7758 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
7759 assert_eq!(node_id, $node_a.get_our_node_id());
7760 $node_a.handle_update_fulfill_htlc(&$node_b.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
7761 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &updates.commitment_signed);
7763 _ => panic!("Failed to generate claim event"),
7766 let (raa, cs) = get_revoke_commit_msgs!(NodeHolder { node: &$node_a }, $node_b.get_our_node_id());
7767 $node_b.handle_revoke_and_ack(&$node_a.get_our_node_id(), &raa);
7768 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &cs);
7769 $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()));
7771 expect_payment_sent!(NodeHolder { node: &$node_a }, payment_preimage);
7776 send_payment!(node_a, node_b);
7777 send_payment!(node_b, node_a);