1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! The top-level channel management and payment tracking stuff lives here.
12 //! The ChannelManager is the main chunk of logic implementing the lightning protocol and is
13 //! responsible for tracking which channels are open, HTLCs are in flight and reestablishing those
14 //! upon reconnect to the relevant peer(s).
16 //! It does not manage routing logic (see [`find_route`] for that) nor does it manage constructing
17 //! on-chain transactions (it only monitors the chain to watch for any force-closes that might
18 //! imply it needs to fail HTLCs/payments/channels it manages).
20 //! [`find_route`]: crate::routing::router::find_route
22 use bitcoin::blockdata::block::BlockHeader;
23 use bitcoin::blockdata::transaction::Transaction;
24 use bitcoin::blockdata::constants::genesis_block;
25 use bitcoin::network::constants::Network;
27 use bitcoin::hashes::Hash;
28 use bitcoin::hashes::sha256::Hash as Sha256;
29 use bitcoin::hash_types::{BlockHash, Txid};
31 use bitcoin::secp256k1::{SecretKey,PublicKey};
32 use bitcoin::secp256k1::Secp256k1;
33 use bitcoin::{LockTime, secp256k1, Sequence};
36 use crate::chain::{Confirm, ChannelMonitorUpdateStatus, Watch, BestBlock};
37 use crate::chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator, LowerBoundedFeeEstimator};
38 use crate::chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, ChannelMonitorUpdateStep, HTLC_FAIL_BACK_BUFFER, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY, MonitorEvent, CLOSED_CHANNEL_UPDATE_ID};
39 use crate::chain::transaction::{OutPoint, TransactionData};
40 // Since this struct is returned in `list_channels` methods, expose it here in case users want to
41 // construct one themselves.
42 use crate::ln::{inbound_payment, PaymentHash, PaymentPreimage, PaymentSecret};
43 use crate::ln::channel::{Channel, ChannelError, ChannelUpdateStatus, UpdateFulfillCommitFetch};
44 use crate::ln::features::{ChannelFeatures, ChannelTypeFeatures, InitFeatures, NodeFeatures};
45 #[cfg(any(feature = "_test_utils", test))]
46 use crate::ln::features::InvoiceFeatures;
47 use crate::routing::gossip::NetworkGraph;
48 use crate::routing::router::{DefaultRouter, InFlightHtlcs, PaymentParameters, Route, RouteHop, RouteParameters, RoutePath, Router};
49 use crate::routing::scoring::ProbabilisticScorer;
51 use crate::ln::onion_utils;
52 use crate::ln::onion_utils::HTLCFailReason;
53 use crate::ln::msgs::{ChannelMessageHandler, DecodeError, LightningError, MAX_VALUE_MSAT};
55 use crate::ln::outbound_payment;
56 use crate::ln::outbound_payment::{OutboundPayments, PaymentAttempts, PendingOutboundPayment};
57 use crate::ln::wire::Encode;
58 use crate::chain::keysinterface::{EntropySource, KeysManager, NodeSigner, Recipient, SignerProvider, ChannelSigner};
59 use crate::util::config::{UserConfig, ChannelConfig};
60 use crate::util::events::{Event, EventHandler, EventsProvider, MessageSendEvent, MessageSendEventsProvider, ClosureReason, HTLCDestination};
61 use crate::util::events;
62 use crate::util::wakers::{Future, Notifier};
63 use crate::util::scid_utils::fake_scid;
64 use crate::util::ser::{BigSize, FixedLengthReader, Readable, ReadableArgs, MaybeReadable, Writeable, Writer, VecWriter};
65 use crate::util::logger::{Level, Logger};
66 use crate::util::errors::APIError;
69 use crate::prelude::*;
71 use core::cell::RefCell;
73 use crate::sync::{Arc, Mutex, RwLock, RwLockReadGuard, FairRwLock};
74 use core::sync::atomic::{AtomicUsize, Ordering};
75 use core::time::Duration;
78 // Re-export this for use in the public API.
79 pub use crate::ln::outbound_payment::{PaymentSendFailure, Retry};
81 // We hold various information about HTLC relay in the HTLC objects in Channel itself:
83 // Upon receipt of an HTLC from a peer, we'll give it a PendingHTLCStatus indicating if it should
84 // forward the HTLC with information it will give back to us when it does so, or if it should Fail
85 // the HTLC with the relevant message for the Channel to handle giving to the remote peer.
87 // Once said HTLC is committed in the Channel, if the PendingHTLCStatus indicated Forward, the
88 // Channel will return the PendingHTLCInfo back to us, and we will create an HTLCForwardInfo
89 // with it to track where it came from (in case of onwards-forward error), waiting a random delay
90 // before we forward it.
92 // We will then use HTLCForwardInfo's PendingHTLCInfo to construct an outbound HTLC, with a
93 // relevant HTLCSource::PreviousHopData filled in to indicate where it came from (which we can use
94 // to either fail-backwards or fulfill the HTLC backwards along the relevant path).
95 // Alternatively, we can fill an outbound HTLC with a HTLCSource::OutboundRoute indicating this is
96 // our payment, which we can use to decode errors or inform the user that the payment was sent.
98 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
99 pub(super) enum PendingHTLCRouting {
101 onion_packet: msgs::OnionPacket,
102 /// The SCID from the onion that we should forward to. This could be a real SCID or a fake one
103 /// generated using `get_fake_scid` from the scid_utils::fake_scid module.
104 short_channel_id: u64, // This should be NonZero<u64> eventually when we bump MSRV
107 payment_data: msgs::FinalOnionHopData,
108 incoming_cltv_expiry: u32, // Used to track when we should expire pending HTLCs that go unclaimed
109 phantom_shared_secret: Option<[u8; 32]>,
112 payment_preimage: PaymentPreimage,
113 incoming_cltv_expiry: u32, // Used to track when we should expire pending HTLCs that go unclaimed
117 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
118 pub(super) struct PendingHTLCInfo {
119 pub(super) routing: PendingHTLCRouting,
120 pub(super) incoming_shared_secret: [u8; 32],
121 payment_hash: PaymentHash,
122 pub(super) incoming_amt_msat: Option<u64>, // Added in 0.0.113
123 pub(super) outgoing_amt_msat: u64,
124 pub(super) outgoing_cltv_value: u32,
127 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
128 pub(super) enum HTLCFailureMsg {
129 Relay(msgs::UpdateFailHTLC),
130 Malformed(msgs::UpdateFailMalformedHTLC),
133 /// Stores whether we can't forward an HTLC or relevant forwarding info
134 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
135 pub(super) enum PendingHTLCStatus {
136 Forward(PendingHTLCInfo),
137 Fail(HTLCFailureMsg),
140 pub(super) struct PendingAddHTLCInfo {
141 pub(super) forward_info: PendingHTLCInfo,
143 // These fields are produced in `forward_htlcs()` and consumed in
144 // `process_pending_htlc_forwards()` for constructing the
145 // `HTLCSource::PreviousHopData` for failed and forwarded
148 // Note that this may be an outbound SCID alias for the associated channel.
149 prev_short_channel_id: u64,
151 prev_funding_outpoint: OutPoint,
152 prev_user_channel_id: u128,
155 pub(super) enum HTLCForwardInfo {
156 AddHTLC(PendingAddHTLCInfo),
159 err_packet: msgs::OnionErrorPacket,
163 /// Tracks the inbound corresponding to an outbound HTLC
164 #[derive(Clone, Hash, PartialEq, Eq)]
165 pub(crate) struct HTLCPreviousHopData {
166 // Note that this may be an outbound SCID alias for the associated channel.
167 short_channel_id: u64,
169 incoming_packet_shared_secret: [u8; 32],
170 phantom_shared_secret: Option<[u8; 32]>,
172 // This field is consumed by `claim_funds_from_hop()` when updating a force-closed backwards
173 // channel with a preimage provided by the forward channel.
178 /// Indicates this incoming onion payload is for the purpose of paying an invoice.
180 /// This is only here for backwards-compatibility in serialization, in the future it can be
181 /// removed, breaking clients running 0.0.106 and earlier.
182 _legacy_hop_data: Option<msgs::FinalOnionHopData>,
184 /// Contains the payer-provided preimage.
185 Spontaneous(PaymentPreimage),
188 /// HTLCs that are to us and can be failed/claimed by the user
189 struct ClaimableHTLC {
190 prev_hop: HTLCPreviousHopData,
192 /// The amount (in msats) of this MPP part
194 onion_payload: OnionPayload,
196 /// The sum total of all MPP parts
200 /// A payment identifier used to uniquely identify a payment to LDK.
201 /// (C-not exported) as we just use [u8; 32] directly
202 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
203 pub struct PaymentId(pub [u8; 32]);
205 impl Writeable for PaymentId {
206 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
211 impl Readable for PaymentId {
212 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
213 let buf: [u8; 32] = Readable::read(r)?;
218 /// An identifier used to uniquely identify an intercepted HTLC to LDK.
219 /// (C-not exported) as we just use [u8; 32] directly
220 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
221 pub struct InterceptId(pub [u8; 32]);
223 impl Writeable for InterceptId {
224 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
229 impl Readable for InterceptId {
230 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
231 let buf: [u8; 32] = Readable::read(r)?;
235 /// Tracks the inbound corresponding to an outbound HTLC
236 #[allow(clippy::derive_hash_xor_eq)] // Our Hash is faithful to the data, we just don't have SecretKey::hash
237 #[derive(Clone, PartialEq, Eq)]
238 pub(crate) enum HTLCSource {
239 PreviousHopData(HTLCPreviousHopData),
242 session_priv: SecretKey,
243 /// Technically we can recalculate this from the route, but we cache it here to avoid
244 /// doing a double-pass on route when we get a failure back
245 first_hop_htlc_msat: u64,
246 payment_id: PaymentId,
247 payment_secret: Option<PaymentSecret>,
248 /// Note that this is now "deprecated" - we write it for forwards (and read it for
249 /// backwards) compatibility reasons, but prefer to use the data in the
250 /// [`super::outbound_payment`] module, which stores per-payment data once instead of in
252 payment_params: Option<PaymentParameters>,
255 #[allow(clippy::derive_hash_xor_eq)] // Our Hash is faithful to the data, we just don't have SecretKey::hash
256 impl core::hash::Hash for HTLCSource {
257 fn hash<H: core::hash::Hasher>(&self, hasher: &mut H) {
259 HTLCSource::PreviousHopData(prev_hop_data) => {
261 prev_hop_data.hash(hasher);
263 HTLCSource::OutboundRoute { path, session_priv, payment_id, payment_secret, first_hop_htlc_msat, payment_params } => {
266 session_priv[..].hash(hasher);
267 payment_id.hash(hasher);
268 payment_secret.hash(hasher);
269 first_hop_htlc_msat.hash(hasher);
270 payment_params.hash(hasher);
275 #[cfg(not(feature = "grind_signatures"))]
278 pub fn dummy() -> Self {
279 HTLCSource::OutboundRoute {
281 session_priv: SecretKey::from_slice(&[1; 32]).unwrap(),
282 first_hop_htlc_msat: 0,
283 payment_id: PaymentId([2; 32]),
284 payment_secret: None,
285 payment_params: None,
290 struct ReceiveError {
296 /// This enum is used to specify which error data to send to peers when failing back an HTLC
297 /// using [`ChannelManager::fail_htlc_backwards_with_reason`].
299 /// For more info on failure codes, see <https://github.com/lightning/bolts/blob/master/04-onion-routing.md#failure-messages>.
300 #[derive(Clone, Copy)]
301 pub enum FailureCode {
302 /// We had a temporary error processing the payment. Useful if no other error codes fit
303 /// and you want to indicate that the payer may want to retry.
304 TemporaryNodeFailure = 0x2000 | 2,
305 /// We have a required feature which was not in this onion. For example, you may require
306 /// some additional metadata that was not provided with this payment.
307 RequiredNodeFeatureMissing = 0x4000 | 0x2000 | 3,
308 /// You may wish to use this when a `payment_preimage` is unknown, or the CLTV expiry of
309 /// the HTLC is too close to the current block height for safe handling.
310 /// Using this failure code in [`ChannelManager::fail_htlc_backwards_with_reason`] is
311 /// equivalent to calling [`ChannelManager::fail_htlc_backwards`].
312 IncorrectOrUnknownPaymentDetails = 0x4000 | 15,
315 type ShutdownResult = (Option<(OutPoint, ChannelMonitorUpdate)>, Vec<(HTLCSource, PaymentHash, PublicKey, [u8; 32])>);
317 /// Error type returned across the peer_state mutex boundary. When an Err is generated for a
318 /// Channel, we generally end up with a ChannelError::Close for which we have to close the channel
319 /// immediately (ie with no further calls on it made). Thus, this step happens inside a
320 /// peer_state lock. We then return the set of things that need to be done outside the lock in
321 /// this struct and call handle_error!() on it.
323 struct MsgHandleErrInternal {
324 err: msgs::LightningError,
325 chan_id: Option<([u8; 32], u128)>, // If Some a channel of ours has been closed
326 shutdown_finish: Option<(ShutdownResult, Option<msgs::ChannelUpdate>)>,
328 impl MsgHandleErrInternal {
330 fn send_err_msg_no_close(err: String, channel_id: [u8; 32]) -> Self {
332 err: LightningError {
334 action: msgs::ErrorAction::SendErrorMessage {
335 msg: msgs::ErrorMessage {
342 shutdown_finish: None,
346 fn ignore_no_close(err: String) -> Self {
348 err: LightningError {
350 action: msgs::ErrorAction::IgnoreError,
353 shutdown_finish: None,
357 fn from_no_close(err: msgs::LightningError) -> Self {
358 Self { err, chan_id: None, shutdown_finish: None }
361 fn from_finish_shutdown(err: String, channel_id: [u8; 32], user_channel_id: u128, shutdown_res: ShutdownResult, channel_update: Option<msgs::ChannelUpdate>) -> Self {
363 err: LightningError {
365 action: msgs::ErrorAction::SendErrorMessage {
366 msg: msgs::ErrorMessage {
372 chan_id: Some((channel_id, user_channel_id)),
373 shutdown_finish: Some((shutdown_res, channel_update)),
377 fn from_chan_no_close(err: ChannelError, channel_id: [u8; 32]) -> Self {
380 ChannelError::Warn(msg) => LightningError {
382 action: msgs::ErrorAction::SendWarningMessage {
383 msg: msgs::WarningMessage {
387 log_level: Level::Warn,
390 ChannelError::Ignore(msg) => LightningError {
392 action: msgs::ErrorAction::IgnoreError,
394 ChannelError::Close(msg) => LightningError {
396 action: msgs::ErrorAction::SendErrorMessage {
397 msg: msgs::ErrorMessage {
405 shutdown_finish: None,
410 /// We hold back HTLCs we intend to relay for a random interval greater than this (see
411 /// Event::PendingHTLCsForwardable for the API guidelines indicating how long should be waited).
412 /// This provides some limited amount of privacy. Ideally this would range from somewhere like one
413 /// second to 30 seconds, but people expect lightning to be, you know, kinda fast, sadly.
414 pub(super) const MIN_HTLC_RELAY_HOLDING_CELL_MILLIS: u64 = 100;
416 /// For events which result in both a RevokeAndACK and a CommitmentUpdate, by default they should
417 /// be sent in the order they appear in the return value, however sometimes the order needs to be
418 /// variable at runtime (eg Channel::channel_reestablish needs to re-send messages in the order
419 /// they were originally sent). In those cases, this enum is also returned.
420 #[derive(Clone, PartialEq)]
421 pub(super) enum RAACommitmentOrder {
422 /// Send the CommitmentUpdate messages first
424 /// Send the RevokeAndACK message first
428 /// Information about a payment which is currently being claimed.
429 struct ClaimingPayment {
431 payment_purpose: events::PaymentPurpose,
432 receiver_node_id: PublicKey,
434 impl_writeable_tlv_based!(ClaimingPayment, {
435 (0, amount_msat, required),
436 (2, payment_purpose, required),
437 (4, receiver_node_id, required),
440 /// Information about claimable or being-claimed payments
441 struct ClaimablePayments {
442 /// Map from payment hash to the payment data and any HTLCs which are to us and can be
443 /// failed/claimed by the user.
445 /// Note that, no consistency guarantees are made about the channels given here actually
446 /// existing anymore by the time you go to read them!
448 /// When adding to the map, [`Self::pending_claiming_payments`] must also be checked to ensure
449 /// we don't get a duplicate payment.
450 claimable_htlcs: HashMap<PaymentHash, (events::PaymentPurpose, Vec<ClaimableHTLC>)>,
452 /// Map from payment hash to the payment data for HTLCs which we have begun claiming, but which
453 /// are waiting on a [`ChannelMonitorUpdate`] to complete in order to be surfaced to the user
454 /// as an [`events::Event::PaymentClaimed`].
455 pending_claiming_payments: HashMap<PaymentHash, ClaimingPayment>,
458 /// Events which we process internally but cannot be procsesed immediately at the generation site
459 /// for some reason. They are handled in timer_tick_occurred, so may be processed with
460 /// quite some time lag.
461 enum BackgroundEvent {
462 /// Handle a ChannelMonitorUpdate that closes a channel, broadcasting its current latest holder
463 /// commitment transaction.
464 ClosingMonitorUpdate((OutPoint, ChannelMonitorUpdate)),
467 pub(crate) enum MonitorUpdateCompletionAction {
468 /// Indicates that a payment ultimately destined for us was claimed and we should emit an
469 /// [`events::Event::PaymentClaimed`] to the user if we haven't yet generated such an event for
470 /// this payment. Note that this is only best-effort. On restart it's possible such a duplicate
471 /// event can be generated.
472 PaymentClaimed { payment_hash: PaymentHash },
473 /// Indicates an [`events::Event`] should be surfaced to the user.
474 EmitEvent { event: events::Event },
477 /// State we hold per-peer.
478 pub(super) struct PeerState<Signer: ChannelSigner> {
479 /// `temporary_channel_id` or `channel_id` -> `channel`.
481 /// Holds all channels where the peer is the counterparty. Once a channel has been assigned a
482 /// `channel_id`, the `temporary_channel_id` key in the map is updated and is replaced by the
484 pub(super) channel_by_id: HashMap<[u8; 32], Channel<Signer>>,
485 /// The latest `InitFeatures` we heard from the peer.
486 latest_features: InitFeatures,
487 /// Messages to send to the peer - pushed to in the same lock that they are generated in (except
488 /// for broadcast messages, where ordering isn't as strict).
489 pub(super) pending_msg_events: Vec<MessageSendEvent>,
490 /// The peer is currently connected (i.e. we've seen a
491 /// [`ChannelMessageHandler::peer_connected`] and no corresponding
492 /// [`ChannelMessageHandler::peer_disconnected`].
496 /// Stores a PaymentSecret and any other data we may need to validate an inbound payment is
497 /// actually ours and not some duplicate HTLC sent to us by a node along the route.
499 /// For users who don't want to bother doing their own payment preimage storage, we also store that
502 /// Note that this struct will be removed entirely soon, in favor of storing no inbound payment data
503 /// and instead encoding it in the payment secret.
504 struct PendingInboundPayment {
505 /// The payment secret that the sender must use for us to accept this payment
506 payment_secret: PaymentSecret,
507 /// Time at which this HTLC expires - blocks with a header time above this value will result in
508 /// this payment being removed.
510 /// Arbitrary identifier the user specifies (or not)
511 user_payment_id: u64,
512 // Other required attributes of the payment, optionally enforced:
513 payment_preimage: Option<PaymentPreimage>,
514 min_value_msat: Option<u64>,
517 /// SimpleArcChannelManager is useful when you need a ChannelManager with a static lifetime, e.g.
518 /// when you're using lightning-net-tokio (since tokio::spawn requires parameters with static
519 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
520 /// SimpleRefChannelManager is the more appropriate type. Defining these type aliases prevents
521 /// issues such as overly long function definitions. Note that the ChannelManager can take any type
522 /// that implements KeysInterface or Router for its keys manager and router, respectively, but this
523 /// type alias chooses the concrete types of KeysManager and DefaultRouter.
525 /// (C-not exported) as Arcs don't make sense in bindings
526 pub type SimpleArcChannelManager<M, T, F, L> = ChannelManager<
534 Arc<NetworkGraph<Arc<L>>>,
536 Arc<Mutex<ProbabilisticScorer<Arc<NetworkGraph<Arc<L>>>, Arc<L>>>>
541 /// SimpleRefChannelManager is a type alias for a ChannelManager reference, and is the reference
542 /// counterpart to the SimpleArcChannelManager type alias. Use this type by default when you don't
543 /// need a ChannelManager with a static lifetime. You'll need a static lifetime in cases such as
544 /// usage of lightning-net-tokio (since tokio::spawn requires parameters with static lifetimes).
545 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
546 /// issues such as overly long function definitions. Note that the ChannelManager can take any type
547 /// that implements KeysInterface or Router for its keys manager and router, respectively, but this
548 /// type alias chooses the concrete types of KeysManager and DefaultRouter.
550 /// (C-not exported) as Arcs don't make sense in bindings
551 pub type SimpleRefChannelManager<'a, 'b, 'c, 'd, 'e, 'f, 'g, 'h, M, T, F, L> = ChannelManager<&'a M, &'b T, &'c KeysManager, &'c KeysManager, &'c KeysManager, &'d F, &'e DefaultRouter<&'f NetworkGraph<&'g L>, &'g L, &'h Mutex<ProbabilisticScorer<&'f NetworkGraph<&'g L>, &'g L>>>, &'g L>;
553 /// Manager which keeps track of a number of channels and sends messages to the appropriate
554 /// channel, also tracking HTLC preimages and forwarding onion packets appropriately.
556 /// Implements ChannelMessageHandler, handling the multi-channel parts and passing things through
557 /// to individual Channels.
559 /// Implements Writeable to write out all channel state to disk. Implies peer_disconnected() for
560 /// all peers during write/read (though does not modify this instance, only the instance being
561 /// serialized). This will result in any channels which have not yet exchanged funding_created (ie
562 /// called funding_transaction_generated for outbound channels).
564 /// Note that you can be a bit lazier about writing out ChannelManager than you can be with
565 /// ChannelMonitors. With ChannelMonitors you MUST write each monitor update out to disk before
566 /// returning from chain::Watch::watch_/update_channel, with ChannelManagers, writing updates
567 /// happens out-of-band (and will prevent any other ChannelManager operations from occurring during
568 /// the serialization process). If the deserialized version is out-of-date compared to the
569 /// ChannelMonitors passed by reference to read(), those channels will be force-closed based on the
570 /// ChannelMonitor state and no funds will be lost (mod on-chain transaction fees).
572 /// Note that the deserializer is only implemented for (BlockHash, ChannelManager), which
573 /// tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
574 /// the "reorg path" (ie call block_disconnected() until you get to a common block and then call
575 /// block_connected() to step towards your best block) upon deserialization before using the
578 /// Note that ChannelManager is responsible for tracking liveness of its channels and generating
579 /// ChannelUpdate messages informing peers that the channel is temporarily disabled. To avoid
580 /// spam due to quick disconnection/reconnection, updates are not sent until the channel has been
581 /// offline for a full minute. In order to track this, you must call
582 /// timer_tick_occurred roughly once per minute, though it doesn't have to be perfect.
584 /// Rather than using a plain ChannelManager, it is preferable to use either a SimpleArcChannelManager
585 /// a SimpleRefChannelManager, for conciseness. See their documentation for more details, but
586 /// essentially you should default to using a SimpleRefChannelManager, and use a
587 /// SimpleArcChannelManager when you require a ChannelManager with a static lifetime, such as when
588 /// you're using lightning-net-tokio.
591 // The tree structure below illustrates the lock order requirements for the different locks of the
592 // `ChannelManager`. Locks can be held at the same time if they are on the same branch in the tree,
593 // and should then be taken in the order of the lowest to the highest level in the tree.
594 // Note that locks on different branches shall not be taken at the same time, as doing so will
595 // create a new lock order for those specific locks in the order they were taken.
599 // `total_consistency_lock`
601 // |__`forward_htlcs`
603 // | |__`pending_intercepted_htlcs`
605 // |__`per_peer_state`
607 // | |__`pending_inbound_payments`
609 // | |__`claimable_payments`
611 // | |__`pending_outbound_payments` // This field's struct contains a map of pending outbounds
617 // | |__`short_to_chan_info`
619 // | |__`outbound_scid_aliases`
623 // | |__`pending_events`
625 // | |__`pending_background_events`
627 pub struct ChannelManager<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
629 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
630 T::Target: BroadcasterInterface,
631 ES::Target: EntropySource,
632 NS::Target: NodeSigner,
633 SP::Target: SignerProvider,
634 F::Target: FeeEstimator,
638 default_configuration: UserConfig,
639 genesis_hash: BlockHash,
640 fee_estimator: LowerBoundedFeeEstimator<F>,
646 /// See `ChannelManager` struct-level documentation for lock order requirements.
648 pub(super) best_block: RwLock<BestBlock>,
650 best_block: RwLock<BestBlock>,
651 secp_ctx: Secp256k1<secp256k1::All>,
653 /// Storage for PaymentSecrets and any requirements on future inbound payments before we will
654 /// expose them to users via a PaymentClaimable event. HTLCs which do not meet the requirements
655 /// here are failed when we process them as pending-forwardable-HTLCs, and entries are removed
656 /// after we generate a PaymentClaimable upon receipt of all MPP parts or when they time out.
658 /// See `ChannelManager` struct-level documentation for lock order requirements.
659 pending_inbound_payments: Mutex<HashMap<PaymentHash, PendingInboundPayment>>,
661 /// The session_priv bytes and retry metadata of outbound payments which are pending resolution.
662 /// The authoritative state of these HTLCs resides either within Channels or ChannelMonitors
663 /// (if the channel has been force-closed), however we track them here to prevent duplicative
664 /// PaymentSent/PaymentPathFailed events. Specifically, in the case of a duplicative
665 /// update_fulfill_htlc message after a reconnect, we may "claim" a payment twice.
666 /// Additionally, because ChannelMonitors are often not re-serialized after connecting block(s)
667 /// which may generate a claim event, we may receive similar duplicate claim/fail MonitorEvents
668 /// after reloading from disk while replaying blocks against ChannelMonitors.
670 /// See `PendingOutboundPayment` documentation for more info.
672 /// See `ChannelManager` struct-level documentation for lock order requirements.
673 pending_outbound_payments: OutboundPayments,
675 /// SCID/SCID Alias -> forward infos. Key of 0 means payments received.
677 /// Note that because we may have an SCID Alias as the key we can have two entries per channel,
678 /// though in practice we probably won't be receiving HTLCs for a channel both via the alias
679 /// and via the classic SCID.
681 /// Note that no consistency guarantees are made about the existence of a channel with the
682 /// `short_channel_id` here, nor the `short_channel_id` in the `PendingHTLCInfo`!
684 /// See `ChannelManager` struct-level documentation for lock order requirements.
686 pub(super) forward_htlcs: Mutex<HashMap<u64, Vec<HTLCForwardInfo>>>,
688 forward_htlcs: Mutex<HashMap<u64, Vec<HTLCForwardInfo>>>,
689 /// Storage for HTLCs that have been intercepted and bubbled up to the user. We hold them here
690 /// until the user tells us what we should do with them.
692 /// See `ChannelManager` struct-level documentation for lock order requirements.
693 pending_intercepted_htlcs: Mutex<HashMap<InterceptId, PendingAddHTLCInfo>>,
695 /// The sets of payments which are claimable or currently being claimed. See
696 /// [`ClaimablePayments`]' individual field docs for more info.
698 /// See `ChannelManager` struct-level documentation for lock order requirements.
699 claimable_payments: Mutex<ClaimablePayments>,
701 /// The set of outbound SCID aliases across all our channels, including unconfirmed channels
702 /// and some closed channels which reached a usable state prior to being closed. This is used
703 /// only to avoid duplicates, and is not persisted explicitly to disk, but rebuilt from the
704 /// active channel list on load.
706 /// See `ChannelManager` struct-level documentation for lock order requirements.
707 outbound_scid_aliases: Mutex<HashSet<u64>>,
709 /// `channel_id` -> `counterparty_node_id`.
711 /// Only `channel_id`s are allowed as keys in this map, and not `temporary_channel_id`s. As
712 /// multiple channels with the same `temporary_channel_id` to different peers can exist,
713 /// allowing `temporary_channel_id`s in this map would cause collisions for such channels.
715 /// Note that this map should only be used for `MonitorEvent` handling, to be able to access
716 /// the corresponding channel for the event, as we only have access to the `channel_id` during
717 /// the handling of the events.
719 /// Note that no consistency guarantees are made about the existence of a peer with the
720 /// `counterparty_node_id` in our other maps.
723 /// The `counterparty_node_id` isn't passed with `MonitorEvent`s currently. To pass it, we need
724 /// to make `counterparty_node_id`'s a required field in `ChannelMonitor`s, which unfortunately
725 /// would break backwards compatability.
726 /// We should add `counterparty_node_id`s to `MonitorEvent`s, and eventually rely on it in the
727 /// future. That would make this map redundant, as only the `ChannelManager::per_peer_state` is
728 /// required to access the channel with the `counterparty_node_id`.
730 /// See `ChannelManager` struct-level documentation for lock order requirements.
731 id_to_peer: Mutex<HashMap<[u8; 32], PublicKey>>,
733 /// SCIDs (and outbound SCID aliases) -> `counterparty_node_id`s and `channel_id`s.
735 /// Outbound SCID aliases are added here once the channel is available for normal use, with
736 /// SCIDs being added once the funding transaction is confirmed at the channel's required
737 /// confirmation depth.
739 /// Note that while this holds `counterparty_node_id`s and `channel_id`s, no consistency
740 /// guarantees are made about the existence of a peer with the `counterparty_node_id` nor a
741 /// channel with the `channel_id` in our other maps.
743 /// See `ChannelManager` struct-level documentation for lock order requirements.
745 pub(super) short_to_chan_info: FairRwLock<HashMap<u64, (PublicKey, [u8; 32])>>,
747 short_to_chan_info: FairRwLock<HashMap<u64, (PublicKey, [u8; 32])>>,
749 our_network_pubkey: PublicKey,
751 inbound_payment_key: inbound_payment::ExpandedKey,
753 /// LDK puts the [fake scids] that it generates into namespaces, to identify the type of an
754 /// incoming payment. To make it harder for a third-party to identify the type of a payment,
755 /// we encrypt the namespace identifier using these bytes.
757 /// [fake scids]: crate::util::scid_utils::fake_scid
758 fake_scid_rand_bytes: [u8; 32],
760 /// When we send payment probes, we generate the [`PaymentHash`] based on this cookie secret
761 /// and a random [`PaymentId`]. This allows us to discern probes from real payments, without
762 /// keeping additional state.
763 probing_cookie_secret: [u8; 32],
765 /// The highest block timestamp we've seen, which is usually a good guess at the current time.
766 /// Assuming most miners are generating blocks with reasonable timestamps, this shouldn't be
767 /// very far in the past, and can only ever be up to two hours in the future.
768 highest_seen_timestamp: AtomicUsize,
770 /// The bulk of our storage. Currently the `per_peer_state` stores our channels on a per-peer
771 /// basis, as well as the peer's latest features.
773 /// If we are connected to a peer we always at least have an entry here, even if no channels
774 /// are currently open with that peer.
776 /// Because adding or removing an entry is rare, we usually take an outer read lock and then
777 /// operate on the inner value freely. This opens up for parallel per-peer operation for
780 /// Note that the same thread must never acquire two inner `PeerState` locks at the same time.
782 /// See `ChannelManager` struct-level documentation for lock order requirements.
783 #[cfg(not(any(test, feature = "_test_utils")))]
784 per_peer_state: FairRwLock<HashMap<PublicKey, Mutex<PeerState<<SP::Target as SignerProvider>::Signer>>>>,
785 #[cfg(any(test, feature = "_test_utils"))]
786 pub(super) per_peer_state: FairRwLock<HashMap<PublicKey, Mutex<PeerState<<SP::Target as SignerProvider>::Signer>>>>,
788 /// See `ChannelManager` struct-level documentation for lock order requirements.
789 pending_events: Mutex<Vec<events::Event>>,
790 /// See `ChannelManager` struct-level documentation for lock order requirements.
791 pending_background_events: Mutex<Vec<BackgroundEvent>>,
792 /// Used when we have to take a BIG lock to make sure everything is self-consistent.
793 /// Essentially just when we're serializing ourselves out.
794 /// Taken first everywhere where we are making changes before any other locks.
795 /// When acquiring this lock in read mode, rather than acquiring it directly, call
796 /// `PersistenceNotifierGuard::notify_on_drop(..)` and pass the lock to it, to ensure the
797 /// Notifier the lock contains sends out a notification when the lock is released.
798 total_consistency_lock: RwLock<()>,
800 persistence_notifier: Notifier,
809 /// Chain-related parameters used to construct a new `ChannelManager`.
811 /// Typically, the block-specific parameters are derived from the best block hash for the network,
812 /// as a newly constructed `ChannelManager` will not have created any channels yet. These parameters
813 /// are not needed when deserializing a previously constructed `ChannelManager`.
814 #[derive(Clone, Copy, PartialEq)]
815 pub struct ChainParameters {
816 /// The network for determining the `chain_hash` in Lightning messages.
817 pub network: Network,
819 /// The hash and height of the latest block successfully connected.
821 /// Used to track on-chain channel funding outputs and send payments with reliable timelocks.
822 pub best_block: BestBlock,
825 #[derive(Copy, Clone, PartialEq)]
831 /// Whenever we release the `ChannelManager`'s `total_consistency_lock`, from read mode, it is
832 /// desirable to notify any listeners on `await_persistable_update_timeout`/
833 /// `await_persistable_update` when new updates are available for persistence. Therefore, this
834 /// struct is responsible for locking the total consistency lock and, upon going out of scope,
835 /// sending the aforementioned notification (since the lock being released indicates that the
836 /// updates are ready for persistence).
838 /// We allow callers to either always notify by constructing with `notify_on_drop` or choose to
839 /// notify or not based on whether relevant changes have been made, providing a closure to
840 /// `optionally_notify` which returns a `NotifyOption`.
841 struct PersistenceNotifierGuard<'a, F: Fn() -> NotifyOption> {
842 persistence_notifier: &'a Notifier,
844 // We hold onto this result so the lock doesn't get released immediately.
845 _read_guard: RwLockReadGuard<'a, ()>,
848 impl<'a> PersistenceNotifierGuard<'a, fn() -> NotifyOption> { // We don't care what the concrete F is here, it's unused
849 fn notify_on_drop(lock: &'a RwLock<()>, notifier: &'a Notifier) -> PersistenceNotifierGuard<'a, impl Fn() -> NotifyOption> {
850 PersistenceNotifierGuard::optionally_notify(lock, notifier, || -> NotifyOption { NotifyOption::DoPersist })
853 fn optionally_notify<F: Fn() -> NotifyOption>(lock: &'a RwLock<()>, notifier: &'a Notifier, persist_check: F) -> PersistenceNotifierGuard<'a, F> {
854 let read_guard = lock.read().unwrap();
856 PersistenceNotifierGuard {
857 persistence_notifier: notifier,
858 should_persist: persist_check,
859 _read_guard: read_guard,
864 impl<'a, F: Fn() -> NotifyOption> Drop for PersistenceNotifierGuard<'a, F> {
866 if (self.should_persist)() == NotifyOption::DoPersist {
867 self.persistence_notifier.notify();
872 /// The amount of time in blocks we require our counterparty wait to claim their money (ie time
873 /// between when we, or our watchtower, must check for them having broadcast a theft transaction).
875 /// This can be increased (but not decreased) through [`ChannelHandshakeConfig::our_to_self_delay`]
877 /// [`ChannelHandshakeConfig::our_to_self_delay`]: crate::util::config::ChannelHandshakeConfig::our_to_self_delay
878 pub const BREAKDOWN_TIMEOUT: u16 = 6 * 24;
879 /// The amount of time in blocks we're willing to wait to claim money back to us. This matches
880 /// the maximum required amount in lnd as of March 2021.
881 pub(crate) const MAX_LOCAL_BREAKDOWN_TIMEOUT: u16 = 2 * 6 * 24 * 7;
883 /// The minimum number of blocks between an inbound HTLC's CLTV and the corresponding outbound
884 /// HTLC's CLTV. The current default represents roughly seven hours of blocks at six blocks/hour.
886 /// This can be increased (but not decreased) through [`ChannelConfig::cltv_expiry_delta`]
888 /// [`ChannelConfig::cltv_expiry_delta`]: crate::util::config::ChannelConfig::cltv_expiry_delta
889 // This should always be a few blocks greater than channelmonitor::CLTV_CLAIM_BUFFER,
890 // i.e. the node we forwarded the payment on to should always have enough room to reliably time out
891 // the HTLC via a full update_fail_htlc/commitment_signed dance before we hit the
892 // CLTV_CLAIM_BUFFER point (we static assert that it's at least 3 blocks more).
893 pub const MIN_CLTV_EXPIRY_DELTA: u16 = 6*7;
894 // This should be long enough to allow a payment path drawn across multiple routing hops with substantial
895 // `cltv_expiry_delta`. Indeed, the length of those values is the reaction delay offered to a routing node
896 // in case of HTLC on-chain settlement. While appearing less competitive, a node operator could decide to
897 // scale them up to suit its security policy. At the network-level, we shouldn't constrain them too much,
898 // while avoiding to introduce a DoS vector. Further, a low CTLV_FAR_FAR_AWAY could be a source of
899 // routing failure for any HTLC sender picking up an LDK node among the first hops.
900 pub(super) const CLTV_FAR_FAR_AWAY: u32 = 14 * 24 * 6;
902 /// Minimum CLTV difference between the current block height and received inbound payments.
903 /// Invoices generated for payment to us must set their `min_final_cltv_expiry_delta` field to at least
905 // Note that we fail if exactly HTLC_FAIL_BACK_BUFFER + 1 was used, so we need to add one for
906 // any payments to succeed. Further, we don't want payments to fail if a block was found while
907 // a payment was being routed, so we add an extra block to be safe.
908 pub const MIN_FINAL_CLTV_EXPIRY_DELTA: u16 = HTLC_FAIL_BACK_BUFFER as u16 + 3;
910 // Check that our CLTV_EXPIRY is at least CLTV_CLAIM_BUFFER + ANTI_REORG_DELAY + LATENCY_GRACE_PERIOD_BLOCKS,
911 // ie that if the next-hop peer fails the HTLC within
912 // LATENCY_GRACE_PERIOD_BLOCKS then we'll still have CLTV_CLAIM_BUFFER left to timeout it onchain,
913 // then waiting ANTI_REORG_DELAY to be reorg-safe on the outbound HLTC and
914 // failing the corresponding htlc backward, and us now seeing the last block of ANTI_REORG_DELAY before
915 // LATENCY_GRACE_PERIOD_BLOCKS.
918 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;
920 // Check for ability of an attacker to make us fail on-chain by delaying an HTLC claim. See
921 // ChannelMonitor::should_broadcast_holder_commitment_txn for a description of why this is needed.
924 const CHECK_CLTV_EXPIRY_SANITY_2: u32 = MIN_CLTV_EXPIRY_DELTA as u32 - LATENCY_GRACE_PERIOD_BLOCKS - 2*CLTV_CLAIM_BUFFER;
926 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] until expiry of incomplete MPPs
927 pub(crate) const MPP_TIMEOUT_TICKS: u8 = 3;
929 /// The number of ticks of [`ChannelManager::timer_tick_occurred`] until we time-out the
930 /// idempotency of payments by [`PaymentId`]. See
931 /// [`OutboundPayments::remove_stale_resolved_payments`].
932 pub(crate) const IDEMPOTENCY_TIMEOUT_TICKS: u8 = 7;
934 /// Information needed for constructing an invoice route hint for this channel.
935 #[derive(Clone, Debug, PartialEq)]
936 pub struct CounterpartyForwardingInfo {
937 /// Base routing fee in millisatoshis.
938 pub fee_base_msat: u32,
939 /// Amount in millionths of a satoshi the channel will charge per transferred satoshi.
940 pub fee_proportional_millionths: u32,
941 /// The minimum difference in cltv_expiry between an ingoing HTLC and its outgoing counterpart,
942 /// such that the outgoing HTLC is forwardable to this counterparty. See `msgs::ChannelUpdate`'s
943 /// `cltv_expiry_delta` for more details.
944 pub cltv_expiry_delta: u16,
947 /// Channel parameters which apply to our counterparty. These are split out from [`ChannelDetails`]
948 /// to better separate parameters.
949 #[derive(Clone, Debug, PartialEq)]
950 pub struct ChannelCounterparty {
951 /// The node_id of our counterparty
952 pub node_id: PublicKey,
953 /// The Features the channel counterparty provided upon last connection.
954 /// Useful for routing as it is the most up-to-date copy of the counterparty's features and
955 /// many routing-relevant features are present in the init context.
956 pub features: InitFeatures,
957 /// The value, in satoshis, that must always be held in the channel for our counterparty. This
958 /// value ensures that if our counterparty broadcasts a revoked state, we can punish them by
959 /// claiming at least this value on chain.
961 /// This value is not included in [`inbound_capacity_msat`] as it can never be spent.
963 /// [`inbound_capacity_msat`]: ChannelDetails::inbound_capacity_msat
964 pub unspendable_punishment_reserve: u64,
965 /// Information on the fees and requirements that the counterparty requires when forwarding
966 /// payments to us through this channel.
967 pub forwarding_info: Option<CounterpartyForwardingInfo>,
968 /// The smallest value HTLC (in msat) the remote peer will accept, for this channel. This field
969 /// is only `None` before we have received either the `OpenChannel` or `AcceptChannel` message
970 /// from the remote peer, or for `ChannelCounterparty` objects serialized prior to LDK 0.0.107.
971 pub outbound_htlc_minimum_msat: Option<u64>,
972 /// The largest value HTLC (in msat) the remote peer currently will accept, for this channel.
973 pub outbound_htlc_maximum_msat: Option<u64>,
976 /// Details of a channel, as returned by ChannelManager::list_channels and ChannelManager::list_usable_channels
977 #[derive(Clone, Debug, PartialEq)]
978 pub struct ChannelDetails {
979 /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
980 /// thereafter this is the txid of the funding transaction xor the funding transaction output).
981 /// Note that this means this value is *not* persistent - it can change once during the
982 /// lifetime of the channel.
983 pub channel_id: [u8; 32],
984 /// Parameters which apply to our counterparty. See individual fields for more information.
985 pub counterparty: ChannelCounterparty,
986 /// The Channel's funding transaction output, if we've negotiated the funding transaction with
987 /// our counterparty already.
989 /// Note that, if this has been set, `channel_id` will be equivalent to
990 /// `funding_txo.unwrap().to_channel_id()`.
991 pub funding_txo: Option<OutPoint>,
992 /// The features which this channel operates with. See individual features for more info.
994 /// `None` until negotiation completes and the channel type is finalized.
995 pub channel_type: Option<ChannelTypeFeatures>,
996 /// The position of the funding transaction in the chain. None if the funding transaction has
997 /// not yet been confirmed and the channel fully opened.
999 /// Note that if [`inbound_scid_alias`] is set, it must be used for invoices and inbound
1000 /// payments instead of this. See [`get_inbound_payment_scid`].
1002 /// For channels with [`confirmations_required`] set to `Some(0)`, [`outbound_scid_alias`] may
1003 /// be used in place of this in outbound routes. See [`get_outbound_payment_scid`].
1005 /// [`inbound_scid_alias`]: Self::inbound_scid_alias
1006 /// [`outbound_scid_alias`]: Self::outbound_scid_alias
1007 /// [`get_inbound_payment_scid`]: Self::get_inbound_payment_scid
1008 /// [`get_outbound_payment_scid`]: Self::get_outbound_payment_scid
1009 /// [`confirmations_required`]: Self::confirmations_required
1010 pub short_channel_id: Option<u64>,
1011 /// An optional [`short_channel_id`] alias for this channel, randomly generated by us and
1012 /// usable in place of [`short_channel_id`] to reference the channel in outbound routes when
1013 /// the channel has not yet been confirmed (as long as [`confirmations_required`] is
1016 /// This will be `None` as long as the channel is not available for routing outbound payments.
1018 /// [`short_channel_id`]: Self::short_channel_id
1019 /// [`confirmations_required`]: Self::confirmations_required
1020 pub outbound_scid_alias: Option<u64>,
1021 /// An optional [`short_channel_id`] alias for this channel, randomly generated by our
1022 /// counterparty and usable in place of [`short_channel_id`] in invoice route hints. Our
1023 /// counterparty will recognize the alias provided here in place of the [`short_channel_id`]
1024 /// when they see a payment to be routed to us.
1026 /// Our counterparty may choose to rotate this value at any time, though will always recognize
1027 /// previous values for inbound payment forwarding.
1029 /// [`short_channel_id`]: Self::short_channel_id
1030 pub inbound_scid_alias: Option<u64>,
1031 /// The value, in satoshis, of this channel as appears in the funding output
1032 pub channel_value_satoshis: u64,
1033 /// The value, in satoshis, that must always be held in the channel for us. This value ensures
1034 /// that if we broadcast a revoked state, our counterparty can punish us by claiming at least
1035 /// this value on chain.
1037 /// This value is not included in [`outbound_capacity_msat`] as it can never be spent.
1039 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1041 /// [`outbound_capacity_msat`]: ChannelDetails::outbound_capacity_msat
1042 pub unspendable_punishment_reserve: Option<u64>,
1043 /// The `user_channel_id` passed in to create_channel, or a random value if the channel was
1044 /// inbound. This may be zero for inbound channels serialized with LDK versions prior to
1046 pub user_channel_id: u128,
1047 /// Our total balance. This is the amount we would get if we close the channel.
1048 /// This value is not exact. Due to various in-flight changes and feerate changes, exactly this
1049 /// amount is not likely to be recoverable on close.
1051 /// This does not include any pending HTLCs which are not yet fully resolved (and, thus, whose
1052 /// balance is not available for inclusion in new outbound HTLCs). This further does not include
1053 /// any pending outgoing HTLCs which are awaiting some other resolution to be sent.
1054 /// This does not consider any on-chain fees.
1056 /// See also [`ChannelDetails::outbound_capacity_msat`]
1057 pub balance_msat: u64,
1058 /// The available outbound capacity for sending HTLCs to the remote peer. This does not include
1059 /// any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1060 /// available for inclusion in new outbound HTLCs). This further does not include any pending
1061 /// outgoing HTLCs which are awaiting some other resolution to be sent.
1063 /// See also [`ChannelDetails::balance_msat`]
1065 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1066 /// conflict-avoidance policy, exactly this amount is not likely to be spendable. However, we
1067 /// should be able to spend nearly this amount.
1068 pub outbound_capacity_msat: u64,
1069 /// The available outbound capacity for sending a single HTLC to the remote peer. This is
1070 /// similar to [`ChannelDetails::outbound_capacity_msat`] but it may be further restricted by
1071 /// the current state and per-HTLC limit(s). This is intended for use when routing, allowing us
1072 /// to use a limit as close as possible to the HTLC limit we can currently send.
1074 /// See also [`ChannelDetails::balance_msat`] and [`ChannelDetails::outbound_capacity_msat`].
1075 pub next_outbound_htlc_limit_msat: u64,
1076 /// The available inbound capacity for the remote peer to send HTLCs to us. This does not
1077 /// include any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1078 /// available for inclusion in new inbound HTLCs).
1079 /// Note that there are some corner cases not fully handled here, so the actual available
1080 /// inbound capacity may be slightly higher than this.
1082 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1083 /// counterparty's conflict-avoidance policy, exactly this amount is not likely to be spendable.
1084 /// However, our counterparty should be able to spend nearly this amount.
1085 pub inbound_capacity_msat: u64,
1086 /// The number of required confirmations on the funding transaction before the funding will be
1087 /// considered "locked". This number is selected by the channel fundee (i.e. us if
1088 /// [`is_outbound`] is *not* set), and can be selected for inbound channels with
1089 /// [`ChannelHandshakeConfig::minimum_depth`] or limited for outbound channels with
1090 /// [`ChannelHandshakeLimits::max_minimum_depth`].
1092 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1094 /// [`is_outbound`]: ChannelDetails::is_outbound
1095 /// [`ChannelHandshakeConfig::minimum_depth`]: crate::util::config::ChannelHandshakeConfig::minimum_depth
1096 /// [`ChannelHandshakeLimits::max_minimum_depth`]: crate::util::config::ChannelHandshakeLimits::max_minimum_depth
1097 pub confirmations_required: Option<u32>,
1098 /// The current number of confirmations on the funding transaction.
1100 /// This value will be `None` for objects serialized with LDK versions prior to 0.0.113.
1101 pub confirmations: Option<u32>,
1102 /// The number of blocks (after our commitment transaction confirms) that we will need to wait
1103 /// until we can claim our funds after we force-close the channel. During this time our
1104 /// counterparty is allowed to punish us if we broadcasted a stale state. If our counterparty
1105 /// force-closes the channel and broadcasts a commitment transaction we do not have to wait any
1106 /// time to claim our non-HTLC-encumbered funds.
1108 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1109 pub force_close_spend_delay: Option<u16>,
1110 /// True if the channel was initiated (and thus funded) by us.
1111 pub is_outbound: bool,
1112 /// True if the channel is confirmed, channel_ready messages have been exchanged, and the
1113 /// channel is not currently being shut down. `channel_ready` message exchange implies the
1114 /// required confirmation count has been reached (and we were connected to the peer at some
1115 /// point after the funding transaction received enough confirmations). The required
1116 /// confirmation count is provided in [`confirmations_required`].
1118 /// [`confirmations_required`]: ChannelDetails::confirmations_required
1119 pub is_channel_ready: bool,
1120 /// True if the channel is (a) confirmed and channel_ready messages have been exchanged, (b)
1121 /// the peer is connected, and (c) the channel is not currently negotiating a shutdown.
1123 /// This is a strict superset of `is_channel_ready`.
1124 pub is_usable: bool,
1125 /// True if this channel is (or will be) publicly-announced.
1126 pub is_public: bool,
1127 /// The smallest value HTLC (in msat) we will accept, for this channel. This field
1128 /// is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.107
1129 pub inbound_htlc_minimum_msat: Option<u64>,
1130 /// The largest value HTLC (in msat) we currently will accept, for this channel.
1131 pub inbound_htlc_maximum_msat: Option<u64>,
1132 /// Set of configurable parameters that affect channel operation.
1134 /// This field is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.109.
1135 pub config: Option<ChannelConfig>,
1138 impl ChannelDetails {
1139 /// Gets the current SCID which should be used to identify this channel for inbound payments.
1140 /// This should be used for providing invoice hints or in any other context where our
1141 /// counterparty will forward a payment to us.
1143 /// This is either the [`ChannelDetails::inbound_scid_alias`], if set, or the
1144 /// [`ChannelDetails::short_channel_id`]. See those for more information.
1145 pub fn get_inbound_payment_scid(&self) -> Option<u64> {
1146 self.inbound_scid_alias.or(self.short_channel_id)
1149 /// Gets the current SCID which should be used to identify this channel for outbound payments.
1150 /// This should be used in [`Route`]s to describe the first hop or in other contexts where
1151 /// we're sending or forwarding a payment outbound over this channel.
1153 /// This is either the [`ChannelDetails::short_channel_id`], if set, or the
1154 /// [`ChannelDetails::outbound_scid_alias`]. See those for more information.
1155 pub fn get_outbound_payment_scid(&self) -> Option<u64> {
1156 self.short_channel_id.or(self.outbound_scid_alias)
1160 /// Used by [`ChannelManager::list_recent_payments`] to express the status of recent payments.
1161 /// These include payments that have yet to find a successful path, or have unresolved HTLCs.
1162 #[derive(Debug, PartialEq)]
1163 pub enum RecentPaymentDetails {
1164 /// When a payment is still being sent and awaiting successful delivery.
1166 /// Hash of the payment that is currently being sent but has yet to be fulfilled or
1168 payment_hash: PaymentHash,
1169 /// Total amount (in msat, excluding fees) across all paths for this payment,
1170 /// not just the amount currently inflight.
1173 /// When a pending payment is fulfilled, we continue tracking it until all pending HTLCs have
1174 /// been resolved. Upon receiving [`Event::PaymentSent`], we delay for a few minutes before the
1175 /// payment is removed from tracking.
1177 /// Hash of the payment that was claimed. `None` for serializations of [`ChannelManager`]
1178 /// made before LDK version 0.0.104.
1179 payment_hash: Option<PaymentHash>,
1181 /// After a payment is explicitly abandoned by calling [`ChannelManager::abandon_payment`], it
1182 /// is marked as abandoned until an [`Event::PaymentFailed`] is generated. A payment could also
1183 /// be marked as abandoned if pathfinding fails repeatedly or retries have been exhausted.
1185 /// Hash of the payment that we have given up trying to send.
1186 payment_hash: PaymentHash,
1190 /// Route hints used in constructing invoices for [phantom node payents].
1192 /// [phantom node payments]: crate::chain::keysinterface::PhantomKeysManager
1194 pub struct PhantomRouteHints {
1195 /// The list of channels to be included in the invoice route hints.
1196 pub channels: Vec<ChannelDetails>,
1197 /// A fake scid used for representing the phantom node's fake channel in generating the invoice
1199 pub phantom_scid: u64,
1200 /// The pubkey of the real backing node that would ultimately receive the payment.
1201 pub real_node_pubkey: PublicKey,
1204 macro_rules! handle_error {
1205 ($self: ident, $internal: expr, $counterparty_node_id: expr) => {
1208 Err(MsgHandleErrInternal { err, chan_id, shutdown_finish }) => {
1209 #[cfg(any(feature = "_test_utils", test))]
1211 // In testing, ensure there are no deadlocks where the lock is already held upon
1212 // entering the macro.
1213 debug_assert!($self.pending_events.try_lock().is_ok());
1214 debug_assert!($self.per_peer_state.try_write().is_ok());
1217 let mut msg_events = Vec::with_capacity(2);
1219 if let Some((shutdown_res, update_option)) = shutdown_finish {
1220 $self.finish_force_close_channel(shutdown_res);
1221 if let Some(update) = update_option {
1222 msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1226 if let Some((channel_id, user_channel_id)) = chan_id {
1227 $self.pending_events.lock().unwrap().push(events::Event::ChannelClosed {
1228 channel_id, user_channel_id,
1229 reason: ClosureReason::ProcessingError { err: err.err.clone() }
1234 log_error!($self.logger, "{}", err.err);
1235 if let msgs::ErrorAction::IgnoreError = err.action {
1237 msg_events.push(events::MessageSendEvent::HandleError {
1238 node_id: $counterparty_node_id,
1239 action: err.action.clone()
1243 if !msg_events.is_empty() {
1244 let per_peer_state = $self.per_peer_state.read().unwrap();
1245 if let Some(peer_state_mutex) = per_peer_state.get(&$counterparty_node_id) {
1246 let mut peer_state = peer_state_mutex.lock().unwrap();
1247 peer_state.pending_msg_events.append(&mut msg_events);
1249 #[cfg(any(feature = "_test_utils", test))]
1251 if per_peer_state.get(&$counterparty_node_id).is_none() {
1252 // This shouldn't occur in tests unless an unknown counterparty_node_id
1253 // has been passed to our message handling functions.
1254 let expected_error_str = format!("Can't find a peer matching the passed counterparty node_id {}", $counterparty_node_id);
1256 msgs::ErrorAction::SendErrorMessage {
1257 msg: msgs::ErrorMessage { ref channel_id, ref data }
1260 assert_eq!(*data, expected_error_str);
1261 if let Some((err_channel_id, _user_channel_id)) = chan_id {
1262 debug_assert_eq!(*channel_id, err_channel_id);
1265 _ => debug_assert!(false, "Unexpected event"),
1271 // Return error in case higher-API need one
1278 macro_rules! update_maps_on_chan_removal {
1279 ($self: expr, $channel: expr) => {{
1280 $self.id_to_peer.lock().unwrap().remove(&$channel.channel_id());
1281 let mut short_to_chan_info = $self.short_to_chan_info.write().unwrap();
1282 if let Some(short_id) = $channel.get_short_channel_id() {
1283 short_to_chan_info.remove(&short_id);
1285 // If the channel was never confirmed on-chain prior to its closure, remove the
1286 // outbound SCID alias we used for it from the collision-prevention set. While we
1287 // generally want to avoid ever re-using an outbound SCID alias across all channels, we
1288 // also don't want a counterparty to be able to trivially cause a memory leak by simply
1289 // opening a million channels with us which are closed before we ever reach the funding
1291 let alias_removed = $self.outbound_scid_aliases.lock().unwrap().remove(&$channel.outbound_scid_alias());
1292 debug_assert!(alias_removed);
1294 short_to_chan_info.remove(&$channel.outbound_scid_alias());
1298 /// Returns (boolean indicating if we should remove the Channel object from memory, a mapped error)
1299 macro_rules! convert_chan_err {
1300 ($self: ident, $err: expr, $channel: expr, $channel_id: expr) => {
1302 ChannelError::Warn(msg) => {
1303 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Warn(msg), $channel_id.clone()))
1305 ChannelError::Ignore(msg) => {
1306 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore(msg), $channel_id.clone()))
1308 ChannelError::Close(msg) => {
1309 log_error!($self.logger, "Closing channel {} due to close-required error: {}", log_bytes!($channel_id[..]), msg);
1310 update_maps_on_chan_removal!($self, $channel);
1311 let shutdown_res = $channel.force_shutdown(true);
1312 (true, MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, $channel.get_user_id(),
1313 shutdown_res, $self.get_channel_update_for_broadcast(&$channel).ok()))
1319 macro_rules! break_chan_entry {
1320 ($self: ident, $res: expr, $entry: expr) => {
1324 let (drop, res) = convert_chan_err!($self, e, $entry.get_mut(), $entry.key());
1326 $entry.remove_entry();
1334 macro_rules! try_chan_entry {
1335 ($self: ident, $res: expr, $entry: expr) => {
1339 let (drop, res) = convert_chan_err!($self, e, $entry.get_mut(), $entry.key());
1341 $entry.remove_entry();
1349 macro_rules! remove_channel {
1350 ($self: expr, $entry: expr) => {
1352 let channel = $entry.remove_entry().1;
1353 update_maps_on_chan_removal!($self, channel);
1359 macro_rules! handle_monitor_update_res {
1360 ($self: ident, $err: expr, $chan: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr, $resend_channel_ready: expr, $failed_forwards: expr, $failed_fails: expr, $failed_finalized_fulfills: expr, $chan_id: expr) => {
1362 ChannelMonitorUpdateStatus::PermanentFailure => {
1363 log_error!($self.logger, "Closing channel {} due to monitor update ChannelMonitorUpdateStatus::PermanentFailure", log_bytes!($chan_id[..]));
1364 update_maps_on_chan_removal!($self, $chan);
1365 // TODO: $failed_fails is dropped here, which will cause other channels to hit the
1366 // chain in a confused state! We need to move them into the ChannelMonitor which
1367 // will be responsible for failing backwards once things confirm on-chain.
1368 // It's ok that we drop $failed_forwards here - at this point we'd rather they
1369 // broadcast HTLC-Timeout and pay the associated fees to get their funds back than
1370 // us bother trying to claim it just to forward on to another peer. If we're
1371 // splitting hairs we'd prefer to claim payments that were to us, but we haven't
1372 // given up the preimage yet, so might as well just wait until the payment is
1373 // retried, avoiding the on-chain fees.
1374 let res: Result<(), _> = Err(MsgHandleErrInternal::from_finish_shutdown("ChannelMonitor storage failure".to_owned(), *$chan_id, $chan.get_user_id(),
1375 $chan.force_shutdown(false), $self.get_channel_update_for_broadcast(&$chan).ok() ));
1378 ChannelMonitorUpdateStatus::InProgress => {
1379 log_info!($self.logger, "Disabling channel {} due to monitor update in progress. On restore will send {} and process {} forwards, {} fails, and {} fulfill finalizations",
1380 log_bytes!($chan_id[..]),
1381 if $resend_commitment && $resend_raa {
1382 match $action_type {
1383 RAACommitmentOrder::CommitmentFirst => { "commitment then RAA" },
1384 RAACommitmentOrder::RevokeAndACKFirst => { "RAA then commitment" },
1386 } else if $resend_commitment { "commitment" }
1387 else if $resend_raa { "RAA" }
1389 (&$failed_forwards as &Vec<(PendingHTLCInfo, u64)>).len(),
1390 (&$failed_fails as &Vec<(HTLCSource, PaymentHash, HTLCFailReason)>).len(),
1391 (&$failed_finalized_fulfills as &Vec<HTLCSource>).len());
1392 if !$resend_commitment {
1393 debug_assert!($action_type == RAACommitmentOrder::RevokeAndACKFirst || !$resend_raa);
1396 debug_assert!($action_type == RAACommitmentOrder::CommitmentFirst || !$resend_commitment);
1398 $chan.monitor_updating_paused($resend_raa, $resend_commitment, $resend_channel_ready, $failed_forwards, $failed_fails, $failed_finalized_fulfills);
1399 (Err(MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore("Failed to update ChannelMonitor".to_owned()), *$chan_id)), false)
1401 ChannelMonitorUpdateStatus::Completed => {
1406 ($self: ident, $err: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr, $resend_channel_ready: expr, $failed_forwards: expr, $failed_fails: expr, $failed_finalized_fulfills: expr) => { {
1407 let (res, drop) = handle_monitor_update_res!($self, $err, $entry.get_mut(), $action_type, $resend_raa, $resend_commitment, $resend_channel_ready, $failed_forwards, $failed_fails, $failed_finalized_fulfills, $entry.key());
1409 $entry.remove_entry();
1413 ($self: ident, $err: expr, $entry: expr, $action_type: path, $chan_id: expr, COMMITMENT_UPDATE_ONLY) => { {
1414 debug_assert!($action_type == RAACommitmentOrder::CommitmentFirst);
1415 handle_monitor_update_res!($self, $err, $entry, $action_type, false, true, false, Vec::new(), Vec::new(), Vec::new(), $chan_id)
1417 ($self: ident, $err: expr, $entry: expr, $action_type: path, $chan_id: expr, NO_UPDATE) => {
1418 handle_monitor_update_res!($self, $err, $entry, $action_type, false, false, false, Vec::new(), Vec::new(), Vec::new(), $chan_id)
1420 ($self: ident, $err: expr, $entry: expr, $action_type: path, $resend_channel_ready: expr, OPTIONALLY_RESEND_FUNDING_LOCKED) => {
1421 handle_monitor_update_res!($self, $err, $entry, $action_type, false, false, $resend_channel_ready, Vec::new(), Vec::new(), Vec::new())
1423 ($self: ident, $err: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
1424 handle_monitor_update_res!($self, $err, $entry, $action_type, $resend_raa, $resend_commitment, false, Vec::new(), Vec::new(), Vec::new())
1426 ($self: ident, $err: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr, $failed_forwards: expr, $failed_fails: expr) => {
1427 handle_monitor_update_res!($self, $err, $entry, $action_type, $resend_raa, $resend_commitment, false, $failed_forwards, $failed_fails, Vec::new())
1431 macro_rules! send_channel_ready {
1432 ($self: ident, $pending_msg_events: expr, $channel: expr, $channel_ready_msg: expr) => {{
1433 $pending_msg_events.push(events::MessageSendEvent::SendChannelReady {
1434 node_id: $channel.get_counterparty_node_id(),
1435 msg: $channel_ready_msg,
1437 // Note that we may send a `channel_ready` multiple times for a channel if we reconnect, so
1438 // we allow collisions, but we shouldn't ever be updating the channel ID pointed to.
1439 let mut short_to_chan_info = $self.short_to_chan_info.write().unwrap();
1440 let outbound_alias_insert = short_to_chan_info.insert($channel.outbound_scid_alias(), ($channel.get_counterparty_node_id(), $channel.channel_id()));
1441 assert!(outbound_alias_insert.is_none() || outbound_alias_insert.unwrap() == ($channel.get_counterparty_node_id(), $channel.channel_id()),
1442 "SCIDs should never collide - ensure you weren't behind the chain tip by a full month when creating channels");
1443 if let Some(real_scid) = $channel.get_short_channel_id() {
1444 let scid_insert = short_to_chan_info.insert(real_scid, ($channel.get_counterparty_node_id(), $channel.channel_id()));
1445 assert!(scid_insert.is_none() || scid_insert.unwrap() == ($channel.get_counterparty_node_id(), $channel.channel_id()),
1446 "SCIDs should never collide - ensure you weren't behind the chain tip by a full month when creating channels");
1451 macro_rules! emit_channel_ready_event {
1452 ($self: expr, $channel: expr) => {
1453 if $channel.should_emit_channel_ready_event() {
1455 let mut pending_events = $self.pending_events.lock().unwrap();
1456 pending_events.push(events::Event::ChannelReady {
1457 channel_id: $channel.channel_id(),
1458 user_channel_id: $channel.get_user_id(),
1459 counterparty_node_id: $channel.get_counterparty_node_id(),
1460 channel_type: $channel.get_channel_type().clone(),
1463 $channel.set_channel_ready_event_emitted();
1468 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref> ChannelManager<M, T, ES, NS, SP, F, R, L>
1470 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
1471 T::Target: BroadcasterInterface,
1472 ES::Target: EntropySource,
1473 NS::Target: NodeSigner,
1474 SP::Target: SignerProvider,
1475 F::Target: FeeEstimator,
1479 /// Constructs a new ChannelManager to hold several channels and route between them.
1481 /// This is the main "logic hub" for all channel-related actions, and implements
1482 /// ChannelMessageHandler.
1484 /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
1486 /// Users need to notify the new ChannelManager when a new block is connected or
1487 /// disconnected using its `block_connected` and `block_disconnected` methods, starting
1488 /// from after `params.latest_hash`.
1489 pub fn new(fee_est: F, chain_monitor: M, tx_broadcaster: T, router: R, logger: L, entropy_source: ES, node_signer: NS, signer_provider: SP, config: UserConfig, params: ChainParameters) -> Self {
1490 let mut secp_ctx = Secp256k1::new();
1491 secp_ctx.seeded_randomize(&entropy_source.get_secure_random_bytes());
1492 let inbound_pmt_key_material = node_signer.get_inbound_payment_key_material();
1493 let expanded_inbound_key = inbound_payment::ExpandedKey::new(&inbound_pmt_key_material);
1495 default_configuration: config.clone(),
1496 genesis_hash: genesis_block(params.network).header.block_hash(),
1497 fee_estimator: LowerBoundedFeeEstimator::new(fee_est),
1502 best_block: RwLock::new(params.best_block),
1504 outbound_scid_aliases: Mutex::new(HashSet::new()),
1505 pending_inbound_payments: Mutex::new(HashMap::new()),
1506 pending_outbound_payments: OutboundPayments::new(),
1507 forward_htlcs: Mutex::new(HashMap::new()),
1508 claimable_payments: Mutex::new(ClaimablePayments { claimable_htlcs: HashMap::new(), pending_claiming_payments: HashMap::new() }),
1509 pending_intercepted_htlcs: Mutex::new(HashMap::new()),
1510 id_to_peer: Mutex::new(HashMap::new()),
1511 short_to_chan_info: FairRwLock::new(HashMap::new()),
1513 our_network_pubkey: node_signer.get_node_id(Recipient::Node).unwrap(),
1516 inbound_payment_key: expanded_inbound_key,
1517 fake_scid_rand_bytes: entropy_source.get_secure_random_bytes(),
1519 probing_cookie_secret: entropy_source.get_secure_random_bytes(),
1521 highest_seen_timestamp: AtomicUsize::new(0),
1523 per_peer_state: FairRwLock::new(HashMap::new()),
1525 pending_events: Mutex::new(Vec::new()),
1526 pending_background_events: Mutex::new(Vec::new()),
1527 total_consistency_lock: RwLock::new(()),
1528 persistence_notifier: Notifier::new(),
1538 /// Gets the current configuration applied to all new channels.
1539 pub fn get_current_default_configuration(&self) -> &UserConfig {
1540 &self.default_configuration
1543 fn create_and_insert_outbound_scid_alias(&self) -> u64 {
1544 let height = self.best_block.read().unwrap().height();
1545 let mut outbound_scid_alias = 0;
1548 if cfg!(fuzzing) { // fuzzing chacha20 doesn't use the key at all so we always get the same alias
1549 outbound_scid_alias += 1;
1551 outbound_scid_alias = fake_scid::Namespace::OutboundAlias.get_fake_scid(height, &self.genesis_hash, &self.fake_scid_rand_bytes, &self.entropy_source);
1553 if outbound_scid_alias != 0 && self.outbound_scid_aliases.lock().unwrap().insert(outbound_scid_alias) {
1557 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"); }
1562 /// Creates a new outbound channel to the given remote node and with the given value.
1564 /// `user_channel_id` will be provided back as in
1565 /// [`Event::FundingGenerationReady::user_channel_id`] to allow tracking of which events
1566 /// correspond with which `create_channel` call. Note that the `user_channel_id` defaults to a
1567 /// randomized value for inbound channels. `user_channel_id` has no meaning inside of LDK, it
1568 /// is simply copied to events and otherwise ignored.
1570 /// Raises [`APIError::APIMisuseError`] when `channel_value_satoshis` > 2**24 or `push_msat` is
1571 /// greater than `channel_value_satoshis * 1k` or `channel_value_satoshis < 1000`.
1573 /// Note that we do not check if you are currently connected to the given peer. If no
1574 /// connection is available, the outbound `open_channel` message may fail to send, resulting in
1575 /// the channel eventually being silently forgotten (dropped on reload).
1577 /// Returns the new Channel's temporary `channel_id`. This ID will appear as
1578 /// [`Event::FundingGenerationReady::temporary_channel_id`] and in
1579 /// [`ChannelDetails::channel_id`] until after
1580 /// [`ChannelManager::funding_transaction_generated`] is called, swapping the Channel's ID for
1581 /// one derived from the funding transaction's TXID. If the counterparty rejects the channel
1582 /// immediately, this temporary ID will appear in [`Event::ChannelClosed::channel_id`].
1584 /// [`Event::FundingGenerationReady::user_channel_id`]: events::Event::FundingGenerationReady::user_channel_id
1585 /// [`Event::FundingGenerationReady::temporary_channel_id`]: events::Event::FundingGenerationReady::temporary_channel_id
1586 /// [`Event::ChannelClosed::channel_id`]: events::Event::ChannelClosed::channel_id
1587 pub fn create_channel(&self, their_network_key: PublicKey, channel_value_satoshis: u64, push_msat: u64, user_channel_id: u128, override_config: Option<UserConfig>) -> Result<[u8; 32], APIError> {
1588 if channel_value_satoshis < 1000 {
1589 return Err(APIError::APIMisuseError { err: format!("Channel value must be at least 1000 satoshis. It was {}", channel_value_satoshis) });
1592 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1593 // We want to make sure the lock is actually acquired by PersistenceNotifierGuard.
1594 debug_assert!(&self.total_consistency_lock.try_write().is_err());
1596 let per_peer_state = self.per_peer_state.read().unwrap();
1598 let peer_state_mutex = per_peer_state.get(&their_network_key)
1599 .ok_or_else(|| APIError::APIMisuseError{ err: format!("Not connected to node: {}", their_network_key) })?;
1601 let mut peer_state = peer_state_mutex.lock().unwrap();
1603 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
1604 let their_features = &peer_state.latest_features;
1605 let config = if override_config.is_some() { override_config.as_ref().unwrap() } else { &self.default_configuration };
1606 match Channel::new_outbound(&self.fee_estimator, &self.entropy_source, &self.signer_provider, their_network_key,
1607 their_features, channel_value_satoshis, push_msat, user_channel_id, config,
1608 self.best_block.read().unwrap().height(), outbound_scid_alias)
1612 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
1617 let res = channel.get_open_channel(self.genesis_hash.clone());
1619 let temporary_channel_id = channel.channel_id();
1620 match peer_state.channel_by_id.entry(temporary_channel_id) {
1621 hash_map::Entry::Occupied(_) => {
1623 return Err(APIError::APIMisuseError { err: "Fuzzy bad RNG".to_owned() });
1625 panic!("RNG is bad???");
1628 hash_map::Entry::Vacant(entry) => { entry.insert(channel); }
1631 peer_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
1632 node_id: their_network_key,
1635 Ok(temporary_channel_id)
1638 fn list_channels_with_filter<Fn: FnMut(&(&[u8; 32], &Channel<<SP::Target as SignerProvider>::Signer>)) -> bool + Copy>(&self, f: Fn) -> Vec<ChannelDetails> {
1639 let mut res = Vec::new();
1640 // Allocate our best estimate of the number of channels we have in the `res`
1641 // Vec. Sadly the `short_to_chan_info` map doesn't cover channels without
1642 // a scid or a scid alias, and the `id_to_peer` shouldn't be used outside
1643 // of the ChannelMonitor handling. Therefore reallocations may still occur, but is
1644 // unlikely as the `short_to_chan_info` map often contains 2 entries for
1645 // the same channel.
1646 res.reserve(self.short_to_chan_info.read().unwrap().len());
1648 let best_block_height = self.best_block.read().unwrap().height();
1649 let per_peer_state = self.per_peer_state.read().unwrap();
1650 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
1651 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
1652 let peer_state = &mut *peer_state_lock;
1653 for (channel_id, channel) in peer_state.channel_by_id.iter().filter(f) {
1654 let balance = channel.get_available_balances();
1655 let (to_remote_reserve_satoshis, to_self_reserve_satoshis) =
1656 channel.get_holder_counterparty_selected_channel_reserve_satoshis();
1657 res.push(ChannelDetails {
1658 channel_id: (*channel_id).clone(),
1659 counterparty: ChannelCounterparty {
1660 node_id: channel.get_counterparty_node_id(),
1661 features: peer_state.latest_features.clone(),
1662 unspendable_punishment_reserve: to_remote_reserve_satoshis,
1663 forwarding_info: channel.counterparty_forwarding_info(),
1664 // Ensures that we have actually received the `htlc_minimum_msat` value
1665 // from the counterparty through the `OpenChannel` or `AcceptChannel`
1666 // message (as they are always the first message from the counterparty).
1667 // Else `Channel::get_counterparty_htlc_minimum_msat` could return the
1668 // default `0` value set by `Channel::new_outbound`.
1669 outbound_htlc_minimum_msat: if channel.have_received_message() {
1670 Some(channel.get_counterparty_htlc_minimum_msat()) } else { None },
1671 outbound_htlc_maximum_msat: channel.get_counterparty_htlc_maximum_msat(),
1673 funding_txo: channel.get_funding_txo(),
1674 // Note that accept_channel (or open_channel) is always the first message, so
1675 // `have_received_message` indicates that type negotiation has completed.
1676 channel_type: if channel.have_received_message() { Some(channel.get_channel_type().clone()) } else { None },
1677 short_channel_id: channel.get_short_channel_id(),
1678 outbound_scid_alias: if channel.is_usable() { Some(channel.outbound_scid_alias()) } else { None },
1679 inbound_scid_alias: channel.latest_inbound_scid_alias(),
1680 channel_value_satoshis: channel.get_value_satoshis(),
1681 unspendable_punishment_reserve: to_self_reserve_satoshis,
1682 balance_msat: balance.balance_msat,
1683 inbound_capacity_msat: balance.inbound_capacity_msat,
1684 outbound_capacity_msat: balance.outbound_capacity_msat,
1685 next_outbound_htlc_limit_msat: balance.next_outbound_htlc_limit_msat,
1686 user_channel_id: channel.get_user_id(),
1687 confirmations_required: channel.minimum_depth(),
1688 confirmations: Some(channel.get_funding_tx_confirmations(best_block_height)),
1689 force_close_spend_delay: channel.get_counterparty_selected_contest_delay(),
1690 is_outbound: channel.is_outbound(),
1691 is_channel_ready: channel.is_usable(),
1692 is_usable: channel.is_live(),
1693 is_public: channel.should_announce(),
1694 inbound_htlc_minimum_msat: Some(channel.get_holder_htlc_minimum_msat()),
1695 inbound_htlc_maximum_msat: channel.get_holder_htlc_maximum_msat(),
1696 config: Some(channel.config()),
1704 /// Gets the list of open channels, in random order. See ChannelDetail field documentation for
1705 /// more information.
1706 pub fn list_channels(&self) -> Vec<ChannelDetails> {
1707 self.list_channels_with_filter(|_| true)
1710 /// Gets the list of usable channels, in random order. Useful as an argument to [`find_route`]
1711 /// to ensure non-announced channels are used.
1713 /// These are guaranteed to have their [`ChannelDetails::is_usable`] value set to true, see the
1714 /// documentation for [`ChannelDetails::is_usable`] for more info on exactly what the criteria
1717 /// [`find_route`]: crate::routing::router::find_route
1718 pub fn list_usable_channels(&self) -> Vec<ChannelDetails> {
1719 // Note we use is_live here instead of usable which leads to somewhat confused
1720 // internal/external nomenclature, but that's ok cause that's probably what the user
1721 // really wanted anyway.
1722 self.list_channels_with_filter(|&(_, ref channel)| channel.is_live())
1725 /// Returns in an undefined order recent payments that -- if not fulfilled -- have yet to find a
1726 /// successful path, or have unresolved HTLCs.
1728 /// This can be useful for payments that may have been prepared, but ultimately not sent, as a
1729 /// result of a crash. If such a payment exists, is not listed here, and an
1730 /// [`Event::PaymentSent`] has not been received, you may consider retrying the payment.
1732 /// [`Event::PaymentSent`]: events::Event::PaymentSent
1733 pub fn list_recent_payments(&self) -> Vec<RecentPaymentDetails> {
1734 self.pending_outbound_payments.pending_outbound_payments.lock().unwrap().iter()
1735 .filter_map(|(_, pending_outbound_payment)| match pending_outbound_payment {
1736 PendingOutboundPayment::Retryable { payment_hash, total_msat, .. } => {
1737 Some(RecentPaymentDetails::Pending {
1738 payment_hash: *payment_hash,
1739 total_msat: *total_msat,
1742 PendingOutboundPayment::Abandoned { payment_hash, .. } => {
1743 Some(RecentPaymentDetails::Abandoned { payment_hash: *payment_hash })
1745 PendingOutboundPayment::Fulfilled { payment_hash, .. } => {
1746 Some(RecentPaymentDetails::Fulfilled { payment_hash: *payment_hash })
1748 PendingOutboundPayment::Legacy { .. } => None
1753 /// Helper function that issues the channel close events
1754 fn issue_channel_close_events(&self, channel: &Channel<<SP::Target as SignerProvider>::Signer>, closure_reason: ClosureReason) {
1755 let mut pending_events_lock = self.pending_events.lock().unwrap();
1756 match channel.unbroadcasted_funding() {
1757 Some(transaction) => {
1758 pending_events_lock.push(events::Event::DiscardFunding { channel_id: channel.channel_id(), transaction })
1762 pending_events_lock.push(events::Event::ChannelClosed {
1763 channel_id: channel.channel_id(),
1764 user_channel_id: channel.get_user_id(),
1765 reason: closure_reason
1769 fn close_channel_internal(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey, target_feerate_sats_per_1000_weight: Option<u32>) -> Result<(), APIError> {
1770 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1772 let mut failed_htlcs: Vec<(HTLCSource, PaymentHash)>;
1773 let result: Result<(), _> = loop {
1774 let per_peer_state = self.per_peer_state.read().unwrap();
1776 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
1777 .ok_or_else(|| APIError::APIMisuseError{ err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
1779 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
1780 let peer_state = &mut *peer_state_lock;
1781 match peer_state.channel_by_id.entry(channel_id.clone()) {
1782 hash_map::Entry::Occupied(mut chan_entry) => {
1783 let (shutdown_msg, monitor_update, htlcs) = chan_entry.get_mut().get_shutdown(&self.signer_provider, &peer_state.latest_features, target_feerate_sats_per_1000_weight)?;
1784 failed_htlcs = htlcs;
1786 // Update the monitor with the shutdown script if necessary.
1787 if let Some(monitor_update) = monitor_update {
1788 let update_res = self.chain_monitor.update_channel(chan_entry.get().get_funding_txo().unwrap(), &monitor_update);
1789 let (result, is_permanent) =
1790 handle_monitor_update_res!(self, update_res, chan_entry.get_mut(), RAACommitmentOrder::CommitmentFirst, chan_entry.key(), NO_UPDATE);
1792 remove_channel!(self, chan_entry);
1797 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
1798 node_id: *counterparty_node_id,
1802 if chan_entry.get().is_shutdown() {
1803 let channel = remove_channel!(self, chan_entry);
1804 if let Ok(channel_update) = self.get_channel_update_for_broadcast(&channel) {
1805 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1809 self.issue_channel_close_events(&channel, ClosureReason::HolderForceClosed);
1813 hash_map::Entry::Vacant(_) => return Err(APIError::ChannelUnavailable{err: format!("Channel with id {} not found for the passed counterparty node_id {}", log_bytes!(*channel_id), counterparty_node_id) })
1817 for htlc_source in failed_htlcs.drain(..) {
1818 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
1819 let receiver = HTLCDestination::NextHopChannel { node_id: Some(*counterparty_node_id), channel_id: *channel_id };
1820 self.fail_htlc_backwards_internal(&htlc_source.0, &htlc_source.1, &reason, receiver);
1823 let _ = handle_error!(self, result, *counterparty_node_id);
1827 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
1828 /// will be accepted on the given channel, and after additional timeout/the closing of all
1829 /// pending HTLCs, the channel will be closed on chain.
1831 /// * If we are the channel initiator, we will pay between our [`Background`] and
1832 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
1834 /// * If our counterparty is the channel initiator, we will require a channel closing
1835 /// transaction feerate of at least our [`Background`] feerate or the feerate which
1836 /// would appear on a force-closure transaction, whichever is lower. We will allow our
1837 /// counterparty to pay as much fee as they'd like, however.
1839 /// May generate a SendShutdown message event on success, which should be relayed.
1841 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
1842 /// [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
1843 /// [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
1844 pub fn close_channel(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey) -> Result<(), APIError> {
1845 self.close_channel_internal(channel_id, counterparty_node_id, None)
1848 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
1849 /// will be accepted on the given channel, and after additional timeout/the closing of all
1850 /// pending HTLCs, the channel will be closed on chain.
1852 /// `target_feerate_sat_per_1000_weight` has different meanings depending on if we initiated
1853 /// the channel being closed or not:
1854 /// * If we are the channel initiator, we will pay at least this feerate on the closing
1855 /// transaction. The upper-bound is set by
1856 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
1857 /// estimate (or `target_feerate_sat_per_1000_weight`, if it is greater).
1858 /// * If our counterparty is the channel initiator, we will refuse to accept a channel closure
1859 /// transaction feerate below `target_feerate_sat_per_1000_weight` (or the feerate which
1860 /// will appear on a force-closure transaction, whichever is lower).
1862 /// May generate a SendShutdown message event on success, which should be relayed.
1864 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
1865 /// [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
1866 /// [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
1867 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> {
1868 self.close_channel_internal(channel_id, counterparty_node_id, Some(target_feerate_sats_per_1000_weight))
1872 fn finish_force_close_channel(&self, shutdown_res: ShutdownResult) {
1873 let (monitor_update_option, mut failed_htlcs) = shutdown_res;
1874 log_debug!(self.logger, "Finishing force-closure of channel with {} HTLCs to fail", failed_htlcs.len());
1875 for htlc_source in failed_htlcs.drain(..) {
1876 let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
1877 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
1878 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
1879 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
1881 if let Some((funding_txo, monitor_update)) = monitor_update_option {
1882 // There isn't anything we can do if we get an update failure - we're already
1883 // force-closing. The monitor update on the required in-memory copy should broadcast
1884 // the latest local state, which is the best we can do anyway. Thus, it is safe to
1885 // ignore the result here.
1886 let _ = self.chain_monitor.update_channel(funding_txo, &monitor_update);
1890 /// `peer_msg` should be set when we receive a message from a peer, but not set when the
1891 /// user closes, which will be re-exposed as the `ChannelClosed` reason.
1892 fn force_close_channel_with_peer(&self, channel_id: &[u8; 32], peer_node_id: &PublicKey, peer_msg: Option<&String>, broadcast: bool)
1893 -> Result<PublicKey, APIError> {
1894 let per_peer_state = self.per_peer_state.read().unwrap();
1895 let peer_state_mutex = per_peer_state.get(peer_node_id)
1896 .ok_or_else(|| APIError::APIMisuseError{ err: format!("Can't find a peer matching the passed counterparty node_id {}", peer_node_id) })?;
1898 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
1899 let peer_state = &mut *peer_state_lock;
1900 if let hash_map::Entry::Occupied(chan) = peer_state.channel_by_id.entry(channel_id.clone()) {
1901 if let Some(peer_msg) = peer_msg {
1902 self.issue_channel_close_events(chan.get(),ClosureReason::CounterpartyForceClosed { peer_msg: peer_msg.to_string() });
1904 self.issue_channel_close_events(chan.get(),ClosureReason::HolderForceClosed);
1906 remove_channel!(self, chan)
1908 return Err(APIError::ChannelUnavailable{ err: format!("Channel with id {} not found for the passed counterparty node_id {}", log_bytes!(*channel_id), peer_node_id) });
1911 log_error!(self.logger, "Force-closing channel {}", log_bytes!(channel_id[..]));
1912 self.finish_force_close_channel(chan.force_shutdown(broadcast));
1913 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
1914 let mut peer_state = peer_state_mutex.lock().unwrap();
1915 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1920 Ok(chan.get_counterparty_node_id())
1923 fn force_close_sending_error(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey, broadcast: bool) -> Result<(), APIError> {
1924 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1925 match self.force_close_channel_with_peer(channel_id, counterparty_node_id, None, broadcast) {
1926 Ok(counterparty_node_id) => {
1927 let per_peer_state = self.per_peer_state.read().unwrap();
1928 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
1929 let mut peer_state = peer_state_mutex.lock().unwrap();
1930 peer_state.pending_msg_events.push(
1931 events::MessageSendEvent::HandleError {
1932 node_id: counterparty_node_id,
1933 action: msgs::ErrorAction::SendErrorMessage {
1934 msg: msgs::ErrorMessage { channel_id: *channel_id, data: "Channel force-closed".to_owned() }
1945 /// Force closes a channel, immediately broadcasting the latest local transaction(s) and
1946 /// rejecting new HTLCs on the given channel. Fails if `channel_id` is unknown to
1947 /// the manager, or if the `counterparty_node_id` isn't the counterparty of the corresponding
1949 pub fn force_close_broadcasting_latest_txn(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey)
1950 -> Result<(), APIError> {
1951 self.force_close_sending_error(channel_id, counterparty_node_id, true)
1954 /// Force closes a channel, rejecting new HTLCs on the given channel but skips broadcasting
1955 /// the latest local transaction(s). Fails if `channel_id` is unknown to the manager, or if the
1956 /// `counterparty_node_id` isn't the counterparty of the corresponding channel.
1958 /// You can always get the latest local transaction(s) to broadcast from
1959 /// [`ChannelMonitor::get_latest_holder_commitment_txn`].
1960 pub fn force_close_without_broadcasting_txn(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey)
1961 -> Result<(), APIError> {
1962 self.force_close_sending_error(channel_id, counterparty_node_id, false)
1965 /// Force close all channels, immediately broadcasting the latest local commitment transaction
1966 /// for each to the chain and rejecting new HTLCs on each.
1967 pub fn force_close_all_channels_broadcasting_latest_txn(&self) {
1968 for chan in self.list_channels() {
1969 let _ = self.force_close_broadcasting_latest_txn(&chan.channel_id, &chan.counterparty.node_id);
1973 /// Force close all channels rejecting new HTLCs on each but without broadcasting the latest
1974 /// local transaction(s).
1975 pub fn force_close_all_channels_without_broadcasting_txn(&self) {
1976 for chan in self.list_channels() {
1977 let _ = self.force_close_without_broadcasting_txn(&chan.channel_id, &chan.counterparty.node_id);
1981 fn construct_recv_pending_htlc_info(&self, hop_data: msgs::OnionHopData, shared_secret: [u8; 32],
1982 payment_hash: PaymentHash, amt_msat: u64, cltv_expiry: u32, phantom_shared_secret: Option<[u8; 32]>) -> Result<PendingHTLCInfo, ReceiveError>
1984 // final_incorrect_cltv_expiry
1985 if hop_data.outgoing_cltv_value != cltv_expiry {
1986 return Err(ReceiveError {
1987 msg: "Upstream node set CLTV to the wrong value",
1989 err_data: cltv_expiry.to_be_bytes().to_vec()
1992 // final_expiry_too_soon
1993 // We have to have some headroom to broadcast on chain if we have the preimage, so make sure
1994 // we have at least HTLC_FAIL_BACK_BUFFER blocks to go.
1996 // Also, ensure that, in the case of an unknown preimage for the received payment hash, our
1997 // payment logic has enough time to fail the HTLC backward before our onchain logic triggers a
1998 // channel closure (see HTLC_FAIL_BACK_BUFFER rationale).
1999 let current_height: u32 = self.best_block.read().unwrap().height();
2000 if (hop_data.outgoing_cltv_value as u64) <= current_height as u64 + HTLC_FAIL_BACK_BUFFER as u64 + 1 {
2001 let mut err_data = Vec::with_capacity(12);
2002 err_data.extend_from_slice(&amt_msat.to_be_bytes());
2003 err_data.extend_from_slice(¤t_height.to_be_bytes());
2004 return Err(ReceiveError {
2005 err_code: 0x4000 | 15, err_data,
2006 msg: "The final CLTV expiry is too soon to handle",
2009 if hop_data.amt_to_forward > amt_msat {
2010 return Err(ReceiveError {
2012 err_data: amt_msat.to_be_bytes().to_vec(),
2013 msg: "Upstream node sent less than we were supposed to receive in payment",
2017 let routing = match hop_data.format {
2018 msgs::OnionHopDataFormat::NonFinalNode { .. } => {
2019 return Err(ReceiveError {
2020 err_code: 0x4000|22,
2021 err_data: Vec::new(),
2022 msg: "Got non final data with an HMAC of 0",
2025 msgs::OnionHopDataFormat::FinalNode { payment_data, keysend_preimage } => {
2026 if payment_data.is_some() && keysend_preimage.is_some() {
2027 return Err(ReceiveError {
2028 err_code: 0x4000|22,
2029 err_data: Vec::new(),
2030 msg: "We don't support MPP keysend payments",
2032 } else if let Some(data) = payment_data {
2033 PendingHTLCRouting::Receive {
2035 incoming_cltv_expiry: hop_data.outgoing_cltv_value,
2036 phantom_shared_secret,
2038 } else if let Some(payment_preimage) = keysend_preimage {
2039 // We need to check that the sender knows the keysend preimage before processing this
2040 // payment further. Otherwise, an intermediary routing hop forwarding non-keysend-HTLC X
2041 // could discover the final destination of X, by probing the adjacent nodes on the route
2042 // with a keysend payment of identical payment hash to X and observing the processing
2043 // time discrepancies due to a hash collision with X.
2044 let hashed_preimage = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
2045 if hashed_preimage != payment_hash {
2046 return Err(ReceiveError {
2047 err_code: 0x4000|22,
2048 err_data: Vec::new(),
2049 msg: "Payment preimage didn't match payment hash",
2053 PendingHTLCRouting::ReceiveKeysend {
2055 incoming_cltv_expiry: hop_data.outgoing_cltv_value,
2058 return Err(ReceiveError {
2059 err_code: 0x4000|0x2000|3,
2060 err_data: Vec::new(),
2061 msg: "We require payment_secrets",
2066 Ok(PendingHTLCInfo {
2069 incoming_shared_secret: shared_secret,
2070 incoming_amt_msat: Some(amt_msat),
2071 outgoing_amt_msat: amt_msat,
2072 outgoing_cltv_value: hop_data.outgoing_cltv_value,
2076 fn decode_update_add_htlc_onion(&self, msg: &msgs::UpdateAddHTLC) -> PendingHTLCStatus {
2077 macro_rules! return_malformed_err {
2078 ($msg: expr, $err_code: expr) => {
2080 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
2081 return PendingHTLCStatus::Fail(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
2082 channel_id: msg.channel_id,
2083 htlc_id: msg.htlc_id,
2084 sha256_of_onion: Sha256::hash(&msg.onion_routing_packet.hop_data).into_inner(),
2085 failure_code: $err_code,
2091 if let Err(_) = msg.onion_routing_packet.public_key {
2092 return_malformed_err!("invalid ephemeral pubkey", 0x8000 | 0x4000 | 6);
2095 let shared_secret = self.node_signer.ecdh(
2096 Recipient::Node, &msg.onion_routing_packet.public_key.unwrap(), None
2097 ).unwrap().secret_bytes();
2099 if msg.onion_routing_packet.version != 0 {
2100 //TODO: Spec doesn't indicate if we should only hash hop_data here (and in other
2101 //sha256_of_onion error data packets), or the entire onion_routing_packet. Either way,
2102 //the hash doesn't really serve any purpose - in the case of hashing all data, the
2103 //receiving node would have to brute force to figure out which version was put in the
2104 //packet by the node that send us the message, in the case of hashing the hop_data, the
2105 //node knows the HMAC matched, so they already know what is there...
2106 return_malformed_err!("Unknown onion packet version", 0x8000 | 0x4000 | 4);
2108 macro_rules! return_err {
2109 ($msg: expr, $err_code: expr, $data: expr) => {
2111 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
2112 return PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
2113 channel_id: msg.channel_id,
2114 htlc_id: msg.htlc_id,
2115 reason: HTLCFailReason::reason($err_code, $data.to_vec())
2116 .get_encrypted_failure_packet(&shared_secret, &None),
2122 let next_hop = match onion_utils::decode_next_payment_hop(shared_secret, &msg.onion_routing_packet.hop_data[..], msg.onion_routing_packet.hmac, msg.payment_hash) {
2124 Err(onion_utils::OnionDecodeErr::Malformed { err_msg, err_code }) => {
2125 return_malformed_err!(err_msg, err_code);
2127 Err(onion_utils::OnionDecodeErr::Relay { err_msg, err_code }) => {
2128 return_err!(err_msg, err_code, &[0; 0]);
2132 let pending_forward_info = match next_hop {
2133 onion_utils::Hop::Receive(next_hop_data) => {
2135 match self.construct_recv_pending_htlc_info(next_hop_data, shared_secret, msg.payment_hash, msg.amount_msat, msg.cltv_expiry, None) {
2137 // Note that we could obviously respond immediately with an update_fulfill_htlc
2138 // message, however that would leak that we are the recipient of this payment, so
2139 // instead we stay symmetric with the forwarding case, only responding (after a
2140 // delay) once they've send us a commitment_signed!
2141 PendingHTLCStatus::Forward(info)
2143 Err(ReceiveError { err_code, err_data, msg }) => return_err!(msg, err_code, &err_data)
2146 onion_utils::Hop::Forward { next_hop_data, next_hop_hmac, new_packet_bytes } => {
2147 let new_pubkey = msg.onion_routing_packet.public_key.unwrap();
2148 let outgoing_packet = msgs::OnionPacket {
2150 public_key: onion_utils::next_hop_packet_pubkey(&self.secp_ctx, new_pubkey, &shared_secret),
2151 hop_data: new_packet_bytes,
2152 hmac: next_hop_hmac.clone(),
2155 let short_channel_id = match next_hop_data.format {
2156 msgs::OnionHopDataFormat::NonFinalNode { short_channel_id } => short_channel_id,
2157 msgs::OnionHopDataFormat::FinalNode { .. } => {
2158 return_err!("Final Node OnionHopData provided for us as an intermediary node", 0x4000 | 22, &[0;0]);
2162 PendingHTLCStatus::Forward(PendingHTLCInfo {
2163 routing: PendingHTLCRouting::Forward {
2164 onion_packet: outgoing_packet,
2167 payment_hash: msg.payment_hash.clone(),
2168 incoming_shared_secret: shared_secret,
2169 incoming_amt_msat: Some(msg.amount_msat),
2170 outgoing_amt_msat: next_hop_data.amt_to_forward,
2171 outgoing_cltv_value: next_hop_data.outgoing_cltv_value,
2176 if let &PendingHTLCStatus::Forward(PendingHTLCInfo { ref routing, ref outgoing_amt_msat, ref outgoing_cltv_value, .. }) = &pending_forward_info {
2177 // If short_channel_id is 0 here, we'll reject the HTLC as there cannot be a channel
2178 // with a short_channel_id of 0. This is important as various things later assume
2179 // short_channel_id is non-0 in any ::Forward.
2180 if let &PendingHTLCRouting::Forward { ref short_channel_id, .. } = routing {
2181 if let Some((err, mut code, chan_update)) = loop {
2182 let id_option = self.short_to_chan_info.read().unwrap().get(short_channel_id).cloned();
2183 let forwarding_chan_info_opt = match id_option {
2184 None => { // unknown_next_peer
2185 // Note that this is likely a timing oracle for detecting whether an scid is a
2186 // phantom or an intercept.
2187 if (self.default_configuration.accept_intercept_htlcs &&
2188 fake_scid::is_valid_intercept(&self.fake_scid_rand_bytes, *short_channel_id, &self.genesis_hash)) ||
2189 fake_scid::is_valid_phantom(&self.fake_scid_rand_bytes, *short_channel_id, &self.genesis_hash)
2193 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
2196 Some((cp_id, id)) => Some((cp_id.clone(), id.clone())),
2198 let chan_update_opt = if let Some((counterparty_node_id, forwarding_id)) = forwarding_chan_info_opt {
2199 let per_peer_state = self.per_peer_state.read().unwrap();
2200 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
2201 if peer_state_mutex_opt.is_none() {
2202 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
2204 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
2205 let peer_state = &mut *peer_state_lock;
2206 let chan = match peer_state.channel_by_id.get_mut(&forwarding_id) {
2208 // Channel was removed. The short_to_chan_info and channel_by_id maps
2209 // have no consistency guarantees.
2210 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
2214 if !chan.should_announce() && !self.default_configuration.accept_forwards_to_priv_channels {
2215 // Note that the behavior here should be identical to the above block - we
2216 // should NOT reveal the existence or non-existence of a private channel if
2217 // we don't allow forwards outbound over them.
2218 break Some(("Refusing to forward to a private channel based on our config.", 0x4000 | 10, None));
2220 if chan.get_channel_type().supports_scid_privacy() && *short_channel_id != chan.outbound_scid_alias() {
2221 // `option_scid_alias` (referred to in LDK as `scid_privacy`) means
2222 // "refuse to forward unless the SCID alias was used", so we pretend
2223 // we don't have the channel here.
2224 break Some(("Refusing to forward over real channel SCID as our counterparty requested.", 0x4000 | 10, None));
2226 let chan_update_opt = self.get_channel_update_for_onion(*short_channel_id, chan).ok();
2228 // Note that we could technically not return an error yet here and just hope
2229 // that the connection is reestablished or monitor updated by the time we get
2230 // around to doing the actual forward, but better to fail early if we can and
2231 // hopefully an attacker trying to path-trace payments cannot make this occur
2232 // on a small/per-node/per-channel scale.
2233 if !chan.is_live() { // channel_disabled
2234 break Some(("Forwarding channel is not in a ready state.", 0x1000 | 20, chan_update_opt));
2236 if *outgoing_amt_msat < chan.get_counterparty_htlc_minimum_msat() { // amount_below_minimum
2237 break Some(("HTLC amount was below the htlc_minimum_msat", 0x1000 | 11, chan_update_opt));
2239 if let Err((err, code)) = chan.htlc_satisfies_config(&msg, *outgoing_amt_msat, *outgoing_cltv_value) {
2240 break Some((err, code, chan_update_opt));
2244 if (msg.cltv_expiry as u64) < (*outgoing_cltv_value) as u64 + MIN_CLTV_EXPIRY_DELTA as u64 {
2245 // We really should set `incorrect_cltv_expiry` here but as we're not
2246 // forwarding over a real channel we can't generate a channel_update
2247 // for it. Instead we just return a generic temporary_node_failure.
2249 "Forwarding node has tampered with the intended HTLC values or origin node has an obsolete cltv_expiry_delta",
2256 let cur_height = self.best_block.read().unwrap().height() + 1;
2257 // Theoretically, channel counterparty shouldn't send us a HTLC expiring now,
2258 // but we want to be robust wrt to counterparty packet sanitization (see
2259 // HTLC_FAIL_BACK_BUFFER rationale).
2260 if msg.cltv_expiry <= cur_height + HTLC_FAIL_BACK_BUFFER as u32 { // expiry_too_soon
2261 break Some(("CLTV expiry is too close", 0x1000 | 14, chan_update_opt));
2263 if msg.cltv_expiry > cur_height + CLTV_FAR_FAR_AWAY as u32 { // expiry_too_far
2264 break Some(("CLTV expiry is too far in the future", 21, None));
2266 // If the HTLC expires ~now, don't bother trying to forward it to our
2267 // counterparty. They should fail it anyway, but we don't want to bother with
2268 // the round-trips or risk them deciding they definitely want the HTLC and
2269 // force-closing to ensure they get it if we're offline.
2270 // We previously had a much more aggressive check here which tried to ensure
2271 // our counterparty receives an HTLC which has *our* risk threshold met on it,
2272 // but there is no need to do that, and since we're a bit conservative with our
2273 // risk threshold it just results in failing to forward payments.
2274 if (*outgoing_cltv_value) as u64 <= (cur_height + LATENCY_GRACE_PERIOD_BLOCKS) as u64 {
2275 break Some(("Outgoing CLTV value is too soon", 0x1000 | 14, chan_update_opt));
2281 let mut res = VecWriter(Vec::with_capacity(chan_update.serialized_length() + 2 + 8 + 2));
2282 if let Some(chan_update) = chan_update {
2283 if code == 0x1000 | 11 || code == 0x1000 | 12 {
2284 msg.amount_msat.write(&mut res).expect("Writes cannot fail");
2286 else if code == 0x1000 | 13 {
2287 msg.cltv_expiry.write(&mut res).expect("Writes cannot fail");
2289 else if code == 0x1000 | 20 {
2290 // TODO: underspecified, follow https://github.com/lightning/bolts/issues/791
2291 0u16.write(&mut res).expect("Writes cannot fail");
2293 (chan_update.serialized_length() as u16 + 2).write(&mut res).expect("Writes cannot fail");
2294 msgs::ChannelUpdate::TYPE.write(&mut res).expect("Writes cannot fail");
2295 chan_update.write(&mut res).expect("Writes cannot fail");
2296 } else if code & 0x1000 == 0x1000 {
2297 // If we're trying to return an error that requires a `channel_update` but
2298 // we're forwarding to a phantom or intercept "channel" (i.e. cannot
2299 // generate an update), just use the generic "temporary_node_failure"
2303 return_err!(err, code, &res.0[..]);
2308 pending_forward_info
2311 /// Gets the current channel_update for the given channel. This first checks if the channel is
2312 /// public, and thus should be called whenever the result is going to be passed out in a
2313 /// [`MessageSendEvent::BroadcastChannelUpdate`] event.
2315 /// Note that in `internal_closing_signed`, this function is called without the `peer_state`
2316 /// corresponding to the channel's counterparty locked, as the channel been removed from the
2317 /// storage and the `peer_state` lock has been dropped.
2318 fn get_channel_update_for_broadcast(&self, chan: &Channel<<SP::Target as SignerProvider>::Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
2319 if !chan.should_announce() {
2320 return Err(LightningError {
2321 err: "Cannot broadcast a channel_update for a private channel".to_owned(),
2322 action: msgs::ErrorAction::IgnoreError
2325 if chan.get_short_channel_id().is_none() {
2326 return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError});
2328 log_trace!(self.logger, "Attempting to generate broadcast channel update for channel {}", log_bytes!(chan.channel_id()));
2329 self.get_channel_update_for_unicast(chan)
2332 /// Gets the current channel_update for the given channel. This does not check if the channel
2333 /// is public (only returning an Err if the channel does not yet have an assigned short_id),
2334 /// and thus MUST NOT be called unless the recipient of the resulting message has already
2335 /// provided evidence that they know about the existence of the channel.
2337 /// Note that through `internal_closing_signed`, this function is called without the
2338 /// `peer_state` corresponding to the channel's counterparty locked, as the channel been
2339 /// removed from the storage and the `peer_state` lock has been dropped.
2340 fn get_channel_update_for_unicast(&self, chan: &Channel<<SP::Target as SignerProvider>::Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
2341 log_trace!(self.logger, "Attempting to generate channel update for channel {}", log_bytes!(chan.channel_id()));
2342 let short_channel_id = match chan.get_short_channel_id().or(chan.latest_inbound_scid_alias()) {
2343 None => return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError}),
2347 self.get_channel_update_for_onion(short_channel_id, chan)
2349 fn get_channel_update_for_onion(&self, short_channel_id: u64, chan: &Channel<<SP::Target as SignerProvider>::Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
2350 log_trace!(self.logger, "Generating channel update for channel {}", log_bytes!(chan.channel_id()));
2351 let were_node_one = self.our_network_pubkey.serialize()[..] < chan.get_counterparty_node_id().serialize()[..];
2353 let unsigned = msgs::UnsignedChannelUpdate {
2354 chain_hash: self.genesis_hash,
2356 timestamp: chan.get_update_time_counter(),
2357 flags: (!were_node_one) as u8 | ((!chan.is_live() as u8) << 1),
2358 cltv_expiry_delta: chan.get_cltv_expiry_delta(),
2359 htlc_minimum_msat: chan.get_counterparty_htlc_minimum_msat(),
2360 htlc_maximum_msat: chan.get_announced_htlc_max_msat(),
2361 fee_base_msat: chan.get_outbound_forwarding_fee_base_msat(),
2362 fee_proportional_millionths: chan.get_fee_proportional_millionths(),
2363 excess_data: Vec::new(),
2365 // Panic on failure to signal LDK should be restarted to retry signing the `ChannelUpdate`.
2366 // If we returned an error and the `node_signer` cannot provide a signature for whatever
2367 // reason`, we wouldn't be able to receive inbound payments through the corresponding
2369 let sig = self.node_signer.sign_gossip_message(msgs::UnsignedGossipMessage::ChannelUpdate(&unsigned)).unwrap();
2371 Ok(msgs::ChannelUpdate {
2377 // Only public for testing, this should otherwise never be called direcly
2378 pub(crate) fn send_payment_along_path(&self, path: &Vec<RouteHop>, payment_params: &Option<PaymentParameters>, payment_hash: &PaymentHash, payment_secret: &Option<PaymentSecret>, total_value: u64, cur_height: u32, payment_id: PaymentId, keysend_preimage: &Option<PaymentPreimage>, session_priv_bytes: [u8; 32]) -> Result<(), APIError> {
2379 log_trace!(self.logger, "Attempting to send payment for path with next hop {}", path.first().unwrap().short_channel_id);
2380 let prng_seed = self.entropy_source.get_secure_random_bytes();
2381 let session_priv = SecretKey::from_slice(&session_priv_bytes[..]).expect("RNG is busted");
2383 let onion_keys = onion_utils::construct_onion_keys(&self.secp_ctx, &path, &session_priv)
2384 .map_err(|_| APIError::InvalidRoute{err: "Pubkey along hop was maliciously selected"})?;
2385 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(path, total_value, payment_secret, cur_height, keysend_preimage)?;
2386 if onion_utils::route_size_insane(&onion_payloads) {
2387 return Err(APIError::InvalidRoute{err: "Route size too large considering onion data"});
2389 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, prng_seed, payment_hash);
2391 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2393 let err: Result<(), _> = loop {
2394 let (counterparty_node_id, id) = match self.short_to_chan_info.read().unwrap().get(&path.first().unwrap().short_channel_id) {
2395 None => return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()}),
2396 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
2399 let per_peer_state = self.per_peer_state.read().unwrap();
2400 let peer_state_mutex = per_peer_state.get(&counterparty_node_id)
2401 .ok_or_else(|| APIError::InvalidRoute{err: "No peer matching the path's first hop found!" })?;
2402 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2403 let peer_state = &mut *peer_state_lock;
2404 if let hash_map::Entry::Occupied(mut chan) = peer_state.channel_by_id.entry(id) {
2406 if !chan.get().is_live() {
2407 return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected/pending monitor update!".to_owned()});
2409 break_chan_entry!(self, chan.get_mut().send_htlc_and_commit(
2410 htlc_msat, payment_hash.clone(), htlc_cltv, HTLCSource::OutboundRoute {
2412 session_priv: session_priv.clone(),
2413 first_hop_htlc_msat: htlc_msat,
2415 payment_secret: payment_secret.clone(),
2416 payment_params: payment_params.clone(),
2417 }, onion_packet, &self.logger),
2420 Some((update_add, commitment_signed, monitor_update)) => {
2421 let update_err = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), &monitor_update);
2422 let chan_id = chan.get().channel_id();
2424 handle_monitor_update_res!(self, update_err, chan,
2425 RAACommitmentOrder::CommitmentFirst, false, true))
2427 (ChannelMonitorUpdateStatus::PermanentFailure, Err(e)) => break Err(e),
2428 (ChannelMonitorUpdateStatus::Completed, Ok(())) => {},
2429 (ChannelMonitorUpdateStatus::InProgress, Err(_)) => {
2430 // Note that MonitorUpdateInProgress here indicates (per function
2431 // docs) that we will resend the commitment update once monitor
2432 // updating completes. Therefore, we must return an error
2433 // indicating that it is unsafe to retry the payment wholesale,
2434 // which we do in the send_payment check for
2435 // MonitorUpdateInProgress, below.
2436 return Err(APIError::MonitorUpdateInProgress);
2438 _ => unreachable!(),
2441 log_debug!(self.logger, "Sending payment along path resulted in a commitment_signed for channel {}", log_bytes!(chan_id));
2442 peer_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2443 node_id: path.first().unwrap().pubkey,
2444 updates: msgs::CommitmentUpdate {
2445 update_add_htlcs: vec![update_add],
2446 update_fulfill_htlcs: Vec::new(),
2447 update_fail_htlcs: Vec::new(),
2448 update_fail_malformed_htlcs: Vec::new(),
2457 // The channel was likely removed after we fetched the id from the
2458 // `short_to_chan_info` map, but before we successfully locked the
2459 // `channel_by_id` map.
2460 // This can occur as no consistency guarantees exists between the two maps.
2461 return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()});
2466 match handle_error!(self, err, path.first().unwrap().pubkey) {
2467 Ok(_) => unreachable!(),
2469 Err(APIError::ChannelUnavailable { err: e.err })
2474 /// Sends a payment along a given route.
2476 /// Value parameters are provided via the last hop in route, see documentation for [`RouteHop`]
2477 /// fields for more info.
2479 /// May generate SendHTLCs message(s) event on success, which should be relayed (e.g. via
2480 /// [`PeerManager::process_events`]).
2482 /// # Avoiding Duplicate Payments
2484 /// If a pending payment is currently in-flight with the same [`PaymentId`] provided, this
2485 /// method will error with an [`APIError::InvalidRoute`]. Note, however, that once a payment
2486 /// is no longer pending (either via [`ChannelManager::abandon_payment`], or handling of an
2487 /// [`Event::PaymentSent`]) LDK will not stop you from sending a second payment with the same
2490 /// Thus, in order to ensure duplicate payments are not sent, you should implement your own
2491 /// tracking of payments, including state to indicate once a payment has completed. Because you
2492 /// should also ensure that [`PaymentHash`]es are not re-used, for simplicity, you should
2493 /// consider using the [`PaymentHash`] as the key for tracking payments. In that case, the
2494 /// [`PaymentId`] should be a copy of the [`PaymentHash`] bytes.
2496 /// Additionally, in the scenario where we begin the process of sending a payment, but crash
2497 /// before `send_payment` returns (or prior to [`ChannelMonitorUpdate`] persistence if you're
2498 /// using [`ChannelMonitorUpdateStatus::InProgress`]), the payment may be lost on restart. See
2499 /// [`ChannelManager::list_recent_payments`] for more information.
2501 /// # Possible Error States on [`PaymentSendFailure`]
2503 /// Each path may have a different return value, and PaymentSendValue may return a Vec with
2504 /// each entry matching the corresponding-index entry in the route paths, see
2505 /// [`PaymentSendFailure`] for more info.
2507 /// In general, a path may raise:
2508 /// * [`APIError::InvalidRoute`] when an invalid route or forwarding parameter (cltv_delta, fee,
2509 /// node public key) is specified.
2510 /// * [`APIError::ChannelUnavailable`] if the next-hop channel is not available for updates
2511 /// (including due to previous monitor update failure or new permanent monitor update
2513 /// * [`APIError::MonitorUpdateInProgress`] if a new monitor update failure prevented sending the
2514 /// relevant updates.
2516 /// Note that depending on the type of the PaymentSendFailure the HTLC may have been
2517 /// irrevocably committed to on our end. In such a case, do NOT retry the payment with a
2518 /// different route unless you intend to pay twice!
2520 /// # A caution on `payment_secret`
2522 /// `payment_secret` is unrelated to `payment_hash` (or [`PaymentPreimage`]) and exists to
2523 /// authenticate the sender to the recipient and prevent payment-probing (deanonymization)
2524 /// attacks. For newer nodes, it will be provided to you in the invoice. If you do not have one,
2525 /// the [`Route`] must not contain multiple paths as multi-path payments require a
2526 /// recipient-provided `payment_secret`.
2528 /// If a `payment_secret` *is* provided, we assume that the invoice had the payment_secret
2529 /// feature bit set (either as required or as available). If multiple paths are present in the
2530 /// [`Route`], we assume the invoice had the basic_mpp feature set.
2532 /// [`Event::PaymentSent`]: events::Event::PaymentSent
2533 /// [`PeerManager::process_events`]: crate::ln::peer_handler::PeerManager::process_events
2534 /// [`ChannelMonitorUpdateStatus::InProgress`]: crate::chain::ChannelMonitorUpdateStatus::InProgress
2535 pub fn send_payment(&self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>, payment_id: PaymentId) -> Result<(), PaymentSendFailure> {
2536 let best_block_height = self.best_block.read().unwrap().height();
2537 self.pending_outbound_payments
2538 .send_payment_with_route(route, payment_hash, payment_secret, payment_id, &self.entropy_source, &self.node_signer, best_block_height,
2539 |path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv|
2540 self.send_payment_along_path(path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv))
2543 /// Similar to [`ChannelManager::send_payment`], but will automatically find a route based on
2544 /// `route_params` and retry failed payment paths based on `retry_strategy`.
2545 pub fn send_payment_with_retry(&self, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>, payment_id: PaymentId, route_params: RouteParameters, retry_strategy: Retry) -> Result<(), PaymentSendFailure> {
2546 let best_block_height = self.best_block.read().unwrap().height();
2547 self.pending_outbound_payments
2548 .send_payment(payment_hash, payment_secret, payment_id, retry_strategy, route_params,
2549 &self.router, self.list_usable_channels(), self.compute_inflight_htlcs(),
2550 &self.entropy_source, &self.node_signer, best_block_height, &self.logger,
2551 |path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv|
2552 self.send_payment_along_path(path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv))
2556 fn test_send_payment_internal(&self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>, keysend_preimage: Option<PaymentPreimage>, payment_id: PaymentId, recv_value_msat: Option<u64>, onion_session_privs: Vec<[u8; 32]>) -> Result<(), PaymentSendFailure> {
2557 let best_block_height = self.best_block.read().unwrap().height();
2558 self.pending_outbound_payments.test_send_payment_internal(route, payment_hash, payment_secret, keysend_preimage, payment_id, recv_value_msat, onion_session_privs, &self.node_signer, best_block_height,
2559 |path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv|
2560 self.send_payment_along_path(path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv))
2564 pub(crate) fn test_add_new_pending_payment(&self, payment_hash: PaymentHash, payment_secret: Option<PaymentSecret>, payment_id: PaymentId, route: &Route) -> Result<Vec<[u8; 32]>, PaymentSendFailure> {
2565 let best_block_height = self.best_block.read().unwrap().height();
2566 self.pending_outbound_payments.test_add_new_pending_payment(payment_hash, payment_secret, payment_id, route, None, &self.entropy_source, best_block_height)
2570 /// Retries a payment along the given [`Route`].
2572 /// Errors returned are a superset of those returned from [`send_payment`], so see
2573 /// [`send_payment`] documentation for more details on errors. This method will also error if the
2574 /// retry amount puts the payment more than 10% over the payment's total amount, if the payment
2575 /// for the given `payment_id` cannot be found (likely due to timeout or success), or if
2576 /// further retries have been disabled with [`abandon_payment`].
2578 /// [`send_payment`]: [`ChannelManager::send_payment`]
2579 /// [`abandon_payment`]: [`ChannelManager::abandon_payment`]
2580 pub fn retry_payment(&self, route: &Route, payment_id: PaymentId) -> Result<(), PaymentSendFailure> {
2581 let best_block_height = self.best_block.read().unwrap().height();
2582 self.pending_outbound_payments.retry_payment_with_route(route, payment_id, &self.entropy_source, &self.node_signer, best_block_height,
2583 |path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv|
2584 self.send_payment_along_path(path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv))
2587 /// Signals that no further retries for the given payment will occur.
2589 /// After this method returns, no future calls to [`retry_payment`] for the given `payment_id`
2590 /// are allowed. If no [`Event::PaymentFailed`] event had been generated before, one will be
2591 /// generated as soon as there are no remaining pending HTLCs for this payment.
2593 /// Note that calling this method does *not* prevent a payment from succeeding. You must still
2594 /// wait until you receive either a [`Event::PaymentFailed`] or [`Event::PaymentSent`] event to
2595 /// determine the ultimate status of a payment.
2597 /// If an [`Event::PaymentFailed`] event is generated and we restart without this
2598 /// [`ChannelManager`] having been persisted, the payment may still be in the pending state
2599 /// upon restart. This allows further calls to [`retry_payment`] (and requiring a second call
2600 /// to [`abandon_payment`] to mark the payment as failed again). Otherwise, future calls to
2601 /// [`retry_payment`] will fail with [`PaymentSendFailure::ParameterError`].
2603 /// [`abandon_payment`]: Self::abandon_payment
2604 /// [`retry_payment`]: Self::retry_payment
2605 /// [`Event::PaymentFailed`]: events::Event::PaymentFailed
2606 /// [`Event::PaymentSent`]: events::Event::PaymentSent
2607 pub fn abandon_payment(&self, payment_id: PaymentId) {
2608 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2609 if let Some(payment_failed_ev) = self.pending_outbound_payments.abandon_payment(payment_id) {
2610 self.pending_events.lock().unwrap().push(payment_failed_ev);
2614 /// Send a spontaneous payment, which is a payment that does not require the recipient to have
2615 /// generated an invoice. Optionally, you may specify the preimage. If you do choose to specify
2616 /// the preimage, it must be a cryptographically secure random value that no intermediate node
2617 /// would be able to guess -- otherwise, an intermediate node may claim the payment and it will
2618 /// never reach the recipient.
2620 /// See [`send_payment`] documentation for more details on the return value of this function
2621 /// and idempotency guarantees provided by the [`PaymentId`] key.
2623 /// Similar to regular payments, you MUST NOT reuse a `payment_preimage` value. See
2624 /// [`send_payment`] for more information about the risks of duplicate preimage usage.
2626 /// Note that `route` must have exactly one path.
2628 /// [`send_payment`]: Self::send_payment
2629 pub fn send_spontaneous_payment(&self, route: &Route, payment_preimage: Option<PaymentPreimage>, payment_id: PaymentId) -> Result<PaymentHash, PaymentSendFailure> {
2630 let best_block_height = self.best_block.read().unwrap().height();
2631 self.pending_outbound_payments.send_spontaneous_payment_with_route(
2632 route, payment_preimage, payment_id, &self.entropy_source, &self.node_signer,
2634 |path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv|
2635 self.send_payment_along_path(path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv))
2638 /// Similar to [`ChannelManager::send_spontaneous_payment`], but will automatically find a route
2639 /// based on `route_params` and retry failed payment paths based on `retry_strategy`.
2640 pub fn send_spontaneous_payment_with_retry(&self, payment_preimage: Option<PaymentPreimage>, payment_id: PaymentId, route_params: RouteParameters, retry_strategy: Retry) -> Result<PaymentHash, PaymentSendFailure> {
2641 let best_block_height = self.best_block.read().unwrap().height();
2642 self.pending_outbound_payments.send_spontaneous_payment(payment_preimage, payment_id,
2643 retry_strategy, route_params, &self.router, self.list_usable_channels(),
2644 self.compute_inflight_htlcs(), &self.entropy_source, &self.node_signer, best_block_height,
2646 |path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv|
2647 self.send_payment_along_path(path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv))
2650 /// Send a payment that is probing the given route for liquidity. We calculate the
2651 /// [`PaymentHash`] of probes based on a static secret and a random [`PaymentId`], which allows
2652 /// us to easily discern them from real payments.
2653 pub fn send_probe(&self, hops: Vec<RouteHop>) -> Result<(PaymentHash, PaymentId), PaymentSendFailure> {
2654 let best_block_height = self.best_block.read().unwrap().height();
2655 self.pending_outbound_payments.send_probe(hops, self.probing_cookie_secret, &self.entropy_source, &self.node_signer, best_block_height,
2656 |path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv|
2657 self.send_payment_along_path(path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv))
2660 /// Returns whether a payment with the given [`PaymentHash`] and [`PaymentId`] is, in fact, a
2663 pub(crate) fn payment_is_probe(&self, payment_hash: &PaymentHash, payment_id: &PaymentId) -> bool {
2664 outbound_payment::payment_is_probe(payment_hash, payment_id, self.probing_cookie_secret)
2667 /// Handles the generation of a funding transaction, optionally (for tests) with a function
2668 /// which checks the correctness of the funding transaction given the associated channel.
2669 fn funding_transaction_generated_intern<FundingOutput: Fn(&Channel<<SP::Target as SignerProvider>::Signer>, &Transaction) -> Result<OutPoint, APIError>>(
2670 &self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, funding_transaction: Transaction, find_funding_output: FundingOutput
2671 ) -> Result<(), APIError> {
2672 let per_peer_state = self.per_peer_state.read().unwrap();
2673 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
2674 .ok_or_else(|| APIError::ChannelUnavailable{ err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
2676 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2677 let peer_state = &mut *peer_state_lock;
2680 match peer_state.channel_by_id.remove(temporary_channel_id) {
2682 let funding_txo = find_funding_output(&chan, &funding_transaction)?;
2684 (chan.get_outbound_funding_created(funding_transaction, funding_txo, &self.logger)
2685 .map_err(|e| if let ChannelError::Close(msg) = e {
2686 MsgHandleErrInternal::from_finish_shutdown(msg, chan.channel_id(), chan.get_user_id(), chan.force_shutdown(true), None)
2687 } else { unreachable!(); })
2690 None => { return Err(APIError::ChannelUnavailable { err: format!("Channel with id {} not found for the passed counterparty node_id {}", log_bytes!(*temporary_channel_id), counterparty_node_id) }) },
2693 match handle_error!(self, res, chan.get_counterparty_node_id()) {
2694 Ok(funding_msg) => {
2697 Err(_) => { return Err(APIError::ChannelUnavailable {
2698 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()
2703 peer_state.pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
2704 node_id: chan.get_counterparty_node_id(),
2707 match peer_state.channel_by_id.entry(chan.channel_id()) {
2708 hash_map::Entry::Occupied(_) => {
2709 panic!("Generated duplicate funding txid?");
2711 hash_map::Entry::Vacant(e) => {
2712 let mut id_to_peer = self.id_to_peer.lock().unwrap();
2713 if id_to_peer.insert(chan.channel_id(), chan.get_counterparty_node_id()).is_some() {
2714 panic!("id_to_peer map already contained funding txid, which shouldn't be possible");
2723 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> {
2724 self.funding_transaction_generated_intern(temporary_channel_id, counterparty_node_id, funding_transaction, |_, tx| {
2725 Ok(OutPoint { txid: tx.txid(), index: output_index })
2729 /// Call this upon creation of a funding transaction for the given channel.
2731 /// Returns an [`APIError::APIMisuseError`] if the funding_transaction spent non-SegWit outputs
2732 /// or if no output was found which matches the parameters in [`Event::FundingGenerationReady`].
2734 /// Returns [`APIError::APIMisuseError`] if the funding transaction is not final for propagation
2735 /// across the p2p network.
2737 /// Returns [`APIError::ChannelUnavailable`] if a funding transaction has already been provided
2738 /// for the channel or if the channel has been closed as indicated by [`Event::ChannelClosed`].
2740 /// May panic if the output found in the funding transaction is duplicative with some other
2741 /// channel (note that this should be trivially prevented by using unique funding transaction
2742 /// keys per-channel).
2744 /// Do NOT broadcast the funding transaction yourself. When we have safely received our
2745 /// counterparty's signature the funding transaction will automatically be broadcast via the
2746 /// [`BroadcasterInterface`] provided when this `ChannelManager` was constructed.
2748 /// Note that this includes RBF or similar transaction replacement strategies - lightning does
2749 /// not currently support replacing a funding transaction on an existing channel. Instead,
2750 /// create a new channel with a conflicting funding transaction.
2752 /// Note to keep the miner incentives aligned in moving the blockchain forward, we recommend
2753 /// the wallet software generating the funding transaction to apply anti-fee sniping as
2754 /// implemented by Bitcoin Core wallet. See <https://bitcoinops.org/en/topics/fee-sniping/>
2755 /// for more details.
2757 /// [`Event::FundingGenerationReady`]: crate::util::events::Event::FundingGenerationReady
2758 /// [`Event::ChannelClosed`]: crate::util::events::Event::ChannelClosed
2759 pub fn funding_transaction_generated(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, funding_transaction: Transaction) -> Result<(), APIError> {
2760 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2762 for inp in funding_transaction.input.iter() {
2763 if inp.witness.is_empty() {
2764 return Err(APIError::APIMisuseError {
2765 err: "Funding transaction must be fully signed and spend Segwit outputs".to_owned()
2770 let height = self.best_block.read().unwrap().height();
2771 // Transactions are evaluated as final by network mempools at the next block. However, the modules
2772 // constituting our Lightning node might not have perfect sync about their blockchain views. Thus, if
2773 // the wallet module is in advance on the LDK view, allow one more block of headroom.
2774 if !funding_transaction.input.iter().all(|input| input.sequence == Sequence::MAX) && LockTime::from(funding_transaction.lock_time).is_block_height() && funding_transaction.lock_time.0 > height + 2 {
2775 return Err(APIError::APIMisuseError {
2776 err: "Funding transaction absolute timelock is non-final".to_owned()
2780 self.funding_transaction_generated_intern(temporary_channel_id, counterparty_node_id, funding_transaction, |chan, tx| {
2781 let mut output_index = None;
2782 let expected_spk = chan.get_funding_redeemscript().to_v0_p2wsh();
2783 for (idx, outp) in tx.output.iter().enumerate() {
2784 if outp.script_pubkey == expected_spk && outp.value == chan.get_value_satoshis() {
2785 if output_index.is_some() {
2786 return Err(APIError::APIMisuseError {
2787 err: "Multiple outputs matched the expected script and value".to_owned()
2790 if idx > u16::max_value() as usize {
2791 return Err(APIError::APIMisuseError {
2792 err: "Transaction had more than 2^16 outputs, which is not supported".to_owned()
2795 output_index = Some(idx as u16);
2798 if output_index.is_none() {
2799 return Err(APIError::APIMisuseError {
2800 err: "No output matched the script_pubkey and value in the FundingGenerationReady event".to_owned()
2803 Ok(OutPoint { txid: tx.txid(), index: output_index.unwrap() })
2807 /// Atomically updates the [`ChannelConfig`] for the given channels.
2809 /// Once the updates are applied, each eligible channel (advertised with a known short channel
2810 /// ID and a change in [`forwarding_fee_proportional_millionths`], [`forwarding_fee_base_msat`],
2811 /// or [`cltv_expiry_delta`]) has a [`BroadcastChannelUpdate`] event message generated
2812 /// containing the new [`ChannelUpdate`] message which should be broadcast to the network.
2814 /// Returns [`ChannelUnavailable`] when a channel is not found or an incorrect
2815 /// `counterparty_node_id` is provided.
2817 /// Returns [`APIMisuseError`] when a [`cltv_expiry_delta`] update is to be applied with a value
2818 /// below [`MIN_CLTV_EXPIRY_DELTA`].
2820 /// If an error is returned, none of the updates should be considered applied.
2822 /// [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
2823 /// [`forwarding_fee_base_msat`]: ChannelConfig::forwarding_fee_base_msat
2824 /// [`cltv_expiry_delta`]: ChannelConfig::cltv_expiry_delta
2825 /// [`BroadcastChannelUpdate`]: events::MessageSendEvent::BroadcastChannelUpdate
2826 /// [`ChannelUpdate`]: msgs::ChannelUpdate
2827 /// [`ChannelUnavailable`]: APIError::ChannelUnavailable
2828 /// [`APIMisuseError`]: APIError::APIMisuseError
2829 pub fn update_channel_config(
2830 &self, counterparty_node_id: &PublicKey, channel_ids: &[[u8; 32]], config: &ChannelConfig,
2831 ) -> Result<(), APIError> {
2832 if config.cltv_expiry_delta < MIN_CLTV_EXPIRY_DELTA {
2833 return Err(APIError::APIMisuseError {
2834 err: format!("The chosen CLTV expiry delta is below the minimum of {}", MIN_CLTV_EXPIRY_DELTA),
2838 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(
2839 &self.total_consistency_lock, &self.persistence_notifier,
2841 let per_peer_state = self.per_peer_state.read().unwrap();
2842 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
2843 .ok_or_else(|| APIError::APIMisuseError{ err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
2844 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2845 let peer_state = &mut *peer_state_lock;
2846 for channel_id in channel_ids {
2847 if !peer_state.channel_by_id.contains_key(channel_id) {
2848 return Err(APIError::ChannelUnavailable {
2849 err: format!("Channel with ID {} was not found for the passed counterparty_node_id {}", log_bytes!(*channel_id), counterparty_node_id),
2853 for channel_id in channel_ids {
2854 let channel = peer_state.channel_by_id.get_mut(channel_id).unwrap();
2855 if !channel.update_config(config) {
2858 if let Ok(msg) = self.get_channel_update_for_broadcast(channel) {
2859 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate { msg });
2860 } else if let Ok(msg) = self.get_channel_update_for_unicast(channel) {
2861 peer_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
2862 node_id: channel.get_counterparty_node_id(),
2870 /// Attempts to forward an intercepted HTLC over the provided channel id and with the provided
2871 /// amount to forward. Should only be called in response to an [`HTLCIntercepted`] event.
2873 /// Intercepted HTLCs can be useful for Lightning Service Providers (LSPs) to open a just-in-time
2874 /// channel to a receiving node if the node lacks sufficient inbound liquidity.
2876 /// To make use of intercepted HTLCs, set [`UserConfig::accept_intercept_htlcs`] and use
2877 /// [`ChannelManager::get_intercept_scid`] to generate short channel id(s) to put in the
2878 /// receiver's invoice route hints. These route hints will signal to LDK to generate an
2879 /// [`HTLCIntercepted`] event when it receives the forwarded HTLC, and this method or
2880 /// [`ChannelManager::fail_intercepted_htlc`] MUST be called in response to the event.
2882 /// Note that LDK does not enforce fee requirements in `amt_to_forward_msat`, and will not stop
2883 /// you from forwarding more than you received.
2885 /// Errors if the event was not handled in time, in which case the HTLC was automatically failed
2888 /// [`UserConfig::accept_intercept_htlcs`]: crate::util::config::UserConfig::accept_intercept_htlcs
2889 /// [`HTLCIntercepted`]: events::Event::HTLCIntercepted
2890 // TODO: when we move to deciding the best outbound channel at forward time, only take
2891 // `next_node_id` and not `next_hop_channel_id`
2892 pub fn forward_intercepted_htlc(&self, intercept_id: InterceptId, next_hop_channel_id: &[u8; 32], next_node_id: PublicKey, amt_to_forward_msat: u64) -> Result<(), APIError> {
2893 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2895 let next_hop_scid = {
2896 let peer_state_lock = self.per_peer_state.read().unwrap();
2897 let peer_state_mutex = peer_state_lock.get(&next_node_id)
2898 .ok_or_else(|| APIError::APIMisuseError{ err: format!("Can't find a peer matching the passed counterparty node_id {}", next_node_id) })?;
2899 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
2900 let peer_state = &mut *peer_state_lock;
2901 match peer_state.channel_by_id.get(next_hop_channel_id) {
2903 if !chan.is_usable() {
2904 return Err(APIError::ChannelUnavailable {
2905 err: format!("Channel with id {} not fully established", log_bytes!(*next_hop_channel_id))
2908 chan.get_short_channel_id().unwrap_or(chan.outbound_scid_alias())
2910 None => return Err(APIError::ChannelUnavailable {
2911 err: format!("Channel with id {} not found for the passed counterparty node_id {}", log_bytes!(*next_hop_channel_id), next_node_id)
2916 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
2917 .ok_or_else(|| APIError::APIMisuseError {
2918 err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
2921 let routing = match payment.forward_info.routing {
2922 PendingHTLCRouting::Forward { onion_packet, .. } => {
2923 PendingHTLCRouting::Forward { onion_packet, short_channel_id: next_hop_scid }
2925 _ => unreachable!() // Only `PendingHTLCRouting::Forward`s are intercepted
2927 let pending_htlc_info = PendingHTLCInfo {
2928 outgoing_amt_msat: amt_to_forward_msat, routing, ..payment.forward_info
2931 let mut per_source_pending_forward = [(
2932 payment.prev_short_channel_id,
2933 payment.prev_funding_outpoint,
2934 payment.prev_user_channel_id,
2935 vec![(pending_htlc_info, payment.prev_htlc_id)]
2937 self.forward_htlcs(&mut per_source_pending_forward);
2941 /// Fails the intercepted HTLC indicated by intercept_id. Should only be called in response to
2942 /// an [`HTLCIntercepted`] event. See [`ChannelManager::forward_intercepted_htlc`].
2944 /// Errors if the event was not handled in time, in which case the HTLC was automatically failed
2947 /// [`HTLCIntercepted`]: events::Event::HTLCIntercepted
2948 pub fn fail_intercepted_htlc(&self, intercept_id: InterceptId) -> Result<(), APIError> {
2949 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2951 let payment = self.pending_intercepted_htlcs.lock().unwrap().remove(&intercept_id)
2952 .ok_or_else(|| APIError::APIMisuseError {
2953 err: format!("Payment with intercept id {} not found", log_bytes!(intercept_id.0))
2956 if let PendingHTLCRouting::Forward { short_channel_id, .. } = payment.forward_info.routing {
2957 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
2958 short_channel_id: payment.prev_short_channel_id,
2959 outpoint: payment.prev_funding_outpoint,
2960 htlc_id: payment.prev_htlc_id,
2961 incoming_packet_shared_secret: payment.forward_info.incoming_shared_secret,
2962 phantom_shared_secret: None,
2965 let failure_reason = HTLCFailReason::from_failure_code(0x4000 | 10);
2966 let destination = HTLCDestination::UnknownNextHop { requested_forward_scid: short_channel_id };
2967 self.fail_htlc_backwards_internal(&htlc_source, &payment.forward_info.payment_hash, &failure_reason, destination);
2968 } else { unreachable!() } // Only `PendingHTLCRouting::Forward`s are intercepted
2973 /// Processes HTLCs which are pending waiting on random forward delay.
2975 /// Should only really ever be called in response to a PendingHTLCsForwardable event.
2976 /// Will likely generate further events.
2977 pub fn process_pending_htlc_forwards(&self) {
2978 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2980 let mut new_events = Vec::new();
2981 let mut failed_forwards = Vec::new();
2982 let mut phantom_receives: Vec<(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)> = Vec::new();
2984 let mut forward_htlcs = HashMap::new();
2985 mem::swap(&mut forward_htlcs, &mut self.forward_htlcs.lock().unwrap());
2987 for (short_chan_id, mut pending_forwards) in forward_htlcs {
2988 if short_chan_id != 0 {
2989 macro_rules! forwarding_channel_not_found {
2991 for forward_info in pending_forwards.drain(..) {
2992 match forward_info {
2993 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
2994 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id,
2995 forward_info: PendingHTLCInfo {
2996 routing, incoming_shared_secret, payment_hash, outgoing_amt_msat,
2997 outgoing_cltv_value, incoming_amt_msat: _
3000 macro_rules! failure_handler {
3001 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr, $next_hop_unknown: expr) => {
3002 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
3004 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
3005 short_channel_id: prev_short_channel_id,
3006 outpoint: prev_funding_outpoint,
3007 htlc_id: prev_htlc_id,
3008 incoming_packet_shared_secret: incoming_shared_secret,
3009 phantom_shared_secret: $phantom_ss,
3012 let reason = if $next_hop_unknown {
3013 HTLCDestination::UnknownNextHop { requested_forward_scid: short_chan_id }
3015 HTLCDestination::FailedPayment{ payment_hash }
3018 failed_forwards.push((htlc_source, payment_hash,
3019 HTLCFailReason::reason($err_code, $err_data),
3025 macro_rules! fail_forward {
3026 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr) => {
3028 failure_handler!($msg, $err_code, $err_data, $phantom_ss, true);
3032 macro_rules! failed_payment {
3033 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr) => {
3035 failure_handler!($msg, $err_code, $err_data, $phantom_ss, false);
3039 if let PendingHTLCRouting::Forward { onion_packet, .. } = routing {
3040 let phantom_pubkey_res = self.node_signer.get_node_id(Recipient::PhantomNode);
3041 if phantom_pubkey_res.is_ok() && fake_scid::is_valid_phantom(&self.fake_scid_rand_bytes, short_chan_id, &self.genesis_hash) {
3042 let phantom_shared_secret = self.node_signer.ecdh(Recipient::PhantomNode, &onion_packet.public_key.unwrap(), None).unwrap().secret_bytes();
3043 let next_hop = match onion_utils::decode_next_payment_hop(phantom_shared_secret, &onion_packet.hop_data, onion_packet.hmac, payment_hash) {
3045 Err(onion_utils::OnionDecodeErr::Malformed { err_msg, err_code }) => {
3046 let sha256_of_onion = Sha256::hash(&onion_packet.hop_data).into_inner();
3047 // In this scenario, the phantom would have sent us an
3048 // `update_fail_malformed_htlc`, meaning here we encrypt the error as
3049 // if it came from us (the second-to-last hop) but contains the sha256
3051 failed_payment!(err_msg, err_code, sha256_of_onion.to_vec(), None);
3053 Err(onion_utils::OnionDecodeErr::Relay { err_msg, err_code }) => {
3054 failed_payment!(err_msg, err_code, Vec::new(), Some(phantom_shared_secret));
3058 onion_utils::Hop::Receive(hop_data) => {
3059 match self.construct_recv_pending_htlc_info(hop_data, incoming_shared_secret, payment_hash, outgoing_amt_msat, outgoing_cltv_value, Some(phantom_shared_secret)) {
3060 Ok(info) => phantom_receives.push((prev_short_channel_id, prev_funding_outpoint, prev_user_channel_id, vec![(info, prev_htlc_id)])),
3061 Err(ReceiveError { err_code, err_data, msg }) => failed_payment!(msg, err_code, err_data, Some(phantom_shared_secret))
3067 fail_forward!(format!("Unknown short channel id {} for forward HTLC", short_chan_id), 0x4000 | 10, Vec::new(), None);
3070 fail_forward!(format!("Unknown short channel id {} for forward HTLC", short_chan_id), 0x4000 | 10, Vec::new(), None);
3073 HTLCForwardInfo::FailHTLC { .. } => {
3074 // Channel went away before we could fail it. This implies
3075 // the channel is now on chain and our counterparty is
3076 // trying to broadcast the HTLC-Timeout, but that's their
3077 // problem, not ours.
3083 let (counterparty_node_id, forward_chan_id) = match self.short_to_chan_info.read().unwrap().get(&short_chan_id) {
3084 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
3086 forwarding_channel_not_found!();
3090 let per_peer_state = self.per_peer_state.read().unwrap();
3091 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
3092 if peer_state_mutex_opt.is_none() {
3093 forwarding_channel_not_found!();
3096 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
3097 let peer_state = &mut *peer_state_lock;
3098 match peer_state.channel_by_id.entry(forward_chan_id) {
3099 hash_map::Entry::Vacant(_) => {
3100 forwarding_channel_not_found!();
3103 hash_map::Entry::Occupied(mut chan) => {
3104 for forward_info in pending_forwards.drain(..) {
3105 match forward_info {
3106 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
3107 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id: _,
3108 forward_info: PendingHTLCInfo {
3109 incoming_shared_secret, payment_hash, outgoing_amt_msat, outgoing_cltv_value,
3110 routing: PendingHTLCRouting::Forward { onion_packet, .. }, incoming_amt_msat: _,
3113 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);
3114 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
3115 short_channel_id: prev_short_channel_id,
3116 outpoint: prev_funding_outpoint,
3117 htlc_id: prev_htlc_id,
3118 incoming_packet_shared_secret: incoming_shared_secret,
3119 // Phantom payments are only PendingHTLCRouting::Receive.
3120 phantom_shared_secret: None,
3122 if let Err(e) = chan.get_mut().queue_add_htlc(outgoing_amt_msat,
3123 payment_hash, outgoing_cltv_value, htlc_source.clone(),
3124 onion_packet, &self.logger)
3126 if let ChannelError::Ignore(msg) = e {
3127 log_trace!(self.logger, "Failed to forward HTLC with payment_hash {}: {}", log_bytes!(payment_hash.0), msg);
3129 panic!("Stated return value requirements in send_htlc() were not met");
3131 let (failure_code, data) = self.get_htlc_temp_fail_err_and_data(0x1000|7, short_chan_id, chan.get());
3132 failed_forwards.push((htlc_source, payment_hash,
3133 HTLCFailReason::reason(failure_code, data),
3134 HTLCDestination::NextHopChannel { node_id: Some(chan.get().get_counterparty_node_id()), channel_id: forward_chan_id }
3139 HTLCForwardInfo::AddHTLC { .. } => {
3140 panic!("short_channel_id != 0 should imply any pending_forward entries are of type Forward");
3142 HTLCForwardInfo::FailHTLC { htlc_id, err_packet } => {
3143 log_trace!(self.logger, "Failing HTLC back to channel with short id {} (backward HTLC ID {}) after delay", short_chan_id, htlc_id);
3144 if let Err(e) = chan.get_mut().queue_fail_htlc(
3145 htlc_id, err_packet, &self.logger
3147 if let ChannelError::Ignore(msg) = e {
3148 log_trace!(self.logger, "Failed to fail HTLC with ID {} backwards to short_id {}: {}", htlc_id, short_chan_id, msg);
3150 panic!("Stated return value requirements in queue_fail_htlc() were not met");
3152 // fail-backs are best-effort, we probably already have one
3153 // pending, and if not that's OK, if not, the channel is on
3154 // the chain and sending the HTLC-Timeout is their problem.
3163 for forward_info in pending_forwards.drain(..) {
3164 match forward_info {
3165 HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
3166 prev_short_channel_id, prev_htlc_id, prev_funding_outpoint, prev_user_channel_id,
3167 forward_info: PendingHTLCInfo {
3168 routing, incoming_shared_secret, payment_hash, outgoing_amt_msat, ..
3171 let (cltv_expiry, onion_payload, payment_data, phantom_shared_secret) = match routing {
3172 PendingHTLCRouting::Receive { payment_data, incoming_cltv_expiry, phantom_shared_secret } => {
3173 let _legacy_hop_data = Some(payment_data.clone());
3174 (incoming_cltv_expiry, OnionPayload::Invoice { _legacy_hop_data }, Some(payment_data), phantom_shared_secret)
3176 PendingHTLCRouting::ReceiveKeysend { payment_preimage, incoming_cltv_expiry } =>
3177 (incoming_cltv_expiry, OnionPayload::Spontaneous(payment_preimage), None, None),
3179 panic!("short_channel_id == 0 should imply any pending_forward entries are of type Receive");
3182 let claimable_htlc = ClaimableHTLC {
3183 prev_hop: HTLCPreviousHopData {
3184 short_channel_id: prev_short_channel_id,
3185 outpoint: prev_funding_outpoint,
3186 htlc_id: prev_htlc_id,
3187 incoming_packet_shared_secret: incoming_shared_secret,
3188 phantom_shared_secret,
3190 value: outgoing_amt_msat,
3192 total_msat: if let Some(data) = &payment_data { data.total_msat } else { outgoing_amt_msat },
3197 macro_rules! fail_htlc {
3198 ($htlc: expr, $payment_hash: expr) => {
3199 let mut htlc_msat_height_data = $htlc.value.to_be_bytes().to_vec();
3200 htlc_msat_height_data.extend_from_slice(
3201 &self.best_block.read().unwrap().height().to_be_bytes(),
3203 failed_forwards.push((HTLCSource::PreviousHopData(HTLCPreviousHopData {
3204 short_channel_id: $htlc.prev_hop.short_channel_id,
3205 outpoint: prev_funding_outpoint,
3206 htlc_id: $htlc.prev_hop.htlc_id,
3207 incoming_packet_shared_secret: $htlc.prev_hop.incoming_packet_shared_secret,
3208 phantom_shared_secret,
3210 HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data),
3211 HTLCDestination::FailedPayment { payment_hash: $payment_hash },
3215 let phantom_shared_secret = claimable_htlc.prev_hop.phantom_shared_secret;
3216 let mut receiver_node_id = self.our_network_pubkey;
3217 if phantom_shared_secret.is_some() {
3218 receiver_node_id = self.node_signer.get_node_id(Recipient::PhantomNode)
3219 .expect("Failed to get node_id for phantom node recipient");
3222 macro_rules! check_total_value {
3223 ($payment_data: expr, $payment_preimage: expr) => {{
3224 let mut payment_claimable_generated = false;
3226 events::PaymentPurpose::InvoicePayment {
3227 payment_preimage: $payment_preimage,
3228 payment_secret: $payment_data.payment_secret,
3231 let mut claimable_payments = self.claimable_payments.lock().unwrap();
3232 if claimable_payments.pending_claiming_payments.contains_key(&payment_hash) {
3233 fail_htlc!(claimable_htlc, payment_hash);
3236 let (_, htlcs) = claimable_payments.claimable_htlcs.entry(payment_hash)
3237 .or_insert_with(|| (purpose(), Vec::new()));
3238 if htlcs.len() == 1 {
3239 if let OnionPayload::Spontaneous(_) = htlcs[0].onion_payload {
3240 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));
3241 fail_htlc!(claimable_htlc, payment_hash);
3245 let mut total_value = claimable_htlc.value;
3246 for htlc in htlcs.iter() {
3247 total_value += htlc.value;
3248 match &htlc.onion_payload {
3249 OnionPayload::Invoice { .. } => {
3250 if htlc.total_msat != $payment_data.total_msat {
3251 log_trace!(self.logger, "Failing HTLCs with payment_hash {} as the HTLCs had inconsistent total values (eg {} and {})",
3252 log_bytes!(payment_hash.0), $payment_data.total_msat, htlc.total_msat);
3253 total_value = msgs::MAX_VALUE_MSAT;
3255 if total_value >= msgs::MAX_VALUE_MSAT { break; }
3257 _ => unreachable!(),
3260 if total_value >= msgs::MAX_VALUE_MSAT || total_value > $payment_data.total_msat {
3261 log_trace!(self.logger, "Failing HTLCs with payment_hash {} as the total value {} ran over expected value {} (or HTLCs were inconsistent)",
3262 log_bytes!(payment_hash.0), total_value, $payment_data.total_msat);
3263 fail_htlc!(claimable_htlc, payment_hash);
3264 } else if total_value == $payment_data.total_msat {
3265 let prev_channel_id = prev_funding_outpoint.to_channel_id();
3266 htlcs.push(claimable_htlc);
3267 new_events.push(events::Event::PaymentClaimable {
3268 receiver_node_id: Some(receiver_node_id),
3271 amount_msat: total_value,
3272 via_channel_id: Some(prev_channel_id),
3273 via_user_channel_id: Some(prev_user_channel_id),
3275 payment_claimable_generated = true;
3277 // Nothing to do - we haven't reached the total
3278 // payment value yet, wait until we receive more
3280 htlcs.push(claimable_htlc);
3282 payment_claimable_generated
3286 // Check that the payment hash and secret are known. Note that we
3287 // MUST take care to handle the "unknown payment hash" and
3288 // "incorrect payment secret" cases here identically or we'd expose
3289 // that we are the ultimate recipient of the given payment hash.
3290 // Further, we must not expose whether we have any other HTLCs
3291 // associated with the same payment_hash pending or not.
3292 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
3293 match payment_secrets.entry(payment_hash) {
3294 hash_map::Entry::Vacant(_) => {
3295 match claimable_htlc.onion_payload {
3296 OnionPayload::Invoice { .. } => {
3297 let payment_data = payment_data.unwrap();
3298 let (payment_preimage, min_final_cltv_expiry_delta) = match inbound_payment::verify(payment_hash, &payment_data, self.highest_seen_timestamp.load(Ordering::Acquire) as u64, &self.inbound_payment_key, &self.logger) {
3299 Ok(result) => result,
3301 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as payment verification failed", log_bytes!(payment_hash.0));
3302 fail_htlc!(claimable_htlc, payment_hash);
3306 if let Some(min_final_cltv_expiry_delta) = min_final_cltv_expiry_delta {
3307 let expected_min_expiry_height = (self.current_best_block().height() + min_final_cltv_expiry_delta as u32) as u64;
3308 if (cltv_expiry as u64) < expected_min_expiry_height {
3309 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as its CLTV expiry was too soon (had {}, earliest expected {})",
3310 log_bytes!(payment_hash.0), cltv_expiry, expected_min_expiry_height);
3311 fail_htlc!(claimable_htlc, payment_hash);
3315 check_total_value!(payment_data, payment_preimage);
3317 OnionPayload::Spontaneous(preimage) => {
3318 let mut claimable_payments = self.claimable_payments.lock().unwrap();
3319 if claimable_payments.pending_claiming_payments.contains_key(&payment_hash) {
3320 fail_htlc!(claimable_htlc, payment_hash);
3323 match claimable_payments.claimable_htlcs.entry(payment_hash) {
3324 hash_map::Entry::Vacant(e) => {
3325 let purpose = events::PaymentPurpose::SpontaneousPayment(preimage);
3326 e.insert((purpose.clone(), vec![claimable_htlc]));
3327 let prev_channel_id = prev_funding_outpoint.to_channel_id();
3328 new_events.push(events::Event::PaymentClaimable {
3329 receiver_node_id: Some(receiver_node_id),
3331 amount_msat: outgoing_amt_msat,
3333 via_channel_id: Some(prev_channel_id),
3334 via_user_channel_id: Some(prev_user_channel_id),
3337 hash_map::Entry::Occupied(_) => {
3338 log_trace!(self.logger, "Failing new keysend HTLC with payment_hash {} for a duplicative payment hash", log_bytes!(payment_hash.0));
3339 fail_htlc!(claimable_htlc, payment_hash);
3345 hash_map::Entry::Occupied(inbound_payment) => {
3346 if payment_data.is_none() {
3347 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));
3348 fail_htlc!(claimable_htlc, payment_hash);
3351 let payment_data = payment_data.unwrap();
3352 if inbound_payment.get().payment_secret != payment_data.payment_secret {
3353 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our expected payment secret.", log_bytes!(payment_hash.0));
3354 fail_htlc!(claimable_htlc, payment_hash);
3355 } else if inbound_payment.get().min_value_msat.is_some() && payment_data.total_msat < inbound_payment.get().min_value_msat.unwrap() {
3356 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our minimum value (had {}, needed {}).",
3357 log_bytes!(payment_hash.0), payment_data.total_msat, inbound_payment.get().min_value_msat.unwrap());
3358 fail_htlc!(claimable_htlc, payment_hash);
3360 let payment_claimable_generated = check_total_value!(payment_data, inbound_payment.get().payment_preimage);
3361 if payment_claimable_generated {
3362 inbound_payment.remove_entry();
3368 HTLCForwardInfo::FailHTLC { .. } => {
3369 panic!("Got pending fail of our own HTLC");
3377 let best_block_height = self.best_block.read().unwrap().height();
3378 self.pending_outbound_payments.check_retry_payments(&self.router, || self.list_usable_channels(),
3379 || self.compute_inflight_htlcs(), &self.entropy_source, &self.node_signer, best_block_height, &self.logger,
3380 |path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv|
3381 self.send_payment_along_path(path, payment_params, payment_hash, payment_secret, total_value, cur_height, payment_id, keysend_preimage, session_priv));
3383 for (htlc_source, payment_hash, failure_reason, destination) in failed_forwards.drain(..) {
3384 self.fail_htlc_backwards_internal(&htlc_source, &payment_hash, &failure_reason, destination);
3386 self.forward_htlcs(&mut phantom_receives);
3388 // Freeing the holding cell here is relatively redundant - in practice we'll do it when we
3389 // next get a `get_and_clear_pending_msg_events` call, but some tests rely on it, and it's
3390 // nice to do the work now if we can rather than while we're trying to get messages in the
3392 self.check_free_holding_cells();
3394 if new_events.is_empty() { return }
3395 let mut events = self.pending_events.lock().unwrap();
3396 events.append(&mut new_events);
3399 /// Free the background events, generally called from timer_tick_occurred.
3401 /// Exposed for testing to allow us to process events quickly without generating accidental
3402 /// BroadcastChannelUpdate events in timer_tick_occurred.
3404 /// Expects the caller to have a total_consistency_lock read lock.
3405 fn process_background_events(&self) -> bool {
3406 let mut background_events = Vec::new();
3407 mem::swap(&mut *self.pending_background_events.lock().unwrap(), &mut background_events);
3408 if background_events.is_empty() {
3412 for event in background_events.drain(..) {
3414 BackgroundEvent::ClosingMonitorUpdate((funding_txo, update)) => {
3415 // The channel has already been closed, so no use bothering to care about the
3416 // monitor updating completing.
3417 let _ = self.chain_monitor.update_channel(funding_txo, &update);
3424 #[cfg(any(test, feature = "_test_utils"))]
3425 /// Process background events, for functional testing
3426 pub fn test_process_background_events(&self) {
3427 self.process_background_events();
3430 fn update_channel_fee(&self, chan_id: &[u8; 32], chan: &mut Channel<<SP::Target as SignerProvider>::Signer>, new_feerate: u32) -> NotifyOption {
3431 if !chan.is_outbound() { return NotifyOption::SkipPersist; }
3432 // If the feerate has decreased by less than half, don't bother
3433 if new_feerate <= chan.get_feerate() && new_feerate * 2 > chan.get_feerate() {
3434 log_trace!(self.logger, "Channel {} does not qualify for a feerate change from {} to {}.",
3435 log_bytes!(chan_id[..]), chan.get_feerate(), new_feerate);
3436 return NotifyOption::SkipPersist;
3438 if !chan.is_live() {
3439 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).",
3440 log_bytes!(chan_id[..]), chan.get_feerate(), new_feerate);
3441 return NotifyOption::SkipPersist;
3443 log_trace!(self.logger, "Channel {} qualifies for a feerate change from {} to {}.",
3444 log_bytes!(chan_id[..]), chan.get_feerate(), new_feerate);
3446 chan.queue_update_fee(new_feerate, &self.logger);
3447 NotifyOption::DoPersist
3451 /// In chanmon_consistency we want to sometimes do the channel fee updates done in
3452 /// timer_tick_occurred, but we can't generate the disabled channel updates as it considers
3453 /// these a fuzz failure (as they usually indicate a channel force-close, which is exactly what
3454 /// it wants to detect). Thus, we have a variant exposed here for its benefit.
3455 pub fn maybe_update_chan_fees(&self) {
3456 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
3457 let mut should_persist = NotifyOption::SkipPersist;
3459 let new_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::Normal);
3461 let per_peer_state = self.per_peer_state.read().unwrap();
3462 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
3463 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3464 let peer_state = &mut *peer_state_lock;
3465 for (chan_id, chan) in peer_state.channel_by_id.iter_mut() {
3466 let chan_needs_persist = self.update_channel_fee(chan_id, chan, new_feerate);
3467 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
3475 /// Performs actions which should happen on startup and roughly once per minute thereafter.
3477 /// This currently includes:
3478 /// * Increasing or decreasing the on-chain feerate estimates for our outbound channels,
3479 /// * Broadcasting `ChannelUpdate` messages if we've been disconnected from our peer for more
3480 /// than a minute, informing the network that they should no longer attempt to route over
3482 /// * Expiring a channel's previous `ChannelConfig` if necessary to only allow forwarding HTLCs
3483 /// with the current `ChannelConfig`.
3485 /// Note that this may cause reentrancy through `chain::Watch::update_channel` calls or feerate
3486 /// estimate fetches.
3487 pub fn timer_tick_occurred(&self) {
3488 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
3489 let mut should_persist = NotifyOption::SkipPersist;
3490 if self.process_background_events() { should_persist = NotifyOption::DoPersist; }
3492 let new_feerate = self.fee_estimator.bounded_sat_per_1000_weight(ConfirmationTarget::Normal);
3494 let mut handle_errors: Vec<(Result<(), _>, _)> = Vec::new();
3495 let mut timed_out_mpp_htlcs = Vec::new();
3497 let per_peer_state = self.per_peer_state.read().unwrap();
3498 for (counterparty_node_id, peer_state_mutex) in per_peer_state.iter() {
3499 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3500 let peer_state = &mut *peer_state_lock;
3501 let pending_msg_events = &mut peer_state.pending_msg_events;
3502 peer_state.channel_by_id.retain(|chan_id, chan| {
3503 let chan_needs_persist = self.update_channel_fee(chan_id, chan, new_feerate);
3504 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
3506 if let Err(e) = chan.timer_check_closing_negotiation_progress() {
3507 let (needs_close, err) = convert_chan_err!(self, e, chan, chan_id);
3508 handle_errors.push((Err(err), *counterparty_node_id));
3509 if needs_close { return false; }
3512 match chan.channel_update_status() {
3513 ChannelUpdateStatus::Enabled if !chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::DisabledStaged),
3514 ChannelUpdateStatus::Disabled if chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::EnabledStaged),
3515 ChannelUpdateStatus::DisabledStaged if chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::Enabled),
3516 ChannelUpdateStatus::EnabledStaged if !chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::Disabled),
3517 ChannelUpdateStatus::DisabledStaged if !chan.is_live() => {
3518 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
3519 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
3523 should_persist = NotifyOption::DoPersist;
3524 chan.set_channel_update_status(ChannelUpdateStatus::Disabled);
3526 ChannelUpdateStatus::EnabledStaged if chan.is_live() => {
3527 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
3528 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
3532 should_persist = NotifyOption::DoPersist;
3533 chan.set_channel_update_status(ChannelUpdateStatus::Enabled);
3538 chan.maybe_expire_prev_config();
3545 self.claimable_payments.lock().unwrap().claimable_htlcs.retain(|payment_hash, (_, htlcs)| {
3546 if htlcs.is_empty() {
3547 // This should be unreachable
3548 debug_assert!(false);
3551 if let OnionPayload::Invoice { .. } = htlcs[0].onion_payload {
3552 // Check if we've received all the parts we need for an MPP (the value of the parts adds to total_msat).
3553 // In this case we're not going to handle any timeouts of the parts here.
3554 if htlcs[0].total_msat == htlcs.iter().fold(0, |total, htlc| total + htlc.value) {
3556 } else if htlcs.into_iter().any(|htlc| {
3557 htlc.timer_ticks += 1;
3558 return htlc.timer_ticks >= MPP_TIMEOUT_TICKS
3560 timed_out_mpp_htlcs.extend(htlcs.drain(..).map(|htlc: ClaimableHTLC| (htlc.prev_hop, *payment_hash)));
3567 for htlc_source in timed_out_mpp_htlcs.drain(..) {
3568 let source = HTLCSource::PreviousHopData(htlc_source.0.clone());
3569 let reason = HTLCFailReason::from_failure_code(23);
3570 let receiver = HTLCDestination::FailedPayment { payment_hash: htlc_source.1 };
3571 self.fail_htlc_backwards_internal(&source, &htlc_source.1, &reason, receiver);
3574 for (err, counterparty_node_id) in handle_errors.drain(..) {
3575 let _ = handle_error!(self, err, counterparty_node_id);
3578 self.pending_outbound_payments.remove_stale_resolved_payments(&self.pending_events);
3580 // Technically we don't need to do this here, but if we have holding cell entries in a
3581 // channel that need freeing, it's better to do that here and block a background task
3582 // than block the message queueing pipeline.
3583 if self.check_free_holding_cells() {
3584 should_persist = NotifyOption::DoPersist;
3591 /// Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
3592 /// after a PaymentClaimable event, failing the HTLC back to its origin and freeing resources
3593 /// along the path (including in our own channel on which we received it).
3595 /// Note that in some cases around unclean shutdown, it is possible the payment may have
3596 /// already been claimed by you via [`ChannelManager::claim_funds`] prior to you seeing (a
3597 /// second copy of) the [`events::Event::PaymentClaimable`] event. Alternatively, the payment
3598 /// may have already been failed automatically by LDK if it was nearing its expiration time.
3600 /// While LDK will never claim a payment automatically on your behalf (i.e. without you calling
3601 /// [`ChannelManager::claim_funds`]), you should still monitor for
3602 /// [`events::Event::PaymentClaimed`] events even for payments you intend to fail, especially on
3603 /// startup during which time claims that were in-progress at shutdown may be replayed.
3604 pub fn fail_htlc_backwards(&self, payment_hash: &PaymentHash) {
3605 self.fail_htlc_backwards_with_reason(payment_hash, &FailureCode::IncorrectOrUnknownPaymentDetails);
3608 /// This is a variant of [`ChannelManager::fail_htlc_backwards`] that allows you to specify the
3609 /// reason for the failure.
3611 /// See [`FailureCode`] for valid failure codes.
3612 pub fn fail_htlc_backwards_with_reason(&self, payment_hash: &PaymentHash, failure_code: &FailureCode) {
3613 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
3615 let removed_source = self.claimable_payments.lock().unwrap().claimable_htlcs.remove(payment_hash);
3616 if let Some((_, mut sources)) = removed_source {
3617 for htlc in sources.drain(..) {
3618 let reason = self.get_htlc_fail_reason_from_failure_code(failure_code, &htlc);
3619 let source = HTLCSource::PreviousHopData(htlc.prev_hop);
3620 let receiver = HTLCDestination::FailedPayment { payment_hash: *payment_hash };
3621 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
3626 /// Gets error data to form an [`HTLCFailReason`] given a [`FailureCode`] and [`ClaimableHTLC`].
3627 fn get_htlc_fail_reason_from_failure_code(&self, failure_code: &FailureCode, htlc: &ClaimableHTLC) -> HTLCFailReason {
3628 match failure_code {
3629 FailureCode::TemporaryNodeFailure => HTLCFailReason::from_failure_code(*failure_code as u16),
3630 FailureCode::RequiredNodeFeatureMissing => HTLCFailReason::from_failure_code(*failure_code as u16),
3631 FailureCode::IncorrectOrUnknownPaymentDetails => {
3632 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
3633 htlc_msat_height_data.extend_from_slice(&self.best_block.read().unwrap().height().to_be_bytes());
3634 HTLCFailReason::reason(*failure_code as u16, htlc_msat_height_data)
3639 /// Gets an HTLC onion failure code and error data for an `UPDATE` error, given the error code
3640 /// that we want to return and a channel.
3642 /// This is for failures on the channel on which the HTLC was *received*, not failures
3644 fn get_htlc_inbound_temp_fail_err_and_data(&self, desired_err_code: u16, chan: &Channel<<SP::Target as SignerProvider>::Signer>) -> (u16, Vec<u8>) {
3645 // We can't be sure what SCID was used when relaying inbound towards us, so we have to
3646 // guess somewhat. If its a public channel, we figure best to just use the real SCID (as
3647 // we're not leaking that we have a channel with the counterparty), otherwise we try to use
3648 // an inbound SCID alias before the real SCID.
3649 let scid_pref = if chan.should_announce() {
3650 chan.get_short_channel_id().or(chan.latest_inbound_scid_alias())
3652 chan.latest_inbound_scid_alias().or(chan.get_short_channel_id())
3654 if let Some(scid) = scid_pref {
3655 self.get_htlc_temp_fail_err_and_data(desired_err_code, scid, chan)
3657 (0x4000|10, Vec::new())
3662 /// Gets an HTLC onion failure code and error data for an `UPDATE` error, given the error code
3663 /// that we want to return and a channel.
3664 fn get_htlc_temp_fail_err_and_data(&self, desired_err_code: u16, scid: u64, chan: &Channel<<SP::Target as SignerProvider>::Signer>) -> (u16, Vec<u8>) {
3665 debug_assert_eq!(desired_err_code & 0x1000, 0x1000);
3666 if let Ok(upd) = self.get_channel_update_for_onion(scid, chan) {
3667 let mut enc = VecWriter(Vec::with_capacity(upd.serialized_length() + 6));
3668 if desired_err_code == 0x1000 | 20 {
3669 // No flags for `disabled_flags` are currently defined so they're always two zero bytes.
3670 // See https://github.com/lightning/bolts/blob/341ec84/04-onion-routing.md?plain=1#L1008
3671 0u16.write(&mut enc).expect("Writes cannot fail");
3673 (upd.serialized_length() as u16 + 2).write(&mut enc).expect("Writes cannot fail");
3674 msgs::ChannelUpdate::TYPE.write(&mut enc).expect("Writes cannot fail");
3675 upd.write(&mut enc).expect("Writes cannot fail");
3676 (desired_err_code, enc.0)
3678 // If we fail to get a unicast channel_update, it implies we don't yet have an SCID,
3679 // which means we really shouldn't have gotten a payment to be forwarded over this
3680 // channel yet, or if we did it's from a route hint. Either way, returning an error of
3681 // PERM|no_such_channel should be fine.
3682 (0x4000|10, Vec::new())
3686 // Fail a list of HTLCs that were just freed from the holding cell. The HTLCs need to be
3687 // failed backwards or, if they were one of our outgoing HTLCs, then their failure needs to
3688 // be surfaced to the user.
3689 fn fail_holding_cell_htlcs(
3690 &self, mut htlcs_to_fail: Vec<(HTLCSource, PaymentHash)>, channel_id: [u8; 32],
3691 counterparty_node_id: &PublicKey
3693 let (failure_code, onion_failure_data) = {
3694 let per_peer_state = self.per_peer_state.read().unwrap();
3695 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
3696 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
3697 let peer_state = &mut *peer_state_lock;
3698 match peer_state.channel_by_id.entry(channel_id) {
3699 hash_map::Entry::Occupied(chan_entry) => {
3700 self.get_htlc_inbound_temp_fail_err_and_data(0x1000|7, &chan_entry.get())
3702 hash_map::Entry::Vacant(_) => (0x4000|10, Vec::new())
3704 } else { (0x4000|10, Vec::new()) }
3707 for (htlc_src, payment_hash) in htlcs_to_fail.drain(..) {
3708 let reason = HTLCFailReason::reason(failure_code, onion_failure_data.clone());
3709 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id.clone()), channel_id };
3710 self.fail_htlc_backwards_internal(&htlc_src, &payment_hash, &reason, receiver);
3714 /// Fails an HTLC backwards to the sender of it to us.
3715 /// Note that we do not assume that channels corresponding to failed HTLCs are still available.
3716 fn fail_htlc_backwards_internal(&self, source: &HTLCSource, payment_hash: &PaymentHash, onion_error: &HTLCFailReason, destination: HTLCDestination) {
3717 #[cfg(any(feature = "_test_utils", test))]
3719 // Ensure that the peer state channel storage lock is not held when calling this
3721 // This ensures that future code doesn't introduce a lock_order requirement for
3722 // `forward_htlcs` to be locked after the `per_peer_state` peer locks, which calling
3723 // this function with any `per_peer_state` peer lock aquired would.
3724 let per_peer_state = self.per_peer_state.read().unwrap();
3725 for (_, peer) in per_peer_state.iter() {
3726 debug_assert!(peer.try_lock().is_ok());
3730 //TODO: There is a timing attack here where if a node fails an HTLC back to us they can
3731 //identify whether we sent it or not based on the (I presume) very different runtime
3732 //between the branches here. We should make this async and move it into the forward HTLCs
3735 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
3736 // from block_connected which may run during initialization prior to the chain_monitor
3737 // being fully configured. See the docs for `ChannelManagerReadArgs` for more.
3739 HTLCSource::OutboundRoute { ref path, ref session_priv, ref payment_id, ref payment_params, .. } => {
3740 self.pending_outbound_payments.fail_htlc(source, payment_hash, onion_error, path, session_priv, payment_id, payment_params, self.probing_cookie_secret, &self.secp_ctx, &self.pending_events, &self.logger);
3742 HTLCSource::PreviousHopData(HTLCPreviousHopData { ref short_channel_id, ref htlc_id, ref incoming_packet_shared_secret, ref phantom_shared_secret, ref outpoint }) => {
3743 log_trace!(self.logger, "Failing HTLC with payment_hash {} backwards from us with {:?}", log_bytes!(payment_hash.0), onion_error);
3744 let err_packet = onion_error.get_encrypted_failure_packet(incoming_packet_shared_secret, phantom_shared_secret);
3746 let mut forward_event = None;
3747 let mut forward_htlcs = self.forward_htlcs.lock().unwrap();
3748 if forward_htlcs.is_empty() {
3749 forward_event = Some(Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS));
3751 match forward_htlcs.entry(*short_channel_id) {
3752 hash_map::Entry::Occupied(mut entry) => {
3753 entry.get_mut().push(HTLCForwardInfo::FailHTLC { htlc_id: *htlc_id, err_packet });
3755 hash_map::Entry::Vacant(entry) => {
3756 entry.insert(vec!(HTLCForwardInfo::FailHTLC { htlc_id: *htlc_id, err_packet }));
3759 mem::drop(forward_htlcs);
3760 let mut pending_events = self.pending_events.lock().unwrap();
3761 if let Some(time) = forward_event {
3762 pending_events.push(events::Event::PendingHTLCsForwardable {
3763 time_forwardable: time
3766 pending_events.push(events::Event::HTLCHandlingFailed {
3767 prev_channel_id: outpoint.to_channel_id(),
3768 failed_next_destination: destination,
3774 /// Provides a payment preimage in response to [`Event::PaymentClaimable`], generating any
3775 /// [`MessageSendEvent`]s needed to claim the payment.
3777 /// Note that calling this method does *not* guarantee that the payment has been claimed. You
3778 /// *must* wait for an [`Event::PaymentClaimed`] event which upon a successful claim will be
3779 /// provided to your [`EventHandler`] when [`process_pending_events`] is next called.
3781 /// Note that if you did not set an `amount_msat` when calling [`create_inbound_payment`] or
3782 /// [`create_inbound_payment_for_hash`] you must check that the amount in the `PaymentClaimable`
3783 /// event matches your expectation. If you fail to do so and call this method, you may provide
3784 /// the sender "proof-of-payment" when they did not fulfill the full expected payment.
3786 /// [`Event::PaymentClaimable`]: crate::util::events::Event::PaymentClaimable
3787 /// [`Event::PaymentClaimed`]: crate::util::events::Event::PaymentClaimed
3788 /// [`process_pending_events`]: EventsProvider::process_pending_events
3789 /// [`create_inbound_payment`]: Self::create_inbound_payment
3790 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
3791 pub fn claim_funds(&self, payment_preimage: PaymentPreimage) {
3792 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
3794 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
3797 let mut claimable_payments = self.claimable_payments.lock().unwrap();
3798 if let Some((payment_purpose, sources)) = claimable_payments.claimable_htlcs.remove(&payment_hash) {
3799 let mut receiver_node_id = self.our_network_pubkey;
3800 for htlc in sources.iter() {
3801 if htlc.prev_hop.phantom_shared_secret.is_some() {
3802 let phantom_pubkey = self.node_signer.get_node_id(Recipient::PhantomNode)
3803 .expect("Failed to get node_id for phantom node recipient");
3804 receiver_node_id = phantom_pubkey;
3809 let dup_purpose = claimable_payments.pending_claiming_payments.insert(payment_hash,
3810 ClaimingPayment { amount_msat: sources.iter().map(|source| source.value).sum(),
3811 payment_purpose, receiver_node_id,
3813 if dup_purpose.is_some() {
3814 debug_assert!(false, "Shouldn't get a duplicate pending claim event ever");
3815 log_error!(self.logger, "Got a duplicate pending claimable event on payment hash {}! Please report this bug",
3816 log_bytes!(payment_hash.0));
3821 debug_assert!(!sources.is_empty());
3823 // If we are claiming an MPP payment, we check that all channels which contain a claimable
3824 // HTLC still exist. While this isn't guaranteed to remain true if a channel closes while
3825 // we're claiming (or even after we claim, before the commitment update dance completes),
3826 // it should be a relatively rare race, and we'd rather not claim HTLCs that require us to
3827 // go on-chain (and lose the on-chain fee to do so) than just reject the payment.
3829 // Note that we'll still always get our funds - as long as the generated
3830 // `ChannelMonitorUpdate` makes it out to the relevant monitor we can claim on-chain.
3832 // If we find an HTLC which we would need to claim but for which we do not have a
3833 // channel, we will fail all parts of the MPP payment. While we could wait and see if
3834 // the sender retries the already-failed path(s), it should be a pretty rare case where
3835 // we got all the HTLCs and then a channel closed while we were waiting for the user to
3836 // provide the preimage, so worrying too much about the optimal handling isn't worth
3838 let mut claimable_amt_msat = 0;
3839 let mut expected_amt_msat = None;
3840 let mut valid_mpp = true;
3841 let mut errs = Vec::new();
3842 let per_peer_state = self.per_peer_state.read().unwrap();
3843 for htlc in sources.iter() {
3844 let (counterparty_node_id, chan_id) = match self.short_to_chan_info.read().unwrap().get(&htlc.prev_hop.short_channel_id) {
3845 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
3852 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
3853 if peer_state_mutex_opt.is_none() {
3858 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
3859 let peer_state = &mut *peer_state_lock;
3861 if peer_state.channel_by_id.get(&chan_id).is_none() {
3866 if expected_amt_msat.is_some() && expected_amt_msat != Some(htlc.total_msat) {
3867 log_error!(self.logger, "Somehow ended up with an MPP payment with different total amounts - this should not be reachable!");
3868 debug_assert!(false);
3873 expected_amt_msat = Some(htlc.total_msat);
3874 if let OnionPayload::Spontaneous(_) = &htlc.onion_payload {
3875 // We don't currently support MPP for spontaneous payments, so just check
3876 // that there's one payment here and move on.
3877 if sources.len() != 1 {
3878 log_error!(self.logger, "Somehow ended up with an MPP spontaneous payment - this should not be reachable!");
3879 debug_assert!(false);
3885 claimable_amt_msat += htlc.value;
3887 mem::drop(per_peer_state);
3888 if sources.is_empty() || expected_amt_msat.is_none() {
3889 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
3890 log_info!(self.logger, "Attempted to claim an incomplete payment which no longer had any available HTLCs!");
3893 if claimable_amt_msat != expected_amt_msat.unwrap() {
3894 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
3895 log_info!(self.logger, "Attempted to claim an incomplete payment, expected {} msat, had {} available to claim.",
3896 expected_amt_msat.unwrap(), claimable_amt_msat);
3900 for htlc in sources.drain(..) {
3901 if let Err((pk, err)) = self.claim_funds_from_hop(
3902 htlc.prev_hop, payment_preimage,
3903 |_| Some(MonitorUpdateCompletionAction::PaymentClaimed { payment_hash }))
3905 if let msgs::ErrorAction::IgnoreError = err.err.action {
3906 // We got a temporary failure updating monitor, but will claim the
3907 // HTLC when the monitor updating is restored (or on chain).
3908 log_error!(self.logger, "Temporary failure claiming HTLC, treating as success: {}", err.err.err);
3909 } else { errs.push((pk, err)); }
3914 for htlc in sources.drain(..) {
3915 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
3916 htlc_msat_height_data.extend_from_slice(&self.best_block.read().unwrap().height().to_be_bytes());
3917 let source = HTLCSource::PreviousHopData(htlc.prev_hop);
3918 let reason = HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data);
3919 let receiver = HTLCDestination::FailedPayment { payment_hash };
3920 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
3922 self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
3925 // Now we can handle any errors which were generated.
3926 for (counterparty_node_id, err) in errs.drain(..) {
3927 let res: Result<(), _> = Err(err);
3928 let _ = handle_error!(self, res, counterparty_node_id);
3932 fn claim_funds_from_hop<ComplFunc: FnOnce(Option<u64>) -> Option<MonitorUpdateCompletionAction>>(&self,
3933 prev_hop: HTLCPreviousHopData, payment_preimage: PaymentPreimage, completion_action: ComplFunc)
3934 -> Result<(), (PublicKey, MsgHandleErrInternal)> {
3935 //TODO: Delay the claimed_funds relaying just like we do outbound relay!
3937 let per_peer_state = self.per_peer_state.read().unwrap();
3938 let chan_id = prev_hop.outpoint.to_channel_id();
3940 let counterparty_node_id_opt = match self.short_to_chan_info.read().unwrap().get(&prev_hop.short_channel_id) {
3941 Some((cp_id, _dup_chan_id)) => Some(cp_id.clone()),
3945 let mut peer_state_opt = counterparty_node_id_opt.as_ref().map(
3946 |counterparty_node_id| per_peer_state.get(counterparty_node_id).map(
3947 |peer_mutex| peer_mutex.lock().unwrap()
3951 if let Some(hash_map::Entry::Occupied(mut chan)) = peer_state_opt.as_mut().map(|peer_state| peer_state.channel_by_id.entry(chan_id))
3953 let counterparty_node_id = chan.get().get_counterparty_node_id();
3954 match chan.get_mut().get_update_fulfill_htlc_and_commit(prev_hop.htlc_id, payment_preimage, &self.logger) {
3955 Ok(msgs_monitor_option) => {
3956 if let UpdateFulfillCommitFetch::NewClaim { msgs, htlc_value_msat, monitor_update } = msgs_monitor_option {
3957 match self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), &monitor_update) {
3958 ChannelMonitorUpdateStatus::Completed => {},
3960 log_given_level!(self.logger, if e == ChannelMonitorUpdateStatus::PermanentFailure { Level::Error } else { Level::Debug },
3961 "Failed to update channel monitor with preimage {:?}: {:?}",
3962 payment_preimage, e);
3963 let err = handle_monitor_update_res!(self, e, chan, RAACommitmentOrder::CommitmentFirst, false, msgs.is_some()).unwrap_err();
3964 mem::drop(peer_state_opt);
3965 mem::drop(per_peer_state);
3966 self.handle_monitor_update_completion_actions(completion_action(Some(htlc_value_msat)));
3967 return Err((counterparty_node_id, err));
3970 if let Some((msg, commitment_signed)) = msgs {
3971 log_debug!(self.logger, "Claiming funds for HTLC with preimage {} resulted in a commitment_signed for channel {}",
3972 log_bytes!(payment_preimage.0), log_bytes!(chan.get().channel_id()));
3973 peer_state_opt.as_mut().unwrap().pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
3974 node_id: counterparty_node_id,
3975 updates: msgs::CommitmentUpdate {
3976 update_add_htlcs: Vec::new(),
3977 update_fulfill_htlcs: vec![msg],
3978 update_fail_htlcs: Vec::new(),
3979 update_fail_malformed_htlcs: Vec::new(),
3985 mem::drop(peer_state_opt);
3986 mem::drop(per_peer_state);
3987 self.handle_monitor_update_completion_actions(completion_action(Some(htlc_value_msat)));
3993 Err((e, monitor_update)) => {
3994 match self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), &monitor_update) {
3995 ChannelMonitorUpdateStatus::Completed => {},
3997 // TODO: This needs to be handled somehow - if we receive a monitor update
3998 // with a preimage we *must* somehow manage to propagate it to the upstream
3999 // channel, or we must have an ability to receive the same update and try
4000 // again on restart.
4001 log_given_level!(self.logger, if e == ChannelMonitorUpdateStatus::PermanentFailure { Level::Error } else { Level::Info },
4002 "Failed to update channel monitor with preimage {:?} immediately prior to force-close: {:?}",
4003 payment_preimage, e);
4006 let (drop, res) = convert_chan_err!(self, e, chan.get_mut(), &chan_id);
4008 chan.remove_entry();
4010 mem::drop(peer_state_opt);
4011 mem::drop(per_peer_state);
4012 self.handle_monitor_update_completion_actions(completion_action(None));
4013 Err((counterparty_node_id, res))
4017 let preimage_update = ChannelMonitorUpdate {
4018 update_id: CLOSED_CHANNEL_UPDATE_ID,
4019 updates: vec![ChannelMonitorUpdateStep::PaymentPreimage {
4023 // We update the ChannelMonitor on the backward link, after
4024 // receiving an `update_fulfill_htlc` from the forward link.
4025 let update_res = self.chain_monitor.update_channel(prev_hop.outpoint, &preimage_update);
4026 if update_res != ChannelMonitorUpdateStatus::Completed {
4027 // TODO: This needs to be handled somehow - if we receive a monitor update
4028 // with a preimage we *must* somehow manage to propagate it to the upstream
4029 // channel, or we must have an ability to receive the same event and try
4030 // again on restart.
4031 log_error!(self.logger, "Critical error: failed to update channel monitor with preimage {:?}: {:?}",
4032 payment_preimage, update_res);
4034 mem::drop(peer_state_opt);
4035 mem::drop(per_peer_state);
4036 // Note that we do process the completion action here. This totally could be a
4037 // duplicate claim, but we have no way of knowing without interrogating the
4038 // `ChannelMonitor` we've provided the above update to. Instead, note that `Event`s are
4039 // generally always allowed to be duplicative (and it's specifically noted in
4040 // `PaymentForwarded`).
4041 self.handle_monitor_update_completion_actions(completion_action(None));
4046 fn finalize_claims(&self, sources: Vec<HTLCSource>) {
4047 self.pending_outbound_payments.finalize_claims(sources, &self.pending_events);
4050 fn claim_funds_internal(&self, source: HTLCSource, payment_preimage: PaymentPreimage, forwarded_htlc_value_msat: Option<u64>, from_onchain: bool, next_channel_id: [u8; 32]) {
4052 HTLCSource::OutboundRoute { session_priv, payment_id, path, .. } => {
4053 self.pending_outbound_payments.claim_htlc(payment_id, payment_preimage, session_priv, path, from_onchain, &self.pending_events, &self.logger);
4055 HTLCSource::PreviousHopData(hop_data) => {
4056 let prev_outpoint = hop_data.outpoint;
4057 let res = self.claim_funds_from_hop(hop_data, payment_preimage,
4058 |htlc_claim_value_msat| {
4059 if let Some(forwarded_htlc_value) = forwarded_htlc_value_msat {
4060 let fee_earned_msat = if let Some(claimed_htlc_value) = htlc_claim_value_msat {
4061 Some(claimed_htlc_value - forwarded_htlc_value)
4064 let prev_channel_id = Some(prev_outpoint.to_channel_id());
4065 let next_channel_id = Some(next_channel_id);
4067 Some(MonitorUpdateCompletionAction::EmitEvent { event: events::Event::PaymentForwarded {
4069 claim_from_onchain_tx: from_onchain,
4075 if let Err((pk, err)) = res {
4076 let result: Result<(), _> = Err(err);
4077 let _ = handle_error!(self, result, pk);
4083 /// Gets the node_id held by this ChannelManager
4084 pub fn get_our_node_id(&self) -> PublicKey {
4085 self.our_network_pubkey.clone()
4088 fn handle_monitor_update_completion_actions<I: IntoIterator<Item=MonitorUpdateCompletionAction>>(&self, actions: I) {
4089 for action in actions.into_iter() {
4091 MonitorUpdateCompletionAction::PaymentClaimed { payment_hash } => {
4092 let payment = self.claimable_payments.lock().unwrap().pending_claiming_payments.remove(&payment_hash);
4093 if let Some(ClaimingPayment { amount_msat, payment_purpose: purpose, receiver_node_id }) = payment {
4094 self.pending_events.lock().unwrap().push(events::Event::PaymentClaimed {
4095 payment_hash, purpose, amount_msat, receiver_node_id: Some(receiver_node_id),
4099 MonitorUpdateCompletionAction::EmitEvent { event } => {
4100 self.pending_events.lock().unwrap().push(event);
4106 /// Handles a channel reentering a functional state, either due to reconnect or a monitor
4107 /// update completion.
4108 fn handle_channel_resumption(&self, pending_msg_events: &mut Vec<MessageSendEvent>,
4109 channel: &mut Channel<<SP::Target as SignerProvider>::Signer>, raa: Option<msgs::RevokeAndACK>,
4110 commitment_update: Option<msgs::CommitmentUpdate>, order: RAACommitmentOrder,
4111 pending_forwards: Vec<(PendingHTLCInfo, u64)>, funding_broadcastable: Option<Transaction>,
4112 channel_ready: Option<msgs::ChannelReady>, announcement_sigs: Option<msgs::AnnouncementSignatures>)
4113 -> Option<(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)> {
4114 let mut htlc_forwards = None;
4116 let counterparty_node_id = channel.get_counterparty_node_id();
4117 if !pending_forwards.is_empty() {
4118 htlc_forwards = Some((channel.get_short_channel_id().unwrap_or(channel.outbound_scid_alias()),
4119 channel.get_funding_txo().unwrap(), channel.get_user_id(), pending_forwards));
4122 if let Some(msg) = channel_ready {
4123 send_channel_ready!(self, pending_msg_events, channel, msg);
4125 if let Some(msg) = announcement_sigs {
4126 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
4127 node_id: counterparty_node_id,
4132 emit_channel_ready_event!(self, channel);
4134 macro_rules! handle_cs { () => {
4135 if let Some(update) = commitment_update {
4136 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
4137 node_id: counterparty_node_id,
4142 macro_rules! handle_raa { () => {
4143 if let Some(revoke_and_ack) = raa {
4144 pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
4145 node_id: counterparty_node_id,
4146 msg: revoke_and_ack,
4151 RAACommitmentOrder::CommitmentFirst => {
4155 RAACommitmentOrder::RevokeAndACKFirst => {
4161 if let Some(tx) = funding_broadcastable {
4162 log_info!(self.logger, "Broadcasting funding transaction with txid {}", tx.txid());
4163 self.tx_broadcaster.broadcast_transaction(&tx);
4169 fn channel_monitor_updated(&self, funding_txo: &OutPoint, highest_applied_update_id: u64, counterparty_node_id: Option<&PublicKey>) {
4170 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4173 let (mut pending_failures, finalized_claims, counterparty_node_id) = {
4174 let counterparty_node_id = match counterparty_node_id {
4175 Some(cp_id) => cp_id.clone(),
4177 // TODO: Once we can rely on the counterparty_node_id from the
4178 // monitor event, this and the id_to_peer map should be removed.
4179 let id_to_peer = self.id_to_peer.lock().unwrap();
4180 match id_to_peer.get(&funding_txo.to_channel_id()) {
4181 Some(cp_id) => cp_id.clone(),
4186 let per_peer_state = self.per_peer_state.read().unwrap();
4187 let mut peer_state_lock;
4188 let peer_state_mutex_opt = per_peer_state.get(&counterparty_node_id);
4189 if peer_state_mutex_opt.is_none() { return }
4190 peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
4191 let peer_state = &mut *peer_state_lock;
4193 match peer_state.channel_by_id.entry(funding_txo.to_channel_id()){
4194 hash_map::Entry::Occupied(chan) => chan,
4195 hash_map::Entry::Vacant(_) => return,
4198 if !channel.get().is_awaiting_monitor_update() || channel.get().get_latest_monitor_update_id() != highest_applied_update_id {
4202 let updates = channel.get_mut().monitor_updating_restored(&self.logger, &self.node_signer, self.genesis_hash, &self.default_configuration, self.best_block.read().unwrap().height());
4203 let channel_update = if updates.channel_ready.is_some() && channel.get().is_usable() {
4204 // We only send a channel_update in the case where we are just now sending a
4205 // channel_ready and the channel is in a usable state. We may re-send a
4206 // channel_update later through the announcement_signatures process for public
4207 // channels, but there's no reason not to just inform our counterparty of our fees
4209 if let Ok(msg) = self.get_channel_update_for_unicast(channel.get()) {
4210 Some(events::MessageSendEvent::SendChannelUpdate {
4211 node_id: channel.get().get_counterparty_node_id(),
4216 htlc_forwards = self.handle_channel_resumption(&mut peer_state.pending_msg_events, channel.get_mut(), updates.raa, updates.commitment_update, updates.order, updates.accepted_htlcs, updates.funding_broadcastable, updates.channel_ready, updates.announcement_sigs);
4217 if let Some(upd) = channel_update {
4218 peer_state.pending_msg_events.push(upd);
4221 (updates.failed_htlcs, updates.finalized_claimed_htlcs, counterparty_node_id)
4223 if let Some(forwards) = htlc_forwards {
4224 self.forward_htlcs(&mut [forwards][..]);
4226 self.finalize_claims(finalized_claims);
4227 for failure in pending_failures.drain(..) {
4228 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id: funding_txo.to_channel_id() };
4229 self.fail_htlc_backwards_internal(&failure.0, &failure.1, &failure.2, receiver);
4233 /// Accepts a request to open a channel after a [`Event::OpenChannelRequest`].
4235 /// The `temporary_channel_id` parameter indicates which inbound channel should be accepted,
4236 /// and the `counterparty_node_id` parameter is the id of the peer which has requested to open
4239 /// The `user_channel_id` parameter will be provided back in
4240 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
4241 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
4243 /// Note that this method will return an error and reject the channel, if it requires support
4244 /// for zero confirmations. Instead, `accept_inbound_channel_from_trusted_peer_0conf` must be
4245 /// used to accept such channels.
4247 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
4248 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
4249 pub fn accept_inbound_channel(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, user_channel_id: u128) -> Result<(), APIError> {
4250 self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, false, user_channel_id)
4253 /// Accepts a request to open a channel after a [`events::Event::OpenChannelRequest`], treating
4254 /// it as confirmed immediately.
4256 /// The `user_channel_id` parameter will be provided back in
4257 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
4258 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
4260 /// Unlike [`ChannelManager::accept_inbound_channel`], this method accepts the incoming channel
4261 /// and (if the counterparty agrees), enables forwarding of payments immediately.
4263 /// This fully trusts that the counterparty has honestly and correctly constructed the funding
4264 /// transaction and blindly assumes that it will eventually confirm.
4266 /// If it does not confirm before we decide to close the channel, or if the funding transaction
4267 /// does not pay to the correct script the correct amount, *you will lose funds*.
4269 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
4270 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
4271 pub fn accept_inbound_channel_from_trusted_peer_0conf(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, user_channel_id: u128) -> Result<(), APIError> {
4272 self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, true, user_channel_id)
4275 fn do_accept_inbound_channel(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, accept_0conf: bool, user_channel_id: u128) -> Result<(), APIError> {
4276 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4278 let per_peer_state = self.per_peer_state.read().unwrap();
4279 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
4280 .ok_or_else(|| APIError::APIMisuseError{ err: format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id) })?;
4281 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4282 let peer_state = &mut *peer_state_lock;
4283 match peer_state.channel_by_id.entry(temporary_channel_id.clone()) {
4284 hash_map::Entry::Occupied(mut channel) => {
4285 if !channel.get().inbound_is_awaiting_accept() {
4286 return Err(APIError::APIMisuseError { err: "The channel isn't currently awaiting to be accepted.".to_owned() });
4289 channel.get_mut().set_0conf();
4290 } else if channel.get().get_channel_type().requires_zero_conf() {
4291 let send_msg_err_event = events::MessageSendEvent::HandleError {
4292 node_id: channel.get().get_counterparty_node_id(),
4293 action: msgs::ErrorAction::SendErrorMessage{
4294 msg: msgs::ErrorMessage { channel_id: temporary_channel_id.clone(), data: "No zero confirmation channels accepted".to_owned(), }
4297 peer_state.pending_msg_events.push(send_msg_err_event);
4298 let _ = remove_channel!(self, channel);
4299 return Err(APIError::APIMisuseError { err: "Please use accept_inbound_channel_from_trusted_peer_0conf to accept channels with zero confirmations.".to_owned() });
4302 peer_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
4303 node_id: channel.get().get_counterparty_node_id(),
4304 msg: channel.get_mut().accept_inbound_channel(user_channel_id),
4307 hash_map::Entry::Vacant(_) => {
4308 return Err(APIError::ChannelUnavailable { err: format!("Channel with id {} not found for the passed counterparty node_id {}", log_bytes!(*temporary_channel_id), counterparty_node_id) });
4314 fn internal_open_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::OpenChannel) -> Result<(), MsgHandleErrInternal> {
4315 if msg.chain_hash != self.genesis_hash {
4316 return Err(MsgHandleErrInternal::send_err_msg_no_close("Unknown genesis block hash".to_owned(), msg.temporary_channel_id.clone()));
4319 if !self.default_configuration.accept_inbound_channels {
4320 return Err(MsgHandleErrInternal::send_err_msg_no_close("No inbound channels accepted".to_owned(), msg.temporary_channel_id.clone()));
4323 let mut random_bytes = [0u8; 16];
4324 random_bytes.copy_from_slice(&self.entropy_source.get_secure_random_bytes()[..16]);
4325 let user_channel_id = u128::from_be_bytes(random_bytes);
4327 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
4328 let per_peer_state = self.per_peer_state.read().unwrap();
4329 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
4330 .ok_or_else(|| MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.temporary_channel_id.clone()))?;
4331 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4332 let peer_state = &mut *peer_state_lock;
4333 let mut channel = match Channel::new_from_req(&self.fee_estimator, &self.entropy_source, &self.signer_provider,
4334 counterparty_node_id.clone(), &self.channel_type_features(), &peer_state.latest_features, msg, user_channel_id, &self.default_configuration,
4335 self.best_block.read().unwrap().height(), &self.logger, outbound_scid_alias)
4338 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
4339 return Err(MsgHandleErrInternal::from_chan_no_close(e, msg.temporary_channel_id));
4343 match peer_state.channel_by_id.entry(channel.channel_id()) {
4344 hash_map::Entry::Occupied(_) => {
4345 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
4346 return Err(MsgHandleErrInternal::send_err_msg_no_close("temporary_channel_id collision for the same peer!".to_owned(), msg.temporary_channel_id.clone()))
4348 hash_map::Entry::Vacant(entry) => {
4349 if !self.default_configuration.manually_accept_inbound_channels {
4350 if channel.get_channel_type().requires_zero_conf() {
4351 return Err(MsgHandleErrInternal::send_err_msg_no_close("No zero confirmation channels accepted".to_owned(), msg.temporary_channel_id.clone()));
4353 peer_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
4354 node_id: counterparty_node_id.clone(),
4355 msg: channel.accept_inbound_channel(user_channel_id),
4358 let mut pending_events = self.pending_events.lock().unwrap();
4359 pending_events.push(
4360 events::Event::OpenChannelRequest {
4361 temporary_channel_id: msg.temporary_channel_id.clone(),
4362 counterparty_node_id: counterparty_node_id.clone(),
4363 funding_satoshis: msg.funding_satoshis,
4364 push_msat: msg.push_msat,
4365 channel_type: channel.get_channel_type().clone(),
4370 entry.insert(channel);
4376 fn internal_accept_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::AcceptChannel) -> Result<(), MsgHandleErrInternal> {
4377 let (value, output_script, user_id) = {
4378 let per_peer_state = self.per_peer_state.read().unwrap();
4379 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
4380 .ok_or_else(|| MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.temporary_channel_id))?;
4381 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4382 let peer_state = &mut *peer_state_lock;
4383 match peer_state.channel_by_id.entry(msg.temporary_channel_id) {
4384 hash_map::Entry::Occupied(mut chan) => {
4385 try_chan_entry!(self, chan.get_mut().accept_channel(&msg, &self.default_configuration.channel_handshake_limits, &peer_state.latest_features), chan);
4386 (chan.get().get_value_satoshis(), chan.get().get_funding_redeemscript().to_v0_p2wsh(), chan.get().get_user_id())
4388 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", counterparty_node_id), msg.temporary_channel_id))
4391 let mut pending_events = self.pending_events.lock().unwrap();
4392 pending_events.push(events::Event::FundingGenerationReady {
4393 temporary_channel_id: msg.temporary_channel_id,
4394 counterparty_node_id: *counterparty_node_id,
4395 channel_value_satoshis: value,
4397 user_channel_id: user_id,
4402 fn internal_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), MsgHandleErrInternal> {
4403 let per_peer_state = self.per_peer_state.read().unwrap();
4404 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
4405 .ok_or_else(|| MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.temporary_channel_id))?;
4406 let ((funding_msg, monitor, mut channel_ready), mut chan) = {
4407 let best_block = *self.best_block.read().unwrap();
4408 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4409 let peer_state = &mut *peer_state_lock;
4410 match peer_state.channel_by_id.entry(msg.temporary_channel_id) {
4411 hash_map::Entry::Occupied(mut chan) => {
4412 (try_chan_entry!(self, chan.get_mut().funding_created(msg, best_block, &self.signer_provider, &self.logger), chan), chan.remove())
4414 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", counterparty_node_id), msg.temporary_channel_id))
4417 // Because we have exclusive ownership of the channel here we can release the peer_state
4418 // lock before watch_channel
4419 match self.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor) {
4420 ChannelMonitorUpdateStatus::Completed => {},
4421 ChannelMonitorUpdateStatus::PermanentFailure => {
4422 // Note that we reply with the new channel_id in error messages if we gave up on the
4423 // channel, not the temporary_channel_id. This is compatible with ourselves, but the
4424 // spec is somewhat ambiguous here. Not a huge deal since we'll send error messages for
4425 // any messages referencing a previously-closed channel anyway.
4426 // We do not propagate the monitor update to the user as it would be for a monitor
4427 // that we didn't manage to store (and that we don't care about - we don't respond
4428 // with the funding_signed so the channel can never go on chain).
4429 let (_monitor_update, failed_htlcs) = chan.force_shutdown(false);
4430 assert!(failed_htlcs.is_empty());
4431 return Err(MsgHandleErrInternal::send_err_msg_no_close("ChannelMonitor storage failure".to_owned(), funding_msg.channel_id));
4433 ChannelMonitorUpdateStatus::InProgress => {
4434 // There's no problem signing a counterparty's funding transaction if our monitor
4435 // hasn't persisted to disk yet - we can't lose money on a transaction that we haven't
4436 // accepted payment from yet. We do, however, need to wait to send our channel_ready
4437 // until we have persisted our monitor.
4438 chan.monitor_updating_paused(false, false, channel_ready.is_some(), Vec::new(), Vec::new(), Vec::new());
4439 channel_ready = None; // Don't send the channel_ready now
4442 // It's safe to unwrap as we've held the `per_peer_state` read lock since checking that the
4443 // peer exists, despite the inner PeerState potentially having no channels after removing
4444 // the channel above.
4445 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4446 let peer_state = &mut *peer_state_lock;
4447 match peer_state.channel_by_id.entry(funding_msg.channel_id) {
4448 hash_map::Entry::Occupied(_) => {
4449 return Err(MsgHandleErrInternal::send_err_msg_no_close("Already had channel with the new channel_id".to_owned(), funding_msg.channel_id))
4451 hash_map::Entry::Vacant(e) => {
4452 let mut id_to_peer = self.id_to_peer.lock().unwrap();
4453 match id_to_peer.entry(chan.channel_id()) {
4454 hash_map::Entry::Occupied(_) => {
4455 return Err(MsgHandleErrInternal::send_err_msg_no_close(
4456 "The funding_created message had the same funding_txid as an existing channel - funding is not possible".to_owned(),
4457 funding_msg.channel_id))
4459 hash_map::Entry::Vacant(i_e) => {
4460 i_e.insert(chan.get_counterparty_node_id());
4463 peer_state.pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
4464 node_id: counterparty_node_id.clone(),
4467 if let Some(msg) = channel_ready {
4468 send_channel_ready!(self, peer_state.pending_msg_events, chan, msg);
4476 fn internal_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), MsgHandleErrInternal> {
4478 let best_block = *self.best_block.read().unwrap();
4479 let per_peer_state = self.per_peer_state.read().unwrap();
4480 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
4481 .ok_or_else(|| MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id))?;
4483 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4484 let peer_state = &mut *peer_state_lock;
4485 match peer_state.channel_by_id.entry(msg.channel_id) {
4486 hash_map::Entry::Occupied(mut chan) => {
4487 let (monitor, funding_tx, channel_ready) = match chan.get_mut().funding_signed(&msg, best_block, &self.signer_provider, &self.logger) {
4488 Ok(update) => update,
4489 Err(e) => try_chan_entry!(self, Err(e), chan),
4491 match self.chain_monitor.watch_channel(chan.get().get_funding_txo().unwrap(), monitor) {
4492 ChannelMonitorUpdateStatus::Completed => {},
4494 let mut res = handle_monitor_update_res!(self, e, chan, RAACommitmentOrder::RevokeAndACKFirst, channel_ready.is_some(), OPTIONALLY_RESEND_FUNDING_LOCKED);
4495 if let Err(MsgHandleErrInternal { ref mut shutdown_finish, .. }) = res {
4496 // We weren't able to watch the channel to begin with, so no updates should be made on
4497 // it. Previously, full_stack_target found an (unreachable) panic when the
4498 // monitor update contained within `shutdown_finish` was applied.
4499 if let Some((ref mut shutdown_finish, _)) = shutdown_finish {
4500 shutdown_finish.0.take();
4506 if let Some(msg) = channel_ready {
4507 send_channel_ready!(self, peer_state.pending_msg_events, chan.get(), msg);
4511 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", counterparty_node_id), msg.channel_id))
4514 log_info!(self.logger, "Broadcasting funding transaction with txid {}", funding_tx.txid());
4515 self.tx_broadcaster.broadcast_transaction(&funding_tx);
4519 fn internal_channel_ready(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReady) -> Result<(), MsgHandleErrInternal> {
4520 let per_peer_state = self.per_peer_state.read().unwrap();
4521 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
4522 .ok_or_else(|| MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id))?;
4523 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4524 let peer_state = &mut *peer_state_lock;
4525 match peer_state.channel_by_id.entry(msg.channel_id) {
4526 hash_map::Entry::Occupied(mut chan) => {
4527 let announcement_sigs_opt = try_chan_entry!(self, chan.get_mut().channel_ready(&msg, &self.node_signer,
4528 self.genesis_hash.clone(), &self.default_configuration, &self.best_block.read().unwrap(), &self.logger), chan);
4529 if let Some(announcement_sigs) = announcement_sigs_opt {
4530 log_trace!(self.logger, "Sending announcement_signatures for channel {}", log_bytes!(chan.get().channel_id()));
4531 peer_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
4532 node_id: counterparty_node_id.clone(),
4533 msg: announcement_sigs,
4535 } else if chan.get().is_usable() {
4536 // If we're sending an announcement_signatures, we'll send the (public)
4537 // channel_update after sending a channel_announcement when we receive our
4538 // counterparty's announcement_signatures. Thus, we only bother to send a
4539 // channel_update here if the channel is not public, i.e. we're not sending an
4540 // announcement_signatures.
4541 log_trace!(self.logger, "Sending private initial channel_update for our counterparty on channel {}", log_bytes!(chan.get().channel_id()));
4542 if let Ok(msg) = self.get_channel_update_for_unicast(chan.get()) {
4543 peer_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
4544 node_id: counterparty_node_id.clone(),
4550 emit_channel_ready_event!(self, chan.get_mut());
4554 hash_map::Entry::Vacant(_) => Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", counterparty_node_id), msg.channel_id))
4558 fn internal_shutdown(&self, counterparty_node_id: &PublicKey, msg: &msgs::Shutdown) -> Result<(), MsgHandleErrInternal> {
4559 let mut dropped_htlcs: Vec<(HTLCSource, PaymentHash)>;
4560 let result: Result<(), _> = loop {
4561 let per_peer_state = self.per_peer_state.read().unwrap();
4562 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
4563 .ok_or_else(|| MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id))?;
4564 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4565 let peer_state = &mut *peer_state_lock;
4566 match peer_state.channel_by_id.entry(msg.channel_id.clone()) {
4567 hash_map::Entry::Occupied(mut chan_entry) => {
4569 if !chan_entry.get().received_shutdown() {
4570 log_info!(self.logger, "Received a shutdown message from our counterparty for channel {}{}.",
4571 log_bytes!(msg.channel_id),
4572 if chan_entry.get().sent_shutdown() { " after we initiated shutdown" } else { "" });
4575 let (shutdown, monitor_update, htlcs) = try_chan_entry!(self, chan_entry.get_mut().shutdown(&self.signer_provider, &peer_state.latest_features, &msg), chan_entry);
4576 dropped_htlcs = htlcs;
4578 // Update the monitor with the shutdown script if necessary.
4579 if let Some(monitor_update) = monitor_update {
4580 let update_res = self.chain_monitor.update_channel(chan_entry.get().get_funding_txo().unwrap(), &monitor_update);
4581 let (result, is_permanent) =
4582 handle_monitor_update_res!(self, update_res, chan_entry.get_mut(), RAACommitmentOrder::CommitmentFirst, chan_entry.key(), NO_UPDATE);
4584 remove_channel!(self, chan_entry);
4589 if let Some(msg) = shutdown {
4590 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
4591 node_id: *counterparty_node_id,
4598 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", counterparty_node_id), msg.channel_id))
4601 for htlc_source in dropped_htlcs.drain(..) {
4602 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id.clone()), channel_id: msg.channel_id };
4603 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
4604 self.fail_htlc_backwards_internal(&htlc_source.0, &htlc_source.1, &reason, receiver);
4607 let _ = handle_error!(self, result, *counterparty_node_id);
4611 fn internal_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<(), MsgHandleErrInternal> {
4612 let per_peer_state = self.per_peer_state.read().unwrap();
4613 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
4614 .ok_or_else(|| MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id))?;
4615 let (tx, chan_option) = {
4616 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4617 let peer_state = &mut *peer_state_lock;
4618 match peer_state.channel_by_id.entry(msg.channel_id.clone()) {
4619 hash_map::Entry::Occupied(mut chan_entry) => {
4620 let (closing_signed, tx) = try_chan_entry!(self, chan_entry.get_mut().closing_signed(&self.fee_estimator, &msg), chan_entry);
4621 if let Some(msg) = closing_signed {
4622 peer_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
4623 node_id: counterparty_node_id.clone(),
4628 // We're done with this channel, we've got a signed closing transaction and
4629 // will send the closing_signed back to the remote peer upon return. This
4630 // also implies there are no pending HTLCs left on the channel, so we can
4631 // fully delete it from tracking (the channel monitor is still around to
4632 // watch for old state broadcasts)!
4633 (tx, Some(remove_channel!(self, chan_entry)))
4634 } else { (tx, None) }
4636 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", counterparty_node_id), msg.channel_id))
4639 if let Some(broadcast_tx) = tx {
4640 log_info!(self.logger, "Broadcasting {}", log_tx!(broadcast_tx));
4641 self.tx_broadcaster.broadcast_transaction(&broadcast_tx);
4643 if let Some(chan) = chan_option {
4644 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
4645 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4646 let peer_state = &mut *peer_state_lock;
4647 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
4651 self.issue_channel_close_events(&chan, ClosureReason::CooperativeClosure);
4656 fn internal_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), MsgHandleErrInternal> {
4657 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
4658 //determine the state of the payment based on our response/if we forward anything/the time
4659 //we take to respond. We should take care to avoid allowing such an attack.
4661 //TODO: There exists a further attack where a node may garble the onion data, forward it to
4662 //us repeatedly garbled in different ways, and compare our error messages, which are
4663 //encrypted with the same key. It's not immediately obvious how to usefully exploit that,
4664 //but we should prevent it anyway.
4666 let pending_forward_info = self.decode_update_add_htlc_onion(msg);
4667 let per_peer_state = self.per_peer_state.read().unwrap();
4668 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
4669 .ok_or_else(|| MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id))?;
4670 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4671 let peer_state = &mut *peer_state_lock;
4672 match peer_state.channel_by_id.entry(msg.channel_id) {
4673 hash_map::Entry::Occupied(mut chan) => {
4675 let create_pending_htlc_status = |chan: &Channel<<SP::Target as SignerProvider>::Signer>, pending_forward_info: PendingHTLCStatus, error_code: u16| {
4676 // If the update_add is completely bogus, the call will Err and we will close,
4677 // but if we've sent a shutdown and they haven't acknowledged it yet, we just
4678 // want to reject the new HTLC and fail it backwards instead of forwarding.
4679 match pending_forward_info {
4680 PendingHTLCStatus::Forward(PendingHTLCInfo { ref incoming_shared_secret, .. }) => {
4681 let reason = if (error_code & 0x1000) != 0 {
4682 let (real_code, error_data) = self.get_htlc_inbound_temp_fail_err_and_data(error_code, chan);
4683 HTLCFailReason::reason(real_code, error_data)
4685 HTLCFailReason::from_failure_code(error_code)
4686 }.get_encrypted_failure_packet(incoming_shared_secret, &None);
4687 let msg = msgs::UpdateFailHTLC {
4688 channel_id: msg.channel_id,
4689 htlc_id: msg.htlc_id,
4692 PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msg))
4694 _ => pending_forward_info
4697 try_chan_entry!(self, chan.get_mut().update_add_htlc(&msg, pending_forward_info, create_pending_htlc_status, &self.logger), chan);
4699 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", counterparty_node_id), msg.channel_id))
4704 fn internal_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), MsgHandleErrInternal> {
4705 let (htlc_source, forwarded_htlc_value) = {
4706 let per_peer_state = self.per_peer_state.read().unwrap();
4707 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
4708 .ok_or_else(|| MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id))?;
4709 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4710 let peer_state = &mut *peer_state_lock;
4711 match peer_state.channel_by_id.entry(msg.channel_id) {
4712 hash_map::Entry::Occupied(mut chan) => {
4713 try_chan_entry!(self, chan.get_mut().update_fulfill_htlc(&msg), chan)
4715 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", counterparty_node_id), msg.channel_id))
4718 self.claim_funds_internal(htlc_source, msg.payment_preimage.clone(), Some(forwarded_htlc_value), false, msg.channel_id);
4722 fn internal_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), MsgHandleErrInternal> {
4723 let per_peer_state = self.per_peer_state.read().unwrap();
4724 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
4725 .ok_or_else(|| MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id))?;
4726 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4727 let peer_state = &mut *peer_state_lock;
4728 match peer_state.channel_by_id.entry(msg.channel_id) {
4729 hash_map::Entry::Occupied(mut chan) => {
4730 try_chan_entry!(self, chan.get_mut().update_fail_htlc(&msg, HTLCFailReason::from_msg(msg)), chan);
4732 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", counterparty_node_id), msg.channel_id))
4737 fn internal_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), MsgHandleErrInternal> {
4738 let per_peer_state = self.per_peer_state.read().unwrap();
4739 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
4740 .ok_or_else(|| MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id))?;
4741 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4742 let peer_state = &mut *peer_state_lock;
4743 match peer_state.channel_by_id.entry(msg.channel_id) {
4744 hash_map::Entry::Occupied(mut chan) => {
4745 if (msg.failure_code & 0x8000) == 0 {
4746 let chan_err: ChannelError = ChannelError::Close("Got update_fail_malformed_htlc with BADONION not set".to_owned());
4747 try_chan_entry!(self, Err(chan_err), chan);
4749 try_chan_entry!(self, chan.get_mut().update_fail_malformed_htlc(&msg, HTLCFailReason::reason(msg.failure_code, msg.sha256_of_onion.to_vec())), chan);
4752 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", counterparty_node_id), msg.channel_id))
4756 fn internal_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), MsgHandleErrInternal> {
4757 let per_peer_state = self.per_peer_state.read().unwrap();
4758 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
4759 .ok_or_else(|| MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id))?;
4760 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4761 let peer_state = &mut *peer_state_lock;
4762 match peer_state.channel_by_id.entry(msg.channel_id) {
4763 hash_map::Entry::Occupied(mut chan) => {
4764 let (revoke_and_ack, commitment_signed, monitor_update) =
4765 match chan.get_mut().commitment_signed(&msg, &self.logger) {
4766 Err((None, e)) => try_chan_entry!(self, Err(e), chan),
4767 Err((Some(update), e)) => {
4768 assert!(chan.get().is_awaiting_monitor_update());
4769 let _ = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), &update);
4770 try_chan_entry!(self, Err(e), chan);
4775 let update_res = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), &monitor_update);
4776 if let Err(e) = handle_monitor_update_res!(self, update_res, chan, RAACommitmentOrder::RevokeAndACKFirst, true, commitment_signed.is_some()) {
4780 peer_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
4781 node_id: counterparty_node_id.clone(),
4782 msg: revoke_and_ack,
4784 if let Some(msg) = commitment_signed {
4785 peer_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
4786 node_id: counterparty_node_id.clone(),
4787 updates: msgs::CommitmentUpdate {
4788 update_add_htlcs: Vec::new(),
4789 update_fulfill_htlcs: Vec::new(),
4790 update_fail_htlcs: Vec::new(),
4791 update_fail_malformed_htlcs: Vec::new(),
4793 commitment_signed: msg,
4799 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", counterparty_node_id), msg.channel_id))
4804 fn forward_htlcs(&self, per_source_pending_forwards: &mut [(u64, OutPoint, u128, Vec<(PendingHTLCInfo, u64)>)]) {
4805 for &mut (prev_short_channel_id, prev_funding_outpoint, prev_user_channel_id, ref mut pending_forwards) in per_source_pending_forwards {
4806 let mut forward_event = None;
4807 let mut new_intercept_events = Vec::new();
4808 let mut failed_intercept_forwards = Vec::new();
4809 if !pending_forwards.is_empty() {
4810 for (forward_info, prev_htlc_id) in pending_forwards.drain(..) {
4811 let scid = match forward_info.routing {
4812 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
4813 PendingHTLCRouting::Receive { .. } => 0,
4814 PendingHTLCRouting::ReceiveKeysend { .. } => 0,
4816 // Pull this now to avoid introducing a lock order with `forward_htlcs`.
4817 let is_our_scid = self.short_to_chan_info.read().unwrap().contains_key(&scid);
4819 let mut forward_htlcs = self.forward_htlcs.lock().unwrap();
4820 let forward_htlcs_empty = forward_htlcs.is_empty();
4821 match forward_htlcs.entry(scid) {
4822 hash_map::Entry::Occupied(mut entry) => {
4823 entry.get_mut().push(HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
4824 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info }));
4826 hash_map::Entry::Vacant(entry) => {
4827 if !is_our_scid && forward_info.incoming_amt_msat.is_some() &&
4828 fake_scid::is_valid_intercept(&self.fake_scid_rand_bytes, scid, &self.genesis_hash)
4830 let intercept_id = InterceptId(Sha256::hash(&forward_info.incoming_shared_secret).into_inner());
4831 let mut pending_intercepts = self.pending_intercepted_htlcs.lock().unwrap();
4832 match pending_intercepts.entry(intercept_id) {
4833 hash_map::Entry::Vacant(entry) => {
4834 new_intercept_events.push(events::Event::HTLCIntercepted {
4835 requested_next_hop_scid: scid,
4836 payment_hash: forward_info.payment_hash,
4837 inbound_amount_msat: forward_info.incoming_amt_msat.unwrap(),
4838 expected_outbound_amount_msat: forward_info.outgoing_amt_msat,
4841 entry.insert(PendingAddHTLCInfo {
4842 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info });
4844 hash_map::Entry::Occupied(_) => {
4845 log_info!(self.logger, "Failed to forward incoming HTLC: detected duplicate intercepted payment over short channel id {}", scid);
4846 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
4847 short_channel_id: prev_short_channel_id,
4848 outpoint: prev_funding_outpoint,
4849 htlc_id: prev_htlc_id,
4850 incoming_packet_shared_secret: forward_info.incoming_shared_secret,
4851 phantom_shared_secret: None,
4854 failed_intercept_forwards.push((htlc_source, forward_info.payment_hash,
4855 HTLCFailReason::from_failure_code(0x4000 | 10),
4856 HTLCDestination::InvalidForward { requested_forward_scid: scid },
4861 // We don't want to generate a PendingHTLCsForwardable event if only intercepted
4862 // payments are being processed.
4863 if forward_htlcs_empty {
4864 forward_event = Some(Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS));
4866 entry.insert(vec!(HTLCForwardInfo::AddHTLC(PendingAddHTLCInfo {
4867 prev_short_channel_id, prev_funding_outpoint, prev_htlc_id, prev_user_channel_id, forward_info })));
4874 for (htlc_source, payment_hash, failure_reason, destination) in failed_intercept_forwards.drain(..) {
4875 self.fail_htlc_backwards_internal(&htlc_source, &payment_hash, &failure_reason, destination);
4878 if !new_intercept_events.is_empty() {
4879 let mut events = self.pending_events.lock().unwrap();
4880 events.append(&mut new_intercept_events);
4883 match forward_event {
4885 let mut pending_events = self.pending_events.lock().unwrap();
4886 pending_events.push(events::Event::PendingHTLCsForwardable {
4887 time_forwardable: time
4895 fn internal_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), MsgHandleErrInternal> {
4896 let mut htlcs_to_fail = Vec::new();
4898 let per_peer_state = self.per_peer_state.read().unwrap();
4899 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
4900 .ok_or_else(|| MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id))?;
4901 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4902 let peer_state = &mut *peer_state_lock;
4903 match peer_state.channel_by_id.entry(msg.channel_id) {
4904 hash_map::Entry::Occupied(mut chan) => {
4905 let was_paused_for_mon_update = chan.get().is_awaiting_monitor_update();
4906 let raa_updates = break_chan_entry!(self,
4907 chan.get_mut().revoke_and_ack(&msg, &self.logger), chan);
4908 htlcs_to_fail = raa_updates.holding_cell_failed_htlcs;
4909 let update_res = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), &raa_updates.monitor_update);
4910 if was_paused_for_mon_update {
4911 assert!(update_res != ChannelMonitorUpdateStatus::Completed);
4912 assert!(raa_updates.commitment_update.is_none());
4913 assert!(raa_updates.accepted_htlcs.is_empty());
4914 assert!(raa_updates.failed_htlcs.is_empty());
4915 assert!(raa_updates.finalized_claimed_htlcs.is_empty());
4916 break Err(MsgHandleErrInternal::ignore_no_close("Existing pending monitor update prevented responses to RAA".to_owned()));
4918 if update_res != ChannelMonitorUpdateStatus::Completed {
4919 if let Err(e) = handle_monitor_update_res!(self, update_res, chan,
4920 RAACommitmentOrder::CommitmentFirst, false,
4921 raa_updates.commitment_update.is_some(), false,
4922 raa_updates.accepted_htlcs, raa_updates.failed_htlcs,
4923 raa_updates.finalized_claimed_htlcs) {
4925 } else { unreachable!(); }
4927 if let Some(updates) = raa_updates.commitment_update {
4928 peer_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
4929 node_id: counterparty_node_id.clone(),
4933 break Ok((raa_updates.accepted_htlcs, raa_updates.failed_htlcs,
4934 raa_updates.finalized_claimed_htlcs,
4935 chan.get().get_short_channel_id()
4936 .unwrap_or(chan.get().outbound_scid_alias()),
4937 chan.get().get_funding_txo().unwrap(),
4938 chan.get().get_user_id()))
4940 hash_map::Entry::Vacant(_) => break Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", counterparty_node_id), msg.channel_id))
4943 self.fail_holding_cell_htlcs(htlcs_to_fail, msg.channel_id, counterparty_node_id);
4945 Ok((pending_forwards, mut pending_failures, finalized_claim_htlcs,
4946 short_channel_id, channel_outpoint, user_channel_id)) =>
4948 for failure in pending_failures.drain(..) {
4949 let receiver = HTLCDestination::NextHopChannel { node_id: Some(*counterparty_node_id), channel_id: channel_outpoint.to_channel_id() };
4950 self.fail_htlc_backwards_internal(&failure.0, &failure.1, &failure.2, receiver);
4952 self.forward_htlcs(&mut [(short_channel_id, channel_outpoint, user_channel_id, pending_forwards)]);
4953 self.finalize_claims(finalized_claim_htlcs);
4960 fn internal_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), MsgHandleErrInternal> {
4961 let per_peer_state = self.per_peer_state.read().unwrap();
4962 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
4963 .ok_or_else(|| MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id))?;
4964 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4965 let peer_state = &mut *peer_state_lock;
4966 match peer_state.channel_by_id.entry(msg.channel_id) {
4967 hash_map::Entry::Occupied(mut chan) => {
4968 try_chan_entry!(self, chan.get_mut().update_fee(&self.fee_estimator, &msg, &self.logger), chan);
4970 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", counterparty_node_id), msg.channel_id))
4975 fn internal_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), MsgHandleErrInternal> {
4976 let per_peer_state = self.per_peer_state.read().unwrap();
4977 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
4978 .ok_or_else(|| MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id))?;
4979 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4980 let peer_state = &mut *peer_state_lock;
4981 match peer_state.channel_by_id.entry(msg.channel_id) {
4982 hash_map::Entry::Occupied(mut chan) => {
4983 if !chan.get().is_usable() {
4984 return Err(MsgHandleErrInternal::from_no_close(LightningError{err: "Got an announcement_signatures before we were ready for it".to_owned(), action: msgs::ErrorAction::IgnoreError}));
4987 peer_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
4988 msg: try_chan_entry!(self, chan.get_mut().announcement_signatures(
4989 &self.node_signer, self.genesis_hash.clone(), self.best_block.read().unwrap().height(),
4990 msg, &self.default_configuration
4992 // Note that announcement_signatures fails if the channel cannot be announced,
4993 // so get_channel_update_for_broadcast will never fail by the time we get here.
4994 update_msg: self.get_channel_update_for_broadcast(chan.get()).unwrap(),
4997 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", counterparty_node_id), msg.channel_id))
5002 /// Returns ShouldPersist if anything changed, otherwise either SkipPersist or an Err.
5003 fn internal_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) -> Result<NotifyOption, MsgHandleErrInternal> {
5004 let (chan_counterparty_node_id, chan_id) = match self.short_to_chan_info.read().unwrap().get(&msg.contents.short_channel_id) {
5005 Some((cp_id, chan_id)) => (cp_id.clone(), chan_id.clone()),
5007 // It's not a local channel
5008 return Ok(NotifyOption::SkipPersist)
5011 let per_peer_state = self.per_peer_state.read().unwrap();
5012 let peer_state_mutex_opt = per_peer_state.get(&chan_counterparty_node_id);
5013 if peer_state_mutex_opt.is_none() {
5014 return Ok(NotifyOption::SkipPersist)
5016 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
5017 let peer_state = &mut *peer_state_lock;
5018 match peer_state.channel_by_id.entry(chan_id) {
5019 hash_map::Entry::Occupied(mut chan) => {
5020 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
5021 if chan.get().should_announce() {
5022 // If the announcement is about a channel of ours which is public, some
5023 // other peer may simply be forwarding all its gossip to us. Don't provide
5024 // a scary-looking error message and return Ok instead.
5025 return Ok(NotifyOption::SkipPersist);
5027 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));
5029 let were_node_one = self.get_our_node_id().serialize()[..] < chan.get().get_counterparty_node_id().serialize()[..];
5030 let msg_from_node_one = msg.contents.flags & 1 == 0;
5031 if were_node_one == msg_from_node_one {
5032 return Ok(NotifyOption::SkipPersist);
5034 log_debug!(self.logger, "Received channel_update for channel {}.", log_bytes!(chan_id));
5035 try_chan_entry!(self, chan.get_mut().channel_update(&msg), chan);
5038 hash_map::Entry::Vacant(_) => return Ok(NotifyOption::SkipPersist)
5040 Ok(NotifyOption::DoPersist)
5043 fn internal_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<(), MsgHandleErrInternal> {
5045 let need_lnd_workaround = {
5046 let per_peer_state = self.per_peer_state.read().unwrap();
5048 let peer_state_mutex = per_peer_state.get(counterparty_node_id)
5049 .ok_or_else(|| MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.channel_id))?;
5050 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5051 let peer_state = &mut *peer_state_lock;
5052 match peer_state.channel_by_id.entry(msg.channel_id) {
5053 hash_map::Entry::Occupied(mut chan) => {
5054 // Currently, we expect all holding cell update_adds to be dropped on peer
5055 // disconnect, so Channel's reestablish will never hand us any holding cell
5056 // freed HTLCs to fail backwards. If in the future we no longer drop pending
5057 // add-HTLCs on disconnect, we may be handed HTLCs to fail backwards here.
5058 let responses = try_chan_entry!(self, chan.get_mut().channel_reestablish(
5059 msg, &self.logger, &self.node_signer, self.genesis_hash,
5060 &self.default_configuration, &*self.best_block.read().unwrap()), chan);
5061 let mut channel_update = None;
5062 if let Some(msg) = responses.shutdown_msg {
5063 peer_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
5064 node_id: counterparty_node_id.clone(),
5067 } else if chan.get().is_usable() {
5068 // If the channel is in a usable state (ie the channel is not being shut
5069 // down), send a unicast channel_update to our counterparty to make sure
5070 // they have the latest channel parameters.
5071 if let Ok(msg) = self.get_channel_update_for_unicast(chan.get()) {
5072 channel_update = Some(events::MessageSendEvent::SendChannelUpdate {
5073 node_id: chan.get().get_counterparty_node_id(),
5078 let need_lnd_workaround = chan.get_mut().workaround_lnd_bug_4006.take();
5079 htlc_forwards = self.handle_channel_resumption(
5080 &mut peer_state.pending_msg_events, chan.get_mut(), responses.raa, responses.commitment_update, responses.order,
5081 Vec::new(), None, responses.channel_ready, responses.announcement_sigs);
5082 if let Some(upd) = channel_update {
5083 peer_state.pending_msg_events.push(upd);
5087 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", counterparty_node_id), msg.channel_id))
5091 if let Some(forwards) = htlc_forwards {
5092 self.forward_htlcs(&mut [forwards][..]);
5095 if let Some(channel_ready_msg) = need_lnd_workaround {
5096 self.internal_channel_ready(counterparty_node_id, &channel_ready_msg)?;
5101 /// Process pending events from the `chain::Watch`, returning whether any events were processed.
5102 fn process_pending_monitor_events(&self) -> bool {
5103 let mut failed_channels = Vec::new();
5104 let mut pending_monitor_events = self.chain_monitor.release_pending_monitor_events();
5105 let has_pending_monitor_events = !pending_monitor_events.is_empty();
5106 for (funding_outpoint, mut monitor_events, counterparty_node_id) in pending_monitor_events.drain(..) {
5107 for monitor_event in monitor_events.drain(..) {
5108 match monitor_event {
5109 MonitorEvent::HTLCEvent(htlc_update) => {
5110 if let Some(preimage) = htlc_update.payment_preimage {
5111 log_trace!(self.logger, "Claiming HTLC with preimage {} from our monitor", log_bytes!(preimage.0));
5112 self.claim_funds_internal(htlc_update.source, preimage, htlc_update.htlc_value_satoshis.map(|v| v * 1000), true, funding_outpoint.to_channel_id());
5114 log_trace!(self.logger, "Failing HTLC with hash {} from our monitor", log_bytes!(htlc_update.payment_hash.0));
5115 let receiver = HTLCDestination::NextHopChannel { node_id: counterparty_node_id, channel_id: funding_outpoint.to_channel_id() };
5116 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
5117 self.fail_htlc_backwards_internal(&htlc_update.source, &htlc_update.payment_hash, &reason, receiver);
5120 MonitorEvent::CommitmentTxConfirmed(funding_outpoint) |
5121 MonitorEvent::UpdateFailed(funding_outpoint) => {
5122 let counterparty_node_id_opt = match counterparty_node_id {
5123 Some(cp_id) => Some(cp_id),
5125 // TODO: Once we can rely on the counterparty_node_id from the
5126 // monitor event, this and the id_to_peer map should be removed.
5127 let id_to_peer = self.id_to_peer.lock().unwrap();
5128 id_to_peer.get(&funding_outpoint.to_channel_id()).cloned()
5131 if let Some(counterparty_node_id) = counterparty_node_id_opt {
5132 let per_peer_state = self.per_peer_state.read().unwrap();
5133 if let Some(peer_state_mutex) = per_peer_state.get(&counterparty_node_id) {
5134 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5135 let peer_state = &mut *peer_state_lock;
5136 let pending_msg_events = &mut peer_state.pending_msg_events;
5137 if let hash_map::Entry::Occupied(chan_entry) = peer_state.channel_by_id.entry(funding_outpoint.to_channel_id()) {
5138 let mut chan = remove_channel!(self, chan_entry);
5139 failed_channels.push(chan.force_shutdown(false));
5140 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
5141 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
5145 let reason = if let MonitorEvent::UpdateFailed(_) = monitor_event {
5146 ClosureReason::ProcessingError { err: "Failed to persist ChannelMonitor update during chain sync".to_string() }
5148 ClosureReason::CommitmentTxConfirmed
5150 self.issue_channel_close_events(&chan, reason);
5151 pending_msg_events.push(events::MessageSendEvent::HandleError {
5152 node_id: chan.get_counterparty_node_id(),
5153 action: msgs::ErrorAction::SendErrorMessage {
5154 msg: msgs::ErrorMessage { channel_id: chan.channel_id(), data: "Channel force-closed".to_owned() }
5161 MonitorEvent::Completed { funding_txo, monitor_update_id } => {
5162 self.channel_monitor_updated(&funding_txo, monitor_update_id, counterparty_node_id.as_ref());
5168 for failure in failed_channels.drain(..) {
5169 self.finish_force_close_channel(failure);
5172 has_pending_monitor_events
5175 /// In chanmon_consistency_target, we'd like to be able to restore monitor updating without
5176 /// handling all pending events (i.e. not PendingHTLCsForwardable). Thus, we expose monitor
5177 /// update events as a separate process method here.
5179 pub fn process_monitor_events(&self) {
5180 self.process_pending_monitor_events();
5183 /// Check the holding cell in each channel and free any pending HTLCs in them if possible.
5184 /// Returns whether there were any updates such as if pending HTLCs were freed or a monitor
5185 /// update was applied.
5186 fn check_free_holding_cells(&self) -> bool {
5187 let mut has_monitor_update = false;
5188 let mut failed_htlcs = Vec::new();
5189 let mut handle_errors = Vec::new();
5191 let per_peer_state = self.per_peer_state.read().unwrap();
5193 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
5194 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5195 let peer_state = &mut *peer_state_lock;
5196 let pending_msg_events = &mut peer_state.pending_msg_events;
5197 peer_state.channel_by_id.retain(|channel_id, chan| {
5198 match chan.maybe_free_holding_cell_htlcs(&self.logger) {
5199 Ok((commitment_opt, holding_cell_failed_htlcs)) => {
5200 if !holding_cell_failed_htlcs.is_empty() {
5202 holding_cell_failed_htlcs,
5204 chan.get_counterparty_node_id()
5207 if let Some((commitment_update, monitor_update)) = commitment_opt {
5208 match self.chain_monitor.update_channel(chan.get_funding_txo().unwrap(), &monitor_update) {
5209 ChannelMonitorUpdateStatus::Completed => {
5210 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
5211 node_id: chan.get_counterparty_node_id(),
5212 updates: commitment_update,
5216 has_monitor_update = true;
5217 let (res, close_channel) = handle_monitor_update_res!(self, e, chan, RAACommitmentOrder::CommitmentFirst, channel_id, COMMITMENT_UPDATE_ONLY);
5218 handle_errors.push((chan.get_counterparty_node_id(), res));
5219 if close_channel { return false; }
5226 let (close_channel, res) = convert_chan_err!(self, e, chan, channel_id);
5227 handle_errors.push((chan.get_counterparty_node_id(), Err(res)));
5228 // ChannelClosed event is generated by handle_error for us
5236 let has_update = has_monitor_update || !failed_htlcs.is_empty() || !handle_errors.is_empty();
5237 for (failures, channel_id, counterparty_node_id) in failed_htlcs.drain(..) {
5238 self.fail_holding_cell_htlcs(failures, channel_id, &counterparty_node_id);
5241 for (counterparty_node_id, err) in handle_errors.drain(..) {
5242 let _ = handle_error!(self, err, counterparty_node_id);
5248 /// Check whether any channels have finished removing all pending updates after a shutdown
5249 /// exchange and can now send a closing_signed.
5250 /// Returns whether any closing_signed messages were generated.
5251 fn maybe_generate_initial_closing_signed(&self) -> bool {
5252 let mut handle_errors: Vec<(PublicKey, Result<(), _>)> = Vec::new();
5253 let mut has_update = false;
5255 let per_peer_state = self.per_peer_state.read().unwrap();
5257 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
5258 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5259 let peer_state = &mut *peer_state_lock;
5260 let pending_msg_events = &mut peer_state.pending_msg_events;
5261 peer_state.channel_by_id.retain(|channel_id, chan| {
5262 match chan.maybe_propose_closing_signed(&self.fee_estimator, &self.logger) {
5263 Ok((msg_opt, tx_opt)) => {
5264 if let Some(msg) = msg_opt {
5266 pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
5267 node_id: chan.get_counterparty_node_id(), msg,
5270 if let Some(tx) = tx_opt {
5271 // We're done with this channel. We got a closing_signed and sent back
5272 // a closing_signed with a closing transaction to broadcast.
5273 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
5274 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
5279 self.issue_channel_close_events(chan, ClosureReason::CooperativeClosure);
5281 log_info!(self.logger, "Broadcasting {}", log_tx!(tx));
5282 self.tx_broadcaster.broadcast_transaction(&tx);
5283 update_maps_on_chan_removal!(self, chan);
5289 let (close_channel, res) = convert_chan_err!(self, e, chan, channel_id);
5290 handle_errors.push((chan.get_counterparty_node_id(), Err(res)));
5298 for (counterparty_node_id, err) in handle_errors.drain(..) {
5299 let _ = handle_error!(self, err, counterparty_node_id);
5305 /// Handle a list of channel failures during a block_connected or block_disconnected call,
5306 /// pushing the channel monitor update (if any) to the background events queue and removing the
5308 fn handle_init_event_channel_failures(&self, mut failed_channels: Vec<ShutdownResult>) {
5309 for mut failure in failed_channels.drain(..) {
5310 // Either a commitment transactions has been confirmed on-chain or
5311 // Channel::block_disconnected detected that the funding transaction has been
5312 // reorganized out of the main chain.
5313 // We cannot broadcast our latest local state via monitor update (as
5314 // Channel::force_shutdown tries to make us do) as we may still be in initialization,
5315 // so we track the update internally and handle it when the user next calls
5316 // timer_tick_occurred, guaranteeing we're running normally.
5317 if let Some((funding_txo, update)) = failure.0.take() {
5318 assert_eq!(update.updates.len(), 1);
5319 if let ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } = update.updates[0] {
5320 assert!(should_broadcast);
5321 } else { unreachable!(); }
5322 self.pending_background_events.lock().unwrap().push(BackgroundEvent::ClosingMonitorUpdate((funding_txo, update)));
5324 self.finish_force_close_channel(failure);
5328 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> {
5329 assert!(invoice_expiry_delta_secs <= 60*60*24*365); // Sadly bitcoin timestamps are u32s, so panic before 2106
5331 if min_value_msat.is_some() && min_value_msat.unwrap() > MAX_VALUE_MSAT {
5332 return Err(APIError::APIMisuseError { err: format!("min_value_msat of {} greater than total 21 million bitcoin supply", min_value_msat.unwrap()) });
5335 let payment_secret = PaymentSecret(self.entropy_source.get_secure_random_bytes());
5337 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5338 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
5339 match payment_secrets.entry(payment_hash) {
5340 hash_map::Entry::Vacant(e) => {
5341 e.insert(PendingInboundPayment {
5342 payment_secret, min_value_msat, payment_preimage,
5343 user_payment_id: 0, // For compatibility with version 0.0.103 and earlier
5344 // We assume that highest_seen_timestamp is pretty close to the current time -
5345 // it's updated when we receive a new block with the maximum time we've seen in
5346 // a header. It should never be more than two hours in the future.
5347 // Thus, we add two hours here as a buffer to ensure we absolutely
5348 // never fail a payment too early.
5349 // Note that we assume that received blocks have reasonably up-to-date
5351 expiry_time: self.highest_seen_timestamp.load(Ordering::Acquire) as u64 + invoice_expiry_delta_secs as u64 + 7200,
5354 hash_map::Entry::Occupied(_) => return Err(APIError::APIMisuseError { err: "Duplicate payment hash".to_owned() }),
5359 /// Gets a payment secret and payment hash for use in an invoice given to a third party wishing
5362 /// This differs from [`create_inbound_payment_for_hash`] only in that it generates the
5363 /// [`PaymentHash`] and [`PaymentPreimage`] for you.
5365 /// The [`PaymentPreimage`] will ultimately be returned to you in the [`PaymentClaimable`], which
5366 /// will have the [`PaymentClaimable::payment_preimage`] field filled in. That should then be
5367 /// passed directly to [`claim_funds`].
5369 /// See [`create_inbound_payment_for_hash`] for detailed documentation on behavior and requirements.
5371 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
5372 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
5376 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
5377 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
5379 /// Errors if `min_value_msat` is greater than total bitcoin supply.
5381 /// If `min_final_cltv_expiry_delta` is set to some value, then the payment will not be receivable
5382 /// on versions of LDK prior to 0.0.114.
5384 /// [`claim_funds`]: Self::claim_funds
5385 /// [`PaymentClaimable`]: events::Event::PaymentClaimable
5386 /// [`PaymentClaimable::payment_preimage`]: events::Event::PaymentClaimable::payment_preimage
5387 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
5388 pub fn create_inbound_payment(&self, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32,
5389 min_final_cltv_expiry_delta: Option<u16>) -> Result<(PaymentHash, PaymentSecret), ()> {
5390 inbound_payment::create(&self.inbound_payment_key, min_value_msat, invoice_expiry_delta_secs,
5391 &self.entropy_source, self.highest_seen_timestamp.load(Ordering::Acquire) as u64,
5392 min_final_cltv_expiry_delta)
5395 /// Legacy version of [`create_inbound_payment`]. Use this method if you wish to share
5396 /// serialized state with LDK node(s) running 0.0.103 and earlier.
5398 /// May panic if `invoice_expiry_delta_secs` is greater than one year.
5401 /// This method is deprecated and will be removed soon.
5403 /// [`create_inbound_payment`]: Self::create_inbound_payment
5405 pub fn create_inbound_payment_legacy(&self, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32) -> Result<(PaymentHash, PaymentSecret), APIError> {
5406 let payment_preimage = PaymentPreimage(self.entropy_source.get_secure_random_bytes());
5407 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
5408 let payment_secret = self.set_payment_hash_secret_map(payment_hash, Some(payment_preimage), min_value_msat, invoice_expiry_delta_secs)?;
5409 Ok((payment_hash, payment_secret))
5412 /// Gets a [`PaymentSecret`] for a given [`PaymentHash`], for which the payment preimage is
5413 /// stored external to LDK.
5415 /// A [`PaymentClaimable`] event will only be generated if the [`PaymentSecret`] matches a
5416 /// payment secret fetched via this method or [`create_inbound_payment`], and which is at least
5417 /// the `min_value_msat` provided here, if one is provided.
5419 /// The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) should be globally unique, though
5420 /// note that LDK will not stop you from registering duplicate payment hashes for inbound
5423 /// `min_value_msat` should be set if the invoice being generated contains a value. Any payment
5424 /// received for the returned [`PaymentHash`] will be required to be at least `min_value_msat`
5425 /// before a [`PaymentClaimable`] event will be generated, ensuring that we do not provide the
5426 /// sender "proof-of-payment" unless they have paid the required amount.
5428 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
5429 /// in excess of the current time. This should roughly match the expiry time set in the invoice.
5430 /// After this many seconds, we will remove the inbound payment, resulting in any attempts to
5431 /// pay the invoice failing. The BOLT spec suggests 3,600 secs as a default validity time for
5432 /// invoices when no timeout is set.
5434 /// Note that we use block header time to time-out pending inbound payments (with some margin
5435 /// to compensate for the inaccuracy of block header timestamps). Thus, in practice we will
5436 /// accept a payment and generate a [`PaymentClaimable`] event for some time after the expiry.
5437 /// If you need exact expiry semantics, you should enforce them upon receipt of
5438 /// [`PaymentClaimable`].
5440 /// Note that invoices generated for inbound payments should have their `min_final_cltv_expiry_delta`
5441 /// set to at least [`MIN_FINAL_CLTV_EXPIRY_DELTA`].
5443 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
5444 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
5448 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
5449 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
5451 /// Errors if `min_value_msat` is greater than total bitcoin supply.
5453 /// If `min_final_cltv_expiry_delta` is set to some value, then the payment will not be receivable
5454 /// on versions of LDK prior to 0.0.114.
5456 /// [`create_inbound_payment`]: Self::create_inbound_payment
5457 /// [`PaymentClaimable`]: events::Event::PaymentClaimable
5458 pub fn create_inbound_payment_for_hash(&self, payment_hash: PaymentHash, min_value_msat: Option<u64>,
5459 invoice_expiry_delta_secs: u32, min_final_cltv_expiry: Option<u16>) -> Result<PaymentSecret, ()> {
5460 inbound_payment::create_from_hash(&self.inbound_payment_key, min_value_msat, payment_hash,
5461 invoice_expiry_delta_secs, self.highest_seen_timestamp.load(Ordering::Acquire) as u64,
5462 min_final_cltv_expiry)
5465 /// Legacy version of [`create_inbound_payment_for_hash`]. Use this method if you wish to share
5466 /// serialized state with LDK node(s) running 0.0.103 and earlier.
5468 /// May panic if `invoice_expiry_delta_secs` is greater than one year.
5471 /// This method is deprecated and will be removed soon.
5473 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
5475 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> {
5476 self.set_payment_hash_secret_map(payment_hash, None, min_value_msat, invoice_expiry_delta_secs)
5479 /// Gets an LDK-generated payment preimage from a payment hash and payment secret that were
5480 /// previously returned from [`create_inbound_payment`].
5482 /// [`create_inbound_payment`]: Self::create_inbound_payment
5483 pub fn get_payment_preimage(&self, payment_hash: PaymentHash, payment_secret: PaymentSecret) -> Result<PaymentPreimage, APIError> {
5484 inbound_payment::get_payment_preimage(payment_hash, payment_secret, &self.inbound_payment_key)
5487 /// Gets a fake short channel id for use in receiving [phantom node payments]. These fake scids
5488 /// are used when constructing the phantom invoice's route hints.
5490 /// [phantom node payments]: crate::chain::keysinterface::PhantomKeysManager
5491 pub fn get_phantom_scid(&self) -> u64 {
5492 let best_block_height = self.best_block.read().unwrap().height();
5493 let short_to_chan_info = self.short_to_chan_info.read().unwrap();
5495 let scid_candidate = fake_scid::Namespace::Phantom.get_fake_scid(best_block_height, &self.genesis_hash, &self.fake_scid_rand_bytes, &self.entropy_source);
5496 // Ensure the generated scid doesn't conflict with a real channel.
5497 match short_to_chan_info.get(&scid_candidate) {
5498 Some(_) => continue,
5499 None => return scid_candidate
5504 /// Gets route hints for use in receiving [phantom node payments].
5506 /// [phantom node payments]: crate::chain::keysinterface::PhantomKeysManager
5507 pub fn get_phantom_route_hints(&self) -> PhantomRouteHints {
5509 channels: self.list_usable_channels(),
5510 phantom_scid: self.get_phantom_scid(),
5511 real_node_pubkey: self.get_our_node_id(),
5515 /// Gets a fake short channel id for use in receiving intercepted payments. These fake scids are
5516 /// used when constructing the route hints for HTLCs intended to be intercepted. See
5517 /// [`ChannelManager::forward_intercepted_htlc`].
5519 /// Note that this method is not guaranteed to return unique values, you may need to call it a few
5520 /// times to get a unique scid.
5521 pub fn get_intercept_scid(&self) -> u64 {
5522 let best_block_height = self.best_block.read().unwrap().height();
5523 let short_to_chan_info = self.short_to_chan_info.read().unwrap();
5525 let scid_candidate = fake_scid::Namespace::Intercept.get_fake_scid(best_block_height, &self.genesis_hash, &self.fake_scid_rand_bytes, &self.entropy_source);
5526 // Ensure the generated scid doesn't conflict with a real channel.
5527 if short_to_chan_info.contains_key(&scid_candidate) { continue }
5528 return scid_candidate
5532 /// Gets inflight HTLC information by processing pending outbound payments that are in
5533 /// our channels. May be used during pathfinding to account for in-use channel liquidity.
5534 pub fn compute_inflight_htlcs(&self) -> InFlightHtlcs {
5535 let mut inflight_htlcs = InFlightHtlcs::new();
5537 let per_peer_state = self.per_peer_state.read().unwrap();
5538 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
5539 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5540 let peer_state = &mut *peer_state_lock;
5541 for chan in peer_state.channel_by_id.values() {
5542 for (htlc_source, _) in chan.inflight_htlc_sources() {
5543 if let HTLCSource::OutboundRoute { path, .. } = htlc_source {
5544 inflight_htlcs.process_path(path, self.get_our_node_id());
5553 #[cfg(any(test, fuzzing, feature = "_test_utils"))]
5554 pub fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
5555 let events = core::cell::RefCell::new(Vec::new());
5556 let event_handler = |event: events::Event| events.borrow_mut().push(event);
5557 self.process_pending_events(&event_handler);
5561 #[cfg(feature = "_test_utils")]
5562 pub fn push_pending_event(&self, event: events::Event) {
5563 let mut events = self.pending_events.lock().unwrap();
5568 pub fn pop_pending_event(&self) -> Option<events::Event> {
5569 let mut events = self.pending_events.lock().unwrap();
5570 if events.is_empty() { None } else { Some(events.remove(0)) }
5574 pub fn has_pending_payments(&self) -> bool {
5575 self.pending_outbound_payments.has_pending_payments()
5579 pub fn clear_pending_payments(&self) {
5580 self.pending_outbound_payments.clear_pending_payments()
5583 /// Processes any events asynchronously in the order they were generated since the last call
5584 /// using the given event handler.
5586 /// See the trait-level documentation of [`EventsProvider`] for requirements.
5587 pub async fn process_pending_events_async<Future: core::future::Future, H: Fn(Event) -> Future>(
5590 // We'll acquire our total consistency lock until the returned future completes so that
5591 // we can be sure no other persists happen while processing events.
5592 let _read_guard = self.total_consistency_lock.read().unwrap();
5594 let mut result = NotifyOption::SkipPersist;
5596 // TODO: This behavior should be documented. It's unintuitive that we query
5597 // ChannelMonitors when clearing other events.
5598 if self.process_pending_monitor_events() {
5599 result = NotifyOption::DoPersist;
5602 let pending_events = mem::replace(&mut *self.pending_events.lock().unwrap(), vec![]);
5603 if !pending_events.is_empty() {
5604 result = NotifyOption::DoPersist;
5607 for event in pending_events {
5608 handler(event).await;
5611 if result == NotifyOption::DoPersist {
5612 self.persistence_notifier.notify();
5617 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref> MessageSendEventsProvider for ChannelManager<M, T, ES, NS, SP, F, R, L>
5619 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
5620 T::Target: BroadcasterInterface,
5621 ES::Target: EntropySource,
5622 NS::Target: NodeSigner,
5623 SP::Target: SignerProvider,
5624 F::Target: FeeEstimator,
5628 /// Returns `MessageSendEvent`s strictly ordered per-peer, in the order they were generated.
5629 /// The returned array will contain `MessageSendEvent`s for different peers if
5630 /// `MessageSendEvent`s to more than one peer exists, but `MessageSendEvent`s to the same peer
5631 /// is always placed next to each other.
5633 /// Note that that while `MessageSendEvent`s are strictly ordered per-peer, the peer order for
5634 /// the chunks of `MessageSendEvent`s for different peers is random. I.e. if the array contains
5635 /// `MessageSendEvent`s for both `node_a` and `node_b`, the `MessageSendEvent`s for `node_a`
5636 /// will randomly be placed first or last in the returned array.
5638 /// Note that even though `BroadcastChannelAnnouncement` and `BroadcastChannelUpdate`
5639 /// `MessageSendEvent`s are intended to be broadcasted to all peers, they will be pleaced among
5640 /// the `MessageSendEvent`s to the specific peer they were generated under.
5641 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
5642 let events = RefCell::new(Vec::new());
5643 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
5644 let mut result = NotifyOption::SkipPersist;
5646 // TODO: This behavior should be documented. It's unintuitive that we query
5647 // ChannelMonitors when clearing other events.
5648 if self.process_pending_monitor_events() {
5649 result = NotifyOption::DoPersist;
5652 if self.check_free_holding_cells() {
5653 result = NotifyOption::DoPersist;
5655 if self.maybe_generate_initial_closing_signed() {
5656 result = NotifyOption::DoPersist;
5659 let mut pending_events = Vec::new();
5660 let per_peer_state = self.per_peer_state.read().unwrap();
5661 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
5662 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5663 let peer_state = &mut *peer_state_lock;
5664 if peer_state.pending_msg_events.len() > 0 {
5665 pending_events.append(&mut peer_state.pending_msg_events);
5669 if !pending_events.is_empty() {
5670 events.replace(pending_events);
5679 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref> EventsProvider for ChannelManager<M, T, ES, NS, SP, F, R, L>
5681 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
5682 T::Target: BroadcasterInterface,
5683 ES::Target: EntropySource,
5684 NS::Target: NodeSigner,
5685 SP::Target: SignerProvider,
5686 F::Target: FeeEstimator,
5690 /// Processes events that must be periodically handled.
5692 /// An [`EventHandler`] may safely call back to the provider in order to handle an event.
5693 /// However, it must not call [`Writeable::write`] as doing so would result in a deadlock.
5694 fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler {
5695 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
5696 let mut result = NotifyOption::SkipPersist;
5698 // TODO: This behavior should be documented. It's unintuitive that we query
5699 // ChannelMonitors when clearing other events.
5700 if self.process_pending_monitor_events() {
5701 result = NotifyOption::DoPersist;
5704 let pending_events = mem::replace(&mut *self.pending_events.lock().unwrap(), vec![]);
5705 if !pending_events.is_empty() {
5706 result = NotifyOption::DoPersist;
5709 for event in pending_events {
5710 handler.handle_event(event);
5718 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref> chain::Listen for ChannelManager<M, T, ES, NS, SP, F, R, L>
5720 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
5721 T::Target: BroadcasterInterface,
5722 ES::Target: EntropySource,
5723 NS::Target: NodeSigner,
5724 SP::Target: SignerProvider,
5725 F::Target: FeeEstimator,
5729 fn filtered_block_connected(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
5731 let best_block = self.best_block.read().unwrap();
5732 assert_eq!(best_block.block_hash(), header.prev_blockhash,
5733 "Blocks must be connected in chain-order - the connected header must build on the last connected header");
5734 assert_eq!(best_block.height(), height - 1,
5735 "Blocks must be connected in chain-order - the connected block height must be one greater than the previous height");
5738 self.transactions_confirmed(header, txdata, height);
5739 self.best_block_updated(header, height);
5742 fn block_disconnected(&self, header: &BlockHeader, height: u32) {
5743 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5744 let new_height = height - 1;
5746 let mut best_block = self.best_block.write().unwrap();
5747 assert_eq!(best_block.block_hash(), header.block_hash(),
5748 "Blocks must be disconnected in chain-order - the disconnected header must be the last connected header");
5749 assert_eq!(best_block.height(), height,
5750 "Blocks must be disconnected in chain-order - the disconnected block must have the correct height");
5751 *best_block = BestBlock::new(header.prev_blockhash, new_height)
5754 self.do_chain_event(Some(new_height), |channel| channel.best_block_updated(new_height, header.time, self.genesis_hash.clone(), &self.node_signer, &self.default_configuration, &self.logger));
5758 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref> chain::Confirm for ChannelManager<M, T, ES, NS, SP, F, R, L>
5760 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
5761 T::Target: BroadcasterInterface,
5762 ES::Target: EntropySource,
5763 NS::Target: NodeSigner,
5764 SP::Target: SignerProvider,
5765 F::Target: FeeEstimator,
5769 fn transactions_confirmed(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
5770 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
5771 // during initialization prior to the chain_monitor being fully configured in some cases.
5772 // See the docs for `ChannelManagerReadArgs` for more.
5774 let block_hash = header.block_hash();
5775 log_trace!(self.logger, "{} transactions included in block {} at height {} provided", txdata.len(), block_hash, height);
5777 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5778 self.do_chain_event(Some(height), |channel| channel.transactions_confirmed(&block_hash, height, txdata, self.genesis_hash.clone(), &self.node_signer, &self.default_configuration, &self.logger)
5779 .map(|(a, b)| (a, Vec::new(), b)));
5781 let last_best_block_height = self.best_block.read().unwrap().height();
5782 if height < last_best_block_height {
5783 let timestamp = self.highest_seen_timestamp.load(Ordering::Acquire);
5784 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.node_signer, &self.default_configuration, &self.logger));
5788 fn best_block_updated(&self, header: &BlockHeader, height: u32) {
5789 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
5790 // during initialization prior to the chain_monitor being fully configured in some cases.
5791 // See the docs for `ChannelManagerReadArgs` for more.
5793 let block_hash = header.block_hash();
5794 log_trace!(self.logger, "New best block: {} at height {}", block_hash, height);
5796 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5798 *self.best_block.write().unwrap() = BestBlock::new(block_hash, height);
5800 self.do_chain_event(Some(height), |channel| channel.best_block_updated(height, header.time, self.genesis_hash.clone(), &self.node_signer, &self.default_configuration, &self.logger));
5802 macro_rules! max_time {
5803 ($timestamp: expr) => {
5805 // Update $timestamp to be the max of its current value and the block
5806 // timestamp. This should keep us close to the current time without relying on
5807 // having an explicit local time source.
5808 // Just in case we end up in a race, we loop until we either successfully
5809 // update $timestamp or decide we don't need to.
5810 let old_serial = $timestamp.load(Ordering::Acquire);
5811 if old_serial >= header.time as usize { break; }
5812 if $timestamp.compare_exchange(old_serial, header.time as usize, Ordering::AcqRel, Ordering::Relaxed).is_ok() {
5818 max_time!(self.highest_seen_timestamp);
5819 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
5820 payment_secrets.retain(|_, inbound_payment| {
5821 inbound_payment.expiry_time > header.time as u64
5825 fn get_relevant_txids(&self) -> Vec<(Txid, Option<BlockHash>)> {
5826 let mut res = Vec::with_capacity(self.short_to_chan_info.read().unwrap().len());
5827 for (_cp_id, peer_state_mutex) in self.per_peer_state.read().unwrap().iter() {
5828 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5829 let peer_state = &mut *peer_state_lock;
5830 for chan in peer_state.channel_by_id.values() {
5831 if let (Some(funding_txo), Some(block_hash)) = (chan.get_funding_txo(), chan.get_funding_tx_confirmed_in()) {
5832 res.push((funding_txo.txid, Some(block_hash)));
5839 fn transaction_unconfirmed(&self, txid: &Txid) {
5840 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5841 self.do_chain_event(None, |channel| {
5842 if let Some(funding_txo) = channel.get_funding_txo() {
5843 if funding_txo.txid == *txid {
5844 channel.funding_transaction_unconfirmed(&self.logger).map(|()| (None, Vec::new(), None))
5845 } else { Ok((None, Vec::new(), None)) }
5846 } else { Ok((None, Vec::new(), None)) }
5851 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref> ChannelManager<M, T, ES, NS, SP, F, R, L>
5853 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
5854 T::Target: BroadcasterInterface,
5855 ES::Target: EntropySource,
5856 NS::Target: NodeSigner,
5857 SP::Target: SignerProvider,
5858 F::Target: FeeEstimator,
5862 /// Calls a function which handles an on-chain event (blocks dis/connected, transactions
5863 /// un/confirmed, etc) on each channel, handling any resulting errors or messages generated by
5865 fn do_chain_event<FN: Fn(&mut Channel<<SP::Target as SignerProvider>::Signer>) -> Result<(Option<msgs::ChannelReady>, Vec<(HTLCSource, PaymentHash)>, Option<msgs::AnnouncementSignatures>), ClosureReason>>
5866 (&self, height_opt: Option<u32>, f: FN) {
5867 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
5868 // during initialization prior to the chain_monitor being fully configured in some cases.
5869 // See the docs for `ChannelManagerReadArgs` for more.
5871 let mut failed_channels = Vec::new();
5872 let mut timed_out_htlcs = Vec::new();
5874 let per_peer_state = self.per_peer_state.read().unwrap();
5875 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
5876 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
5877 let peer_state = &mut *peer_state_lock;
5878 let pending_msg_events = &mut peer_state.pending_msg_events;
5879 peer_state.channel_by_id.retain(|_, channel| {
5880 let res = f(channel);
5881 if let Ok((channel_ready_opt, mut timed_out_pending_htlcs, announcement_sigs)) = res {
5882 for (source, payment_hash) in timed_out_pending_htlcs.drain(..) {
5883 let (failure_code, data) = self.get_htlc_inbound_temp_fail_err_and_data(0x1000|14 /* expiry_too_soon */, &channel);
5884 timed_out_htlcs.push((source, payment_hash, HTLCFailReason::reason(failure_code, data),
5885 HTLCDestination::NextHopChannel { node_id: Some(channel.get_counterparty_node_id()), channel_id: channel.channel_id() }));
5887 if let Some(channel_ready) = channel_ready_opt {
5888 send_channel_ready!(self, pending_msg_events, channel, channel_ready);
5889 if channel.is_usable() {
5890 log_trace!(self.logger, "Sending channel_ready with private initial channel_update for our counterparty on channel {}", log_bytes!(channel.channel_id()));
5891 if let Ok(msg) = self.get_channel_update_for_unicast(channel) {
5892 pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
5893 node_id: channel.get_counterparty_node_id(),
5898 log_trace!(self.logger, "Sending channel_ready WITHOUT channel_update for {}", log_bytes!(channel.channel_id()));
5902 emit_channel_ready_event!(self, channel);
5904 if let Some(announcement_sigs) = announcement_sigs {
5905 log_trace!(self.logger, "Sending announcement_signatures for channel {}", log_bytes!(channel.channel_id()));
5906 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
5907 node_id: channel.get_counterparty_node_id(),
5908 msg: announcement_sigs,
5910 if let Some(height) = height_opt {
5911 if let Some(announcement) = channel.get_signed_channel_announcement(&self.node_signer, self.genesis_hash, height, &self.default_configuration) {
5912 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
5914 // Note that announcement_signatures fails if the channel cannot be announced,
5915 // so get_channel_update_for_broadcast will never fail by the time we get here.
5916 update_msg: self.get_channel_update_for_broadcast(channel).unwrap(),
5921 if channel.is_our_channel_ready() {
5922 if let Some(real_scid) = channel.get_short_channel_id() {
5923 // If we sent a 0conf channel_ready, and now have an SCID, we add it
5924 // to the short_to_chan_info map here. Note that we check whether we
5925 // can relay using the real SCID at relay-time (i.e.
5926 // enforce option_scid_alias then), and if the funding tx is ever
5927 // un-confirmed we force-close the channel, ensuring short_to_chan_info
5928 // is always consistent.
5929 let mut short_to_chan_info = self.short_to_chan_info.write().unwrap();
5930 let scid_insert = short_to_chan_info.insert(real_scid, (channel.get_counterparty_node_id(), channel.channel_id()));
5931 assert!(scid_insert.is_none() || scid_insert.unwrap() == (channel.get_counterparty_node_id(), channel.channel_id()),
5932 "SCIDs should never collide - ensure you weren't behind by a full {} blocks when creating channels",
5933 fake_scid::MAX_SCID_BLOCKS_FROM_NOW);
5936 } else if let Err(reason) = res {
5937 update_maps_on_chan_removal!(self, channel);
5938 // It looks like our counterparty went on-chain or funding transaction was
5939 // reorged out of the main chain. Close the channel.
5940 failed_channels.push(channel.force_shutdown(true));
5941 if let Ok(update) = self.get_channel_update_for_broadcast(&channel) {
5942 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
5946 let reason_message = format!("{}", reason);
5947 self.issue_channel_close_events(channel, reason);
5948 pending_msg_events.push(events::MessageSendEvent::HandleError {
5949 node_id: channel.get_counterparty_node_id(),
5950 action: msgs::ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage {
5951 channel_id: channel.channel_id(),
5952 data: reason_message,
5962 if let Some(height) = height_opt {
5963 self.claimable_payments.lock().unwrap().claimable_htlcs.retain(|payment_hash, (_, htlcs)| {
5964 htlcs.retain(|htlc| {
5965 // If height is approaching the number of blocks we think it takes us to get
5966 // our commitment transaction confirmed before the HTLC expires, plus the
5967 // number of blocks we generally consider it to take to do a commitment update,
5968 // just give up on it and fail the HTLC.
5969 if height >= htlc.cltv_expiry - HTLC_FAIL_BACK_BUFFER {
5970 let mut htlc_msat_height_data = htlc.value.to_be_bytes().to_vec();
5971 htlc_msat_height_data.extend_from_slice(&height.to_be_bytes());
5973 timed_out_htlcs.push((HTLCSource::PreviousHopData(htlc.prev_hop.clone()), payment_hash.clone(),
5974 HTLCFailReason::reason(0x4000 | 15, htlc_msat_height_data),
5975 HTLCDestination::FailedPayment { payment_hash: payment_hash.clone() }));
5979 !htlcs.is_empty() // Only retain this entry if htlcs has at least one entry.
5982 let mut intercepted_htlcs = self.pending_intercepted_htlcs.lock().unwrap();
5983 intercepted_htlcs.retain(|_, htlc| {
5984 if height >= htlc.forward_info.outgoing_cltv_value - HTLC_FAIL_BACK_BUFFER {
5985 let prev_hop_data = HTLCSource::PreviousHopData(HTLCPreviousHopData {
5986 short_channel_id: htlc.prev_short_channel_id,
5987 htlc_id: htlc.prev_htlc_id,
5988 incoming_packet_shared_secret: htlc.forward_info.incoming_shared_secret,
5989 phantom_shared_secret: None,
5990 outpoint: htlc.prev_funding_outpoint,
5993 let requested_forward_scid /* intercept scid */ = match htlc.forward_info.routing {
5994 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
5995 _ => unreachable!(),
5997 timed_out_htlcs.push((prev_hop_data, htlc.forward_info.payment_hash,
5998 HTLCFailReason::from_failure_code(0x2000 | 2),
5999 HTLCDestination::InvalidForward { requested_forward_scid }));
6000 log_trace!(self.logger, "Timing out intercepted HTLC with requested forward scid {}", requested_forward_scid);
6006 self.handle_init_event_channel_failures(failed_channels);
6008 for (source, payment_hash, reason, destination) in timed_out_htlcs.drain(..) {
6009 self.fail_htlc_backwards_internal(&source, &payment_hash, &reason, destination);
6013 /// Blocks until ChannelManager needs to be persisted or a timeout is reached. It returns a bool
6014 /// indicating whether persistence is necessary. Only one listener on
6015 /// [`await_persistable_update`], [`await_persistable_update_timeout`], or a future returned by
6016 /// [`get_persistable_update_future`] is guaranteed to be woken up.
6018 /// Note that this method is not available with the `no-std` feature.
6020 /// [`await_persistable_update`]: Self::await_persistable_update
6021 /// [`await_persistable_update_timeout`]: Self::await_persistable_update_timeout
6022 /// [`get_persistable_update_future`]: Self::get_persistable_update_future
6023 #[cfg(any(test, feature = "std"))]
6024 pub fn await_persistable_update_timeout(&self, max_wait: Duration) -> bool {
6025 self.persistence_notifier.wait_timeout(max_wait)
6028 /// Blocks until ChannelManager needs to be persisted. Only one listener on
6029 /// [`await_persistable_update`], `await_persistable_update_timeout`, or a future returned by
6030 /// [`get_persistable_update_future`] is guaranteed to be woken up.
6032 /// [`await_persistable_update`]: Self::await_persistable_update
6033 /// [`get_persistable_update_future`]: Self::get_persistable_update_future
6034 pub fn await_persistable_update(&self) {
6035 self.persistence_notifier.wait()
6038 /// Gets a [`Future`] that completes when a persistable update is available. Note that
6039 /// callbacks registered on the [`Future`] MUST NOT call back into this [`ChannelManager`] and
6040 /// should instead register actions to be taken later.
6041 pub fn get_persistable_update_future(&self) -> Future {
6042 self.persistence_notifier.get_future()
6045 #[cfg(any(test, feature = "_test_utils"))]
6046 pub fn get_persistence_condvar_value(&self) -> bool {
6047 self.persistence_notifier.notify_pending()
6050 /// Gets the latest best block which was connected either via the [`chain::Listen`] or
6051 /// [`chain::Confirm`] interfaces.
6052 pub fn current_best_block(&self) -> BestBlock {
6053 self.best_block.read().unwrap().clone()
6056 /// Fetches the set of [`NodeFeatures`] flags which are provided by or required by
6057 /// [`ChannelManager`].
6058 pub fn node_features(&self) -> NodeFeatures {
6059 provided_node_features(&self.default_configuration)
6062 /// Fetches the set of [`InvoiceFeatures`] flags which are provided by or required by
6063 /// [`ChannelManager`].
6065 /// Note that the invoice feature flags can vary depending on if the invoice is a "phantom invoice"
6066 /// or not. Thus, this method is not public.
6067 #[cfg(any(feature = "_test_utils", test))]
6068 pub fn invoice_features(&self) -> InvoiceFeatures {
6069 provided_invoice_features(&self.default_configuration)
6072 /// Fetches the set of [`ChannelFeatures`] flags which are provided by or required by
6073 /// [`ChannelManager`].
6074 pub fn channel_features(&self) -> ChannelFeatures {
6075 provided_channel_features(&self.default_configuration)
6078 /// Fetches the set of [`ChannelTypeFeatures`] flags which are provided by or required by
6079 /// [`ChannelManager`].
6080 pub fn channel_type_features(&self) -> ChannelTypeFeatures {
6081 provided_channel_type_features(&self.default_configuration)
6084 /// Fetches the set of [`InitFeatures`] flags which are provided by or required by
6085 /// [`ChannelManager`].
6086 pub fn init_features(&self) -> InitFeatures {
6087 provided_init_features(&self.default_configuration)
6091 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
6092 ChannelMessageHandler for ChannelManager<M, T, ES, NS, SP, F, R, L>
6094 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
6095 T::Target: BroadcasterInterface,
6096 ES::Target: EntropySource,
6097 NS::Target: NodeSigner,
6098 SP::Target: SignerProvider,
6099 F::Target: FeeEstimator,
6103 fn handle_open_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::OpenChannel) {
6104 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6105 let _ = handle_error!(self, self.internal_open_channel(counterparty_node_id, msg), *counterparty_node_id);
6108 fn handle_accept_channel(&self, counterparty_node_id: &PublicKey, msg: &msgs::AcceptChannel) {
6109 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6110 let _ = handle_error!(self, self.internal_accept_channel(counterparty_node_id, msg), *counterparty_node_id);
6113 fn handle_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) {
6114 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6115 let _ = handle_error!(self, self.internal_funding_created(counterparty_node_id, msg), *counterparty_node_id);
6118 fn handle_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) {
6119 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6120 let _ = handle_error!(self, self.internal_funding_signed(counterparty_node_id, msg), *counterparty_node_id);
6123 fn handle_channel_ready(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReady) {
6124 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6125 let _ = handle_error!(self, self.internal_channel_ready(counterparty_node_id, msg), *counterparty_node_id);
6128 fn handle_shutdown(&self, counterparty_node_id: &PublicKey, msg: &msgs::Shutdown) {
6129 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6130 let _ = handle_error!(self, self.internal_shutdown(counterparty_node_id, msg), *counterparty_node_id);
6133 fn handle_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
6134 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6135 let _ = handle_error!(self, self.internal_closing_signed(counterparty_node_id, msg), *counterparty_node_id);
6138 fn handle_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
6139 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6140 let _ = handle_error!(self, self.internal_update_add_htlc(counterparty_node_id, msg), *counterparty_node_id);
6143 fn handle_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
6144 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6145 let _ = handle_error!(self, self.internal_update_fulfill_htlc(counterparty_node_id, msg), *counterparty_node_id);
6148 fn handle_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
6149 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6150 let _ = handle_error!(self, self.internal_update_fail_htlc(counterparty_node_id, msg), *counterparty_node_id);
6153 fn handle_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
6154 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6155 let _ = handle_error!(self, self.internal_update_fail_malformed_htlc(counterparty_node_id, msg), *counterparty_node_id);
6158 fn handle_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
6159 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6160 let _ = handle_error!(self, self.internal_commitment_signed(counterparty_node_id, msg), *counterparty_node_id);
6163 fn handle_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
6164 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6165 let _ = handle_error!(self, self.internal_revoke_and_ack(counterparty_node_id, msg), *counterparty_node_id);
6168 fn handle_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) {
6169 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6170 let _ = handle_error!(self, self.internal_update_fee(counterparty_node_id, msg), *counterparty_node_id);
6173 fn handle_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
6174 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6175 let _ = handle_error!(self, self.internal_announcement_signatures(counterparty_node_id, msg), *counterparty_node_id);
6178 fn handle_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) {
6179 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
6180 if let Ok(persist) = handle_error!(self, self.internal_channel_update(counterparty_node_id, msg), *counterparty_node_id) {
6183 NotifyOption::SkipPersist
6188 fn handle_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
6189 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6190 let _ = handle_error!(self, self.internal_channel_reestablish(counterparty_node_id, msg), *counterparty_node_id);
6193 fn peer_disconnected(&self, counterparty_node_id: &PublicKey, no_connection_possible: bool) {
6194 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6195 let mut failed_channels = Vec::new();
6196 let mut no_channels_remain = true;
6197 let mut per_peer_state = self.per_peer_state.write().unwrap();
6199 log_debug!(self.logger, "Marking channels with {} disconnected and generating channel_updates. We believe we {} make future connections to this peer.",
6200 log_pubkey!(counterparty_node_id), if no_connection_possible { "cannot" } else { "can" });
6201 if let Some(peer_state_mutex) = per_peer_state.get(counterparty_node_id) {
6202 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6203 let peer_state = &mut *peer_state_lock;
6204 let pending_msg_events = &mut peer_state.pending_msg_events;
6205 peer_state.channel_by_id.retain(|_, chan| {
6206 chan.remove_uncommitted_htlcs_and_mark_paused(&self.logger);
6207 if chan.is_shutdown() {
6208 update_maps_on_chan_removal!(self, chan);
6209 self.issue_channel_close_events(chan, ClosureReason::DisconnectedPeer);
6212 no_channels_remain = false;
6216 pending_msg_events.retain(|msg| {
6218 &events::MessageSendEvent::SendAcceptChannel { .. } => false,
6219 &events::MessageSendEvent::SendOpenChannel { .. } => false,
6220 &events::MessageSendEvent::SendFundingCreated { .. } => false,
6221 &events::MessageSendEvent::SendFundingSigned { .. } => false,
6222 &events::MessageSendEvent::SendChannelReady { .. } => false,
6223 &events::MessageSendEvent::SendAnnouncementSignatures { .. } => false,
6224 &events::MessageSendEvent::UpdateHTLCs { .. } => false,
6225 &events::MessageSendEvent::SendRevokeAndACK { .. } => false,
6226 &events::MessageSendEvent::SendClosingSigned { .. } => false,
6227 &events::MessageSendEvent::SendShutdown { .. } => false,
6228 &events::MessageSendEvent::SendChannelReestablish { .. } => false,
6229 &events::MessageSendEvent::SendChannelAnnouncement { .. } => false,
6230 &events::MessageSendEvent::BroadcastChannelAnnouncement { .. } => true,
6231 &events::MessageSendEvent::BroadcastChannelUpdate { .. } => true,
6232 &events::MessageSendEvent::SendChannelUpdate { .. } => false,
6233 &events::MessageSendEvent::HandleError { .. } => false,
6234 &events::MessageSendEvent::SendChannelRangeQuery { .. } => false,
6235 &events::MessageSendEvent::SendShortIdsQuery { .. } => false,
6236 &events::MessageSendEvent::SendReplyChannelRange { .. } => false,
6237 &events::MessageSendEvent::SendGossipTimestampFilter { .. } => false,
6240 debug_assert!(peer_state.is_connected, "A disconnected peer cannot disconnect");
6241 peer_state.is_connected = false;
6244 if no_channels_remain {
6245 per_peer_state.remove(counterparty_node_id);
6247 mem::drop(per_peer_state);
6249 for failure in failed_channels.drain(..) {
6250 self.finish_force_close_channel(failure);
6254 fn peer_connected(&self, counterparty_node_id: &PublicKey, init_msg: &msgs::Init) -> Result<(), ()> {
6255 if !init_msg.features.supports_static_remote_key() {
6256 log_debug!(self.logger, "Peer {} does not support static remote key, disconnecting with no_connection_possible", log_pubkey!(counterparty_node_id));
6260 log_debug!(self.logger, "Generating channel_reestablish events for {}", log_pubkey!(counterparty_node_id));
6262 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6265 let mut peer_state_lock = self.per_peer_state.write().unwrap();
6266 match peer_state_lock.entry(counterparty_node_id.clone()) {
6267 hash_map::Entry::Vacant(e) => {
6268 e.insert(Mutex::new(PeerState {
6269 channel_by_id: HashMap::new(),
6270 latest_features: init_msg.features.clone(),
6271 pending_msg_events: Vec::new(),
6275 hash_map::Entry::Occupied(e) => {
6276 let mut peer_state = e.get().lock().unwrap();
6277 peer_state.latest_features = init_msg.features.clone();
6278 debug_assert!(!peer_state.is_connected, "A peer shouldn't be connected twice");
6279 peer_state.is_connected = true;
6284 let per_peer_state = self.per_peer_state.read().unwrap();
6286 for (_cp_id, peer_state_mutex) in per_peer_state.iter() {
6287 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6288 let peer_state = &mut *peer_state_lock;
6289 let pending_msg_events = &mut peer_state.pending_msg_events;
6290 peer_state.channel_by_id.retain(|_, chan| {
6291 let retain = if chan.get_counterparty_node_id() == *counterparty_node_id {
6292 if !chan.have_received_message() {
6293 // If we created this (outbound) channel while we were disconnected from the
6294 // peer we probably failed to send the open_channel message, which is now
6295 // lost. We can't have had anything pending related to this channel, so we just
6299 pending_msg_events.push(events::MessageSendEvent::SendChannelReestablish {
6300 node_id: chan.get_counterparty_node_id(),
6301 msg: chan.get_channel_reestablish(&self.logger),
6306 if retain && chan.get_counterparty_node_id() != *counterparty_node_id {
6307 if let Some(msg) = chan.get_signed_channel_announcement(&self.node_signer, self.genesis_hash.clone(), self.best_block.read().unwrap().height(), &self.default_configuration) {
6308 if let Ok(update_msg) = self.get_channel_update_for_broadcast(chan) {
6309 pending_msg_events.push(events::MessageSendEvent::SendChannelAnnouncement {
6310 node_id: *counterparty_node_id,
6319 //TODO: Also re-broadcast announcement_signatures
6323 fn handle_error(&self, counterparty_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
6324 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6326 if msg.channel_id == [0; 32] {
6327 let channel_ids: Vec<[u8; 32]> = {
6328 let per_peer_state = self.per_peer_state.read().unwrap();
6329 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
6330 if peer_state_mutex_opt.is_none() { return; }
6331 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
6332 let peer_state = &mut *peer_state_lock;
6333 peer_state.channel_by_id.keys().cloned().collect()
6335 for channel_id in channel_ids {
6336 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
6337 let _ = self.force_close_channel_with_peer(&channel_id, counterparty_node_id, Some(&msg.data), true);
6341 // First check if we can advance the channel type and try again.
6342 let per_peer_state = self.per_peer_state.read().unwrap();
6343 let peer_state_mutex_opt = per_peer_state.get(counterparty_node_id);
6344 if peer_state_mutex_opt.is_none() { return; }
6345 let mut peer_state_lock = peer_state_mutex_opt.unwrap().lock().unwrap();
6346 let peer_state = &mut *peer_state_lock;
6347 if let Some(chan) = peer_state.channel_by_id.get_mut(&msg.channel_id) {
6348 if let Ok(msg) = chan.maybe_handle_error_without_close(self.genesis_hash) {
6349 peer_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
6350 node_id: *counterparty_node_id,
6358 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
6359 let _ = self.force_close_channel_with_peer(&msg.channel_id, counterparty_node_id, Some(&msg.data), true);
6363 fn provided_node_features(&self) -> NodeFeatures {
6364 provided_node_features(&self.default_configuration)
6367 fn provided_init_features(&self, _their_init_features: &PublicKey) -> InitFeatures {
6368 provided_init_features(&self.default_configuration)
6372 /// Fetches the set of [`NodeFeatures`] flags which are provided by or required by
6373 /// [`ChannelManager`].
6374 pub(crate) fn provided_node_features(config: &UserConfig) -> NodeFeatures {
6375 provided_init_features(config).to_context()
6378 /// Fetches the set of [`InvoiceFeatures`] flags which are provided by or required by
6379 /// [`ChannelManager`].
6381 /// Note that the invoice feature flags can vary depending on if the invoice is a "phantom invoice"
6382 /// or not. Thus, this method is not public.
6383 #[cfg(any(feature = "_test_utils", test))]
6384 pub(crate) fn provided_invoice_features(config: &UserConfig) -> InvoiceFeatures {
6385 provided_init_features(config).to_context()
6388 /// Fetches the set of [`ChannelFeatures`] flags which are provided by or required by
6389 /// [`ChannelManager`].
6390 pub(crate) fn provided_channel_features(config: &UserConfig) -> ChannelFeatures {
6391 provided_init_features(config).to_context()
6394 /// Fetches the set of [`ChannelTypeFeatures`] flags which are provided by or required by
6395 /// [`ChannelManager`].
6396 pub(crate) fn provided_channel_type_features(config: &UserConfig) -> ChannelTypeFeatures {
6397 ChannelTypeFeatures::from_init(&provided_init_features(config))
6400 /// Fetches the set of [`InitFeatures`] flags which are provided by or required by
6401 /// [`ChannelManager`].
6402 pub fn provided_init_features(_config: &UserConfig) -> InitFeatures {
6403 // Note that if new features are added here which other peers may (eventually) require, we
6404 // should also add the corresponding (optional) bit to the ChannelMessageHandler impl for
6405 // ErroringMessageHandler.
6406 let mut features = InitFeatures::empty();
6407 features.set_data_loss_protect_optional();
6408 features.set_upfront_shutdown_script_optional();
6409 features.set_variable_length_onion_required();
6410 features.set_static_remote_key_required();
6411 features.set_payment_secret_required();
6412 features.set_basic_mpp_optional();
6413 features.set_wumbo_optional();
6414 features.set_shutdown_any_segwit_optional();
6415 features.set_channel_type_optional();
6416 features.set_scid_privacy_optional();
6417 features.set_zero_conf_optional();
6419 { // Attributes are not allowed on if expressions on our current MSRV of 1.41.
6420 if _config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx {
6421 features.set_anchors_zero_fee_htlc_tx_optional();
6427 const SERIALIZATION_VERSION: u8 = 1;
6428 const MIN_SERIALIZATION_VERSION: u8 = 1;
6430 impl_writeable_tlv_based!(CounterpartyForwardingInfo, {
6431 (2, fee_base_msat, required),
6432 (4, fee_proportional_millionths, required),
6433 (6, cltv_expiry_delta, required),
6436 impl_writeable_tlv_based!(ChannelCounterparty, {
6437 (2, node_id, required),
6438 (4, features, required),
6439 (6, unspendable_punishment_reserve, required),
6440 (8, forwarding_info, option),
6441 (9, outbound_htlc_minimum_msat, option),
6442 (11, outbound_htlc_maximum_msat, option),
6445 impl Writeable for ChannelDetails {
6446 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6447 // `user_channel_id` used to be a single u64 value. In order to remain backwards compatible with
6448 // versions prior to 0.0.113, the u128 is serialized as two separate u64 values.
6449 let user_channel_id_low = self.user_channel_id as u64;
6450 let user_channel_id_high_opt = Some((self.user_channel_id >> 64) as u64);
6451 write_tlv_fields!(writer, {
6452 (1, self.inbound_scid_alias, option),
6453 (2, self.channel_id, required),
6454 (3, self.channel_type, option),
6455 (4, self.counterparty, required),
6456 (5, self.outbound_scid_alias, option),
6457 (6, self.funding_txo, option),
6458 (7, self.config, option),
6459 (8, self.short_channel_id, option),
6460 (9, self.confirmations, option),
6461 (10, self.channel_value_satoshis, required),
6462 (12, self.unspendable_punishment_reserve, option),
6463 (14, user_channel_id_low, required),
6464 (16, self.balance_msat, required),
6465 (18, self.outbound_capacity_msat, required),
6466 // Note that by the time we get past the required read above, outbound_capacity_msat will be
6467 // filled in, so we can safely unwrap it here.
6468 (19, self.next_outbound_htlc_limit_msat, (default_value, outbound_capacity_msat.0.unwrap() as u64)),
6469 (20, self.inbound_capacity_msat, required),
6470 (22, self.confirmations_required, option),
6471 (24, self.force_close_spend_delay, option),
6472 (26, self.is_outbound, required),
6473 (28, self.is_channel_ready, required),
6474 (30, self.is_usable, required),
6475 (32, self.is_public, required),
6476 (33, self.inbound_htlc_minimum_msat, option),
6477 (35, self.inbound_htlc_maximum_msat, option),
6478 (37, user_channel_id_high_opt, option),
6484 impl Readable for ChannelDetails {
6485 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
6486 _init_and_read_tlv_fields!(reader, {
6487 (1, inbound_scid_alias, option),
6488 (2, channel_id, required),
6489 (3, channel_type, option),
6490 (4, counterparty, required),
6491 (5, outbound_scid_alias, option),
6492 (6, funding_txo, option),
6493 (7, config, option),
6494 (8, short_channel_id, option),
6495 (9, confirmations, option),
6496 (10, channel_value_satoshis, required),
6497 (12, unspendable_punishment_reserve, option),
6498 (14, user_channel_id_low, required),
6499 (16, balance_msat, required),
6500 (18, outbound_capacity_msat, required),
6501 // Note that by the time we get past the required read above, outbound_capacity_msat will be
6502 // filled in, so we can safely unwrap it here.
6503 (19, next_outbound_htlc_limit_msat, (default_value, outbound_capacity_msat.0.unwrap() as u64)),
6504 (20, inbound_capacity_msat, required),
6505 (22, confirmations_required, option),
6506 (24, force_close_spend_delay, option),
6507 (26, is_outbound, required),
6508 (28, is_channel_ready, required),
6509 (30, is_usable, required),
6510 (32, is_public, required),
6511 (33, inbound_htlc_minimum_msat, option),
6512 (35, inbound_htlc_maximum_msat, option),
6513 (37, user_channel_id_high_opt, option),
6516 // `user_channel_id` used to be a single u64 value. In order to remain backwards compatible with
6517 // versions prior to 0.0.113, the u128 is serialized as two separate u64 values.
6518 let user_channel_id_low: u64 = user_channel_id_low.0.unwrap();
6519 let user_channel_id = user_channel_id_low as u128 +
6520 ((user_channel_id_high_opt.unwrap_or(0 as u64) as u128) << 64);
6524 channel_id: channel_id.0.unwrap(),
6526 counterparty: counterparty.0.unwrap(),
6527 outbound_scid_alias,
6531 channel_value_satoshis: channel_value_satoshis.0.unwrap(),
6532 unspendable_punishment_reserve,
6534 balance_msat: balance_msat.0.unwrap(),
6535 outbound_capacity_msat: outbound_capacity_msat.0.unwrap(),
6536 next_outbound_htlc_limit_msat: next_outbound_htlc_limit_msat.0.unwrap(),
6537 inbound_capacity_msat: inbound_capacity_msat.0.unwrap(),
6538 confirmations_required,
6540 force_close_spend_delay,
6541 is_outbound: is_outbound.0.unwrap(),
6542 is_channel_ready: is_channel_ready.0.unwrap(),
6543 is_usable: is_usable.0.unwrap(),
6544 is_public: is_public.0.unwrap(),
6545 inbound_htlc_minimum_msat,
6546 inbound_htlc_maximum_msat,
6551 impl_writeable_tlv_based!(PhantomRouteHints, {
6552 (2, channels, vec_type),
6553 (4, phantom_scid, required),
6554 (6, real_node_pubkey, required),
6557 impl_writeable_tlv_based_enum!(PendingHTLCRouting,
6559 (0, onion_packet, required),
6560 (2, short_channel_id, required),
6563 (0, payment_data, required),
6564 (1, phantom_shared_secret, option),
6565 (2, incoming_cltv_expiry, required),
6567 (2, ReceiveKeysend) => {
6568 (0, payment_preimage, required),
6569 (2, incoming_cltv_expiry, required),
6573 impl_writeable_tlv_based!(PendingHTLCInfo, {
6574 (0, routing, required),
6575 (2, incoming_shared_secret, required),
6576 (4, payment_hash, required),
6577 (6, outgoing_amt_msat, required),
6578 (8, outgoing_cltv_value, required),
6579 (9, incoming_amt_msat, option),
6583 impl Writeable for HTLCFailureMsg {
6584 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6586 HTLCFailureMsg::Relay(msgs::UpdateFailHTLC { channel_id, htlc_id, reason }) => {
6588 channel_id.write(writer)?;
6589 htlc_id.write(writer)?;
6590 reason.write(writer)?;
6592 HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
6593 channel_id, htlc_id, sha256_of_onion, failure_code
6596 channel_id.write(writer)?;
6597 htlc_id.write(writer)?;
6598 sha256_of_onion.write(writer)?;
6599 failure_code.write(writer)?;
6606 impl Readable for HTLCFailureMsg {
6607 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
6608 let id: u8 = Readable::read(reader)?;
6611 Ok(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
6612 channel_id: Readable::read(reader)?,
6613 htlc_id: Readable::read(reader)?,
6614 reason: Readable::read(reader)?,
6618 Ok(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
6619 channel_id: Readable::read(reader)?,
6620 htlc_id: Readable::read(reader)?,
6621 sha256_of_onion: Readable::read(reader)?,
6622 failure_code: Readable::read(reader)?,
6625 // In versions prior to 0.0.101, HTLCFailureMsg objects were written with type 0 or 1 but
6626 // weren't length-prefixed and thus didn't support reading the TLV stream suffix of the network
6627 // messages contained in the variants.
6628 // In version 0.0.101, support for reading the variants with these types was added, and
6629 // we should migrate to writing these variants when UpdateFailHTLC or
6630 // UpdateFailMalformedHTLC get TLV fields.
6632 let length: BigSize = Readable::read(reader)?;
6633 let mut s = FixedLengthReader::new(reader, length.0);
6634 let res = Readable::read(&mut s)?;
6635 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
6636 Ok(HTLCFailureMsg::Relay(res))
6639 let length: BigSize = Readable::read(reader)?;
6640 let mut s = FixedLengthReader::new(reader, length.0);
6641 let res = Readable::read(&mut s)?;
6642 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
6643 Ok(HTLCFailureMsg::Malformed(res))
6645 _ => Err(DecodeError::UnknownRequiredFeature),
6650 impl_writeable_tlv_based_enum!(PendingHTLCStatus, ;
6655 impl_writeable_tlv_based!(HTLCPreviousHopData, {
6656 (0, short_channel_id, required),
6657 (1, phantom_shared_secret, option),
6658 (2, outpoint, required),
6659 (4, htlc_id, required),
6660 (6, incoming_packet_shared_secret, required)
6663 impl Writeable for ClaimableHTLC {
6664 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6665 let (payment_data, keysend_preimage) = match &self.onion_payload {
6666 OnionPayload::Invoice { _legacy_hop_data } => (_legacy_hop_data.as_ref(), None),
6667 OnionPayload::Spontaneous(preimage) => (None, Some(preimage)),
6669 write_tlv_fields!(writer, {
6670 (0, self.prev_hop, required),
6671 (1, self.total_msat, required),
6672 (2, self.value, required),
6673 (4, payment_data, option),
6674 (6, self.cltv_expiry, required),
6675 (8, keysend_preimage, option),
6681 impl Readable for ClaimableHTLC {
6682 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
6683 let mut prev_hop = crate::util::ser::OptionDeserWrapper(None);
6685 let mut payment_data: Option<msgs::FinalOnionHopData> = None;
6686 let mut cltv_expiry = 0;
6687 let mut total_msat = None;
6688 let mut keysend_preimage: Option<PaymentPreimage> = None;
6689 read_tlv_fields!(reader, {
6690 (0, prev_hop, required),
6691 (1, total_msat, option),
6692 (2, value, required),
6693 (4, payment_data, option),
6694 (6, cltv_expiry, required),
6695 (8, keysend_preimage, option)
6697 let onion_payload = match keysend_preimage {
6699 if payment_data.is_some() {
6700 return Err(DecodeError::InvalidValue)
6702 if total_msat.is_none() {
6703 total_msat = Some(value);
6705 OnionPayload::Spontaneous(p)
6708 if total_msat.is_none() {
6709 if payment_data.is_none() {
6710 return Err(DecodeError::InvalidValue)
6712 total_msat = Some(payment_data.as_ref().unwrap().total_msat);
6714 OnionPayload::Invoice { _legacy_hop_data: payment_data }
6718 prev_hop: prev_hop.0.unwrap(),
6721 total_msat: total_msat.unwrap(),
6728 impl Readable for HTLCSource {
6729 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
6730 let id: u8 = Readable::read(reader)?;
6733 let mut session_priv: crate::util::ser::OptionDeserWrapper<SecretKey> = crate::util::ser::OptionDeserWrapper(None);
6734 let mut first_hop_htlc_msat: u64 = 0;
6735 let mut path = Some(Vec::new());
6736 let mut payment_id = None;
6737 let mut payment_secret = None;
6738 let mut payment_params = None;
6739 read_tlv_fields!(reader, {
6740 (0, session_priv, required),
6741 (1, payment_id, option),
6742 (2, first_hop_htlc_msat, required),
6743 (3, payment_secret, option),
6744 (4, path, vec_type),
6745 (5, payment_params, option),
6747 if payment_id.is_none() {
6748 // For backwards compat, if there was no payment_id written, use the session_priv bytes
6750 payment_id = Some(PaymentId(*session_priv.0.unwrap().as_ref()));
6752 Ok(HTLCSource::OutboundRoute {
6753 session_priv: session_priv.0.unwrap(),
6754 first_hop_htlc_msat,
6755 path: path.unwrap(),
6756 payment_id: payment_id.unwrap(),
6761 1 => Ok(HTLCSource::PreviousHopData(Readable::read(reader)?)),
6762 _ => Err(DecodeError::UnknownRequiredFeature),
6767 impl Writeable for HTLCSource {
6768 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), crate::io::Error> {
6770 HTLCSource::OutboundRoute { ref session_priv, ref first_hop_htlc_msat, ref path, payment_id, payment_secret, payment_params } => {
6772 let payment_id_opt = Some(payment_id);
6773 write_tlv_fields!(writer, {
6774 (0, session_priv, required),
6775 (1, payment_id_opt, option),
6776 (2, first_hop_htlc_msat, required),
6777 (3, payment_secret, option),
6778 (4, *path, vec_type),
6779 (5, payment_params, option),
6782 HTLCSource::PreviousHopData(ref field) => {
6784 field.write(writer)?;
6791 impl_writeable_tlv_based!(PendingAddHTLCInfo, {
6792 (0, forward_info, required),
6793 (1, prev_user_channel_id, (default_value, 0)),
6794 (2, prev_short_channel_id, required),
6795 (4, prev_htlc_id, required),
6796 (6, prev_funding_outpoint, required),
6799 impl_writeable_tlv_based_enum!(HTLCForwardInfo,
6801 (0, htlc_id, required),
6802 (2, err_packet, required),
6807 impl_writeable_tlv_based!(PendingInboundPayment, {
6808 (0, payment_secret, required),
6809 (2, expiry_time, required),
6810 (4, user_payment_id, required),
6811 (6, payment_preimage, required),
6812 (8, min_value_msat, required),
6815 impl<M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref> Writeable for ChannelManager<M, T, ES, NS, SP, F, R, L>
6817 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
6818 T::Target: BroadcasterInterface,
6819 ES::Target: EntropySource,
6820 NS::Target: NodeSigner,
6821 SP::Target: SignerProvider,
6822 F::Target: FeeEstimator,
6826 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6827 let _consistency_lock = self.total_consistency_lock.write().unwrap();
6829 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
6831 self.genesis_hash.write(writer)?;
6833 let best_block = self.best_block.read().unwrap();
6834 best_block.height().write(writer)?;
6835 best_block.block_hash().write(writer)?;
6839 let per_peer_state = self.per_peer_state.read().unwrap();
6840 let mut unfunded_channels = 0;
6841 let mut number_of_channels = 0;
6842 for (_, peer_state_mutex) in per_peer_state.iter() {
6843 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6844 let peer_state = &mut *peer_state_lock;
6845 number_of_channels += peer_state.channel_by_id.len();
6846 for (_, channel) in peer_state.channel_by_id.iter() {
6847 if !channel.is_funding_initiated() {
6848 unfunded_channels += 1;
6853 ((number_of_channels - unfunded_channels) as u64).write(writer)?;
6855 for (_, peer_state_mutex) in per_peer_state.iter() {
6856 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
6857 let peer_state = &mut *peer_state_lock;
6858 for (_, channel) in peer_state.channel_by_id.iter() {
6859 if channel.is_funding_initiated() {
6860 channel.write(writer)?;
6867 let forward_htlcs = self.forward_htlcs.lock().unwrap();
6868 (forward_htlcs.len() as u64).write(writer)?;
6869 for (short_channel_id, pending_forwards) in forward_htlcs.iter() {
6870 short_channel_id.write(writer)?;
6871 (pending_forwards.len() as u64).write(writer)?;
6872 for forward in pending_forwards {
6873 forward.write(writer)?;
6878 let per_peer_state = self.per_peer_state.write().unwrap();
6880 let pending_inbound_payments = self.pending_inbound_payments.lock().unwrap();
6881 let claimable_payments = self.claimable_payments.lock().unwrap();
6882 let pending_outbound_payments = self.pending_outbound_payments.pending_outbound_payments.lock().unwrap();
6884 let mut htlc_purposes: Vec<&events::PaymentPurpose> = Vec::new();
6885 (claimable_payments.claimable_htlcs.len() as u64).write(writer)?;
6886 for (payment_hash, (purpose, previous_hops)) in claimable_payments.claimable_htlcs.iter() {
6887 payment_hash.write(writer)?;
6888 (previous_hops.len() as u64).write(writer)?;
6889 for htlc in previous_hops.iter() {
6890 htlc.write(writer)?;
6892 htlc_purposes.push(purpose);
6895 (per_peer_state.len() as u64).write(writer)?;
6896 for (peer_pubkey, peer_state_mutex) in per_peer_state.iter() {
6897 peer_pubkey.write(writer)?;
6898 let peer_state = peer_state_mutex.lock().unwrap();
6899 peer_state.latest_features.write(writer)?;
6902 let events = self.pending_events.lock().unwrap();
6903 (events.len() as u64).write(writer)?;
6904 for event in events.iter() {
6905 event.write(writer)?;
6908 let background_events = self.pending_background_events.lock().unwrap();
6909 (background_events.len() as u64).write(writer)?;
6910 for event in background_events.iter() {
6912 BackgroundEvent::ClosingMonitorUpdate((funding_txo, monitor_update)) => {
6914 funding_txo.write(writer)?;
6915 monitor_update.write(writer)?;
6920 // Prior to 0.0.111 we tracked node_announcement serials here, however that now happens in
6921 // `PeerManager`, and thus we simply write the `highest_seen_timestamp` twice, which is
6922 // likely to be identical.
6923 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
6924 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
6926 (pending_inbound_payments.len() as u64).write(writer)?;
6927 for (hash, pending_payment) in pending_inbound_payments.iter() {
6928 hash.write(writer)?;
6929 pending_payment.write(writer)?;
6932 // For backwards compat, write the session privs and their total length.
6933 let mut num_pending_outbounds_compat: u64 = 0;
6934 for (_, outbound) in pending_outbound_payments.iter() {
6935 if !outbound.is_fulfilled() && !outbound.abandoned() {
6936 num_pending_outbounds_compat += outbound.remaining_parts() as u64;
6939 num_pending_outbounds_compat.write(writer)?;
6940 for (_, outbound) in pending_outbound_payments.iter() {
6942 PendingOutboundPayment::Legacy { session_privs } |
6943 PendingOutboundPayment::Retryable { session_privs, .. } => {
6944 for session_priv in session_privs.iter() {
6945 session_priv.write(writer)?;
6948 PendingOutboundPayment::Fulfilled { .. } => {},
6949 PendingOutboundPayment::Abandoned { .. } => {},
6953 // Encode without retry info for 0.0.101 compatibility.
6954 let mut pending_outbound_payments_no_retry: HashMap<PaymentId, HashSet<[u8; 32]>> = HashMap::new();
6955 for (id, outbound) in pending_outbound_payments.iter() {
6957 PendingOutboundPayment::Legacy { session_privs } |
6958 PendingOutboundPayment::Retryable { session_privs, .. } => {
6959 pending_outbound_payments_no_retry.insert(*id, session_privs.clone());
6965 let mut pending_intercepted_htlcs = None;
6966 let our_pending_intercepts = self.pending_intercepted_htlcs.lock().unwrap();
6967 if our_pending_intercepts.len() != 0 {
6968 pending_intercepted_htlcs = Some(our_pending_intercepts);
6971 let mut pending_claiming_payments = Some(&claimable_payments.pending_claiming_payments);
6972 if pending_claiming_payments.as_ref().unwrap().is_empty() {
6973 // LDK versions prior to 0.0.113 do not know how to read the pending claimed payments
6974 // map. Thus, if there are no entries we skip writing a TLV for it.
6975 pending_claiming_payments = None;
6977 debug_assert!(false, "While we have code to serialize pending_claiming_payments, the map should always be empty until a later PR");
6980 write_tlv_fields!(writer, {
6981 (1, pending_outbound_payments_no_retry, required),
6982 (2, pending_intercepted_htlcs, option),
6983 (3, pending_outbound_payments, required),
6984 (4, pending_claiming_payments, option),
6985 (5, self.our_network_pubkey, required),
6986 (7, self.fake_scid_rand_bytes, required),
6987 (9, htlc_purposes, vec_type),
6988 (11, self.probing_cookie_secret, required),
6995 /// Arguments for the creation of a ChannelManager that are not deserialized.
6997 /// At a high-level, the process for deserializing a ChannelManager and resuming normal operation
6999 /// 1) Deserialize all stored [`ChannelMonitor`]s.
7000 /// 2) Deserialize the [`ChannelManager`] by filling in this struct and calling:
7001 /// `<(BlockHash, ChannelManager)>::read(reader, args)`
7002 /// This may result in closing some channels if the [`ChannelMonitor`] is newer than the stored
7003 /// [`ChannelManager`] state to ensure no loss of funds. Thus, transactions may be broadcasted.
7004 /// 3) If you are not fetching full blocks, register all relevant [`ChannelMonitor`] outpoints the
7005 /// same way you would handle a [`chain::Filter`] call using
7006 /// [`ChannelMonitor::get_outputs_to_watch`] and [`ChannelMonitor::get_funding_txo`].
7007 /// 4) Reconnect blocks on your [`ChannelMonitor`]s.
7008 /// 5) Disconnect/connect blocks on the [`ChannelManager`].
7009 /// 6) Re-persist the [`ChannelMonitor`]s to ensure the latest state is on disk.
7010 /// Note that if you're using a [`ChainMonitor`] for your [`chain::Watch`] implementation, you
7011 /// will likely accomplish this as a side-effect of calling [`chain::Watch::watch_channel`] in
7013 /// 7) Move the [`ChannelMonitor`]s into your local [`chain::Watch`]. If you're using a
7014 /// [`ChainMonitor`], this is done by calling [`chain::Watch::watch_channel`].
7016 /// Note that the ordering of #4-7 is not of importance, however all four must occur before you
7017 /// call any other methods on the newly-deserialized [`ChannelManager`].
7019 /// Note that because some channels may be closed during deserialization, it is critical that you
7020 /// always deserialize only the latest version of a ChannelManager and ChannelMonitors available to
7021 /// you. If you deserialize an old ChannelManager (during which force-closure transactions may be
7022 /// broadcast), and then later deserialize a newer version of the same ChannelManager (which will
7023 /// not force-close the same channels but consider them live), you may end up revoking a state for
7024 /// which you've already broadcasted the transaction.
7026 /// [`ChainMonitor`]: crate::chain::chainmonitor::ChainMonitor
7027 pub struct ChannelManagerReadArgs<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
7029 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
7030 T::Target: BroadcasterInterface,
7031 ES::Target: EntropySource,
7032 NS::Target: NodeSigner,
7033 SP::Target: SignerProvider,
7034 F::Target: FeeEstimator,
7038 /// A cryptographically secure source of entropy.
7039 pub entropy_source: ES,
7041 /// A signer that is able to perform node-scoped cryptographic operations.
7042 pub node_signer: NS,
7044 /// The keys provider which will give us relevant keys. Some keys will be loaded during
7045 /// deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
7047 pub signer_provider: SP,
7049 /// The fee_estimator for use in the ChannelManager in the future.
7051 /// No calls to the FeeEstimator will be made during deserialization.
7052 pub fee_estimator: F,
7053 /// The chain::Watch for use in the ChannelManager in the future.
7055 /// No calls to the chain::Watch will be made during deserialization. It is assumed that
7056 /// you have deserialized ChannelMonitors separately and will add them to your
7057 /// chain::Watch after deserializing this ChannelManager.
7058 pub chain_monitor: M,
7060 /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
7061 /// used to broadcast the latest local commitment transactions of channels which must be
7062 /// force-closed during deserialization.
7063 pub tx_broadcaster: T,
7064 /// The router which will be used in the ChannelManager in the future for finding routes
7065 /// on-the-fly for trampoline payments. Absent in private nodes that don't support forwarding.
7067 /// No calls to the router will be made during deserialization.
7069 /// The Logger for use in the ChannelManager and which may be used to log information during
7070 /// deserialization.
7072 /// Default settings used for new channels. Any existing channels will continue to use the
7073 /// runtime settings which were stored when the ChannelManager was serialized.
7074 pub default_config: UserConfig,
7076 /// A map from channel funding outpoints to ChannelMonitors for those channels (ie
7077 /// value.get_funding_txo() should be the key).
7079 /// If a monitor is inconsistent with the channel state during deserialization the channel will
7080 /// be force-closed using the data in the ChannelMonitor and the channel will be dropped. This
7081 /// is true for missing channels as well. If there is a monitor missing for which we find
7082 /// channel data Err(DecodeError::InvalidValue) will be returned.
7084 /// In such cases the latest local transactions will be sent to the tx_broadcaster included in
7087 /// (C-not exported) because we have no HashMap bindings
7088 pub channel_monitors: HashMap<OutPoint, &'a mut ChannelMonitor<<SP::Target as SignerProvider>::Signer>>,
7091 impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
7092 ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>
7094 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
7095 T::Target: BroadcasterInterface,
7096 ES::Target: EntropySource,
7097 NS::Target: NodeSigner,
7098 SP::Target: SignerProvider,
7099 F::Target: FeeEstimator,
7103 /// Simple utility function to create a ChannelManagerReadArgs which creates the monitor
7104 /// HashMap for you. This is primarily useful for C bindings where it is not practical to
7105 /// populate a HashMap directly from C.
7106 pub fn new(entropy_source: ES, node_signer: NS, signer_provider: SP, fee_estimator: F, chain_monitor: M, tx_broadcaster: T, router: R, logger: L, default_config: UserConfig,
7107 mut channel_monitors: Vec<&'a mut ChannelMonitor<<SP::Target as SignerProvider>::Signer>>) -> Self {
7109 entropy_source, node_signer, signer_provider, fee_estimator, chain_monitor, tx_broadcaster, router, logger, default_config,
7110 channel_monitors: channel_monitors.drain(..).map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect()
7115 // Implement ReadableArgs for an Arc'd ChannelManager to make it a bit easier to work with the
7116 // SipmleArcChannelManager type:
7117 impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
7118 ReadableArgs<ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>> for (BlockHash, Arc<ChannelManager<M, T, ES, NS, SP, F, R, L>>)
7120 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
7121 T::Target: BroadcasterInterface,
7122 ES::Target: EntropySource,
7123 NS::Target: NodeSigner,
7124 SP::Target: SignerProvider,
7125 F::Target: FeeEstimator,
7129 fn read<Reader: io::Read>(reader: &mut Reader, args: ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>) -> Result<Self, DecodeError> {
7130 let (blockhash, chan_manager) = <(BlockHash, ChannelManager<M, T, ES, NS, SP, F, R, L>)>::read(reader, args)?;
7131 Ok((blockhash, Arc::new(chan_manager)))
7135 impl<'a, M: Deref, T: Deref, ES: Deref, NS: Deref, SP: Deref, F: Deref, R: Deref, L: Deref>
7136 ReadableArgs<ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>> for (BlockHash, ChannelManager<M, T, ES, NS, SP, F, R, L>)
7138 M::Target: chain::Watch<<SP::Target as SignerProvider>::Signer>,
7139 T::Target: BroadcasterInterface,
7140 ES::Target: EntropySource,
7141 NS::Target: NodeSigner,
7142 SP::Target: SignerProvider,
7143 F::Target: FeeEstimator,
7147 fn read<Reader: io::Read>(reader: &mut Reader, mut args: ChannelManagerReadArgs<'a, M, T, ES, NS, SP, F, R, L>) -> Result<Self, DecodeError> {
7148 let _ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
7150 let genesis_hash: BlockHash = Readable::read(reader)?;
7151 let best_block_height: u32 = Readable::read(reader)?;
7152 let best_block_hash: BlockHash = Readable::read(reader)?;
7154 let mut failed_htlcs = Vec::new();
7156 let channel_count: u64 = Readable::read(reader)?;
7157 let mut funding_txo_set = HashSet::with_capacity(cmp::min(channel_count as usize, 128));
7158 let mut peer_channels: HashMap<PublicKey, HashMap<[u8; 32], Channel<<SP::Target as SignerProvider>::Signer>>> = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
7159 let mut id_to_peer = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
7160 let mut short_to_chan_info = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
7161 let mut channel_closures = Vec::new();
7162 for _ in 0..channel_count {
7163 let mut channel: Channel<<SP::Target as SignerProvider>::Signer> = Channel::read(reader, (
7164 &args.entropy_source, &args.signer_provider, best_block_height, &provided_channel_type_features(&args.default_config)
7166 let funding_txo = channel.get_funding_txo().ok_or(DecodeError::InvalidValue)?;
7167 funding_txo_set.insert(funding_txo.clone());
7168 if let Some(ref mut monitor) = args.channel_monitors.get_mut(&funding_txo) {
7169 if channel.get_cur_holder_commitment_transaction_number() < monitor.get_cur_holder_commitment_number() ||
7170 channel.get_revoked_counterparty_commitment_transaction_number() < monitor.get_min_seen_secret() ||
7171 channel.get_cur_counterparty_commitment_transaction_number() < monitor.get_cur_counterparty_commitment_number() ||
7172 channel.get_latest_monitor_update_id() > monitor.get_latest_update_id() {
7173 // If the channel is ahead of the monitor, return InvalidValue:
7174 log_error!(args.logger, "A ChannelMonitor is stale compared to the current ChannelManager! This indicates a potentially-critical violation of the chain::Watch API!");
7175 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
7176 log_bytes!(channel.channel_id()), monitor.get_latest_update_id(), channel.get_latest_monitor_update_id());
7177 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
7178 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
7179 log_error!(args.logger, " Without the latest ChannelMonitor we cannot continue without risking funds.");
7180 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");
7181 return Err(DecodeError::InvalidValue);
7182 } else if channel.get_cur_holder_commitment_transaction_number() > monitor.get_cur_holder_commitment_number() ||
7183 channel.get_revoked_counterparty_commitment_transaction_number() > monitor.get_min_seen_secret() ||
7184 channel.get_cur_counterparty_commitment_transaction_number() > monitor.get_cur_counterparty_commitment_number() ||
7185 channel.get_latest_monitor_update_id() < monitor.get_latest_update_id() {
7186 // But if the channel is behind of the monitor, close the channel:
7187 log_error!(args.logger, "A ChannelManager is stale compared to the current ChannelMonitor!");
7188 log_error!(args.logger, " The channel will be force-closed and the latest commitment transaction from the ChannelMonitor broadcast.");
7189 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
7190 log_bytes!(channel.channel_id()), monitor.get_latest_update_id(), channel.get_latest_monitor_update_id());
7191 let (_, mut new_failed_htlcs) = channel.force_shutdown(true);
7192 failed_htlcs.append(&mut new_failed_htlcs);
7193 monitor.broadcast_latest_holder_commitment_txn(&args.tx_broadcaster, &args.logger);
7194 channel_closures.push(events::Event::ChannelClosed {
7195 channel_id: channel.channel_id(),
7196 user_channel_id: channel.get_user_id(),
7197 reason: ClosureReason::OutdatedChannelManager
7199 for (channel_htlc_source, payment_hash) in channel.inflight_htlc_sources() {
7200 let mut found_htlc = false;
7201 for (monitor_htlc_source, _) in monitor.get_all_current_outbound_htlcs() {
7202 if *channel_htlc_source == monitor_htlc_source { found_htlc = true; break; }
7205 // If we have some HTLCs in the channel which are not present in the newer
7206 // ChannelMonitor, they have been removed and should be failed back to
7207 // ensure we don't forget them entirely. Note that if the missing HTLC(s)
7208 // were actually claimed we'd have generated and ensured the previous-hop
7209 // claim update ChannelMonitor updates were persisted prior to persising
7210 // the ChannelMonitor update for the forward leg, so attempting to fail the
7211 // backwards leg of the HTLC will simply be rejected.
7212 log_info!(args.logger,
7213 "Failing HTLC with hash {} as it is missing in the ChannelMonitor for channel {} but was present in the (stale) ChannelManager",
7214 log_bytes!(channel.channel_id()), log_bytes!(payment_hash.0));
7215 failed_htlcs.push((channel_htlc_source.clone(), *payment_hash, channel.get_counterparty_node_id(), channel.channel_id()));
7219 log_info!(args.logger, "Successfully loaded channel {}", log_bytes!(channel.channel_id()));
7220 if let Some(short_channel_id) = channel.get_short_channel_id() {
7221 short_to_chan_info.insert(short_channel_id, (channel.get_counterparty_node_id(), channel.channel_id()));
7223 if channel.is_funding_initiated() {
7224 id_to_peer.insert(channel.channel_id(), channel.get_counterparty_node_id());
7226 match peer_channels.entry(channel.get_counterparty_node_id()) {
7227 hash_map::Entry::Occupied(mut entry) => {
7228 let by_id_map = entry.get_mut();
7229 by_id_map.insert(channel.channel_id(), channel);
7231 hash_map::Entry::Vacant(entry) => {
7232 let mut by_id_map = HashMap::new();
7233 by_id_map.insert(channel.channel_id(), channel);
7234 entry.insert(by_id_map);
7238 } else if channel.is_awaiting_initial_mon_persist() {
7239 // If we were persisted and shut down while the initial ChannelMonitor persistence
7240 // was in-progress, we never broadcasted the funding transaction and can still
7241 // safely discard the channel.
7242 let _ = channel.force_shutdown(false);
7243 channel_closures.push(events::Event::ChannelClosed {
7244 channel_id: channel.channel_id(),
7245 user_channel_id: channel.get_user_id(),
7246 reason: ClosureReason::DisconnectedPeer,
7249 log_error!(args.logger, "Missing ChannelMonitor for channel {} needed by ChannelManager.", log_bytes!(channel.channel_id()));
7250 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
7251 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
7252 log_error!(args.logger, " Without the ChannelMonitor we cannot continue without risking funds.");
7253 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");
7254 return Err(DecodeError::InvalidValue);
7258 for (funding_txo, monitor) in args.channel_monitors.iter_mut() {
7259 if !funding_txo_set.contains(funding_txo) {
7260 log_info!(args.logger, "Broadcasting latest holder commitment transaction for closed channel {}", log_bytes!(funding_txo.to_channel_id()));
7261 monitor.broadcast_latest_holder_commitment_txn(&args.tx_broadcaster, &args.logger);
7265 const MAX_ALLOC_SIZE: usize = 1024 * 64;
7266 let forward_htlcs_count: u64 = Readable::read(reader)?;
7267 let mut forward_htlcs = HashMap::with_capacity(cmp::min(forward_htlcs_count as usize, 128));
7268 for _ in 0..forward_htlcs_count {
7269 let short_channel_id = Readable::read(reader)?;
7270 let pending_forwards_count: u64 = Readable::read(reader)?;
7271 let mut pending_forwards = Vec::with_capacity(cmp::min(pending_forwards_count as usize, MAX_ALLOC_SIZE/mem::size_of::<HTLCForwardInfo>()));
7272 for _ in 0..pending_forwards_count {
7273 pending_forwards.push(Readable::read(reader)?);
7275 forward_htlcs.insert(short_channel_id, pending_forwards);
7278 let claimable_htlcs_count: u64 = Readable::read(reader)?;
7279 let mut claimable_htlcs_list = Vec::with_capacity(cmp::min(claimable_htlcs_count as usize, 128));
7280 for _ in 0..claimable_htlcs_count {
7281 let payment_hash = Readable::read(reader)?;
7282 let previous_hops_len: u64 = Readable::read(reader)?;
7283 let mut previous_hops = Vec::with_capacity(cmp::min(previous_hops_len as usize, MAX_ALLOC_SIZE/mem::size_of::<ClaimableHTLC>()));
7284 for _ in 0..previous_hops_len {
7285 previous_hops.push(<ClaimableHTLC as Readable>::read(reader)?);
7287 claimable_htlcs_list.push((payment_hash, previous_hops));
7290 let peer_count: u64 = Readable::read(reader)?;
7291 let mut per_peer_state = HashMap::with_capacity(cmp::min(peer_count as usize, MAX_ALLOC_SIZE/mem::size_of::<(PublicKey, Mutex<PeerState<<SP::Target as SignerProvider>::Signer>>)>()));
7292 for _ in 0..peer_count {
7293 let peer_pubkey = Readable::read(reader)?;
7294 let peer_state = PeerState {
7295 channel_by_id: peer_channels.remove(&peer_pubkey).unwrap_or(HashMap::new()),
7296 latest_features: Readable::read(reader)?,
7297 pending_msg_events: Vec::new(),
7298 is_connected: false,
7300 per_peer_state.insert(peer_pubkey, Mutex::new(peer_state));
7303 let event_count: u64 = Readable::read(reader)?;
7304 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>()));
7305 for _ in 0..event_count {
7306 match MaybeReadable::read(reader)? {
7307 Some(event) => pending_events_read.push(event),
7312 let background_event_count: u64 = Readable::read(reader)?;
7313 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>()));
7314 for _ in 0..background_event_count {
7315 match <u8 as Readable>::read(reader)? {
7316 0 => pending_background_events_read.push(BackgroundEvent::ClosingMonitorUpdate((Readable::read(reader)?, Readable::read(reader)?))),
7317 _ => return Err(DecodeError::InvalidValue),
7321 let _last_node_announcement_serial: u32 = Readable::read(reader)?; // Only used < 0.0.111
7322 let highest_seen_timestamp: u32 = Readable::read(reader)?;
7324 let pending_inbound_payment_count: u64 = Readable::read(reader)?;
7325 let mut pending_inbound_payments: HashMap<PaymentHash, PendingInboundPayment> = HashMap::with_capacity(cmp::min(pending_inbound_payment_count as usize, MAX_ALLOC_SIZE/(3*32)));
7326 for _ in 0..pending_inbound_payment_count {
7327 if pending_inbound_payments.insert(Readable::read(reader)?, Readable::read(reader)?).is_some() {
7328 return Err(DecodeError::InvalidValue);
7332 let pending_outbound_payments_count_compat: u64 = Readable::read(reader)?;
7333 let mut pending_outbound_payments_compat: HashMap<PaymentId, PendingOutboundPayment> =
7334 HashMap::with_capacity(cmp::min(pending_outbound_payments_count_compat as usize, MAX_ALLOC_SIZE/32));
7335 for _ in 0..pending_outbound_payments_count_compat {
7336 let session_priv = Readable::read(reader)?;
7337 let payment = PendingOutboundPayment::Legacy {
7338 session_privs: [session_priv].iter().cloned().collect()
7340 if pending_outbound_payments_compat.insert(PaymentId(session_priv), payment).is_some() {
7341 return Err(DecodeError::InvalidValue)
7345 // pending_outbound_payments_no_retry is for compatibility with 0.0.101 clients.
7346 let mut pending_outbound_payments_no_retry: Option<HashMap<PaymentId, HashSet<[u8; 32]>>> = None;
7347 let mut pending_outbound_payments = None;
7348 let mut pending_intercepted_htlcs: Option<HashMap<InterceptId, PendingAddHTLCInfo>> = Some(HashMap::new());
7349 let mut received_network_pubkey: Option<PublicKey> = None;
7350 let mut fake_scid_rand_bytes: Option<[u8; 32]> = None;
7351 let mut probing_cookie_secret: Option<[u8; 32]> = None;
7352 let mut claimable_htlc_purposes = None;
7353 let mut pending_claiming_payments = Some(HashMap::new());
7354 read_tlv_fields!(reader, {
7355 (1, pending_outbound_payments_no_retry, option),
7356 (2, pending_intercepted_htlcs, option),
7357 (3, pending_outbound_payments, option),
7358 (4, pending_claiming_payments, option),
7359 (5, received_network_pubkey, option),
7360 (7, fake_scid_rand_bytes, option),
7361 (9, claimable_htlc_purposes, vec_type),
7362 (11, probing_cookie_secret, option),
7364 if fake_scid_rand_bytes.is_none() {
7365 fake_scid_rand_bytes = Some(args.entropy_source.get_secure_random_bytes());
7368 if probing_cookie_secret.is_none() {
7369 probing_cookie_secret = Some(args.entropy_source.get_secure_random_bytes());
7372 if pending_outbound_payments.is_none() && pending_outbound_payments_no_retry.is_none() {
7373 pending_outbound_payments = Some(pending_outbound_payments_compat);
7374 } else if pending_outbound_payments.is_none() {
7375 let mut outbounds = HashMap::new();
7376 for (id, session_privs) in pending_outbound_payments_no_retry.unwrap().drain() {
7377 outbounds.insert(id, PendingOutboundPayment::Legacy { session_privs });
7379 pending_outbound_payments = Some(outbounds);
7381 // If we're tracking pending payments, ensure we haven't lost any by looking at the
7382 // ChannelMonitor data for any channels for which we do not have authorative state
7383 // (i.e. those for which we just force-closed above or we otherwise don't have a
7384 // corresponding `Channel` at all).
7385 // This avoids several edge-cases where we would otherwise "forget" about pending
7386 // payments which are still in-flight via their on-chain state.
7387 // We only rebuild the pending payments map if we were most recently serialized by
7389 for (_, monitor) in args.channel_monitors.iter() {
7390 if id_to_peer.get(&monitor.get_funding_txo().0.to_channel_id()).is_none() {
7391 for (htlc_source, htlc) in monitor.get_pending_outbound_htlcs() {
7392 if let HTLCSource::OutboundRoute { payment_id, session_priv, path, payment_secret, .. } = htlc_source {
7393 if path.is_empty() {
7394 log_error!(args.logger, "Got an empty path for a pending payment");
7395 return Err(DecodeError::InvalidValue);
7397 let path_amt = path.last().unwrap().fee_msat;
7398 let mut session_priv_bytes = [0; 32];
7399 session_priv_bytes[..].copy_from_slice(&session_priv[..]);
7400 match pending_outbound_payments.as_mut().unwrap().entry(payment_id) {
7401 hash_map::Entry::Occupied(mut entry) => {
7402 let newly_added = entry.get_mut().insert(session_priv_bytes, &path);
7403 log_info!(args.logger, "{} a pending payment path for {} msat for session priv {} on an existing pending payment with payment hash {}",
7404 if newly_added { "Added" } else { "Had" }, path_amt, log_bytes!(session_priv_bytes), log_bytes!(htlc.payment_hash.0));
7406 hash_map::Entry::Vacant(entry) => {
7407 let path_fee = path.get_path_fees();
7408 entry.insert(PendingOutboundPayment::Retryable {
7409 retry_strategy: None,
7410 attempts: PaymentAttempts::new(),
7411 payment_params: None,
7412 session_privs: [session_priv_bytes].iter().map(|a| *a).collect(),
7413 payment_hash: htlc.payment_hash,
7415 keysend_preimage: None, // only used for retries, and we'll never retry on startup
7416 pending_amt_msat: path_amt,
7417 pending_fee_msat: Some(path_fee),
7418 total_msat: path_amt,
7419 starting_block_height: best_block_height,
7421 log_info!(args.logger, "Added a pending payment for {} msat with payment hash {} for path with session priv {}",
7422 path_amt, log_bytes!(htlc.payment_hash.0), log_bytes!(session_priv_bytes));
7427 for (htlc_source, htlc) in monitor.get_all_current_outbound_htlcs() {
7428 if let HTLCSource::PreviousHopData(prev_hop_data) = htlc_source {
7429 let pending_forward_matches_htlc = |info: &PendingAddHTLCInfo| {
7430 info.prev_funding_outpoint == prev_hop_data.outpoint &&
7431 info.prev_htlc_id == prev_hop_data.htlc_id
7433 // The ChannelMonitor is now responsible for this HTLC's
7434 // failure/success and will let us know what its outcome is. If we
7435 // still have an entry for this HTLC in `forward_htlcs` or
7436 // `pending_intercepted_htlcs`, we were apparently not persisted after
7437 // the monitor was when forwarding the payment.
7438 forward_htlcs.retain(|_, forwards| {
7439 forwards.retain(|forward| {
7440 if let HTLCForwardInfo::AddHTLC(htlc_info) = forward {
7441 if pending_forward_matches_htlc(&htlc_info) {
7442 log_info!(args.logger, "Removing pending to-forward HTLC with hash {} as it was forwarded to the closed channel {}",
7443 log_bytes!(htlc.payment_hash.0), log_bytes!(monitor.get_funding_txo().0.to_channel_id()));
7448 !forwards.is_empty()
7450 pending_intercepted_htlcs.as_mut().unwrap().retain(|intercepted_id, htlc_info| {
7451 if pending_forward_matches_htlc(&htlc_info) {
7452 log_info!(args.logger, "Removing pending intercepted HTLC with hash {} as it was forwarded to the closed channel {}",
7453 log_bytes!(htlc.payment_hash.0), log_bytes!(monitor.get_funding_txo().0.to_channel_id()));
7454 pending_events_read.retain(|event| {
7455 if let Event::HTLCIntercepted { intercept_id: ev_id, .. } = event {
7456 intercepted_id != ev_id
7468 if !forward_htlcs.is_empty() {
7469 // If we have pending HTLCs to forward, assume we either dropped a
7470 // `PendingHTLCsForwardable` or the user received it but never processed it as they
7471 // shut down before the timer hit. Either way, set the time_forwardable to a small
7472 // constant as enough time has likely passed that we should simply handle the forwards
7473 // now, or at least after the user gets a chance to reconnect to our peers.
7474 pending_events_read.push(events::Event::PendingHTLCsForwardable {
7475 time_forwardable: Duration::from_secs(2),
7479 let inbound_pmt_key_material = args.node_signer.get_inbound_payment_key_material();
7480 let expanded_inbound_key = inbound_payment::ExpandedKey::new(&inbound_pmt_key_material);
7482 let mut claimable_htlcs = HashMap::with_capacity(claimable_htlcs_list.len());
7483 if let Some(mut purposes) = claimable_htlc_purposes {
7484 if purposes.len() != claimable_htlcs_list.len() {
7485 return Err(DecodeError::InvalidValue);
7487 for (purpose, (payment_hash, previous_hops)) in purposes.drain(..).zip(claimable_htlcs_list.drain(..)) {
7488 claimable_htlcs.insert(payment_hash, (purpose, previous_hops));
7491 // LDK versions prior to 0.0.107 did not write a `pending_htlc_purposes`, but do
7492 // include a `_legacy_hop_data` in the `OnionPayload`.
7493 for (payment_hash, previous_hops) in claimable_htlcs_list.drain(..) {
7494 if previous_hops.is_empty() {
7495 return Err(DecodeError::InvalidValue);
7497 let purpose = match &previous_hops[0].onion_payload {
7498 OnionPayload::Invoice { _legacy_hop_data } => {
7499 if let Some(hop_data) = _legacy_hop_data {
7500 events::PaymentPurpose::InvoicePayment {
7501 payment_preimage: match pending_inbound_payments.get(&payment_hash) {
7502 Some(inbound_payment) => inbound_payment.payment_preimage,
7503 None => match inbound_payment::verify(payment_hash, &hop_data, 0, &expanded_inbound_key, &args.logger) {
7504 Ok((payment_preimage, _)) => payment_preimage,
7506 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));
7507 return Err(DecodeError::InvalidValue);
7511 payment_secret: hop_data.payment_secret,
7513 } else { return Err(DecodeError::InvalidValue); }
7515 OnionPayload::Spontaneous(payment_preimage) =>
7516 events::PaymentPurpose::SpontaneousPayment(*payment_preimage),
7518 claimable_htlcs.insert(payment_hash, (purpose, previous_hops));
7522 let mut secp_ctx = Secp256k1::new();
7523 secp_ctx.seeded_randomize(&args.entropy_source.get_secure_random_bytes());
7525 if !channel_closures.is_empty() {
7526 pending_events_read.append(&mut channel_closures);
7529 let our_network_pubkey = match args.node_signer.get_node_id(Recipient::Node) {
7531 Err(()) => return Err(DecodeError::InvalidValue)
7533 if let Some(network_pubkey) = received_network_pubkey {
7534 if network_pubkey != our_network_pubkey {
7535 log_error!(args.logger, "Key that was generated does not match the existing key.");
7536 return Err(DecodeError::InvalidValue);
7540 let mut outbound_scid_aliases = HashSet::new();
7541 for (_peer_node_id, peer_state_mutex) in per_peer_state.iter_mut() {
7542 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7543 let peer_state = &mut *peer_state_lock;
7544 for (chan_id, chan) in peer_state.channel_by_id.iter_mut() {
7545 if chan.outbound_scid_alias() == 0 {
7546 let mut outbound_scid_alias;
7548 outbound_scid_alias = fake_scid::Namespace::OutboundAlias
7549 .get_fake_scid(best_block_height, &genesis_hash, fake_scid_rand_bytes.as_ref().unwrap(), &args.entropy_source);
7550 if outbound_scid_aliases.insert(outbound_scid_alias) { break; }
7552 chan.set_outbound_scid_alias(outbound_scid_alias);
7553 } else if !outbound_scid_aliases.insert(chan.outbound_scid_alias()) {
7554 // Note that in rare cases its possible to hit this while reading an older
7555 // channel if we just happened to pick a colliding outbound alias above.
7556 log_error!(args.logger, "Got duplicate outbound SCID alias; {}", chan.outbound_scid_alias());
7557 return Err(DecodeError::InvalidValue);
7559 if chan.is_usable() {
7560 if short_to_chan_info.insert(chan.outbound_scid_alias(), (chan.get_counterparty_node_id(), *chan_id)).is_some() {
7561 // Note that in rare cases its possible to hit this while reading an older
7562 // channel if we just happened to pick a colliding outbound alias above.
7563 log_error!(args.logger, "Got duplicate outbound SCID alias; {}", chan.outbound_scid_alias());
7564 return Err(DecodeError::InvalidValue);
7570 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(args.fee_estimator);
7572 for (_, monitor) in args.channel_monitors.iter() {
7573 for (payment_hash, payment_preimage) in monitor.get_stored_preimages() {
7574 if let Some((payment_purpose, claimable_htlcs)) = claimable_htlcs.remove(&payment_hash) {
7575 log_info!(args.logger, "Re-claiming HTLCs with payment hash {} as we've released the preimage to a ChannelMonitor!", log_bytes!(payment_hash.0));
7576 let mut claimable_amt_msat = 0;
7577 let mut receiver_node_id = Some(our_network_pubkey);
7578 let phantom_shared_secret = claimable_htlcs[0].prev_hop.phantom_shared_secret;
7579 if phantom_shared_secret.is_some() {
7580 let phantom_pubkey = args.node_signer.get_node_id(Recipient::PhantomNode)
7581 .expect("Failed to get node_id for phantom node recipient");
7582 receiver_node_id = Some(phantom_pubkey)
7584 for claimable_htlc in claimable_htlcs {
7585 claimable_amt_msat += claimable_htlc.value;
7587 // Add a holding-cell claim of the payment to the Channel, which should be
7588 // applied ~immediately on peer reconnection. Because it won't generate a
7589 // new commitment transaction we can just provide the payment preimage to
7590 // the corresponding ChannelMonitor and nothing else.
7592 // We do so directly instead of via the normal ChannelMonitor update
7593 // procedure as the ChainMonitor hasn't yet been initialized, implying
7594 // we're not allowed to call it directly yet. Further, we do the update
7595 // without incrementing the ChannelMonitor update ID as there isn't any
7597 // If we were to generate a new ChannelMonitor update ID here and then
7598 // crash before the user finishes block connect we'd end up force-closing
7599 // this channel as well. On the flip side, there's no harm in restarting
7600 // without the new monitor persisted - we'll end up right back here on
7602 let previous_channel_id = claimable_htlc.prev_hop.outpoint.to_channel_id();
7603 if let Some(peer_node_id) = id_to_peer.get(&previous_channel_id){
7604 let peer_state_mutex = per_peer_state.get(peer_node_id).unwrap();
7605 let mut peer_state_lock = peer_state_mutex.lock().unwrap();
7606 let peer_state = &mut *peer_state_lock;
7607 if let Some(channel) = peer_state.channel_by_id.get_mut(&previous_channel_id) {
7608 channel.claim_htlc_while_disconnected_dropping_mon_update(claimable_htlc.prev_hop.htlc_id, payment_preimage, &args.logger);
7611 if let Some(previous_hop_monitor) = args.channel_monitors.get(&claimable_htlc.prev_hop.outpoint) {
7612 previous_hop_monitor.provide_payment_preimage(&payment_hash, &payment_preimage, &args.tx_broadcaster, &bounded_fee_estimator, &args.logger);
7615 pending_events_read.push(events::Event::PaymentClaimed {
7618 purpose: payment_purpose,
7619 amount_msat: claimable_amt_msat,
7625 let channel_manager = ChannelManager {
7627 fee_estimator: bounded_fee_estimator,
7628 chain_monitor: args.chain_monitor,
7629 tx_broadcaster: args.tx_broadcaster,
7630 router: args.router,
7632 best_block: RwLock::new(BestBlock::new(best_block_hash, best_block_height)),
7634 inbound_payment_key: expanded_inbound_key,
7635 pending_inbound_payments: Mutex::new(pending_inbound_payments),
7636 pending_outbound_payments: OutboundPayments { pending_outbound_payments: Mutex::new(pending_outbound_payments.unwrap()) },
7637 pending_intercepted_htlcs: Mutex::new(pending_intercepted_htlcs.unwrap()),
7639 forward_htlcs: Mutex::new(forward_htlcs),
7640 claimable_payments: Mutex::new(ClaimablePayments { claimable_htlcs, pending_claiming_payments: pending_claiming_payments.unwrap() }),
7641 outbound_scid_aliases: Mutex::new(outbound_scid_aliases),
7642 id_to_peer: Mutex::new(id_to_peer),
7643 short_to_chan_info: FairRwLock::new(short_to_chan_info),
7644 fake_scid_rand_bytes: fake_scid_rand_bytes.unwrap(),
7646 probing_cookie_secret: probing_cookie_secret.unwrap(),
7651 highest_seen_timestamp: AtomicUsize::new(highest_seen_timestamp as usize),
7653 per_peer_state: FairRwLock::new(per_peer_state),
7655 pending_events: Mutex::new(pending_events_read),
7656 pending_background_events: Mutex::new(pending_background_events_read),
7657 total_consistency_lock: RwLock::new(()),
7658 persistence_notifier: Notifier::new(),
7660 entropy_source: args.entropy_source,
7661 node_signer: args.node_signer,
7662 signer_provider: args.signer_provider,
7664 logger: args.logger,
7665 default_configuration: args.default_config,
7668 for htlc_source in failed_htlcs.drain(..) {
7669 let (source, payment_hash, counterparty_node_id, channel_id) = htlc_source;
7670 let receiver = HTLCDestination::NextHopChannel { node_id: Some(counterparty_node_id), channel_id };
7671 let reason = HTLCFailReason::from_failure_code(0x4000 | 8);
7672 channel_manager.fail_htlc_backwards_internal(&source, &payment_hash, &reason, receiver);
7675 //TODO: Broadcast channel update for closed channels, but only after we've made a
7676 //connection or two.
7678 Ok((best_block_hash.clone(), channel_manager))
7684 use bitcoin::hashes::Hash;
7685 use bitcoin::hashes::sha256::Hash as Sha256;
7686 use bitcoin::hashes::hex::FromHex;
7687 use bitcoin::secp256k1::{PublicKey, Secp256k1, SecretKey};
7688 use bitcoin::secp256k1::ecdsa::Signature;
7689 use bitcoin::secp256k1::ffi::Signature as FFISignature;
7690 use bitcoin::blockdata::script::Script;
7692 use core::time::Duration;
7693 use core::sync::atomic::Ordering;
7694 use crate::ln::{PaymentPreimage, PaymentHash, PaymentSecret};
7695 use crate::ln::channelmanager::{inbound_payment, PaymentId, PaymentSendFailure, InterceptId};
7696 use crate::ln::functional_test_utils::*;
7697 use crate::ln::msgs;
7698 use crate::ln::msgs::{ChannelMessageHandler, OptionalField};
7699 use crate::routing::router::{PaymentParameters, RouteParameters, find_route};
7700 use crate::util::errors::APIError;
7701 use crate::util::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, ClosureReason};
7702 use crate::util::test_utils;
7703 use crate::util::config::ChannelConfig;
7704 use crate::chain::keysinterface::EntropySource;
7707 fn test_notify_limits() {
7708 // Check that a few cases which don't require the persistence of a new ChannelManager,
7709 // indeed, do not cause the persistence of a new ChannelManager.
7710 let chanmon_cfgs = create_chanmon_cfgs(3);
7711 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7712 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7713 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7715 // All nodes start with a persistable update pending as `create_network` connects each node
7716 // with all other nodes to make most tests simpler.
7717 assert!(nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7718 assert!(nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7719 assert!(nodes[2].node.await_persistable_update_timeout(Duration::from_millis(1)));
7721 let mut chan = create_announced_chan_between_nodes(&nodes, 0, 1);
7723 // We check that the channel info nodes have doesn't change too early, even though we try
7724 // to connect messages with new values
7725 chan.0.contents.fee_base_msat *= 2;
7726 chan.1.contents.fee_base_msat *= 2;
7727 let node_a_chan_info = nodes[0].node.list_channels()[0].clone();
7728 let node_b_chan_info = nodes[1].node.list_channels()[0].clone();
7730 // The first two nodes (which opened a channel) should now require fresh persistence
7731 assert!(nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7732 assert!(nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7733 // ... but the last node should not.
7734 assert!(!nodes[2].node.await_persistable_update_timeout(Duration::from_millis(1)));
7735 // After persisting the first two nodes they should no longer need fresh persistence.
7736 assert!(!nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7737 assert!(!nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7739 // Node 3, unrelated to the only channel, shouldn't care if it receives a channel_update
7740 // about the channel.
7741 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.0);
7742 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.1);
7743 assert!(!nodes[2].node.await_persistable_update_timeout(Duration::from_millis(1)));
7745 // The nodes which are a party to the channel should also ignore messages from unrelated
7747 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
7748 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
7749 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
7750 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
7751 assert!(!nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7752 assert!(!nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7754 // At this point the channel info given by peers should still be the same.
7755 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
7756 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
7758 // An earlier version of handle_channel_update didn't check the directionality of the
7759 // update message and would always update the local fee info, even if our peer was
7760 // (spuriously) forwarding us our own channel_update.
7761 let as_node_one = nodes[0].node.get_our_node_id().serialize()[..] < nodes[1].node.get_our_node_id().serialize()[..];
7762 let as_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.0 } else { &chan.1 };
7763 let bs_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.1 } else { &chan.0 };
7765 // First deliver each peers' own message, checking that the node doesn't need to be
7766 // persisted and that its channel info remains the same.
7767 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &as_update);
7768 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &bs_update);
7769 assert!(!nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7770 assert!(!nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7771 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
7772 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
7774 // Finally, deliver the other peers' message, ensuring each node needs to be persisted and
7775 // the channel info has updated.
7776 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &bs_update);
7777 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &as_update);
7778 assert!(nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7779 assert!(nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7780 assert_ne!(nodes[0].node.list_channels()[0], node_a_chan_info);
7781 assert_ne!(nodes[1].node.list_channels()[0], node_b_chan_info);
7785 fn test_keysend_dup_hash_partial_mpp() {
7786 // Test that a keysend payment with a duplicate hash to an existing partial MPP payment fails as
7788 let chanmon_cfgs = create_chanmon_cfgs(2);
7789 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7790 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7791 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7792 create_announced_chan_between_nodes(&nodes, 0, 1);
7794 // First, send a partial MPP payment.
7795 let (route, our_payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[1], 100_000);
7796 let mut mpp_route = route.clone();
7797 mpp_route.paths.push(mpp_route.paths[0].clone());
7799 let payment_id = PaymentId([42; 32]);
7800 // Use the utility function send_payment_along_path to send the payment with MPP data which
7801 // indicates there are more HTLCs coming.
7802 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.
7803 let session_privs = nodes[0].node.test_add_new_pending_payment(our_payment_hash, Some(payment_secret), payment_id, &mpp_route).unwrap();
7804 nodes[0].node.send_payment_along_path(&mpp_route.paths[0], &route.payment_params, &our_payment_hash, &Some(payment_secret), 200_000, cur_height, payment_id, &None, session_privs[0]).unwrap();
7805 check_added_monitors!(nodes[0], 1);
7806 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7807 assert_eq!(events.len(), 1);
7808 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false, None);
7810 // Next, send a keysend payment with the same payment_hash and make sure it fails.
7811 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage), PaymentId(payment_preimage.0)).unwrap();
7812 check_added_monitors!(nodes[0], 1);
7813 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7814 assert_eq!(events.len(), 1);
7815 let ev = events.drain(..).next().unwrap();
7816 let payment_event = SendEvent::from_event(ev);
7817 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7818 check_added_monitors!(nodes[1], 0);
7819 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7820 expect_pending_htlcs_forwardable!(nodes[1]);
7821 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash: our_payment_hash }]);
7822 check_added_monitors!(nodes[1], 1);
7823 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7824 assert!(updates.update_add_htlcs.is_empty());
7825 assert!(updates.update_fulfill_htlcs.is_empty());
7826 assert_eq!(updates.update_fail_htlcs.len(), 1);
7827 assert!(updates.update_fail_malformed_htlcs.is_empty());
7828 assert!(updates.update_fee.is_none());
7829 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
7830 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
7831 expect_payment_failed!(nodes[0], our_payment_hash, true);
7833 // Send the second half of the original MPP payment.
7834 nodes[0].node.send_payment_along_path(&mpp_route.paths[1], &route.payment_params, &our_payment_hash, &Some(payment_secret), 200_000, cur_height, payment_id, &None, session_privs[1]).unwrap();
7835 check_added_monitors!(nodes[0], 1);
7836 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7837 assert_eq!(events.len(), 1);
7838 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), true, None);
7840 // Claim the full MPP payment. Note that we can't use a test utility like
7841 // claim_funds_along_route because the ordering of the messages causes the second half of the
7842 // payment to be put in the holding cell, which confuses the test utilities. So we exchange the
7843 // lightning messages manually.
7844 nodes[1].node.claim_funds(payment_preimage);
7845 expect_payment_claimed!(nodes[1], our_payment_hash, 200_000);
7846 check_added_monitors!(nodes[1], 2);
7848 let bs_first_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7849 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_first_updates.update_fulfill_htlcs[0]);
7850 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_first_updates.commitment_signed);
7851 check_added_monitors!(nodes[0], 1);
7852 let (as_first_raa, as_first_cs) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7853 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_first_raa);
7854 check_added_monitors!(nodes[1], 1);
7855 let bs_second_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7856 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_first_cs);
7857 check_added_monitors!(nodes[1], 1);
7858 let bs_first_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
7859 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_second_updates.update_fulfill_htlcs[0]);
7860 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_updates.commitment_signed);
7861 check_added_monitors!(nodes[0], 1);
7862 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
7863 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
7864 let as_second_updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7865 check_added_monitors!(nodes[0], 1);
7866 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
7867 check_added_monitors!(nodes[1], 1);
7868 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_updates.commitment_signed);
7869 check_added_monitors!(nodes[1], 1);
7870 let bs_third_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
7871 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_third_raa);
7872 check_added_monitors!(nodes[0], 1);
7874 // Note that successful MPP payments will generate a single PaymentSent event upon the first
7875 // path's success and a PaymentPathSuccessful event for each path's success.
7876 let events = nodes[0].node.get_and_clear_pending_events();
7877 assert_eq!(events.len(), 3);
7879 Event::PaymentSent { payment_id: ref id, payment_preimage: ref preimage, payment_hash: ref hash, .. } => {
7880 assert_eq!(Some(payment_id), *id);
7881 assert_eq!(payment_preimage, *preimage);
7882 assert_eq!(our_payment_hash, *hash);
7884 _ => panic!("Unexpected event"),
7887 Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
7888 assert_eq!(payment_id, *actual_payment_id);
7889 assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
7890 assert_eq!(route.paths[0], *path);
7892 _ => panic!("Unexpected event"),
7895 Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
7896 assert_eq!(payment_id, *actual_payment_id);
7897 assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
7898 assert_eq!(route.paths[0], *path);
7900 _ => panic!("Unexpected event"),
7905 fn test_keysend_dup_payment_hash() {
7906 // (1): Test that a keysend payment with a duplicate payment hash to an existing pending
7907 // outbound regular payment fails as expected.
7908 // (2): Test that a regular payment with a duplicate payment hash to an existing keysend payment
7909 // fails as expected.
7910 let chanmon_cfgs = create_chanmon_cfgs(2);
7911 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7912 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7913 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7914 create_announced_chan_between_nodes(&nodes, 0, 1);
7915 let scorer = test_utils::TestScorer::with_penalty(0);
7916 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
7918 // To start (1), send a regular payment but don't claim it.
7919 let expected_route = [&nodes[1]];
7920 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &expected_route, 100_000);
7922 // Next, attempt a keysend payment and make sure it fails.
7923 let route_params = RouteParameters {
7924 payment_params: PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV),
7925 final_value_msat: 100_000,
7926 final_cltv_expiry_delta: TEST_FINAL_CLTV,
7928 let route = find_route(
7929 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
7930 None, nodes[0].logger, &scorer, &random_seed_bytes
7932 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage), PaymentId(payment_preimage.0)).unwrap();
7933 check_added_monitors!(nodes[0], 1);
7934 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7935 assert_eq!(events.len(), 1);
7936 let ev = events.drain(..).next().unwrap();
7937 let payment_event = SendEvent::from_event(ev);
7938 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7939 check_added_monitors!(nodes[1], 0);
7940 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7941 // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
7942 // fails), the second will process the resulting failure and fail the HTLC backward
7943 expect_pending_htlcs_forwardable!(nodes[1]);
7944 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
7945 check_added_monitors!(nodes[1], 1);
7946 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7947 assert!(updates.update_add_htlcs.is_empty());
7948 assert!(updates.update_fulfill_htlcs.is_empty());
7949 assert_eq!(updates.update_fail_htlcs.len(), 1);
7950 assert!(updates.update_fail_malformed_htlcs.is_empty());
7951 assert!(updates.update_fee.is_none());
7952 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
7953 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
7954 expect_payment_failed!(nodes[0], payment_hash, true);
7956 // Finally, claim the original payment.
7957 claim_payment(&nodes[0], &expected_route, payment_preimage);
7959 // To start (2), send a keysend payment but don't claim it.
7960 let payment_preimage = PaymentPreimage([42; 32]);
7961 let route = find_route(
7962 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
7963 None, nodes[0].logger, &scorer, &random_seed_bytes
7965 let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage), PaymentId(payment_preimage.0)).unwrap();
7966 check_added_monitors!(nodes[0], 1);
7967 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7968 assert_eq!(events.len(), 1);
7969 let event = events.pop().unwrap();
7970 let path = vec![&nodes[1]];
7971 pass_along_path(&nodes[0], &path, 100_000, payment_hash, None, event, true, Some(payment_preimage));
7973 // Next, attempt a regular payment and make sure it fails.
7974 let payment_secret = PaymentSecret([43; 32]);
7975 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
7976 check_added_monitors!(nodes[0], 1);
7977 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7978 assert_eq!(events.len(), 1);
7979 let ev = events.drain(..).next().unwrap();
7980 let payment_event = SendEvent::from_event(ev);
7981 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7982 check_added_monitors!(nodes[1], 0);
7983 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7984 expect_pending_htlcs_forwardable!(nodes[1]);
7985 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(nodes[1], vec![HTLCDestination::FailedPayment { payment_hash }]);
7986 check_added_monitors!(nodes[1], 1);
7987 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7988 assert!(updates.update_add_htlcs.is_empty());
7989 assert!(updates.update_fulfill_htlcs.is_empty());
7990 assert_eq!(updates.update_fail_htlcs.len(), 1);
7991 assert!(updates.update_fail_malformed_htlcs.is_empty());
7992 assert!(updates.update_fee.is_none());
7993 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
7994 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
7995 expect_payment_failed!(nodes[0], payment_hash, true);
7997 // Finally, succeed the keysend payment.
7998 claim_payment(&nodes[0], &expected_route, payment_preimage);
8002 fn test_keysend_hash_mismatch() {
8003 // Test that if we receive a keysend `update_add_htlc` msg, we fail as expected if the keysend
8004 // preimage doesn't match the msg's payment hash.
8005 let chanmon_cfgs = create_chanmon_cfgs(2);
8006 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8007 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8008 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8010 let payer_pubkey = nodes[0].node.get_our_node_id();
8011 let payee_pubkey = nodes[1].node.get_our_node_id();
8013 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1]);
8014 let route_params = RouteParameters {
8015 payment_params: PaymentParameters::for_keysend(payee_pubkey, 40),
8016 final_value_msat: 10_000,
8017 final_cltv_expiry_delta: 40,
8019 let network_graph = nodes[0].network_graph.clone();
8020 let first_hops = nodes[0].node.list_usable_channels();
8021 let scorer = test_utils::TestScorer::with_penalty(0);
8022 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
8023 let route = find_route(
8024 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
8025 nodes[0].logger, &scorer, &random_seed_bytes
8028 let test_preimage = PaymentPreimage([42; 32]);
8029 let mismatch_payment_hash = PaymentHash([43; 32]);
8030 let session_privs = nodes[0].node.test_add_new_pending_payment(mismatch_payment_hash, None, PaymentId(mismatch_payment_hash.0), &route).unwrap();
8031 nodes[0].node.test_send_payment_internal(&route, mismatch_payment_hash, &None, Some(test_preimage), PaymentId(mismatch_payment_hash.0), None, session_privs).unwrap();
8032 check_added_monitors!(nodes[0], 1);
8034 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
8035 assert_eq!(updates.update_add_htlcs.len(), 1);
8036 assert!(updates.update_fulfill_htlcs.is_empty());
8037 assert!(updates.update_fail_htlcs.is_empty());
8038 assert!(updates.update_fail_malformed_htlcs.is_empty());
8039 assert!(updates.update_fee.is_none());
8040 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
8042 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Payment preimage didn't match payment hash".to_string(), 1);
8046 fn test_keysend_msg_with_secret_err() {
8047 // Test that we error as expected if we receive a keysend payment that includes a payment secret.
8048 let chanmon_cfgs = create_chanmon_cfgs(2);
8049 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8050 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8051 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8053 let payer_pubkey = nodes[0].node.get_our_node_id();
8054 let payee_pubkey = nodes[1].node.get_our_node_id();
8056 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1]);
8057 let route_params = RouteParameters {
8058 payment_params: PaymentParameters::for_keysend(payee_pubkey, 40),
8059 final_value_msat: 10_000,
8060 final_cltv_expiry_delta: 40,
8062 let network_graph = nodes[0].network_graph.clone();
8063 let first_hops = nodes[0].node.list_usable_channels();
8064 let scorer = test_utils::TestScorer::with_penalty(0);
8065 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
8066 let route = find_route(
8067 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
8068 nodes[0].logger, &scorer, &random_seed_bytes
8071 let test_preimage = PaymentPreimage([42; 32]);
8072 let test_secret = PaymentSecret([43; 32]);
8073 let payment_hash = PaymentHash(Sha256::hash(&test_preimage.0).into_inner());
8074 let session_privs = nodes[0].node.test_add_new_pending_payment(payment_hash, Some(test_secret), PaymentId(payment_hash.0), &route).unwrap();
8075 nodes[0].node.test_send_payment_internal(&route, payment_hash, &Some(test_secret), Some(test_preimage), PaymentId(payment_hash.0), None, session_privs).unwrap();
8076 check_added_monitors!(nodes[0], 1);
8078 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
8079 assert_eq!(updates.update_add_htlcs.len(), 1);
8080 assert!(updates.update_fulfill_htlcs.is_empty());
8081 assert!(updates.update_fail_htlcs.is_empty());
8082 assert!(updates.update_fail_malformed_htlcs.is_empty());
8083 assert!(updates.update_fee.is_none());
8084 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
8086 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "We don't support MPP keysend payments".to_string(), 1);
8090 fn test_multi_hop_missing_secret() {
8091 let chanmon_cfgs = create_chanmon_cfgs(4);
8092 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
8093 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
8094 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
8096 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1).0.contents.short_channel_id;
8097 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2).0.contents.short_channel_id;
8098 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3).0.contents.short_channel_id;
8099 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3).0.contents.short_channel_id;
8101 // Marshall an MPP route.
8102 let (mut route, payment_hash, _, _) = get_route_and_payment_hash!(&nodes[0], nodes[3], 100000);
8103 let path = route.paths[0].clone();
8104 route.paths.push(path);
8105 route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
8106 route.paths[0][0].short_channel_id = chan_1_id;
8107 route.paths[0][1].short_channel_id = chan_3_id;
8108 route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
8109 route.paths[1][0].short_channel_id = chan_2_id;
8110 route.paths[1][1].short_channel_id = chan_4_id;
8112 match nodes[0].node.send_payment(&route, payment_hash, &None, PaymentId(payment_hash.0)).unwrap_err() {
8113 PaymentSendFailure::ParameterError(APIError::APIMisuseError { ref err }) => {
8114 assert!(regex::Regex::new(r"Payment secret is required for multi-path payments").unwrap().is_match(err)) },
8115 _ => panic!("unexpected error")
8120 fn bad_inbound_payment_hash() {
8121 // Add coverage for checking that a user-provided payment hash matches the payment secret.
8122 let chanmon_cfgs = create_chanmon_cfgs(2);
8123 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8124 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8125 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8127 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[0]);
8128 let payment_data = msgs::FinalOnionHopData {
8130 total_msat: 100_000,
8133 // Ensure that if the payment hash given to `inbound_payment::verify` differs from the original,
8134 // payment verification fails as expected.
8135 let mut bad_payment_hash = payment_hash.clone();
8136 bad_payment_hash.0[0] += 1;
8137 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) {
8138 Ok(_) => panic!("Unexpected ok"),
8140 nodes[0].logger.assert_log_contains("lightning::ln::inbound_payment".to_string(), "Failing HTLC with user-generated payment_hash".to_string(), 1);
8144 // Check that using the original payment hash succeeds.
8145 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());
8149 fn test_id_to_peer_coverage() {
8150 // Test that the `ChannelManager:id_to_peer` contains channels which have been assigned
8151 // a `channel_id` (i.e. have had the funding tx created), and that they are removed once
8152 // the channel is successfully closed.
8153 let chanmon_cfgs = create_chanmon_cfgs(2);
8154 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8155 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8156 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8158 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None).unwrap();
8159 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8160 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel);
8161 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8162 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), &accept_channel);
8164 let (temporary_channel_id, tx, _funding_output) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 1_000_000, 42);
8165 let channel_id = &tx.txid().into_inner();
8167 // Ensure that the `id_to_peer` map is empty until either party has received the
8168 // funding transaction, and have the real `channel_id`.
8169 assert_eq!(nodes[0].node.id_to_peer.lock().unwrap().len(), 0);
8170 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
8173 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()).unwrap();
8175 // Assert that `nodes[0]`'s `id_to_peer` map is populated with the channel as soon as
8176 // as it has the funding transaction.
8177 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
8178 assert_eq!(nodes_0_lock.len(), 1);
8179 assert!(nodes_0_lock.contains_key(channel_id));
8181 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
8184 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
8186 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
8188 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
8189 assert_eq!(nodes_0_lock.len(), 1);
8190 assert!(nodes_0_lock.contains_key(channel_id));
8192 // Assert that `nodes[1]`'s `id_to_peer` map is populated with the channel as soon as
8193 // as it has the funding transaction.
8194 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
8195 assert_eq!(nodes_1_lock.len(), 1);
8196 assert!(nodes_1_lock.contains_key(channel_id));
8198 check_added_monitors!(nodes[1], 1);
8199 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
8200 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
8201 check_added_monitors!(nodes[0], 1);
8202 let (channel_ready, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
8203 let (announcement, nodes_0_update, nodes_1_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &channel_ready);
8204 update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &nodes_0_update, &nodes_1_update);
8206 nodes[0].node.close_channel(channel_id, &nodes[1].node.get_our_node_id()).unwrap();
8207 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id()));
8208 let nodes_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
8209 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &nodes_1_shutdown);
8211 let closing_signed_node_0 = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
8212 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_node_0);
8214 // Assert that the channel is kept in the `id_to_peer` map for both nodes until the
8215 // channel can be fully closed by both parties (i.e. no outstanding htlcs exists, the
8216 // fee for the closing transaction has been negotiated and the parties has the other
8217 // party's signature for the fee negotiated closing transaction.)
8218 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
8219 assert_eq!(nodes_0_lock.len(), 1);
8220 assert!(nodes_0_lock.contains_key(channel_id));
8222 // At this stage, `nodes[1]` has proposed a fee for the closing transaction in the
8223 // `handle_closing_signed` call above. As `nodes[1]` has not yet received the signature
8224 // from `nodes[0]` for the closing transaction with the proposed fee, the channel is
8225 // kept in the `nodes[1]`'s `id_to_peer` map.
8226 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
8227 assert_eq!(nodes_1_lock.len(), 1);
8228 assert!(nodes_1_lock.contains_key(channel_id));
8231 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &get_event_msg!(nodes[1], MessageSendEvent::SendClosingSigned, nodes[0].node.get_our_node_id()));
8233 // `nodes[0]` accepts `nodes[1]`'s proposed fee for the closing transaction, and
8234 // therefore has all it needs to fully close the channel (both signatures for the
8235 // closing transaction).
8236 // Assert that the channel is removed from `nodes[0]`'s `id_to_peer` map as it can be
8237 // fully closed by `nodes[0]`.
8238 assert_eq!(nodes[0].node.id_to_peer.lock().unwrap().len(), 0);
8240 // Assert that the channel is still in `nodes[1]`'s `id_to_peer` map, as `nodes[1]`
8241 // doesn't have `nodes[0]`'s signature for the closing transaction yet.
8242 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
8243 assert_eq!(nodes_1_lock.len(), 1);
8244 assert!(nodes_1_lock.contains_key(channel_id));
8247 let (_nodes_0_update, closing_signed_node_0) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
8249 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_node_0.unwrap());
8251 // Assert that the channel has now been removed from both parties `id_to_peer` map once
8252 // they both have everything required to fully close the channel.
8253 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
8255 let (_nodes_1_update, _none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
8257 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
8258 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
8261 fn check_not_connected_to_peer_error<T>(res_err: Result<T, APIError>, expected_public_key: PublicKey) {
8262 let expected_message = format!("Not connected to node: {}", expected_public_key);
8263 check_api_misuse_error_message(expected_message, res_err)
8266 fn check_unkown_peer_error<T>(res_err: Result<T, APIError>, expected_public_key: PublicKey) {
8267 let expected_message = format!("Can't find a peer matching the passed counterparty node_id {}", expected_public_key);
8268 check_api_misuse_error_message(expected_message, res_err)
8271 fn check_api_misuse_error_message<T>(expected_err_message: String, res_err: Result<T, APIError>) {
8273 Err(APIError::APIMisuseError { err }) => {
8274 assert_eq!(err, expected_err_message);
8276 Ok(_) => panic!("Unexpected Ok"),
8277 Err(_) => panic!("Unexpected Error"),
8282 fn test_api_calls_with_unkown_counterparty_node() {
8283 // Tests that our API functions and message handlers that expects a `counterparty_node_id`
8284 // as input, behaves as expected if the `counterparty_node_id` is an unkown peer in the
8285 // `ChannelManager::per_peer_state` map.
8286 let chanmon_cfg = create_chanmon_cfgs(2);
8287 let node_cfg = create_node_cfgs(2, &chanmon_cfg);
8288 let node_chanmgr = create_node_chanmgrs(2, &node_cfg, &[None, None]);
8289 let nodes = create_network(2, &node_cfg, &node_chanmgr);
8291 // Boilerplate code to produce `open_channel` and `accept_channel` msgs more densly than
8292 // creating dummy ones.
8293 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None).unwrap();
8294 let open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8295 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
8296 let accept_channel_msg = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8299 let channel_id = [4; 32];
8300 let signature = Signature::from(unsafe { FFISignature::new() });
8301 let unkown_public_key = PublicKey::from_secret_key(&Secp256k1::signing_only(), &SecretKey::from_slice(&[42; 32]).unwrap());
8302 let intercept_id = InterceptId([0; 32]);
8305 let funding_created_msg = msgs::FundingCreated {
8306 temporary_channel_id: open_channel_msg.temporary_channel_id,
8307 funding_txid: Txid::from_hex("ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap(),
8308 funding_output_index: 0,
8309 signature: signature,
8312 let funding_signed_msg = msgs::FundingSigned {
8313 channel_id: channel_id,
8314 signature: signature,
8317 let channel_ready_msg = msgs::ChannelReady {
8318 channel_id: channel_id,
8319 next_per_commitment_point: unkown_public_key,
8320 short_channel_id_alias: None,
8323 let announcement_signatures_msg = msgs::AnnouncementSignatures {
8324 channel_id: channel_id,
8325 short_channel_id: 0,
8326 node_signature: signature,
8327 bitcoin_signature: signature,
8330 let channel_reestablish_msg = msgs::ChannelReestablish {
8331 channel_id: channel_id,
8332 next_local_commitment_number: 0,
8333 next_remote_commitment_number: 0,
8334 data_loss_protect: OptionalField::Absent,
8337 let closing_signed_msg = msgs::ClosingSigned {
8338 channel_id: channel_id,
8340 signature: signature,
8344 let shutdown_msg = msgs::Shutdown {
8345 channel_id: channel_id,
8346 scriptpubkey: Script::new(),
8349 let onion_routing_packet = msgs::OnionPacket {
8351 public_key: Ok(unkown_public_key),
8352 hop_data: [1; 20*65],
8356 let update_add_htlc_msg = msgs::UpdateAddHTLC {
8357 channel_id: channel_id,
8359 amount_msat: 1000000,
8360 payment_hash: PaymentHash([1; 32]),
8361 cltv_expiry: 821716,
8362 onion_routing_packet
8365 let commitment_signed_msg = msgs::CommitmentSigned {
8366 channel_id: channel_id,
8367 signature: signature,
8368 htlc_signatures: Vec::new(),
8371 let update_fee_msg = msgs::UpdateFee {
8372 channel_id: channel_id,
8373 feerate_per_kw: 1000,
8376 let malformed_update_msg = msgs::UpdateFailMalformedHTLC{
8377 channel_id: channel_id,
8379 sha256_of_onion: [1; 32],
8380 failure_code: 0x8000,
8383 let fulfill_update_msg = msgs::UpdateFulfillHTLC{
8384 channel_id: channel_id,
8386 payment_preimage: PaymentPreimage([1; 32]),
8389 let fail_update_msg = msgs::UpdateFailHTLC{
8390 channel_id: channel_id,
8392 reason: msgs::OnionErrorPacket { data: Vec::new()},
8395 let revoke_and_ack_msg = msgs::RevokeAndACK {
8396 channel_id: channel_id,
8397 per_commitment_secret: [1; 32],
8398 next_per_commitment_point: unkown_public_key,
8401 // Test the API functions and message handlers.
8402 check_not_connected_to_peer_error(nodes[0].node.create_channel(unkown_public_key, 1_000_000, 500_000_000, 42, None), unkown_public_key);
8404 nodes[1].node.handle_open_channel(&unkown_public_key, &open_channel_msg);
8406 nodes[0].node.handle_accept_channel(&unkown_public_key, &accept_channel_msg);
8408 check_unkown_peer_error(nodes[0].node.accept_inbound_channel(&open_channel_msg.temporary_channel_id, &unkown_public_key, 42), unkown_public_key);
8410 nodes[1].node.handle_funding_created(&unkown_public_key, &funding_created_msg);
8412 nodes[0].node.handle_funding_signed(&unkown_public_key, &funding_signed_msg);
8414 nodes[0].node.handle_channel_ready(&unkown_public_key, &channel_ready_msg);
8416 nodes[1].node.handle_announcement_signatures(&unkown_public_key, &announcement_signatures_msg);
8418 check_unkown_peer_error(nodes[0].node.close_channel(&channel_id, &unkown_public_key), unkown_public_key);
8420 check_unkown_peer_error(nodes[0].node.force_close_broadcasting_latest_txn(&channel_id, &unkown_public_key), unkown_public_key);
8422 check_unkown_peer_error(nodes[0].node.force_close_without_broadcasting_txn(&channel_id, &unkown_public_key), unkown_public_key);
8424 check_unkown_peer_error(nodes[0].node.forward_intercepted_htlc(intercept_id, &channel_id, unkown_public_key, 1_000_000), unkown_public_key);
8426 check_unkown_peer_error(nodes[0].node.update_channel_config(&unkown_public_key, &[channel_id], &ChannelConfig::default()), unkown_public_key);
8428 nodes[0].node.handle_shutdown(&unkown_public_key, &shutdown_msg);
8430 nodes[1].node.handle_closing_signed(&unkown_public_key, &closing_signed_msg);
8432 nodes[0].node.handle_channel_reestablish(&unkown_public_key, &channel_reestablish_msg);
8434 nodes[1].node.handle_update_add_htlc(&unkown_public_key, &update_add_htlc_msg);
8436 nodes[1].node.handle_commitment_signed(&unkown_public_key, &commitment_signed_msg);
8438 nodes[1].node.handle_update_fail_malformed_htlc(&unkown_public_key, &malformed_update_msg);
8440 nodes[1].node.handle_update_fail_htlc(&unkown_public_key, &fail_update_msg);
8442 nodes[1].node.handle_update_fulfill_htlc(&unkown_public_key, &fulfill_update_msg);
8444 nodes[1].node.handle_revoke_and_ack(&unkown_public_key, &revoke_and_ack_msg);
8446 nodes[1].node.handle_update_fee(&unkown_public_key, &update_fee_msg);
8451 fn test_anchors_zero_fee_htlc_tx_fallback() {
8452 // Tests that if both nodes support anchors, but the remote node does not want to accept
8453 // anchor channels at the moment, an error it sent to the local node such that it can retry
8454 // the channel without the anchors feature.
8455 let chanmon_cfgs = create_chanmon_cfgs(2);
8456 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8457 let mut anchors_config = test_default_channel_config();
8458 anchors_config.channel_handshake_config.negotiate_anchors_zero_fee_htlc_tx = true;
8459 anchors_config.manually_accept_inbound_channels = true;
8460 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(anchors_config.clone()), Some(anchors_config.clone())]);
8461 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8463 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100_000, 0, 0, None).unwrap();
8464 let open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8465 assert!(open_channel_msg.channel_type.as_ref().unwrap().supports_anchors_zero_fee_htlc_tx());
8467 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), &open_channel_msg);
8468 let events = nodes[1].node.get_and_clear_pending_events();
8470 Event::OpenChannelRequest { temporary_channel_id, .. } => {
8471 nodes[1].node.force_close_broadcasting_latest_txn(&temporary_channel_id, &nodes[0].node.get_our_node_id()).unwrap();
8473 _ => panic!("Unexpected event"),
8476 let error_msg = get_err_msg!(nodes[1], nodes[0].node.get_our_node_id());
8477 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &error_msg);
8479 let open_channel_msg = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8480 assert!(!open_channel_msg.channel_type.unwrap().supports_anchors_zero_fee_htlc_tx());
8482 check_closed_event!(nodes[1], 1, ClosureReason::HolderForceClosed);
8486 #[cfg(all(any(test, feature = "_test_utils"), feature = "_bench_unstable"))]
8488 use crate::chain::Listen;
8489 use crate::chain::chainmonitor::{ChainMonitor, Persist};
8490 use crate::chain::keysinterface::{EntropySource, KeysManager, InMemorySigner};
8491 use crate::ln::channelmanager::{self, BestBlock, ChainParameters, ChannelManager, PaymentHash, PaymentPreimage, PaymentId};
8492 use crate::ln::functional_test_utils::*;
8493 use crate::ln::msgs::{ChannelMessageHandler, Init};
8494 use crate::routing::gossip::NetworkGraph;
8495 use crate::routing::router::{PaymentParameters, get_route};
8496 use crate::util::test_utils;
8497 use crate::util::config::UserConfig;
8498 use crate::util::events::{Event, MessageSendEvent, MessageSendEventsProvider};
8500 use bitcoin::hashes::Hash;
8501 use bitcoin::hashes::sha256::Hash as Sha256;
8502 use bitcoin::{Block, BlockHeader, PackedLockTime, Transaction, TxMerkleNode, TxOut};
8504 use crate::sync::{Arc, Mutex};
8508 struct NodeHolder<'a, P: Persist<InMemorySigner>> {
8509 node: &'a ChannelManager<
8510 &'a ChainMonitor<InMemorySigner, &'a test_utils::TestChainSource,
8511 &'a test_utils::TestBroadcaster, &'a test_utils::TestFeeEstimator,
8512 &'a test_utils::TestLogger, &'a P>,
8513 &'a test_utils::TestBroadcaster, &'a KeysManager, &'a KeysManager, &'a KeysManager,
8514 &'a test_utils::TestFeeEstimator, &'a test_utils::TestRouter<'a>,
8515 &'a test_utils::TestLogger>,
8520 fn bench_sends(bench: &mut Bencher) {
8521 bench_two_sends(bench, test_utils::TestPersister::new(), test_utils::TestPersister::new());
8524 pub fn bench_two_sends<P: Persist<InMemorySigner>>(bench: &mut Bencher, persister_a: P, persister_b: P) {
8525 // Do a simple benchmark of sending a payment back and forth between two nodes.
8526 // Note that this is unrealistic as each payment send will require at least two fsync
8528 let network = bitcoin::Network::Testnet;
8529 let genesis_hash = bitcoin::blockdata::constants::genesis_block(network).header.block_hash();
8531 let tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), blocks: Arc::new(Mutex::new(Vec::new()))};
8532 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
8533 let logger_a = test_utils::TestLogger::with_id("node a".to_owned());
8534 let router = test_utils::TestRouter::new(Arc::new(NetworkGraph::new(genesis_hash, &logger_a)));
8536 let mut config: UserConfig = Default::default();
8537 config.channel_handshake_config.minimum_depth = 1;
8539 let chain_monitor_a = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_a);
8540 let seed_a = [1u8; 32];
8541 let keys_manager_a = KeysManager::new(&seed_a, 42, 42);
8542 let node_a = ChannelManager::new(&fee_estimator, &chain_monitor_a, &tx_broadcaster, &router, &logger_a, &keys_manager_a, &keys_manager_a, &keys_manager_a, config.clone(), ChainParameters {
8544 best_block: BestBlock::from_genesis(network),
8546 let node_a_holder = NodeHolder { node: &node_a };
8548 let logger_b = test_utils::TestLogger::with_id("node a".to_owned());
8549 let chain_monitor_b = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_b);
8550 let seed_b = [2u8; 32];
8551 let keys_manager_b = KeysManager::new(&seed_b, 42, 42);
8552 let node_b = ChannelManager::new(&fee_estimator, &chain_monitor_b, &tx_broadcaster, &router, &logger_b, &keys_manager_b, &keys_manager_b, &keys_manager_b, config.clone(), ChainParameters {
8554 best_block: BestBlock::from_genesis(network),
8556 let node_b_holder = NodeHolder { node: &node_b };
8558 node_a.peer_connected(&node_b.get_our_node_id(), &Init { features: node_b.init_features(), remote_network_address: None }).unwrap();
8559 node_b.peer_connected(&node_a.get_our_node_id(), &Init { features: node_a.init_features(), remote_network_address: None }).unwrap();
8560 node_a.create_channel(node_b.get_our_node_id(), 8_000_000, 100_000_000, 42, None).unwrap();
8561 node_b.handle_open_channel(&node_a.get_our_node_id(), &get_event_msg!(node_a_holder, MessageSendEvent::SendOpenChannel, node_b.get_our_node_id()));
8562 node_a.handle_accept_channel(&node_b.get_our_node_id(), &get_event_msg!(node_b_holder, MessageSendEvent::SendAcceptChannel, node_a.get_our_node_id()));
8565 if let Event::FundingGenerationReady { temporary_channel_id, output_script, .. } = get_event!(node_a_holder, Event::FundingGenerationReady) {
8566 tx = Transaction { version: 2, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: vec![TxOut {
8567 value: 8_000_000, script_pubkey: output_script,
8569 node_a.funding_transaction_generated(&temporary_channel_id, &node_b.get_our_node_id(), tx.clone()).unwrap();
8570 } else { panic!(); }
8572 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()));
8573 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()));
8575 assert_eq!(&tx_broadcaster.txn_broadcasted.lock().unwrap()[..], &[tx.clone()]);
8578 header: BlockHeader { version: 0x20000000, prev_blockhash: genesis_hash, merkle_root: TxMerkleNode::all_zeros(), time: 42, bits: 42, nonce: 42 },
8581 Listen::block_connected(&node_a, &block, 1);
8582 Listen::block_connected(&node_b, &block, 1);
8584 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()));
8585 let msg_events = node_a.get_and_clear_pending_msg_events();
8586 assert_eq!(msg_events.len(), 2);
8587 match msg_events[0] {
8588 MessageSendEvent::SendChannelReady { ref msg, .. } => {
8589 node_b.handle_channel_ready(&node_a.get_our_node_id(), msg);
8590 get_event_msg!(node_b_holder, MessageSendEvent::SendChannelUpdate, node_a.get_our_node_id());
8594 match msg_events[1] {
8595 MessageSendEvent::SendChannelUpdate { .. } => {},
8599 let events_a = node_a.get_and_clear_pending_events();
8600 assert_eq!(events_a.len(), 1);
8602 Event::ChannelReady{ ref counterparty_node_id, .. } => {
8603 assert_eq!(*counterparty_node_id, node_b.get_our_node_id());
8605 _ => panic!("Unexpected event"),
8608 let events_b = node_b.get_and_clear_pending_events();
8609 assert_eq!(events_b.len(), 1);
8611 Event::ChannelReady{ ref counterparty_node_id, .. } => {
8612 assert_eq!(*counterparty_node_id, node_a.get_our_node_id());
8614 _ => panic!("Unexpected event"),
8617 let dummy_graph = NetworkGraph::new(genesis_hash, &logger_a);
8619 let mut payment_count: u64 = 0;
8620 macro_rules! send_payment {
8621 ($node_a: expr, $node_b: expr) => {
8622 let usable_channels = $node_a.list_usable_channels();
8623 let payment_params = PaymentParameters::from_node_id($node_b.get_our_node_id(), TEST_FINAL_CLTV)
8624 .with_features($node_b.invoice_features());
8625 let scorer = test_utils::TestScorer::with_penalty(0);
8626 let seed = [3u8; 32];
8627 let keys_manager = KeysManager::new(&seed, 42, 42);
8628 let random_seed_bytes = keys_manager.get_secure_random_bytes();
8629 let route = get_route(&$node_a.get_our_node_id(), &payment_params, &dummy_graph.read_only(),
8630 Some(&usable_channels.iter().map(|r| r).collect::<Vec<_>>()), 10_000, TEST_FINAL_CLTV, &logger_a, &scorer, &random_seed_bytes).unwrap();
8632 let mut payment_preimage = PaymentPreimage([0; 32]);
8633 payment_preimage.0[0..8].copy_from_slice(&payment_count.to_le_bytes());
8635 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
8636 let payment_secret = $node_b.create_inbound_payment_for_hash(payment_hash, None, 7200, None).unwrap();
8638 $node_a.send_payment(&route, payment_hash, &Some(payment_secret), PaymentId(payment_hash.0)).unwrap();
8639 let payment_event = SendEvent::from_event($node_a.get_and_clear_pending_msg_events().pop().unwrap());
8640 $node_b.handle_update_add_htlc(&$node_a.get_our_node_id(), &payment_event.msgs[0]);
8641 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &payment_event.commitment_msg);
8642 let (raa, cs) = get_revoke_commit_msgs!(NodeHolder { node: &$node_b }, $node_a.get_our_node_id());
8643 $node_a.handle_revoke_and_ack(&$node_b.get_our_node_id(), &raa);
8644 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &cs);
8645 $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()));
8647 expect_pending_htlcs_forwardable!(NodeHolder { node: &$node_b });
8648 expect_payment_claimable!(NodeHolder { node: &$node_b }, payment_hash, payment_secret, 10_000);
8649 $node_b.claim_funds(payment_preimage);
8650 expect_payment_claimed!(NodeHolder { node: &$node_b }, payment_hash, 10_000);
8652 match $node_b.get_and_clear_pending_msg_events().pop().unwrap() {
8653 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
8654 assert_eq!(node_id, $node_a.get_our_node_id());
8655 $node_a.handle_update_fulfill_htlc(&$node_b.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8656 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &updates.commitment_signed);
8658 _ => panic!("Failed to generate claim event"),
8661 let (raa, cs) = get_revoke_commit_msgs!(NodeHolder { node: &$node_a }, $node_b.get_our_node_id());
8662 $node_b.handle_revoke_and_ack(&$node_a.get_our_node_id(), &raa);
8663 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &cs);
8664 $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()));
8666 expect_payment_sent!(NodeHolder { node: &$node_a }, payment_preimage);
8671 send_payment!(node_a, node_b);
8672 send_payment!(node_b, node_a);