1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! The top-level channel management and payment tracking stuff lives here.
12 //! The ChannelManager is the main chunk of logic implementing the lightning protocol and is
13 //! responsible for tracking which channels are open, HTLCs are in flight and reestablishing those
14 //! upon reconnect to the relevant peer(s).
16 //! It does not manage routing logic (see [`find_route`] for that) nor does it manage constructing
17 //! on-chain transactions (it only monitors the chain to watch for any force-closes that might
18 //! imply it needs to fail HTLCs/payments/channels it manages).
20 //! [`find_route`]: crate::routing::router::find_route
22 use bitcoin::blockdata::block::BlockHeader;
23 use bitcoin::blockdata::transaction::Transaction;
24 use bitcoin::blockdata::constants::genesis_block;
25 use bitcoin::network::constants::Network;
27 use bitcoin::hashes::Hash;
28 use bitcoin::hashes::sha256::Hash as Sha256;
29 use bitcoin::hashes::sha256d::Hash as Sha256dHash;
30 use bitcoin::hash_types::{BlockHash, Txid};
32 use bitcoin::secp256k1::{SecretKey,PublicKey};
33 use bitcoin::secp256k1::Secp256k1;
34 use bitcoin::secp256k1::ecdh::SharedSecret;
35 use bitcoin::secp256k1;
38 use chain::{Confirm, ChannelMonitorUpdateErr, Watch, BestBlock};
39 use chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator, LowerBoundedFeeEstimator};
40 use chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, ChannelMonitorUpdateStep, HTLC_FAIL_BACK_BUFFER, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY, MonitorEvent, CLOSED_CHANNEL_UPDATE_ID};
41 use chain::transaction::{OutPoint, TransactionData};
42 // Since this struct is returned in `list_channels` methods, expose it here in case users want to
43 // construct one themselves.
44 use ln::{inbound_payment, PaymentHash, PaymentPreimage, PaymentSecret};
45 use ln::channel::{Channel, ChannelError, ChannelUpdateStatus, UpdateFulfillCommitFetch};
46 use ln::features::{ChannelTypeFeatures, InitFeatures, NodeFeatures};
47 use routing::router::{PaymentParameters, Route, RouteHop, RoutePath, RouteParameters};
49 use ln::msgs::NetAddress;
51 use ln::msgs::{ChannelMessageHandler, DecodeError, LightningError, MAX_VALUE_MSAT, OptionalField};
53 use chain::keysinterface::{Sign, KeysInterface, KeysManager, InMemorySigner, Recipient};
54 use util::config::{UserConfig, ChannelConfig};
55 use util::events::{EventHandler, EventsProvider, MessageSendEvent, MessageSendEventsProvider, ClosureReason};
56 use util::{byte_utils, events};
57 use util::scid_utils::fake_scid;
58 use util::ser::{BigSize, FixedLengthReader, Readable, ReadableArgs, MaybeReadable, Writeable, Writer, VecWriter};
59 use util::logger::{Level, Logger};
60 use util::errors::APIError;
65 use core::cell::RefCell;
67 use sync::{Arc, Condvar, Mutex, MutexGuard, RwLock, RwLockReadGuard};
68 use core::sync::atomic::{AtomicUsize, Ordering};
69 use core::time::Duration;
72 #[cfg(any(test, feature = "std"))]
73 use std::time::Instant;
74 use util::crypto::sign;
76 // We hold various information about HTLC relay in the HTLC objects in Channel itself:
78 // Upon receipt of an HTLC from a peer, we'll give it a PendingHTLCStatus indicating if it should
79 // forward the HTLC with information it will give back to us when it does so, or if it should Fail
80 // the HTLC with the relevant message for the Channel to handle giving to the remote peer.
82 // Once said HTLC is committed in the Channel, if the PendingHTLCStatus indicated Forward, the
83 // Channel will return the PendingHTLCInfo back to us, and we will create an HTLCForwardInfo
84 // with it to track where it came from (in case of onwards-forward error), waiting a random delay
85 // before we forward it.
87 // We will then use HTLCForwardInfo's PendingHTLCInfo to construct an outbound HTLC, with a
88 // relevant HTLCSource::PreviousHopData filled in to indicate where it came from (which we can use
89 // to either fail-backwards or fulfill the HTLC backwards along the relevant path).
90 // Alternatively, we can fill an outbound HTLC with a HTLCSource::OutboundRoute indicating this is
91 // our payment, which we can use to decode errors or inform the user that the payment was sent.
93 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
94 pub(super) enum PendingHTLCRouting {
96 onion_packet: msgs::OnionPacket,
97 /// The SCID from the onion that we should forward to. This could be a "real" SCID, an
98 /// outbound SCID alias, or a phantom node SCID.
99 short_channel_id: u64, // This should be NonZero<u64> eventually when we bump MSRV
102 payment_data: msgs::FinalOnionHopData,
103 incoming_cltv_expiry: u32, // Used to track when we should expire pending HTLCs that go unclaimed
104 phantom_shared_secret: Option<[u8; 32]>,
107 payment_preimage: PaymentPreimage,
108 incoming_cltv_expiry: u32, // Used to track when we should expire pending HTLCs that go unclaimed
112 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
113 pub(super) struct PendingHTLCInfo {
114 pub(super) routing: PendingHTLCRouting,
115 pub(super) incoming_shared_secret: [u8; 32],
116 payment_hash: PaymentHash,
117 pub(super) amt_to_forward: u64,
118 pub(super) outgoing_cltv_value: u32,
121 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
122 pub(super) enum HTLCFailureMsg {
123 Relay(msgs::UpdateFailHTLC),
124 Malformed(msgs::UpdateFailMalformedHTLC),
127 /// Stores whether we can't forward an HTLC or relevant forwarding info
128 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
129 pub(super) enum PendingHTLCStatus {
130 Forward(PendingHTLCInfo),
131 Fail(HTLCFailureMsg),
134 pub(super) enum HTLCForwardInfo {
136 forward_info: PendingHTLCInfo,
138 // These fields are produced in `forward_htlcs()` and consumed in
139 // `process_pending_htlc_forwards()` for constructing the
140 // `HTLCSource::PreviousHopData` for failed and forwarded
143 // Note that this may be an outbound SCID alias for the associated channel.
144 prev_short_channel_id: u64,
146 prev_funding_outpoint: OutPoint,
150 err_packet: msgs::OnionErrorPacket,
154 /// Tracks the inbound corresponding to an outbound HTLC
155 #[derive(Clone, Hash, PartialEq, Eq)]
156 pub(crate) struct HTLCPreviousHopData {
157 // Note that this may be an outbound SCID alias for the associated channel.
158 short_channel_id: u64,
160 incoming_packet_shared_secret: [u8; 32],
161 phantom_shared_secret: Option<[u8; 32]>,
163 // This field is consumed by `claim_funds_from_hop()` when updating a force-closed backwards
164 // channel with a preimage provided by the forward channel.
169 /// Indicates this incoming onion payload is for the purpose of paying an invoice.
171 /// This is only here for backwards-compatibility in serialization, in the future it can be
172 /// removed, breaking clients running 0.0.106 and earlier.
173 _legacy_hop_data: Option<msgs::FinalOnionHopData>,
175 /// Contains the payer-provided preimage.
176 Spontaneous(PaymentPreimage),
179 /// HTLCs that are to us and can be failed/claimed by the user
180 struct ClaimableHTLC {
181 prev_hop: HTLCPreviousHopData,
183 /// The amount (in msats) of this MPP part
185 onion_payload: OnionPayload,
187 /// The sum total of all MPP parts
191 /// A payment identifier used to uniquely identify a payment to LDK.
192 /// (C-not exported) as we just use [u8; 32] directly
193 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
194 pub struct PaymentId(pub [u8; 32]);
196 impl Writeable for PaymentId {
197 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
202 impl Readable for PaymentId {
203 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
204 let buf: [u8; 32] = Readable::read(r)?;
208 /// Tracks the inbound corresponding to an outbound HTLC
209 #[allow(clippy::derive_hash_xor_eq)] // Our Hash is faithful to the data, we just don't have SecretKey::hash
210 #[derive(Clone, PartialEq, Eq)]
211 pub(crate) enum HTLCSource {
212 PreviousHopData(HTLCPreviousHopData),
215 session_priv: SecretKey,
216 /// Technically we can recalculate this from the route, but we cache it here to avoid
217 /// doing a double-pass on route when we get a failure back
218 first_hop_htlc_msat: u64,
219 payment_id: PaymentId,
220 payment_secret: Option<PaymentSecret>,
221 payment_params: Option<PaymentParameters>,
224 #[allow(clippy::derive_hash_xor_eq)] // Our Hash is faithful to the data, we just don't have SecretKey::hash
225 impl core::hash::Hash for HTLCSource {
226 fn hash<H: core::hash::Hasher>(&self, hasher: &mut H) {
228 HTLCSource::PreviousHopData(prev_hop_data) => {
230 prev_hop_data.hash(hasher);
232 HTLCSource::OutboundRoute { path, session_priv, payment_id, payment_secret, first_hop_htlc_msat, payment_params } => {
235 session_priv[..].hash(hasher);
236 payment_id.hash(hasher);
237 payment_secret.hash(hasher);
238 first_hop_htlc_msat.hash(hasher);
239 payment_params.hash(hasher);
244 #[cfg(not(feature = "grind_signatures"))]
247 pub fn dummy() -> Self {
248 HTLCSource::OutboundRoute {
250 session_priv: SecretKey::from_slice(&[1; 32]).unwrap(),
251 first_hop_htlc_msat: 0,
252 payment_id: PaymentId([2; 32]),
253 payment_secret: None,
254 payment_params: None,
259 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
260 pub(super) enum HTLCFailReason {
262 err: msgs::OnionErrorPacket,
270 struct ReceiveError {
276 /// Return value for claim_funds_from_hop
277 enum ClaimFundsFromHop {
279 MonitorUpdateFail(PublicKey, MsgHandleErrInternal, Option<u64>),
284 type ShutdownResult = (Option<(OutPoint, ChannelMonitorUpdate)>, Vec<(HTLCSource, PaymentHash)>);
286 /// Error type returned across the channel_state mutex boundary. When an Err is generated for a
287 /// Channel, we generally end up with a ChannelError::Close for which we have to close the channel
288 /// immediately (ie with no further calls on it made). Thus, this step happens inside a
289 /// channel_state lock. We then return the set of things that need to be done outside the lock in
290 /// this struct and call handle_error!() on it.
292 struct MsgHandleErrInternal {
293 err: msgs::LightningError,
294 chan_id: Option<([u8; 32], u64)>, // If Some a channel of ours has been closed
295 shutdown_finish: Option<(ShutdownResult, Option<msgs::ChannelUpdate>)>,
297 impl MsgHandleErrInternal {
299 fn send_err_msg_no_close(err: String, channel_id: [u8; 32]) -> Self {
301 err: LightningError {
303 action: msgs::ErrorAction::SendErrorMessage {
304 msg: msgs::ErrorMessage {
311 shutdown_finish: None,
315 fn ignore_no_close(err: String) -> Self {
317 err: LightningError {
319 action: msgs::ErrorAction::IgnoreError,
322 shutdown_finish: None,
326 fn from_no_close(err: msgs::LightningError) -> Self {
327 Self { err, chan_id: None, shutdown_finish: None }
330 fn from_finish_shutdown(err: String, channel_id: [u8; 32], user_channel_id: u64, shutdown_res: ShutdownResult, channel_update: Option<msgs::ChannelUpdate>) -> Self {
332 err: LightningError {
334 action: msgs::ErrorAction::SendErrorMessage {
335 msg: msgs::ErrorMessage {
341 chan_id: Some((channel_id, user_channel_id)),
342 shutdown_finish: Some((shutdown_res, channel_update)),
346 fn from_chan_no_close(err: ChannelError, channel_id: [u8; 32]) -> Self {
349 ChannelError::Warn(msg) => LightningError {
351 action: msgs::ErrorAction::SendWarningMessage {
352 msg: msgs::WarningMessage {
356 log_level: Level::Warn,
359 ChannelError::Ignore(msg) => LightningError {
361 action: msgs::ErrorAction::IgnoreError,
363 ChannelError::Close(msg) => LightningError {
365 action: msgs::ErrorAction::SendErrorMessage {
366 msg: msgs::ErrorMessage {
374 shutdown_finish: None,
379 /// We hold back HTLCs we intend to relay for a random interval greater than this (see
380 /// Event::PendingHTLCsForwardable for the API guidelines indicating how long should be waited).
381 /// This provides some limited amount of privacy. Ideally this would range from somewhere like one
382 /// second to 30 seconds, but people expect lightning to be, you know, kinda fast, sadly.
383 const MIN_HTLC_RELAY_HOLDING_CELL_MILLIS: u64 = 100;
385 /// For events which result in both a RevokeAndACK and a CommitmentUpdate, by default they should
386 /// be sent in the order they appear in the return value, however sometimes the order needs to be
387 /// variable at runtime (eg Channel::channel_reestablish needs to re-send messages in the order
388 /// they were originally sent). In those cases, this enum is also returned.
389 #[derive(Clone, PartialEq)]
390 pub(super) enum RAACommitmentOrder {
391 /// Send the CommitmentUpdate messages first
393 /// Send the RevokeAndACK message first
397 // Note this is only exposed in cfg(test):
398 pub(super) struct ChannelHolder<Signer: Sign> {
399 pub(super) by_id: HashMap<[u8; 32], Channel<Signer>>,
400 /// SCIDs (and outbound SCID aliases) -> `counterparty_node_id`s and `channel_id`s.
402 /// Outbound SCID aliases are added here once the channel is available for normal use, with
403 /// SCIDs being added once the funding transaction is confirmed at the channel's required
404 /// confirmation depth.
405 pub(super) short_to_chan_info: HashMap<u64, (PublicKey, [u8; 32])>,
406 /// SCID/SCID Alias -> forward infos. Key of 0 means payments received.
408 /// Note that because we may have an SCID Alias as the key we can have two entries per channel,
409 /// though in practice we probably won't be receiving HTLCs for a channel both via the alias
410 /// and via the classic SCID.
412 /// Note that while this is held in the same mutex as the channels themselves, no consistency
413 /// guarantees are made about the existence of a channel with the short id here, nor the short
414 /// ids in the PendingHTLCInfo!
415 pub(super) forward_htlcs: HashMap<u64, Vec<HTLCForwardInfo>>,
416 /// Map from payment hash to the payment data and any HTLCs which are to us and can be
417 /// failed/claimed by the user.
419 /// Note that while this is held in the same mutex as the channels themselves, no consistency
420 /// guarantees are made about the channels given here actually existing anymore by the time you
422 claimable_htlcs: HashMap<PaymentHash, (events::PaymentPurpose, Vec<ClaimableHTLC>)>,
423 /// Messages to send to peers - pushed to in the same lock that they are generated in (except
424 /// for broadcast messages, where ordering isn't as strict).
425 pub(super) pending_msg_events: Vec<MessageSendEvent>,
428 /// Events which we process internally but cannot be procsesed immediately at the generation site
429 /// for some reason. They are handled in timer_tick_occurred, so may be processed with
430 /// quite some time lag.
431 enum BackgroundEvent {
432 /// Handle a ChannelMonitorUpdate that closes a channel, broadcasting its current latest holder
433 /// commitment transaction.
434 ClosingMonitorUpdate((OutPoint, ChannelMonitorUpdate)),
437 /// State we hold per-peer. In the future we should put channels in here, but for now we only hold
438 /// the latest Init features we heard from the peer.
440 latest_features: InitFeatures,
443 /// Stores a PaymentSecret and any other data we may need to validate an inbound payment is
444 /// actually ours and not some duplicate HTLC sent to us by a node along the route.
446 /// For users who don't want to bother doing their own payment preimage storage, we also store that
449 /// Note that this struct will be removed entirely soon, in favor of storing no inbound payment data
450 /// and instead encoding it in the payment secret.
451 struct PendingInboundPayment {
452 /// The payment secret that the sender must use for us to accept this payment
453 payment_secret: PaymentSecret,
454 /// Time at which this HTLC expires - blocks with a header time above this value will result in
455 /// this payment being removed.
457 /// Arbitrary identifier the user specifies (or not)
458 user_payment_id: u64,
459 // Other required attributes of the payment, optionally enforced:
460 payment_preimage: Option<PaymentPreimage>,
461 min_value_msat: Option<u64>,
464 /// Stores the session_priv for each part of a payment that is still pending. For versions 0.0.102
465 /// and later, also stores information for retrying the payment.
466 pub(crate) enum PendingOutboundPayment {
468 session_privs: HashSet<[u8; 32]>,
471 session_privs: HashSet<[u8; 32]>,
472 payment_hash: PaymentHash,
473 payment_secret: Option<PaymentSecret>,
474 pending_amt_msat: u64,
475 /// Used to track the fee paid. Only present if the payment was serialized on 0.0.103+.
476 pending_fee_msat: Option<u64>,
477 /// The total payment amount across all paths, used to verify that a retry is not overpaying.
479 /// Our best known block height at the time this payment was initiated.
480 starting_block_height: u32,
482 /// When a pending payment is fulfilled, we continue tracking it until all pending HTLCs have
483 /// been resolved. This ensures we don't look up pending payments in ChannelMonitors on restart
484 /// and add a pending payment that was already fulfilled.
486 session_privs: HashSet<[u8; 32]>,
487 payment_hash: Option<PaymentHash>,
489 /// When a payer gives up trying to retry a payment, they inform us, letting us generate a
490 /// `PaymentFailed` event when all HTLCs have irrevocably failed. This avoids a number of race
491 /// conditions in MPP-aware payment retriers (1), where the possibility of multiple
492 /// `PaymentPathFailed` events with `all_paths_failed` can be pending at once, confusing a
493 /// downstream event handler as to when a payment has actually failed.
495 /// (1) https://github.com/lightningdevkit/rust-lightning/issues/1164
497 session_privs: HashSet<[u8; 32]>,
498 payment_hash: PaymentHash,
502 impl PendingOutboundPayment {
503 fn is_retryable(&self) -> bool {
505 PendingOutboundPayment::Retryable { .. } => true,
509 fn is_fulfilled(&self) -> bool {
511 PendingOutboundPayment::Fulfilled { .. } => true,
515 fn abandoned(&self) -> bool {
517 PendingOutboundPayment::Abandoned { .. } => true,
521 fn get_pending_fee_msat(&self) -> Option<u64> {
523 PendingOutboundPayment::Retryable { pending_fee_msat, .. } => pending_fee_msat.clone(),
528 fn payment_hash(&self) -> Option<PaymentHash> {
530 PendingOutboundPayment::Legacy { .. } => None,
531 PendingOutboundPayment::Retryable { payment_hash, .. } => Some(*payment_hash),
532 PendingOutboundPayment::Fulfilled { payment_hash, .. } => *payment_hash,
533 PendingOutboundPayment::Abandoned { payment_hash, .. } => Some(*payment_hash),
537 fn mark_fulfilled(&mut self) {
538 let mut session_privs = HashSet::new();
539 core::mem::swap(&mut session_privs, match self {
540 PendingOutboundPayment::Legacy { session_privs } |
541 PendingOutboundPayment::Retryable { session_privs, .. } |
542 PendingOutboundPayment::Fulfilled { session_privs, .. } |
543 PendingOutboundPayment::Abandoned { session_privs, .. }
546 let payment_hash = self.payment_hash();
547 *self = PendingOutboundPayment::Fulfilled { session_privs, payment_hash };
550 fn mark_abandoned(&mut self) -> Result<(), ()> {
551 let mut session_privs = HashSet::new();
552 let our_payment_hash;
553 core::mem::swap(&mut session_privs, match self {
554 PendingOutboundPayment::Legacy { .. } |
555 PendingOutboundPayment::Fulfilled { .. } =>
557 PendingOutboundPayment::Retryable { session_privs, payment_hash, .. } |
558 PendingOutboundPayment::Abandoned { session_privs, payment_hash, .. } => {
559 our_payment_hash = *payment_hash;
563 *self = PendingOutboundPayment::Abandoned { session_privs, payment_hash: our_payment_hash };
567 /// panics if path is None and !self.is_fulfilled
568 fn remove(&mut self, session_priv: &[u8; 32], path: Option<&Vec<RouteHop>>) -> bool {
569 let remove_res = match self {
570 PendingOutboundPayment::Legacy { session_privs } |
571 PendingOutboundPayment::Retryable { session_privs, .. } |
572 PendingOutboundPayment::Fulfilled { session_privs, .. } |
573 PendingOutboundPayment::Abandoned { session_privs, .. } => {
574 session_privs.remove(session_priv)
578 if let PendingOutboundPayment::Retryable { ref mut pending_amt_msat, ref mut pending_fee_msat, .. } = self {
579 let path = path.expect("Fulfilling a payment should always come with a path");
580 let path_last_hop = path.last().expect("Outbound payments must have had a valid path");
581 *pending_amt_msat -= path_last_hop.fee_msat;
582 if let Some(fee_msat) = pending_fee_msat.as_mut() {
583 *fee_msat -= path.get_path_fees();
590 fn insert(&mut self, session_priv: [u8; 32], path: &Vec<RouteHop>) -> bool {
591 let insert_res = match self {
592 PendingOutboundPayment::Legacy { session_privs } |
593 PendingOutboundPayment::Retryable { session_privs, .. } => {
594 session_privs.insert(session_priv)
596 PendingOutboundPayment::Fulfilled { .. } => false,
597 PendingOutboundPayment::Abandoned { .. } => false,
600 if let PendingOutboundPayment::Retryable { ref mut pending_amt_msat, ref mut pending_fee_msat, .. } = self {
601 let path_last_hop = path.last().expect("Outbound payments must have had a valid path");
602 *pending_amt_msat += path_last_hop.fee_msat;
603 if let Some(fee_msat) = pending_fee_msat.as_mut() {
604 *fee_msat += path.get_path_fees();
611 fn remaining_parts(&self) -> usize {
613 PendingOutboundPayment::Legacy { session_privs } |
614 PendingOutboundPayment::Retryable { session_privs, .. } |
615 PendingOutboundPayment::Fulfilled { session_privs, .. } |
616 PendingOutboundPayment::Abandoned { session_privs, .. } => {
623 /// SimpleArcChannelManager is useful when you need a ChannelManager with a static lifetime, e.g.
624 /// when you're using lightning-net-tokio (since tokio::spawn requires parameters with static
625 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
626 /// SimpleRefChannelManager is the more appropriate type. Defining these type aliases prevents
627 /// issues such as overly long function definitions. Note that the ChannelManager can take any
628 /// type that implements KeysInterface for its keys manager, but this type alias chooses the
629 /// concrete type of the KeysManager.
631 /// (C-not exported) as Arcs don't make sense in bindings
632 pub type SimpleArcChannelManager<M, T, F, L> = ChannelManager<InMemorySigner, Arc<M>, Arc<T>, Arc<KeysManager>, Arc<F>, Arc<L>>;
634 /// SimpleRefChannelManager is a type alias for a ChannelManager reference, and is the reference
635 /// counterpart to the SimpleArcChannelManager type alias. Use this type by default when you don't
636 /// need a ChannelManager with a static lifetime. You'll need a static lifetime in cases such as
637 /// usage of lightning-net-tokio (since tokio::spawn requires parameters with static lifetimes).
638 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
639 /// helps with issues such as long function definitions. Note that the ChannelManager can take any
640 /// type that implements KeysInterface for its keys manager, but this type alias chooses the
641 /// concrete type of the KeysManager.
643 /// (C-not exported) as Arcs don't make sense in bindings
644 pub type SimpleRefChannelManager<'a, 'b, 'c, 'd, 'e, M, T, F, L> = ChannelManager<InMemorySigner, &'a M, &'b T, &'c KeysManager, &'d F, &'e L>;
646 /// Manager which keeps track of a number of channels and sends messages to the appropriate
647 /// channel, also tracking HTLC preimages and forwarding onion packets appropriately.
649 /// Implements ChannelMessageHandler, handling the multi-channel parts and passing things through
650 /// to individual Channels.
652 /// Implements Writeable to write out all channel state to disk. Implies peer_disconnected() for
653 /// all peers during write/read (though does not modify this instance, only the instance being
654 /// serialized). This will result in any channels which have not yet exchanged funding_created (ie
655 /// called funding_transaction_generated for outbound channels).
657 /// Note that you can be a bit lazier about writing out ChannelManager than you can be with
658 /// ChannelMonitors. With ChannelMonitors you MUST write each monitor update out to disk before
659 /// returning from chain::Watch::watch_/update_channel, with ChannelManagers, writing updates
660 /// happens out-of-band (and will prevent any other ChannelManager operations from occurring during
661 /// the serialization process). If the deserialized version is out-of-date compared to the
662 /// ChannelMonitors passed by reference to read(), those channels will be force-closed based on the
663 /// ChannelMonitor state and no funds will be lost (mod on-chain transaction fees).
665 /// Note that the deserializer is only implemented for (BlockHash, ChannelManager), which
666 /// tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
667 /// the "reorg path" (ie call block_disconnected() until you get to a common block and then call
668 /// block_connected() to step towards your best block) upon deserialization before using the
671 /// Note that ChannelManager is responsible for tracking liveness of its channels and generating
672 /// ChannelUpdate messages informing peers that the channel is temporarily disabled. To avoid
673 /// spam due to quick disconnection/reconnection, updates are not sent until the channel has been
674 /// offline for a full minute. In order to track this, you must call
675 /// timer_tick_occurred roughly once per minute, though it doesn't have to be perfect.
677 /// Rather than using a plain ChannelManager, it is preferable to use either a SimpleArcChannelManager
678 /// a SimpleRefChannelManager, for conciseness. See their documentation for more details, but
679 /// essentially you should default to using a SimpleRefChannelManager, and use a
680 /// SimpleArcChannelManager when you require a ChannelManager with a static lifetime, such as when
681 /// you're using lightning-net-tokio.
682 pub struct ChannelManager<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
683 where M::Target: chain::Watch<Signer>,
684 T::Target: BroadcasterInterface,
685 K::Target: KeysInterface<Signer = Signer>,
686 F::Target: FeeEstimator,
689 default_configuration: UserConfig,
690 genesis_hash: BlockHash,
691 fee_estimator: LowerBoundedFeeEstimator<F>,
696 pub(super) best_block: RwLock<BestBlock>,
698 best_block: RwLock<BestBlock>,
699 secp_ctx: Secp256k1<secp256k1::All>,
701 #[cfg(any(test, feature = "_test_utils"))]
702 pub(super) channel_state: Mutex<ChannelHolder<Signer>>,
703 #[cfg(not(any(test, feature = "_test_utils")))]
704 channel_state: Mutex<ChannelHolder<Signer>>,
706 /// Storage for PaymentSecrets and any requirements on future inbound payments before we will
707 /// expose them to users via a PaymentReceived event. HTLCs which do not meet the requirements
708 /// here are failed when we process them as pending-forwardable-HTLCs, and entries are removed
709 /// after we generate a PaymentReceived upon receipt of all MPP parts or when they time out.
710 /// Locked *after* channel_state.
711 pending_inbound_payments: Mutex<HashMap<PaymentHash, PendingInboundPayment>>,
713 /// The session_priv bytes and retry metadata of outbound payments which are pending resolution.
714 /// The authoritative state of these HTLCs resides either within Channels or ChannelMonitors
715 /// (if the channel has been force-closed), however we track them here to prevent duplicative
716 /// PaymentSent/PaymentPathFailed events. Specifically, in the case of a duplicative
717 /// update_fulfill_htlc message after a reconnect, we may "claim" a payment twice.
718 /// Additionally, because ChannelMonitors are often not re-serialized after connecting block(s)
719 /// which may generate a claim event, we may receive similar duplicate claim/fail MonitorEvents
720 /// after reloading from disk while replaying blocks against ChannelMonitors.
722 /// See `PendingOutboundPayment` documentation for more info.
724 /// Locked *after* channel_state.
725 pending_outbound_payments: Mutex<HashMap<PaymentId, PendingOutboundPayment>>,
727 /// The set of outbound SCID aliases across all our channels, including unconfirmed channels
728 /// and some closed channels which reached a usable state prior to being closed. This is used
729 /// only to avoid duplicates, and is not persisted explicitly to disk, but rebuilt from the
730 /// active channel list on load.
731 outbound_scid_aliases: Mutex<HashSet<u64>>,
733 /// `channel_id` -> `counterparty_node_id`.
735 /// Only `channel_id`s are allowed as keys in this map, and not `temporary_channel_id`s. As
736 /// multiple channels with the same `temporary_channel_id` to different peers can exist,
737 /// allowing `temporary_channel_id`s in this map would cause collisions for such channels.
739 /// Note that this map should only be used for `MonitorEvent` handling, to be able to access
740 /// the corresponding channel for the event, as we only have access to the `channel_id` during
741 /// the handling of the events.
744 /// The `counterparty_node_id` isn't passed with `MonitorEvent`s currently. To pass it, we need
745 /// to make `counterparty_node_id`'s a required field in `ChannelMonitor`s, which unfortunately
746 /// would break backwards compatability.
747 /// We should add `counterparty_node_id`s to `MonitorEvent`s, and eventually rely on it in the
748 /// future. That would make this map redundant, as only the `ChannelManager::per_peer_state` is
749 /// required to access the channel with the `counterparty_node_id`.
750 id_to_peer: Mutex<HashMap<[u8; 32], PublicKey>>,
752 our_network_key: SecretKey,
753 our_network_pubkey: PublicKey,
755 inbound_payment_key: inbound_payment::ExpandedKey,
757 /// LDK puts the [fake scids] that it generates into namespaces, to identify the type of an
758 /// incoming payment. To make it harder for a third-party to identify the type of a payment,
759 /// we encrypt the namespace identifier using these bytes.
761 /// [fake scids]: crate::util::scid_utils::fake_scid
762 fake_scid_rand_bytes: [u8; 32],
764 /// When we send payment probes, we generate the [`PaymentHash`] based on this cookie secret
765 /// and a random [`PaymentId`]. This allows us to discern probes from real payments, without
766 /// keeping additional state.
767 probing_cookie_secret: [u8; 32],
769 /// Used to track the last value sent in a node_announcement "timestamp" field. We ensure this
770 /// value increases strictly since we don't assume access to a time source.
771 last_node_announcement_serial: AtomicUsize,
773 /// The highest block timestamp we've seen, which is usually a good guess at the current time.
774 /// Assuming most miners are generating blocks with reasonable timestamps, this shouldn't be
775 /// very far in the past, and can only ever be up to two hours in the future.
776 highest_seen_timestamp: AtomicUsize,
778 /// The bulk of our storage will eventually be here (channels and message queues and the like).
779 /// If we are connected to a peer we always at least have an entry here, even if no channels
780 /// are currently open with that peer.
781 /// Because adding or removing an entry is rare, we usually take an outer read lock and then
782 /// operate on the inner value freely. Sadly, this prevents parallel operation when opening a
785 /// If also holding `channel_state` lock, must lock `channel_state` prior to `per_peer_state`.
786 per_peer_state: RwLock<HashMap<PublicKey, Mutex<PeerState>>>,
788 pending_events: Mutex<Vec<events::Event>>,
789 pending_background_events: Mutex<Vec<BackgroundEvent>>,
790 /// Used when we have to take a BIG lock to make sure everything is self-consistent.
791 /// Essentially just when we're serializing ourselves out.
792 /// Taken first everywhere where we are making changes before any other locks.
793 /// When acquiring this lock in read mode, rather than acquiring it directly, call
794 /// `PersistenceNotifierGuard::notify_on_drop(..)` and pass the lock to it, to ensure the
795 /// PersistenceNotifier the lock contains sends out a notification when the lock is released.
796 total_consistency_lock: RwLock<()>,
798 persistence_notifier: PersistenceNotifier,
805 /// Chain-related parameters used to construct a new `ChannelManager`.
807 /// Typically, the block-specific parameters are derived from the best block hash for the network,
808 /// as a newly constructed `ChannelManager` will not have created any channels yet. These parameters
809 /// are not needed when deserializing a previously constructed `ChannelManager`.
810 #[derive(Clone, Copy, PartialEq)]
811 pub struct ChainParameters {
812 /// The network for determining the `chain_hash` in Lightning messages.
813 pub network: Network,
815 /// The hash and height of the latest block successfully connected.
817 /// Used to track on-chain channel funding outputs and send payments with reliable timelocks.
818 pub best_block: BestBlock,
821 #[derive(Copy, Clone, PartialEq)]
827 /// Whenever we release the `ChannelManager`'s `total_consistency_lock`, from read mode, it is
828 /// desirable to notify any listeners on `await_persistable_update_timeout`/
829 /// `await_persistable_update` when new updates are available for persistence. Therefore, this
830 /// struct is responsible for locking the total consistency lock and, upon going out of scope,
831 /// sending the aforementioned notification (since the lock being released indicates that the
832 /// updates are ready for persistence).
834 /// We allow callers to either always notify by constructing with `notify_on_drop` or choose to
835 /// notify or not based on whether relevant changes have been made, providing a closure to
836 /// `optionally_notify` which returns a `NotifyOption`.
837 struct PersistenceNotifierGuard<'a, F: Fn() -> NotifyOption> {
838 persistence_notifier: &'a PersistenceNotifier,
840 // We hold onto this result so the lock doesn't get released immediately.
841 _read_guard: RwLockReadGuard<'a, ()>,
844 impl<'a> PersistenceNotifierGuard<'a, fn() -> NotifyOption> { // We don't care what the concrete F is here, it's unused
845 fn notify_on_drop(lock: &'a RwLock<()>, notifier: &'a PersistenceNotifier) -> PersistenceNotifierGuard<'a, impl Fn() -> NotifyOption> {
846 PersistenceNotifierGuard::optionally_notify(lock, notifier, || -> NotifyOption { NotifyOption::DoPersist })
849 fn optionally_notify<F: Fn() -> NotifyOption>(lock: &'a RwLock<()>, notifier: &'a PersistenceNotifier, persist_check: F) -> PersistenceNotifierGuard<'a, F> {
850 let read_guard = lock.read().unwrap();
852 PersistenceNotifierGuard {
853 persistence_notifier: notifier,
854 should_persist: persist_check,
855 _read_guard: read_guard,
860 impl<'a, F: Fn() -> NotifyOption> Drop for PersistenceNotifierGuard<'a, F> {
862 if (self.should_persist)() == NotifyOption::DoPersist {
863 self.persistence_notifier.notify();
868 /// The amount of time in blocks we require our counterparty wait to claim their money (ie time
869 /// between when we, or our watchtower, must check for them having broadcast a theft transaction).
871 /// This can be increased (but not decreased) through [`ChannelHandshakeConfig::our_to_self_delay`]
873 /// [`ChannelHandshakeConfig::our_to_self_delay`]: crate::util::config::ChannelHandshakeConfig::our_to_self_delay
874 pub const BREAKDOWN_TIMEOUT: u16 = 6 * 24;
875 /// The amount of time in blocks we're willing to wait to claim money back to us. This matches
876 /// the maximum required amount in lnd as of March 2021.
877 pub(crate) const MAX_LOCAL_BREAKDOWN_TIMEOUT: u16 = 2 * 6 * 24 * 7;
879 /// The minimum number of blocks between an inbound HTLC's CLTV and the corresponding outbound
880 /// HTLC's CLTV. The current default represents roughly seven hours of blocks at six blocks/hour.
882 /// This can be increased (but not decreased) through [`ChannelConfig::cltv_expiry_delta`]
884 /// [`ChannelConfig::cltv_expiry_delta`]: crate::util::config::ChannelConfig::cltv_expiry_delta
885 // This should always be a few blocks greater than channelmonitor::CLTV_CLAIM_BUFFER,
886 // i.e. the node we forwarded the payment on to should always have enough room to reliably time out
887 // the HTLC via a full update_fail_htlc/commitment_signed dance before we hit the
888 // CLTV_CLAIM_BUFFER point (we static assert that it's at least 3 blocks more).
889 pub const MIN_CLTV_EXPIRY_DELTA: u16 = 6*7;
890 // This should be long enough to allow a payment path drawn across multiple routing hops with substantial
891 // `cltv_expiry_delta`. Indeed, the length of those values is the reaction delay offered to a routing node
892 // in case of HTLC on-chain settlement. While appearing less competitive, a node operator could decide to
893 // scale them up to suit its security policy. At the network-level, we shouldn't constrain them too much,
894 // while avoiding to introduce a DoS vector. Further, a low CTLV_FAR_FAR_AWAY could be a source of
895 // routing failure for any HTLC sender picking up an LDK node among the first hops.
896 pub(super) const CLTV_FAR_FAR_AWAY: u32 = 14 * 24 * 6;
898 /// Minimum CLTV difference between the current block height and received inbound payments.
899 /// Invoices generated for payment to us must set their `min_final_cltv_expiry` field to at least
901 // Note that we fail if exactly HTLC_FAIL_BACK_BUFFER + 1 was used, so we need to add one for
902 // any payments to succeed. Further, we don't want payments to fail if a block was found while
903 // a payment was being routed, so we add an extra block to be safe.
904 pub const MIN_FINAL_CLTV_EXPIRY: u32 = HTLC_FAIL_BACK_BUFFER + 3;
906 // Check that our CLTV_EXPIRY is at least CLTV_CLAIM_BUFFER + ANTI_REORG_DELAY + LATENCY_GRACE_PERIOD_BLOCKS,
907 // ie that if the next-hop peer fails the HTLC within
908 // LATENCY_GRACE_PERIOD_BLOCKS then we'll still have CLTV_CLAIM_BUFFER left to timeout it onchain,
909 // then waiting ANTI_REORG_DELAY to be reorg-safe on the outbound HLTC and
910 // failing the corresponding htlc backward, and us now seeing the last block of ANTI_REORG_DELAY before
911 // LATENCY_GRACE_PERIOD_BLOCKS.
914 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;
916 // Check for ability of an attacker to make us fail on-chain by delaying an HTLC claim. See
917 // ChannelMonitor::should_broadcast_holder_commitment_txn for a description of why this is needed.
920 const CHECK_CLTV_EXPIRY_SANITY_2: u32 = MIN_CLTV_EXPIRY_DELTA as u32 - LATENCY_GRACE_PERIOD_BLOCKS - 2*CLTV_CLAIM_BUFFER;
922 /// The number of blocks before we consider an outbound payment for expiry if it doesn't have any
923 /// pending HTLCs in flight.
924 pub(crate) const PAYMENT_EXPIRY_BLOCKS: u32 = 3;
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 /// Information needed for constructing an invoice route hint for this channel.
930 #[derive(Clone, Debug, PartialEq)]
931 pub struct CounterpartyForwardingInfo {
932 /// Base routing fee in millisatoshis.
933 pub fee_base_msat: u32,
934 /// Amount in millionths of a satoshi the channel will charge per transferred satoshi.
935 pub fee_proportional_millionths: u32,
936 /// The minimum difference in cltv_expiry between an ingoing HTLC and its outgoing counterpart,
937 /// such that the outgoing HTLC is forwardable to this counterparty. See `msgs::ChannelUpdate`'s
938 /// `cltv_expiry_delta` for more details.
939 pub cltv_expiry_delta: u16,
942 /// Channel parameters which apply to our counterparty. These are split out from [`ChannelDetails`]
943 /// to better separate parameters.
944 #[derive(Clone, Debug, PartialEq)]
945 pub struct ChannelCounterparty {
946 /// The node_id of our counterparty
947 pub node_id: PublicKey,
948 /// The Features the channel counterparty provided upon last connection.
949 /// Useful for routing as it is the most up-to-date copy of the counterparty's features and
950 /// many routing-relevant features are present in the init context.
951 pub features: InitFeatures,
952 /// The value, in satoshis, that must always be held in the channel for our counterparty. This
953 /// value ensures that if our counterparty broadcasts a revoked state, we can punish them by
954 /// claiming at least this value on chain.
956 /// This value is not included in [`inbound_capacity_msat`] as it can never be spent.
958 /// [`inbound_capacity_msat`]: ChannelDetails::inbound_capacity_msat
959 pub unspendable_punishment_reserve: u64,
960 /// Information on the fees and requirements that the counterparty requires when forwarding
961 /// payments to us through this channel.
962 pub forwarding_info: Option<CounterpartyForwardingInfo>,
963 /// The smallest value HTLC (in msat) the remote peer will accept, for this channel. This field
964 /// is only `None` before we have received either the `OpenChannel` or `AcceptChannel` message
965 /// from the remote peer, or for `ChannelCounterparty` objects serialized prior to LDK 0.0.107.
966 pub outbound_htlc_minimum_msat: Option<u64>,
967 /// The largest value HTLC (in msat) the remote peer currently will accept, for this channel.
968 pub outbound_htlc_maximum_msat: Option<u64>,
971 /// Details of a channel, as returned by ChannelManager::list_channels and ChannelManager::list_usable_channels
972 #[derive(Clone, Debug, PartialEq)]
973 pub struct ChannelDetails {
974 /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
975 /// thereafter this is the txid of the funding transaction xor the funding transaction output).
976 /// Note that this means this value is *not* persistent - it can change once during the
977 /// lifetime of the channel.
978 pub channel_id: [u8; 32],
979 /// Parameters which apply to our counterparty. See individual fields for more information.
980 pub counterparty: ChannelCounterparty,
981 /// The Channel's funding transaction output, if we've negotiated the funding transaction with
982 /// our counterparty already.
984 /// Note that, if this has been set, `channel_id` will be equivalent to
985 /// `funding_txo.unwrap().to_channel_id()`.
986 pub funding_txo: Option<OutPoint>,
987 /// The features which this channel operates with. See individual features for more info.
989 /// `None` until negotiation completes and the channel type is finalized.
990 pub channel_type: Option<ChannelTypeFeatures>,
991 /// The position of the funding transaction in the chain. None if the funding transaction has
992 /// not yet been confirmed and the channel fully opened.
994 /// Note that if [`inbound_scid_alias`] is set, it must be used for invoices and inbound
995 /// payments instead of this. See [`get_inbound_payment_scid`].
997 /// For channels with [`confirmations_required`] set to `Some(0)`, [`outbound_scid_alias`] may
998 /// be used in place of this in outbound routes. See [`get_outbound_payment_scid`].
1000 /// [`inbound_scid_alias`]: Self::inbound_scid_alias
1001 /// [`outbound_scid_alias`]: Self::outbound_scid_alias
1002 /// [`get_inbound_payment_scid`]: Self::get_inbound_payment_scid
1003 /// [`get_outbound_payment_scid`]: Self::get_outbound_payment_scid
1004 /// [`confirmations_required`]: Self::confirmations_required
1005 pub short_channel_id: Option<u64>,
1006 /// An optional [`short_channel_id`] alias for this channel, randomly generated by us and
1007 /// usable in place of [`short_channel_id`] to reference the channel in outbound routes when
1008 /// the channel has not yet been confirmed (as long as [`confirmations_required`] is
1011 /// This will be `None` as long as the channel is not available for routing outbound payments.
1013 /// [`short_channel_id`]: Self::short_channel_id
1014 /// [`confirmations_required`]: Self::confirmations_required
1015 pub outbound_scid_alias: Option<u64>,
1016 /// An optional [`short_channel_id`] alias for this channel, randomly generated by our
1017 /// counterparty and usable in place of [`short_channel_id`] in invoice route hints. Our
1018 /// counterparty will recognize the alias provided here in place of the [`short_channel_id`]
1019 /// when they see a payment to be routed to us.
1021 /// Our counterparty may choose to rotate this value at any time, though will always recognize
1022 /// previous values for inbound payment forwarding.
1024 /// [`short_channel_id`]: Self::short_channel_id
1025 pub inbound_scid_alias: Option<u64>,
1026 /// The value, in satoshis, of this channel as appears in the funding output
1027 pub channel_value_satoshis: u64,
1028 /// The value, in satoshis, that must always be held in the channel for us. This value ensures
1029 /// that if we broadcast a revoked state, our counterparty can punish us by claiming at least
1030 /// this value on chain.
1032 /// This value is not included in [`outbound_capacity_msat`] as it can never be spent.
1034 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1036 /// [`outbound_capacity_msat`]: ChannelDetails::outbound_capacity_msat
1037 pub unspendable_punishment_reserve: Option<u64>,
1038 /// The `user_channel_id` passed in to create_channel, or 0 if the channel was inbound.
1039 pub user_channel_id: u64,
1040 /// Our total balance. This is the amount we would get if we close the channel.
1041 /// This value is not exact. Due to various in-flight changes and feerate changes, exactly this
1042 /// amount is not likely to be recoverable on close.
1044 /// This does not include any pending HTLCs which are not yet fully resolved (and, thus, whose
1045 /// balance is not available for inclusion in new outbound HTLCs). This further does not include
1046 /// any pending outgoing HTLCs which are awaiting some other resolution to be sent.
1047 /// This does not consider any on-chain fees.
1049 /// See also [`ChannelDetails::outbound_capacity_msat`]
1050 pub balance_msat: u64,
1051 /// The available outbound capacity for sending HTLCs to the remote peer. This does not include
1052 /// any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1053 /// available for inclusion in new outbound HTLCs). This further does not include any pending
1054 /// outgoing HTLCs which are awaiting some other resolution to be sent.
1056 /// See also [`ChannelDetails::balance_msat`]
1058 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1059 /// conflict-avoidance policy, exactly this amount is not likely to be spendable. However, we
1060 /// should be able to spend nearly this amount.
1061 pub outbound_capacity_msat: u64,
1062 /// The available outbound capacity for sending a single HTLC to the remote peer. This is
1063 /// similar to [`ChannelDetails::outbound_capacity_msat`] but it may be further restricted by
1064 /// the current state and per-HTLC limit(s). This is intended for use when routing, allowing us
1065 /// to use a limit as close as possible to the HTLC limit we can currently send.
1067 /// See also [`ChannelDetails::balance_msat`] and [`ChannelDetails::outbound_capacity_msat`].
1068 pub next_outbound_htlc_limit_msat: u64,
1069 /// The available inbound capacity for the remote peer to send HTLCs to us. This does not
1070 /// include any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
1071 /// available for inclusion in new inbound HTLCs).
1072 /// Note that there are some corner cases not fully handled here, so the actual available
1073 /// inbound capacity may be slightly higher than this.
1075 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
1076 /// counterparty's conflict-avoidance policy, exactly this amount is not likely to be spendable.
1077 /// However, our counterparty should be able to spend nearly this amount.
1078 pub inbound_capacity_msat: u64,
1079 /// The number of required confirmations on the funding transaction before the funding will be
1080 /// considered "locked". This number is selected by the channel fundee (i.e. us if
1081 /// [`is_outbound`] is *not* set), and can be selected for inbound channels with
1082 /// [`ChannelHandshakeConfig::minimum_depth`] or limited for outbound channels with
1083 /// [`ChannelHandshakeLimits::max_minimum_depth`].
1085 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1087 /// [`is_outbound`]: ChannelDetails::is_outbound
1088 /// [`ChannelHandshakeConfig::minimum_depth`]: crate::util::config::ChannelHandshakeConfig::minimum_depth
1089 /// [`ChannelHandshakeLimits::max_minimum_depth`]: crate::util::config::ChannelHandshakeLimits::max_minimum_depth
1090 pub confirmations_required: Option<u32>,
1091 /// The number of blocks (after our commitment transaction confirms) that we will need to wait
1092 /// until we can claim our funds after we force-close the channel. During this time our
1093 /// counterparty is allowed to punish us if we broadcasted a stale state. If our counterparty
1094 /// force-closes the channel and broadcasts a commitment transaction we do not have to wait any
1095 /// time to claim our non-HTLC-encumbered funds.
1097 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
1098 pub force_close_spend_delay: Option<u16>,
1099 /// True if the channel was initiated (and thus funded) by us.
1100 pub is_outbound: bool,
1101 /// True if the channel is confirmed, channel_ready messages have been exchanged, and the
1102 /// channel is not currently being shut down. `channel_ready` message exchange implies the
1103 /// required confirmation count has been reached (and we were connected to the peer at some
1104 /// point after the funding transaction received enough confirmations). The required
1105 /// confirmation count is provided in [`confirmations_required`].
1107 /// [`confirmations_required`]: ChannelDetails::confirmations_required
1108 pub is_channel_ready: bool,
1109 /// True if the channel is (a) confirmed and channel_ready messages have been exchanged, (b)
1110 /// the peer is connected, and (c) the channel is not currently negotiating a shutdown.
1112 /// This is a strict superset of `is_channel_ready`.
1113 pub is_usable: bool,
1114 /// True if this channel is (or will be) publicly-announced.
1115 pub is_public: bool,
1116 /// The smallest value HTLC (in msat) we will accept, for this channel. This field
1117 /// is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.107
1118 pub inbound_htlc_minimum_msat: Option<u64>,
1119 /// The largest value HTLC (in msat) we currently will accept, for this channel.
1120 pub inbound_htlc_maximum_msat: Option<u64>,
1121 /// Set of configurable parameters that affect channel operation.
1123 /// This field is only `None` for `ChannelDetails` objects serialized prior to LDK 0.0.109.
1124 pub config: Option<ChannelConfig>,
1127 impl ChannelDetails {
1128 /// Gets the current SCID which should be used to identify this channel for inbound payments.
1129 /// This should be used for providing invoice hints or in any other context where our
1130 /// counterparty will forward a payment to us.
1132 /// This is either the [`ChannelDetails::inbound_scid_alias`], if set, or the
1133 /// [`ChannelDetails::short_channel_id`]. See those for more information.
1134 pub fn get_inbound_payment_scid(&self) -> Option<u64> {
1135 self.inbound_scid_alias.or(self.short_channel_id)
1138 /// Gets the current SCID which should be used to identify this channel for outbound payments.
1139 /// This should be used in [`Route`]s to describe the first hop or in other contexts where
1140 /// we're sending or forwarding a payment outbound over this channel.
1142 /// This is either the [`ChannelDetails::short_channel_id`], if set, or the
1143 /// [`ChannelDetails::outbound_scid_alias`]. See those for more information.
1144 pub fn get_outbound_payment_scid(&self) -> Option<u64> {
1145 self.short_channel_id.or(self.outbound_scid_alias)
1149 /// If a payment fails to send, it can be in one of several states. This enum is returned as the
1150 /// Err() type describing which state the payment is in, see the description of individual enum
1151 /// states for more.
1152 #[derive(Clone, Debug)]
1153 pub enum PaymentSendFailure {
1154 /// A parameter which was passed to send_payment was invalid, preventing us from attempting to
1155 /// send the payment at all. No channel state has been changed or messages sent to peers, and
1156 /// once you've changed the parameter at error, you can freely retry the payment in full.
1157 ParameterError(APIError),
1158 /// A parameter in a single path which was passed to send_payment was invalid, preventing us
1159 /// from attempting to send the payment at all. No channel state has been changed or messages
1160 /// sent to peers, and once you've changed the parameter at error, you can freely retry the
1161 /// payment in full.
1163 /// The results here are ordered the same as the paths in the route object which was passed to
1165 PathParameterError(Vec<Result<(), APIError>>),
1166 /// All paths which were attempted failed to send, with no channel state change taking place.
1167 /// You can freely retry the payment in full (though you probably want to do so over different
1168 /// paths than the ones selected).
1169 AllFailedRetrySafe(Vec<APIError>),
1170 /// Some paths which were attempted failed to send, though possibly not all. At least some
1171 /// paths have irrevocably committed to the HTLC and retrying the payment in full would result
1172 /// in over-/re-payment.
1174 /// The results here are ordered the same as the paths in the route object which was passed to
1175 /// send_payment, and any Errs which are not APIError::MonitorUpdateFailed can be safely
1176 /// retried (though there is currently no API with which to do so).
1178 /// Any entries which contain Err(APIError::MonitorUpdateFailed) or Ok(()) MUST NOT be retried
1179 /// as they will result in over-/re-payment. These HTLCs all either successfully sent (in the
1180 /// case of Ok(())) or will send once channel_monitor_updated is called on the next-hop channel
1181 /// with the latest update_id.
1183 /// The errors themselves, in the same order as the route hops.
1184 results: Vec<Result<(), APIError>>,
1185 /// If some paths failed without irrevocably committing to the new HTLC(s), this will
1186 /// contain a [`RouteParameters`] object which can be used to calculate a new route that
1187 /// will pay all remaining unpaid balance.
1188 failed_paths_retry: Option<RouteParameters>,
1189 /// The payment id for the payment, which is now at least partially pending.
1190 payment_id: PaymentId,
1194 /// Route hints used in constructing invoices for [phantom node payents].
1196 /// [phantom node payments]: crate::chain::keysinterface::PhantomKeysManager
1198 pub struct PhantomRouteHints {
1199 /// The list of channels to be included in the invoice route hints.
1200 pub channels: Vec<ChannelDetails>,
1201 /// A fake scid used for representing the phantom node's fake channel in generating the invoice
1203 pub phantom_scid: u64,
1204 /// The pubkey of the real backing node that would ultimately receive the payment.
1205 pub real_node_pubkey: PublicKey,
1208 macro_rules! handle_error {
1209 ($self: ident, $internal: expr, $counterparty_node_id: expr) => {
1212 Err(MsgHandleErrInternal { err, chan_id, shutdown_finish }) => {
1213 #[cfg(debug_assertions)]
1215 // In testing, ensure there are no deadlocks where the lock is already held upon
1216 // entering the macro.
1217 assert!($self.channel_state.try_lock().is_ok());
1218 assert!($self.pending_events.try_lock().is_ok());
1221 let mut msg_events = Vec::with_capacity(2);
1223 if let Some((shutdown_res, update_option)) = shutdown_finish {
1224 $self.finish_force_close_channel(shutdown_res);
1225 if let Some(update) = update_option {
1226 msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1230 if let Some((channel_id, user_channel_id)) = chan_id {
1231 $self.pending_events.lock().unwrap().push(events::Event::ChannelClosed {
1232 channel_id, user_channel_id,
1233 reason: ClosureReason::ProcessingError { err: err.err.clone() }
1238 log_error!($self.logger, "{}", err.err);
1239 if let msgs::ErrorAction::IgnoreError = err.action {
1241 msg_events.push(events::MessageSendEvent::HandleError {
1242 node_id: $counterparty_node_id,
1243 action: err.action.clone()
1247 if !msg_events.is_empty() {
1248 $self.channel_state.lock().unwrap().pending_msg_events.append(&mut msg_events);
1251 // Return error in case higher-API need one
1258 macro_rules! update_maps_on_chan_removal {
1259 ($self: expr, $short_to_chan_info: expr, $channel: expr) => {
1260 if let Some(short_id) = $channel.get_short_channel_id() {
1261 $short_to_chan_info.remove(&short_id);
1263 // If the channel was never confirmed on-chain prior to its closure, remove the
1264 // outbound SCID alias we used for it from the collision-prevention set. While we
1265 // generally want to avoid ever re-using an outbound SCID alias across all channels, we
1266 // also don't want a counterparty to be able to trivially cause a memory leak by simply
1267 // opening a million channels with us which are closed before we ever reach the funding
1269 let alias_removed = $self.outbound_scid_aliases.lock().unwrap().remove(&$channel.outbound_scid_alias());
1270 debug_assert!(alias_removed);
1272 $self.id_to_peer.lock().unwrap().remove(&$channel.channel_id());
1273 $short_to_chan_info.remove(&$channel.outbound_scid_alias());
1277 /// Returns (boolean indicating if we should remove the Channel object from memory, a mapped error)
1278 macro_rules! convert_chan_err {
1279 ($self: ident, $err: expr, $short_to_chan_info: expr, $channel: expr, $channel_id: expr) => {
1281 ChannelError::Warn(msg) => {
1282 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Warn(msg), $channel_id.clone()))
1284 ChannelError::Ignore(msg) => {
1285 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore(msg), $channel_id.clone()))
1287 ChannelError::Close(msg) => {
1288 log_error!($self.logger, "Closing channel {} due to close-required error: {}", log_bytes!($channel_id[..]), msg);
1289 update_maps_on_chan_removal!($self, $short_to_chan_info, $channel);
1290 let shutdown_res = $channel.force_shutdown(true);
1291 (true, MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, $channel.get_user_id(),
1292 shutdown_res, $self.get_channel_update_for_broadcast(&$channel).ok()))
1298 macro_rules! break_chan_entry {
1299 ($self: ident, $res: expr, $channel_state: expr, $entry: expr) => {
1303 let (drop, res) = convert_chan_err!($self, e, $channel_state.short_to_chan_info, $entry.get_mut(), $entry.key());
1305 $entry.remove_entry();
1313 macro_rules! try_chan_entry {
1314 ($self: ident, $res: expr, $channel_state: expr, $entry: expr) => {
1318 let (drop, res) = convert_chan_err!($self, e, $channel_state.short_to_chan_info, $entry.get_mut(), $entry.key());
1320 $entry.remove_entry();
1328 macro_rules! remove_channel {
1329 ($self: expr, $channel_state: expr, $entry: expr) => {
1331 let channel = $entry.remove_entry().1;
1332 update_maps_on_chan_removal!($self, $channel_state.short_to_chan_info, channel);
1338 macro_rules! handle_monitor_err {
1339 ($self: ident, $err: expr, $short_to_chan_info: expr, $chan: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr, $resend_channel_ready: expr, $failed_forwards: expr, $failed_fails: expr, $failed_finalized_fulfills: expr, $chan_id: expr) => {
1341 ChannelMonitorUpdateErr::PermanentFailure => {
1342 log_error!($self.logger, "Closing channel {} due to monitor update ChannelMonitorUpdateErr::PermanentFailure", log_bytes!($chan_id[..]));
1343 update_maps_on_chan_removal!($self, $short_to_chan_info, $chan);
1344 // TODO: $failed_fails is dropped here, which will cause other channels to hit the
1345 // chain in a confused state! We need to move them into the ChannelMonitor which
1346 // will be responsible for failing backwards once things confirm on-chain.
1347 // It's ok that we drop $failed_forwards here - at this point we'd rather they
1348 // broadcast HTLC-Timeout and pay the associated fees to get their funds back than
1349 // us bother trying to claim it just to forward on to another peer. If we're
1350 // splitting hairs we'd prefer to claim payments that were to us, but we haven't
1351 // given up the preimage yet, so might as well just wait until the payment is
1352 // retried, avoiding the on-chain fees.
1353 let res: Result<(), _> = Err(MsgHandleErrInternal::from_finish_shutdown("ChannelMonitor storage failure".to_owned(), *$chan_id, $chan.get_user_id(),
1354 $chan.force_shutdown(true), $self.get_channel_update_for_broadcast(&$chan).ok() ));
1357 ChannelMonitorUpdateErr::TemporaryFailure => {
1358 log_info!($self.logger, "Disabling channel {} due to monitor update TemporaryFailure. On restore will send {} and process {} forwards, {} fails, and {} fulfill finalizations",
1359 log_bytes!($chan_id[..]),
1360 if $resend_commitment && $resend_raa {
1361 match $action_type {
1362 RAACommitmentOrder::CommitmentFirst => { "commitment then RAA" },
1363 RAACommitmentOrder::RevokeAndACKFirst => { "RAA then commitment" },
1365 } else if $resend_commitment { "commitment" }
1366 else if $resend_raa { "RAA" }
1368 (&$failed_forwards as &Vec<(PendingHTLCInfo, u64)>).len(),
1369 (&$failed_fails as &Vec<(HTLCSource, PaymentHash, HTLCFailReason)>).len(),
1370 (&$failed_finalized_fulfills as &Vec<HTLCSource>).len());
1371 if !$resend_commitment {
1372 debug_assert!($action_type == RAACommitmentOrder::RevokeAndACKFirst || !$resend_raa);
1375 debug_assert!($action_type == RAACommitmentOrder::CommitmentFirst || !$resend_commitment);
1377 $chan.monitor_update_failed($resend_raa, $resend_commitment, $resend_channel_ready, $failed_forwards, $failed_fails, $failed_finalized_fulfills);
1378 (Err(MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore("Failed to update ChannelMonitor".to_owned()), *$chan_id)), false)
1382 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr, $resend_channel_ready: expr, $failed_forwards: expr, $failed_fails: expr, $failed_finalized_fulfills: expr) => { {
1383 let (res, drop) = handle_monitor_err!($self, $err, $channel_state.short_to_chan_info, $entry.get_mut(), $action_type, $resend_raa, $resend_commitment, $resend_channel_ready, $failed_forwards, $failed_fails, $failed_finalized_fulfills, $entry.key());
1385 $entry.remove_entry();
1389 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $chan_id: expr, COMMITMENT_UPDATE_ONLY) => { {
1390 debug_assert!($action_type == RAACommitmentOrder::CommitmentFirst);
1391 handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, false, true, false, Vec::new(), Vec::new(), Vec::new(), $chan_id)
1393 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $chan_id: expr, NO_UPDATE) => {
1394 handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, false, false, false, Vec::new(), Vec::new(), Vec::new(), $chan_id)
1396 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_channel_ready: expr, OPTIONALLY_RESEND_FUNDING_LOCKED) => {
1397 handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, false, false, $resend_channel_ready, Vec::new(), Vec::new(), Vec::new())
1399 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
1400 handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment, false, Vec::new(), Vec::new(), Vec::new())
1402 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr, $failed_forwards: expr, $failed_fails: expr) => {
1403 handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment, false, $failed_forwards, $failed_fails, Vec::new())
1407 macro_rules! return_monitor_err {
1408 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
1409 return handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment);
1411 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr, $failed_forwards: expr, $failed_fails: expr) => {
1412 return handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment, $failed_forwards, $failed_fails);
1416 // Does not break in case of TemporaryFailure!
1417 macro_rules! maybe_break_monitor_err {
1418 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
1419 match (handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment), $err) {
1420 (e, ChannelMonitorUpdateErr::PermanentFailure) => {
1423 (_, ChannelMonitorUpdateErr::TemporaryFailure) => { },
1428 macro_rules! send_channel_ready {
1429 ($short_to_chan_info: expr, $pending_msg_events: expr, $channel: expr, $channel_ready_msg: expr) => {
1430 $pending_msg_events.push(events::MessageSendEvent::SendChannelReady {
1431 node_id: $channel.get_counterparty_node_id(),
1432 msg: $channel_ready_msg,
1434 // Note that we may send a `channel_ready` multiple times for a channel if we reconnect, so
1435 // we allow collisions, but we shouldn't ever be updating the channel ID pointed to.
1436 let outbound_alias_insert = $short_to_chan_info.insert($channel.outbound_scid_alias(), ($channel.get_counterparty_node_id(), $channel.channel_id()));
1437 assert!(outbound_alias_insert.is_none() || outbound_alias_insert.unwrap() == ($channel.get_counterparty_node_id(), $channel.channel_id()),
1438 "SCIDs should never collide - ensure you weren't behind the chain tip by a full month when creating channels");
1439 if let Some(real_scid) = $channel.get_short_channel_id() {
1440 let scid_insert = $short_to_chan_info.insert(real_scid, ($channel.get_counterparty_node_id(), $channel.channel_id()));
1441 assert!(scid_insert.is_none() || scid_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");
1447 macro_rules! handle_chan_restoration_locked {
1448 ($self: ident, $channel_lock: expr, $channel_state: expr, $channel_entry: expr,
1449 $raa: expr, $commitment_update: expr, $order: expr, $chanmon_update: expr,
1450 $pending_forwards: expr, $funding_broadcastable: expr, $channel_ready: expr, $announcement_sigs: expr) => { {
1451 let mut htlc_forwards = None;
1453 let chanmon_update: Option<ChannelMonitorUpdate> = $chanmon_update; // Force type-checking to resolve
1454 let chanmon_update_is_none = chanmon_update.is_none();
1455 let counterparty_node_id = $channel_entry.get().get_counterparty_node_id();
1457 let forwards: Vec<(PendingHTLCInfo, u64)> = $pending_forwards; // Force type-checking to resolve
1458 if !forwards.is_empty() {
1459 htlc_forwards = Some(($channel_entry.get().get_short_channel_id().unwrap_or($channel_entry.get().outbound_scid_alias()),
1460 $channel_entry.get().get_funding_txo().unwrap(), forwards));
1463 if chanmon_update.is_some() {
1464 // On reconnect, we, by definition, only resend a channel_ready if there have been
1465 // no commitment updates, so the only channel monitor update which could also be
1466 // associated with a channel_ready would be the funding_created/funding_signed
1467 // monitor update. That monitor update failing implies that we won't send
1468 // channel_ready until it's been updated, so we can't have a channel_ready and a
1469 // monitor update here (so we don't bother to handle it correctly below).
1470 assert!($channel_ready.is_none());
1471 // A channel monitor update makes no sense without either a channel_ready or a
1472 // commitment update to process after it. Since we can't have a channel_ready, we
1473 // only bother to handle the monitor-update + commitment_update case below.
1474 assert!($commitment_update.is_some());
1477 if let Some(msg) = $channel_ready {
1478 // Similar to the above, this implies that we're letting the channel_ready fly
1479 // before it should be allowed to.
1480 assert!(chanmon_update.is_none());
1481 send_channel_ready!($channel_state.short_to_chan_info, $channel_state.pending_msg_events, $channel_entry.get(), msg);
1483 if let Some(msg) = $announcement_sigs {
1484 $channel_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
1485 node_id: counterparty_node_id,
1490 let funding_broadcastable: Option<Transaction> = $funding_broadcastable; // Force type-checking to resolve
1491 if let Some(monitor_update) = chanmon_update {
1492 // We only ever broadcast a funding transaction in response to a funding_signed
1493 // message and the resulting monitor update. Thus, on channel_reestablish
1494 // message handling we can't have a funding transaction to broadcast. When
1495 // processing a monitor update finishing resulting in a funding broadcast, we
1496 // cannot have a second monitor update, thus this case would indicate a bug.
1497 assert!(funding_broadcastable.is_none());
1498 // Given we were just reconnected or finished updating a channel monitor, the
1499 // only case where we can get a new ChannelMonitorUpdate would be if we also
1500 // have some commitment updates to send as well.
1501 assert!($commitment_update.is_some());
1502 if let Err(e) = $self.chain_monitor.update_channel($channel_entry.get().get_funding_txo().unwrap(), monitor_update) {
1503 // channel_reestablish doesn't guarantee the order it returns is sensical
1504 // for the messages it returns, but if we're setting what messages to
1505 // re-transmit on monitor update success, we need to make sure it is sane.
1506 let mut order = $order;
1508 order = RAACommitmentOrder::CommitmentFirst;
1510 break handle_monitor_err!($self, e, $channel_state, $channel_entry, order, $raa.is_some(), true);
1514 macro_rules! handle_cs { () => {
1515 if let Some(update) = $commitment_update {
1516 $channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1517 node_id: counterparty_node_id,
1522 macro_rules! handle_raa { () => {
1523 if let Some(revoke_and_ack) = $raa {
1524 $channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
1525 node_id: counterparty_node_id,
1526 msg: revoke_and_ack,
1531 RAACommitmentOrder::CommitmentFirst => {
1535 RAACommitmentOrder::RevokeAndACKFirst => {
1540 if let Some(tx) = funding_broadcastable {
1541 log_info!($self.logger, "Broadcasting funding transaction with txid {}", tx.txid());
1542 $self.tx_broadcaster.broadcast_transaction(&tx);
1547 if chanmon_update_is_none {
1548 // If there was no ChannelMonitorUpdate, we should never generate an Err in the res loop
1549 // above. Doing so would imply calling handle_err!() from channel_monitor_updated() which
1550 // should *never* end up calling back to `chain_monitor.update_channel()`.
1551 assert!(res.is_ok());
1554 (htlc_forwards, res, counterparty_node_id)
1558 macro_rules! post_handle_chan_restoration {
1559 ($self: ident, $locked_res: expr) => { {
1560 let (htlc_forwards, res, counterparty_node_id) = $locked_res;
1562 let _ = handle_error!($self, res, counterparty_node_id);
1564 if let Some(forwards) = htlc_forwards {
1565 $self.forward_htlcs(&mut [forwards][..]);
1570 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<Signer, M, T, K, F, L>
1571 where M::Target: chain::Watch<Signer>,
1572 T::Target: BroadcasterInterface,
1573 K::Target: KeysInterface<Signer = Signer>,
1574 F::Target: FeeEstimator,
1577 /// Constructs a new ChannelManager to hold several channels and route between them.
1579 /// This is the main "logic hub" for all channel-related actions, and implements
1580 /// ChannelMessageHandler.
1582 /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
1584 /// Users need to notify the new ChannelManager when a new block is connected or
1585 /// disconnected using its `block_connected` and `block_disconnected` methods, starting
1586 /// from after `params.latest_hash`.
1587 pub fn new(fee_est: F, chain_monitor: M, tx_broadcaster: T, logger: L, keys_manager: K, config: UserConfig, params: ChainParameters) -> Self {
1588 let mut secp_ctx = Secp256k1::new();
1589 secp_ctx.seeded_randomize(&keys_manager.get_secure_random_bytes());
1590 let inbound_pmt_key_material = keys_manager.get_inbound_payment_key_material();
1591 let expanded_inbound_key = inbound_payment::ExpandedKey::new(&inbound_pmt_key_material);
1593 default_configuration: config.clone(),
1594 genesis_hash: genesis_block(params.network).header.block_hash(),
1595 fee_estimator: LowerBoundedFeeEstimator::new(fee_est),
1599 best_block: RwLock::new(params.best_block),
1601 channel_state: Mutex::new(ChannelHolder{
1602 by_id: HashMap::new(),
1603 short_to_chan_info: HashMap::new(),
1604 forward_htlcs: HashMap::new(),
1605 claimable_htlcs: HashMap::new(),
1606 pending_msg_events: Vec::new(),
1608 outbound_scid_aliases: Mutex::new(HashSet::new()),
1609 pending_inbound_payments: Mutex::new(HashMap::new()),
1610 pending_outbound_payments: Mutex::new(HashMap::new()),
1611 id_to_peer: Mutex::new(HashMap::new()),
1613 our_network_key: keys_manager.get_node_secret(Recipient::Node).unwrap(),
1614 our_network_pubkey: PublicKey::from_secret_key(&secp_ctx, &keys_manager.get_node_secret(Recipient::Node).unwrap()),
1617 inbound_payment_key: expanded_inbound_key,
1618 fake_scid_rand_bytes: keys_manager.get_secure_random_bytes(),
1620 probing_cookie_secret: keys_manager.get_secure_random_bytes(),
1622 last_node_announcement_serial: AtomicUsize::new(0),
1623 highest_seen_timestamp: AtomicUsize::new(0),
1625 per_peer_state: RwLock::new(HashMap::new()),
1627 pending_events: Mutex::new(Vec::new()),
1628 pending_background_events: Mutex::new(Vec::new()),
1629 total_consistency_lock: RwLock::new(()),
1630 persistence_notifier: PersistenceNotifier::new(),
1638 /// Gets the current configuration applied to all new channels, as
1639 pub fn get_current_default_configuration(&self) -> &UserConfig {
1640 &self.default_configuration
1643 fn create_and_insert_outbound_scid_alias(&self) -> u64 {
1644 let height = self.best_block.read().unwrap().height();
1645 let mut outbound_scid_alias = 0;
1648 if cfg!(fuzzing) { // fuzzing chacha20 doesn't use the key at all so we always get the same alias
1649 outbound_scid_alias += 1;
1651 outbound_scid_alias = fake_scid::Namespace::OutboundAlias.get_fake_scid(height, &self.genesis_hash, &self.fake_scid_rand_bytes, &self.keys_manager);
1653 if outbound_scid_alias != 0 && self.outbound_scid_aliases.lock().unwrap().insert(outbound_scid_alias) {
1657 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"); }
1662 /// Creates a new outbound channel to the given remote node and with the given value.
1664 /// `user_channel_id` will be provided back as in
1665 /// [`Event::FundingGenerationReady::user_channel_id`] to allow tracking of which events
1666 /// correspond with which `create_channel` call. Note that the `user_channel_id` defaults to 0
1667 /// for inbound channels, so you may wish to avoid using 0 for `user_channel_id` here.
1668 /// `user_channel_id` has no meaning inside of LDK, it is simply copied to events and otherwise
1671 /// Raises [`APIError::APIMisuseError`] when `channel_value_satoshis` > 2**24 or `push_msat` is
1672 /// greater than `channel_value_satoshis * 1k` or `channel_value_satoshis < 1000`.
1674 /// Note that we do not check if you are currently connected to the given peer. If no
1675 /// connection is available, the outbound `open_channel` message may fail to send, resulting in
1676 /// the channel eventually being silently forgotten (dropped on reload).
1678 /// Returns the new Channel's temporary `channel_id`. This ID will appear as
1679 /// [`Event::FundingGenerationReady::temporary_channel_id`] and in
1680 /// [`ChannelDetails::channel_id`] until after
1681 /// [`ChannelManager::funding_transaction_generated`] is called, swapping the Channel's ID for
1682 /// one derived from the funding transaction's TXID. If the counterparty rejects the channel
1683 /// immediately, this temporary ID will appear in [`Event::ChannelClosed::channel_id`].
1685 /// [`Event::FundingGenerationReady::user_channel_id`]: events::Event::FundingGenerationReady::user_channel_id
1686 /// [`Event::FundingGenerationReady::temporary_channel_id`]: events::Event::FundingGenerationReady::temporary_channel_id
1687 /// [`Event::ChannelClosed::channel_id`]: events::Event::ChannelClosed::channel_id
1688 pub fn create_channel(&self, their_network_key: PublicKey, channel_value_satoshis: u64, push_msat: u64, user_channel_id: u64, override_config: Option<UserConfig>) -> Result<[u8; 32], APIError> {
1689 if channel_value_satoshis < 1000 {
1690 return Err(APIError::APIMisuseError { err: format!("Channel value must be at least 1000 satoshis. It was {}", channel_value_satoshis) });
1694 let per_peer_state = self.per_peer_state.read().unwrap();
1695 match per_peer_state.get(&their_network_key) {
1696 Some(peer_state) => {
1697 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
1698 let peer_state = peer_state.lock().unwrap();
1699 let their_features = &peer_state.latest_features;
1700 let config = if override_config.is_some() { override_config.as_ref().unwrap() } else { &self.default_configuration };
1701 match Channel::new_outbound(&self.fee_estimator, &self.keys_manager, their_network_key,
1702 their_features, channel_value_satoshis, push_msat, user_channel_id, config,
1703 self.best_block.read().unwrap().height(), outbound_scid_alias)
1707 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
1712 None => return Err(APIError::ChannelUnavailable { err: format!("Not connected to node: {}", their_network_key) }),
1715 let res = channel.get_open_channel(self.genesis_hash.clone());
1717 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1718 // We want to make sure the lock is actually acquired by PersistenceNotifierGuard.
1719 debug_assert!(&self.total_consistency_lock.try_write().is_err());
1721 let temporary_channel_id = channel.channel_id();
1722 let mut channel_state = self.channel_state.lock().unwrap();
1723 match channel_state.by_id.entry(temporary_channel_id) {
1724 hash_map::Entry::Occupied(_) => {
1726 return Err(APIError::APIMisuseError { err: "Fuzzy bad RNG".to_owned() });
1728 panic!("RNG is bad???");
1731 hash_map::Entry::Vacant(entry) => { entry.insert(channel); }
1733 channel_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
1734 node_id: their_network_key,
1737 Ok(temporary_channel_id)
1740 fn list_channels_with_filter<Fn: FnMut(&(&[u8; 32], &Channel<Signer>)) -> bool>(&self, f: Fn) -> Vec<ChannelDetails> {
1741 let mut res = Vec::new();
1743 let channel_state = self.channel_state.lock().unwrap();
1744 res.reserve(channel_state.by_id.len());
1745 for (channel_id, channel) in channel_state.by_id.iter().filter(f) {
1746 let balance = channel.get_available_balances();
1747 let (to_remote_reserve_satoshis, to_self_reserve_satoshis) =
1748 channel.get_holder_counterparty_selected_channel_reserve_satoshis();
1749 res.push(ChannelDetails {
1750 channel_id: (*channel_id).clone(),
1751 counterparty: ChannelCounterparty {
1752 node_id: channel.get_counterparty_node_id(),
1753 features: InitFeatures::empty(),
1754 unspendable_punishment_reserve: to_remote_reserve_satoshis,
1755 forwarding_info: channel.counterparty_forwarding_info(),
1756 // Ensures that we have actually received the `htlc_minimum_msat` value
1757 // from the counterparty through the `OpenChannel` or `AcceptChannel`
1758 // message (as they are always the first message from the counterparty).
1759 // Else `Channel::get_counterparty_htlc_minimum_msat` could return the
1760 // default `0` value set by `Channel::new_outbound`.
1761 outbound_htlc_minimum_msat: if channel.have_received_message() {
1762 Some(channel.get_counterparty_htlc_minimum_msat()) } else { None },
1763 outbound_htlc_maximum_msat: channel.get_counterparty_htlc_maximum_msat(),
1765 funding_txo: channel.get_funding_txo(),
1766 // Note that accept_channel (or open_channel) is always the first message, so
1767 // `have_received_message` indicates that type negotiation has completed.
1768 channel_type: if channel.have_received_message() { Some(channel.get_channel_type().clone()) } else { None },
1769 short_channel_id: channel.get_short_channel_id(),
1770 outbound_scid_alias: if channel.is_usable() { Some(channel.outbound_scid_alias()) } else { None },
1771 inbound_scid_alias: channel.latest_inbound_scid_alias(),
1772 channel_value_satoshis: channel.get_value_satoshis(),
1773 unspendable_punishment_reserve: to_self_reserve_satoshis,
1774 balance_msat: balance.balance_msat,
1775 inbound_capacity_msat: balance.inbound_capacity_msat,
1776 outbound_capacity_msat: balance.outbound_capacity_msat,
1777 next_outbound_htlc_limit_msat: balance.next_outbound_htlc_limit_msat,
1778 user_channel_id: channel.get_user_id(),
1779 confirmations_required: channel.minimum_depth(),
1780 force_close_spend_delay: channel.get_counterparty_selected_contest_delay(),
1781 is_outbound: channel.is_outbound(),
1782 is_channel_ready: channel.is_usable(),
1783 is_usable: channel.is_live(),
1784 is_public: channel.should_announce(),
1785 inbound_htlc_minimum_msat: Some(channel.get_holder_htlc_minimum_msat()),
1786 inbound_htlc_maximum_msat: channel.get_holder_htlc_maximum_msat(),
1787 config: Some(channel.config()),
1791 let per_peer_state = self.per_peer_state.read().unwrap();
1792 for chan in res.iter_mut() {
1793 if let Some(peer_state) = per_peer_state.get(&chan.counterparty.node_id) {
1794 chan.counterparty.features = peer_state.lock().unwrap().latest_features.clone();
1800 /// Gets the list of open channels, in random order. See ChannelDetail field documentation for
1801 /// more information.
1802 pub fn list_channels(&self) -> Vec<ChannelDetails> {
1803 self.list_channels_with_filter(|_| true)
1806 /// Gets the list of usable channels, in random order. Useful as an argument to [`find_route`]
1807 /// to ensure non-announced channels are used.
1809 /// These are guaranteed to have their [`ChannelDetails::is_usable`] value set to true, see the
1810 /// documentation for [`ChannelDetails::is_usable`] for more info on exactly what the criteria
1813 /// [`find_route`]: crate::routing::router::find_route
1814 pub fn list_usable_channels(&self) -> Vec<ChannelDetails> {
1815 // Note we use is_live here instead of usable which leads to somewhat confused
1816 // internal/external nomenclature, but that's ok cause that's probably what the user
1817 // really wanted anyway.
1818 self.list_channels_with_filter(|&(_, ref channel)| channel.is_live())
1821 /// Helper function that issues the channel close events
1822 fn issue_channel_close_events(&self, channel: &Channel<Signer>, closure_reason: ClosureReason) {
1823 let mut pending_events_lock = self.pending_events.lock().unwrap();
1824 match channel.unbroadcasted_funding() {
1825 Some(transaction) => {
1826 pending_events_lock.push(events::Event::DiscardFunding { channel_id: channel.channel_id(), transaction })
1830 pending_events_lock.push(events::Event::ChannelClosed {
1831 channel_id: channel.channel_id(),
1832 user_channel_id: channel.get_user_id(),
1833 reason: closure_reason
1837 fn close_channel_internal(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey, target_feerate_sats_per_1000_weight: Option<u32>) -> Result<(), APIError> {
1838 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1840 let mut failed_htlcs: Vec<(HTLCSource, PaymentHash)>;
1841 let result: Result<(), _> = loop {
1842 let mut channel_state_lock = self.channel_state.lock().unwrap();
1843 let channel_state = &mut *channel_state_lock;
1844 match channel_state.by_id.entry(channel_id.clone()) {
1845 hash_map::Entry::Occupied(mut chan_entry) => {
1846 if *counterparty_node_id != chan_entry.get().get_counterparty_node_id(){
1847 return Err(APIError::APIMisuseError { err: "The passed counterparty_node_id doesn't match the channel's counterparty node_id".to_owned() });
1849 let per_peer_state = self.per_peer_state.read().unwrap();
1850 let (shutdown_msg, monitor_update, htlcs) = match per_peer_state.get(&counterparty_node_id) {
1851 Some(peer_state) => {
1852 let peer_state = peer_state.lock().unwrap();
1853 let their_features = &peer_state.latest_features;
1854 chan_entry.get_mut().get_shutdown(&self.keys_manager, their_features, target_feerate_sats_per_1000_weight)?
1856 None => return Err(APIError::ChannelUnavailable { err: format!("Not connected to node: {}", counterparty_node_id) }),
1858 failed_htlcs = htlcs;
1860 // Update the monitor with the shutdown script if necessary.
1861 if let Some(monitor_update) = monitor_update {
1862 if let Err(e) = self.chain_monitor.update_channel(chan_entry.get().get_funding_txo().unwrap(), monitor_update) {
1863 let (result, is_permanent) =
1864 handle_monitor_err!(self, e, channel_state.short_to_chan_info, chan_entry.get_mut(), RAACommitmentOrder::CommitmentFirst, chan_entry.key(), NO_UPDATE);
1866 remove_channel!(self, channel_state, chan_entry);
1872 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
1873 node_id: *counterparty_node_id,
1877 if chan_entry.get().is_shutdown() {
1878 let channel = remove_channel!(self, channel_state, chan_entry);
1879 if let Ok(channel_update) = self.get_channel_update_for_broadcast(&channel) {
1880 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1884 self.issue_channel_close_events(&channel, ClosureReason::HolderForceClosed);
1888 hash_map::Entry::Vacant(_) => return Err(APIError::ChannelUnavailable{err: "No such channel".to_owned()})
1892 for htlc_source in failed_htlcs.drain(..) {
1893 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source.0, &htlc_source.1, HTLCFailReason::Reason { failure_code: 0x4000 | 8, data: Vec::new() });
1896 let _ = handle_error!(self, result, *counterparty_node_id);
1900 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
1901 /// will be accepted on the given channel, and after additional timeout/the closing of all
1902 /// pending HTLCs, the channel will be closed on chain.
1904 /// * If we are the channel initiator, we will pay between our [`Background`] and
1905 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
1907 /// * If our counterparty is the channel initiator, we will require a channel closing
1908 /// transaction feerate of at least our [`Background`] feerate or the feerate which
1909 /// would appear on a force-closure transaction, whichever is lower. We will allow our
1910 /// counterparty to pay as much fee as they'd like, however.
1912 /// May generate a SendShutdown message event on success, which should be relayed.
1914 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
1915 /// [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
1916 /// [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
1917 pub fn close_channel(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey) -> Result<(), APIError> {
1918 self.close_channel_internal(channel_id, counterparty_node_id, None)
1921 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
1922 /// will be accepted on the given channel, and after additional timeout/the closing of all
1923 /// pending HTLCs, the channel will be closed on chain.
1925 /// `target_feerate_sat_per_1000_weight` has different meanings depending on if we initiated
1926 /// the channel being closed or not:
1927 /// * If we are the channel initiator, we will pay at least this feerate on the closing
1928 /// transaction. The upper-bound is set by
1929 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
1930 /// estimate (or `target_feerate_sat_per_1000_weight`, if it is greater).
1931 /// * If our counterparty is the channel initiator, we will refuse to accept a channel closure
1932 /// transaction feerate below `target_feerate_sat_per_1000_weight` (or the feerate which
1933 /// will appear on a force-closure transaction, whichever is lower).
1935 /// May generate a SendShutdown message event on success, which should be relayed.
1937 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
1938 /// [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
1939 /// [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
1940 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> {
1941 self.close_channel_internal(channel_id, counterparty_node_id, Some(target_feerate_sats_per_1000_weight))
1945 fn finish_force_close_channel(&self, shutdown_res: ShutdownResult) {
1946 let (monitor_update_option, mut failed_htlcs) = shutdown_res;
1947 log_debug!(self.logger, "Finishing force-closure of channel with {} HTLCs to fail", failed_htlcs.len());
1948 for htlc_source in failed_htlcs.drain(..) {
1949 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source.0, &htlc_source.1, HTLCFailReason::Reason { failure_code: 0x4000 | 8, data: Vec::new() });
1951 if let Some((funding_txo, monitor_update)) = monitor_update_option {
1952 // There isn't anything we can do if we get an update failure - we're already
1953 // force-closing. The monitor update on the required in-memory copy should broadcast
1954 // the latest local state, which is the best we can do anyway. Thus, it is safe to
1955 // ignore the result here.
1956 let _ = self.chain_monitor.update_channel(funding_txo, monitor_update);
1960 /// `peer_msg` should be set when we receive a message from a peer, but not set when the
1961 /// user closes, which will be re-exposed as the `ChannelClosed` reason.
1962 fn force_close_channel_with_peer(&self, channel_id: &[u8; 32], peer_node_id: &PublicKey, peer_msg: Option<&String>, broadcast: bool)
1963 -> Result<PublicKey, APIError> {
1965 let mut channel_state_lock = self.channel_state.lock().unwrap();
1966 let channel_state = &mut *channel_state_lock;
1967 if let hash_map::Entry::Occupied(chan) = channel_state.by_id.entry(channel_id.clone()) {
1968 if chan.get().get_counterparty_node_id() != *peer_node_id {
1969 return Err(APIError::ChannelUnavailable{err: "No such channel".to_owned()});
1971 if let Some(peer_msg) = peer_msg {
1972 self.issue_channel_close_events(chan.get(),ClosureReason::CounterpartyForceClosed { peer_msg: peer_msg.to_string() });
1974 self.issue_channel_close_events(chan.get(),ClosureReason::HolderForceClosed);
1976 remove_channel!(self, channel_state, chan)
1978 return Err(APIError::ChannelUnavailable{err: "No such channel".to_owned()});
1981 log_error!(self.logger, "Force-closing channel {}", log_bytes!(channel_id[..]));
1982 self.finish_force_close_channel(chan.force_shutdown(broadcast));
1983 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
1984 let mut channel_state = self.channel_state.lock().unwrap();
1985 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1990 Ok(chan.get_counterparty_node_id())
1993 fn force_close_sending_error(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey, broadcast: bool) -> Result<(), APIError> {
1994 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1995 match self.force_close_channel_with_peer(channel_id, counterparty_node_id, None, broadcast) {
1996 Ok(counterparty_node_id) => {
1997 self.channel_state.lock().unwrap().pending_msg_events.push(
1998 events::MessageSendEvent::HandleError {
1999 node_id: counterparty_node_id,
2000 action: msgs::ErrorAction::SendErrorMessage {
2001 msg: msgs::ErrorMessage { channel_id: *channel_id, data: "Channel force-closed".to_owned() }
2011 /// Force closes a channel, immediately broadcasting the latest local transaction(s) and
2012 /// rejecting new HTLCs on the given channel. Fails if `channel_id` is unknown to
2013 /// the manager, or if the `counterparty_node_id` isn't the counterparty of the corresponding
2015 pub fn force_close_broadcasting_latest_txn(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey)
2016 -> Result<(), APIError> {
2017 self.force_close_sending_error(channel_id, counterparty_node_id, true)
2020 /// Force closes a channel, rejecting new HTLCs on the given channel but skips broadcasting
2021 /// the latest local transaction(s). Fails if `channel_id` is unknown to the manager, or if the
2022 /// `counterparty_node_id` isn't the counterparty of the corresponding channel.
2024 /// You can always get the latest local transaction(s) to broadcast from
2025 /// [`ChannelMonitor::get_latest_holder_commitment_txn`].
2026 pub fn force_close_without_broadcasting_txn(&self, channel_id: &[u8; 32], counterparty_node_id: &PublicKey)
2027 -> Result<(), APIError> {
2028 self.force_close_sending_error(channel_id, counterparty_node_id, false)
2031 /// Force close all channels, immediately broadcasting the latest local commitment transaction
2032 /// for each to the chain and rejecting new HTLCs on each.
2033 pub fn force_close_all_channels_broadcasting_latest_txn(&self) {
2034 for chan in self.list_channels() {
2035 let _ = self.force_close_broadcasting_latest_txn(&chan.channel_id, &chan.counterparty.node_id);
2039 /// Force close all channels rejecting new HTLCs on each but without broadcasting the latest
2040 /// local transaction(s).
2041 pub fn force_close_all_channels_without_broadcasting_txn(&self) {
2042 for chan in self.list_channels() {
2043 let _ = self.force_close_without_broadcasting_txn(&chan.channel_id, &chan.counterparty.node_id);
2047 fn construct_recv_pending_htlc_info(&self, hop_data: msgs::OnionHopData, shared_secret: [u8; 32],
2048 payment_hash: PaymentHash, amt_msat: u64, cltv_expiry: u32, phantom_shared_secret: Option<[u8; 32]>) -> Result<PendingHTLCInfo, ReceiveError>
2050 // final_incorrect_cltv_expiry
2051 if hop_data.outgoing_cltv_value != cltv_expiry {
2052 return Err(ReceiveError {
2053 msg: "Upstream node set CLTV to the wrong value",
2055 err_data: byte_utils::be32_to_array(cltv_expiry).to_vec()
2058 // final_expiry_too_soon
2059 // We have to have some headroom to broadcast on chain if we have the preimage, so make sure
2060 // we have at least HTLC_FAIL_BACK_BUFFER blocks to go.
2061 // Also, ensure that, in the case of an unknown preimage for the received payment hash, our
2062 // payment logic has enough time to fail the HTLC backward before our onchain logic triggers a
2063 // channel closure (see HTLC_FAIL_BACK_BUFFER rationale).
2064 if (hop_data.outgoing_cltv_value as u64) <= self.best_block.read().unwrap().height() as u64 + HTLC_FAIL_BACK_BUFFER as u64 + 1 {
2065 return Err(ReceiveError {
2067 err_data: Vec::new(),
2068 msg: "The final CLTV expiry is too soon to handle",
2071 if hop_data.amt_to_forward > amt_msat {
2072 return Err(ReceiveError {
2074 err_data: byte_utils::be64_to_array(amt_msat).to_vec(),
2075 msg: "Upstream node sent less than we were supposed to receive in payment",
2079 let routing = match hop_data.format {
2080 msgs::OnionHopDataFormat::Legacy { .. } => {
2081 return Err(ReceiveError {
2082 err_code: 0x4000|0x2000|3,
2083 err_data: Vec::new(),
2084 msg: "We require payment_secrets",
2087 msgs::OnionHopDataFormat::NonFinalNode { .. } => {
2088 return Err(ReceiveError {
2089 err_code: 0x4000|22,
2090 err_data: Vec::new(),
2091 msg: "Got non final data with an HMAC of 0",
2094 msgs::OnionHopDataFormat::FinalNode { payment_data, keysend_preimage } => {
2095 if payment_data.is_some() && keysend_preimage.is_some() {
2096 return Err(ReceiveError {
2097 err_code: 0x4000|22,
2098 err_data: Vec::new(),
2099 msg: "We don't support MPP keysend payments",
2101 } else if let Some(data) = payment_data {
2102 PendingHTLCRouting::Receive {
2104 incoming_cltv_expiry: hop_data.outgoing_cltv_value,
2105 phantom_shared_secret,
2107 } else if let Some(payment_preimage) = keysend_preimage {
2108 // We need to check that the sender knows the keysend preimage before processing this
2109 // payment further. Otherwise, an intermediary routing hop forwarding non-keysend-HTLC X
2110 // could discover the final destination of X, by probing the adjacent nodes on the route
2111 // with a keysend payment of identical payment hash to X and observing the processing
2112 // time discrepancies due to a hash collision with X.
2113 let hashed_preimage = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
2114 if hashed_preimage != payment_hash {
2115 return Err(ReceiveError {
2116 err_code: 0x4000|22,
2117 err_data: Vec::new(),
2118 msg: "Payment preimage didn't match payment hash",
2122 PendingHTLCRouting::ReceiveKeysend {
2124 incoming_cltv_expiry: hop_data.outgoing_cltv_value,
2127 return Err(ReceiveError {
2128 err_code: 0x4000|0x2000|3,
2129 err_data: Vec::new(),
2130 msg: "We require payment_secrets",
2135 Ok(PendingHTLCInfo {
2138 incoming_shared_secret: shared_secret,
2139 amt_to_forward: amt_msat,
2140 outgoing_cltv_value: hop_data.outgoing_cltv_value,
2144 fn decode_update_add_htlc_onion(&self, msg: &msgs::UpdateAddHTLC) -> (PendingHTLCStatus, MutexGuard<ChannelHolder<Signer>>) {
2145 macro_rules! return_malformed_err {
2146 ($msg: expr, $err_code: expr) => {
2148 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
2149 return (PendingHTLCStatus::Fail(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
2150 channel_id: msg.channel_id,
2151 htlc_id: msg.htlc_id,
2152 sha256_of_onion: Sha256::hash(&msg.onion_routing_packet.hop_data).into_inner(),
2153 failure_code: $err_code,
2154 })), self.channel_state.lock().unwrap());
2159 if let Err(_) = msg.onion_routing_packet.public_key {
2160 return_malformed_err!("invalid ephemeral pubkey", 0x8000 | 0x4000 | 6);
2163 let shared_secret = SharedSecret::new(&msg.onion_routing_packet.public_key.unwrap(), &self.our_network_key).secret_bytes();
2165 if msg.onion_routing_packet.version != 0 {
2166 //TODO: Spec doesn't indicate if we should only hash hop_data here (and in other
2167 //sha256_of_onion error data packets), or the entire onion_routing_packet. Either way,
2168 //the hash doesn't really serve any purpose - in the case of hashing all data, the
2169 //receiving node would have to brute force to figure out which version was put in the
2170 //packet by the node that send us the message, in the case of hashing the hop_data, the
2171 //node knows the HMAC matched, so they already know what is there...
2172 return_malformed_err!("Unknown onion packet version", 0x8000 | 0x4000 | 4);
2175 let mut channel_state = None;
2176 macro_rules! return_err {
2177 ($msg: expr, $err_code: expr, $data: expr) => {
2179 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
2180 if channel_state.is_none() {
2181 channel_state = Some(self.channel_state.lock().unwrap());
2183 return (PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
2184 channel_id: msg.channel_id,
2185 htlc_id: msg.htlc_id,
2186 reason: onion_utils::build_first_hop_failure_packet(&shared_secret, $err_code, $data),
2187 })), channel_state.unwrap());
2192 let next_hop = match onion_utils::decode_next_hop(shared_secret, &msg.onion_routing_packet.hop_data[..], msg.onion_routing_packet.hmac, msg.payment_hash) {
2194 Err(onion_utils::OnionDecodeErr::Malformed { err_msg, err_code }) => {
2195 return_malformed_err!(err_msg, err_code);
2197 Err(onion_utils::OnionDecodeErr::Relay { err_msg, err_code }) => {
2198 return_err!(err_msg, err_code, &[0; 0]);
2202 let pending_forward_info = match next_hop {
2203 onion_utils::Hop::Receive(next_hop_data) => {
2205 match self.construct_recv_pending_htlc_info(next_hop_data, shared_secret, msg.payment_hash, msg.amount_msat, msg.cltv_expiry, None) {
2207 // Note that we could obviously respond immediately with an update_fulfill_htlc
2208 // message, however that would leak that we are the recipient of this payment, so
2209 // instead we stay symmetric with the forwarding case, only responding (after a
2210 // delay) once they've send us a commitment_signed!
2211 PendingHTLCStatus::Forward(info)
2213 Err(ReceiveError { err_code, err_data, msg }) => return_err!(msg, err_code, &err_data)
2216 onion_utils::Hop::Forward { next_hop_data, next_hop_hmac, new_packet_bytes } => {
2217 let new_pubkey = msg.onion_routing_packet.public_key.unwrap();
2218 let outgoing_packet = msgs::OnionPacket {
2220 public_key: onion_utils::next_hop_packet_pubkey(&self.secp_ctx, new_pubkey, &shared_secret),
2221 hop_data: new_packet_bytes,
2222 hmac: next_hop_hmac.clone(),
2225 let short_channel_id = match next_hop_data.format {
2226 msgs::OnionHopDataFormat::Legacy { short_channel_id } => short_channel_id,
2227 msgs::OnionHopDataFormat::NonFinalNode { short_channel_id } => short_channel_id,
2228 msgs::OnionHopDataFormat::FinalNode { .. } => {
2229 return_err!("Final Node OnionHopData provided for us as an intermediary node", 0x4000 | 22, &[0;0]);
2233 PendingHTLCStatus::Forward(PendingHTLCInfo {
2234 routing: PendingHTLCRouting::Forward {
2235 onion_packet: outgoing_packet,
2238 payment_hash: msg.payment_hash.clone(),
2239 incoming_shared_secret: shared_secret,
2240 amt_to_forward: next_hop_data.amt_to_forward,
2241 outgoing_cltv_value: next_hop_data.outgoing_cltv_value,
2246 channel_state = Some(self.channel_state.lock().unwrap());
2247 if let &PendingHTLCStatus::Forward(PendingHTLCInfo { ref routing, ref amt_to_forward, ref outgoing_cltv_value, .. }) = &pending_forward_info {
2248 // If short_channel_id is 0 here, we'll reject the HTLC as there cannot be a channel
2249 // with a short_channel_id of 0. This is important as various things later assume
2250 // short_channel_id is non-0 in any ::Forward.
2251 if let &PendingHTLCRouting::Forward { ref short_channel_id, .. } = routing {
2252 let id_option = channel_state.as_ref().unwrap().short_to_chan_info.get(&short_channel_id).cloned();
2253 if let Some((err, code, chan_update)) = loop {
2254 let forwarding_id_opt = match id_option {
2255 None => { // unknown_next_peer
2256 // Note that this is likely a timing oracle for detecting whether an scid is a
2258 if fake_scid::is_valid_phantom(&self.fake_scid_rand_bytes, *short_channel_id) {
2261 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
2264 Some((_cp_id, chan_id)) => Some(chan_id.clone()),
2266 let chan_update_opt = if let Some(forwarding_id) = forwarding_id_opt {
2267 let chan = channel_state.as_mut().unwrap().by_id.get_mut(&forwarding_id).unwrap();
2268 if !chan.should_announce() && !self.default_configuration.accept_forwards_to_priv_channels {
2269 // Note that the behavior here should be identical to the above block - we
2270 // should NOT reveal the existence or non-existence of a private channel if
2271 // we don't allow forwards outbound over them.
2272 break Some(("Refusing to forward to a private channel based on our config.", 0x4000 | 10, None));
2274 if chan.get_channel_type().supports_scid_privacy() && *short_channel_id != chan.outbound_scid_alias() {
2275 // `option_scid_alias` (referred to in LDK as `scid_privacy`) means
2276 // "refuse to forward unless the SCID alias was used", so we pretend
2277 // we don't have the channel here.
2278 break Some(("Refusing to forward over real channel SCID as our counterparty requested.", 0x4000 | 10, None));
2280 let chan_update_opt = self.get_channel_update_for_onion(*short_channel_id, chan).ok();
2282 // Note that we could technically not return an error yet here and just hope
2283 // that the connection is reestablished or monitor updated by the time we get
2284 // around to doing the actual forward, but better to fail early if we can and
2285 // hopefully an attacker trying to path-trace payments cannot make this occur
2286 // on a small/per-node/per-channel scale.
2287 if !chan.is_live() { // channel_disabled
2288 break Some(("Forwarding channel is not in a ready state.", 0x1000 | 20, chan_update_opt));
2290 if *amt_to_forward < chan.get_counterparty_htlc_minimum_msat() { // amount_below_minimum
2291 break Some(("HTLC amount was below the htlc_minimum_msat", 0x1000 | 11, chan_update_opt));
2293 if let Err((err, code)) = chan.htlc_satisfies_config(&msg, *amt_to_forward, *outgoing_cltv_value) {
2294 break Some((err, code, chan_update_opt));
2298 if (msg.cltv_expiry as u64) < (*outgoing_cltv_value) as u64 + MIN_CLTV_EXPIRY_DELTA as u64 { // incorrect_cltv_expiry
2300 "Forwarding node has tampered with the intended HTLC values or origin node has an obsolete cltv_expiry_delta",
2307 let cur_height = self.best_block.read().unwrap().height() + 1;
2308 // Theoretically, channel counterparty shouldn't send us a HTLC expiring now,
2309 // but we want to be robust wrt to counterparty packet sanitization (see
2310 // HTLC_FAIL_BACK_BUFFER rationale).
2311 if msg.cltv_expiry <= cur_height + HTLC_FAIL_BACK_BUFFER as u32 { // expiry_too_soon
2312 break Some(("CLTV expiry is too close", 0x1000 | 14, chan_update_opt));
2314 if msg.cltv_expiry > cur_height + CLTV_FAR_FAR_AWAY as u32 { // expiry_too_far
2315 break Some(("CLTV expiry is too far in the future", 21, None));
2317 // If the HTLC expires ~now, don't bother trying to forward it to our
2318 // counterparty. They should fail it anyway, but we don't want to bother with
2319 // the round-trips or risk them deciding they definitely want the HTLC and
2320 // force-closing to ensure they get it if we're offline.
2321 // We previously had a much more aggressive check here which tried to ensure
2322 // our counterparty receives an HTLC which has *our* risk threshold met on it,
2323 // but there is no need to do that, and since we're a bit conservative with our
2324 // risk threshold it just results in failing to forward payments.
2325 if (*outgoing_cltv_value) as u64 <= (cur_height + LATENCY_GRACE_PERIOD_BLOCKS) as u64 {
2326 break Some(("Outgoing CLTV value is too soon", 0x1000 | 14, chan_update_opt));
2332 let mut res = VecWriter(Vec::with_capacity(chan_update.serialized_length() + 2 + 8 + 2));
2333 if let Some(chan_update) = chan_update {
2334 if code == 0x1000 | 11 || code == 0x1000 | 12 {
2335 msg.amount_msat.write(&mut res).expect("Writes cannot fail");
2337 else if code == 0x1000 | 13 {
2338 msg.cltv_expiry.write(&mut res).expect("Writes cannot fail");
2340 else if code == 0x1000 | 20 {
2341 // TODO: underspecified, follow https://github.com/lightning/bolts/issues/791
2342 0u16.write(&mut res).expect("Writes cannot fail");
2344 (chan_update.serialized_length() as u16 + 2).write(&mut res).expect("Writes cannot fail");
2345 msgs::ChannelUpdate::TYPE.write(&mut res).expect("Writes cannot fail");
2346 chan_update.write(&mut res).expect("Writes cannot fail");
2348 return_err!(err, code, &res.0[..]);
2353 (pending_forward_info, channel_state.unwrap())
2356 /// Gets the current channel_update for the given channel. This first checks if the channel is
2357 /// public, and thus should be called whenever the result is going to be passed out in a
2358 /// [`MessageSendEvent::BroadcastChannelUpdate`] event.
2360 /// May be called with channel_state already locked!
2361 fn get_channel_update_for_broadcast(&self, chan: &Channel<Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
2362 if !chan.should_announce() {
2363 return Err(LightningError {
2364 err: "Cannot broadcast a channel_update for a private channel".to_owned(),
2365 action: msgs::ErrorAction::IgnoreError
2368 if chan.get_short_channel_id().is_none() {
2369 return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError});
2371 log_trace!(self.logger, "Attempting to generate broadcast channel update for channel {}", log_bytes!(chan.channel_id()));
2372 self.get_channel_update_for_unicast(chan)
2375 /// Gets the current channel_update for the given channel. This does not check if the channel
2376 /// is public (only returning an Err if the channel does not yet have an assigned short_id),
2377 /// and thus MUST NOT be called unless the recipient of the resulting message has already
2378 /// provided evidence that they know about the existence of the channel.
2379 /// May be called with channel_state already locked!
2380 fn get_channel_update_for_unicast(&self, chan: &Channel<Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
2381 log_trace!(self.logger, "Attempting to generate channel update for channel {}", log_bytes!(chan.channel_id()));
2382 let short_channel_id = match chan.get_short_channel_id().or(chan.latest_inbound_scid_alias()) {
2383 None => return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError}),
2387 self.get_channel_update_for_onion(short_channel_id, chan)
2389 fn get_channel_update_for_onion(&self, short_channel_id: u64, chan: &Channel<Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
2390 log_trace!(self.logger, "Generating channel update for channel {}", log_bytes!(chan.channel_id()));
2391 let were_node_one = PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key).serialize()[..] < chan.get_counterparty_node_id().serialize()[..];
2393 let unsigned = msgs::UnsignedChannelUpdate {
2394 chain_hash: self.genesis_hash,
2396 timestamp: chan.get_update_time_counter(),
2397 flags: (!were_node_one) as u8 | ((!chan.is_live() as u8) << 1),
2398 cltv_expiry_delta: chan.get_cltv_expiry_delta(),
2399 htlc_minimum_msat: chan.get_counterparty_htlc_minimum_msat(),
2400 htlc_maximum_msat: OptionalField::Present(chan.get_announced_htlc_max_msat()),
2401 fee_base_msat: chan.get_outbound_forwarding_fee_base_msat(),
2402 fee_proportional_millionths: chan.get_fee_proportional_millionths(),
2403 excess_data: Vec::new(),
2406 let msg_hash = Sha256dHash::hash(&unsigned.encode()[..]);
2407 let sig = self.secp_ctx.sign_ecdsa(&hash_to_message!(&msg_hash[..]), &self.our_network_key);
2409 Ok(msgs::ChannelUpdate {
2415 // Only public for testing, this should otherwise never be called direcly
2416 pub(crate) fn send_payment_along_path(&self, path: &Vec<RouteHop>, payment_params: &Option<PaymentParameters>, payment_hash: &PaymentHash, payment_secret: &Option<PaymentSecret>, total_value: u64, cur_height: u32, payment_id: PaymentId, keysend_preimage: &Option<PaymentPreimage>) -> Result<(), APIError> {
2417 log_trace!(self.logger, "Attempting to send payment for path with next hop {}", path.first().unwrap().short_channel_id);
2418 let prng_seed = self.keys_manager.get_secure_random_bytes();
2419 let session_priv_bytes = self.keys_manager.get_secure_random_bytes();
2420 let session_priv = SecretKey::from_slice(&session_priv_bytes[..]).expect("RNG is busted");
2422 let onion_keys = onion_utils::construct_onion_keys(&self.secp_ctx, &path, &session_priv)
2423 .map_err(|_| APIError::RouteError{err: "Pubkey along hop was maliciously selected"})?;
2424 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(path, total_value, payment_secret, cur_height, keysend_preimage)?;
2425 if onion_utils::route_size_insane(&onion_payloads) {
2426 return Err(APIError::RouteError{err: "Route size too large considering onion data"});
2428 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, prng_seed, payment_hash);
2430 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2432 let err: Result<(), _> = loop {
2433 let mut channel_lock = self.channel_state.lock().unwrap();
2435 let mut pending_outbounds = self.pending_outbound_payments.lock().unwrap();
2436 let payment_entry = pending_outbounds.entry(payment_id);
2437 if let hash_map::Entry::Occupied(payment) = &payment_entry {
2438 if !payment.get().is_retryable() {
2439 return Err(APIError::RouteError {
2440 err: "Payment already completed"
2445 let id = match channel_lock.short_to_chan_info.get(&path.first().unwrap().short_channel_id) {
2446 None => return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()}),
2447 Some((_cp_id, chan_id)) => chan_id.clone(),
2450 macro_rules! insert_outbound_payment {
2452 let payment = payment_entry.or_insert_with(|| PendingOutboundPayment::Retryable {
2453 session_privs: HashSet::new(),
2454 pending_amt_msat: 0,
2455 pending_fee_msat: Some(0),
2456 payment_hash: *payment_hash,
2457 payment_secret: *payment_secret,
2458 starting_block_height: self.best_block.read().unwrap().height(),
2459 total_msat: total_value,
2461 assert!(payment.insert(session_priv_bytes, path));
2465 let channel_state = &mut *channel_lock;
2466 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(id) {
2468 if chan.get().get_counterparty_node_id() != path.first().unwrap().pubkey {
2469 return Err(APIError::RouteError{err: "Node ID mismatch on first hop!"});
2471 if !chan.get().is_live() {
2472 return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected/pending monitor update!".to_owned()});
2474 break_chan_entry!(self, chan.get_mut().send_htlc_and_commit(
2475 htlc_msat, payment_hash.clone(), htlc_cltv, HTLCSource::OutboundRoute {
2477 session_priv: session_priv.clone(),
2478 first_hop_htlc_msat: htlc_msat,
2480 payment_secret: payment_secret.clone(),
2481 payment_params: payment_params.clone(),
2482 }, onion_packet, &self.logger),
2483 channel_state, chan)
2485 Some((update_add, commitment_signed, monitor_update)) => {
2486 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
2487 maybe_break_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, true);
2488 // Note that MonitorUpdateFailed here indicates (per function docs)
2489 // that we will resend the commitment update once monitor updating
2490 // is restored. Therefore, we must return an error indicating that
2491 // it is unsafe to retry the payment wholesale, which we do in the
2492 // send_payment check for MonitorUpdateFailed, below.
2493 insert_outbound_payment!(); // Only do this after possibly break'ing on Perm failure above.
2494 return Err(APIError::MonitorUpdateFailed);
2496 insert_outbound_payment!();
2498 log_debug!(self.logger, "Sending payment along path resulted in a commitment_signed for channel {}", log_bytes!(chan.get().channel_id()));
2499 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2500 node_id: path.first().unwrap().pubkey,
2501 updates: msgs::CommitmentUpdate {
2502 update_add_htlcs: vec![update_add],
2503 update_fulfill_htlcs: Vec::new(),
2504 update_fail_htlcs: Vec::new(),
2505 update_fail_malformed_htlcs: Vec::new(),
2511 None => { insert_outbound_payment!(); },
2513 } else { unreachable!(); }
2517 match handle_error!(self, err, path.first().unwrap().pubkey) {
2518 Ok(_) => unreachable!(),
2520 Err(APIError::ChannelUnavailable { err: e.err })
2525 /// Sends a payment along a given route.
2527 /// Value parameters are provided via the last hop in route, see documentation for RouteHop
2528 /// fields for more info.
2530 /// Note that if the payment_hash already exists elsewhere (eg you're sending a duplicative
2531 /// payment), we don't do anything to stop you! We always try to ensure that if the provided
2532 /// next hop knows the preimage to payment_hash they can claim an additional amount as
2533 /// specified in the last hop in the route! Thus, you should probably do your own
2534 /// payment_preimage tracking (which you should already be doing as they represent "proof of
2535 /// payment") and prevent double-sends yourself.
2537 /// May generate SendHTLCs message(s) event on success, which should be relayed.
2539 /// Each path may have a different return value, and PaymentSendValue may return a Vec with
2540 /// each entry matching the corresponding-index entry in the route paths, see
2541 /// PaymentSendFailure for more info.
2543 /// In general, a path may raise:
2544 /// * APIError::RouteError when an invalid route or forwarding parameter (cltv_delta, fee,
2545 /// node public key) is specified.
2546 /// * APIError::ChannelUnavailable if the next-hop channel is not available for updates
2547 /// (including due to previous monitor update failure or new permanent monitor update
2549 /// * APIError::MonitorUpdateFailed if a new monitor update failure prevented sending the
2550 /// relevant updates.
2552 /// Note that depending on the type of the PaymentSendFailure the HTLC may have been
2553 /// irrevocably committed to on our end. In such a case, do NOT retry the payment with a
2554 /// different route unless you intend to pay twice!
2556 /// payment_secret is unrelated to payment_hash (or PaymentPreimage) and exists to authenticate
2557 /// the sender to the recipient and prevent payment-probing (deanonymization) attacks. For
2558 /// newer nodes, it will be provided to you in the invoice. If you do not have one, the Route
2559 /// must not contain multiple paths as multi-path payments require a recipient-provided
2561 /// If a payment_secret *is* provided, we assume that the invoice had the payment_secret feature
2562 /// bit set (either as required or as available). If multiple paths are present in the Route,
2563 /// we assume the invoice had the basic_mpp feature set.
2564 pub fn send_payment(&self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>) -> Result<PaymentId, PaymentSendFailure> {
2565 self.send_payment_internal(route, payment_hash, payment_secret, None, None, None)
2568 fn send_payment_internal(&self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>, keysend_preimage: Option<PaymentPreimage>, payment_id: Option<PaymentId>, recv_value_msat: Option<u64>) -> Result<PaymentId, PaymentSendFailure> {
2569 if route.paths.len() < 1 {
2570 return Err(PaymentSendFailure::ParameterError(APIError::RouteError{err: "There must be at least one path to send over"}));
2572 if payment_secret.is_none() && route.paths.len() > 1 {
2573 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError{err: "Payment secret is required for multi-path payments".to_string()}));
2575 let mut total_value = 0;
2576 let our_node_id = self.get_our_node_id();
2577 let mut path_errs = Vec::with_capacity(route.paths.len());
2578 let payment_id = if let Some(id) = payment_id { id } else { PaymentId(self.keys_manager.get_secure_random_bytes()) };
2579 'path_check: for path in route.paths.iter() {
2580 if path.len() < 1 || path.len() > 20 {
2581 path_errs.push(Err(APIError::RouteError{err: "Path didn't go anywhere/had bogus size"}));
2582 continue 'path_check;
2584 for (idx, hop) in path.iter().enumerate() {
2585 if idx != path.len() - 1 && hop.pubkey == our_node_id {
2586 path_errs.push(Err(APIError::RouteError{err: "Path went through us but wasn't a simple rebalance loop to us"}));
2587 continue 'path_check;
2590 total_value += path.last().unwrap().fee_msat;
2591 path_errs.push(Ok(()));
2593 if path_errs.iter().any(|e| e.is_err()) {
2594 return Err(PaymentSendFailure::PathParameterError(path_errs));
2596 if let Some(amt_msat) = recv_value_msat {
2597 debug_assert!(amt_msat >= total_value);
2598 total_value = amt_msat;
2601 let cur_height = self.best_block.read().unwrap().height() + 1;
2602 let mut results = Vec::new();
2603 for path in route.paths.iter() {
2604 results.push(self.send_payment_along_path(&path, &route.payment_params, &payment_hash, payment_secret, total_value, cur_height, payment_id, &keysend_preimage));
2606 let mut has_ok = false;
2607 let mut has_err = false;
2608 let mut pending_amt_unsent = 0;
2609 let mut max_unsent_cltv_delta = 0;
2610 for (res, path) in results.iter().zip(route.paths.iter()) {
2611 if res.is_ok() { has_ok = true; }
2612 if res.is_err() { has_err = true; }
2613 if let &Err(APIError::MonitorUpdateFailed) = res {
2614 // MonitorUpdateFailed is inherently unsafe to retry, so we call it a
2618 } else if res.is_err() {
2619 pending_amt_unsent += path.last().unwrap().fee_msat;
2620 max_unsent_cltv_delta = cmp::max(max_unsent_cltv_delta, path.last().unwrap().cltv_expiry_delta);
2623 if has_err && has_ok {
2624 Err(PaymentSendFailure::PartialFailure {
2627 failed_paths_retry: if pending_amt_unsent != 0 {
2628 if let Some(payment_params) = &route.payment_params {
2629 Some(RouteParameters {
2630 payment_params: payment_params.clone(),
2631 final_value_msat: pending_amt_unsent,
2632 final_cltv_expiry_delta: max_unsent_cltv_delta,
2638 // If we failed to send any paths, we shouldn't have inserted the new PaymentId into
2639 // our `pending_outbound_payments` map at all.
2640 debug_assert!(self.pending_outbound_payments.lock().unwrap().get(&payment_id).is_none());
2641 Err(PaymentSendFailure::AllFailedRetrySafe(results.drain(..).map(|r| r.unwrap_err()).collect()))
2647 /// Retries a payment along the given [`Route`].
2649 /// Errors returned are a superset of those returned from [`send_payment`], so see
2650 /// [`send_payment`] documentation for more details on errors. This method will also error if the
2651 /// retry amount puts the payment more than 10% over the payment's total amount, if the payment
2652 /// for the given `payment_id` cannot be found (likely due to timeout or success), or if
2653 /// further retries have been disabled with [`abandon_payment`].
2655 /// [`send_payment`]: [`ChannelManager::send_payment`]
2656 /// [`abandon_payment`]: [`ChannelManager::abandon_payment`]
2657 pub fn retry_payment(&self, route: &Route, payment_id: PaymentId) -> Result<(), PaymentSendFailure> {
2658 const RETRY_OVERFLOW_PERCENTAGE: u64 = 10;
2659 for path in route.paths.iter() {
2660 if path.len() == 0 {
2661 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
2662 err: "length-0 path in route".to_string()
2667 let (total_msat, payment_hash, payment_secret) = {
2668 let outbounds = self.pending_outbound_payments.lock().unwrap();
2669 if let Some(payment) = outbounds.get(&payment_id) {
2671 PendingOutboundPayment::Retryable {
2672 total_msat, payment_hash, payment_secret, pending_amt_msat, ..
2674 let retry_amt_msat: u64 = route.paths.iter().map(|path| path.last().unwrap().fee_msat).sum();
2675 if retry_amt_msat + *pending_amt_msat > *total_msat * (100 + RETRY_OVERFLOW_PERCENTAGE) / 100 {
2676 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
2677 err: format!("retry_amt_msat of {} will put pending_amt_msat (currently: {}) more than 10% over total_payment_amt_msat of {}", retry_amt_msat, pending_amt_msat, total_msat).to_string()
2680 (*total_msat, *payment_hash, *payment_secret)
2682 PendingOutboundPayment::Legacy { .. } => {
2683 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
2684 err: "Unable to retry payments that were initially sent on LDK versions prior to 0.0.102".to_string()
2687 PendingOutboundPayment::Fulfilled { .. } => {
2688 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
2689 err: "Payment already completed".to_owned()
2692 PendingOutboundPayment::Abandoned { .. } => {
2693 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
2694 err: "Payment already abandoned (with some HTLCs still pending)".to_owned()
2699 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
2700 err: format!("Payment with ID {} not found", log_bytes!(payment_id.0)),
2704 return self.send_payment_internal(route, payment_hash, &payment_secret, None, Some(payment_id), Some(total_msat)).map(|_| ())
2707 /// Signals that no further retries for the given payment will occur.
2709 /// After this method returns, any future calls to [`retry_payment`] for the given `payment_id`
2710 /// will fail with [`PaymentSendFailure::ParameterError`]. If no such event has been generated,
2711 /// an [`Event::PaymentFailed`] event will be generated as soon as there are no remaining
2712 /// pending HTLCs for this payment.
2714 /// Note that calling this method does *not* prevent a payment from succeeding. You must still
2715 /// wait until you receive either a [`Event::PaymentFailed`] or [`Event::PaymentSent`] event to
2716 /// determine the ultimate status of a payment.
2718 /// [`retry_payment`]: Self::retry_payment
2719 /// [`Event::PaymentFailed`]: events::Event::PaymentFailed
2720 /// [`Event::PaymentSent`]: events::Event::PaymentSent
2721 pub fn abandon_payment(&self, payment_id: PaymentId) {
2722 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2724 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
2725 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
2726 if let Ok(()) = payment.get_mut().mark_abandoned() {
2727 if payment.get().remaining_parts() == 0 {
2728 self.pending_events.lock().unwrap().push(events::Event::PaymentFailed {
2730 payment_hash: payment.get().payment_hash().expect("PendingOutboundPayments::RetriesExceeded always has a payment hash set"),
2738 /// Send a spontaneous payment, which is a payment that does not require the recipient to have
2739 /// generated an invoice. Optionally, you may specify the preimage. If you do choose to specify
2740 /// the preimage, it must be a cryptographically secure random value that no intermediate node
2741 /// would be able to guess -- otherwise, an intermediate node may claim the payment and it will
2742 /// never reach the recipient.
2744 /// See [`send_payment`] documentation for more details on the return value of this function.
2746 /// Similar to regular payments, you MUST NOT reuse a `payment_preimage` value. See
2747 /// [`send_payment`] for more information about the risks of duplicate preimage usage.
2749 /// Note that `route` must have exactly one path.
2751 /// [`send_payment`]: Self::send_payment
2752 pub fn send_spontaneous_payment(&self, route: &Route, payment_preimage: Option<PaymentPreimage>) -> Result<(PaymentHash, PaymentId), PaymentSendFailure> {
2753 let preimage = match payment_preimage {
2755 None => PaymentPreimage(self.keys_manager.get_secure_random_bytes()),
2757 let payment_hash = PaymentHash(Sha256::hash(&preimage.0).into_inner());
2758 match self.send_payment_internal(route, payment_hash, &None, Some(preimage), None, None) {
2759 Ok(payment_id) => Ok((payment_hash, payment_id)),
2764 /// Send a payment that is probing the given route for liquidity. We calculate the
2765 /// [`PaymentHash`] of probes based on a static secret and a random [`PaymentId`], which allows
2766 /// us to easily discern them from real payments.
2767 pub fn send_probe(&self, hops: Vec<RouteHop>) -> Result<(PaymentHash, PaymentId), PaymentSendFailure> {
2768 let payment_id = PaymentId(self.keys_manager.get_secure_random_bytes());
2770 let payment_hash = self.probing_cookie_from_id(&payment_id);
2773 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
2774 err: "No need probing a path with less than two hops".to_string()
2778 let route = Route { paths: vec![hops], payment_params: None };
2780 match self.send_payment_internal(&route, payment_hash, &None, None, Some(payment_id), None) {
2781 Ok(payment_id) => Ok((payment_hash, payment_id)),
2786 /// Returns whether a payment with the given [`PaymentHash`] and [`PaymentId`] is, in fact, a
2788 pub(crate) fn payment_is_probe(&self, payment_hash: &PaymentHash, payment_id: &PaymentId) -> bool {
2789 let target_payment_hash = self.probing_cookie_from_id(payment_id);
2790 target_payment_hash == *payment_hash
2793 /// Returns the 'probing cookie' for the given [`PaymentId`].
2794 fn probing_cookie_from_id(&self, payment_id: &PaymentId) -> PaymentHash {
2795 let mut preimage = [0u8; 64];
2796 preimage[..32].copy_from_slice(&self.probing_cookie_secret);
2797 preimage[32..].copy_from_slice(&payment_id.0);
2798 PaymentHash(Sha256::hash(&preimage).into_inner())
2801 /// Handles the generation of a funding transaction, optionally (for tests) with a function
2802 /// which checks the correctness of the funding transaction given the associated channel.
2803 fn funding_transaction_generated_intern<FundingOutput: Fn(&Channel<Signer>, &Transaction) -> Result<OutPoint, APIError>>(
2804 &self, temporary_channel_id: &[u8; 32], _counterparty_node_id: &PublicKey, funding_transaction: Transaction, find_funding_output: FundingOutput
2805 ) -> Result<(), APIError> {
2807 let (res, chan) = match self.channel_state.lock().unwrap().by_id.remove(temporary_channel_id) {
2809 let funding_txo = find_funding_output(&chan, &funding_transaction)?;
2811 (chan.get_outbound_funding_created(funding_transaction, funding_txo, &self.logger)
2812 .map_err(|e| if let ChannelError::Close(msg) = e {
2813 MsgHandleErrInternal::from_finish_shutdown(msg, chan.channel_id(), chan.get_user_id(), chan.force_shutdown(true), None)
2814 } else { unreachable!(); })
2817 None => { return Err(APIError::ChannelUnavailable { err: "No such channel".to_owned() }) },
2819 match handle_error!(self, res, chan.get_counterparty_node_id()) {
2820 Ok(funding_msg) => {
2823 Err(_) => { return Err(APIError::ChannelUnavailable {
2824 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()
2829 let mut channel_state = self.channel_state.lock().unwrap();
2830 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
2831 node_id: chan.get_counterparty_node_id(),
2834 match channel_state.by_id.entry(chan.channel_id()) {
2835 hash_map::Entry::Occupied(_) => {
2836 panic!("Generated duplicate funding txid?");
2838 hash_map::Entry::Vacant(e) => {
2839 let mut id_to_peer = self.id_to_peer.lock().unwrap();
2840 if id_to_peer.insert(chan.channel_id(), chan.get_counterparty_node_id()).is_some() {
2841 panic!("id_to_peer map already contained funding txid, which shouldn't be possible");
2850 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> {
2851 self.funding_transaction_generated_intern(temporary_channel_id, counterparty_node_id, funding_transaction, |_, tx| {
2852 Ok(OutPoint { txid: tx.txid(), index: output_index })
2856 /// Call this upon creation of a funding transaction for the given channel.
2858 /// Returns an [`APIError::APIMisuseError`] if the funding_transaction spent non-SegWit outputs
2859 /// or if no output was found which matches the parameters in [`Event::FundingGenerationReady`].
2861 /// Returns [`APIError::APIMisuseError`] if the funding transaction is not final for propagation
2862 /// across the p2p network.
2864 /// Returns [`APIError::ChannelUnavailable`] if a funding transaction has already been provided
2865 /// for the channel or if the channel has been closed as indicated by [`Event::ChannelClosed`].
2867 /// May panic if the output found in the funding transaction is duplicative with some other
2868 /// channel (note that this should be trivially prevented by using unique funding transaction
2869 /// keys per-channel).
2871 /// Do NOT broadcast the funding transaction yourself. When we have safely received our
2872 /// counterparty's signature the funding transaction will automatically be broadcast via the
2873 /// [`BroadcasterInterface`] provided when this `ChannelManager` was constructed.
2875 /// Note that this includes RBF or similar transaction replacement strategies - lightning does
2876 /// not currently support replacing a funding transaction on an existing channel. Instead,
2877 /// create a new channel with a conflicting funding transaction.
2879 /// Note to keep the miner incentives aligned in moving the blockchain forward, we recommend
2880 /// the wallet software generating the funding transaction to apply anti-fee sniping as
2881 /// implemented by Bitcoin Core wallet. See <https://bitcoinops.org/en/topics/fee-sniping/>
2882 /// for more details.
2884 /// [`Event::FundingGenerationReady`]: crate::util::events::Event::FundingGenerationReady
2885 /// [`Event::ChannelClosed`]: crate::util::events::Event::ChannelClosed
2886 pub fn funding_transaction_generated(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, funding_transaction: Transaction) -> Result<(), APIError> {
2887 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2889 for inp in funding_transaction.input.iter() {
2890 if inp.witness.is_empty() {
2891 return Err(APIError::APIMisuseError {
2892 err: "Funding transaction must be fully signed and spend Segwit outputs".to_owned()
2897 let height = self.best_block.read().unwrap().height();
2898 // Transactions are evaluated as final by network mempools at the next block. However, the modules
2899 // constituting our Lightning node might not have perfect sync about their blockchain views. Thus, if
2900 // the wallet module is in advance on the LDK view, allow one more block of headroom.
2901 // TODO: updated if/when https://github.com/rust-bitcoin/rust-bitcoin/pull/994 landed and rust-bitcoin bumped.
2902 if !funding_transaction.input.iter().all(|input| input.sequence == 0xffffffff) && funding_transaction.lock_time < 500_000_000 && funding_transaction.lock_time > height + 2 {
2903 return Err(APIError::APIMisuseError {
2904 err: "Funding transaction absolute timelock is non-final".to_owned()
2908 self.funding_transaction_generated_intern(temporary_channel_id, counterparty_node_id, funding_transaction, |chan, tx| {
2909 let mut output_index = None;
2910 let expected_spk = chan.get_funding_redeemscript().to_v0_p2wsh();
2911 for (idx, outp) in tx.output.iter().enumerate() {
2912 if outp.script_pubkey == expected_spk && outp.value == chan.get_value_satoshis() {
2913 if output_index.is_some() {
2914 return Err(APIError::APIMisuseError {
2915 err: "Multiple outputs matched the expected script and value".to_owned()
2918 if idx > u16::max_value() as usize {
2919 return Err(APIError::APIMisuseError {
2920 err: "Transaction had more than 2^16 outputs, which is not supported".to_owned()
2923 output_index = Some(idx as u16);
2926 if output_index.is_none() {
2927 return Err(APIError::APIMisuseError {
2928 err: "No output matched the script_pubkey and value in the FundingGenerationReady event".to_owned()
2931 Ok(OutPoint { txid: tx.txid(), index: output_index.unwrap() })
2936 // Messages of up to 64KB should never end up more than half full with addresses, as that would
2937 // be absurd. We ensure this by checking that at least 100 (our stated public contract on when
2938 // broadcast_node_announcement panics) of the maximum-length addresses would fit in a 64KB
2940 const HALF_MESSAGE_IS_ADDRS: u32 = ::core::u16::MAX as u32 / (NetAddress::MAX_LEN as u32 + 1) / 2;
2943 // ...by failing to compile if the number of addresses that would be half of a message is
2944 // smaller than 100:
2945 const STATIC_ASSERT: u32 = Self::HALF_MESSAGE_IS_ADDRS - 100;
2947 /// Regenerates channel_announcements and generates a signed node_announcement from the given
2948 /// arguments, providing them in corresponding events via
2949 /// [`get_and_clear_pending_msg_events`], if at least one public channel has been confirmed
2950 /// on-chain. This effectively re-broadcasts all channel announcements and sends our node
2951 /// announcement to ensure that the lightning P2P network is aware of the channels we have and
2952 /// our network addresses.
2954 /// `rgb` is a node "color" and `alias` is a printable human-readable string to describe this
2955 /// node to humans. They carry no in-protocol meaning.
2957 /// `addresses` represent the set (possibly empty) of socket addresses on which this node
2958 /// accepts incoming connections. These will be included in the node_announcement, publicly
2959 /// tying these addresses together and to this node. If you wish to preserve user privacy,
2960 /// addresses should likely contain only Tor Onion addresses.
2962 /// Panics if `addresses` is absurdly large (more than 100).
2964 /// [`get_and_clear_pending_msg_events`]: MessageSendEventsProvider::get_and_clear_pending_msg_events
2965 pub fn broadcast_node_announcement(&self, rgb: [u8; 3], alias: [u8; 32], mut addresses: Vec<NetAddress>) {
2966 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2968 if addresses.len() > 100 {
2969 panic!("More than half the message size was taken up by public addresses!");
2972 // While all existing nodes handle unsorted addresses just fine, the spec requires that
2973 // addresses be sorted for future compatibility.
2974 addresses.sort_by_key(|addr| addr.get_id());
2976 let announcement = msgs::UnsignedNodeAnnouncement {
2977 features: NodeFeatures::known(),
2978 timestamp: self.last_node_announcement_serial.fetch_add(1, Ordering::AcqRel) as u32,
2979 node_id: self.get_our_node_id(),
2980 rgb, alias, addresses,
2981 excess_address_data: Vec::new(),
2982 excess_data: Vec::new(),
2984 let msghash = hash_to_message!(&Sha256dHash::hash(&announcement.encode()[..])[..]);
2985 let node_announce_sig = sign(&self.secp_ctx, &msghash, &self.our_network_key);
2987 let mut channel_state_lock = self.channel_state.lock().unwrap();
2988 let channel_state = &mut *channel_state_lock;
2990 let mut announced_chans = false;
2991 for (_, chan) in channel_state.by_id.iter() {
2992 if let Some(msg) = chan.get_signed_channel_announcement(self.get_our_node_id(), self.genesis_hash.clone(), self.best_block.read().unwrap().height()) {
2993 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
2995 update_msg: match self.get_channel_update_for_broadcast(chan) {
3000 announced_chans = true;
3002 // If the channel is not public or has not yet reached channel_ready, check the
3003 // next channel. If we don't yet have any public channels, we'll skip the broadcast
3004 // below as peers may not accept it without channels on chain first.
3008 if announced_chans {
3009 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastNodeAnnouncement {
3010 msg: msgs::NodeAnnouncement {
3011 signature: node_announce_sig,
3012 contents: announcement
3018 /// Atomically updates the [`ChannelConfig`] for the given channels.
3020 /// Once the updates are applied, each eligible channel (advertised with a known short channel
3021 /// ID and a change in [`forwarding_fee_proportional_millionths`], [`forwarding_fee_base_msat`],
3022 /// or [`cltv_expiry_delta`]) has a [`BroadcastChannelUpdate`] event message generated
3023 /// containing the new [`ChannelUpdate`] message which should be broadcast to the network.
3025 /// Returns [`ChannelUnavailable`] when a channel is not found or an incorrect
3026 /// `counterparty_node_id` is provided.
3028 /// Returns [`APIMisuseError`] when a [`cltv_expiry_delta`] update is to be applied with a value
3029 /// below [`MIN_CLTV_EXPIRY_DELTA`].
3031 /// If an error is returned, none of the updates should be considered applied.
3033 /// [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
3034 /// [`forwarding_fee_base_msat`]: ChannelConfig::forwarding_fee_base_msat
3035 /// [`cltv_expiry_delta`]: ChannelConfig::cltv_expiry_delta
3036 /// [`BroadcastChannelUpdate`]: events::MessageSendEvent::BroadcastChannelUpdate
3037 /// [`ChannelUpdate`]: msgs::ChannelUpdate
3038 /// [`ChannelUnavailable`]: APIError::ChannelUnavailable
3039 /// [`APIMisuseError`]: APIError::APIMisuseError
3040 pub fn update_channel_config(
3041 &self, counterparty_node_id: &PublicKey, channel_ids: &[[u8; 32]], config: &ChannelConfig,
3042 ) -> Result<(), APIError> {
3043 if config.cltv_expiry_delta < MIN_CLTV_EXPIRY_DELTA {
3044 return Err(APIError::APIMisuseError {
3045 err: format!("The chosen CLTV expiry delta is below the minimum of {}", MIN_CLTV_EXPIRY_DELTA),
3049 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(
3050 &self.total_consistency_lock, &self.persistence_notifier,
3053 let mut channel_state_lock = self.channel_state.lock().unwrap();
3054 let channel_state = &mut *channel_state_lock;
3055 for channel_id in channel_ids {
3056 let channel_counterparty_node_id = channel_state.by_id.get(channel_id)
3057 .ok_or(APIError::ChannelUnavailable {
3058 err: format!("Channel with ID {} was not found", log_bytes!(*channel_id)),
3060 .get_counterparty_node_id();
3061 if channel_counterparty_node_id != *counterparty_node_id {
3062 return Err(APIError::APIMisuseError {
3063 err: "counterparty node id mismatch".to_owned(),
3067 for channel_id in channel_ids {
3068 let channel = channel_state.by_id.get_mut(channel_id).unwrap();
3069 if !channel.update_config(config) {
3072 if let Ok(msg) = self.get_channel_update_for_broadcast(channel) {
3073 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate { msg });
3074 } else if let Ok(msg) = self.get_channel_update_for_unicast(channel) {
3075 channel_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
3076 node_id: channel.get_counterparty_node_id(),
3085 /// Processes HTLCs which are pending waiting on random forward delay.
3087 /// Should only really ever be called in response to a PendingHTLCsForwardable event.
3088 /// Will likely generate further events.
3089 pub fn process_pending_htlc_forwards(&self) {
3090 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
3092 let mut new_events = Vec::new();
3093 let mut failed_forwards = Vec::new();
3094 let mut phantom_receives: Vec<(u64, OutPoint, Vec<(PendingHTLCInfo, u64)>)> = Vec::new();
3095 let mut handle_errors = Vec::new();
3097 let mut channel_state_lock = self.channel_state.lock().unwrap();
3098 let channel_state = &mut *channel_state_lock;
3100 for (short_chan_id, mut pending_forwards) in channel_state.forward_htlcs.drain() {
3101 if short_chan_id != 0 {
3102 let forward_chan_id = match channel_state.short_to_chan_info.get(&short_chan_id) {
3103 Some((_cp_id, chan_id)) => chan_id.clone(),
3105 for forward_info in pending_forwards.drain(..) {
3106 match forward_info {
3107 HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info: PendingHTLCInfo {
3108 routing, incoming_shared_secret, payment_hash, amt_to_forward, outgoing_cltv_value },
3109 prev_funding_outpoint } => {
3110 macro_rules! fail_forward {
3111 ($msg: expr, $err_code: expr, $err_data: expr, $phantom_ss: expr) => {
3113 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
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_shared_secret: $phantom_ss,
3121 failed_forwards.push((htlc_source, payment_hash,
3122 HTLCFailReason::Reason { failure_code: $err_code, data: $err_data }
3128 if let PendingHTLCRouting::Forward { onion_packet, .. } = routing {
3129 let phantom_secret_res = self.keys_manager.get_node_secret(Recipient::PhantomNode);
3130 if phantom_secret_res.is_ok() && fake_scid::is_valid_phantom(&self.fake_scid_rand_bytes, short_chan_id) {
3131 let phantom_shared_secret = SharedSecret::new(&onion_packet.public_key.unwrap(), &phantom_secret_res.unwrap()).secret_bytes();
3132 let next_hop = match onion_utils::decode_next_hop(phantom_shared_secret, &onion_packet.hop_data, onion_packet.hmac, payment_hash) {
3134 Err(onion_utils::OnionDecodeErr::Malformed { err_msg, err_code }) => {
3135 let sha256_of_onion = Sha256::hash(&onion_packet.hop_data).into_inner();
3136 // In this scenario, the phantom would have sent us an
3137 // `update_fail_malformed_htlc`, meaning here we encrypt the error as
3138 // if it came from us (the second-to-last hop) but contains the sha256
3140 fail_forward!(err_msg, err_code, sha256_of_onion.to_vec(), None);
3142 Err(onion_utils::OnionDecodeErr::Relay { err_msg, err_code }) => {
3143 fail_forward!(err_msg, err_code, Vec::new(), Some(phantom_shared_secret));
3147 onion_utils::Hop::Receive(hop_data) => {
3148 match self.construct_recv_pending_htlc_info(hop_data, incoming_shared_secret, payment_hash, amt_to_forward, outgoing_cltv_value, Some(phantom_shared_secret)) {
3149 Ok(info) => phantom_receives.push((prev_short_channel_id, prev_funding_outpoint, vec![(info, prev_htlc_id)])),
3150 Err(ReceiveError { err_code, err_data, msg }) => fail_forward!(msg, err_code, err_data, Some(phantom_shared_secret))
3156 fail_forward!(format!("Unknown short channel id {} for forward HTLC", short_chan_id), 0x4000 | 10, Vec::new(), None);
3159 fail_forward!(format!("Unknown short channel id {} for forward HTLC", short_chan_id), 0x4000 | 10, Vec::new(), None);
3162 HTLCForwardInfo::FailHTLC { .. } => {
3163 // Channel went away before we could fail it. This implies
3164 // the channel is now on chain and our counterparty is
3165 // trying to broadcast the HTLC-Timeout, but that's their
3166 // problem, not ours.
3173 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(forward_chan_id) {
3174 let mut add_htlc_msgs = Vec::new();
3175 let mut fail_htlc_msgs = Vec::new();
3176 for forward_info in pending_forwards.drain(..) {
3177 match forward_info {
3178 HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info: PendingHTLCInfo {
3179 routing: PendingHTLCRouting::Forward {
3181 }, incoming_shared_secret, payment_hash, amt_to_forward, outgoing_cltv_value },
3182 prev_funding_outpoint } => {
3183 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);
3184 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
3185 short_channel_id: prev_short_channel_id,
3186 outpoint: prev_funding_outpoint,
3187 htlc_id: prev_htlc_id,
3188 incoming_packet_shared_secret: incoming_shared_secret,
3189 // Phantom payments are only PendingHTLCRouting::Receive.
3190 phantom_shared_secret: None,
3192 match chan.get_mut().send_htlc(amt_to_forward, payment_hash, outgoing_cltv_value, htlc_source.clone(), onion_packet, &self.logger) {
3194 if let ChannelError::Ignore(msg) = e {
3195 log_trace!(self.logger, "Failed to forward HTLC with payment_hash {}: {}", log_bytes!(payment_hash.0), msg);
3197 panic!("Stated return value requirements in send_htlc() were not met");
3199 let (failure_code, data) = self.get_htlc_temp_fail_err_and_data(0x1000|7, short_chan_id, chan.get());
3200 failed_forwards.push((htlc_source, payment_hash,
3201 HTLCFailReason::Reason { failure_code, data }
3207 Some(msg) => { add_htlc_msgs.push(msg); },
3209 // Nothing to do here...we're waiting on a remote
3210 // revoke_and_ack before we can add anymore HTLCs. The Channel
3211 // will automatically handle building the update_add_htlc and
3212 // commitment_signed messages when we can.
3213 // TODO: Do some kind of timer to set the channel as !is_live()
3214 // as we don't really want others relying on us relaying through
3215 // this channel currently :/.
3221 HTLCForwardInfo::AddHTLC { .. } => {
3222 panic!("short_channel_id != 0 should imply any pending_forward entries are of type Forward");
3224 HTLCForwardInfo::FailHTLC { htlc_id, err_packet } => {
3225 log_trace!(self.logger, "Failing HTLC back to channel with short id {} (backward HTLC ID {}) after delay", short_chan_id, htlc_id);
3226 match chan.get_mut().get_update_fail_htlc(htlc_id, err_packet, &self.logger) {
3228 if let ChannelError::Ignore(msg) = e {
3229 log_trace!(self.logger, "Failed to fail HTLC with ID {} backwards to short_id {}: {}", htlc_id, short_chan_id, msg);
3231 panic!("Stated return value requirements in get_update_fail_htlc() were not met");
3233 // fail-backs are best-effort, we probably already have one
3234 // pending, and if not that's OK, if not, the channel is on
3235 // the chain and sending the HTLC-Timeout is their problem.
3238 Ok(Some(msg)) => { fail_htlc_msgs.push(msg); },
3240 // Nothing to do here...we're waiting on a remote
3241 // revoke_and_ack before we can update the commitment
3242 // transaction. The Channel will automatically handle
3243 // building the update_fail_htlc and commitment_signed
3244 // messages when we can.
3245 // We don't need any kind of timer here as they should fail
3246 // the channel onto the chain if they can't get our
3247 // update_fail_htlc in time, it's not our problem.
3254 if !add_htlc_msgs.is_empty() || !fail_htlc_msgs.is_empty() {
3255 let (commitment_msg, monitor_update) = match chan.get_mut().send_commitment(&self.logger) {
3258 // We surely failed send_commitment due to bad keys, in that case
3259 // close channel and then send error message to peer.
3260 let counterparty_node_id = chan.get().get_counterparty_node_id();
3261 let err: Result<(), _> = match e {
3262 ChannelError::Ignore(_) | ChannelError::Warn(_) => {
3263 panic!("Stated return value requirements in send_commitment() were not met");
3265 ChannelError::Close(msg) => {
3266 log_trace!(self.logger, "Closing channel {} due to Close-required error: {}", log_bytes!(chan.key()[..]), msg);
3267 let mut channel = remove_channel!(self, channel_state, chan);
3268 // ChannelClosed event is generated by handle_error for us.
3269 Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel.channel_id(), channel.get_user_id(), channel.force_shutdown(true), self.get_channel_update_for_broadcast(&channel).ok()))
3272 handle_errors.push((counterparty_node_id, err));
3276 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
3277 handle_errors.push((chan.get().get_counterparty_node_id(), handle_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, true)));
3280 log_debug!(self.logger, "Forwarding HTLCs resulted in a commitment update with {} HTLCs added and {} HTLCs failed for channel {}",
3281 add_htlc_msgs.len(), fail_htlc_msgs.len(), log_bytes!(chan.get().channel_id()));
3282 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
3283 node_id: chan.get().get_counterparty_node_id(),
3284 updates: msgs::CommitmentUpdate {
3285 update_add_htlcs: add_htlc_msgs,
3286 update_fulfill_htlcs: Vec::new(),
3287 update_fail_htlcs: fail_htlc_msgs,
3288 update_fail_malformed_htlcs: Vec::new(),
3290 commitment_signed: commitment_msg,
3298 for forward_info in pending_forwards.drain(..) {
3299 match forward_info {
3300 HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info: PendingHTLCInfo {
3301 routing, incoming_shared_secret, payment_hash, amt_to_forward, .. },
3302 prev_funding_outpoint } => {
3303 let (cltv_expiry, onion_payload, payment_data, phantom_shared_secret) = match routing {
3304 PendingHTLCRouting::Receive { payment_data, incoming_cltv_expiry, phantom_shared_secret } => {
3305 let _legacy_hop_data = Some(payment_data.clone());
3306 (incoming_cltv_expiry, OnionPayload::Invoice { _legacy_hop_data }, Some(payment_data), phantom_shared_secret)
3308 PendingHTLCRouting::ReceiveKeysend { payment_preimage, incoming_cltv_expiry } =>
3309 (incoming_cltv_expiry, OnionPayload::Spontaneous(payment_preimage), None, None),
3311 panic!("short_channel_id == 0 should imply any pending_forward entries are of type Receive");
3314 let claimable_htlc = ClaimableHTLC {
3315 prev_hop: HTLCPreviousHopData {
3316 short_channel_id: prev_short_channel_id,
3317 outpoint: prev_funding_outpoint,
3318 htlc_id: prev_htlc_id,
3319 incoming_packet_shared_secret: incoming_shared_secret,
3320 phantom_shared_secret,
3322 value: amt_to_forward,
3324 total_msat: if let Some(data) = &payment_data { data.total_msat } else { amt_to_forward },
3329 macro_rules! fail_htlc {
3331 let mut htlc_msat_height_data = byte_utils::be64_to_array($htlc.value).to_vec();
3332 htlc_msat_height_data.extend_from_slice(
3333 &byte_utils::be32_to_array(self.best_block.read().unwrap().height()),
3335 failed_forwards.push((HTLCSource::PreviousHopData(HTLCPreviousHopData {
3336 short_channel_id: $htlc.prev_hop.short_channel_id,
3337 outpoint: prev_funding_outpoint,
3338 htlc_id: $htlc.prev_hop.htlc_id,
3339 incoming_packet_shared_secret: $htlc.prev_hop.incoming_packet_shared_secret,
3340 phantom_shared_secret,
3342 HTLCFailReason::Reason { failure_code: 0x4000 | 15, data: htlc_msat_height_data }
3347 macro_rules! check_total_value {
3348 ($payment_data: expr, $payment_preimage: expr) => {{
3349 let mut payment_received_generated = false;
3351 events::PaymentPurpose::InvoicePayment {
3352 payment_preimage: $payment_preimage,
3353 payment_secret: $payment_data.payment_secret,
3356 let (_, htlcs) = channel_state.claimable_htlcs.entry(payment_hash)
3357 .or_insert_with(|| (purpose(), Vec::new()));
3358 if htlcs.len() == 1 {
3359 if let OnionPayload::Spontaneous(_) = htlcs[0].onion_payload {
3360 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));
3361 fail_htlc!(claimable_htlc);
3365 let mut total_value = claimable_htlc.value;
3366 for htlc in htlcs.iter() {
3367 total_value += htlc.value;
3368 match &htlc.onion_payload {
3369 OnionPayload::Invoice { .. } => {
3370 if htlc.total_msat != $payment_data.total_msat {
3371 log_trace!(self.logger, "Failing HTLCs with payment_hash {} as the HTLCs had inconsistent total values (eg {} and {})",
3372 log_bytes!(payment_hash.0), $payment_data.total_msat, htlc.total_msat);
3373 total_value = msgs::MAX_VALUE_MSAT;
3375 if total_value >= msgs::MAX_VALUE_MSAT { break; }
3377 _ => unreachable!(),
3380 if total_value >= msgs::MAX_VALUE_MSAT || total_value > $payment_data.total_msat {
3381 log_trace!(self.logger, "Failing HTLCs with payment_hash {} as the total value {} ran over expected value {} (or HTLCs were inconsistent)",
3382 log_bytes!(payment_hash.0), total_value, $payment_data.total_msat);
3383 fail_htlc!(claimable_htlc);
3384 } else if total_value == $payment_data.total_msat {
3385 htlcs.push(claimable_htlc);
3386 new_events.push(events::Event::PaymentReceived {
3389 amount_msat: total_value,
3391 payment_received_generated = true;
3393 // Nothing to do - we haven't reached the total
3394 // payment value yet, wait until we receive more
3396 htlcs.push(claimable_htlc);
3398 payment_received_generated
3402 // Check that the payment hash and secret are known. Note that we
3403 // MUST take care to handle the "unknown payment hash" and
3404 // "incorrect payment secret" cases here identically or we'd expose
3405 // that we are the ultimate recipient of the given payment hash.
3406 // Further, we must not expose whether we have any other HTLCs
3407 // associated with the same payment_hash pending or not.
3408 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
3409 match payment_secrets.entry(payment_hash) {
3410 hash_map::Entry::Vacant(_) => {
3411 match claimable_htlc.onion_payload {
3412 OnionPayload::Invoice { .. } => {
3413 let payment_data = payment_data.unwrap();
3414 let payment_preimage = match inbound_payment::verify(payment_hash, &payment_data, self.highest_seen_timestamp.load(Ordering::Acquire) as u64, &self.inbound_payment_key, &self.logger) {
3415 Ok(payment_preimage) => payment_preimage,
3417 fail_htlc!(claimable_htlc);
3421 check_total_value!(payment_data, payment_preimage);
3423 OnionPayload::Spontaneous(preimage) => {
3424 match channel_state.claimable_htlcs.entry(payment_hash) {
3425 hash_map::Entry::Vacant(e) => {
3426 let purpose = events::PaymentPurpose::SpontaneousPayment(preimage);
3427 e.insert((purpose.clone(), vec![claimable_htlc]));
3428 new_events.push(events::Event::PaymentReceived {
3430 amount_msat: amt_to_forward,
3434 hash_map::Entry::Occupied(_) => {
3435 log_trace!(self.logger, "Failing new keysend HTLC with payment_hash {} for a duplicative payment hash", log_bytes!(payment_hash.0));
3436 fail_htlc!(claimable_htlc);
3442 hash_map::Entry::Occupied(inbound_payment) => {
3443 if payment_data.is_none() {
3444 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));
3445 fail_htlc!(claimable_htlc);
3448 let payment_data = payment_data.unwrap();
3449 if inbound_payment.get().payment_secret != payment_data.payment_secret {
3450 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our expected payment secret.", log_bytes!(payment_hash.0));
3451 fail_htlc!(claimable_htlc);
3452 } else if inbound_payment.get().min_value_msat.is_some() && payment_data.total_msat < inbound_payment.get().min_value_msat.unwrap() {
3453 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our minimum value (had {}, needed {}).",
3454 log_bytes!(payment_hash.0), payment_data.total_msat, inbound_payment.get().min_value_msat.unwrap());
3455 fail_htlc!(claimable_htlc);
3457 let payment_received_generated = check_total_value!(payment_data, inbound_payment.get().payment_preimage);
3458 if payment_received_generated {
3459 inbound_payment.remove_entry();
3465 HTLCForwardInfo::FailHTLC { .. } => {
3466 panic!("Got pending fail of our own HTLC");
3474 for (htlc_source, payment_hash, failure_reason) in failed_forwards.drain(..) {
3475 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source, &payment_hash, failure_reason);
3477 self.forward_htlcs(&mut phantom_receives);
3479 for (counterparty_node_id, err) in handle_errors.drain(..) {
3480 let _ = handle_error!(self, err, counterparty_node_id);
3483 if new_events.is_empty() { return }
3484 let mut events = self.pending_events.lock().unwrap();
3485 events.append(&mut new_events);
3488 /// Free the background events, generally called from timer_tick_occurred.
3490 /// Exposed for testing to allow us to process events quickly without generating accidental
3491 /// BroadcastChannelUpdate events in timer_tick_occurred.
3493 /// Expects the caller to have a total_consistency_lock read lock.
3494 fn process_background_events(&self) -> bool {
3495 let mut background_events = Vec::new();
3496 mem::swap(&mut *self.pending_background_events.lock().unwrap(), &mut background_events);
3497 if background_events.is_empty() {
3501 for event in background_events.drain(..) {
3503 BackgroundEvent::ClosingMonitorUpdate((funding_txo, update)) => {
3504 // The channel has already been closed, so no use bothering to care about the
3505 // monitor updating completing.
3506 let _ = self.chain_monitor.update_channel(funding_txo, update);
3513 #[cfg(any(test, feature = "_test_utils"))]
3514 /// Process background events, for functional testing
3515 pub fn test_process_background_events(&self) {
3516 self.process_background_events();
3519 fn update_channel_fee(&self, short_to_chan_info: &mut HashMap<u64, (PublicKey, [u8; 32])>, pending_msg_events: &mut Vec<events::MessageSendEvent>, chan_id: &[u8; 32], chan: &mut Channel<Signer>, new_feerate: u32) -> (bool, NotifyOption, Result<(), MsgHandleErrInternal>) {
3520 if !chan.is_outbound() { return (true, NotifyOption::SkipPersist, Ok(())); }
3521 // If the feerate has decreased by less than half, don't bother
3522 if new_feerate <= chan.get_feerate() && new_feerate * 2 > chan.get_feerate() {
3523 log_trace!(self.logger, "Channel {} does not qualify for a feerate change from {} to {}.",
3524 log_bytes!(chan_id[..]), chan.get_feerate(), new_feerate);
3525 return (true, NotifyOption::SkipPersist, Ok(()));
3527 if !chan.is_live() {
3528 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).",
3529 log_bytes!(chan_id[..]), chan.get_feerate(), new_feerate);
3530 return (true, NotifyOption::SkipPersist, Ok(()));
3532 log_trace!(self.logger, "Channel {} qualifies for a feerate change from {} to {}.",
3533 log_bytes!(chan_id[..]), chan.get_feerate(), new_feerate);
3535 let mut retain_channel = true;
3536 let res = match chan.send_update_fee_and_commit(new_feerate, &self.logger) {
3539 let (drop, res) = convert_chan_err!(self, e, short_to_chan_info, chan, chan_id);
3540 if drop { retain_channel = false; }
3544 let ret_err = match res {
3545 Ok(Some((update_fee, commitment_signed, monitor_update))) => {
3546 if let Err(e) = self.chain_monitor.update_channel(chan.get_funding_txo().unwrap(), monitor_update) {
3547 let (res, drop) = handle_monitor_err!(self, e, short_to_chan_info, chan, RAACommitmentOrder::CommitmentFirst, chan_id, COMMITMENT_UPDATE_ONLY);
3548 if drop { retain_channel = false; }
3551 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
3552 node_id: chan.get_counterparty_node_id(),
3553 updates: msgs::CommitmentUpdate {
3554 update_add_htlcs: Vec::new(),
3555 update_fulfill_htlcs: Vec::new(),
3556 update_fail_htlcs: Vec::new(),
3557 update_fail_malformed_htlcs: Vec::new(),
3558 update_fee: Some(update_fee),
3568 (retain_channel, NotifyOption::DoPersist, ret_err)
3572 /// In chanmon_consistency we want to sometimes do the channel fee updates done in
3573 /// timer_tick_occurred, but we can't generate the disabled channel updates as it considers
3574 /// these a fuzz failure (as they usually indicate a channel force-close, which is exactly what
3575 /// it wants to detect). Thus, we have a variant exposed here for its benefit.
3576 pub fn maybe_update_chan_fees(&self) {
3577 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
3578 let mut should_persist = NotifyOption::SkipPersist;
3580 let new_feerate = self.fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
3582 let mut handle_errors = Vec::new();
3584 let mut channel_state_lock = self.channel_state.lock().unwrap();
3585 let channel_state = &mut *channel_state_lock;
3586 let pending_msg_events = &mut channel_state.pending_msg_events;
3587 let short_to_chan_info = &mut channel_state.short_to_chan_info;
3588 channel_state.by_id.retain(|chan_id, chan| {
3589 let (retain_channel, chan_needs_persist, err) = self.update_channel_fee(short_to_chan_info, pending_msg_events, chan_id, chan, new_feerate);
3590 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
3592 handle_errors.push(err);
3602 /// Performs actions which should happen on startup and roughly once per minute thereafter.
3604 /// This currently includes:
3605 /// * Increasing or decreasing the on-chain feerate estimates for our outbound channels,
3606 /// * Broadcasting `ChannelUpdate` messages if we've been disconnected from our peer for more
3607 /// than a minute, informing the network that they should no longer attempt to route over
3609 /// * Expiring a channel's previous `ChannelConfig` if necessary to only allow forwarding HTLCs
3610 /// with the current `ChannelConfig`.
3612 /// Note that this may cause reentrancy through `chain::Watch::update_channel` calls or feerate
3613 /// estimate fetches.
3614 pub fn timer_tick_occurred(&self) {
3615 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
3616 let mut should_persist = NotifyOption::SkipPersist;
3617 if self.process_background_events() { should_persist = NotifyOption::DoPersist; }
3619 let new_feerate = self.fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
3621 let mut handle_errors = Vec::new();
3622 let mut timed_out_mpp_htlcs = Vec::new();
3624 let mut channel_state_lock = self.channel_state.lock().unwrap();
3625 let channel_state = &mut *channel_state_lock;
3626 let pending_msg_events = &mut channel_state.pending_msg_events;
3627 let short_to_chan_info = &mut channel_state.short_to_chan_info;
3628 channel_state.by_id.retain(|chan_id, chan| {
3629 let counterparty_node_id = chan.get_counterparty_node_id();
3630 let (retain_channel, chan_needs_persist, err) = self.update_channel_fee(short_to_chan_info, pending_msg_events, chan_id, chan, new_feerate);
3631 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
3633 handle_errors.push((err, counterparty_node_id));
3635 if !retain_channel { return false; }
3637 if let Err(e) = chan.timer_check_closing_negotiation_progress() {
3638 let (needs_close, err) = convert_chan_err!(self, e, short_to_chan_info, chan, chan_id);
3639 handle_errors.push((Err(err), chan.get_counterparty_node_id()));
3640 if needs_close { return false; }
3643 match chan.channel_update_status() {
3644 ChannelUpdateStatus::Enabled if !chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::DisabledStaged),
3645 ChannelUpdateStatus::Disabled if chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::EnabledStaged),
3646 ChannelUpdateStatus::DisabledStaged if chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::Enabled),
3647 ChannelUpdateStatus::EnabledStaged if !chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::Disabled),
3648 ChannelUpdateStatus::DisabledStaged if !chan.is_live() => {
3649 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
3650 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
3654 should_persist = NotifyOption::DoPersist;
3655 chan.set_channel_update_status(ChannelUpdateStatus::Disabled);
3657 ChannelUpdateStatus::EnabledStaged if chan.is_live() => {
3658 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
3659 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
3663 should_persist = NotifyOption::DoPersist;
3664 chan.set_channel_update_status(ChannelUpdateStatus::Enabled);
3669 chan.maybe_expire_prev_config();
3674 channel_state.claimable_htlcs.retain(|payment_hash, (_, htlcs)| {
3675 if htlcs.is_empty() {
3676 // This should be unreachable
3677 debug_assert!(false);
3680 if let OnionPayload::Invoice { .. } = htlcs[0].onion_payload {
3681 // Check if we've received all the parts we need for an MPP (the value of the parts adds to total_msat).
3682 // In this case we're not going to handle any timeouts of the parts here.
3683 if htlcs[0].total_msat == htlcs.iter().fold(0, |total, htlc| total + htlc.value) {
3685 } else if htlcs.into_iter().any(|htlc| {
3686 htlc.timer_ticks += 1;
3687 return htlc.timer_ticks >= MPP_TIMEOUT_TICKS
3689 timed_out_mpp_htlcs.extend(htlcs.into_iter().map(|htlc| (htlc.prev_hop.clone(), payment_hash.clone())));
3697 for htlc_source in timed_out_mpp_htlcs.drain(..) {
3698 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), HTLCSource::PreviousHopData(htlc_source.0), &htlc_source.1, HTLCFailReason::Reason { failure_code: 23, data: Vec::new() });
3701 for (err, counterparty_node_id) in handle_errors.drain(..) {
3702 let _ = handle_error!(self, err, counterparty_node_id);
3708 /// Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
3709 /// after a PaymentReceived event, failing the HTLC back to its origin and freeing resources
3710 /// along the path (including in our own channel on which we received it).
3712 /// Note that in some cases around unclean shutdown, it is possible the payment may have
3713 /// already been claimed by you via [`ChannelManager::claim_funds`] prior to you seeing (a
3714 /// second copy of) the [`events::Event::PaymentReceived`] event. Alternatively, the payment
3715 /// may have already been failed automatically by LDK if it was nearing its expiration time.
3717 /// While LDK will never claim a payment automatically on your behalf (i.e. without you calling
3718 /// [`ChannelManager::claim_funds`]), you should still monitor for
3719 /// [`events::Event::PaymentClaimed`] events even for payments you intend to fail, especially on
3720 /// startup during which time claims that were in-progress at shutdown may be replayed.
3721 pub fn fail_htlc_backwards(&self, payment_hash: &PaymentHash) {
3722 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
3724 let mut channel_state = Some(self.channel_state.lock().unwrap());
3725 let removed_source = channel_state.as_mut().unwrap().claimable_htlcs.remove(payment_hash);
3726 if let Some((_, mut sources)) = removed_source {
3727 for htlc in sources.drain(..) {
3728 if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
3729 let mut htlc_msat_height_data = byte_utils::be64_to_array(htlc.value).to_vec();
3730 htlc_msat_height_data.extend_from_slice(&byte_utils::be32_to_array(
3731 self.best_block.read().unwrap().height()));
3732 self.fail_htlc_backwards_internal(channel_state.take().unwrap(),
3733 HTLCSource::PreviousHopData(htlc.prev_hop), payment_hash,
3734 HTLCFailReason::Reason { failure_code: 0x4000 | 15, data: htlc_msat_height_data });
3739 /// Gets an HTLC onion failure code and error data for an `UPDATE` error, given the error code
3740 /// that we want to return and a channel.
3742 /// This is for failures on the channel on which the HTLC was *received*, not failures
3744 fn get_htlc_inbound_temp_fail_err_and_data(&self, desired_err_code: u16, chan: &Channel<Signer>) -> (u16, Vec<u8>) {
3745 // We can't be sure what SCID was used when relaying inbound towards us, so we have to
3746 // guess somewhat. If its a public channel, we figure best to just use the real SCID (as
3747 // we're not leaking that we have a channel with the counterparty), otherwise we try to use
3748 // an inbound SCID alias before the real SCID.
3749 let scid_pref = if chan.should_announce() {
3750 chan.get_short_channel_id().or(chan.latest_inbound_scid_alias())
3752 chan.latest_inbound_scid_alias().or(chan.get_short_channel_id())
3754 if let Some(scid) = scid_pref {
3755 self.get_htlc_temp_fail_err_and_data(desired_err_code, scid, chan)
3757 (0x4000|10, Vec::new())
3762 /// Gets an HTLC onion failure code and error data for an `UPDATE` error, given the error code
3763 /// that we want to return and a channel.
3764 fn get_htlc_temp_fail_err_and_data(&self, desired_err_code: u16, scid: u64, chan: &Channel<Signer>) -> (u16, Vec<u8>) {
3765 debug_assert_eq!(desired_err_code & 0x1000, 0x1000);
3766 if let Ok(upd) = self.get_channel_update_for_onion(scid, chan) {
3767 let mut enc = VecWriter(Vec::with_capacity(upd.serialized_length() + 6));
3768 if desired_err_code == 0x1000 | 20 {
3769 // TODO: underspecified, follow https://github.com/lightning/bolts/issues/791
3770 0u16.write(&mut enc).expect("Writes cannot fail");
3772 (upd.serialized_length() as u16 + 2).write(&mut enc).expect("Writes cannot fail");
3773 msgs::ChannelUpdate::TYPE.write(&mut enc).expect("Writes cannot fail");
3774 upd.write(&mut enc).expect("Writes cannot fail");
3775 (desired_err_code, enc.0)
3777 // If we fail to get a unicast channel_update, it implies we don't yet have an SCID,
3778 // which means we really shouldn't have gotten a payment to be forwarded over this
3779 // channel yet, or if we did it's from a route hint. Either way, returning an error of
3780 // PERM|no_such_channel should be fine.
3781 (0x4000|10, Vec::new())
3785 // Fail a list of HTLCs that were just freed from the holding cell. The HTLCs need to be
3786 // failed backwards or, if they were one of our outgoing HTLCs, then their failure needs to
3787 // be surfaced to the user.
3788 fn fail_holding_cell_htlcs(
3789 &self, mut htlcs_to_fail: Vec<(HTLCSource, PaymentHash)>, channel_id: [u8; 32],
3790 _counterparty_node_id: &PublicKey
3792 for (htlc_src, payment_hash) in htlcs_to_fail.drain(..) {
3794 HTLCSource::PreviousHopData(HTLCPreviousHopData { .. }) => {
3795 let (failure_code, onion_failure_data) =
3796 match self.channel_state.lock().unwrap().by_id.entry(channel_id) {
3797 hash_map::Entry::Occupied(chan_entry) => {
3798 self.get_htlc_inbound_temp_fail_err_and_data(0x1000|7, &chan_entry.get())
3800 hash_map::Entry::Vacant(_) => (0x4000|10, Vec::new())
3802 let channel_state = self.channel_state.lock().unwrap();
3803 self.fail_htlc_backwards_internal(channel_state,
3804 htlc_src, &payment_hash, HTLCFailReason::Reason { failure_code, data: onion_failure_data});
3806 HTLCSource::OutboundRoute { session_priv, payment_id, path, payment_params, .. } => {
3807 let mut session_priv_bytes = [0; 32];
3808 session_priv_bytes.copy_from_slice(&session_priv[..]);
3809 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
3810 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
3811 if payment.get_mut().remove(&session_priv_bytes, Some(&path)) && !payment.get().is_fulfilled() {
3812 let retry = if let Some(payment_params_data) = payment_params {
3813 let path_last_hop = path.last().expect("Outbound payments must have had a valid path");
3814 Some(RouteParameters {
3815 payment_params: payment_params_data,
3816 final_value_msat: path_last_hop.fee_msat,
3817 final_cltv_expiry_delta: path_last_hop.cltv_expiry_delta,
3820 let mut pending_events = self.pending_events.lock().unwrap();
3821 pending_events.push(events::Event::PaymentPathFailed {
3822 payment_id: Some(payment_id),
3824 rejected_by_dest: false,
3825 network_update: None,
3826 all_paths_failed: payment.get().remaining_parts() == 0,
3828 short_channel_id: None,
3835 if payment.get().abandoned() && payment.get().remaining_parts() == 0 {
3836 pending_events.push(events::Event::PaymentFailed {
3838 payment_hash: payment.get().payment_hash().expect("PendingOutboundPayments::RetriesExceeded always has a payment hash set"),
3844 log_trace!(self.logger, "Received duplicative fail for HTLC with payment_hash {}", log_bytes!(payment_hash.0));
3851 /// Fails an HTLC backwards to the sender of it to us.
3852 /// Note that while we take a channel_state lock as input, we do *not* assume consistency here.
3853 /// There are several callsites that do stupid things like loop over a list of payment_hashes
3854 /// to fail and take the channel_state lock for each iteration (as we take ownership and may
3855 /// drop it). In other words, no assumptions are made that entries in claimable_htlcs point to
3856 /// still-available channels.
3857 fn fail_htlc_backwards_internal(&self, mut channel_state_lock: MutexGuard<ChannelHolder<Signer>>, source: HTLCSource, payment_hash: &PaymentHash, onion_error: HTLCFailReason) {
3858 //TODO: There is a timing attack here where if a node fails an HTLC back to us they can
3859 //identify whether we sent it or not based on the (I presume) very different runtime
3860 //between the branches here. We should make this async and move it into the forward HTLCs
3863 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
3864 // from block_connected which may run during initialization prior to the chain_monitor
3865 // being fully configured. See the docs for `ChannelManagerReadArgs` for more.
3867 HTLCSource::OutboundRoute { ref path, session_priv, payment_id, ref payment_params, .. } => {
3868 let mut session_priv_bytes = [0; 32];
3869 session_priv_bytes.copy_from_slice(&session_priv[..]);
3870 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
3871 let mut all_paths_failed = false;
3872 let mut full_failure_ev = None;
3873 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
3874 if !payment.get_mut().remove(&session_priv_bytes, Some(&path)) {
3875 log_trace!(self.logger, "Received duplicative fail for HTLC with payment_hash {}", log_bytes!(payment_hash.0));
3878 if payment.get().is_fulfilled() {
3879 log_trace!(self.logger, "Received failure of HTLC with payment_hash {} after payment completion", log_bytes!(payment_hash.0));
3882 if payment.get().remaining_parts() == 0 {
3883 all_paths_failed = true;
3884 if payment.get().abandoned() {
3885 full_failure_ev = Some(events::Event::PaymentFailed {
3887 payment_hash: payment.get().payment_hash().expect("PendingOutboundPayments::RetriesExceeded always has a payment hash set"),
3893 log_trace!(self.logger, "Received duplicative fail for HTLC with payment_hash {}", log_bytes!(payment_hash.0));
3896 mem::drop(channel_state_lock);
3897 let retry = if let Some(payment_params_data) = payment_params {
3898 let path_last_hop = path.last().expect("Outbound payments must have had a valid path");
3899 Some(RouteParameters {
3900 payment_params: payment_params_data.clone(),
3901 final_value_msat: path_last_hop.fee_msat,
3902 final_cltv_expiry_delta: path_last_hop.cltv_expiry_delta,
3905 log_trace!(self.logger, "Failing outbound payment HTLC with payment_hash {}", log_bytes!(payment_hash.0));
3907 let path_failure = match &onion_error {
3908 &HTLCFailReason::LightningError { ref err } => {
3910 let (network_update, short_channel_id, payment_retryable, onion_error_code, onion_error_data) = onion_utils::process_onion_failure(&self.secp_ctx, &self.logger, &source, err.data.clone());
3912 let (network_update, short_channel_id, payment_retryable, _, _) = onion_utils::process_onion_failure(&self.secp_ctx, &self.logger, &source, err.data.clone());
3914 if self.payment_is_probe(payment_hash, &payment_id) {
3915 if !payment_retryable {
3916 events::Event::ProbeSuccessful {
3918 payment_hash: payment_hash.clone(),
3922 events::Event::ProbeFailed {
3923 payment_id: payment_id,
3924 payment_hash: payment_hash.clone(),
3930 // TODO: If we decided to blame ourselves (or one of our channels) in
3931 // process_onion_failure we should close that channel as it implies our
3932 // next-hop is needlessly blaming us!
3933 events::Event::PaymentPathFailed {
3934 payment_id: Some(payment_id),
3935 payment_hash: payment_hash.clone(),
3936 rejected_by_dest: !payment_retryable,
3943 error_code: onion_error_code,
3945 error_data: onion_error_data
3949 &HTLCFailReason::Reason {
3955 // we get a fail_malformed_htlc from the first hop
3956 // TODO: We'd like to generate a NetworkUpdate for temporary
3957 // failures here, but that would be insufficient as find_route
3958 // generally ignores its view of our own channels as we provide them via
3960 // TODO: For non-temporary failures, we really should be closing the
3961 // channel here as we apparently can't relay through them anyway.
3962 events::Event::PaymentPathFailed {
3963 payment_id: Some(payment_id),
3964 payment_hash: payment_hash.clone(),
3965 rejected_by_dest: path.len() == 1,
3966 network_update: None,
3969 short_channel_id: Some(path.first().unwrap().short_channel_id),
3972 error_code: Some(*failure_code),
3974 error_data: Some(data.clone()),
3978 let mut pending_events = self.pending_events.lock().unwrap();
3979 pending_events.push(path_failure);
3980 if let Some(ev) = full_failure_ev { pending_events.push(ev); }
3982 HTLCSource::PreviousHopData(HTLCPreviousHopData { short_channel_id, htlc_id, incoming_packet_shared_secret, phantom_shared_secret, .. }) => {
3983 let err_packet = match onion_error {
3984 HTLCFailReason::Reason { failure_code, data } => {
3985 log_trace!(self.logger, "Failing HTLC with payment_hash {} backwards from us with code {}", log_bytes!(payment_hash.0), failure_code);
3986 if let Some(phantom_ss) = phantom_shared_secret {
3987 let phantom_packet = onion_utils::build_failure_packet(&phantom_ss, failure_code, &data[..]).encode();
3988 let encrypted_phantom_packet = onion_utils::encrypt_failure_packet(&phantom_ss, &phantom_packet);
3989 onion_utils::encrypt_failure_packet(&incoming_packet_shared_secret, &encrypted_phantom_packet.data[..])
3991 let packet = onion_utils::build_failure_packet(&incoming_packet_shared_secret, failure_code, &data[..]).encode();
3992 onion_utils::encrypt_failure_packet(&incoming_packet_shared_secret, &packet)
3995 HTLCFailReason::LightningError { err } => {
3996 log_trace!(self.logger, "Failing HTLC with payment_hash {} backwards with pre-built LightningError", log_bytes!(payment_hash.0));
3997 onion_utils::encrypt_failure_packet(&incoming_packet_shared_secret, &err.data)
4001 let mut forward_event = None;
4002 if channel_state_lock.forward_htlcs.is_empty() {
4003 forward_event = Some(Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS));
4005 match channel_state_lock.forward_htlcs.entry(short_channel_id) {
4006 hash_map::Entry::Occupied(mut entry) => {
4007 entry.get_mut().push(HTLCForwardInfo::FailHTLC { htlc_id, err_packet });
4009 hash_map::Entry::Vacant(entry) => {
4010 entry.insert(vec!(HTLCForwardInfo::FailHTLC { htlc_id, err_packet }));
4013 mem::drop(channel_state_lock);
4014 if let Some(time) = forward_event {
4015 let mut pending_events = self.pending_events.lock().unwrap();
4016 pending_events.push(events::Event::PendingHTLCsForwardable {
4017 time_forwardable: time
4024 /// Provides a payment preimage in response to [`Event::PaymentReceived`], generating any
4025 /// [`MessageSendEvent`]s needed to claim the payment.
4027 /// Note that calling this method does *not* guarantee that the payment has been claimed. You
4028 /// *must* wait for an [`Event::PaymentClaimed`] event which upon a successful claim will be
4029 /// provided to your [`EventHandler`] when [`process_pending_events`] is next called.
4031 /// Note that if you did not set an `amount_msat` when calling [`create_inbound_payment`] or
4032 /// [`create_inbound_payment_for_hash`] you must check that the amount in the `PaymentReceived`
4033 /// event matches your expectation. If you fail to do so and call this method, you may provide
4034 /// the sender "proof-of-payment" when they did not fulfill the full expected payment.
4036 /// [`Event::PaymentReceived`]: crate::util::events::Event::PaymentReceived
4037 /// [`Event::PaymentClaimed`]: crate::util::events::Event::PaymentClaimed
4038 /// [`process_pending_events`]: EventsProvider::process_pending_events
4039 /// [`create_inbound_payment`]: Self::create_inbound_payment
4040 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
4041 /// [`get_and_clear_pending_msg_events`]: MessageSendEventsProvider::get_and_clear_pending_msg_events
4042 pub fn claim_funds(&self, payment_preimage: PaymentPreimage) {
4043 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
4045 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4047 let mut channel_state = Some(self.channel_state.lock().unwrap());
4048 let removed_source = channel_state.as_mut().unwrap().claimable_htlcs.remove(&payment_hash);
4049 if let Some((payment_purpose, mut sources)) = removed_source {
4050 assert!(!sources.is_empty());
4052 // If we are claiming an MPP payment, we have to take special care to ensure that each
4053 // channel exists before claiming all of the payments (inside one lock).
4054 // Note that channel existance is sufficient as we should always get a monitor update
4055 // which will take care of the real HTLC claim enforcement.
4057 // If we find an HTLC which we would need to claim but for which we do not have a
4058 // channel, we will fail all parts of the MPP payment. While we could wait and see if
4059 // the sender retries the already-failed path(s), it should be a pretty rare case where
4060 // we got all the HTLCs and then a channel closed while we were waiting for the user to
4061 // provide the preimage, so worrying too much about the optimal handling isn't worth
4063 let mut claimable_amt_msat = 0;
4064 let mut expected_amt_msat = None;
4065 let mut valid_mpp = true;
4066 for htlc in sources.iter() {
4067 if let None = channel_state.as_ref().unwrap().short_to_chan_info.get(&htlc.prev_hop.short_channel_id) {
4071 if expected_amt_msat.is_some() && expected_amt_msat != Some(htlc.total_msat) {
4072 log_error!(self.logger, "Somehow ended up with an MPP payment with different total amounts - this should not be reachable!");
4073 debug_assert!(false);
4077 expected_amt_msat = Some(htlc.total_msat);
4078 if let OnionPayload::Spontaneous(_) = &htlc.onion_payload {
4079 // We don't currently support MPP for spontaneous payments, so just check
4080 // that there's one payment here and move on.
4081 if sources.len() != 1 {
4082 log_error!(self.logger, "Somehow ended up with an MPP spontaneous payment - this should not be reachable!");
4083 debug_assert!(false);
4089 claimable_amt_msat += htlc.value;
4091 if sources.is_empty() || expected_amt_msat.is_none() {
4092 log_info!(self.logger, "Attempted to claim an incomplete payment which no longer had any available HTLCs!");
4095 if claimable_amt_msat != expected_amt_msat.unwrap() {
4096 log_info!(self.logger, "Attempted to claim an incomplete payment, expected {} msat, had {} available to claim.",
4097 expected_amt_msat.unwrap(), claimable_amt_msat);
4101 let mut errs = Vec::new();
4102 let mut claimed_any_htlcs = false;
4103 for htlc in sources.drain(..) {
4105 if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
4106 let mut htlc_msat_height_data = byte_utils::be64_to_array(htlc.value).to_vec();
4107 htlc_msat_height_data.extend_from_slice(&byte_utils::be32_to_array(
4108 self.best_block.read().unwrap().height()));
4109 self.fail_htlc_backwards_internal(channel_state.take().unwrap(),
4110 HTLCSource::PreviousHopData(htlc.prev_hop), &payment_hash,
4111 HTLCFailReason::Reason { failure_code: 0x4000|15, data: htlc_msat_height_data });
4113 match self.claim_funds_from_hop(channel_state.as_mut().unwrap(), htlc.prev_hop, payment_preimage) {
4114 ClaimFundsFromHop::MonitorUpdateFail(pk, err, _) => {
4115 if let msgs::ErrorAction::IgnoreError = err.err.action {
4116 // We got a temporary failure updating monitor, but will claim the
4117 // HTLC when the monitor updating is restored (or on chain).
4118 log_error!(self.logger, "Temporary failure claiming HTLC, treating as success: {}", err.err.err);
4119 claimed_any_htlcs = true;
4120 } else { errs.push((pk, err)); }
4122 ClaimFundsFromHop::PrevHopForceClosed => unreachable!("We already checked for channel existence, we can't fail here!"),
4123 ClaimFundsFromHop::DuplicateClaim => {
4124 // While we should never get here in most cases, if we do, it likely
4125 // indicates that the HTLC was timed out some time ago and is no longer
4126 // available to be claimed. Thus, it does not make sense to set
4127 // `claimed_any_htlcs`.
4129 ClaimFundsFromHop::Success(_) => claimed_any_htlcs = true,
4134 if claimed_any_htlcs {
4135 self.pending_events.lock().unwrap().push(events::Event::PaymentClaimed {
4137 purpose: payment_purpose,
4138 amount_msat: claimable_amt_msat,
4142 // Now that we've done the entire above loop in one lock, we can handle any errors
4143 // which were generated.
4144 channel_state.take();
4146 for (counterparty_node_id, err) in errs.drain(..) {
4147 let res: Result<(), _> = Err(err);
4148 let _ = handle_error!(self, res, counterparty_node_id);
4153 fn claim_funds_from_hop(&self, channel_state_lock: &mut MutexGuard<ChannelHolder<Signer>>, prev_hop: HTLCPreviousHopData, payment_preimage: PaymentPreimage) -> ClaimFundsFromHop {
4154 //TODO: Delay the claimed_funds relaying just like we do outbound relay!
4155 let channel_state = &mut **channel_state_lock;
4156 let chan_id = match channel_state.short_to_chan_info.get(&prev_hop.short_channel_id) {
4157 Some((_cp_id, chan_id)) => chan_id.clone(),
4159 return ClaimFundsFromHop::PrevHopForceClosed
4163 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(chan_id) {
4164 match chan.get_mut().get_update_fulfill_htlc_and_commit(prev_hop.htlc_id, payment_preimage, &self.logger) {
4165 Ok(msgs_monitor_option) => {
4166 if let UpdateFulfillCommitFetch::NewClaim { msgs, htlc_value_msat, monitor_update } = msgs_monitor_option {
4167 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
4168 log_given_level!(self.logger, if e == ChannelMonitorUpdateErr::PermanentFailure { Level::Error } else { Level::Debug },
4169 "Failed to update channel monitor with preimage {:?}: {:?}",
4170 payment_preimage, e);
4171 return ClaimFundsFromHop::MonitorUpdateFail(
4172 chan.get().get_counterparty_node_id(),
4173 handle_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, msgs.is_some()).unwrap_err(),
4174 Some(htlc_value_msat)
4177 if let Some((msg, commitment_signed)) = msgs {
4178 log_debug!(self.logger, "Claiming funds for HTLC with preimage {} resulted in a commitment_signed for channel {}",
4179 log_bytes!(payment_preimage.0), log_bytes!(chan.get().channel_id()));
4180 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
4181 node_id: chan.get().get_counterparty_node_id(),
4182 updates: msgs::CommitmentUpdate {
4183 update_add_htlcs: Vec::new(),
4184 update_fulfill_htlcs: vec![msg],
4185 update_fail_htlcs: Vec::new(),
4186 update_fail_malformed_htlcs: Vec::new(),
4192 return ClaimFundsFromHop::Success(htlc_value_msat);
4194 return ClaimFundsFromHop::DuplicateClaim;
4197 Err((e, monitor_update)) => {
4198 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
4199 log_given_level!(self.logger, if e == ChannelMonitorUpdateErr::PermanentFailure { Level::Error } else { Level::Info },
4200 "Failed to update channel monitor with preimage {:?} immediately prior to force-close: {:?}",
4201 payment_preimage, e);
4203 let counterparty_node_id = chan.get().get_counterparty_node_id();
4204 let (drop, res) = convert_chan_err!(self, e, channel_state.short_to_chan_info, chan.get_mut(), &chan_id);
4206 chan.remove_entry();
4208 return ClaimFundsFromHop::MonitorUpdateFail(counterparty_node_id, res, None);
4211 } else { unreachable!(); }
4214 fn finalize_claims(&self, mut sources: Vec<HTLCSource>) {
4215 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
4216 let mut pending_events = self.pending_events.lock().unwrap();
4217 for source in sources.drain(..) {
4218 if let HTLCSource::OutboundRoute { session_priv, payment_id, path, .. } = source {
4219 let mut session_priv_bytes = [0; 32];
4220 session_priv_bytes.copy_from_slice(&session_priv[..]);
4221 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
4222 assert!(payment.get().is_fulfilled());
4223 if payment.get_mut().remove(&session_priv_bytes, None) {
4224 pending_events.push(
4225 events::Event::PaymentPathSuccessful {
4227 payment_hash: payment.get().payment_hash(),
4232 if payment.get().remaining_parts() == 0 {
4240 fn claim_funds_internal(&self, mut channel_state_lock: MutexGuard<ChannelHolder<Signer>>, source: HTLCSource, payment_preimage: PaymentPreimage, forwarded_htlc_value_msat: Option<u64>, from_onchain: bool, next_channel_id: [u8; 32]) {
4242 HTLCSource::OutboundRoute { session_priv, payment_id, path, .. } => {
4243 mem::drop(channel_state_lock);
4244 let mut session_priv_bytes = [0; 32];
4245 session_priv_bytes.copy_from_slice(&session_priv[..]);
4246 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
4247 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
4248 let mut pending_events = self.pending_events.lock().unwrap();
4249 if !payment.get().is_fulfilled() {
4250 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
4251 let fee_paid_msat = payment.get().get_pending_fee_msat();
4252 pending_events.push(
4253 events::Event::PaymentSent {
4254 payment_id: Some(payment_id),
4260 payment.get_mut().mark_fulfilled();
4264 // We currently immediately remove HTLCs which were fulfilled on-chain.
4265 // This could potentially lead to removing a pending payment too early,
4266 // with a reorg of one block causing us to re-add the fulfilled payment on
4268 // TODO: We should have a second monitor event that informs us of payments
4269 // irrevocably fulfilled.
4270 if payment.get_mut().remove(&session_priv_bytes, Some(&path)) {
4271 let payment_hash = Some(PaymentHash(Sha256::hash(&payment_preimage.0).into_inner()));
4272 pending_events.push(
4273 events::Event::PaymentPathSuccessful {
4281 if payment.get().remaining_parts() == 0 {
4286 log_trace!(self.logger, "Received duplicative fulfill for HTLC with payment_preimage {}", log_bytes!(payment_preimage.0));
4289 HTLCSource::PreviousHopData(hop_data) => {
4290 let prev_outpoint = hop_data.outpoint;
4291 let res = self.claim_funds_from_hop(&mut channel_state_lock, hop_data, payment_preimage);
4292 let claimed_htlc = if let ClaimFundsFromHop::DuplicateClaim = res { false } else { true };
4293 let htlc_claim_value_msat = match res {
4294 ClaimFundsFromHop::MonitorUpdateFail(_, _, amt_opt) => amt_opt,
4295 ClaimFundsFromHop::Success(amt) => Some(amt),
4298 if let ClaimFundsFromHop::PrevHopForceClosed = res {
4299 let preimage_update = ChannelMonitorUpdate {
4300 update_id: CLOSED_CHANNEL_UPDATE_ID,
4301 updates: vec![ChannelMonitorUpdateStep::PaymentPreimage {
4302 payment_preimage: payment_preimage.clone(),
4305 // We update the ChannelMonitor on the backward link, after
4306 // receiving an offchain preimage event from the forward link (the
4307 // event being update_fulfill_htlc).
4308 if let Err(e) = self.chain_monitor.update_channel(prev_outpoint, preimage_update) {
4309 log_error!(self.logger, "Critical error: failed to update channel monitor with preimage {:?}: {:?}",
4310 payment_preimage, e);
4312 // Note that we do *not* set `claimed_htlc` to false here. In fact, this
4313 // totally could be a duplicate claim, but we have no way of knowing
4314 // without interrogating the `ChannelMonitor` we've provided the above
4315 // update to. Instead, we simply document in `PaymentForwarded` that this
4318 mem::drop(channel_state_lock);
4319 if let ClaimFundsFromHop::MonitorUpdateFail(pk, err, _) = res {
4320 let result: Result<(), _> = Err(err);
4321 let _ = handle_error!(self, result, pk);
4325 if let Some(forwarded_htlc_value) = forwarded_htlc_value_msat {
4326 let fee_earned_msat = if let Some(claimed_htlc_value) = htlc_claim_value_msat {
4327 Some(claimed_htlc_value - forwarded_htlc_value)
4330 let mut pending_events = self.pending_events.lock().unwrap();
4331 let prev_channel_id = Some(prev_outpoint.to_channel_id());
4332 let next_channel_id = Some(next_channel_id);
4334 pending_events.push(events::Event::PaymentForwarded {
4336 claim_from_onchain_tx: from_onchain,
4346 /// Gets the node_id held by this ChannelManager
4347 pub fn get_our_node_id(&self) -> PublicKey {
4348 self.our_network_pubkey.clone()
4351 fn channel_monitor_updated(&self, funding_txo: &OutPoint, highest_applied_update_id: u64) {
4352 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4354 let chan_restoration_res;
4355 let (mut pending_failures, finalized_claims) = {
4356 let mut channel_lock = self.channel_state.lock().unwrap();
4357 let channel_state = &mut *channel_lock;
4358 let mut channel = match channel_state.by_id.entry(funding_txo.to_channel_id()) {
4359 hash_map::Entry::Occupied(chan) => chan,
4360 hash_map::Entry::Vacant(_) => return,
4362 if !channel.get().is_awaiting_monitor_update() || channel.get().get_latest_monitor_update_id() != highest_applied_update_id {
4366 let updates = channel.get_mut().monitor_updating_restored(&self.logger, self.get_our_node_id(), self.genesis_hash, self.best_block.read().unwrap().height());
4367 let channel_update = if updates.channel_ready.is_some() && channel.get().is_usable() {
4368 // We only send a channel_update in the case where we are just now sending a
4369 // channel_ready and the channel is in a usable state. We may re-send a
4370 // channel_update later through the announcement_signatures process for public
4371 // channels, but there's no reason not to just inform our counterparty of our fees
4373 if let Ok(msg) = self.get_channel_update_for_unicast(channel.get()) {
4374 Some(events::MessageSendEvent::SendChannelUpdate {
4375 node_id: channel.get().get_counterparty_node_id(),
4380 chan_restoration_res = handle_chan_restoration_locked!(self, channel_lock, channel_state, channel, updates.raa, updates.commitment_update, updates.order, None, updates.accepted_htlcs, updates.funding_broadcastable, updates.channel_ready, updates.announcement_sigs);
4381 if let Some(upd) = channel_update {
4382 channel_state.pending_msg_events.push(upd);
4384 (updates.failed_htlcs, updates.finalized_claimed_htlcs)
4386 post_handle_chan_restoration!(self, chan_restoration_res);
4387 self.finalize_claims(finalized_claims);
4388 for failure in pending_failures.drain(..) {
4389 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), failure.0, &failure.1, failure.2);
4393 /// Accepts a request to open a channel after a [`Event::OpenChannelRequest`].
4395 /// The `temporary_channel_id` parameter indicates which inbound channel should be accepted,
4396 /// and the `counterparty_node_id` parameter is the id of the peer which has requested to open
4399 /// The `user_channel_id` parameter will be provided back in
4400 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
4401 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
4403 /// Note that this method will return an error and reject the channel, if it requires support
4404 /// for zero confirmations. Instead, `accept_inbound_channel_from_trusted_peer_0conf` must be
4405 /// used to accept such channels.
4407 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
4408 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
4409 pub fn accept_inbound_channel(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, user_channel_id: u64) -> Result<(), APIError> {
4410 self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, false, user_channel_id)
4413 /// Accepts a request to open a channel after a [`events::Event::OpenChannelRequest`], treating
4414 /// it as confirmed immediately.
4416 /// The `user_channel_id` parameter will be provided back in
4417 /// [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
4418 /// with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
4420 /// Unlike [`ChannelManager::accept_inbound_channel`], this method accepts the incoming channel
4421 /// and (if the counterparty agrees), enables forwarding of payments immediately.
4423 /// This fully trusts that the counterparty has honestly and correctly constructed the funding
4424 /// transaction and blindly assumes that it will eventually confirm.
4426 /// If it does not confirm before we decide to close the channel, or if the funding transaction
4427 /// does not pay to the correct script the correct amount, *you will lose funds*.
4429 /// [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
4430 /// [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
4431 pub fn accept_inbound_channel_from_trusted_peer_0conf(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, user_channel_id: u64) -> Result<(), APIError> {
4432 self.do_accept_inbound_channel(temporary_channel_id, counterparty_node_id, true, user_channel_id)
4435 fn do_accept_inbound_channel(&self, temporary_channel_id: &[u8; 32], counterparty_node_id: &PublicKey, accept_0conf: bool, user_channel_id: u64) -> Result<(), APIError> {
4436 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4438 let mut channel_state_lock = self.channel_state.lock().unwrap();
4439 let channel_state = &mut *channel_state_lock;
4440 match channel_state.by_id.entry(temporary_channel_id.clone()) {
4441 hash_map::Entry::Occupied(mut channel) => {
4442 if !channel.get().inbound_is_awaiting_accept() {
4443 return Err(APIError::APIMisuseError { err: "The channel isn't currently awaiting to be accepted.".to_owned() });
4445 if *counterparty_node_id != channel.get().get_counterparty_node_id() {
4446 return Err(APIError::APIMisuseError { err: "The passed counterparty_node_id doesn't match the channel's counterparty node_id".to_owned() });
4449 channel.get_mut().set_0conf();
4450 } else if channel.get().get_channel_type().requires_zero_conf() {
4451 let send_msg_err_event = events::MessageSendEvent::HandleError {
4452 node_id: channel.get().get_counterparty_node_id(),
4453 action: msgs::ErrorAction::SendErrorMessage{
4454 msg: msgs::ErrorMessage { channel_id: temporary_channel_id.clone(), data: "No zero confirmation channels accepted".to_owned(), }
4457 channel_state.pending_msg_events.push(send_msg_err_event);
4458 let _ = remove_channel!(self, channel_state, channel);
4459 return Err(APIError::APIMisuseError { err: "Please use accept_inbound_channel_from_trusted_peer_0conf to accept channels with zero confirmations.".to_owned() });
4462 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
4463 node_id: channel.get().get_counterparty_node_id(),
4464 msg: channel.get_mut().accept_inbound_channel(user_channel_id),
4467 hash_map::Entry::Vacant(_) => {
4468 return Err(APIError::ChannelUnavailable { err: "Can't accept a channel that doesn't exist".to_owned() });
4474 fn internal_open_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::OpenChannel) -> Result<(), MsgHandleErrInternal> {
4475 if msg.chain_hash != self.genesis_hash {
4476 return Err(MsgHandleErrInternal::send_err_msg_no_close("Unknown genesis block hash".to_owned(), msg.temporary_channel_id.clone()));
4479 if !self.default_configuration.accept_inbound_channels {
4480 return Err(MsgHandleErrInternal::send_err_msg_no_close("No inbound channels accepted".to_owned(), msg.temporary_channel_id.clone()));
4483 let outbound_scid_alias = self.create_and_insert_outbound_scid_alias();
4484 let mut channel = match Channel::new_from_req(&self.fee_estimator, &self.keys_manager,
4485 counterparty_node_id.clone(), &their_features, msg, 0, &self.default_configuration,
4486 self.best_block.read().unwrap().height(), &self.logger, outbound_scid_alias)
4489 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
4490 return Err(MsgHandleErrInternal::from_chan_no_close(e, msg.temporary_channel_id));
4494 let mut channel_state_lock = self.channel_state.lock().unwrap();
4495 let channel_state = &mut *channel_state_lock;
4496 match channel_state.by_id.entry(channel.channel_id()) {
4497 hash_map::Entry::Occupied(_) => {
4498 self.outbound_scid_aliases.lock().unwrap().remove(&outbound_scid_alias);
4499 return Err(MsgHandleErrInternal::send_err_msg_no_close("temporary_channel_id collision!".to_owned(), msg.temporary_channel_id.clone()))
4501 hash_map::Entry::Vacant(entry) => {
4502 if !self.default_configuration.manually_accept_inbound_channels {
4503 if channel.get_channel_type().requires_zero_conf() {
4504 return Err(MsgHandleErrInternal::send_err_msg_no_close("No zero confirmation channels accepted".to_owned(), msg.temporary_channel_id.clone()));
4506 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
4507 node_id: counterparty_node_id.clone(),
4508 msg: channel.accept_inbound_channel(0),
4511 let mut pending_events = self.pending_events.lock().unwrap();
4512 pending_events.push(
4513 events::Event::OpenChannelRequest {
4514 temporary_channel_id: msg.temporary_channel_id.clone(),
4515 counterparty_node_id: counterparty_node_id.clone(),
4516 funding_satoshis: msg.funding_satoshis,
4517 push_msat: msg.push_msat,
4518 channel_type: channel.get_channel_type().clone(),
4523 entry.insert(channel);
4529 fn internal_accept_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::AcceptChannel) -> Result<(), MsgHandleErrInternal> {
4530 let (value, output_script, user_id) = {
4531 let mut channel_lock = self.channel_state.lock().unwrap();
4532 let channel_state = &mut *channel_lock;
4533 match channel_state.by_id.entry(msg.temporary_channel_id) {
4534 hash_map::Entry::Occupied(mut chan) => {
4535 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4536 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.temporary_channel_id));
4538 try_chan_entry!(self, chan.get_mut().accept_channel(&msg, &self.default_configuration.channel_handshake_limits, &their_features), channel_state, chan);
4539 (chan.get().get_value_satoshis(), chan.get().get_funding_redeemscript().to_v0_p2wsh(), chan.get().get_user_id())
4541 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.temporary_channel_id))
4544 let mut pending_events = self.pending_events.lock().unwrap();
4545 pending_events.push(events::Event::FundingGenerationReady {
4546 temporary_channel_id: msg.temporary_channel_id,
4547 counterparty_node_id: *counterparty_node_id,
4548 channel_value_satoshis: value,
4550 user_channel_id: user_id,
4555 fn internal_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), MsgHandleErrInternal> {
4556 let ((funding_msg, monitor, mut channel_ready), mut chan) = {
4557 let best_block = *self.best_block.read().unwrap();
4558 let mut channel_lock = self.channel_state.lock().unwrap();
4559 let channel_state = &mut *channel_lock;
4560 match channel_state.by_id.entry(msg.temporary_channel_id.clone()) {
4561 hash_map::Entry::Occupied(mut chan) => {
4562 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4563 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.temporary_channel_id));
4565 (try_chan_entry!(self, chan.get_mut().funding_created(msg, best_block, &self.logger), channel_state, chan), chan.remove())
4567 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.temporary_channel_id))
4570 // Because we have exclusive ownership of the channel here we can release the channel_state
4571 // lock before watch_channel
4572 if let Err(e) = self.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor) {
4574 ChannelMonitorUpdateErr::PermanentFailure => {
4575 // Note that we reply with the new channel_id in error messages if we gave up on the
4576 // channel, not the temporary_channel_id. This is compatible with ourselves, but the
4577 // spec is somewhat ambiguous here. Not a huge deal since we'll send error messages for
4578 // any messages referencing a previously-closed channel anyway.
4579 // We do not do a force-close here as that would generate a monitor update for
4580 // a monitor that we didn't manage to store (and that we don't care about - we
4581 // don't respond with the funding_signed so the channel can never go on chain).
4582 let (_monitor_update, failed_htlcs) = chan.force_shutdown(true);
4583 assert!(failed_htlcs.is_empty());
4584 return Err(MsgHandleErrInternal::send_err_msg_no_close("ChannelMonitor storage failure".to_owned(), funding_msg.channel_id));
4586 ChannelMonitorUpdateErr::TemporaryFailure => {
4587 // There's no problem signing a counterparty's funding transaction if our monitor
4588 // hasn't persisted to disk yet - we can't lose money on a transaction that we haven't
4589 // accepted payment from yet. We do, however, need to wait to send our channel_ready
4590 // until we have persisted our monitor.
4591 chan.monitor_update_failed(false, false, channel_ready.is_some(), Vec::new(), Vec::new(), Vec::new());
4592 channel_ready = None; // Don't send the channel_ready now
4596 let mut channel_state_lock = self.channel_state.lock().unwrap();
4597 let channel_state = &mut *channel_state_lock;
4598 match channel_state.by_id.entry(funding_msg.channel_id) {
4599 hash_map::Entry::Occupied(_) => {
4600 return Err(MsgHandleErrInternal::send_err_msg_no_close("Already had channel with the new channel_id".to_owned(), funding_msg.channel_id))
4602 hash_map::Entry::Vacant(e) => {
4603 let mut id_to_peer = self.id_to_peer.lock().unwrap();
4604 match id_to_peer.entry(chan.channel_id()) {
4605 hash_map::Entry::Occupied(_) => {
4606 return Err(MsgHandleErrInternal::send_err_msg_no_close(
4607 "The funding_created message had the same funding_txid as an existing channel - funding is not possible".to_owned(),
4608 funding_msg.channel_id))
4610 hash_map::Entry::Vacant(i_e) => {
4611 i_e.insert(chan.get_counterparty_node_id());
4614 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
4615 node_id: counterparty_node_id.clone(),
4618 if let Some(msg) = channel_ready {
4619 send_channel_ready!(channel_state.short_to_chan_info, channel_state.pending_msg_events, chan, msg);
4627 fn internal_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), MsgHandleErrInternal> {
4629 let best_block = *self.best_block.read().unwrap();
4630 let mut channel_lock = self.channel_state.lock().unwrap();
4631 let channel_state = &mut *channel_lock;
4632 match channel_state.by_id.entry(msg.channel_id) {
4633 hash_map::Entry::Occupied(mut chan) => {
4634 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4635 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4637 let (monitor, funding_tx, channel_ready) = match chan.get_mut().funding_signed(&msg, best_block, &self.logger) {
4638 Ok(update) => update,
4639 Err(e) => try_chan_entry!(self, Err(e), channel_state, chan),
4641 if let Err(e) = self.chain_monitor.watch_channel(chan.get().get_funding_txo().unwrap(), monitor) {
4642 let mut res = handle_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::RevokeAndACKFirst, channel_ready.is_some(), OPTIONALLY_RESEND_FUNDING_LOCKED);
4643 if let Err(MsgHandleErrInternal { ref mut shutdown_finish, .. }) = res {
4644 // We weren't able to watch the channel to begin with, so no updates should be made on
4645 // it. Previously, full_stack_target found an (unreachable) panic when the
4646 // monitor update contained within `shutdown_finish` was applied.
4647 if let Some((ref mut shutdown_finish, _)) = shutdown_finish {
4648 shutdown_finish.0.take();
4653 if let Some(msg) = channel_ready {
4654 send_channel_ready!(channel_state.short_to_chan_info, channel_state.pending_msg_events, chan.get(), msg);
4658 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4661 log_info!(self.logger, "Broadcasting funding transaction with txid {}", funding_tx.txid());
4662 self.tx_broadcaster.broadcast_transaction(&funding_tx);
4666 fn internal_channel_ready(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReady) -> Result<(), MsgHandleErrInternal> {
4667 let mut channel_state_lock = self.channel_state.lock().unwrap();
4668 let channel_state = &mut *channel_state_lock;
4669 match channel_state.by_id.entry(msg.channel_id) {
4670 hash_map::Entry::Occupied(mut chan) => {
4671 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4672 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4674 let announcement_sigs_opt = try_chan_entry!(self, chan.get_mut().channel_ready(&msg, self.get_our_node_id(),
4675 self.genesis_hash.clone(), &self.best_block.read().unwrap(), &self.logger), channel_state, chan);
4676 if let Some(announcement_sigs) = announcement_sigs_opt {
4677 log_trace!(self.logger, "Sending announcement_signatures for channel {}", log_bytes!(chan.get().channel_id()));
4678 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
4679 node_id: counterparty_node_id.clone(),
4680 msg: announcement_sigs,
4682 } else if chan.get().is_usable() {
4683 // If we're sending an announcement_signatures, we'll send the (public)
4684 // channel_update after sending a channel_announcement when we receive our
4685 // counterparty's announcement_signatures. Thus, we only bother to send a
4686 // channel_update here if the channel is not public, i.e. we're not sending an
4687 // announcement_signatures.
4688 log_trace!(self.logger, "Sending private initial channel_update for our counterparty on channel {}", log_bytes!(chan.get().channel_id()));
4689 if let Ok(msg) = self.get_channel_update_for_unicast(chan.get()) {
4690 channel_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
4691 node_id: counterparty_node_id.clone(),
4698 hash_map::Entry::Vacant(_) => Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4702 fn internal_shutdown(&self, counterparty_node_id: &PublicKey, their_features: &InitFeatures, msg: &msgs::Shutdown) -> Result<(), MsgHandleErrInternal> {
4703 let mut dropped_htlcs: Vec<(HTLCSource, PaymentHash)>;
4704 let result: Result<(), _> = loop {
4705 let mut channel_state_lock = self.channel_state.lock().unwrap();
4706 let channel_state = &mut *channel_state_lock;
4708 match channel_state.by_id.entry(msg.channel_id.clone()) {
4709 hash_map::Entry::Occupied(mut chan_entry) => {
4710 if chan_entry.get().get_counterparty_node_id() != *counterparty_node_id {
4711 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4714 if !chan_entry.get().received_shutdown() {
4715 log_info!(self.logger, "Received a shutdown message from our counterparty for channel {}{}.",
4716 log_bytes!(msg.channel_id),
4717 if chan_entry.get().sent_shutdown() { " after we initiated shutdown" } else { "" });
4720 let (shutdown, monitor_update, htlcs) = try_chan_entry!(self, chan_entry.get_mut().shutdown(&self.keys_manager, &their_features, &msg), channel_state, chan_entry);
4721 dropped_htlcs = htlcs;
4723 // Update the monitor with the shutdown script if necessary.
4724 if let Some(monitor_update) = monitor_update {
4725 if let Err(e) = self.chain_monitor.update_channel(chan_entry.get().get_funding_txo().unwrap(), monitor_update) {
4726 let (result, is_permanent) =
4727 handle_monitor_err!(self, e, channel_state.short_to_chan_info, chan_entry.get_mut(), RAACommitmentOrder::CommitmentFirst, chan_entry.key(), NO_UPDATE);
4729 remove_channel!(self, channel_state, chan_entry);
4735 if let Some(msg) = shutdown {
4736 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
4737 node_id: *counterparty_node_id,
4744 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4747 for htlc_source in dropped_htlcs.drain(..) {
4748 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source.0, &htlc_source.1, HTLCFailReason::Reason { failure_code: 0x4000 | 8, data: Vec::new() });
4751 let _ = handle_error!(self, result, *counterparty_node_id);
4755 fn internal_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<(), MsgHandleErrInternal> {
4756 let (tx, chan_option) = {
4757 let mut channel_state_lock = self.channel_state.lock().unwrap();
4758 let channel_state = &mut *channel_state_lock;
4759 match channel_state.by_id.entry(msg.channel_id.clone()) {
4760 hash_map::Entry::Occupied(mut chan_entry) => {
4761 if chan_entry.get().get_counterparty_node_id() != *counterparty_node_id {
4762 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4764 let (closing_signed, tx) = try_chan_entry!(self, chan_entry.get_mut().closing_signed(&self.fee_estimator, &msg), channel_state, chan_entry);
4765 if let Some(msg) = closing_signed {
4766 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
4767 node_id: counterparty_node_id.clone(),
4772 // We're done with this channel, we've got a signed closing transaction and
4773 // will send the closing_signed back to the remote peer upon return. This
4774 // also implies there are no pending HTLCs left on the channel, so we can
4775 // fully delete it from tracking (the channel monitor is still around to
4776 // watch for old state broadcasts)!
4777 (tx, Some(remove_channel!(self, channel_state, chan_entry)))
4778 } else { (tx, None) }
4780 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4783 if let Some(broadcast_tx) = tx {
4784 log_info!(self.logger, "Broadcasting {}", log_tx!(broadcast_tx));
4785 self.tx_broadcaster.broadcast_transaction(&broadcast_tx);
4787 if let Some(chan) = chan_option {
4788 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
4789 let mut channel_state = self.channel_state.lock().unwrap();
4790 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
4794 self.issue_channel_close_events(&chan, ClosureReason::CooperativeClosure);
4799 fn internal_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), MsgHandleErrInternal> {
4800 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
4801 //determine the state of the payment based on our response/if we forward anything/the time
4802 //we take to respond. We should take care to avoid allowing such an attack.
4804 //TODO: There exists a further attack where a node may garble the onion data, forward it to
4805 //us repeatedly garbled in different ways, and compare our error messages, which are
4806 //encrypted with the same key. It's not immediately obvious how to usefully exploit that,
4807 //but we should prevent it anyway.
4809 let (pending_forward_info, mut channel_state_lock) = self.decode_update_add_htlc_onion(msg);
4810 let channel_state = &mut *channel_state_lock;
4812 match channel_state.by_id.entry(msg.channel_id) {
4813 hash_map::Entry::Occupied(mut chan) => {
4814 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4815 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4818 let create_pending_htlc_status = |chan: &Channel<Signer>, pending_forward_info: PendingHTLCStatus, error_code: u16| {
4819 // If the update_add is completely bogus, the call will Err and we will close,
4820 // but if we've sent a shutdown and they haven't acknowledged it yet, we just
4821 // want to reject the new HTLC and fail it backwards instead of forwarding.
4822 match pending_forward_info {
4823 PendingHTLCStatus::Forward(PendingHTLCInfo { ref incoming_shared_secret, .. }) => {
4824 let reason = if (error_code & 0x1000) != 0 {
4825 let (real_code, error_data) = self.get_htlc_inbound_temp_fail_err_and_data(error_code, chan);
4826 onion_utils::build_first_hop_failure_packet(incoming_shared_secret, real_code, &error_data)
4828 onion_utils::build_first_hop_failure_packet(incoming_shared_secret, error_code, &[])
4830 let msg = msgs::UpdateFailHTLC {
4831 channel_id: msg.channel_id,
4832 htlc_id: msg.htlc_id,
4835 PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msg))
4837 _ => pending_forward_info
4840 try_chan_entry!(self, chan.get_mut().update_add_htlc(&msg, pending_forward_info, create_pending_htlc_status, &self.logger), channel_state, chan);
4842 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4847 fn internal_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), MsgHandleErrInternal> {
4848 let mut channel_lock = self.channel_state.lock().unwrap();
4849 let (htlc_source, forwarded_htlc_value) = {
4850 let channel_state = &mut *channel_lock;
4851 match channel_state.by_id.entry(msg.channel_id) {
4852 hash_map::Entry::Occupied(mut chan) => {
4853 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4854 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4856 try_chan_entry!(self, chan.get_mut().update_fulfill_htlc(&msg), channel_state, chan)
4858 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4861 self.claim_funds_internal(channel_lock, htlc_source, msg.payment_preimage.clone(), Some(forwarded_htlc_value), false, msg.channel_id);
4865 fn internal_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), MsgHandleErrInternal> {
4866 let mut channel_lock = self.channel_state.lock().unwrap();
4867 let channel_state = &mut *channel_lock;
4868 match channel_state.by_id.entry(msg.channel_id) {
4869 hash_map::Entry::Occupied(mut chan) => {
4870 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4871 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4873 try_chan_entry!(self, chan.get_mut().update_fail_htlc(&msg, HTLCFailReason::LightningError { err: msg.reason.clone() }), channel_state, chan);
4875 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4880 fn internal_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), MsgHandleErrInternal> {
4881 let mut channel_lock = self.channel_state.lock().unwrap();
4882 let channel_state = &mut *channel_lock;
4883 match channel_state.by_id.entry(msg.channel_id) {
4884 hash_map::Entry::Occupied(mut chan) => {
4885 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4886 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4888 if (msg.failure_code & 0x8000) == 0 {
4889 let chan_err: ChannelError = ChannelError::Close("Got update_fail_malformed_htlc with BADONION not set".to_owned());
4890 try_chan_entry!(self, Err(chan_err), channel_state, chan);
4892 try_chan_entry!(self, chan.get_mut().update_fail_malformed_htlc(&msg, HTLCFailReason::Reason { failure_code: msg.failure_code, data: Vec::new() }), channel_state, chan);
4895 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4899 fn internal_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), MsgHandleErrInternal> {
4900 let mut channel_state_lock = self.channel_state.lock().unwrap();
4901 let channel_state = &mut *channel_state_lock;
4902 match channel_state.by_id.entry(msg.channel_id) {
4903 hash_map::Entry::Occupied(mut chan) => {
4904 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4905 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4907 let (revoke_and_ack, commitment_signed, monitor_update) =
4908 match chan.get_mut().commitment_signed(&msg, &self.logger) {
4909 Err((None, e)) => try_chan_entry!(self, Err(e), channel_state, chan),
4910 Err((Some(update), e)) => {
4911 assert!(chan.get().is_awaiting_monitor_update());
4912 let _ = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), update);
4913 try_chan_entry!(self, Err(e), channel_state, chan);
4918 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
4919 return_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::RevokeAndACKFirst, true, commitment_signed.is_some());
4921 channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
4922 node_id: counterparty_node_id.clone(),
4923 msg: revoke_and_ack,
4925 if let Some(msg) = commitment_signed {
4926 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
4927 node_id: counterparty_node_id.clone(),
4928 updates: msgs::CommitmentUpdate {
4929 update_add_htlcs: Vec::new(),
4930 update_fulfill_htlcs: Vec::new(),
4931 update_fail_htlcs: Vec::new(),
4932 update_fail_malformed_htlcs: Vec::new(),
4934 commitment_signed: msg,
4940 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4945 fn forward_htlcs(&self, per_source_pending_forwards: &mut [(u64, OutPoint, Vec<(PendingHTLCInfo, u64)>)]) {
4946 for &mut (prev_short_channel_id, prev_funding_outpoint, ref mut pending_forwards) in per_source_pending_forwards {
4947 let mut forward_event = None;
4948 if !pending_forwards.is_empty() {
4949 let mut channel_state = self.channel_state.lock().unwrap();
4950 if channel_state.forward_htlcs.is_empty() {
4951 forward_event = Some(Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS))
4953 for (forward_info, prev_htlc_id) in pending_forwards.drain(..) {
4954 match channel_state.forward_htlcs.entry(match forward_info.routing {
4955 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
4956 PendingHTLCRouting::Receive { .. } => 0,
4957 PendingHTLCRouting::ReceiveKeysend { .. } => 0,
4959 hash_map::Entry::Occupied(mut entry) => {
4960 entry.get_mut().push(HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_funding_outpoint,
4961 prev_htlc_id, forward_info });
4963 hash_map::Entry::Vacant(entry) => {
4964 entry.insert(vec!(HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_funding_outpoint,
4965 prev_htlc_id, forward_info }));
4970 match forward_event {
4972 let mut pending_events = self.pending_events.lock().unwrap();
4973 pending_events.push(events::Event::PendingHTLCsForwardable {
4974 time_forwardable: time
4982 fn internal_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), MsgHandleErrInternal> {
4983 let mut htlcs_to_fail = Vec::new();
4985 let mut channel_state_lock = self.channel_state.lock().unwrap();
4986 let channel_state = &mut *channel_state_lock;
4987 match channel_state.by_id.entry(msg.channel_id) {
4988 hash_map::Entry::Occupied(mut chan) => {
4989 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4990 break Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4992 let was_frozen_for_monitor = chan.get().is_awaiting_monitor_update();
4993 let raa_updates = break_chan_entry!(self,
4994 chan.get_mut().revoke_and_ack(&msg, &self.logger), channel_state, chan);
4995 htlcs_to_fail = raa_updates.holding_cell_failed_htlcs;
4996 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), raa_updates.monitor_update) {
4997 if was_frozen_for_monitor {
4998 assert!(raa_updates.commitment_update.is_none());
4999 assert!(raa_updates.accepted_htlcs.is_empty());
5000 assert!(raa_updates.failed_htlcs.is_empty());
5001 assert!(raa_updates.finalized_claimed_htlcs.is_empty());
5002 break Err(MsgHandleErrInternal::ignore_no_close("Previous monitor update failure prevented responses to RAA".to_owned()));
5004 if let Err(e) = handle_monitor_err!(self, e, channel_state, chan,
5005 RAACommitmentOrder::CommitmentFirst, false,
5006 raa_updates.commitment_update.is_some(), false,
5007 raa_updates.accepted_htlcs, raa_updates.failed_htlcs,
5008 raa_updates.finalized_claimed_htlcs) {
5010 } else { unreachable!(); }
5013 if let Some(updates) = raa_updates.commitment_update {
5014 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
5015 node_id: counterparty_node_id.clone(),
5019 break Ok((raa_updates.accepted_htlcs, raa_updates.failed_htlcs,
5020 raa_updates.finalized_claimed_htlcs,
5021 chan.get().get_short_channel_id()
5022 .unwrap_or(chan.get().outbound_scid_alias()),
5023 chan.get().get_funding_txo().unwrap()))
5025 hash_map::Entry::Vacant(_) => break Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
5028 self.fail_holding_cell_htlcs(htlcs_to_fail, msg.channel_id, counterparty_node_id);
5030 Ok((pending_forwards, mut pending_failures, finalized_claim_htlcs,
5031 short_channel_id, channel_outpoint)) =>
5033 for failure in pending_failures.drain(..) {
5034 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), failure.0, &failure.1, failure.2);
5036 self.forward_htlcs(&mut [(short_channel_id, channel_outpoint, pending_forwards)]);
5037 self.finalize_claims(finalized_claim_htlcs);
5044 fn internal_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), MsgHandleErrInternal> {
5045 let mut channel_lock = self.channel_state.lock().unwrap();
5046 let channel_state = &mut *channel_lock;
5047 match channel_state.by_id.entry(msg.channel_id) {
5048 hash_map::Entry::Occupied(mut chan) => {
5049 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
5050 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
5052 try_chan_entry!(self, chan.get_mut().update_fee(&self.fee_estimator, &msg), channel_state, chan);
5054 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
5059 fn internal_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), MsgHandleErrInternal> {
5060 let mut channel_state_lock = self.channel_state.lock().unwrap();
5061 let channel_state = &mut *channel_state_lock;
5063 match channel_state.by_id.entry(msg.channel_id) {
5064 hash_map::Entry::Occupied(mut chan) => {
5065 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
5066 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
5068 if !chan.get().is_usable() {
5069 return Err(MsgHandleErrInternal::from_no_close(LightningError{err: "Got an announcement_signatures before we were ready for it".to_owned(), action: msgs::ErrorAction::IgnoreError}));
5072 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
5073 msg: try_chan_entry!(self, chan.get_mut().announcement_signatures(
5074 self.get_our_node_id(), self.genesis_hash.clone(), self.best_block.read().unwrap().height(), msg), channel_state, chan),
5075 // Note that announcement_signatures fails if the channel cannot be announced,
5076 // so get_channel_update_for_broadcast will never fail by the time we get here.
5077 update_msg: self.get_channel_update_for_broadcast(chan.get()).unwrap(),
5080 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
5085 /// Returns ShouldPersist if anything changed, otherwise either SkipPersist or an Err.
5086 fn internal_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) -> Result<NotifyOption, MsgHandleErrInternal> {
5087 let mut channel_state_lock = self.channel_state.lock().unwrap();
5088 let channel_state = &mut *channel_state_lock;
5089 let chan_id = match channel_state.short_to_chan_info.get(&msg.contents.short_channel_id) {
5090 Some((_cp_id, chan_id)) => chan_id.clone(),
5092 // It's not a local channel
5093 return Ok(NotifyOption::SkipPersist)
5096 match channel_state.by_id.entry(chan_id) {
5097 hash_map::Entry::Occupied(mut chan) => {
5098 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
5099 if chan.get().should_announce() {
5100 // If the announcement is about a channel of ours which is public, some
5101 // other peer may simply be forwarding all its gossip to us. Don't provide
5102 // a scary-looking error message and return Ok instead.
5103 return Ok(NotifyOption::SkipPersist);
5105 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));
5107 let were_node_one = self.get_our_node_id().serialize()[..] < chan.get().get_counterparty_node_id().serialize()[..];
5108 let msg_from_node_one = msg.contents.flags & 1 == 0;
5109 if were_node_one == msg_from_node_one {
5110 return Ok(NotifyOption::SkipPersist);
5112 try_chan_entry!(self, chan.get_mut().channel_update(&msg), channel_state, chan);
5115 hash_map::Entry::Vacant(_) => unreachable!()
5117 Ok(NotifyOption::DoPersist)
5120 fn internal_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<(), MsgHandleErrInternal> {
5121 let chan_restoration_res;
5122 let (htlcs_failed_forward, need_lnd_workaround) = {
5123 let mut channel_state_lock = self.channel_state.lock().unwrap();
5124 let channel_state = &mut *channel_state_lock;
5126 match channel_state.by_id.entry(msg.channel_id) {
5127 hash_map::Entry::Occupied(mut chan) => {
5128 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
5129 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
5131 // Currently, we expect all holding cell update_adds to be dropped on peer
5132 // disconnect, so Channel's reestablish will never hand us any holding cell
5133 // freed HTLCs to fail backwards. If in the future we no longer drop pending
5134 // add-HTLCs on disconnect, we may be handed HTLCs to fail backwards here.
5135 let responses = try_chan_entry!(self, chan.get_mut().channel_reestablish(
5136 msg, &self.logger, self.our_network_pubkey.clone(), self.genesis_hash,
5137 &*self.best_block.read().unwrap()), channel_state, chan);
5138 let mut channel_update = None;
5139 if let Some(msg) = responses.shutdown_msg {
5140 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
5141 node_id: counterparty_node_id.clone(),
5144 } else if chan.get().is_usable() {
5145 // If the channel is in a usable state (ie the channel is not being shut
5146 // down), send a unicast channel_update to our counterparty to make sure
5147 // they have the latest channel parameters.
5148 if let Ok(msg) = self.get_channel_update_for_unicast(chan.get()) {
5149 channel_update = Some(events::MessageSendEvent::SendChannelUpdate {
5150 node_id: chan.get().get_counterparty_node_id(),
5155 let need_lnd_workaround = chan.get_mut().workaround_lnd_bug_4006.take();
5156 chan_restoration_res = handle_chan_restoration_locked!(
5157 self, channel_state_lock, channel_state, chan, responses.raa, responses.commitment_update, responses.order,
5158 responses.mon_update, Vec::new(), None, responses.channel_ready, responses.announcement_sigs);
5159 if let Some(upd) = channel_update {
5160 channel_state.pending_msg_events.push(upd);
5162 (responses.holding_cell_failed_htlcs, need_lnd_workaround)
5164 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
5167 post_handle_chan_restoration!(self, chan_restoration_res);
5168 self.fail_holding_cell_htlcs(htlcs_failed_forward, msg.channel_id, counterparty_node_id);
5170 if let Some(channel_ready_msg) = need_lnd_workaround {
5171 self.internal_channel_ready(counterparty_node_id, &channel_ready_msg)?;
5176 /// Process pending events from the `chain::Watch`, returning whether any events were processed.
5177 fn process_pending_monitor_events(&self) -> bool {
5178 let mut failed_channels = Vec::new();
5179 let mut pending_monitor_events = self.chain_monitor.release_pending_monitor_events();
5180 let has_pending_monitor_events = !pending_monitor_events.is_empty();
5181 for (funding_outpoint, mut monitor_events) in pending_monitor_events.drain(..) {
5182 for monitor_event in monitor_events.drain(..) {
5183 match monitor_event {
5184 MonitorEvent::HTLCEvent(htlc_update) => {
5185 if let Some(preimage) = htlc_update.payment_preimage {
5186 log_trace!(self.logger, "Claiming HTLC with preimage {} from our monitor", log_bytes!(preimage.0));
5187 self.claim_funds_internal(self.channel_state.lock().unwrap(), htlc_update.source, preimage, htlc_update.htlc_value_satoshis.map(|v| v * 1000), true, funding_outpoint.to_channel_id());
5189 log_trace!(self.logger, "Failing HTLC with hash {} from our monitor", log_bytes!(htlc_update.payment_hash.0));
5190 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_update.source, &htlc_update.payment_hash, HTLCFailReason::Reason { failure_code: 0x4000 | 8, data: Vec::new() });
5193 MonitorEvent::CommitmentTxConfirmed(funding_outpoint) |
5194 MonitorEvent::UpdateFailed(funding_outpoint) => {
5195 let mut channel_lock = self.channel_state.lock().unwrap();
5196 let channel_state = &mut *channel_lock;
5197 let by_id = &mut channel_state.by_id;
5198 let pending_msg_events = &mut channel_state.pending_msg_events;
5199 if let hash_map::Entry::Occupied(chan_entry) = by_id.entry(funding_outpoint.to_channel_id()) {
5200 let mut chan = remove_channel!(self, channel_state, chan_entry);
5201 failed_channels.push(chan.force_shutdown(false));
5202 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
5203 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
5207 let reason = if let MonitorEvent::UpdateFailed(_) = monitor_event {
5208 ClosureReason::ProcessingError { err: "Failed to persist ChannelMonitor update during chain sync".to_string() }
5210 ClosureReason::CommitmentTxConfirmed
5212 self.issue_channel_close_events(&chan, reason);
5213 pending_msg_events.push(events::MessageSendEvent::HandleError {
5214 node_id: chan.get_counterparty_node_id(),
5215 action: msgs::ErrorAction::SendErrorMessage {
5216 msg: msgs::ErrorMessage { channel_id: chan.channel_id(), data: "Channel force-closed".to_owned() }
5221 MonitorEvent::UpdateCompleted { funding_txo, monitor_update_id } => {
5222 self.channel_monitor_updated(&funding_txo, monitor_update_id);
5228 for failure in failed_channels.drain(..) {
5229 self.finish_force_close_channel(failure);
5232 has_pending_monitor_events
5235 /// In chanmon_consistency_target, we'd like to be able to restore monitor updating without
5236 /// handling all pending events (i.e. not PendingHTLCsForwardable). Thus, we expose monitor
5237 /// update events as a separate process method here.
5239 pub fn process_monitor_events(&self) {
5240 self.process_pending_monitor_events();
5243 /// Check the holding cell in each channel and free any pending HTLCs in them if possible.
5244 /// Returns whether there were any updates such as if pending HTLCs were freed or a monitor
5245 /// update was applied.
5247 /// This should only apply to HTLCs which were added to the holding cell because we were
5248 /// waiting on a monitor update to finish. In that case, we don't want to free the holding cell
5249 /// directly in `channel_monitor_updated` as it may introduce deadlocks calling back into user
5250 /// code to inform them of a channel monitor update.
5251 fn check_free_holding_cells(&self) -> bool {
5252 let mut has_monitor_update = false;
5253 let mut failed_htlcs = Vec::new();
5254 let mut handle_errors = Vec::new();
5256 let mut channel_state_lock = self.channel_state.lock().unwrap();
5257 let channel_state = &mut *channel_state_lock;
5258 let by_id = &mut channel_state.by_id;
5259 let short_to_chan_info = &mut channel_state.short_to_chan_info;
5260 let pending_msg_events = &mut channel_state.pending_msg_events;
5262 by_id.retain(|channel_id, chan| {
5263 match chan.maybe_free_holding_cell_htlcs(&self.logger) {
5264 Ok((commitment_opt, holding_cell_failed_htlcs)) => {
5265 if !holding_cell_failed_htlcs.is_empty() {
5267 holding_cell_failed_htlcs,
5269 chan.get_counterparty_node_id()
5272 if let Some((commitment_update, monitor_update)) = commitment_opt {
5273 if let Err(e) = self.chain_monitor.update_channel(chan.get_funding_txo().unwrap(), monitor_update) {
5274 has_monitor_update = true;
5275 let (res, close_channel) = handle_monitor_err!(self, e, short_to_chan_info, chan, RAACommitmentOrder::CommitmentFirst, channel_id, COMMITMENT_UPDATE_ONLY);
5276 handle_errors.push((chan.get_counterparty_node_id(), res));
5277 if close_channel { return false; }
5279 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
5280 node_id: chan.get_counterparty_node_id(),
5281 updates: commitment_update,
5288 let (close_channel, res) = convert_chan_err!(self, e, short_to_chan_info, chan, channel_id);
5289 handle_errors.push((chan.get_counterparty_node_id(), Err(res)));
5290 // ChannelClosed event is generated by handle_error for us
5297 let has_update = has_monitor_update || !failed_htlcs.is_empty() || !handle_errors.is_empty();
5298 for (failures, channel_id, counterparty_node_id) in failed_htlcs.drain(..) {
5299 self.fail_holding_cell_htlcs(failures, channel_id, &counterparty_node_id);
5302 for (counterparty_node_id, err) in handle_errors.drain(..) {
5303 let _ = handle_error!(self, err, counterparty_node_id);
5309 /// Check whether any channels have finished removing all pending updates after a shutdown
5310 /// exchange and can now send a closing_signed.
5311 /// Returns whether any closing_signed messages were generated.
5312 fn maybe_generate_initial_closing_signed(&self) -> bool {
5313 let mut handle_errors: Vec<(PublicKey, Result<(), _>)> = Vec::new();
5314 let mut has_update = false;
5316 let mut channel_state_lock = self.channel_state.lock().unwrap();
5317 let channel_state = &mut *channel_state_lock;
5318 let by_id = &mut channel_state.by_id;
5319 let short_to_chan_info = &mut channel_state.short_to_chan_info;
5320 let pending_msg_events = &mut channel_state.pending_msg_events;
5322 by_id.retain(|channel_id, chan| {
5323 match chan.maybe_propose_closing_signed(&self.fee_estimator, &self.logger) {
5324 Ok((msg_opt, tx_opt)) => {
5325 if let Some(msg) = msg_opt {
5327 pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
5328 node_id: chan.get_counterparty_node_id(), msg,
5331 if let Some(tx) = tx_opt {
5332 // We're done with this channel. We got a closing_signed and sent back
5333 // a closing_signed with a closing transaction to broadcast.
5334 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
5335 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
5340 self.issue_channel_close_events(chan, ClosureReason::CooperativeClosure);
5342 log_info!(self.logger, "Broadcasting {}", log_tx!(tx));
5343 self.tx_broadcaster.broadcast_transaction(&tx);
5344 update_maps_on_chan_removal!(self, short_to_chan_info, chan);
5350 let (close_channel, res) = convert_chan_err!(self, e, short_to_chan_info, chan, channel_id);
5351 handle_errors.push((chan.get_counterparty_node_id(), Err(res)));
5358 for (counterparty_node_id, err) in handle_errors.drain(..) {
5359 let _ = handle_error!(self, err, counterparty_node_id);
5365 /// Handle a list of channel failures during a block_connected or block_disconnected call,
5366 /// pushing the channel monitor update (if any) to the background events queue and removing the
5368 fn handle_init_event_channel_failures(&self, mut failed_channels: Vec<ShutdownResult>) {
5369 for mut failure in failed_channels.drain(..) {
5370 // Either a commitment transactions has been confirmed on-chain or
5371 // Channel::block_disconnected detected that the funding transaction has been
5372 // reorganized out of the main chain.
5373 // We cannot broadcast our latest local state via monitor update (as
5374 // Channel::force_shutdown tries to make us do) as we may still be in initialization,
5375 // so we track the update internally and handle it when the user next calls
5376 // timer_tick_occurred, guaranteeing we're running normally.
5377 if let Some((funding_txo, update)) = failure.0.take() {
5378 assert_eq!(update.updates.len(), 1);
5379 if let ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } = update.updates[0] {
5380 assert!(should_broadcast);
5381 } else { unreachable!(); }
5382 self.pending_background_events.lock().unwrap().push(BackgroundEvent::ClosingMonitorUpdate((funding_txo, update)));
5384 self.finish_force_close_channel(failure);
5388 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> {
5389 assert!(invoice_expiry_delta_secs <= 60*60*24*365); // Sadly bitcoin timestamps are u32s, so panic before 2106
5391 if min_value_msat.is_some() && min_value_msat.unwrap() > MAX_VALUE_MSAT {
5392 return Err(APIError::APIMisuseError { err: format!("min_value_msat of {} greater than total 21 million bitcoin supply", min_value_msat.unwrap()) });
5395 let payment_secret = PaymentSecret(self.keys_manager.get_secure_random_bytes());
5397 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5398 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
5399 match payment_secrets.entry(payment_hash) {
5400 hash_map::Entry::Vacant(e) => {
5401 e.insert(PendingInboundPayment {
5402 payment_secret, min_value_msat, payment_preimage,
5403 user_payment_id: 0, // For compatibility with version 0.0.103 and earlier
5404 // We assume that highest_seen_timestamp is pretty close to the current time -
5405 // it's updated when we receive a new block with the maximum time we've seen in
5406 // a header. It should never be more than two hours in the future.
5407 // Thus, we add two hours here as a buffer to ensure we absolutely
5408 // never fail a payment too early.
5409 // Note that we assume that received blocks have reasonably up-to-date
5411 expiry_time: self.highest_seen_timestamp.load(Ordering::Acquire) as u64 + invoice_expiry_delta_secs as u64 + 7200,
5414 hash_map::Entry::Occupied(_) => return Err(APIError::APIMisuseError { err: "Duplicate payment hash".to_owned() }),
5419 /// Gets a payment secret and payment hash for use in an invoice given to a third party wishing
5422 /// This differs from [`create_inbound_payment_for_hash`] only in that it generates the
5423 /// [`PaymentHash`] and [`PaymentPreimage`] for you.
5425 /// The [`PaymentPreimage`] will ultimately be returned to you in the [`PaymentReceived`], which
5426 /// will have the [`PaymentReceived::payment_preimage`] field filled in. That should then be
5427 /// passed directly to [`claim_funds`].
5429 /// See [`create_inbound_payment_for_hash`] for detailed documentation on behavior and requirements.
5431 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
5432 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
5436 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
5437 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
5439 /// Errors if `min_value_msat` is greater than total bitcoin supply.
5441 /// [`claim_funds`]: Self::claim_funds
5442 /// [`PaymentReceived`]: events::Event::PaymentReceived
5443 /// [`PaymentReceived::payment_preimage`]: events::Event::PaymentReceived::payment_preimage
5444 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
5445 pub fn create_inbound_payment(&self, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32) -> Result<(PaymentHash, PaymentSecret), ()> {
5446 inbound_payment::create(&self.inbound_payment_key, min_value_msat, invoice_expiry_delta_secs, &self.keys_manager, self.highest_seen_timestamp.load(Ordering::Acquire) as u64)
5449 /// Legacy version of [`create_inbound_payment`]. Use this method if you wish to share
5450 /// serialized state with LDK node(s) running 0.0.103 and earlier.
5452 /// May panic if `invoice_expiry_delta_secs` is greater than one year.
5455 /// This method is deprecated and will be removed soon.
5457 /// [`create_inbound_payment`]: Self::create_inbound_payment
5459 pub fn create_inbound_payment_legacy(&self, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32) -> Result<(PaymentHash, PaymentSecret), APIError> {
5460 let payment_preimage = PaymentPreimage(self.keys_manager.get_secure_random_bytes());
5461 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
5462 let payment_secret = self.set_payment_hash_secret_map(payment_hash, Some(payment_preimage), min_value_msat, invoice_expiry_delta_secs)?;
5463 Ok((payment_hash, payment_secret))
5466 /// Gets a [`PaymentSecret`] for a given [`PaymentHash`], for which the payment preimage is
5467 /// stored external to LDK.
5469 /// A [`PaymentReceived`] event will only be generated if the [`PaymentSecret`] matches a
5470 /// payment secret fetched via this method or [`create_inbound_payment`], and which is at least
5471 /// the `min_value_msat` provided here, if one is provided.
5473 /// The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) should be globally unique, though
5474 /// note that LDK will not stop you from registering duplicate payment hashes for inbound
5477 /// `min_value_msat` should be set if the invoice being generated contains a value. Any payment
5478 /// received for the returned [`PaymentHash`] will be required to be at least `min_value_msat`
5479 /// before a [`PaymentReceived`] event will be generated, ensuring that we do not provide the
5480 /// sender "proof-of-payment" unless they have paid the required amount.
5482 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
5483 /// in excess of the current time. This should roughly match the expiry time set in the invoice.
5484 /// After this many seconds, we will remove the inbound payment, resulting in any attempts to
5485 /// pay the invoice failing. The BOLT spec suggests 3,600 secs as a default validity time for
5486 /// invoices when no timeout is set.
5488 /// Note that we use block header time to time-out pending inbound payments (with some margin
5489 /// to compensate for the inaccuracy of block header timestamps). Thus, in practice we will
5490 /// accept a payment and generate a [`PaymentReceived`] event for some time after the expiry.
5491 /// If you need exact expiry semantics, you should enforce them upon receipt of
5492 /// [`PaymentReceived`].
5494 /// Note that invoices generated for inbound payments should have their `min_final_cltv_expiry`
5495 /// set to at least [`MIN_FINAL_CLTV_EXPIRY`].
5497 /// Note that a malicious eavesdropper can intuit whether an inbound payment was created by
5498 /// `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
5502 /// If you register an inbound payment with this method, then serialize the `ChannelManager`, then
5503 /// deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
5505 /// Errors if `min_value_msat` is greater than total bitcoin supply.
5507 /// [`create_inbound_payment`]: Self::create_inbound_payment
5508 /// [`PaymentReceived`]: events::Event::PaymentReceived
5509 pub fn create_inbound_payment_for_hash(&self, payment_hash: PaymentHash, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32) -> Result<PaymentSecret, ()> {
5510 inbound_payment::create_from_hash(&self.inbound_payment_key, min_value_msat, payment_hash, invoice_expiry_delta_secs, self.highest_seen_timestamp.load(Ordering::Acquire) as u64)
5513 /// Legacy version of [`create_inbound_payment_for_hash`]. Use this method if you wish to share
5514 /// serialized state with LDK node(s) running 0.0.103 and earlier.
5516 /// May panic if `invoice_expiry_delta_secs` is greater than one year.
5519 /// This method is deprecated and will be removed soon.
5521 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
5523 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> {
5524 self.set_payment_hash_secret_map(payment_hash, None, min_value_msat, invoice_expiry_delta_secs)
5527 /// Gets an LDK-generated payment preimage from a payment hash and payment secret that were
5528 /// previously returned from [`create_inbound_payment`].
5530 /// [`create_inbound_payment`]: Self::create_inbound_payment
5531 pub fn get_payment_preimage(&self, payment_hash: PaymentHash, payment_secret: PaymentSecret) -> Result<PaymentPreimage, APIError> {
5532 inbound_payment::get_payment_preimage(payment_hash, payment_secret, &self.inbound_payment_key)
5535 /// Gets a fake short channel id for use in receiving [phantom node payments]. These fake scids
5536 /// are used when constructing the phantom invoice's route hints.
5538 /// [phantom node payments]: crate::chain::keysinterface::PhantomKeysManager
5539 pub fn get_phantom_scid(&self) -> u64 {
5540 let mut channel_state = self.channel_state.lock().unwrap();
5541 let best_block = self.best_block.read().unwrap();
5543 let scid_candidate = fake_scid::Namespace::Phantom.get_fake_scid(best_block.height(), &self.genesis_hash, &self.fake_scid_rand_bytes, &self.keys_manager);
5544 // Ensure the generated scid doesn't conflict with a real channel.
5545 match channel_state.short_to_chan_info.entry(scid_candidate) {
5546 hash_map::Entry::Occupied(_) => continue,
5547 hash_map::Entry::Vacant(_) => return scid_candidate
5552 /// Gets route hints for use in receiving [phantom node payments].
5554 /// [phantom node payments]: crate::chain::keysinterface::PhantomKeysManager
5555 pub fn get_phantom_route_hints(&self) -> PhantomRouteHints {
5557 channels: self.list_usable_channels(),
5558 phantom_scid: self.get_phantom_scid(),
5559 real_node_pubkey: self.get_our_node_id(),
5563 #[cfg(any(test, fuzzing, feature = "_test_utils"))]
5564 pub fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
5565 let events = core::cell::RefCell::new(Vec::new());
5566 let event_handler = |event: &events::Event| events.borrow_mut().push(event.clone());
5567 self.process_pending_events(&event_handler);
5572 pub fn has_pending_payments(&self) -> bool {
5573 !self.pending_outbound_payments.lock().unwrap().is_empty()
5577 pub fn clear_pending_payments(&self) {
5578 self.pending_outbound_payments.lock().unwrap().clear()
5582 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> MessageSendEventsProvider for ChannelManager<Signer, M, T, K, F, L>
5583 where M::Target: chain::Watch<Signer>,
5584 T::Target: BroadcasterInterface,
5585 K::Target: KeysInterface<Signer = Signer>,
5586 F::Target: FeeEstimator,
5589 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
5590 let events = RefCell::new(Vec::new());
5591 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
5592 let mut result = NotifyOption::SkipPersist;
5594 // TODO: This behavior should be documented. It's unintuitive that we query
5595 // ChannelMonitors when clearing other events.
5596 if self.process_pending_monitor_events() {
5597 result = NotifyOption::DoPersist;
5600 if self.check_free_holding_cells() {
5601 result = NotifyOption::DoPersist;
5603 if self.maybe_generate_initial_closing_signed() {
5604 result = NotifyOption::DoPersist;
5607 let mut pending_events = Vec::new();
5608 let mut channel_state = self.channel_state.lock().unwrap();
5609 mem::swap(&mut pending_events, &mut channel_state.pending_msg_events);
5611 if !pending_events.is_empty() {
5612 events.replace(pending_events);
5621 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> EventsProvider for ChannelManager<Signer, M, T, K, F, L>
5623 M::Target: chain::Watch<Signer>,
5624 T::Target: BroadcasterInterface,
5625 K::Target: KeysInterface<Signer = Signer>,
5626 F::Target: FeeEstimator,
5629 /// Processes events that must be periodically handled.
5631 /// An [`EventHandler`] may safely call back to the provider in order to handle an event.
5632 /// However, it must not call [`Writeable::write`] as doing so would result in a deadlock.
5634 /// Pending events are persisted as part of [`ChannelManager`]. While these events are cleared
5635 /// when processed, an [`EventHandler`] must be able to handle previously seen events when
5636 /// restarting from an old state.
5637 fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler {
5638 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
5639 let mut result = NotifyOption::SkipPersist;
5641 // TODO: This behavior should be documented. It's unintuitive that we query
5642 // ChannelMonitors when clearing other events.
5643 if self.process_pending_monitor_events() {
5644 result = NotifyOption::DoPersist;
5647 let mut pending_events = mem::replace(&mut *self.pending_events.lock().unwrap(), vec![]);
5648 if !pending_events.is_empty() {
5649 result = NotifyOption::DoPersist;
5652 for event in pending_events.drain(..) {
5653 handler.handle_event(&event);
5661 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> chain::Listen for ChannelManager<Signer, M, T, K, F, L>
5663 M::Target: chain::Watch<Signer>,
5664 T::Target: BroadcasterInterface,
5665 K::Target: KeysInterface<Signer = Signer>,
5666 F::Target: FeeEstimator,
5669 fn filtered_block_connected(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
5671 let best_block = self.best_block.read().unwrap();
5672 assert_eq!(best_block.block_hash(), header.prev_blockhash,
5673 "Blocks must be connected in chain-order - the connected header must build on the last connected header");
5674 assert_eq!(best_block.height(), height - 1,
5675 "Blocks must be connected in chain-order - the connected block height must be one greater than the previous height");
5678 self.transactions_confirmed(header, txdata, height);
5679 self.best_block_updated(header, height);
5682 fn block_disconnected(&self, header: &BlockHeader, height: u32) {
5683 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5684 let new_height = height - 1;
5686 let mut best_block = self.best_block.write().unwrap();
5687 assert_eq!(best_block.block_hash(), header.block_hash(),
5688 "Blocks must be disconnected in chain-order - the disconnected header must be the last connected header");
5689 assert_eq!(best_block.height(), height,
5690 "Blocks must be disconnected in chain-order - the disconnected block must have the correct height");
5691 *best_block = BestBlock::new(header.prev_blockhash, new_height)
5694 self.do_chain_event(Some(new_height), |channel| channel.best_block_updated(new_height, header.time, self.genesis_hash.clone(), self.get_our_node_id(), &self.logger));
5698 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> chain::Confirm for ChannelManager<Signer, M, T, K, F, L>
5700 M::Target: chain::Watch<Signer>,
5701 T::Target: BroadcasterInterface,
5702 K::Target: KeysInterface<Signer = Signer>,
5703 F::Target: FeeEstimator,
5706 fn transactions_confirmed(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
5707 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
5708 // during initialization prior to the chain_monitor being fully configured in some cases.
5709 // See the docs for `ChannelManagerReadArgs` for more.
5711 let block_hash = header.block_hash();
5712 log_trace!(self.logger, "{} transactions included in block {} at height {} provided", txdata.len(), block_hash, height);
5714 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5715 self.do_chain_event(Some(height), |channel| channel.transactions_confirmed(&block_hash, height, txdata, self.genesis_hash.clone(), self.get_our_node_id(), &self.logger)
5716 .map(|(a, b)| (a, Vec::new(), b)));
5718 let last_best_block_height = self.best_block.read().unwrap().height();
5719 if height < last_best_block_height {
5720 let timestamp = self.highest_seen_timestamp.load(Ordering::Acquire);
5721 self.do_chain_event(Some(last_best_block_height), |channel| channel.best_block_updated(last_best_block_height, timestamp as u32, self.genesis_hash.clone(), self.get_our_node_id(), &self.logger));
5725 fn best_block_updated(&self, header: &BlockHeader, height: u32) {
5726 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
5727 // during initialization prior to the chain_monitor being fully configured in some cases.
5728 // See the docs for `ChannelManagerReadArgs` for more.
5730 let block_hash = header.block_hash();
5731 log_trace!(self.logger, "New best block: {} at height {}", block_hash, height);
5733 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5735 *self.best_block.write().unwrap() = BestBlock::new(block_hash, height);
5737 self.do_chain_event(Some(height), |channel| channel.best_block_updated(height, header.time, self.genesis_hash.clone(), self.get_our_node_id(), &self.logger));
5739 macro_rules! max_time {
5740 ($timestamp: expr) => {
5742 // Update $timestamp to be the max of its current value and the block
5743 // timestamp. This should keep us close to the current time without relying on
5744 // having an explicit local time source.
5745 // Just in case we end up in a race, we loop until we either successfully
5746 // update $timestamp or decide we don't need to.
5747 let old_serial = $timestamp.load(Ordering::Acquire);
5748 if old_serial >= header.time as usize { break; }
5749 if $timestamp.compare_exchange(old_serial, header.time as usize, Ordering::AcqRel, Ordering::Relaxed).is_ok() {
5755 max_time!(self.last_node_announcement_serial);
5756 max_time!(self.highest_seen_timestamp);
5757 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
5758 payment_secrets.retain(|_, inbound_payment| {
5759 inbound_payment.expiry_time > header.time as u64
5762 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
5763 let mut pending_events = self.pending_events.lock().unwrap();
5764 outbounds.retain(|payment_id, payment| {
5765 if payment.remaining_parts() != 0 { return true }
5766 if let PendingOutboundPayment::Retryable { starting_block_height, payment_hash, .. } = payment {
5767 if *starting_block_height + PAYMENT_EXPIRY_BLOCKS <= height {
5768 log_info!(self.logger, "Timing out payment with id {} and hash {}", log_bytes!(payment_id.0), log_bytes!(payment_hash.0));
5769 pending_events.push(events::Event::PaymentFailed {
5770 payment_id: *payment_id, payment_hash: *payment_hash,
5778 fn get_relevant_txids(&self) -> Vec<Txid> {
5779 let channel_state = self.channel_state.lock().unwrap();
5780 let mut res = Vec::with_capacity(channel_state.short_to_chan_info.len());
5781 for chan in channel_state.by_id.values() {
5782 if let Some(funding_txo) = chan.get_funding_txo() {
5783 res.push(funding_txo.txid);
5789 fn transaction_unconfirmed(&self, txid: &Txid) {
5790 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5791 self.do_chain_event(None, |channel| {
5792 if let Some(funding_txo) = channel.get_funding_txo() {
5793 if funding_txo.txid == *txid {
5794 channel.funding_transaction_unconfirmed(&self.logger).map(|()| (None, Vec::new(), None))
5795 } else { Ok((None, Vec::new(), None)) }
5796 } else { Ok((None, Vec::new(), None)) }
5801 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<Signer, M, T, K, F, L>
5803 M::Target: chain::Watch<Signer>,
5804 T::Target: BroadcasterInterface,
5805 K::Target: KeysInterface<Signer = Signer>,
5806 F::Target: FeeEstimator,
5809 /// Calls a function which handles an on-chain event (blocks dis/connected, transactions
5810 /// un/confirmed, etc) on each channel, handling any resulting errors or messages generated by
5812 fn do_chain_event<FN: Fn(&mut Channel<Signer>) -> Result<(Option<msgs::ChannelReady>, Vec<(HTLCSource, PaymentHash)>, Option<msgs::AnnouncementSignatures>), ClosureReason>>
5813 (&self, height_opt: Option<u32>, f: FN) {
5814 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
5815 // during initialization prior to the chain_monitor being fully configured in some cases.
5816 // See the docs for `ChannelManagerReadArgs` for more.
5818 let mut failed_channels = Vec::new();
5819 let mut timed_out_htlcs = Vec::new();
5821 let mut channel_lock = self.channel_state.lock().unwrap();
5822 let channel_state = &mut *channel_lock;
5823 let short_to_chan_info = &mut channel_state.short_to_chan_info;
5824 let pending_msg_events = &mut channel_state.pending_msg_events;
5825 channel_state.by_id.retain(|_, channel| {
5826 let res = f(channel);
5827 if let Ok((channel_ready_opt, mut timed_out_pending_htlcs, announcement_sigs)) = res {
5828 for (source, payment_hash) in timed_out_pending_htlcs.drain(..) {
5829 let (failure_code, data) = self.get_htlc_inbound_temp_fail_err_and_data(0x1000|14 /* expiry_too_soon */, &channel);
5830 timed_out_htlcs.push((source, payment_hash, HTLCFailReason::Reason {
5834 if let Some(channel_ready) = channel_ready_opt {
5835 send_channel_ready!(short_to_chan_info, pending_msg_events, channel, channel_ready);
5836 if channel.is_usable() {
5837 log_trace!(self.logger, "Sending channel_ready with private initial channel_update for our counterparty on channel {}", log_bytes!(channel.channel_id()));
5838 if let Ok(msg) = self.get_channel_update_for_unicast(channel) {
5839 pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
5840 node_id: channel.get_counterparty_node_id(),
5845 log_trace!(self.logger, "Sending channel_ready WITHOUT channel_update for {}", log_bytes!(channel.channel_id()));
5848 if let Some(announcement_sigs) = announcement_sigs {
5849 log_trace!(self.logger, "Sending announcement_signatures for channel {}", log_bytes!(channel.channel_id()));
5850 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
5851 node_id: channel.get_counterparty_node_id(),
5852 msg: announcement_sigs,
5854 if let Some(height) = height_opt {
5855 if let Some(announcement) = channel.get_signed_channel_announcement(self.get_our_node_id(), self.genesis_hash, height) {
5856 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
5858 // Note that announcement_signatures fails if the channel cannot be announced,
5859 // so get_channel_update_for_broadcast will never fail by the time we get here.
5860 update_msg: self.get_channel_update_for_broadcast(channel).unwrap(),
5865 if channel.is_our_channel_ready() {
5866 if let Some(real_scid) = channel.get_short_channel_id() {
5867 // If we sent a 0conf channel_ready, and now have an SCID, we add it
5868 // to the short_to_chan_info map here. Note that we check whether we
5869 // can relay using the real SCID at relay-time (i.e.
5870 // enforce option_scid_alias then), and if the funding tx is ever
5871 // un-confirmed we force-close the channel, ensuring short_to_chan_info
5872 // is always consistent.
5873 let scid_insert = short_to_chan_info.insert(real_scid, (channel.get_counterparty_node_id(), channel.channel_id()));
5874 assert!(scid_insert.is_none() || scid_insert.unwrap() == (channel.get_counterparty_node_id(), channel.channel_id()),
5875 "SCIDs should never collide - ensure you weren't behind by a full {} blocks when creating channels",
5876 fake_scid::MAX_SCID_BLOCKS_FROM_NOW);
5879 } else if let Err(reason) = res {
5880 update_maps_on_chan_removal!(self, short_to_chan_info, channel);
5881 // It looks like our counterparty went on-chain or funding transaction was
5882 // reorged out of the main chain. Close the channel.
5883 failed_channels.push(channel.force_shutdown(true));
5884 if let Ok(update) = self.get_channel_update_for_broadcast(&channel) {
5885 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
5889 let reason_message = format!("{}", reason);
5890 self.issue_channel_close_events(channel, reason);
5891 pending_msg_events.push(events::MessageSendEvent::HandleError {
5892 node_id: channel.get_counterparty_node_id(),
5893 action: msgs::ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage {
5894 channel_id: channel.channel_id(),
5895 data: reason_message,
5903 if let Some(height) = height_opt {
5904 channel_state.claimable_htlcs.retain(|payment_hash, (_, htlcs)| {
5905 htlcs.retain(|htlc| {
5906 // If height is approaching the number of blocks we think it takes us to get
5907 // our commitment transaction confirmed before the HTLC expires, plus the
5908 // number of blocks we generally consider it to take to do a commitment update,
5909 // just give up on it and fail the HTLC.
5910 if height >= htlc.cltv_expiry - HTLC_FAIL_BACK_BUFFER {
5911 let mut htlc_msat_height_data = byte_utils::be64_to_array(htlc.value).to_vec();
5912 htlc_msat_height_data.extend_from_slice(&byte_utils::be32_to_array(height));
5913 timed_out_htlcs.push((HTLCSource::PreviousHopData(htlc.prev_hop.clone()), payment_hash.clone(), HTLCFailReason::Reason {
5914 failure_code: 0x4000 | 15,
5915 data: htlc_msat_height_data
5920 !htlcs.is_empty() // Only retain this entry if htlcs has at least one entry.
5925 self.handle_init_event_channel_failures(failed_channels);
5927 for (source, payment_hash, reason) in timed_out_htlcs.drain(..) {
5928 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), source, &payment_hash, reason);
5932 /// Blocks until ChannelManager needs to be persisted or a timeout is reached. It returns a bool
5933 /// indicating whether persistence is necessary. Only one listener on
5934 /// `await_persistable_update` or `await_persistable_update_timeout` is guaranteed to be woken
5937 /// Note that this method is not available with the `no-std` feature.
5938 #[cfg(any(test, feature = "std"))]
5939 pub fn await_persistable_update_timeout(&self, max_wait: Duration) -> bool {
5940 self.persistence_notifier.wait_timeout(max_wait)
5943 /// Blocks until ChannelManager needs to be persisted. Only one listener on
5944 /// `await_persistable_update` or `await_persistable_update_timeout` is guaranteed to be woken
5946 pub fn await_persistable_update(&self) {
5947 self.persistence_notifier.wait()
5950 #[cfg(any(test, feature = "_test_utils"))]
5951 pub fn get_persistence_condvar_value(&self) -> bool {
5952 let mutcond = &self.persistence_notifier.persistence_lock;
5953 let &(ref mtx, _) = mutcond;
5954 let guard = mtx.lock().unwrap();
5958 /// Gets the latest best block which was connected either via the [`chain::Listen`] or
5959 /// [`chain::Confirm`] interfaces.
5960 pub fn current_best_block(&self) -> BestBlock {
5961 self.best_block.read().unwrap().clone()
5965 impl<Signer: Sign, M: Deref , T: Deref , K: Deref , F: Deref , L: Deref >
5966 ChannelMessageHandler for ChannelManager<Signer, M, T, K, F, L>
5967 where M::Target: chain::Watch<Signer>,
5968 T::Target: BroadcasterInterface,
5969 K::Target: KeysInterface<Signer = Signer>,
5970 F::Target: FeeEstimator,
5973 fn handle_open_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::OpenChannel) {
5974 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5975 let _ = handle_error!(self, self.internal_open_channel(counterparty_node_id, their_features, msg), *counterparty_node_id);
5978 fn handle_accept_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::AcceptChannel) {
5979 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5980 let _ = handle_error!(self, self.internal_accept_channel(counterparty_node_id, their_features, msg), *counterparty_node_id);
5983 fn handle_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) {
5984 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5985 let _ = handle_error!(self, self.internal_funding_created(counterparty_node_id, msg), *counterparty_node_id);
5988 fn handle_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) {
5989 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5990 let _ = handle_error!(self, self.internal_funding_signed(counterparty_node_id, msg), *counterparty_node_id);
5993 fn handle_channel_ready(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReady) {
5994 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
5995 let _ = handle_error!(self, self.internal_channel_ready(counterparty_node_id, msg), *counterparty_node_id);
5998 fn handle_shutdown(&self, counterparty_node_id: &PublicKey, their_features: &InitFeatures, msg: &msgs::Shutdown) {
5999 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6000 let _ = handle_error!(self, self.internal_shutdown(counterparty_node_id, their_features, msg), *counterparty_node_id);
6003 fn handle_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
6004 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6005 let _ = handle_error!(self, self.internal_closing_signed(counterparty_node_id, msg), *counterparty_node_id);
6008 fn handle_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
6009 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6010 let _ = handle_error!(self, self.internal_update_add_htlc(counterparty_node_id, msg), *counterparty_node_id);
6013 fn handle_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
6014 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6015 let _ = handle_error!(self, self.internal_update_fulfill_htlc(counterparty_node_id, msg), *counterparty_node_id);
6018 fn handle_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
6019 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6020 let _ = handle_error!(self, self.internal_update_fail_htlc(counterparty_node_id, msg), *counterparty_node_id);
6023 fn handle_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
6024 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6025 let _ = handle_error!(self, self.internal_update_fail_malformed_htlc(counterparty_node_id, msg), *counterparty_node_id);
6028 fn handle_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
6029 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6030 let _ = handle_error!(self, self.internal_commitment_signed(counterparty_node_id, msg), *counterparty_node_id);
6033 fn handle_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
6034 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6035 let _ = handle_error!(self, self.internal_revoke_and_ack(counterparty_node_id, msg), *counterparty_node_id);
6038 fn handle_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) {
6039 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6040 let _ = handle_error!(self, self.internal_update_fee(counterparty_node_id, msg), *counterparty_node_id);
6043 fn handle_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
6044 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6045 let _ = handle_error!(self, self.internal_announcement_signatures(counterparty_node_id, msg), *counterparty_node_id);
6048 fn handle_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) {
6049 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
6050 if let Ok(persist) = handle_error!(self, self.internal_channel_update(counterparty_node_id, msg), *counterparty_node_id) {
6053 NotifyOption::SkipPersist
6058 fn handle_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
6059 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6060 let _ = handle_error!(self, self.internal_channel_reestablish(counterparty_node_id, msg), *counterparty_node_id);
6063 fn peer_disconnected(&self, counterparty_node_id: &PublicKey, no_connection_possible: bool) {
6064 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6065 let mut failed_channels = Vec::new();
6066 let mut no_channels_remain = true;
6068 let mut channel_state_lock = self.channel_state.lock().unwrap();
6069 let channel_state = &mut *channel_state_lock;
6070 let pending_msg_events = &mut channel_state.pending_msg_events;
6071 let short_to_chan_info = &mut channel_state.short_to_chan_info;
6072 log_debug!(self.logger, "Marking channels with {} disconnected and generating channel_updates. We believe we {} make future connections to this peer.",
6073 log_pubkey!(counterparty_node_id), if no_connection_possible { "cannot" } else { "can" });
6074 channel_state.by_id.retain(|_, chan| {
6075 if chan.get_counterparty_node_id() == *counterparty_node_id {
6076 chan.remove_uncommitted_htlcs_and_mark_paused(&self.logger);
6077 if chan.is_shutdown() {
6078 update_maps_on_chan_removal!(self, short_to_chan_info, chan);
6079 self.issue_channel_close_events(chan, ClosureReason::DisconnectedPeer);
6082 no_channels_remain = false;
6087 pending_msg_events.retain(|msg| {
6089 &events::MessageSendEvent::SendAcceptChannel { ref node_id, .. } => node_id != counterparty_node_id,
6090 &events::MessageSendEvent::SendOpenChannel { ref node_id, .. } => node_id != counterparty_node_id,
6091 &events::MessageSendEvent::SendFundingCreated { ref node_id, .. } => node_id != counterparty_node_id,
6092 &events::MessageSendEvent::SendFundingSigned { ref node_id, .. } => node_id != counterparty_node_id,
6093 &events::MessageSendEvent::SendChannelReady { ref node_id, .. } => node_id != counterparty_node_id,
6094 &events::MessageSendEvent::SendAnnouncementSignatures { ref node_id, .. } => node_id != counterparty_node_id,
6095 &events::MessageSendEvent::UpdateHTLCs { ref node_id, .. } => node_id != counterparty_node_id,
6096 &events::MessageSendEvent::SendRevokeAndACK { ref node_id, .. } => node_id != counterparty_node_id,
6097 &events::MessageSendEvent::SendClosingSigned { ref node_id, .. } => node_id != counterparty_node_id,
6098 &events::MessageSendEvent::SendShutdown { ref node_id, .. } => node_id != counterparty_node_id,
6099 &events::MessageSendEvent::SendChannelReestablish { ref node_id, .. } => node_id != counterparty_node_id,
6100 &events::MessageSendEvent::BroadcastChannelAnnouncement { .. } => true,
6101 &events::MessageSendEvent::BroadcastNodeAnnouncement { .. } => true,
6102 &events::MessageSendEvent::BroadcastChannelUpdate { .. } => true,
6103 &events::MessageSendEvent::SendChannelUpdate { ref node_id, .. } => node_id != counterparty_node_id,
6104 &events::MessageSendEvent::HandleError { ref node_id, .. } => node_id != counterparty_node_id,
6105 &events::MessageSendEvent::SendChannelRangeQuery { .. } => false,
6106 &events::MessageSendEvent::SendShortIdsQuery { .. } => false,
6107 &events::MessageSendEvent::SendReplyChannelRange { .. } => false,
6108 &events::MessageSendEvent::SendGossipTimestampFilter { .. } => false,
6112 if no_channels_remain {
6113 self.per_peer_state.write().unwrap().remove(counterparty_node_id);
6116 for failure in failed_channels.drain(..) {
6117 self.finish_force_close_channel(failure);
6121 fn peer_connected(&self, counterparty_node_id: &PublicKey, init_msg: &msgs::Init) {
6122 log_debug!(self.logger, "Generating channel_reestablish events for {}", log_pubkey!(counterparty_node_id));
6124 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6127 let mut peer_state_lock = self.per_peer_state.write().unwrap();
6128 match peer_state_lock.entry(counterparty_node_id.clone()) {
6129 hash_map::Entry::Vacant(e) => {
6130 e.insert(Mutex::new(PeerState {
6131 latest_features: init_msg.features.clone(),
6134 hash_map::Entry::Occupied(e) => {
6135 e.get().lock().unwrap().latest_features = init_msg.features.clone();
6140 let mut channel_state_lock = self.channel_state.lock().unwrap();
6141 let channel_state = &mut *channel_state_lock;
6142 let pending_msg_events = &mut channel_state.pending_msg_events;
6143 channel_state.by_id.retain(|_, chan| {
6144 if chan.get_counterparty_node_id() == *counterparty_node_id {
6145 if !chan.have_received_message() {
6146 // If we created this (outbound) channel while we were disconnected from the
6147 // peer we probably failed to send the open_channel message, which is now
6148 // lost. We can't have had anything pending related to this channel, so we just
6152 pending_msg_events.push(events::MessageSendEvent::SendChannelReestablish {
6153 node_id: chan.get_counterparty_node_id(),
6154 msg: chan.get_channel_reestablish(&self.logger),
6160 //TODO: Also re-broadcast announcement_signatures
6163 fn handle_error(&self, counterparty_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
6164 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
6166 if msg.channel_id == [0; 32] {
6167 for chan in self.list_channels() {
6168 if chan.counterparty.node_id == *counterparty_node_id {
6169 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
6170 let _ = self.force_close_channel_with_peer(&chan.channel_id, counterparty_node_id, Some(&msg.data), true);
6175 // First check if we can advance the channel type and try again.
6176 let mut channel_state = self.channel_state.lock().unwrap();
6177 if let Some(chan) = channel_state.by_id.get_mut(&msg.channel_id) {
6178 if chan.get_counterparty_node_id() != *counterparty_node_id {
6181 if let Ok(msg) = chan.maybe_handle_error_without_close(self.genesis_hash) {
6182 channel_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
6183 node_id: *counterparty_node_id,
6191 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
6192 let _ = self.force_close_channel_with_peer(&msg.channel_id, counterparty_node_id, Some(&msg.data), true);
6197 /// Used to signal to the ChannelManager persister that the manager needs to be re-persisted to
6198 /// disk/backups, through `await_persistable_update_timeout` and `await_persistable_update`.
6199 struct PersistenceNotifier {
6200 /// Users won't access the persistence_lock directly, but rather wait on its bool using
6201 /// `wait_timeout` and `wait`.
6202 persistence_lock: (Mutex<bool>, Condvar),
6205 impl PersistenceNotifier {
6208 persistence_lock: (Mutex::new(false), Condvar::new()),
6214 let &(ref mtx, ref cvar) = &self.persistence_lock;
6215 let mut guard = mtx.lock().unwrap();
6220 guard = cvar.wait(guard).unwrap();
6221 let result = *guard;
6229 #[cfg(any(test, feature = "std"))]
6230 fn wait_timeout(&self, max_wait: Duration) -> bool {
6231 let current_time = Instant::now();
6233 let &(ref mtx, ref cvar) = &self.persistence_lock;
6234 let mut guard = mtx.lock().unwrap();
6239 guard = cvar.wait_timeout(guard, max_wait).unwrap().0;
6240 // Due to spurious wakeups that can happen on `wait_timeout`, here we need to check if the
6241 // desired wait time has actually passed, and if not then restart the loop with a reduced wait
6242 // time. Note that this logic can be highly simplified through the use of
6243 // `Condvar::wait_while` and `Condvar::wait_timeout_while`, if and when our MSRV is raised to
6245 let elapsed = current_time.elapsed();
6246 let result = *guard;
6247 if result || elapsed >= max_wait {
6251 match max_wait.checked_sub(elapsed) {
6252 None => return result,
6258 // Signal to the ChannelManager persister that there are updates necessitating persisting to disk.
6260 let &(ref persist_mtx, ref cnd) = &self.persistence_lock;
6261 let mut persistence_lock = persist_mtx.lock().unwrap();
6262 *persistence_lock = true;
6263 mem::drop(persistence_lock);
6268 const SERIALIZATION_VERSION: u8 = 1;
6269 const MIN_SERIALIZATION_VERSION: u8 = 1;
6271 impl_writeable_tlv_based!(CounterpartyForwardingInfo, {
6272 (2, fee_base_msat, required),
6273 (4, fee_proportional_millionths, required),
6274 (6, cltv_expiry_delta, required),
6277 impl_writeable_tlv_based!(ChannelCounterparty, {
6278 (2, node_id, required),
6279 (4, features, required),
6280 (6, unspendable_punishment_reserve, required),
6281 (8, forwarding_info, option),
6282 (9, outbound_htlc_minimum_msat, option),
6283 (11, outbound_htlc_maximum_msat, option),
6286 impl_writeable_tlv_based!(ChannelDetails, {
6287 (1, inbound_scid_alias, option),
6288 (2, channel_id, required),
6289 (3, channel_type, option),
6290 (4, counterparty, required),
6291 (5, outbound_scid_alias, option),
6292 (6, funding_txo, option),
6293 (7, config, option),
6294 (8, short_channel_id, option),
6295 (10, channel_value_satoshis, required),
6296 (12, unspendable_punishment_reserve, option),
6297 (14, user_channel_id, required),
6298 (16, balance_msat, required),
6299 (18, outbound_capacity_msat, required),
6300 // Note that by the time we get past the required read above, outbound_capacity_msat will be
6301 // filled in, so we can safely unwrap it here.
6302 (19, next_outbound_htlc_limit_msat, (default_value, outbound_capacity_msat.0.unwrap() as u64)),
6303 (20, inbound_capacity_msat, required),
6304 (22, confirmations_required, option),
6305 (24, force_close_spend_delay, option),
6306 (26, is_outbound, required),
6307 (28, is_channel_ready, required),
6308 (30, is_usable, required),
6309 (32, is_public, required),
6310 (33, inbound_htlc_minimum_msat, option),
6311 (35, inbound_htlc_maximum_msat, option),
6314 impl_writeable_tlv_based!(PhantomRouteHints, {
6315 (2, channels, vec_type),
6316 (4, phantom_scid, required),
6317 (6, real_node_pubkey, required),
6320 impl_writeable_tlv_based_enum!(PendingHTLCRouting,
6322 (0, onion_packet, required),
6323 (2, short_channel_id, required),
6326 (0, payment_data, required),
6327 (1, phantom_shared_secret, option),
6328 (2, incoming_cltv_expiry, required),
6330 (2, ReceiveKeysend) => {
6331 (0, payment_preimage, required),
6332 (2, incoming_cltv_expiry, required),
6336 impl_writeable_tlv_based!(PendingHTLCInfo, {
6337 (0, routing, required),
6338 (2, incoming_shared_secret, required),
6339 (4, payment_hash, required),
6340 (6, amt_to_forward, required),
6341 (8, outgoing_cltv_value, required)
6345 impl Writeable for HTLCFailureMsg {
6346 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6348 HTLCFailureMsg::Relay(msgs::UpdateFailHTLC { channel_id, htlc_id, reason }) => {
6350 channel_id.write(writer)?;
6351 htlc_id.write(writer)?;
6352 reason.write(writer)?;
6354 HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
6355 channel_id, htlc_id, sha256_of_onion, failure_code
6358 channel_id.write(writer)?;
6359 htlc_id.write(writer)?;
6360 sha256_of_onion.write(writer)?;
6361 failure_code.write(writer)?;
6368 impl Readable for HTLCFailureMsg {
6369 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
6370 let id: u8 = Readable::read(reader)?;
6373 Ok(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
6374 channel_id: Readable::read(reader)?,
6375 htlc_id: Readable::read(reader)?,
6376 reason: Readable::read(reader)?,
6380 Ok(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
6381 channel_id: Readable::read(reader)?,
6382 htlc_id: Readable::read(reader)?,
6383 sha256_of_onion: Readable::read(reader)?,
6384 failure_code: Readable::read(reader)?,
6387 // In versions prior to 0.0.101, HTLCFailureMsg objects were written with type 0 or 1 but
6388 // weren't length-prefixed and thus didn't support reading the TLV stream suffix of the network
6389 // messages contained in the variants.
6390 // In version 0.0.101, support for reading the variants with these types was added, and
6391 // we should migrate to writing these variants when UpdateFailHTLC or
6392 // UpdateFailMalformedHTLC get TLV fields.
6394 let length: BigSize = Readable::read(reader)?;
6395 let mut s = FixedLengthReader::new(reader, length.0);
6396 let res = Readable::read(&mut s)?;
6397 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
6398 Ok(HTLCFailureMsg::Relay(res))
6401 let length: BigSize = Readable::read(reader)?;
6402 let mut s = FixedLengthReader::new(reader, length.0);
6403 let res = Readable::read(&mut s)?;
6404 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
6405 Ok(HTLCFailureMsg::Malformed(res))
6407 _ => Err(DecodeError::UnknownRequiredFeature),
6412 impl_writeable_tlv_based_enum!(PendingHTLCStatus, ;
6417 impl_writeable_tlv_based!(HTLCPreviousHopData, {
6418 (0, short_channel_id, required),
6419 (1, phantom_shared_secret, option),
6420 (2, outpoint, required),
6421 (4, htlc_id, required),
6422 (6, incoming_packet_shared_secret, required)
6425 impl Writeable for ClaimableHTLC {
6426 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6427 let (payment_data, keysend_preimage) = match &self.onion_payload {
6428 OnionPayload::Invoice { _legacy_hop_data } => (_legacy_hop_data.as_ref(), None),
6429 OnionPayload::Spontaneous(preimage) => (None, Some(preimage)),
6431 write_tlv_fields!(writer, {
6432 (0, self.prev_hop, required),
6433 (1, self.total_msat, required),
6434 (2, self.value, required),
6435 (4, payment_data, option),
6436 (6, self.cltv_expiry, required),
6437 (8, keysend_preimage, option),
6443 impl Readable for ClaimableHTLC {
6444 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
6445 let mut prev_hop = ::util::ser::OptionDeserWrapper(None);
6447 let mut payment_data: Option<msgs::FinalOnionHopData> = None;
6448 let mut cltv_expiry = 0;
6449 let mut total_msat = None;
6450 let mut keysend_preimage: Option<PaymentPreimage> = None;
6451 read_tlv_fields!(reader, {
6452 (0, prev_hop, required),
6453 (1, total_msat, option),
6454 (2, value, required),
6455 (4, payment_data, option),
6456 (6, cltv_expiry, required),
6457 (8, keysend_preimage, option)
6459 let onion_payload = match keysend_preimage {
6461 if payment_data.is_some() {
6462 return Err(DecodeError::InvalidValue)
6464 if total_msat.is_none() {
6465 total_msat = Some(value);
6467 OnionPayload::Spontaneous(p)
6470 if total_msat.is_none() {
6471 if payment_data.is_none() {
6472 return Err(DecodeError::InvalidValue)
6474 total_msat = Some(payment_data.as_ref().unwrap().total_msat);
6476 OnionPayload::Invoice { _legacy_hop_data: payment_data }
6480 prev_hop: prev_hop.0.unwrap(),
6483 total_msat: total_msat.unwrap(),
6490 impl Readable for HTLCSource {
6491 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
6492 let id: u8 = Readable::read(reader)?;
6495 let mut session_priv: ::util::ser::OptionDeserWrapper<SecretKey> = ::util::ser::OptionDeserWrapper(None);
6496 let mut first_hop_htlc_msat: u64 = 0;
6497 let mut path = Some(Vec::new());
6498 let mut payment_id = None;
6499 let mut payment_secret = None;
6500 let mut payment_params = None;
6501 read_tlv_fields!(reader, {
6502 (0, session_priv, required),
6503 (1, payment_id, option),
6504 (2, first_hop_htlc_msat, required),
6505 (3, payment_secret, option),
6506 (4, path, vec_type),
6507 (5, payment_params, option),
6509 if payment_id.is_none() {
6510 // For backwards compat, if there was no payment_id written, use the session_priv bytes
6512 payment_id = Some(PaymentId(*session_priv.0.unwrap().as_ref()));
6514 Ok(HTLCSource::OutboundRoute {
6515 session_priv: session_priv.0.unwrap(),
6516 first_hop_htlc_msat: first_hop_htlc_msat,
6517 path: path.unwrap(),
6518 payment_id: payment_id.unwrap(),
6523 1 => Ok(HTLCSource::PreviousHopData(Readable::read(reader)?)),
6524 _ => Err(DecodeError::UnknownRequiredFeature),
6529 impl Writeable for HTLCSource {
6530 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::io::Error> {
6532 HTLCSource::OutboundRoute { ref session_priv, ref first_hop_htlc_msat, ref path, payment_id, payment_secret, payment_params } => {
6534 let payment_id_opt = Some(payment_id);
6535 write_tlv_fields!(writer, {
6536 (0, session_priv, required),
6537 (1, payment_id_opt, option),
6538 (2, first_hop_htlc_msat, required),
6539 (3, payment_secret, option),
6540 (4, path, vec_type),
6541 (5, payment_params, option),
6544 HTLCSource::PreviousHopData(ref field) => {
6546 field.write(writer)?;
6553 impl_writeable_tlv_based_enum!(HTLCFailReason,
6554 (0, LightningError) => {
6558 (0, failure_code, required),
6559 (2, data, vec_type),
6563 impl_writeable_tlv_based_enum!(HTLCForwardInfo,
6565 (0, forward_info, required),
6566 (2, prev_short_channel_id, required),
6567 (4, prev_htlc_id, required),
6568 (6, prev_funding_outpoint, required),
6571 (0, htlc_id, required),
6572 (2, err_packet, required),
6576 impl_writeable_tlv_based!(PendingInboundPayment, {
6577 (0, payment_secret, required),
6578 (2, expiry_time, required),
6579 (4, user_payment_id, required),
6580 (6, payment_preimage, required),
6581 (8, min_value_msat, required),
6584 impl_writeable_tlv_based_enum_upgradable!(PendingOutboundPayment,
6586 (0, session_privs, required),
6589 (0, session_privs, required),
6590 (1, payment_hash, option),
6593 (0, session_privs, required),
6594 (1, pending_fee_msat, option),
6595 (2, payment_hash, required),
6596 (4, payment_secret, option),
6597 (6, total_msat, required),
6598 (8, pending_amt_msat, required),
6599 (10, starting_block_height, required),
6602 (0, session_privs, required),
6603 (2, payment_hash, required),
6607 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> Writeable for ChannelManager<Signer, M, T, K, F, L>
6608 where M::Target: chain::Watch<Signer>,
6609 T::Target: BroadcasterInterface,
6610 K::Target: KeysInterface<Signer = Signer>,
6611 F::Target: FeeEstimator,
6614 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6615 let _consistency_lock = self.total_consistency_lock.write().unwrap();
6617 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
6619 self.genesis_hash.write(writer)?;
6621 let best_block = self.best_block.read().unwrap();
6622 best_block.height().write(writer)?;
6623 best_block.block_hash().write(writer)?;
6626 let channel_state = self.channel_state.lock().unwrap();
6627 let mut unfunded_channels = 0;
6628 for (_, channel) in channel_state.by_id.iter() {
6629 if !channel.is_funding_initiated() {
6630 unfunded_channels += 1;
6633 ((channel_state.by_id.len() - unfunded_channels) as u64).write(writer)?;
6634 for (_, channel) in channel_state.by_id.iter() {
6635 if channel.is_funding_initiated() {
6636 channel.write(writer)?;
6640 (channel_state.forward_htlcs.len() as u64).write(writer)?;
6641 for (short_channel_id, pending_forwards) in channel_state.forward_htlcs.iter() {
6642 short_channel_id.write(writer)?;
6643 (pending_forwards.len() as u64).write(writer)?;
6644 for forward in pending_forwards {
6645 forward.write(writer)?;
6649 let mut htlc_purposes: Vec<&events::PaymentPurpose> = Vec::new();
6650 (channel_state.claimable_htlcs.len() as u64).write(writer)?;
6651 for (payment_hash, (purpose, previous_hops)) in channel_state.claimable_htlcs.iter() {
6652 payment_hash.write(writer)?;
6653 (previous_hops.len() as u64).write(writer)?;
6654 for htlc in previous_hops.iter() {
6655 htlc.write(writer)?;
6657 htlc_purposes.push(purpose);
6660 let per_peer_state = self.per_peer_state.write().unwrap();
6661 (per_peer_state.len() as u64).write(writer)?;
6662 for (peer_pubkey, peer_state_mutex) in per_peer_state.iter() {
6663 peer_pubkey.write(writer)?;
6664 let peer_state = peer_state_mutex.lock().unwrap();
6665 peer_state.latest_features.write(writer)?;
6668 let pending_inbound_payments = self.pending_inbound_payments.lock().unwrap();
6669 let pending_outbound_payments = self.pending_outbound_payments.lock().unwrap();
6670 let events = self.pending_events.lock().unwrap();
6671 (events.len() as u64).write(writer)?;
6672 for event in events.iter() {
6673 event.write(writer)?;
6676 let background_events = self.pending_background_events.lock().unwrap();
6677 (background_events.len() as u64).write(writer)?;
6678 for event in background_events.iter() {
6680 BackgroundEvent::ClosingMonitorUpdate((funding_txo, monitor_update)) => {
6682 funding_txo.write(writer)?;
6683 monitor_update.write(writer)?;
6688 (self.last_node_announcement_serial.load(Ordering::Acquire) as u32).write(writer)?;
6689 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
6691 (pending_inbound_payments.len() as u64).write(writer)?;
6692 for (hash, pending_payment) in pending_inbound_payments.iter() {
6693 hash.write(writer)?;
6694 pending_payment.write(writer)?;
6697 // For backwards compat, write the session privs and their total length.
6698 let mut num_pending_outbounds_compat: u64 = 0;
6699 for (_, outbound) in pending_outbound_payments.iter() {
6700 if !outbound.is_fulfilled() && !outbound.abandoned() {
6701 num_pending_outbounds_compat += outbound.remaining_parts() as u64;
6704 num_pending_outbounds_compat.write(writer)?;
6705 for (_, outbound) in pending_outbound_payments.iter() {
6707 PendingOutboundPayment::Legacy { session_privs } |
6708 PendingOutboundPayment::Retryable { session_privs, .. } => {
6709 for session_priv in session_privs.iter() {
6710 session_priv.write(writer)?;
6713 PendingOutboundPayment::Fulfilled { .. } => {},
6714 PendingOutboundPayment::Abandoned { .. } => {},
6718 // Encode without retry info for 0.0.101 compatibility.
6719 let mut pending_outbound_payments_no_retry: HashMap<PaymentId, HashSet<[u8; 32]>> = HashMap::new();
6720 for (id, outbound) in pending_outbound_payments.iter() {
6722 PendingOutboundPayment::Legacy { session_privs } |
6723 PendingOutboundPayment::Retryable { session_privs, .. } => {
6724 pending_outbound_payments_no_retry.insert(*id, session_privs.clone());
6729 write_tlv_fields!(writer, {
6730 (1, pending_outbound_payments_no_retry, required),
6731 (3, pending_outbound_payments, required),
6732 (5, self.our_network_pubkey, required),
6733 (7, self.fake_scid_rand_bytes, required),
6734 (9, htlc_purposes, vec_type),
6735 (11, self.probing_cookie_secret, required),
6742 /// Arguments for the creation of a ChannelManager that are not deserialized.
6744 /// At a high-level, the process for deserializing a ChannelManager and resuming normal operation
6746 /// 1) Deserialize all stored [`ChannelMonitor`]s.
6747 /// 2) Deserialize the [`ChannelManager`] by filling in this struct and calling:
6748 /// `<(BlockHash, ChannelManager)>::read(reader, args)`
6749 /// This may result in closing some channels if the [`ChannelMonitor`] is newer than the stored
6750 /// [`ChannelManager`] state to ensure no loss of funds. Thus, transactions may be broadcasted.
6751 /// 3) If you are not fetching full blocks, register all relevant [`ChannelMonitor`] outpoints the
6752 /// same way you would handle a [`chain::Filter`] call using
6753 /// [`ChannelMonitor::get_outputs_to_watch`] and [`ChannelMonitor::get_funding_txo`].
6754 /// 4) Reconnect blocks on your [`ChannelMonitor`]s.
6755 /// 5) Disconnect/connect blocks on the [`ChannelManager`].
6756 /// 6) Re-persist the [`ChannelMonitor`]s to ensure the latest state is on disk.
6757 /// Note that if you're using a [`ChainMonitor`] for your [`chain::Watch`] implementation, you
6758 /// will likely accomplish this as a side-effect of calling [`chain::Watch::watch_channel`] in
6760 /// 7) Move the [`ChannelMonitor`]s into your local [`chain::Watch`]. If you're using a
6761 /// [`ChainMonitor`], this is done by calling [`chain::Watch::watch_channel`].
6763 /// Note that the ordering of #4-7 is not of importance, however all four must occur before you
6764 /// call any other methods on the newly-deserialized [`ChannelManager`].
6766 /// Note that because some channels may be closed during deserialization, it is critical that you
6767 /// always deserialize only the latest version of a ChannelManager and ChannelMonitors available to
6768 /// you. If you deserialize an old ChannelManager (during which force-closure transactions may be
6769 /// broadcast), and then later deserialize a newer version of the same ChannelManager (which will
6770 /// not force-close the same channels but consider them live), you may end up revoking a state for
6771 /// which you've already broadcasted the transaction.
6773 /// [`ChainMonitor`]: crate::chain::chainmonitor::ChainMonitor
6774 pub struct ChannelManagerReadArgs<'a, Signer: 'a + Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
6775 where M::Target: chain::Watch<Signer>,
6776 T::Target: BroadcasterInterface,
6777 K::Target: KeysInterface<Signer = Signer>,
6778 F::Target: FeeEstimator,
6781 /// The keys provider which will give us relevant keys. Some keys will be loaded during
6782 /// deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
6784 pub keys_manager: K,
6786 /// The fee_estimator for use in the ChannelManager in the future.
6788 /// No calls to the FeeEstimator will be made during deserialization.
6789 pub fee_estimator: F,
6790 /// The chain::Watch for use in the ChannelManager in the future.
6792 /// No calls to the chain::Watch will be made during deserialization. It is assumed that
6793 /// you have deserialized ChannelMonitors separately and will add them to your
6794 /// chain::Watch after deserializing this ChannelManager.
6795 pub chain_monitor: M,
6797 /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
6798 /// used to broadcast the latest local commitment transactions of channels which must be
6799 /// force-closed during deserialization.
6800 pub tx_broadcaster: T,
6801 /// The Logger for use in the ChannelManager and which may be used to log information during
6802 /// deserialization.
6804 /// Default settings used for new channels. Any existing channels will continue to use the
6805 /// runtime settings which were stored when the ChannelManager was serialized.
6806 pub default_config: UserConfig,
6808 /// A map from channel funding outpoints to ChannelMonitors for those channels (ie
6809 /// value.get_funding_txo() should be the key).
6811 /// If a monitor is inconsistent with the channel state during deserialization the channel will
6812 /// be force-closed using the data in the ChannelMonitor and the channel will be dropped. This
6813 /// is true for missing channels as well. If there is a monitor missing for which we find
6814 /// channel data Err(DecodeError::InvalidValue) will be returned.
6816 /// In such cases the latest local transactions will be sent to the tx_broadcaster included in
6819 /// (C-not exported) because we have no HashMap bindings
6820 pub channel_monitors: HashMap<OutPoint, &'a mut ChannelMonitor<Signer>>,
6823 impl<'a, Signer: 'a + Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
6824 ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>
6825 where M::Target: chain::Watch<Signer>,
6826 T::Target: BroadcasterInterface,
6827 K::Target: KeysInterface<Signer = Signer>,
6828 F::Target: FeeEstimator,
6831 /// Simple utility function to create a ChannelManagerReadArgs which creates the monitor
6832 /// HashMap for you. This is primarily useful for C bindings where it is not practical to
6833 /// populate a HashMap directly from C.
6834 pub fn new(keys_manager: K, fee_estimator: F, chain_monitor: M, tx_broadcaster: T, logger: L, default_config: UserConfig,
6835 mut channel_monitors: Vec<&'a mut ChannelMonitor<Signer>>) -> Self {
6837 keys_manager, fee_estimator, chain_monitor, tx_broadcaster, logger, default_config,
6838 channel_monitors: channel_monitors.drain(..).map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect()
6843 // Implement ReadableArgs for an Arc'd ChannelManager to make it a bit easier to work with the
6844 // SipmleArcChannelManager type:
6845 impl<'a, Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
6846 ReadableArgs<ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>> for (BlockHash, Arc<ChannelManager<Signer, M, T, K, F, L>>)
6847 where M::Target: chain::Watch<Signer>,
6848 T::Target: BroadcasterInterface,
6849 K::Target: KeysInterface<Signer = Signer>,
6850 F::Target: FeeEstimator,
6853 fn read<R: io::Read>(reader: &mut R, args: ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>) -> Result<Self, DecodeError> {
6854 let (blockhash, chan_manager) = <(BlockHash, ChannelManager<Signer, M, T, K, F, L>)>::read(reader, args)?;
6855 Ok((blockhash, Arc::new(chan_manager)))
6859 impl<'a, Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
6860 ReadableArgs<ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>> for (BlockHash, ChannelManager<Signer, M, T, K, F, L>)
6861 where M::Target: chain::Watch<Signer>,
6862 T::Target: BroadcasterInterface,
6863 K::Target: KeysInterface<Signer = Signer>,
6864 F::Target: FeeEstimator,
6867 fn read<R: io::Read>(reader: &mut R, mut args: ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>) -> Result<Self, DecodeError> {
6868 let _ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
6870 let genesis_hash: BlockHash = Readable::read(reader)?;
6871 let best_block_height: u32 = Readable::read(reader)?;
6872 let best_block_hash: BlockHash = Readable::read(reader)?;
6874 let mut failed_htlcs = Vec::new();
6876 let channel_count: u64 = Readable::read(reader)?;
6877 let mut funding_txo_set = HashSet::with_capacity(cmp::min(channel_count as usize, 128));
6878 let mut by_id = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
6879 let mut id_to_peer = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
6880 let mut short_to_chan_info = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
6881 let mut channel_closures = Vec::new();
6882 for _ in 0..channel_count {
6883 let mut channel: Channel<Signer> = Channel::read(reader, (&args.keys_manager, best_block_height))?;
6884 let funding_txo = channel.get_funding_txo().ok_or(DecodeError::InvalidValue)?;
6885 funding_txo_set.insert(funding_txo.clone());
6886 if let Some(ref mut monitor) = args.channel_monitors.get_mut(&funding_txo) {
6887 if channel.get_cur_holder_commitment_transaction_number() < monitor.get_cur_holder_commitment_number() ||
6888 channel.get_revoked_counterparty_commitment_transaction_number() < monitor.get_min_seen_secret() ||
6889 channel.get_cur_counterparty_commitment_transaction_number() < monitor.get_cur_counterparty_commitment_number() ||
6890 channel.get_latest_monitor_update_id() > monitor.get_latest_update_id() {
6891 // If the channel is ahead of the monitor, return InvalidValue:
6892 log_error!(args.logger, "A ChannelMonitor is stale compared to the current ChannelManager! This indicates a potentially-critical violation of the chain::Watch API!");
6893 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
6894 log_bytes!(channel.channel_id()), monitor.get_latest_update_id(), channel.get_latest_monitor_update_id());
6895 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
6896 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
6897 log_error!(args.logger, " Without the latest ChannelMonitor we cannot continue without risking funds.");
6898 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");
6899 return Err(DecodeError::InvalidValue);
6900 } else if channel.get_cur_holder_commitment_transaction_number() > monitor.get_cur_holder_commitment_number() ||
6901 channel.get_revoked_counterparty_commitment_transaction_number() > monitor.get_min_seen_secret() ||
6902 channel.get_cur_counterparty_commitment_transaction_number() > monitor.get_cur_counterparty_commitment_number() ||
6903 channel.get_latest_monitor_update_id() < monitor.get_latest_update_id() {
6904 // But if the channel is behind of the monitor, close the channel:
6905 log_error!(args.logger, "A ChannelManager is stale compared to the current ChannelMonitor!");
6906 log_error!(args.logger, " The channel will be force-closed and the latest commitment transaction from the ChannelMonitor broadcast.");
6907 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
6908 log_bytes!(channel.channel_id()), monitor.get_latest_update_id(), channel.get_latest_monitor_update_id());
6909 let (_, mut new_failed_htlcs) = channel.force_shutdown(true);
6910 failed_htlcs.append(&mut new_failed_htlcs);
6911 monitor.broadcast_latest_holder_commitment_txn(&args.tx_broadcaster, &args.logger);
6912 channel_closures.push(events::Event::ChannelClosed {
6913 channel_id: channel.channel_id(),
6914 user_channel_id: channel.get_user_id(),
6915 reason: ClosureReason::OutdatedChannelManager
6918 log_info!(args.logger, "Successfully loaded channel {}", log_bytes!(channel.channel_id()));
6919 if let Some(short_channel_id) = channel.get_short_channel_id() {
6920 short_to_chan_info.insert(short_channel_id, (channel.get_counterparty_node_id(), channel.channel_id()));
6922 if channel.is_funding_initiated() {
6923 id_to_peer.insert(channel.channel_id(), channel.get_counterparty_node_id());
6925 by_id.insert(channel.channel_id(), channel);
6928 log_error!(args.logger, "Missing ChannelMonitor for channel {} needed by ChannelManager.", log_bytes!(channel.channel_id()));
6929 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
6930 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
6931 log_error!(args.logger, " Without the ChannelMonitor we cannot continue without risking funds.");
6932 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");
6933 return Err(DecodeError::InvalidValue);
6937 for (ref funding_txo, ref mut monitor) in args.channel_monitors.iter_mut() {
6938 if !funding_txo_set.contains(funding_txo) {
6939 log_info!(args.logger, "Broadcasting latest holder commitment transaction for closed channel {}", log_bytes!(funding_txo.to_channel_id()));
6940 monitor.broadcast_latest_holder_commitment_txn(&args.tx_broadcaster, &args.logger);
6944 const MAX_ALLOC_SIZE: usize = 1024 * 64;
6945 let forward_htlcs_count: u64 = Readable::read(reader)?;
6946 let mut forward_htlcs = HashMap::with_capacity(cmp::min(forward_htlcs_count as usize, 128));
6947 for _ in 0..forward_htlcs_count {
6948 let short_channel_id = Readable::read(reader)?;
6949 let pending_forwards_count: u64 = Readable::read(reader)?;
6950 let mut pending_forwards = Vec::with_capacity(cmp::min(pending_forwards_count as usize, MAX_ALLOC_SIZE/mem::size_of::<HTLCForwardInfo>()));
6951 for _ in 0..pending_forwards_count {
6952 pending_forwards.push(Readable::read(reader)?);
6954 forward_htlcs.insert(short_channel_id, pending_forwards);
6957 let claimable_htlcs_count: u64 = Readable::read(reader)?;
6958 let mut claimable_htlcs_list = Vec::with_capacity(cmp::min(claimable_htlcs_count as usize, 128));
6959 for _ in 0..claimable_htlcs_count {
6960 let payment_hash = Readable::read(reader)?;
6961 let previous_hops_len: u64 = Readable::read(reader)?;
6962 let mut previous_hops = Vec::with_capacity(cmp::min(previous_hops_len as usize, MAX_ALLOC_SIZE/mem::size_of::<ClaimableHTLC>()));
6963 for _ in 0..previous_hops_len {
6964 previous_hops.push(<ClaimableHTLC as Readable>::read(reader)?);
6966 claimable_htlcs_list.push((payment_hash, previous_hops));
6969 let peer_count: u64 = Readable::read(reader)?;
6970 let mut per_peer_state = HashMap::with_capacity(cmp::min(peer_count as usize, MAX_ALLOC_SIZE/mem::size_of::<(PublicKey, Mutex<PeerState>)>()));
6971 for _ in 0..peer_count {
6972 let peer_pubkey = Readable::read(reader)?;
6973 let peer_state = PeerState {
6974 latest_features: Readable::read(reader)?,
6976 per_peer_state.insert(peer_pubkey, Mutex::new(peer_state));
6979 let event_count: u64 = Readable::read(reader)?;
6980 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>()));
6981 for _ in 0..event_count {
6982 match MaybeReadable::read(reader)? {
6983 Some(event) => pending_events_read.push(event),
6987 if forward_htlcs_count > 0 {
6988 // If we have pending HTLCs to forward, assume we either dropped a
6989 // `PendingHTLCsForwardable` or the user received it but never processed it as they
6990 // shut down before the timer hit. Either way, set the time_forwardable to a small
6991 // constant as enough time has likely passed that we should simply handle the forwards
6992 // now, or at least after the user gets a chance to reconnect to our peers.
6993 pending_events_read.push(events::Event::PendingHTLCsForwardable {
6994 time_forwardable: Duration::from_secs(2),
6998 let background_event_count: u64 = Readable::read(reader)?;
6999 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>()));
7000 for _ in 0..background_event_count {
7001 match <u8 as Readable>::read(reader)? {
7002 0 => pending_background_events_read.push(BackgroundEvent::ClosingMonitorUpdate((Readable::read(reader)?, Readable::read(reader)?))),
7003 _ => return Err(DecodeError::InvalidValue),
7007 let last_node_announcement_serial: u32 = Readable::read(reader)?;
7008 let highest_seen_timestamp: u32 = Readable::read(reader)?;
7010 let pending_inbound_payment_count: u64 = Readable::read(reader)?;
7011 let mut pending_inbound_payments: HashMap<PaymentHash, PendingInboundPayment> = HashMap::with_capacity(cmp::min(pending_inbound_payment_count as usize, MAX_ALLOC_SIZE/(3*32)));
7012 for _ in 0..pending_inbound_payment_count {
7013 if pending_inbound_payments.insert(Readable::read(reader)?, Readable::read(reader)?).is_some() {
7014 return Err(DecodeError::InvalidValue);
7018 let pending_outbound_payments_count_compat: u64 = Readable::read(reader)?;
7019 let mut pending_outbound_payments_compat: HashMap<PaymentId, PendingOutboundPayment> =
7020 HashMap::with_capacity(cmp::min(pending_outbound_payments_count_compat as usize, MAX_ALLOC_SIZE/32));
7021 for _ in 0..pending_outbound_payments_count_compat {
7022 let session_priv = Readable::read(reader)?;
7023 let payment = PendingOutboundPayment::Legacy {
7024 session_privs: [session_priv].iter().cloned().collect()
7026 if pending_outbound_payments_compat.insert(PaymentId(session_priv), payment).is_some() {
7027 return Err(DecodeError::InvalidValue)
7031 // pending_outbound_payments_no_retry is for compatibility with 0.0.101 clients.
7032 let mut pending_outbound_payments_no_retry: Option<HashMap<PaymentId, HashSet<[u8; 32]>>> = None;
7033 let mut pending_outbound_payments = None;
7034 let mut received_network_pubkey: Option<PublicKey> = None;
7035 let mut fake_scid_rand_bytes: Option<[u8; 32]> = None;
7036 let mut probing_cookie_secret: Option<[u8; 32]> = None;
7037 let mut claimable_htlc_purposes = None;
7038 read_tlv_fields!(reader, {
7039 (1, pending_outbound_payments_no_retry, option),
7040 (3, pending_outbound_payments, option),
7041 (5, received_network_pubkey, option),
7042 (7, fake_scid_rand_bytes, option),
7043 (9, claimable_htlc_purposes, vec_type),
7044 (11, probing_cookie_secret, option),
7046 if fake_scid_rand_bytes.is_none() {
7047 fake_scid_rand_bytes = Some(args.keys_manager.get_secure_random_bytes());
7050 if probing_cookie_secret.is_none() {
7051 probing_cookie_secret = Some(args.keys_manager.get_secure_random_bytes());
7054 if pending_outbound_payments.is_none() && pending_outbound_payments_no_retry.is_none() {
7055 pending_outbound_payments = Some(pending_outbound_payments_compat);
7056 } else if pending_outbound_payments.is_none() {
7057 let mut outbounds = HashMap::new();
7058 for (id, session_privs) in pending_outbound_payments_no_retry.unwrap().drain() {
7059 outbounds.insert(id, PendingOutboundPayment::Legacy { session_privs });
7061 pending_outbound_payments = Some(outbounds);
7063 // If we're tracking pending payments, ensure we haven't lost any by looking at the
7064 // ChannelMonitor data for any channels for which we do not have authorative state
7065 // (i.e. those for which we just force-closed above or we otherwise don't have a
7066 // corresponding `Channel` at all).
7067 // This avoids several edge-cases where we would otherwise "forget" about pending
7068 // payments which are still in-flight via their on-chain state.
7069 // We only rebuild the pending payments map if we were most recently serialized by
7071 for (_, monitor) in args.channel_monitors.iter() {
7072 if by_id.get(&monitor.get_funding_txo().0.to_channel_id()).is_none() {
7073 for (htlc_source, htlc) in monitor.get_pending_outbound_htlcs() {
7074 if let HTLCSource::OutboundRoute { payment_id, session_priv, path, payment_secret, .. } = htlc_source {
7075 if path.is_empty() {
7076 log_error!(args.logger, "Got an empty path for a pending payment");
7077 return Err(DecodeError::InvalidValue);
7079 let path_amt = path.last().unwrap().fee_msat;
7080 let mut session_priv_bytes = [0; 32];
7081 session_priv_bytes[..].copy_from_slice(&session_priv[..]);
7082 match pending_outbound_payments.as_mut().unwrap().entry(payment_id) {
7083 hash_map::Entry::Occupied(mut entry) => {
7084 let newly_added = entry.get_mut().insert(session_priv_bytes, &path);
7085 log_info!(args.logger, "{} a pending payment path for {} msat for session priv {} on an existing pending payment with payment hash {}",
7086 if newly_added { "Added" } else { "Had" }, path_amt, log_bytes!(session_priv_bytes), log_bytes!(htlc.payment_hash.0));
7088 hash_map::Entry::Vacant(entry) => {
7089 let path_fee = path.get_path_fees();
7090 entry.insert(PendingOutboundPayment::Retryable {
7091 session_privs: [session_priv_bytes].iter().map(|a| *a).collect(),
7092 payment_hash: htlc.payment_hash,
7094 pending_amt_msat: path_amt,
7095 pending_fee_msat: Some(path_fee),
7096 total_msat: path_amt,
7097 starting_block_height: best_block_height,
7099 log_info!(args.logger, "Added a pending payment for {} msat with payment hash {} for path with session priv {}",
7100 path_amt, log_bytes!(htlc.payment_hash.0), log_bytes!(session_priv_bytes));
7109 let inbound_pmt_key_material = args.keys_manager.get_inbound_payment_key_material();
7110 let expanded_inbound_key = inbound_payment::ExpandedKey::new(&inbound_pmt_key_material);
7112 let mut claimable_htlcs = HashMap::with_capacity(claimable_htlcs_list.len());
7113 if let Some(mut purposes) = claimable_htlc_purposes {
7114 if purposes.len() != claimable_htlcs_list.len() {
7115 return Err(DecodeError::InvalidValue);
7117 for (purpose, (payment_hash, previous_hops)) in purposes.drain(..).zip(claimable_htlcs_list.drain(..)) {
7118 claimable_htlcs.insert(payment_hash, (purpose, previous_hops));
7121 // LDK versions prior to 0.0.107 did not write a `pending_htlc_purposes`, but do
7122 // include a `_legacy_hop_data` in the `OnionPayload`.
7123 for (payment_hash, previous_hops) in claimable_htlcs_list.drain(..) {
7124 if previous_hops.is_empty() {
7125 return Err(DecodeError::InvalidValue);
7127 let purpose = match &previous_hops[0].onion_payload {
7128 OnionPayload::Invoice { _legacy_hop_data } => {
7129 if let Some(hop_data) = _legacy_hop_data {
7130 events::PaymentPurpose::InvoicePayment {
7131 payment_preimage: match pending_inbound_payments.get(&payment_hash) {
7132 Some(inbound_payment) => inbound_payment.payment_preimage,
7133 None => match inbound_payment::verify(payment_hash, &hop_data, 0, &expanded_inbound_key, &args.logger) {
7134 Ok(payment_preimage) => payment_preimage,
7136 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));
7137 return Err(DecodeError::InvalidValue);
7141 payment_secret: hop_data.payment_secret,
7143 } else { return Err(DecodeError::InvalidValue); }
7145 OnionPayload::Spontaneous(payment_preimage) =>
7146 events::PaymentPurpose::SpontaneousPayment(*payment_preimage),
7148 claimable_htlcs.insert(payment_hash, (purpose, previous_hops));
7152 let mut secp_ctx = Secp256k1::new();
7153 secp_ctx.seeded_randomize(&args.keys_manager.get_secure_random_bytes());
7155 if !channel_closures.is_empty() {
7156 pending_events_read.append(&mut channel_closures);
7159 let our_network_key = match args.keys_manager.get_node_secret(Recipient::Node) {
7161 Err(()) => return Err(DecodeError::InvalidValue)
7163 let our_network_pubkey = PublicKey::from_secret_key(&secp_ctx, &our_network_key);
7164 if let Some(network_pubkey) = received_network_pubkey {
7165 if network_pubkey != our_network_pubkey {
7166 log_error!(args.logger, "Key that was generated does not match the existing key.");
7167 return Err(DecodeError::InvalidValue);
7171 let mut outbound_scid_aliases = HashSet::new();
7172 for (chan_id, chan) in by_id.iter_mut() {
7173 if chan.outbound_scid_alias() == 0 {
7174 let mut outbound_scid_alias;
7176 outbound_scid_alias = fake_scid::Namespace::OutboundAlias
7177 .get_fake_scid(best_block_height, &genesis_hash, fake_scid_rand_bytes.as_ref().unwrap(), &args.keys_manager);
7178 if outbound_scid_aliases.insert(outbound_scid_alias) { break; }
7180 chan.set_outbound_scid_alias(outbound_scid_alias);
7181 } else if !outbound_scid_aliases.insert(chan.outbound_scid_alias()) {
7182 // Note that in rare cases its possible to hit this while reading an older
7183 // channel if we just happened to pick a colliding outbound alias above.
7184 log_error!(args.logger, "Got duplicate outbound SCID alias; {}", chan.outbound_scid_alias());
7185 return Err(DecodeError::InvalidValue);
7187 if chan.is_usable() {
7188 if short_to_chan_info.insert(chan.outbound_scid_alias(), (chan.get_counterparty_node_id(), *chan_id)).is_some() {
7189 // Note that in rare cases its possible to hit this while reading an older
7190 // channel if we just happened to pick a colliding outbound alias above.
7191 log_error!(args.logger, "Got duplicate outbound SCID alias; {}", chan.outbound_scid_alias());
7192 return Err(DecodeError::InvalidValue);
7197 let bounded_fee_estimator = LowerBoundedFeeEstimator::new(args.fee_estimator);
7199 for (_, monitor) in args.channel_monitors.iter() {
7200 for (payment_hash, payment_preimage) in monitor.get_stored_preimages() {
7201 if let Some((payment_purpose, claimable_htlcs)) = claimable_htlcs.remove(&payment_hash) {
7202 log_info!(args.logger, "Re-claiming HTLCs with payment hash {} as we've released the preimage to a ChannelMonitor!", log_bytes!(payment_hash.0));
7203 let mut claimable_amt_msat = 0;
7204 for claimable_htlc in claimable_htlcs {
7205 claimable_amt_msat += claimable_htlc.value;
7207 // Add a holding-cell claim of the payment to the Channel, which should be
7208 // applied ~immediately on peer reconnection. Because it won't generate a
7209 // new commitment transaction we can just provide the payment preimage to
7210 // the corresponding ChannelMonitor and nothing else.
7212 // We do so directly instead of via the normal ChannelMonitor update
7213 // procedure as the ChainMonitor hasn't yet been initialized, implying
7214 // we're not allowed to call it directly yet. Further, we do the update
7215 // without incrementing the ChannelMonitor update ID as there isn't any
7217 // If we were to generate a new ChannelMonitor update ID here and then
7218 // crash before the user finishes block connect we'd end up force-closing
7219 // this channel as well. On the flip side, there's no harm in restarting
7220 // without the new monitor persisted - we'll end up right back here on
7222 let previous_channel_id = claimable_htlc.prev_hop.outpoint.to_channel_id();
7223 if let Some(channel) = by_id.get_mut(&previous_channel_id) {
7224 channel.claim_htlc_while_disconnected_dropping_mon_update(claimable_htlc.prev_hop.htlc_id, payment_preimage, &args.logger);
7226 if let Some(previous_hop_monitor) = args.channel_monitors.get(&claimable_htlc.prev_hop.outpoint) {
7227 previous_hop_monitor.provide_payment_preimage(&payment_hash, &payment_preimage, &args.tx_broadcaster, &bounded_fee_estimator, &args.logger);
7230 pending_events_read.push(events::Event::PaymentClaimed {
7232 purpose: payment_purpose,
7233 amount_msat: claimable_amt_msat,
7239 let channel_manager = ChannelManager {
7241 fee_estimator: bounded_fee_estimator,
7242 chain_monitor: args.chain_monitor,
7243 tx_broadcaster: args.tx_broadcaster,
7245 best_block: RwLock::new(BestBlock::new(best_block_hash, best_block_height)),
7247 channel_state: Mutex::new(ChannelHolder {
7252 pending_msg_events: Vec::new(),
7254 inbound_payment_key: expanded_inbound_key,
7255 pending_inbound_payments: Mutex::new(pending_inbound_payments),
7256 pending_outbound_payments: Mutex::new(pending_outbound_payments.unwrap()),
7258 outbound_scid_aliases: Mutex::new(outbound_scid_aliases),
7259 id_to_peer: Mutex::new(id_to_peer),
7260 fake_scid_rand_bytes: fake_scid_rand_bytes.unwrap(),
7262 probing_cookie_secret: probing_cookie_secret.unwrap(),
7268 last_node_announcement_serial: AtomicUsize::new(last_node_announcement_serial as usize),
7269 highest_seen_timestamp: AtomicUsize::new(highest_seen_timestamp as usize),
7271 per_peer_state: RwLock::new(per_peer_state),
7273 pending_events: Mutex::new(pending_events_read),
7274 pending_background_events: Mutex::new(pending_background_events_read),
7275 total_consistency_lock: RwLock::new(()),
7276 persistence_notifier: PersistenceNotifier::new(),
7278 keys_manager: args.keys_manager,
7279 logger: args.logger,
7280 default_configuration: args.default_config,
7283 for htlc_source in failed_htlcs.drain(..) {
7284 channel_manager.fail_htlc_backwards_internal(channel_manager.channel_state.lock().unwrap(), htlc_source.0, &htlc_source.1, HTLCFailReason::Reason { failure_code: 0x4000 | 8, data: Vec::new() });
7287 //TODO: Broadcast channel update for closed channels, but only after we've made a
7288 //connection or two.
7290 Ok((best_block_hash.clone(), channel_manager))
7296 use bitcoin::hashes::Hash;
7297 use bitcoin::hashes::sha256::Hash as Sha256;
7298 use core::time::Duration;
7299 use core::sync::atomic::Ordering;
7300 use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
7301 use ln::channelmanager::{PaymentId, PaymentSendFailure};
7302 use ln::channelmanager::inbound_payment;
7303 use ln::features::InitFeatures;
7304 use ln::functional_test_utils::*;
7306 use ln::msgs::ChannelMessageHandler;
7307 use routing::router::{PaymentParameters, RouteParameters, find_route};
7308 use util::errors::APIError;
7309 use util::events::{Event, MessageSendEvent, MessageSendEventsProvider, ClosureReason};
7310 use util::test_utils;
7311 use chain::keysinterface::KeysInterface;
7313 #[cfg(feature = "std")]
7315 fn test_wait_timeout() {
7316 use ln::channelmanager::PersistenceNotifier;
7318 use core::sync::atomic::AtomicBool;
7321 let persistence_notifier = Arc::new(PersistenceNotifier::new());
7322 let thread_notifier = Arc::clone(&persistence_notifier);
7324 let exit_thread = Arc::new(AtomicBool::new(false));
7325 let exit_thread_clone = exit_thread.clone();
7326 thread::spawn(move || {
7328 let &(ref persist_mtx, ref cnd) = &thread_notifier.persistence_lock;
7329 let mut persistence_lock = persist_mtx.lock().unwrap();
7330 *persistence_lock = true;
7333 if exit_thread_clone.load(Ordering::SeqCst) {
7339 // Check that we can block indefinitely until updates are available.
7340 let _ = persistence_notifier.wait();
7342 // Check that the PersistenceNotifier will return after the given duration if updates are
7345 if persistence_notifier.wait_timeout(Duration::from_millis(100)) {
7350 exit_thread.store(true, Ordering::SeqCst);
7352 // Check that the PersistenceNotifier will return after the given duration even if no updates
7355 if !persistence_notifier.wait_timeout(Duration::from_millis(100)) {
7362 fn test_notify_limits() {
7363 // Check that a few cases which don't require the persistence of a new ChannelManager,
7364 // indeed, do not cause the persistence of a new ChannelManager.
7365 let chanmon_cfgs = create_chanmon_cfgs(3);
7366 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7367 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7368 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7370 // All nodes start with a persistable update pending as `create_network` connects each node
7371 // with all other nodes to make most tests simpler.
7372 assert!(nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7373 assert!(nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7374 assert!(nodes[2].node.await_persistable_update_timeout(Duration::from_millis(1)));
7376 let mut chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7378 // We check that the channel info nodes have doesn't change too early, even though we try
7379 // to connect messages with new values
7380 chan.0.contents.fee_base_msat *= 2;
7381 chan.1.contents.fee_base_msat *= 2;
7382 let node_a_chan_info = nodes[0].node.list_channels()[0].clone();
7383 let node_b_chan_info = nodes[1].node.list_channels()[0].clone();
7385 // The first two nodes (which opened a channel) should now require fresh persistence
7386 assert!(nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7387 assert!(nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7388 // ... but the last node should not.
7389 assert!(!nodes[2].node.await_persistable_update_timeout(Duration::from_millis(1)));
7390 // After persisting the first two nodes they should no longer need fresh persistence.
7391 assert!(!nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7392 assert!(!nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7394 // Node 3, unrelated to the only channel, shouldn't care if it receives a channel_update
7395 // about the channel.
7396 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.0);
7397 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.1);
7398 assert!(!nodes[2].node.await_persistable_update_timeout(Duration::from_millis(1)));
7400 // The nodes which are a party to the channel should also ignore messages from unrelated
7402 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
7403 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
7404 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
7405 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
7406 assert!(!nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7407 assert!(!nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7409 // At this point the channel info given by peers should still be the same.
7410 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
7411 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
7413 // An earlier version of handle_channel_update didn't check the directionality of the
7414 // update message and would always update the local fee info, even if our peer was
7415 // (spuriously) forwarding us our own channel_update.
7416 let as_node_one = nodes[0].node.get_our_node_id().serialize()[..] < nodes[1].node.get_our_node_id().serialize()[..];
7417 let as_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.0 } else { &chan.1 };
7418 let bs_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.1 } else { &chan.0 };
7420 // First deliver each peers' own message, checking that the node doesn't need to be
7421 // persisted and that its channel info remains the same.
7422 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &as_update);
7423 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &bs_update);
7424 assert!(!nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7425 assert!(!nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7426 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
7427 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
7429 // Finally, deliver the other peers' message, ensuring each node needs to be persisted and
7430 // the channel info has updated.
7431 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &bs_update);
7432 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &as_update);
7433 assert!(nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
7434 assert!(nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
7435 assert_ne!(nodes[0].node.list_channels()[0], node_a_chan_info);
7436 assert_ne!(nodes[1].node.list_channels()[0], node_b_chan_info);
7440 fn test_keysend_dup_hash_partial_mpp() {
7441 // Test that a keysend payment with a duplicate hash to an existing partial MPP payment fails as
7443 let chanmon_cfgs = create_chanmon_cfgs(2);
7444 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7445 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7446 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7447 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7449 // First, send a partial MPP payment.
7450 let (route, our_payment_hash, payment_preimage, payment_secret) = get_route_and_payment_hash!(&nodes[0], nodes[1], 100_000);
7451 let payment_id = PaymentId([42; 32]);
7452 // Use the utility function send_payment_along_path to send the payment with MPP data which
7453 // indicates there are more HTLCs coming.
7454 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.
7455 nodes[0].node.send_payment_along_path(&route.paths[0], &route.payment_params, &our_payment_hash, &Some(payment_secret), 200_000, cur_height, payment_id, &None).unwrap();
7456 check_added_monitors!(nodes[0], 1);
7457 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7458 assert_eq!(events.len(), 1);
7459 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false, None);
7461 // Next, send a keysend payment with the same payment_hash and make sure it fails.
7462 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage)).unwrap();
7463 check_added_monitors!(nodes[0], 1);
7464 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7465 assert_eq!(events.len(), 1);
7466 let ev = events.drain(..).next().unwrap();
7467 let payment_event = SendEvent::from_event(ev);
7468 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7469 check_added_monitors!(nodes[1], 0);
7470 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7471 expect_pending_htlcs_forwardable!(nodes[1]);
7472 expect_pending_htlcs_forwardable!(nodes[1]);
7473 check_added_monitors!(nodes[1], 1);
7474 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7475 assert!(updates.update_add_htlcs.is_empty());
7476 assert!(updates.update_fulfill_htlcs.is_empty());
7477 assert_eq!(updates.update_fail_htlcs.len(), 1);
7478 assert!(updates.update_fail_malformed_htlcs.is_empty());
7479 assert!(updates.update_fee.is_none());
7480 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
7481 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
7482 expect_payment_failed!(nodes[0], our_payment_hash, true);
7484 // Send the second half of the original MPP payment.
7485 nodes[0].node.send_payment_along_path(&route.paths[0], &route.payment_params, &our_payment_hash, &Some(payment_secret), 200_000, cur_height, payment_id, &None).unwrap();
7486 check_added_monitors!(nodes[0], 1);
7487 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7488 assert_eq!(events.len(), 1);
7489 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), true, None);
7491 // Claim the full MPP payment. Note that we can't use a test utility like
7492 // claim_funds_along_route because the ordering of the messages causes the second half of the
7493 // payment to be put in the holding cell, which confuses the test utilities. So we exchange the
7494 // lightning messages manually.
7495 nodes[1].node.claim_funds(payment_preimage);
7496 expect_payment_claimed!(nodes[1], our_payment_hash, 200_000);
7497 check_added_monitors!(nodes[1], 2);
7499 let bs_first_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7500 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_first_updates.update_fulfill_htlcs[0]);
7501 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_first_updates.commitment_signed);
7502 check_added_monitors!(nodes[0], 1);
7503 let (as_first_raa, as_first_cs) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7504 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_first_raa);
7505 check_added_monitors!(nodes[1], 1);
7506 let bs_second_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7507 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_first_cs);
7508 check_added_monitors!(nodes[1], 1);
7509 let bs_first_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
7510 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_second_updates.update_fulfill_htlcs[0]);
7511 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_updates.commitment_signed);
7512 check_added_monitors!(nodes[0], 1);
7513 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
7514 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
7515 let as_second_updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7516 check_added_monitors!(nodes[0], 1);
7517 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
7518 check_added_monitors!(nodes[1], 1);
7519 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_updates.commitment_signed);
7520 check_added_monitors!(nodes[1], 1);
7521 let bs_third_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
7522 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_third_raa);
7523 check_added_monitors!(nodes[0], 1);
7525 // Note that successful MPP payments will generate a single PaymentSent event upon the first
7526 // path's success and a PaymentPathSuccessful event for each path's success.
7527 let events = nodes[0].node.get_and_clear_pending_events();
7528 assert_eq!(events.len(), 3);
7530 Event::PaymentSent { payment_id: ref id, payment_preimage: ref preimage, payment_hash: ref hash, .. } => {
7531 assert_eq!(Some(payment_id), *id);
7532 assert_eq!(payment_preimage, *preimage);
7533 assert_eq!(our_payment_hash, *hash);
7535 _ => panic!("Unexpected event"),
7538 Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
7539 assert_eq!(payment_id, *actual_payment_id);
7540 assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
7541 assert_eq!(route.paths[0], *path);
7543 _ => panic!("Unexpected event"),
7546 Event::PaymentPathSuccessful { payment_id: ref actual_payment_id, ref payment_hash, ref path } => {
7547 assert_eq!(payment_id, *actual_payment_id);
7548 assert_eq!(our_payment_hash, *payment_hash.as_ref().unwrap());
7549 assert_eq!(route.paths[0], *path);
7551 _ => panic!("Unexpected event"),
7556 fn test_keysend_dup_payment_hash() {
7557 // (1): Test that a keysend payment with a duplicate payment hash to an existing pending
7558 // outbound regular payment fails as expected.
7559 // (2): Test that a regular payment with a duplicate payment hash to an existing keysend payment
7560 // fails as expected.
7561 let chanmon_cfgs = create_chanmon_cfgs(2);
7562 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7563 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7564 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7565 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7566 let scorer = test_utils::TestScorer::with_penalty(0);
7567 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
7569 // To start (1), send a regular payment but don't claim it.
7570 let expected_route = [&nodes[1]];
7571 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &expected_route, 100_000);
7573 // Next, attempt a keysend payment and make sure it fails.
7574 let route_params = RouteParameters {
7575 payment_params: PaymentParameters::for_keysend(expected_route.last().unwrap().node.get_our_node_id()),
7576 final_value_msat: 100_000,
7577 final_cltv_expiry_delta: TEST_FINAL_CLTV,
7579 let route = find_route(
7580 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
7581 None, nodes[0].logger, &scorer, &random_seed_bytes
7583 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage)).unwrap();
7584 check_added_monitors!(nodes[0], 1);
7585 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7586 assert_eq!(events.len(), 1);
7587 let ev = events.drain(..).next().unwrap();
7588 let payment_event = SendEvent::from_event(ev);
7589 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7590 check_added_monitors!(nodes[1], 0);
7591 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7592 expect_pending_htlcs_forwardable!(nodes[1]);
7593 expect_pending_htlcs_forwardable!(nodes[1]);
7594 check_added_monitors!(nodes[1], 1);
7595 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7596 assert!(updates.update_add_htlcs.is_empty());
7597 assert!(updates.update_fulfill_htlcs.is_empty());
7598 assert_eq!(updates.update_fail_htlcs.len(), 1);
7599 assert!(updates.update_fail_malformed_htlcs.is_empty());
7600 assert!(updates.update_fee.is_none());
7601 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
7602 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
7603 expect_payment_failed!(nodes[0], payment_hash, true);
7605 // Finally, claim the original payment.
7606 claim_payment(&nodes[0], &expected_route, payment_preimage);
7608 // To start (2), send a keysend payment but don't claim it.
7609 let payment_preimage = PaymentPreimage([42; 32]);
7610 let route = find_route(
7611 &nodes[0].node.get_our_node_id(), &route_params, &nodes[0].network_graph,
7612 None, nodes[0].logger, &scorer, &random_seed_bytes
7614 let (payment_hash, _) = nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage)).unwrap();
7615 check_added_monitors!(nodes[0], 1);
7616 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7617 assert_eq!(events.len(), 1);
7618 let event = events.pop().unwrap();
7619 let path = vec![&nodes[1]];
7620 pass_along_path(&nodes[0], &path, 100_000, payment_hash, None, event, true, Some(payment_preimage));
7622 // Next, attempt a regular payment and make sure it fails.
7623 let payment_secret = PaymentSecret([43; 32]);
7624 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
7625 check_added_monitors!(nodes[0], 1);
7626 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7627 assert_eq!(events.len(), 1);
7628 let ev = events.drain(..).next().unwrap();
7629 let payment_event = SendEvent::from_event(ev);
7630 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7631 check_added_monitors!(nodes[1], 0);
7632 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7633 expect_pending_htlcs_forwardable!(nodes[1]);
7634 expect_pending_htlcs_forwardable!(nodes[1]);
7635 check_added_monitors!(nodes[1], 1);
7636 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7637 assert!(updates.update_add_htlcs.is_empty());
7638 assert!(updates.update_fulfill_htlcs.is_empty());
7639 assert_eq!(updates.update_fail_htlcs.len(), 1);
7640 assert!(updates.update_fail_malformed_htlcs.is_empty());
7641 assert!(updates.update_fee.is_none());
7642 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
7643 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
7644 expect_payment_failed!(nodes[0], payment_hash, true);
7646 // Finally, succeed the keysend payment.
7647 claim_payment(&nodes[0], &expected_route, payment_preimage);
7651 fn test_keysend_hash_mismatch() {
7652 // Test that if we receive a keysend `update_add_htlc` msg, we fail as expected if the keysend
7653 // preimage doesn't match the msg's payment hash.
7654 let chanmon_cfgs = create_chanmon_cfgs(2);
7655 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7656 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7657 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7659 let payer_pubkey = nodes[0].node.get_our_node_id();
7660 let payee_pubkey = nodes[1].node.get_our_node_id();
7661 nodes[0].node.peer_connected(&payee_pubkey, &msgs::Init { features: InitFeatures::known(), remote_network_address: None });
7662 nodes[1].node.peer_connected(&payer_pubkey, &msgs::Init { features: InitFeatures::known(), remote_network_address: None });
7664 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
7665 let route_params = RouteParameters {
7666 payment_params: PaymentParameters::for_keysend(payee_pubkey),
7667 final_value_msat: 10000,
7668 final_cltv_expiry_delta: 40,
7670 let network_graph = nodes[0].network_graph;
7671 let first_hops = nodes[0].node.list_usable_channels();
7672 let scorer = test_utils::TestScorer::with_penalty(0);
7673 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
7674 let route = find_route(
7675 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
7676 nodes[0].logger, &scorer, &random_seed_bytes
7679 let test_preimage = PaymentPreimage([42; 32]);
7680 let mismatch_payment_hash = PaymentHash([43; 32]);
7681 let _ = nodes[0].node.send_payment_internal(&route, mismatch_payment_hash, &None, Some(test_preimage), None, None).unwrap();
7682 check_added_monitors!(nodes[0], 1);
7684 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7685 assert_eq!(updates.update_add_htlcs.len(), 1);
7686 assert!(updates.update_fulfill_htlcs.is_empty());
7687 assert!(updates.update_fail_htlcs.is_empty());
7688 assert!(updates.update_fail_malformed_htlcs.is_empty());
7689 assert!(updates.update_fee.is_none());
7690 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7692 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Payment preimage didn't match payment hash".to_string(), 1);
7696 fn test_keysend_msg_with_secret_err() {
7697 // Test that we error as expected if we receive a keysend payment that includes a payment secret.
7698 let chanmon_cfgs = create_chanmon_cfgs(2);
7699 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7700 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7701 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7703 let payer_pubkey = nodes[0].node.get_our_node_id();
7704 let payee_pubkey = nodes[1].node.get_our_node_id();
7705 nodes[0].node.peer_connected(&payee_pubkey, &msgs::Init { features: InitFeatures::known(), remote_network_address: None });
7706 nodes[1].node.peer_connected(&payer_pubkey, &msgs::Init { features: InitFeatures::known(), remote_network_address: None });
7708 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
7709 let route_params = RouteParameters {
7710 payment_params: PaymentParameters::for_keysend(payee_pubkey),
7711 final_value_msat: 10000,
7712 final_cltv_expiry_delta: 40,
7714 let network_graph = nodes[0].network_graph;
7715 let first_hops = nodes[0].node.list_usable_channels();
7716 let scorer = test_utils::TestScorer::with_penalty(0);
7717 let random_seed_bytes = chanmon_cfgs[1].keys_manager.get_secure_random_bytes();
7718 let route = find_route(
7719 &payer_pubkey, &route_params, &network_graph, Some(&first_hops.iter().collect::<Vec<_>>()),
7720 nodes[0].logger, &scorer, &random_seed_bytes
7723 let test_preimage = PaymentPreimage([42; 32]);
7724 let test_secret = PaymentSecret([43; 32]);
7725 let payment_hash = PaymentHash(Sha256::hash(&test_preimage.0).into_inner());
7726 let _ = nodes[0].node.send_payment_internal(&route, payment_hash, &Some(test_secret), Some(test_preimage), None, None).unwrap();
7727 check_added_monitors!(nodes[0], 1);
7729 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7730 assert_eq!(updates.update_add_htlcs.len(), 1);
7731 assert!(updates.update_fulfill_htlcs.is_empty());
7732 assert!(updates.update_fail_htlcs.is_empty());
7733 assert!(updates.update_fail_malformed_htlcs.is_empty());
7734 assert!(updates.update_fee.is_none());
7735 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7737 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "We don't support MPP keysend payments".to_string(), 1);
7741 fn test_multi_hop_missing_secret() {
7742 let chanmon_cfgs = create_chanmon_cfgs(4);
7743 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
7744 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
7745 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
7747 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7748 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7749 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7750 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7752 // Marshall an MPP route.
7753 let (mut route, payment_hash, _, _) = get_route_and_payment_hash!(&nodes[0], nodes[3], 100000);
7754 let path = route.paths[0].clone();
7755 route.paths.push(path);
7756 route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
7757 route.paths[0][0].short_channel_id = chan_1_id;
7758 route.paths[0][1].short_channel_id = chan_3_id;
7759 route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
7760 route.paths[1][0].short_channel_id = chan_2_id;
7761 route.paths[1][1].short_channel_id = chan_4_id;
7763 match nodes[0].node.send_payment(&route, payment_hash, &None).unwrap_err() {
7764 PaymentSendFailure::ParameterError(APIError::APIMisuseError { ref err }) => {
7765 assert!(regex::Regex::new(r"Payment secret is required for multi-path payments").unwrap().is_match(err)) },
7766 _ => panic!("unexpected error")
7771 fn bad_inbound_payment_hash() {
7772 // Add coverage for checking that a user-provided payment hash matches the payment secret.
7773 let chanmon_cfgs = create_chanmon_cfgs(2);
7774 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7775 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7776 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7778 let (_, payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[0]);
7779 let payment_data = msgs::FinalOnionHopData {
7781 total_msat: 100_000,
7784 // Ensure that if the payment hash given to `inbound_payment::verify` differs from the original,
7785 // payment verification fails as expected.
7786 let mut bad_payment_hash = payment_hash.clone();
7787 bad_payment_hash.0[0] += 1;
7788 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) {
7789 Ok(_) => panic!("Unexpected ok"),
7791 nodes[0].logger.assert_log_contains("lightning::ln::inbound_payment".to_string(), "Failing HTLC with user-generated payment_hash".to_string(), 1);
7795 // Check that using the original payment hash succeeds.
7796 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());
7800 fn test_id_to_peer_coverage() {
7801 // Test that the `ChannelManager:id_to_peer` contains channels which have been assigned
7802 // a `channel_id` (i.e. have had the funding tx created), and that they are removed once
7803 // the channel is successfully closed.
7804 let chanmon_cfgs = create_chanmon_cfgs(2);
7805 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7806 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7807 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7809 nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1_000_000, 500_000_000, 42, None).unwrap();
7810 let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7811 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
7812 let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7813 nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7815 let (temporary_channel_id, tx, _funding_output) = create_funding_transaction(&nodes[0], &nodes[1].node.get_our_node_id(), 1_000_000, 42);
7816 let channel_id = &tx.txid().into_inner();
7818 // Ensure that the `id_to_peer` map is empty until either party has received the
7819 // funding transaction, and have the real `channel_id`.
7820 assert_eq!(nodes[0].node.id_to_peer.lock().unwrap().len(), 0);
7821 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
7824 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), tx.clone()).unwrap();
7826 // Assert that `nodes[0]`'s `id_to_peer` map is populated with the channel as soon as
7827 // as it has the funding transaction.
7828 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
7829 assert_eq!(nodes_0_lock.len(), 1);
7830 assert!(nodes_0_lock.contains_key(channel_id));
7832 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
7835 let funding_created_msg = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
7837 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created_msg);
7839 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
7840 assert_eq!(nodes_0_lock.len(), 1);
7841 assert!(nodes_0_lock.contains_key(channel_id));
7843 // Assert that `nodes[1]`'s `id_to_peer` map is populated with the channel as soon as
7844 // as it has the funding transaction.
7845 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
7846 assert_eq!(nodes_1_lock.len(), 1);
7847 assert!(nodes_1_lock.contains_key(channel_id));
7849 check_added_monitors!(nodes[1], 1);
7850 let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
7851 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
7852 check_added_monitors!(nodes[0], 1);
7853 let (channel_ready, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
7854 let (announcement, nodes_0_update, nodes_1_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &channel_ready);
7855 update_nodes_with_chan_announce(&nodes, 0, 1, &announcement, &nodes_0_update, &nodes_1_update);
7857 nodes[0].node.close_channel(channel_id, &nodes[1].node.get_our_node_id()).unwrap();
7858 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &InitFeatures::known(), &get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id()));
7859 let nodes_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7860 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &InitFeatures::known(), &nodes_1_shutdown);
7862 let closing_signed_node_0 = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
7863 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_node_0);
7865 // Assert that the channel is kept in the `id_to_peer` map for both nodes until the
7866 // channel can be fully closed by both parties (i.e. no outstanding htlcs exists, the
7867 // fee for the closing transaction has been negotiated and the parties has the other
7868 // party's signature for the fee negotiated closing transaction.)
7869 let nodes_0_lock = nodes[0].node.id_to_peer.lock().unwrap();
7870 assert_eq!(nodes_0_lock.len(), 1);
7871 assert!(nodes_0_lock.contains_key(channel_id));
7873 // At this stage, `nodes[1]` has proposed a fee for the closing transaction in the
7874 // `handle_closing_signed` call above. As `nodes[1]` has not yet received the signature
7875 // from `nodes[0]` for the closing transaction with the proposed fee, the channel is
7876 // kept in the `nodes[1]`'s `id_to_peer` map.
7877 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
7878 assert_eq!(nodes_1_lock.len(), 1);
7879 assert!(nodes_1_lock.contains_key(channel_id));
7882 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()));
7884 // `nodes[0]` accepts `nodes[1]`'s proposed fee for the closing transaction, and
7885 // therefore has all it needs to fully close the channel (both signatures for the
7886 // closing transaction).
7887 // Assert that the channel is removed from `nodes[0]`'s `id_to_peer` map as it can be
7888 // fully closed by `nodes[0]`.
7889 assert_eq!(nodes[0].node.id_to_peer.lock().unwrap().len(), 0);
7891 // Assert that the channel is still in `nodes[1]`'s `id_to_peer` map, as `nodes[1]`
7892 // doesn't have `nodes[0]`'s signature for the closing transaction yet.
7893 let nodes_1_lock = nodes[1].node.id_to_peer.lock().unwrap();
7894 assert_eq!(nodes_1_lock.len(), 1);
7895 assert!(nodes_1_lock.contains_key(channel_id));
7898 let (_nodes_0_update, closing_signed_node_0) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
7900 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &closing_signed_node_0.unwrap());
7902 // Assert that the channel has now been removed from both parties `id_to_peer` map once
7903 // they both have everything required to fully close the channel.
7904 assert_eq!(nodes[1].node.id_to_peer.lock().unwrap().len(), 0);
7906 let (_nodes_1_update, _none) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
7908 check_closed_event!(nodes[0], 1, ClosureReason::CooperativeClosure);
7909 check_closed_event!(nodes[1], 1, ClosureReason::CooperativeClosure);
7913 #[cfg(all(any(test, feature = "_test_utils"), feature = "_bench_unstable"))]
7916 use chain::chainmonitor::{ChainMonitor, Persist};
7917 use chain::keysinterface::{KeysManager, KeysInterface, InMemorySigner};
7918 use ln::channelmanager::{BestBlock, ChainParameters, ChannelManager, PaymentHash, PaymentPreimage};
7919 use ln::features::{InitFeatures, InvoiceFeatures};
7920 use ln::functional_test_utils::*;
7921 use ln::msgs::{ChannelMessageHandler, Init};
7922 use routing::gossip::NetworkGraph;
7923 use routing::router::{PaymentParameters, get_route};
7924 use util::test_utils;
7925 use util::config::UserConfig;
7926 use util::events::{Event, MessageSendEvent, MessageSendEventsProvider};
7928 use bitcoin::hashes::Hash;
7929 use bitcoin::hashes::sha256::Hash as Sha256;
7930 use bitcoin::{Block, BlockHeader, Transaction, TxOut};
7932 use sync::{Arc, Mutex};
7936 struct NodeHolder<'a, P: Persist<InMemorySigner>> {
7937 node: &'a ChannelManager<InMemorySigner,
7938 &'a ChainMonitor<InMemorySigner, &'a test_utils::TestChainSource,
7939 &'a test_utils::TestBroadcaster, &'a test_utils::TestFeeEstimator,
7940 &'a test_utils::TestLogger, &'a P>,
7941 &'a test_utils::TestBroadcaster, &'a KeysManager,
7942 &'a test_utils::TestFeeEstimator, &'a test_utils::TestLogger>
7947 fn bench_sends(bench: &mut Bencher) {
7948 bench_two_sends(bench, test_utils::TestPersister::new(), test_utils::TestPersister::new());
7951 pub fn bench_two_sends<P: Persist<InMemorySigner>>(bench: &mut Bencher, persister_a: P, persister_b: P) {
7952 // Do a simple benchmark of sending a payment back and forth between two nodes.
7953 // Note that this is unrealistic as each payment send will require at least two fsync
7955 let network = bitcoin::Network::Testnet;
7956 let genesis_hash = bitcoin::blockdata::constants::genesis_block(network).header.block_hash();
7958 let tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), blocks: Arc::new(Mutex::new(Vec::new()))};
7959 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
7961 let mut config: UserConfig = Default::default();
7962 config.channel_handshake_config.minimum_depth = 1;
7964 let logger_a = test_utils::TestLogger::with_id("node a".to_owned());
7965 let chain_monitor_a = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_a);
7966 let seed_a = [1u8; 32];
7967 let keys_manager_a = KeysManager::new(&seed_a, 42, 42);
7968 let node_a = ChannelManager::new(&fee_estimator, &chain_monitor_a, &tx_broadcaster, &logger_a, &keys_manager_a, config.clone(), ChainParameters {
7970 best_block: BestBlock::from_genesis(network),
7972 let node_a_holder = NodeHolder { node: &node_a };
7974 let logger_b = test_utils::TestLogger::with_id("node a".to_owned());
7975 let chain_monitor_b = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_b);
7976 let seed_b = [2u8; 32];
7977 let keys_manager_b = KeysManager::new(&seed_b, 42, 42);
7978 let node_b = ChannelManager::new(&fee_estimator, &chain_monitor_b, &tx_broadcaster, &logger_b, &keys_manager_b, config.clone(), ChainParameters {
7980 best_block: BestBlock::from_genesis(network),
7982 let node_b_holder = NodeHolder { node: &node_b };
7984 node_a.peer_connected(&node_b.get_our_node_id(), &Init { features: InitFeatures::known(), remote_network_address: None });
7985 node_b.peer_connected(&node_a.get_our_node_id(), &Init { features: InitFeatures::known(), remote_network_address: None });
7986 node_a.create_channel(node_b.get_our_node_id(), 8_000_000, 100_000_000, 42, None).unwrap();
7987 node_b.handle_open_channel(&node_a.get_our_node_id(), InitFeatures::known(), &get_event_msg!(node_a_holder, MessageSendEvent::SendOpenChannel, node_b.get_our_node_id()));
7988 node_a.handle_accept_channel(&node_b.get_our_node_id(), InitFeatures::known(), &get_event_msg!(node_b_holder, MessageSendEvent::SendAcceptChannel, node_a.get_our_node_id()));
7991 if let Event::FundingGenerationReady { temporary_channel_id, output_script, .. } = get_event!(node_a_holder, Event::FundingGenerationReady) {
7992 tx = Transaction { version: 2, lock_time: 0, input: Vec::new(), output: vec![TxOut {
7993 value: 8_000_000, script_pubkey: output_script,
7995 node_a.funding_transaction_generated(&temporary_channel_id, &node_b.get_our_node_id(), tx.clone()).unwrap();
7996 } else { panic!(); }
7998 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()));
7999 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()));
8001 assert_eq!(&tx_broadcaster.txn_broadcasted.lock().unwrap()[..], &[tx.clone()]);
8004 header: BlockHeader { version: 0x20000000, prev_blockhash: genesis_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
8007 Listen::block_connected(&node_a, &block, 1);
8008 Listen::block_connected(&node_b, &block, 1);
8010 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()));
8011 let msg_events = node_a.get_and_clear_pending_msg_events();
8012 assert_eq!(msg_events.len(), 2);
8013 match msg_events[0] {
8014 MessageSendEvent::SendChannelReady { ref msg, .. } => {
8015 node_b.handle_channel_ready(&node_a.get_our_node_id(), msg);
8016 get_event_msg!(node_b_holder, MessageSendEvent::SendChannelUpdate, node_a.get_our_node_id());
8020 match msg_events[1] {
8021 MessageSendEvent::SendChannelUpdate { .. } => {},
8025 let dummy_graph = NetworkGraph::new(genesis_hash, &logger_a);
8027 let mut payment_count: u64 = 0;
8028 macro_rules! send_payment {
8029 ($node_a: expr, $node_b: expr) => {
8030 let usable_channels = $node_a.list_usable_channels();
8031 let payment_params = PaymentParameters::from_node_id($node_b.get_our_node_id())
8032 .with_features(InvoiceFeatures::known());
8033 let scorer = test_utils::TestScorer::with_penalty(0);
8034 let seed = [3u8; 32];
8035 let keys_manager = KeysManager::new(&seed, 42, 42);
8036 let random_seed_bytes = keys_manager.get_secure_random_bytes();
8037 let route = get_route(&$node_a.get_our_node_id(), &payment_params, &dummy_graph.read_only(),
8038 Some(&usable_channels.iter().map(|r| r).collect::<Vec<_>>()), 10_000, TEST_FINAL_CLTV, &logger_a, &scorer, &random_seed_bytes).unwrap();
8040 let mut payment_preimage = PaymentPreimage([0; 32]);
8041 payment_preimage.0[0..8].copy_from_slice(&payment_count.to_le_bytes());
8043 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
8044 let payment_secret = $node_b.create_inbound_payment_for_hash(payment_hash, None, 7200).unwrap();
8046 $node_a.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
8047 let payment_event = SendEvent::from_event($node_a.get_and_clear_pending_msg_events().pop().unwrap());
8048 $node_b.handle_update_add_htlc(&$node_a.get_our_node_id(), &payment_event.msgs[0]);
8049 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &payment_event.commitment_msg);
8050 let (raa, cs) = get_revoke_commit_msgs!(NodeHolder { node: &$node_b }, $node_a.get_our_node_id());
8051 $node_a.handle_revoke_and_ack(&$node_b.get_our_node_id(), &raa);
8052 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &cs);
8053 $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()));
8055 expect_pending_htlcs_forwardable!(NodeHolder { node: &$node_b });
8056 expect_payment_received!(NodeHolder { node: &$node_b }, payment_hash, payment_secret, 10_000);
8057 $node_b.claim_funds(payment_preimage);
8058 expect_payment_claimed!(NodeHolder { node: &$node_b }, payment_hash, 10_000);
8060 match $node_b.get_and_clear_pending_msg_events().pop().unwrap() {
8061 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
8062 assert_eq!(node_id, $node_a.get_our_node_id());
8063 $node_a.handle_update_fulfill_htlc(&$node_b.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8064 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &updates.commitment_signed);
8066 _ => panic!("Failed to generate claim event"),
8069 let (raa, cs) = get_revoke_commit_msgs!(NodeHolder { node: &$node_a }, $node_b.get_our_node_id());
8070 $node_b.handle_revoke_and_ack(&$node_a.get_our_node_id(), &raa);
8071 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &cs);
8072 $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()));
8074 expect_payment_sent!(NodeHolder { node: &$node_a }, payment_preimage);
8079 send_payment!(node_a, node_b);
8080 send_payment!(node_b, node_a);