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 routing::router::get_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).
21 use bitcoin::blockdata::block::{Block, BlockHeader};
22 use bitcoin::blockdata::transaction::Transaction;
23 use bitcoin::blockdata::constants::genesis_block;
24 use bitcoin::network::constants::Network;
26 use bitcoin::hashes::{Hash, HashEngine};
27 use bitcoin::hashes::hmac::{Hmac, HmacEngine};
28 use bitcoin::hashes::sha256::Hash as Sha256;
29 use bitcoin::hashes::sha256d::Hash as Sha256dHash;
30 use bitcoin::hashes::cmp::fixed_time_eq;
31 use bitcoin::hash_types::{BlockHash, Txid};
33 use bitcoin::secp256k1::key::{SecretKey,PublicKey};
34 use bitcoin::secp256k1::Secp256k1;
35 use bitcoin::secp256k1::ecdh::SharedSecret;
36 use bitcoin::secp256k1;
39 use chain::{Confirm, Watch, BestBlock};
40 use chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator};
41 use chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, ChannelMonitorUpdateStep, ChannelMonitorUpdateErr, HTLC_FAIL_BACK_BUFFER, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY, MonitorEvent, CLOSED_CHANNEL_UPDATE_ID};
42 use chain::transaction::{OutPoint, TransactionData};
43 // Since this struct is returned in `list_channels` methods, expose it here in case users want to
44 // construct one themselves.
45 use ln::{PaymentHash, PaymentPreimage, PaymentSecret};
46 use ln::channel::{Channel, ChannelError, ChannelUpdateStatus, UpdateFulfillCommitFetch};
47 use ln::features::{InitFeatures, NodeFeatures};
48 use routing::router::{Route, RouteHop};
50 use ln::msgs::NetAddress;
52 use ln::msgs::{ChannelMessageHandler, DecodeError, LightningError, OptionalField};
53 use chain::keysinterface::{Sign, KeysInterface, KeysManager, InMemorySigner};
54 use util::config::UserConfig;
55 use util::events::{EventHandler, EventsProvider, MessageSendEvent, MessageSendEventsProvider, ClosureReason};
56 use util::{byte_utils, events};
57 use util::ser::{BigSize, FixedLengthReader, Readable, ReadableArgs, MaybeReadable, Writeable, Writer};
58 use util::chacha20::{ChaCha20, ChaChaReader};
59 use util::logger::{Logger, Level};
60 use util::errors::APIError;
65 use core::cell::RefCell;
66 use io::{Cursor, Read};
67 use sync::{Arc, Condvar, Mutex, MutexGuard, RwLock, RwLockReadGuard};
68 use core::sync::atomic::{AtomicUsize, Ordering};
69 use core::time::Duration;
70 #[cfg(any(test, feature = "allow_wallclock_use"))]
71 use std::time::Instant;
74 // We hold various information about HTLC relay in the HTLC objects in Channel itself:
76 // Upon receipt of an HTLC from a peer, we'll give it a PendingHTLCStatus indicating if it should
77 // forward the HTLC with information it will give back to us when it does so, or if it should Fail
78 // the HTLC with the relevant message for the Channel to handle giving to the remote peer.
80 // Once said HTLC is committed in the Channel, if the PendingHTLCStatus indicated Forward, the
81 // Channel will return the PendingHTLCInfo back to us, and we will create an HTLCForwardInfo
82 // with it to track where it came from (in case of onwards-forward error), waiting a random delay
83 // before we forward it.
85 // We will then use HTLCForwardInfo's PendingHTLCInfo to construct an outbound HTLC, with a
86 // relevant HTLCSource::PreviousHopData filled in to indicate where it came from (which we can use
87 // to either fail-backwards or fulfill the HTLC backwards along the relevant path).
88 // Alternatively, we can fill an outbound HTLC with a HTLCSource::OutboundRoute indicating this is
89 // our payment, which we can use to decode errors or inform the user that the payment was sent.
91 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
92 enum PendingHTLCRouting {
94 onion_packet: msgs::OnionPacket,
95 short_channel_id: u64, // This should be NonZero<u64> eventually when we bump MSRV
98 payment_data: msgs::FinalOnionHopData,
99 incoming_cltv_expiry: u32, // Used to track when we should expire pending HTLCs that go unclaimed
102 payment_preimage: PaymentPreimage,
103 incoming_cltv_expiry: u32, // Used to track when we should expire pending HTLCs that go unclaimed
107 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
108 pub(super) struct PendingHTLCInfo {
109 routing: PendingHTLCRouting,
110 incoming_shared_secret: [u8; 32],
111 payment_hash: PaymentHash,
112 pub(super) amt_to_forward: u64,
113 pub(super) outgoing_cltv_value: u32,
116 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
117 pub(super) enum HTLCFailureMsg {
118 Relay(msgs::UpdateFailHTLC),
119 Malformed(msgs::UpdateFailMalformedHTLC),
122 /// Stores whether we can't forward an HTLC or relevant forwarding info
123 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
124 pub(super) enum PendingHTLCStatus {
125 Forward(PendingHTLCInfo),
126 Fail(HTLCFailureMsg),
129 pub(super) enum HTLCForwardInfo {
131 forward_info: PendingHTLCInfo,
133 // These fields are produced in `forward_htlcs()` and consumed in
134 // `process_pending_htlc_forwards()` for constructing the
135 // `HTLCSource::PreviousHopData` for failed and forwarded
137 prev_short_channel_id: u64,
139 prev_funding_outpoint: OutPoint,
143 err_packet: msgs::OnionErrorPacket,
147 /// Tracks the inbound corresponding to an outbound HTLC
148 #[derive(Clone, PartialEq)]
149 pub(crate) struct HTLCPreviousHopData {
150 short_channel_id: u64,
152 incoming_packet_shared_secret: [u8; 32],
154 // This field is consumed by `claim_funds_from_hop()` when updating a force-closed backwards
155 // channel with a preimage provided by the forward channel.
160 /// Contains a total_msat (which may differ from value if this is a Multi-Path Payment) and a
161 /// payment_secret which prevents path-probing attacks and can associate different HTLCs which
162 /// are part of the same payment.
163 Invoice(msgs::FinalOnionHopData),
164 /// Contains the payer-provided preimage.
165 Spontaneous(PaymentPreimage),
168 struct ClaimableHTLC {
169 prev_hop: HTLCPreviousHopData,
172 onion_payload: OnionPayload,
175 /// A payment identifier used to uniquely identify a payment to LDK.
176 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
177 pub struct PaymentId(pub [u8; 32]);
179 impl Writeable for PaymentId {
180 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
185 impl Readable for PaymentId {
186 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
187 let buf: [u8; 32] = Readable::read(r)?;
191 /// Tracks the inbound corresponding to an outbound HTLC
192 #[derive(Clone, PartialEq)]
193 pub(crate) enum HTLCSource {
194 PreviousHopData(HTLCPreviousHopData),
197 session_priv: SecretKey,
198 /// Technically we can recalculate this from the route, but we cache it here to avoid
199 /// doing a double-pass on route when we get a failure back
200 first_hop_htlc_msat: u64,
201 payment_id: PaymentId,
206 pub fn dummy() -> Self {
207 HTLCSource::OutboundRoute {
209 session_priv: SecretKey::from_slice(&[1; 32]).unwrap(),
210 first_hop_htlc_msat: 0,
211 payment_id: PaymentId([2; 32]),
216 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
217 pub(super) enum HTLCFailReason {
219 err: msgs::OnionErrorPacket,
227 /// Return value for claim_funds_from_hop
228 enum ClaimFundsFromHop {
230 MonitorUpdateFail(PublicKey, MsgHandleErrInternal, Option<u64>),
235 type ShutdownResult = (Option<(OutPoint, ChannelMonitorUpdate)>, Vec<(HTLCSource, PaymentHash)>);
237 /// Error type returned across the channel_state mutex boundary. When an Err is generated for a
238 /// Channel, we generally end up with a ChannelError::Close for which we have to close the channel
239 /// immediately (ie with no further calls on it made). Thus, this step happens inside a
240 /// channel_state lock. We then return the set of things that need to be done outside the lock in
241 /// this struct and call handle_error!() on it.
243 struct MsgHandleErrInternal {
244 err: msgs::LightningError,
245 chan_id: Option<[u8; 32]>, // If Some a channel of ours has been closed
246 shutdown_finish: Option<(ShutdownResult, Option<msgs::ChannelUpdate>)>,
248 impl MsgHandleErrInternal {
250 fn send_err_msg_no_close(err: String, channel_id: [u8; 32]) -> Self {
252 err: LightningError {
254 action: msgs::ErrorAction::SendErrorMessage {
255 msg: msgs::ErrorMessage {
262 shutdown_finish: None,
266 fn ignore_no_close(err: String) -> Self {
268 err: LightningError {
270 action: msgs::ErrorAction::IgnoreError,
273 shutdown_finish: None,
277 fn from_no_close(err: msgs::LightningError) -> Self {
278 Self { err, chan_id: None, shutdown_finish: None }
281 fn from_finish_shutdown(err: String, channel_id: [u8; 32], shutdown_res: ShutdownResult, channel_update: Option<msgs::ChannelUpdate>) -> Self {
283 err: LightningError {
285 action: msgs::ErrorAction::SendErrorMessage {
286 msg: msgs::ErrorMessage {
292 chan_id: Some(channel_id),
293 shutdown_finish: Some((shutdown_res, channel_update)),
297 fn from_chan_no_close(err: ChannelError, channel_id: [u8; 32]) -> Self {
300 ChannelError::Warn(msg) => LightningError {
302 action: msgs::ErrorAction::IgnoreError,
304 ChannelError::Ignore(msg) => LightningError {
306 action: msgs::ErrorAction::IgnoreError,
308 ChannelError::Close(msg) => LightningError {
310 action: msgs::ErrorAction::SendErrorMessage {
311 msg: msgs::ErrorMessage {
317 ChannelError::CloseDelayBroadcast(msg) => LightningError {
319 action: msgs::ErrorAction::SendErrorMessage {
320 msg: msgs::ErrorMessage {
328 shutdown_finish: None,
333 /// We hold back HTLCs we intend to relay for a random interval greater than this (see
334 /// Event::PendingHTLCsForwardable for the API guidelines indicating how long should be waited).
335 /// This provides some limited amount of privacy. Ideally this would range from somewhere like one
336 /// second to 30 seconds, but people expect lightning to be, you know, kinda fast, sadly.
337 const MIN_HTLC_RELAY_HOLDING_CELL_MILLIS: u64 = 100;
339 /// For events which result in both a RevokeAndACK and a CommitmentUpdate, by default they should
340 /// be sent in the order they appear in the return value, however sometimes the order needs to be
341 /// variable at runtime (eg Channel::channel_reestablish needs to re-send messages in the order
342 /// they were originally sent). In those cases, this enum is also returned.
343 #[derive(Clone, PartialEq)]
344 pub(super) enum RAACommitmentOrder {
345 /// Send the CommitmentUpdate messages first
347 /// Send the RevokeAndACK message first
351 // Note this is only exposed in cfg(test):
352 pub(super) struct ChannelHolder<Signer: Sign> {
353 pub(super) by_id: HashMap<[u8; 32], Channel<Signer>>,
354 pub(super) short_to_id: HashMap<u64, [u8; 32]>,
355 /// short channel id -> forward infos. Key of 0 means payments received
356 /// Note that while this is held in the same mutex as the channels themselves, no consistency
357 /// guarantees are made about the existence of a channel with the short id here, nor the short
358 /// ids in the PendingHTLCInfo!
359 pub(super) forward_htlcs: HashMap<u64, Vec<HTLCForwardInfo>>,
360 /// Map from payment hash to any HTLCs which are to us and can be failed/claimed by the user.
361 /// Note that while this is held in the same mutex as the channels themselves, no consistency
362 /// guarantees are made about the channels given here actually existing anymore by the time you
364 claimable_htlcs: HashMap<PaymentHash, Vec<ClaimableHTLC>>,
365 /// Messages to send to peers - pushed to in the same lock that they are generated in (except
366 /// for broadcast messages, where ordering isn't as strict).
367 pub(super) pending_msg_events: Vec<MessageSendEvent>,
370 /// Events which we process internally but cannot be procsesed immediately at the generation site
371 /// for some reason. They are handled in timer_tick_occurred, so may be processed with
372 /// quite some time lag.
373 enum BackgroundEvent {
374 /// Handle a ChannelMonitorUpdate that closes a channel, broadcasting its current latest holder
375 /// commitment transaction.
376 ClosingMonitorUpdate((OutPoint, ChannelMonitorUpdate)),
379 /// State we hold per-peer. In the future we should put channels in here, but for now we only hold
380 /// the latest Init features we heard from the peer.
382 latest_features: InitFeatures,
385 /// Stores a PaymentSecret and any other data we may need to validate an inbound payment is
386 /// actually ours and not some duplicate HTLC sent to us by a node along the route.
388 /// For users who don't want to bother doing their own payment preimage storage, we also store that
390 struct PendingInboundPayment {
391 /// The payment secret that the sender must use for us to accept this payment
392 payment_secret: PaymentSecret,
393 /// Time at which this HTLC expires - blocks with a header time above this value will result in
394 /// this payment being removed.
396 /// Arbitrary identifier the user specifies (or not)
397 user_payment_id: u64,
398 // Other required attributes of the payment, optionally enforced:
399 payment_preimage: Option<PaymentPreimage>,
400 min_value_msat: Option<u64>,
403 /// Stores the session_priv for each part of a payment that is still pending. For versions 0.0.102
404 /// and later, also stores information for retrying the payment.
405 pub(crate) enum PendingOutboundPayment {
407 session_privs: HashSet<[u8; 32]>,
410 session_privs: HashSet<[u8; 32]>,
411 payment_hash: PaymentHash,
412 payment_secret: Option<PaymentSecret>,
413 pending_amt_msat: u64,
414 /// The total payment amount across all paths, used to verify that a retry is not overpaying.
416 /// Our best known block height at the time this payment was initiated.
417 starting_block_height: u32,
421 impl PendingOutboundPayment {
422 fn remove(&mut self, session_priv: &[u8; 32], part_amt_msat: u64) -> bool {
423 let remove_res = match self {
424 PendingOutboundPayment::Legacy { session_privs } |
425 PendingOutboundPayment::Retryable { session_privs, .. } => {
426 session_privs.remove(session_priv)
430 if let PendingOutboundPayment::Retryable { ref mut pending_amt_msat, .. } = self {
431 *pending_amt_msat -= part_amt_msat;
437 fn insert(&mut self, session_priv: [u8; 32], part_amt_msat: u64) -> bool {
438 let insert_res = match self {
439 PendingOutboundPayment::Legacy { session_privs } |
440 PendingOutboundPayment::Retryable { session_privs, .. } => {
441 session_privs.insert(session_priv)
445 if let PendingOutboundPayment::Retryable { ref mut pending_amt_msat, .. } = self {
446 *pending_amt_msat += part_amt_msat;
452 fn remaining_parts(&self) -> usize {
454 PendingOutboundPayment::Legacy { session_privs } |
455 PendingOutboundPayment::Retryable { session_privs, .. } => {
462 /// SimpleArcChannelManager is useful when you need a ChannelManager with a static lifetime, e.g.
463 /// when you're using lightning-net-tokio (since tokio::spawn requires parameters with static
464 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
465 /// SimpleRefChannelManager is the more appropriate type. Defining these type aliases prevents
466 /// issues such as overly long function definitions. Note that the ChannelManager can take any
467 /// type that implements KeysInterface for its keys manager, but this type alias chooses the
468 /// concrete type of the KeysManager.
469 pub type SimpleArcChannelManager<M, T, F, L> = ChannelManager<InMemorySigner, Arc<M>, Arc<T>, Arc<KeysManager>, Arc<F>, Arc<L>>;
471 /// SimpleRefChannelManager is a type alias for a ChannelManager reference, and is the reference
472 /// counterpart to the SimpleArcChannelManager type alias. Use this type by default when you don't
473 /// need a ChannelManager with a static lifetime. You'll need a static lifetime in cases such as
474 /// usage of lightning-net-tokio (since tokio::spawn requires parameters with static lifetimes).
475 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
476 /// helps with issues such as long function definitions. Note that the ChannelManager can take any
477 /// type that implements KeysInterface for its keys manager, but this type alias chooses the
478 /// concrete type of the KeysManager.
479 pub type SimpleRefChannelManager<'a, 'b, 'c, 'd, 'e, M, T, F, L> = ChannelManager<InMemorySigner, &'a M, &'b T, &'c KeysManager, &'d F, &'e L>;
481 /// Manager which keeps track of a number of channels and sends messages to the appropriate
482 /// channel, also tracking HTLC preimages and forwarding onion packets appropriately.
484 /// Implements ChannelMessageHandler, handling the multi-channel parts and passing things through
485 /// to individual Channels.
487 /// Implements Writeable to write out all channel state to disk. Implies peer_disconnected() for
488 /// all peers during write/read (though does not modify this instance, only the instance being
489 /// serialized). This will result in any channels which have not yet exchanged funding_created (ie
490 /// called funding_transaction_generated for outbound channels).
492 /// Note that you can be a bit lazier about writing out ChannelManager than you can be with
493 /// ChannelMonitors. With ChannelMonitors you MUST write each monitor update out to disk before
494 /// returning from chain::Watch::watch_/update_channel, with ChannelManagers, writing updates
495 /// happens out-of-band (and will prevent any other ChannelManager operations from occurring during
496 /// the serialization process). If the deserialized version is out-of-date compared to the
497 /// ChannelMonitors passed by reference to read(), those channels will be force-closed based on the
498 /// ChannelMonitor state and no funds will be lost (mod on-chain transaction fees).
500 /// Note that the deserializer is only implemented for (BlockHash, ChannelManager), which
501 /// tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
502 /// the "reorg path" (ie call block_disconnected() until you get to a common block and then call
503 /// block_connected() to step towards your best block) upon deserialization before using the
506 /// Note that ChannelManager is responsible for tracking liveness of its channels and generating
507 /// ChannelUpdate messages informing peers that the channel is temporarily disabled. To avoid
508 /// spam due to quick disconnection/reconnection, updates are not sent until the channel has been
509 /// offline for a full minute. In order to track this, you must call
510 /// timer_tick_occurred roughly once per minute, though it doesn't have to be perfect.
512 /// Rather than using a plain ChannelManager, it is preferable to use either a SimpleArcChannelManager
513 /// a SimpleRefChannelManager, for conciseness. See their documentation for more details, but
514 /// essentially you should default to using a SimpleRefChannelManager, and use a
515 /// SimpleArcChannelManager when you require a ChannelManager with a static lifetime, such as when
516 /// you're using lightning-net-tokio.
517 pub struct ChannelManager<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
518 where M::Target: chain::Watch<Signer>,
519 T::Target: BroadcasterInterface,
520 K::Target: KeysInterface<Signer = Signer>,
521 F::Target: FeeEstimator,
524 default_configuration: UserConfig,
525 genesis_hash: BlockHash,
531 pub(super) best_block: RwLock<BestBlock>,
533 best_block: RwLock<BestBlock>,
534 secp_ctx: Secp256k1<secp256k1::All>,
536 #[cfg(any(test, feature = "_test_utils"))]
537 pub(super) channel_state: Mutex<ChannelHolder<Signer>>,
538 #[cfg(not(any(test, feature = "_test_utils")))]
539 channel_state: Mutex<ChannelHolder<Signer>>,
541 /// Storage for PaymentSecrets and any requirements on future inbound payments before we will
542 /// expose them to users via a PaymentReceived event. HTLCs which do not meet the requirements
543 /// here are failed when we process them as pending-forwardable-HTLCs, and entries are removed
544 /// after we generate a PaymentReceived upon receipt of all MPP parts or when they time out.
545 /// Locked *after* channel_state.
546 pending_inbound_payments: Mutex<HashMap<PaymentHash, PendingInboundPayment>>,
548 /// The session_priv bytes and retry metadata of outbound payments which are pending resolution.
549 /// The authoritative state of these HTLCs resides either within Channels or ChannelMonitors
550 /// (if the channel has been force-closed), however we track them here to prevent duplicative
551 /// PaymentSent/PaymentPathFailed events. Specifically, in the case of a duplicative
552 /// update_fulfill_htlc message after a reconnect, we may "claim" a payment twice.
553 /// Additionally, because ChannelMonitors are often not re-serialized after connecting block(s)
554 /// which may generate a claim event, we may receive similar duplicate claim/fail MonitorEvents
555 /// after reloading from disk while replaying blocks against ChannelMonitors.
557 /// See `PendingOutboundPayment` documentation for more info.
559 /// Locked *after* channel_state.
560 pending_outbound_payments: Mutex<HashMap<PaymentId, PendingOutboundPayment>>,
562 our_network_key: SecretKey,
563 our_network_pubkey: PublicKey,
565 /// Used to track the last value sent in a node_announcement "timestamp" field. We ensure this
566 /// value increases strictly since we don't assume access to a time source.
567 last_node_announcement_serial: AtomicUsize,
569 /// The highest block timestamp we've seen, which is usually a good guess at the current time.
570 /// Assuming most miners are generating blocks with reasonable timestamps, this shouldn't be
571 /// very far in the past, and can only ever be up to two hours in the future.
572 highest_seen_timestamp: AtomicUsize,
574 /// The bulk of our storage will eventually be here (channels and message queues and the like).
575 /// If we are connected to a peer we always at least have an entry here, even if no channels
576 /// are currently open with that peer.
577 /// Because adding or removing an entry is rare, we usually take an outer read lock and then
578 /// operate on the inner value freely. Sadly, this prevents parallel operation when opening a
581 /// If also holding `channel_state` lock, must lock `channel_state` prior to `per_peer_state`.
582 per_peer_state: RwLock<HashMap<PublicKey, Mutex<PeerState>>>,
584 pending_events: Mutex<Vec<events::Event>>,
585 pending_background_events: Mutex<Vec<BackgroundEvent>>,
586 /// Used when we have to take a BIG lock to make sure everything is self-consistent.
587 /// Essentially just when we're serializing ourselves out.
588 /// Taken first everywhere where we are making changes before any other locks.
589 /// When acquiring this lock in read mode, rather than acquiring it directly, call
590 /// `PersistenceNotifierGuard::notify_on_drop(..)` and pass the lock to it, to ensure the
591 /// PersistenceNotifier the lock contains sends out a notification when the lock is released.
592 total_consistency_lock: RwLock<()>,
594 persistence_notifier: PersistenceNotifier,
601 /// Chain-related parameters used to construct a new `ChannelManager`.
603 /// Typically, the block-specific parameters are derived from the best block hash for the network,
604 /// as a newly constructed `ChannelManager` will not have created any channels yet. These parameters
605 /// are not needed when deserializing a previously constructed `ChannelManager`.
606 #[derive(Clone, Copy, PartialEq)]
607 pub struct ChainParameters {
608 /// The network for determining the `chain_hash` in Lightning messages.
609 pub network: Network,
611 /// The hash and height of the latest block successfully connected.
613 /// Used to track on-chain channel funding outputs and send payments with reliable timelocks.
614 pub best_block: BestBlock,
617 #[derive(Copy, Clone, PartialEq)]
623 /// Whenever we release the `ChannelManager`'s `total_consistency_lock`, from read mode, it is
624 /// desirable to notify any listeners on `await_persistable_update_timeout`/
625 /// `await_persistable_update` when new updates are available for persistence. Therefore, this
626 /// struct is responsible for locking the total consistency lock and, upon going out of scope,
627 /// sending the aforementioned notification (since the lock being released indicates that the
628 /// updates are ready for persistence).
630 /// We allow callers to either always notify by constructing with `notify_on_drop` or choose to
631 /// notify or not based on whether relevant changes have been made, providing a closure to
632 /// `optionally_notify` which returns a `NotifyOption`.
633 struct PersistenceNotifierGuard<'a, F: Fn() -> NotifyOption> {
634 persistence_notifier: &'a PersistenceNotifier,
636 // We hold onto this result so the lock doesn't get released immediately.
637 _read_guard: RwLockReadGuard<'a, ()>,
640 impl<'a> PersistenceNotifierGuard<'a, fn() -> NotifyOption> { // We don't care what the concrete F is here, it's unused
641 fn notify_on_drop(lock: &'a RwLock<()>, notifier: &'a PersistenceNotifier) -> PersistenceNotifierGuard<'a, impl Fn() -> NotifyOption> {
642 PersistenceNotifierGuard::optionally_notify(lock, notifier, || -> NotifyOption { NotifyOption::DoPersist })
645 fn optionally_notify<F: Fn() -> NotifyOption>(lock: &'a RwLock<()>, notifier: &'a PersistenceNotifier, persist_check: F) -> PersistenceNotifierGuard<'a, F> {
646 let read_guard = lock.read().unwrap();
648 PersistenceNotifierGuard {
649 persistence_notifier: notifier,
650 should_persist: persist_check,
651 _read_guard: read_guard,
656 impl<'a, F: Fn() -> NotifyOption> Drop for PersistenceNotifierGuard<'a, F> {
658 if (self.should_persist)() == NotifyOption::DoPersist {
659 self.persistence_notifier.notify();
664 /// The amount of time in blocks we require our counterparty wait to claim their money (ie time
665 /// between when we, or our watchtower, must check for them having broadcast a theft transaction).
667 /// This can be increased (but not decreased) through [`ChannelHandshakeConfig::our_to_self_delay`]
669 /// [`ChannelHandshakeConfig::our_to_self_delay`]: crate::util::config::ChannelHandshakeConfig::our_to_self_delay
670 pub const BREAKDOWN_TIMEOUT: u16 = 6 * 24;
671 /// The amount of time in blocks we're willing to wait to claim money back to us. This matches
672 /// the maximum required amount in lnd as of March 2021.
673 pub(crate) const MAX_LOCAL_BREAKDOWN_TIMEOUT: u16 = 2 * 6 * 24 * 7;
675 /// The minimum number of blocks between an inbound HTLC's CLTV and the corresponding outbound
676 /// HTLC's CLTV. The current default represents roughly seven hours of blocks at six blocks/hour.
678 /// This can be increased (but not decreased) through [`ChannelConfig::cltv_expiry_delta`]
680 /// [`ChannelConfig::cltv_expiry_delta`]: crate::util::config::ChannelConfig::cltv_expiry_delta
681 // This should always be a few blocks greater than channelmonitor::CLTV_CLAIM_BUFFER,
682 // i.e. the node we forwarded the payment on to should always have enough room to reliably time out
683 // the HTLC via a full update_fail_htlc/commitment_signed dance before we hit the
684 // CLTV_CLAIM_BUFFER point (we static assert that it's at least 3 blocks more).
685 pub const MIN_CLTV_EXPIRY_DELTA: u16 = 6*7;
686 pub(super) const CLTV_FAR_FAR_AWAY: u32 = 6 * 24 * 7; //TODO?
688 /// Minimum CLTV difference between the current block height and received inbound payments.
689 /// Invoices generated for payment to us must set their `min_final_cltv_expiry` field to at least
691 // Note that we fail if exactly HTLC_FAIL_BACK_BUFFER + 1 was used, so we need to add one for
692 // any payments to succeed. Further, we don't want payments to fail if a block was found while
693 // a payment was being routed, so we add an extra block to be safe.
694 pub const MIN_FINAL_CLTV_EXPIRY: u32 = HTLC_FAIL_BACK_BUFFER + 3;
696 // Check that our CLTV_EXPIRY is at least CLTV_CLAIM_BUFFER + ANTI_REORG_DELAY + LATENCY_GRACE_PERIOD_BLOCKS,
697 // ie that if the next-hop peer fails the HTLC within
698 // LATENCY_GRACE_PERIOD_BLOCKS then we'll still have CLTV_CLAIM_BUFFER left to timeout it onchain,
699 // then waiting ANTI_REORG_DELAY to be reorg-safe on the outbound HLTC and
700 // failing the corresponding htlc backward, and us now seeing the last block of ANTI_REORG_DELAY before
701 // LATENCY_GRACE_PERIOD_BLOCKS.
704 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;
706 // Check for ability of an attacker to make us fail on-chain by delaying an HTLC claim. See
707 // ChannelMonitor::should_broadcast_holder_commitment_txn for a description of why this is needed.
710 const CHECK_CLTV_EXPIRY_SANITY_2: u32 = MIN_CLTV_EXPIRY_DELTA as u32 - LATENCY_GRACE_PERIOD_BLOCKS - 2*CLTV_CLAIM_BUFFER;
712 /// Information needed for constructing an invoice route hint for this channel.
713 #[derive(Clone, Debug, PartialEq)]
714 pub struct CounterpartyForwardingInfo {
715 /// Base routing fee in millisatoshis.
716 pub fee_base_msat: u32,
717 /// Amount in millionths of a satoshi the channel will charge per transferred satoshi.
718 pub fee_proportional_millionths: u32,
719 /// The minimum difference in cltv_expiry between an ingoing HTLC and its outgoing counterpart,
720 /// such that the outgoing HTLC is forwardable to this counterparty. See `msgs::ChannelUpdate`'s
721 /// `cltv_expiry_delta` for more details.
722 pub cltv_expiry_delta: u16,
725 /// Channel parameters which apply to our counterparty. These are split out from [`ChannelDetails`]
726 /// to better separate parameters.
727 #[derive(Clone, Debug, PartialEq)]
728 pub struct ChannelCounterparty {
729 /// The node_id of our counterparty
730 pub node_id: PublicKey,
731 /// The Features the channel counterparty provided upon last connection.
732 /// Useful for routing as it is the most up-to-date copy of the counterparty's features and
733 /// many routing-relevant features are present in the init context.
734 pub features: InitFeatures,
735 /// The value, in satoshis, that must always be held in the channel for our counterparty. This
736 /// value ensures that if our counterparty broadcasts a revoked state, we can punish them by
737 /// claiming at least this value on chain.
739 /// This value is not included in [`inbound_capacity_msat`] as it can never be spent.
741 /// [`inbound_capacity_msat`]: ChannelDetails::inbound_capacity_msat
742 pub unspendable_punishment_reserve: u64,
743 /// Information on the fees and requirements that the counterparty requires when forwarding
744 /// payments to us through this channel.
745 pub forwarding_info: Option<CounterpartyForwardingInfo>,
748 /// Details of a channel, as returned by ChannelManager::list_channels and ChannelManager::list_usable_channels
749 #[derive(Clone, Debug, PartialEq)]
750 pub struct ChannelDetails {
751 /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
752 /// thereafter this is the txid of the funding transaction xor the funding transaction output).
753 /// Note that this means this value is *not* persistent - it can change once during the
754 /// lifetime of the channel.
755 pub channel_id: [u8; 32],
756 /// Parameters which apply to our counterparty. See individual fields for more information.
757 pub counterparty: ChannelCounterparty,
758 /// The Channel's funding transaction output, if we've negotiated the funding transaction with
759 /// our counterparty already.
761 /// Note that, if this has been set, `channel_id` will be equivalent to
762 /// `funding_txo.unwrap().to_channel_id()`.
763 pub funding_txo: Option<OutPoint>,
764 /// The position of the funding transaction in the chain. None if the funding transaction has
765 /// not yet been confirmed and the channel fully opened.
766 pub short_channel_id: Option<u64>,
767 /// The value, in satoshis, of this channel as appears in the funding output
768 pub channel_value_satoshis: u64,
769 /// The value, in satoshis, that must always be held in the channel for us. This value ensures
770 /// that if we broadcast a revoked state, our counterparty can punish us by claiming at least
771 /// this value on chain.
773 /// This value is not included in [`outbound_capacity_msat`] as it can never be spent.
775 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
777 /// [`outbound_capacity_msat`]: ChannelDetails::outbound_capacity_msat
778 pub unspendable_punishment_reserve: Option<u64>,
779 /// The user_id passed in to create_channel, or 0 if the channel was inbound.
781 /// The available outbound capacity for sending HTLCs to the remote peer. This does not include
782 /// any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
783 /// available for inclusion in new outbound HTLCs). This further does not include any pending
784 /// outgoing HTLCs which are awaiting some other resolution to be sent.
786 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
787 /// conflict-avoidance policy, exactly this amount is not likely to be spendable. However, we
788 /// should be able to spend nearly this amount.
789 pub outbound_capacity_msat: u64,
790 /// The available inbound capacity for the remote peer to send HTLCs to us. This does not
791 /// include any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
792 /// available for inclusion in new inbound HTLCs).
793 /// Note that there are some corner cases not fully handled here, so the actual available
794 /// inbound capacity may be slightly higher than this.
796 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
797 /// counterparty's conflict-avoidance policy, exactly this amount is not likely to be spendable.
798 /// However, our counterparty should be able to spend nearly this amount.
799 pub inbound_capacity_msat: u64,
800 /// The number of required confirmations on the funding transaction before the funding will be
801 /// considered "locked". This number is selected by the channel fundee (i.e. us if
802 /// [`is_outbound`] is *not* set), and can be selected for inbound channels with
803 /// [`ChannelHandshakeConfig::minimum_depth`] or limited for outbound channels with
804 /// [`ChannelHandshakeLimits::max_minimum_depth`].
806 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
808 /// [`is_outbound`]: ChannelDetails::is_outbound
809 /// [`ChannelHandshakeConfig::minimum_depth`]: crate::util::config::ChannelHandshakeConfig::minimum_depth
810 /// [`ChannelHandshakeLimits::max_minimum_depth`]: crate::util::config::ChannelHandshakeLimits::max_minimum_depth
811 pub confirmations_required: Option<u32>,
812 /// The number of blocks (after our commitment transaction confirms) that we will need to wait
813 /// until we can claim our funds after we force-close the channel. During this time our
814 /// counterparty is allowed to punish us if we broadcasted a stale state. If our counterparty
815 /// force-closes the channel and broadcasts a commitment transaction we do not have to wait any
816 /// time to claim our non-HTLC-encumbered funds.
818 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
819 pub force_close_spend_delay: Option<u16>,
820 /// True if the channel was initiated (and thus funded) by us.
821 pub is_outbound: bool,
822 /// True if the channel is confirmed, funding_locked messages have been exchanged, and the
823 /// channel is not currently being shut down. `funding_locked` message exchange implies the
824 /// required confirmation count has been reached (and we were connected to the peer at some
825 /// point after the funding transaction received enough confirmations). The required
826 /// confirmation count is provided in [`confirmations_required`].
828 /// [`confirmations_required`]: ChannelDetails::confirmations_required
829 pub is_funding_locked: bool,
830 /// True if the channel is (a) confirmed and funding_locked messages have been exchanged, (b)
831 /// the peer is connected, and (c) the channel is not currently negotiating a shutdown.
833 /// This is a strict superset of `is_funding_locked`.
835 /// True if this channel is (or will be) publicly-announced.
839 /// If a payment fails to send, it can be in one of several states. This enum is returned as the
840 /// Err() type describing which state the payment is in, see the description of individual enum
842 #[derive(Clone, Debug)]
843 pub enum PaymentSendFailure {
844 /// A parameter which was passed to send_payment was invalid, preventing us from attempting to
845 /// send the payment at all. No channel state has been changed or messages sent to peers, and
846 /// once you've changed the parameter at error, you can freely retry the payment in full.
847 ParameterError(APIError),
848 /// A parameter in a single path which was passed to send_payment was invalid, preventing us
849 /// from attempting to send the payment at all. No channel state has been changed or messages
850 /// sent to peers, and once you've changed the parameter at error, you can freely retry the
853 /// The results here are ordered the same as the paths in the route object which was passed to
855 PathParameterError(Vec<Result<(), APIError>>),
856 /// All paths which were attempted failed to send, with no channel state change taking place.
857 /// You can freely retry the payment in full (though you probably want to do so over different
858 /// paths than the ones selected).
859 AllFailedRetrySafe(Vec<APIError>),
860 /// Some paths which were attempted failed to send, though possibly not all. At least some
861 /// paths have irrevocably committed to the HTLC and retrying the payment in full would result
862 /// in over-/re-payment.
864 /// The results here are ordered the same as the paths in the route object which was passed to
865 /// send_payment, and any Errs which are not APIError::MonitorUpdateFailed can be safely
866 /// retried (though there is currently no API with which to do so).
868 /// Any entries which contain Err(APIError::MonitorUpdateFailed) or Ok(()) MUST NOT be retried
869 /// as they will result in over-/re-payment. These HTLCs all either successfully sent (in the
870 /// case of Ok(())) or will send once channel_monitor_updated is called on the next-hop channel
871 /// with the latest update_id.
872 PartialFailure(Vec<Result<(), APIError>>),
875 macro_rules! handle_error {
876 ($self: ident, $internal: expr, $counterparty_node_id: expr) => {
879 Err(MsgHandleErrInternal { err, chan_id, shutdown_finish }) => {
880 #[cfg(debug_assertions)]
882 // In testing, ensure there are no deadlocks where the lock is already held upon
883 // entering the macro.
884 assert!($self.channel_state.try_lock().is_ok());
885 assert!($self.pending_events.try_lock().is_ok());
888 let mut msg_events = Vec::with_capacity(2);
890 if let Some((shutdown_res, update_option)) = shutdown_finish {
891 $self.finish_force_close_channel(shutdown_res);
892 if let Some(update) = update_option {
893 msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
897 if let Some(channel_id) = chan_id {
898 $self.pending_events.lock().unwrap().push(events::Event::ChannelClosed { channel_id, reason: ClosureReason::ProcessingError { err: err.err.clone() } });
902 log_error!($self.logger, "{}", err.err);
903 if let msgs::ErrorAction::IgnoreError = err.action {
905 msg_events.push(events::MessageSendEvent::HandleError {
906 node_id: $counterparty_node_id,
907 action: err.action.clone()
911 if !msg_events.is_empty() {
912 $self.channel_state.lock().unwrap().pending_msg_events.append(&mut msg_events);
915 // Return error in case higher-API need one
922 /// Returns (boolean indicating if we should remove the Channel object from memory, a mapped error)
923 macro_rules! convert_chan_err {
924 ($self: ident, $err: expr, $short_to_id: expr, $channel: expr, $channel_id: expr) => {
926 ChannelError::Warn(msg) => {
927 //TODO: Once warning messages are merged, we should send a `warning` message to our
929 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore(msg), $channel_id.clone()))
931 ChannelError::Ignore(msg) => {
932 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore(msg), $channel_id.clone()))
934 ChannelError::Close(msg) => {
935 log_error!($self.logger, "Closing channel {} due to close-required error: {}", log_bytes!($channel_id[..]), msg);
936 if let Some(short_id) = $channel.get_short_channel_id() {
937 $short_to_id.remove(&short_id);
939 let shutdown_res = $channel.force_shutdown(true);
940 (true, MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, shutdown_res, $self.get_channel_update_for_broadcast(&$channel).ok()))
942 ChannelError::CloseDelayBroadcast(msg) => {
943 log_error!($self.logger, "Channel {} need to be shutdown but closing transactions not broadcast due to {}", log_bytes!($channel_id[..]), msg);
944 if let Some(short_id) = $channel.get_short_channel_id() {
945 $short_to_id.remove(&short_id);
947 let shutdown_res = $channel.force_shutdown(false);
948 (true, MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, shutdown_res, $self.get_channel_update_for_broadcast(&$channel).ok()))
954 macro_rules! break_chan_entry {
955 ($self: ident, $res: expr, $channel_state: expr, $entry: expr) => {
959 let (drop, res) = convert_chan_err!($self, e, $channel_state.short_to_id, $entry.get_mut(), $entry.key());
961 $entry.remove_entry();
969 macro_rules! try_chan_entry {
970 ($self: ident, $res: expr, $channel_state: expr, $entry: expr) => {
974 let (drop, res) = convert_chan_err!($self, e, $channel_state.short_to_id, $entry.get_mut(), $entry.key());
976 $entry.remove_entry();
984 macro_rules! remove_channel {
985 ($channel_state: expr, $entry: expr) => {
987 let channel = $entry.remove_entry().1;
988 if let Some(short_id) = channel.get_short_channel_id() {
989 $channel_state.short_to_id.remove(&short_id);
996 macro_rules! handle_monitor_err {
997 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
998 handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment, Vec::new(), Vec::new())
1000 ($self: ident, $err: expr, $short_to_id: expr, $chan: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr, $failed_forwards: expr, $failed_fails: expr, $chan_id: expr) => {
1002 ChannelMonitorUpdateErr::PermanentFailure => {
1003 log_error!($self.logger, "Closing channel {} due to monitor update ChannelMonitorUpdateErr::PermanentFailure", log_bytes!($chan_id[..]));
1004 if let Some(short_id) = $chan.get_short_channel_id() {
1005 $short_to_id.remove(&short_id);
1007 // TODO: $failed_fails is dropped here, which will cause other channels to hit the
1008 // chain in a confused state! We need to move them into the ChannelMonitor which
1009 // will be responsible for failing backwards once things confirm on-chain.
1010 // It's ok that we drop $failed_forwards here - at this point we'd rather they
1011 // broadcast HTLC-Timeout and pay the associated fees to get their funds back than
1012 // us bother trying to claim it just to forward on to another peer. If we're
1013 // splitting hairs we'd prefer to claim payments that were to us, but we haven't
1014 // given up the preimage yet, so might as well just wait until the payment is
1015 // retried, avoiding the on-chain fees.
1016 let res: Result<(), _> = Err(MsgHandleErrInternal::from_finish_shutdown("ChannelMonitor storage failure".to_owned(), *$chan_id,
1017 $chan.force_shutdown(true), $self.get_channel_update_for_broadcast(&$chan).ok() ));
1020 ChannelMonitorUpdateErr::TemporaryFailure => {
1021 log_info!($self.logger, "Disabling channel {} due to monitor update TemporaryFailure. On restore will send {} and process {} forwards and {} fails",
1022 log_bytes!($chan_id[..]),
1023 if $resend_commitment && $resend_raa {
1024 match $action_type {
1025 RAACommitmentOrder::CommitmentFirst => { "commitment then RAA" },
1026 RAACommitmentOrder::RevokeAndACKFirst => { "RAA then commitment" },
1028 } else if $resend_commitment { "commitment" }
1029 else if $resend_raa { "RAA" }
1031 (&$failed_forwards as &Vec<(PendingHTLCInfo, u64)>).len(),
1032 (&$failed_fails as &Vec<(HTLCSource, PaymentHash, HTLCFailReason)>).len());
1033 if !$resend_commitment {
1034 debug_assert!($action_type == RAACommitmentOrder::RevokeAndACKFirst || !$resend_raa);
1037 debug_assert!($action_type == RAACommitmentOrder::CommitmentFirst || !$resend_commitment);
1039 $chan.monitor_update_failed($resend_raa, $resend_commitment, $failed_forwards, $failed_fails);
1040 (Err(MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore("Failed to update ChannelMonitor".to_owned()), *$chan_id)), false)
1044 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr, $failed_forwards: expr, $failed_fails: expr) => { {
1045 let (res, drop) = handle_monitor_err!($self, $err, $channel_state.short_to_id, $entry.get_mut(), $action_type, $resend_raa, $resend_commitment, $failed_forwards, $failed_fails, $entry.key());
1047 $entry.remove_entry();
1053 macro_rules! return_monitor_err {
1054 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
1055 return handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment);
1057 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr, $failed_forwards: expr, $failed_fails: expr) => {
1058 return handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment, $failed_forwards, $failed_fails);
1062 // Does not break in case of TemporaryFailure!
1063 macro_rules! maybe_break_monitor_err {
1064 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
1065 match (handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment), $err) {
1066 (e, ChannelMonitorUpdateErr::PermanentFailure) => {
1069 (_, ChannelMonitorUpdateErr::TemporaryFailure) => { },
1074 macro_rules! handle_chan_restoration_locked {
1075 ($self: ident, $channel_lock: expr, $channel_state: expr, $channel_entry: expr,
1076 $raa: expr, $commitment_update: expr, $order: expr, $chanmon_update: expr,
1077 $pending_forwards: expr, $funding_broadcastable: expr, $funding_locked: expr) => { {
1078 let mut htlc_forwards = None;
1079 let counterparty_node_id = $channel_entry.get().get_counterparty_node_id();
1081 let chanmon_update: Option<ChannelMonitorUpdate> = $chanmon_update; // Force type-checking to resolve
1082 let chanmon_update_is_none = chanmon_update.is_none();
1084 let forwards: Vec<(PendingHTLCInfo, u64)> = $pending_forwards; // Force type-checking to resolve
1085 if !forwards.is_empty() {
1086 htlc_forwards = Some(($channel_entry.get().get_short_channel_id().expect("We can't have pending forwards before funding confirmation"),
1087 $channel_entry.get().get_funding_txo().unwrap(), forwards));
1090 if chanmon_update.is_some() {
1091 // On reconnect, we, by definition, only resend a funding_locked if there have been
1092 // no commitment updates, so the only channel monitor update which could also be
1093 // associated with a funding_locked would be the funding_created/funding_signed
1094 // monitor update. That monitor update failing implies that we won't send
1095 // funding_locked until it's been updated, so we can't have a funding_locked and a
1096 // monitor update here (so we don't bother to handle it correctly below).
1097 assert!($funding_locked.is_none());
1098 // A channel monitor update makes no sense without either a funding_locked or a
1099 // commitment update to process after it. Since we can't have a funding_locked, we
1100 // only bother to handle the monitor-update + commitment_update case below.
1101 assert!($commitment_update.is_some());
1104 if let Some(msg) = $funding_locked {
1105 // Similar to the above, this implies that we're letting the funding_locked fly
1106 // before it should be allowed to.
1107 assert!(chanmon_update.is_none());
1108 $channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingLocked {
1109 node_id: counterparty_node_id,
1112 if let Some(announcement_sigs) = $self.get_announcement_sigs($channel_entry.get()) {
1113 $channel_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
1114 node_id: counterparty_node_id,
1115 msg: announcement_sigs,
1118 $channel_state.short_to_id.insert($channel_entry.get().get_short_channel_id().unwrap(), $channel_entry.get().channel_id());
1121 let funding_broadcastable: Option<Transaction> = $funding_broadcastable; // Force type-checking to resolve
1122 if let Some(monitor_update) = chanmon_update {
1123 // We only ever broadcast a funding transaction in response to a funding_signed
1124 // message and the resulting monitor update. Thus, on channel_reestablish
1125 // message handling we can't have a funding transaction to broadcast. When
1126 // processing a monitor update finishing resulting in a funding broadcast, we
1127 // cannot have a second monitor update, thus this case would indicate a bug.
1128 assert!(funding_broadcastable.is_none());
1129 // Given we were just reconnected or finished updating a channel monitor, the
1130 // only case where we can get a new ChannelMonitorUpdate would be if we also
1131 // have some commitment updates to send as well.
1132 assert!($commitment_update.is_some());
1133 if let Err(e) = $self.chain_monitor.update_channel($channel_entry.get().get_funding_txo().unwrap(), monitor_update) {
1134 // channel_reestablish doesn't guarantee the order it returns is sensical
1135 // for the messages it returns, but if we're setting what messages to
1136 // re-transmit on monitor update success, we need to make sure it is sane.
1137 let mut order = $order;
1139 order = RAACommitmentOrder::CommitmentFirst;
1141 break handle_monitor_err!($self, e, $channel_state, $channel_entry, order, $raa.is_some(), true);
1145 macro_rules! handle_cs { () => {
1146 if let Some(update) = $commitment_update {
1147 $channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1148 node_id: counterparty_node_id,
1153 macro_rules! handle_raa { () => {
1154 if let Some(revoke_and_ack) = $raa {
1155 $channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
1156 node_id: counterparty_node_id,
1157 msg: revoke_and_ack,
1162 RAACommitmentOrder::CommitmentFirst => {
1166 RAACommitmentOrder::RevokeAndACKFirst => {
1171 if let Some(tx) = funding_broadcastable {
1172 log_info!($self.logger, "Broadcasting funding transaction with txid {}", tx.txid());
1173 $self.tx_broadcaster.broadcast_transaction(&tx);
1178 if chanmon_update_is_none {
1179 // If there was no ChannelMonitorUpdate, we should never generate an Err in the res loop
1180 // above. Doing so would imply calling handle_err!() from channel_monitor_updated() which
1181 // should *never* end up calling back to `chain_monitor.update_channel()`.
1182 assert!(res.is_ok());
1185 (htlc_forwards, res, counterparty_node_id)
1189 macro_rules! post_handle_chan_restoration {
1190 ($self: ident, $locked_res: expr) => { {
1191 let (htlc_forwards, res, counterparty_node_id) = $locked_res;
1193 let _ = handle_error!($self, res, counterparty_node_id);
1195 if let Some(forwards) = htlc_forwards {
1196 $self.forward_htlcs(&mut [forwards][..]);
1201 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<Signer, M, T, K, F, L>
1202 where M::Target: chain::Watch<Signer>,
1203 T::Target: BroadcasterInterface,
1204 K::Target: KeysInterface<Signer = Signer>,
1205 F::Target: FeeEstimator,
1208 /// Constructs a new ChannelManager to hold several channels and route between them.
1210 /// This is the main "logic hub" for all channel-related actions, and implements
1211 /// ChannelMessageHandler.
1213 /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
1215 /// panics if channel_value_satoshis is >= `MAX_FUNDING_SATOSHIS`!
1217 /// Users need to notify the new ChannelManager when a new block is connected or
1218 /// disconnected using its `block_connected` and `block_disconnected` methods, starting
1219 /// from after `params.latest_hash`.
1220 pub fn new(fee_est: F, chain_monitor: M, tx_broadcaster: T, logger: L, keys_manager: K, config: UserConfig, params: ChainParameters) -> Self {
1221 let mut secp_ctx = Secp256k1::new();
1222 secp_ctx.seeded_randomize(&keys_manager.get_secure_random_bytes());
1225 default_configuration: config.clone(),
1226 genesis_hash: genesis_block(params.network).header.block_hash(),
1227 fee_estimator: fee_est,
1231 best_block: RwLock::new(params.best_block),
1233 channel_state: Mutex::new(ChannelHolder{
1234 by_id: HashMap::new(),
1235 short_to_id: HashMap::new(),
1236 forward_htlcs: HashMap::new(),
1237 claimable_htlcs: HashMap::new(),
1238 pending_msg_events: Vec::new(),
1240 pending_inbound_payments: Mutex::new(HashMap::new()),
1241 pending_outbound_payments: Mutex::new(HashMap::new()),
1243 our_network_key: keys_manager.get_node_secret(),
1244 our_network_pubkey: PublicKey::from_secret_key(&secp_ctx, &keys_manager.get_node_secret()),
1247 last_node_announcement_serial: AtomicUsize::new(0),
1248 highest_seen_timestamp: AtomicUsize::new(0),
1250 per_peer_state: RwLock::new(HashMap::new()),
1252 pending_events: Mutex::new(Vec::new()),
1253 pending_background_events: Mutex::new(Vec::new()),
1254 total_consistency_lock: RwLock::new(()),
1255 persistence_notifier: PersistenceNotifier::new(),
1263 /// Gets the current configuration applied to all new channels, as
1264 pub fn get_current_default_configuration(&self) -> &UserConfig {
1265 &self.default_configuration
1268 /// Creates a new outbound channel to the given remote node and with the given value.
1270 /// user_id will be provided back as user_channel_id in FundingGenerationReady events to allow
1271 /// tracking of which events correspond with which create_channel call. Note that the
1272 /// user_channel_id defaults to 0 for inbound channels, so you may wish to avoid using 0 for
1273 /// user_id here. user_id has no meaning inside of LDK, it is simply copied to events and
1274 /// otherwise ignored.
1276 /// If successful, will generate a SendOpenChannel message event, so you should probably poll
1277 /// PeerManager::process_events afterwards.
1279 /// Raises APIError::APIMisuseError when channel_value_satoshis > 2**24 or push_msat is
1280 /// greater than channel_value_satoshis * 1k or channel_value_satoshis is < 1000.
1282 /// Note that we do not check if you are currently connected to the given peer. If no
1283 /// connection is available, the outbound `open_channel` message may fail to send, resulting in
1284 /// the channel eventually being silently forgotten.
1285 pub fn create_channel(&self, their_network_key: PublicKey, channel_value_satoshis: u64, push_msat: u64, user_id: u64, override_config: Option<UserConfig>) -> Result<(), APIError> {
1286 if channel_value_satoshis < 1000 {
1287 return Err(APIError::APIMisuseError { err: format!("Channel value must be at least 1000 satoshis. It was {}", channel_value_satoshis) });
1291 let per_peer_state = self.per_peer_state.read().unwrap();
1292 match per_peer_state.get(&their_network_key) {
1293 Some(peer_state) => {
1294 let peer_state = peer_state.lock().unwrap();
1295 let their_features = &peer_state.latest_features;
1296 let config = if override_config.is_some() { override_config.as_ref().unwrap() } else { &self.default_configuration };
1297 Channel::new_outbound(&self.fee_estimator, &self.keys_manager, their_network_key, their_features, channel_value_satoshis, push_msat, user_id, config)?
1299 None => return Err(APIError::ChannelUnavailable { err: format!("Not connected to node: {}", their_network_key) }),
1302 let res = channel.get_open_channel(self.genesis_hash.clone());
1304 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1305 // We want to make sure the lock is actually acquired by PersistenceNotifierGuard.
1306 debug_assert!(&self.total_consistency_lock.try_write().is_err());
1308 let mut channel_state = self.channel_state.lock().unwrap();
1309 match channel_state.by_id.entry(channel.channel_id()) {
1310 hash_map::Entry::Occupied(_) => {
1311 if cfg!(feature = "fuzztarget") {
1312 return Err(APIError::APIMisuseError { err: "Fuzzy bad RNG".to_owned() });
1314 panic!("RNG is bad???");
1317 hash_map::Entry::Vacant(entry) => { entry.insert(channel); }
1319 channel_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
1320 node_id: their_network_key,
1326 fn list_channels_with_filter<Fn: FnMut(&(&[u8; 32], &Channel<Signer>)) -> bool>(&self, f: Fn) -> Vec<ChannelDetails> {
1327 let mut res = Vec::new();
1329 let channel_state = self.channel_state.lock().unwrap();
1330 res.reserve(channel_state.by_id.len());
1331 for (channel_id, channel) in channel_state.by_id.iter().filter(f) {
1332 let (inbound_capacity_msat, outbound_capacity_msat) = channel.get_inbound_outbound_available_balance_msat();
1333 let (to_remote_reserve_satoshis, to_self_reserve_satoshis) =
1334 channel.get_holder_counterparty_selected_channel_reserve_satoshis();
1335 res.push(ChannelDetails {
1336 channel_id: (*channel_id).clone(),
1337 counterparty: ChannelCounterparty {
1338 node_id: channel.get_counterparty_node_id(),
1339 features: InitFeatures::empty(),
1340 unspendable_punishment_reserve: to_remote_reserve_satoshis,
1341 forwarding_info: channel.counterparty_forwarding_info(),
1343 funding_txo: channel.get_funding_txo(),
1344 short_channel_id: channel.get_short_channel_id(),
1345 channel_value_satoshis: channel.get_value_satoshis(),
1346 unspendable_punishment_reserve: to_self_reserve_satoshis,
1347 inbound_capacity_msat,
1348 outbound_capacity_msat,
1349 user_id: channel.get_user_id(),
1350 confirmations_required: channel.minimum_depth(),
1351 force_close_spend_delay: channel.get_counterparty_selected_contest_delay(),
1352 is_outbound: channel.is_outbound(),
1353 is_funding_locked: channel.is_usable(),
1354 is_usable: channel.is_live(),
1355 is_public: channel.should_announce(),
1359 let per_peer_state = self.per_peer_state.read().unwrap();
1360 for chan in res.iter_mut() {
1361 if let Some(peer_state) = per_peer_state.get(&chan.counterparty.node_id) {
1362 chan.counterparty.features = peer_state.lock().unwrap().latest_features.clone();
1368 /// Gets the list of open channels, in random order. See ChannelDetail field documentation for
1369 /// more information.
1370 pub fn list_channels(&self) -> Vec<ChannelDetails> {
1371 self.list_channels_with_filter(|_| true)
1374 /// Gets the list of usable channels, in random order. Useful as an argument to
1375 /// get_route to ensure non-announced channels are used.
1377 /// These are guaranteed to have their [`ChannelDetails::is_usable`] value set to true, see the
1378 /// documentation for [`ChannelDetails::is_usable`] for more info on exactly what the criteria
1380 pub fn list_usable_channels(&self) -> Vec<ChannelDetails> {
1381 // Note we use is_live here instead of usable which leads to somewhat confused
1382 // internal/external nomenclature, but that's ok cause that's probably what the user
1383 // really wanted anyway.
1384 self.list_channels_with_filter(|&(_, ref channel)| channel.is_live())
1387 /// Helper function that issues the channel close events
1388 fn issue_channel_close_events(&self, channel: &Channel<Signer>, closure_reason: ClosureReason) {
1389 let mut pending_events_lock = self.pending_events.lock().unwrap();
1390 match channel.unbroadcasted_funding() {
1391 Some(transaction) => {
1392 pending_events_lock.push(events::Event::DiscardFunding { channel_id: channel.channel_id(), transaction })
1396 pending_events_lock.push(events::Event::ChannelClosed { channel_id: channel.channel_id(), reason: closure_reason });
1399 fn close_channel_internal(&self, channel_id: &[u8; 32], target_feerate_sats_per_1000_weight: Option<u32>) -> Result<(), APIError> {
1400 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1402 let counterparty_node_id;
1403 let mut failed_htlcs: Vec<(HTLCSource, PaymentHash)>;
1404 let result: Result<(), _> = loop {
1405 let mut channel_state_lock = self.channel_state.lock().unwrap();
1406 let channel_state = &mut *channel_state_lock;
1407 match channel_state.by_id.entry(channel_id.clone()) {
1408 hash_map::Entry::Occupied(mut chan_entry) => {
1409 counterparty_node_id = chan_entry.get().get_counterparty_node_id();
1410 let per_peer_state = self.per_peer_state.read().unwrap();
1411 let (shutdown_msg, monitor_update, htlcs) = match per_peer_state.get(&counterparty_node_id) {
1412 Some(peer_state) => {
1413 let peer_state = peer_state.lock().unwrap();
1414 let their_features = &peer_state.latest_features;
1415 chan_entry.get_mut().get_shutdown(&self.keys_manager, their_features, target_feerate_sats_per_1000_weight)?
1417 None => return Err(APIError::ChannelUnavailable { err: format!("Not connected to node: {}", counterparty_node_id) }),
1419 failed_htlcs = htlcs;
1421 // Update the monitor with the shutdown script if necessary.
1422 if let Some(monitor_update) = monitor_update {
1423 if let Err(e) = self.chain_monitor.update_channel(chan_entry.get().get_funding_txo().unwrap(), monitor_update) {
1424 let (result, is_permanent) =
1425 handle_monitor_err!(self, e, channel_state.short_to_id, chan_entry.get_mut(), RAACommitmentOrder::CommitmentFirst, false, false, Vec::new(), Vec::new(), chan_entry.key());
1427 remove_channel!(channel_state, chan_entry);
1433 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
1434 node_id: counterparty_node_id,
1438 if chan_entry.get().is_shutdown() {
1439 let channel = remove_channel!(channel_state, chan_entry);
1440 if let Ok(channel_update) = self.get_channel_update_for_broadcast(&channel) {
1441 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1445 self.issue_channel_close_events(&channel, ClosureReason::HolderForceClosed);
1449 hash_map::Entry::Vacant(_) => return Err(APIError::ChannelUnavailable{err: "No such channel".to_owned()})
1453 for htlc_source in failed_htlcs.drain(..) {
1454 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() });
1457 let _ = handle_error!(self, result, counterparty_node_id);
1461 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
1462 /// will be accepted on the given channel, and after additional timeout/the closing of all
1463 /// pending HTLCs, the channel will be closed on chain.
1465 /// * If we are the channel initiator, we will pay between our [`Background`] and
1466 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
1468 /// * If our counterparty is the channel initiator, we will require a channel closing
1469 /// transaction feerate of at least our [`Background`] feerate or the feerate which
1470 /// would appear on a force-closure transaction, whichever is lower. We will allow our
1471 /// counterparty to pay as much fee as they'd like, however.
1473 /// May generate a SendShutdown message event on success, which should be relayed.
1475 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
1476 /// [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
1477 /// [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
1478 pub fn close_channel(&self, channel_id: &[u8; 32]) -> Result<(), APIError> {
1479 self.close_channel_internal(channel_id, None)
1482 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
1483 /// will be accepted on the given channel, and after additional timeout/the closing of all
1484 /// pending HTLCs, the channel will be closed on chain.
1486 /// `target_feerate_sat_per_1000_weight` has different meanings depending on if we initiated
1487 /// the channel being closed or not:
1488 /// * If we are the channel initiator, we will pay at least this feerate on the closing
1489 /// transaction. The upper-bound is set by
1490 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
1491 /// estimate (or `target_feerate_sat_per_1000_weight`, if it is greater).
1492 /// * If our counterparty is the channel initiator, we will refuse to accept a channel closure
1493 /// transaction feerate below `target_feerate_sat_per_1000_weight` (or the feerate which
1494 /// will appear on a force-closure transaction, whichever is lower).
1496 /// May generate a SendShutdown message event on success, which should be relayed.
1498 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
1499 /// [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
1500 /// [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
1501 pub fn close_channel_with_target_feerate(&self, channel_id: &[u8; 32], target_feerate_sats_per_1000_weight: u32) -> Result<(), APIError> {
1502 self.close_channel_internal(channel_id, Some(target_feerate_sats_per_1000_weight))
1506 fn finish_force_close_channel(&self, shutdown_res: ShutdownResult) {
1507 let (monitor_update_option, mut failed_htlcs) = shutdown_res;
1508 log_debug!(self.logger, "Finishing force-closure of channel with {} HTLCs to fail", failed_htlcs.len());
1509 for htlc_source in failed_htlcs.drain(..) {
1510 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() });
1512 if let Some((funding_txo, monitor_update)) = monitor_update_option {
1513 // There isn't anything we can do if we get an update failure - we're already
1514 // force-closing. The monitor update on the required in-memory copy should broadcast
1515 // the latest local state, which is the best we can do anyway. Thus, it is safe to
1516 // ignore the result here.
1517 let _ = self.chain_monitor.update_channel(funding_txo, monitor_update);
1521 /// `peer_node_id` should be set when we receive a message from a peer, but not set when the
1522 /// user closes, which will be re-exposed as the `ChannelClosed` reason.
1523 fn force_close_channel_with_peer(&self, channel_id: &[u8; 32], peer_node_id: Option<&PublicKey>, peer_msg: Option<&String>) -> Result<PublicKey, APIError> {
1525 let mut channel_state_lock = self.channel_state.lock().unwrap();
1526 let channel_state = &mut *channel_state_lock;
1527 if let hash_map::Entry::Occupied(chan) = channel_state.by_id.entry(channel_id.clone()) {
1528 if let Some(node_id) = peer_node_id {
1529 if chan.get().get_counterparty_node_id() != *node_id {
1530 return Err(APIError::ChannelUnavailable{err: "No such channel".to_owned()});
1533 if let Some(short_id) = chan.get().get_short_channel_id() {
1534 channel_state.short_to_id.remove(&short_id);
1536 if peer_node_id.is_some() {
1537 if let Some(peer_msg) = peer_msg {
1538 self.issue_channel_close_events(chan.get(),ClosureReason::CounterpartyForceClosed { peer_msg: peer_msg.to_string() });
1541 self.issue_channel_close_events(chan.get(),ClosureReason::HolderForceClosed);
1543 chan.remove_entry().1
1545 return Err(APIError::ChannelUnavailable{err: "No such channel".to_owned()});
1548 log_error!(self.logger, "Force-closing channel {}", log_bytes!(channel_id[..]));
1549 self.finish_force_close_channel(chan.force_shutdown(true));
1550 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
1551 let mut channel_state = self.channel_state.lock().unwrap();
1552 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1557 Ok(chan.get_counterparty_node_id())
1560 /// Force closes a channel, immediately broadcasting the latest local commitment transaction to
1561 /// the chain and rejecting new HTLCs on the given channel. Fails if channel_id is unknown to the manager.
1562 pub fn force_close_channel(&self, channel_id: &[u8; 32]) -> Result<(), APIError> {
1563 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1564 match self.force_close_channel_with_peer(channel_id, None, None) {
1565 Ok(counterparty_node_id) => {
1566 self.channel_state.lock().unwrap().pending_msg_events.push(
1567 events::MessageSendEvent::HandleError {
1568 node_id: counterparty_node_id,
1569 action: msgs::ErrorAction::SendErrorMessage {
1570 msg: msgs::ErrorMessage { channel_id: *channel_id, data: "Channel force-closed".to_owned() }
1580 /// Force close all channels, immediately broadcasting the latest local commitment transaction
1581 /// for each to the chain and rejecting new HTLCs on each.
1582 pub fn force_close_all_channels(&self) {
1583 for chan in self.list_channels() {
1584 let _ = self.force_close_channel(&chan.channel_id);
1588 fn decode_update_add_htlc_onion(&self, msg: &msgs::UpdateAddHTLC) -> (PendingHTLCStatus, MutexGuard<ChannelHolder<Signer>>) {
1589 macro_rules! return_malformed_err {
1590 ($msg: expr, $err_code: expr) => {
1592 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
1593 return (PendingHTLCStatus::Fail(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
1594 channel_id: msg.channel_id,
1595 htlc_id: msg.htlc_id,
1596 sha256_of_onion: Sha256::hash(&msg.onion_routing_packet.hop_data).into_inner(),
1597 failure_code: $err_code,
1598 })), self.channel_state.lock().unwrap());
1603 if let Err(_) = msg.onion_routing_packet.public_key {
1604 return_malformed_err!("invalid ephemeral pubkey", 0x8000 | 0x4000 | 6);
1607 let shared_secret = {
1608 let mut arr = [0; 32];
1609 arr.copy_from_slice(&SharedSecret::new(&msg.onion_routing_packet.public_key.unwrap(), &self.our_network_key)[..]);
1612 let (rho, mu) = onion_utils::gen_rho_mu_from_shared_secret(&shared_secret);
1614 if msg.onion_routing_packet.version != 0 {
1615 //TODO: Spec doesn't indicate if we should only hash hop_data here (and in other
1616 //sha256_of_onion error data packets), or the entire onion_routing_packet. Either way,
1617 //the hash doesn't really serve any purpose - in the case of hashing all data, the
1618 //receiving node would have to brute force to figure out which version was put in the
1619 //packet by the node that send us the message, in the case of hashing the hop_data, the
1620 //node knows the HMAC matched, so they already know what is there...
1621 return_malformed_err!("Unknown onion packet version", 0x8000 | 0x4000 | 4);
1624 let mut hmac = HmacEngine::<Sha256>::new(&mu);
1625 hmac.input(&msg.onion_routing_packet.hop_data);
1626 hmac.input(&msg.payment_hash.0[..]);
1627 if !fixed_time_eq(&Hmac::from_engine(hmac).into_inner(), &msg.onion_routing_packet.hmac) {
1628 return_malformed_err!("HMAC Check failed", 0x8000 | 0x4000 | 5);
1631 let mut channel_state = None;
1632 macro_rules! return_err {
1633 ($msg: expr, $err_code: expr, $data: expr) => {
1635 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
1636 if channel_state.is_none() {
1637 channel_state = Some(self.channel_state.lock().unwrap());
1639 return (PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
1640 channel_id: msg.channel_id,
1641 htlc_id: msg.htlc_id,
1642 reason: onion_utils::build_first_hop_failure_packet(&shared_secret, $err_code, $data),
1643 })), channel_state.unwrap());
1648 let mut chacha = ChaCha20::new(&rho, &[0u8; 8]);
1649 let mut chacha_stream = ChaChaReader { chacha: &mut chacha, read: Cursor::new(&msg.onion_routing_packet.hop_data[..]) };
1650 let (next_hop_data, next_hop_hmac): (msgs::OnionHopData, _) = {
1651 match <msgs::OnionHopData as Readable>::read(&mut chacha_stream) {
1653 let error_code = match err {
1654 msgs::DecodeError::UnknownVersion => 0x4000 | 1, // unknown realm byte
1655 msgs::DecodeError::UnknownRequiredFeature|
1656 msgs::DecodeError::InvalidValue|
1657 msgs::DecodeError::ShortRead => 0x4000 | 22, // invalid_onion_payload
1658 _ => 0x2000 | 2, // Should never happen
1660 return_err!("Unable to decode our hop data", error_code, &[0;0]);
1663 let mut hmac = [0; 32];
1664 if let Err(_) = chacha_stream.read_exact(&mut hmac[..]) {
1665 return_err!("Unable to decode hop data", 0x4000 | 22, &[0;0]);
1672 let pending_forward_info = if next_hop_hmac == [0; 32] {
1675 // In tests, make sure that the initial onion pcket data is, at least, non-0.
1676 // We could do some fancy randomness test here, but, ehh, whatever.
1677 // This checks for the issue where you can calculate the path length given the
1678 // onion data as all the path entries that the originator sent will be here
1679 // as-is (and were originally 0s).
1680 // Of course reverse path calculation is still pretty easy given naive routing
1681 // algorithms, but this fixes the most-obvious case.
1682 let mut next_bytes = [0; 32];
1683 chacha_stream.read_exact(&mut next_bytes).unwrap();
1684 assert_ne!(next_bytes[..], [0; 32][..]);
1685 chacha_stream.read_exact(&mut next_bytes).unwrap();
1686 assert_ne!(next_bytes[..], [0; 32][..]);
1690 // final_expiry_too_soon
1691 // We have to have some headroom to broadcast on chain if we have the preimage, so make sure
1692 // we have at least HTLC_FAIL_BACK_BUFFER blocks to go.
1693 // Also, ensure that, in the case of an unknown preimage for the received payment hash, our
1694 // payment logic has enough time to fail the HTLC backward before our onchain logic triggers a
1695 // channel closure (see HTLC_FAIL_BACK_BUFFER rationale).
1696 if (msg.cltv_expiry as u64) <= self.best_block.read().unwrap().height() as u64 + HTLC_FAIL_BACK_BUFFER as u64 + 1 {
1697 return_err!("The final CLTV expiry is too soon to handle", 17, &[0;0]);
1699 // final_incorrect_htlc_amount
1700 if next_hop_data.amt_to_forward > msg.amount_msat {
1701 return_err!("Upstream node sent less than we were supposed to receive in payment", 19, &byte_utils::be64_to_array(msg.amount_msat));
1703 // final_incorrect_cltv_expiry
1704 if next_hop_data.outgoing_cltv_value != msg.cltv_expiry {
1705 return_err!("Upstream node set CLTV to the wrong value", 18, &byte_utils::be32_to_array(msg.cltv_expiry));
1708 let routing = match next_hop_data.format {
1709 msgs::OnionHopDataFormat::Legacy { .. } => return_err!("We require payment_secrets", 0x4000|0x2000|3, &[0;0]),
1710 msgs::OnionHopDataFormat::NonFinalNode { .. } => return_err!("Got non final data with an HMAC of 0", 0x4000 | 22, &[0;0]),
1711 msgs::OnionHopDataFormat::FinalNode { payment_data, keysend_preimage } => {
1712 if payment_data.is_some() && keysend_preimage.is_some() {
1713 return_err!("We don't support MPP keysend payments", 0x4000|22, &[0;0]);
1714 } else if let Some(data) = payment_data {
1715 PendingHTLCRouting::Receive {
1717 incoming_cltv_expiry: msg.cltv_expiry,
1719 } else if let Some(payment_preimage) = keysend_preimage {
1720 // We need to check that the sender knows the keysend preimage before processing this
1721 // payment further. Otherwise, an intermediary routing hop forwarding non-keysend-HTLC X
1722 // could discover the final destination of X, by probing the adjacent nodes on the route
1723 // with a keysend payment of identical payment hash to X and observing the processing
1724 // time discrepancies due to a hash collision with X.
1725 let hashed_preimage = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
1726 if hashed_preimage != msg.payment_hash {
1727 return_err!("Payment preimage didn't match payment hash", 0x4000|22, &[0;0]);
1730 PendingHTLCRouting::ReceiveKeysend {
1732 incoming_cltv_expiry: msg.cltv_expiry,
1735 return_err!("We require payment_secrets", 0x4000|0x2000|3, &[0;0]);
1740 // Note that we could obviously respond immediately with an update_fulfill_htlc
1741 // message, however that would leak that we are the recipient of this payment, so
1742 // instead we stay symmetric with the forwarding case, only responding (after a
1743 // delay) once they've send us a commitment_signed!
1745 PendingHTLCStatus::Forward(PendingHTLCInfo {
1747 payment_hash: msg.payment_hash.clone(),
1748 incoming_shared_secret: shared_secret,
1749 amt_to_forward: next_hop_data.amt_to_forward,
1750 outgoing_cltv_value: next_hop_data.outgoing_cltv_value,
1753 let mut new_packet_data = [0; 20*65];
1754 let read_pos = chacha_stream.read(&mut new_packet_data).unwrap();
1755 #[cfg(debug_assertions)]
1757 // Check two things:
1758 // a) that the behavior of our stream here will return Ok(0) even if the TLV
1759 // read above emptied out our buffer and the unwrap() wont needlessly panic
1760 // b) that we didn't somehow magically end up with extra data.
1762 debug_assert!(chacha_stream.read(&mut t).unwrap() == 0);
1764 // Once we've emptied the set of bytes our peer gave us, encrypt 0 bytes until we
1765 // fill the onion hop data we'll forward to our next-hop peer.
1766 chacha_stream.chacha.process_in_place(&mut new_packet_data[read_pos..]);
1768 let mut new_pubkey = msg.onion_routing_packet.public_key.unwrap();
1770 let blinding_factor = {
1771 let mut sha = Sha256::engine();
1772 sha.input(&new_pubkey.serialize()[..]);
1773 sha.input(&shared_secret);
1774 Sha256::from_engine(sha).into_inner()
1777 let public_key = if let Err(e) = new_pubkey.mul_assign(&self.secp_ctx, &blinding_factor[..]) {
1779 } else { Ok(new_pubkey) };
1781 let outgoing_packet = msgs::OnionPacket {
1784 hop_data: new_packet_data,
1785 hmac: next_hop_hmac.clone(),
1788 let short_channel_id = match next_hop_data.format {
1789 msgs::OnionHopDataFormat::Legacy { short_channel_id } => short_channel_id,
1790 msgs::OnionHopDataFormat::NonFinalNode { short_channel_id } => short_channel_id,
1791 msgs::OnionHopDataFormat::FinalNode { .. } => {
1792 return_err!("Final Node OnionHopData provided for us as an intermediary node", 0x4000 | 22, &[0;0]);
1796 PendingHTLCStatus::Forward(PendingHTLCInfo {
1797 routing: PendingHTLCRouting::Forward {
1798 onion_packet: outgoing_packet,
1801 payment_hash: msg.payment_hash.clone(),
1802 incoming_shared_secret: shared_secret,
1803 amt_to_forward: next_hop_data.amt_to_forward,
1804 outgoing_cltv_value: next_hop_data.outgoing_cltv_value,
1808 channel_state = Some(self.channel_state.lock().unwrap());
1809 if let &PendingHTLCStatus::Forward(PendingHTLCInfo { ref routing, ref amt_to_forward, ref outgoing_cltv_value, .. }) = &pending_forward_info {
1810 // If short_channel_id is 0 here, we'll reject the HTLC as there cannot be a channel
1811 // with a short_channel_id of 0. This is important as various things later assume
1812 // short_channel_id is non-0 in any ::Forward.
1813 if let &PendingHTLCRouting::Forward { ref short_channel_id, .. } = routing {
1814 let id_option = channel_state.as_ref().unwrap().short_to_id.get(&short_channel_id).cloned();
1815 if let Some((err, code, chan_update)) = loop {
1816 let forwarding_id = match id_option {
1817 None => { // unknown_next_peer
1818 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
1820 Some(id) => id.clone(),
1823 let chan = channel_state.as_mut().unwrap().by_id.get_mut(&forwarding_id).unwrap();
1825 if !chan.should_announce() && !self.default_configuration.accept_forwards_to_priv_channels {
1826 // Note that the behavior here should be identical to the above block - we
1827 // should NOT reveal the existence or non-existence of a private channel if
1828 // we don't allow forwards outbound over them.
1829 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
1832 // Note that we could technically not return an error yet here and just hope
1833 // that the connection is reestablished or monitor updated by the time we get
1834 // around to doing the actual forward, but better to fail early if we can and
1835 // hopefully an attacker trying to path-trace payments cannot make this occur
1836 // on a small/per-node/per-channel scale.
1837 if !chan.is_live() { // channel_disabled
1838 break Some(("Forwarding channel is not in a ready state.", 0x1000 | 20, Some(self.get_channel_update_for_unicast(chan).unwrap())));
1840 if *amt_to_forward < chan.get_counterparty_htlc_minimum_msat() { // amount_below_minimum
1841 break Some(("HTLC amount was below the htlc_minimum_msat", 0x1000 | 11, Some(self.get_channel_update_for_unicast(chan).unwrap())));
1843 let fee = amt_to_forward.checked_mul(chan.get_fee_proportional_millionths() as u64)
1844 .and_then(|prop_fee| { (prop_fee / 1000000)
1845 .checked_add(chan.get_outbound_forwarding_fee_base_msat() as u64) });
1846 if fee.is_none() || msg.amount_msat < fee.unwrap() || (msg.amount_msat - fee.unwrap()) < *amt_to_forward { // fee_insufficient
1847 break Some(("Prior hop has deviated from specified fees parameters or origin node has obsolete ones", 0x1000 | 12, Some(self.get_channel_update_for_unicast(chan).unwrap())));
1849 if (msg.cltv_expiry as u64) < (*outgoing_cltv_value) as u64 + chan.get_cltv_expiry_delta() as u64 { // incorrect_cltv_expiry
1850 break Some(("Forwarding node has tampered with the intended HTLC values or origin node has an obsolete cltv_expiry_delta", 0x1000 | 13, Some(self.get_channel_update_for_unicast(chan).unwrap())));
1852 let cur_height = self.best_block.read().unwrap().height() + 1;
1853 // Theoretically, channel counterparty shouldn't send us a HTLC expiring now,
1854 // but we want to be robust wrt to counterparty packet sanitization (see
1855 // HTLC_FAIL_BACK_BUFFER rationale).
1856 if msg.cltv_expiry <= cur_height + HTLC_FAIL_BACK_BUFFER as u32 { // expiry_too_soon
1857 break Some(("CLTV expiry is too close", 0x1000 | 14, Some(self.get_channel_update_for_unicast(chan).unwrap())));
1859 if msg.cltv_expiry > cur_height + CLTV_FAR_FAR_AWAY as u32 { // expiry_too_far
1860 break Some(("CLTV expiry is too far in the future", 21, None));
1862 // If the HTLC expires ~now, don't bother trying to forward it to our
1863 // counterparty. They should fail it anyway, but we don't want to bother with
1864 // the round-trips or risk them deciding they definitely want the HTLC and
1865 // force-closing to ensure they get it if we're offline.
1866 // We previously had a much more aggressive check here which tried to ensure
1867 // our counterparty receives an HTLC which has *our* risk threshold met on it,
1868 // but there is no need to do that, and since we're a bit conservative with our
1869 // risk threshold it just results in failing to forward payments.
1870 if (*outgoing_cltv_value) as u64 <= (cur_height + LATENCY_GRACE_PERIOD_BLOCKS) as u64 {
1871 break Some(("Outgoing CLTV value is too soon", 0x1000 | 14, Some(self.get_channel_update_for_unicast(chan).unwrap())));
1877 let mut res = Vec::with_capacity(8 + 128);
1878 if let Some(chan_update) = chan_update {
1879 if code == 0x1000 | 11 || code == 0x1000 | 12 {
1880 res.extend_from_slice(&byte_utils::be64_to_array(msg.amount_msat));
1882 else if code == 0x1000 | 13 {
1883 res.extend_from_slice(&byte_utils::be32_to_array(msg.cltv_expiry));
1885 else if code == 0x1000 | 20 {
1886 // TODO: underspecified, follow https://github.com/lightningnetwork/lightning-rfc/issues/791
1887 res.extend_from_slice(&byte_utils::be16_to_array(0));
1889 res.extend_from_slice(&chan_update.encode_with_len()[..]);
1891 return_err!(err, code, &res[..]);
1896 (pending_forward_info, channel_state.unwrap())
1899 /// Gets the current channel_update for the given channel. This first checks if the channel is
1900 /// public, and thus should be called whenever the result is going to be passed out in a
1901 /// [`MessageSendEvent::BroadcastChannelUpdate`] event.
1903 /// May be called with channel_state already locked!
1904 fn get_channel_update_for_broadcast(&self, chan: &Channel<Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
1905 if !chan.should_announce() {
1906 return Err(LightningError {
1907 err: "Cannot broadcast a channel_update for a private channel".to_owned(),
1908 action: msgs::ErrorAction::IgnoreError
1911 log_trace!(self.logger, "Attempting to generate broadcast channel update for channel {}", log_bytes!(chan.channel_id()));
1912 self.get_channel_update_for_unicast(chan)
1915 /// Gets the current channel_update for the given channel. This does not check if the channel
1916 /// is public (only returning an Err if the channel does not yet have an assigned short_id),
1917 /// and thus MUST NOT be called unless the recipient of the resulting message has already
1918 /// provided evidence that they know about the existence of the channel.
1919 /// May be called with channel_state already locked!
1920 fn get_channel_update_for_unicast(&self, chan: &Channel<Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
1921 log_trace!(self.logger, "Attempting to generate channel update for channel {}", log_bytes!(chan.channel_id()));
1922 let short_channel_id = match chan.get_short_channel_id() {
1923 None => return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError}),
1927 let were_node_one = PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key).serialize()[..] < chan.get_counterparty_node_id().serialize()[..];
1929 let unsigned = msgs::UnsignedChannelUpdate {
1930 chain_hash: self.genesis_hash,
1932 timestamp: chan.get_update_time_counter(),
1933 flags: (!were_node_one) as u8 | ((!chan.is_live() as u8) << 1),
1934 cltv_expiry_delta: chan.get_cltv_expiry_delta(),
1935 htlc_minimum_msat: chan.get_counterparty_htlc_minimum_msat(),
1936 htlc_maximum_msat: OptionalField::Present(chan.get_announced_htlc_max_msat()),
1937 fee_base_msat: chan.get_outbound_forwarding_fee_base_msat(),
1938 fee_proportional_millionths: chan.get_fee_proportional_millionths(),
1939 excess_data: Vec::new(),
1942 let msg_hash = Sha256dHash::hash(&unsigned.encode()[..]);
1943 let sig = self.secp_ctx.sign(&hash_to_message!(&msg_hash[..]), &self.our_network_key);
1945 Ok(msgs::ChannelUpdate {
1951 // Only public for testing, this should otherwise never be called direcly
1952 pub(crate) fn send_payment_along_path(&self, path: &Vec<RouteHop>, payment_hash: &PaymentHash, payment_secret: &Option<PaymentSecret>, total_value: u64, cur_height: u32, payment_id: PaymentId, keysend_preimage: &Option<PaymentPreimage>) -> Result<(), APIError> {
1953 log_trace!(self.logger, "Attempting to send payment for path with next hop {}", path.first().unwrap().short_channel_id);
1954 let prng_seed = self.keys_manager.get_secure_random_bytes();
1955 let session_priv_bytes = self.keys_manager.get_secure_random_bytes();
1956 let session_priv = SecretKey::from_slice(&session_priv_bytes[..]).expect("RNG is busted");
1958 let onion_keys = onion_utils::construct_onion_keys(&self.secp_ctx, &path, &session_priv)
1959 .map_err(|_| APIError::RouteError{err: "Pubkey along hop was maliciously selected"})?;
1960 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(path, total_value, payment_secret, cur_height, keysend_preimage)?;
1961 if onion_utils::route_size_insane(&onion_payloads) {
1962 return Err(APIError::RouteError{err: "Route size too large considering onion data"});
1964 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, prng_seed, payment_hash);
1966 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1968 let err: Result<(), _> = loop {
1969 let mut channel_lock = self.channel_state.lock().unwrap();
1970 let id = match channel_lock.short_to_id.get(&path.first().unwrap().short_channel_id) {
1971 None => return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()}),
1972 Some(id) => id.clone(),
1975 let channel_state = &mut *channel_lock;
1976 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(id) {
1978 if chan.get().get_counterparty_node_id() != path.first().unwrap().pubkey {
1979 return Err(APIError::RouteError{err: "Node ID mismatch on first hop!"});
1981 if !chan.get().is_live() {
1982 return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected/pending monitor update!".to_owned()});
1984 let send_res = break_chan_entry!(self, chan.get_mut().send_htlc_and_commit(
1985 htlc_msat, payment_hash.clone(), htlc_cltv, HTLCSource::OutboundRoute {
1987 session_priv: session_priv.clone(),
1988 first_hop_htlc_msat: htlc_msat,
1990 }, onion_packet, &self.logger),
1991 channel_state, chan);
1993 let mut pending_outbounds = self.pending_outbound_payments.lock().unwrap();
1994 let payment = pending_outbounds.entry(payment_id).or_insert_with(|| PendingOutboundPayment::Retryable {
1995 session_privs: HashSet::new(),
1996 pending_amt_msat: 0,
1997 payment_hash: *payment_hash,
1998 payment_secret: *payment_secret,
1999 starting_block_height: self.best_block.read().unwrap().height(),
2000 total_msat: total_value,
2002 assert!(payment.insert(session_priv_bytes, path.last().unwrap().fee_msat));
2006 Some((update_add, commitment_signed, monitor_update)) => {
2007 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
2008 maybe_break_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, true);
2009 // Note that MonitorUpdateFailed here indicates (per function docs)
2010 // that we will resend the commitment update once monitor updating
2011 // is restored. Therefore, we must return an error indicating that
2012 // it is unsafe to retry the payment wholesale, which we do in the
2013 // send_payment check for MonitorUpdateFailed, below.
2014 return Err(APIError::MonitorUpdateFailed);
2017 log_debug!(self.logger, "Sending payment along path resulted in a commitment_signed for channel {}", log_bytes!(chan.get().channel_id()));
2018 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2019 node_id: path.first().unwrap().pubkey,
2020 updates: msgs::CommitmentUpdate {
2021 update_add_htlcs: vec![update_add],
2022 update_fulfill_htlcs: Vec::new(),
2023 update_fail_htlcs: Vec::new(),
2024 update_fail_malformed_htlcs: Vec::new(),
2032 } else { unreachable!(); }
2036 match handle_error!(self, err, path.first().unwrap().pubkey) {
2037 Ok(_) => unreachable!(),
2039 Err(APIError::ChannelUnavailable { err: e.err })
2044 /// Sends a payment along a given route.
2046 /// Value parameters are provided via the last hop in route, see documentation for RouteHop
2047 /// fields for more info.
2049 /// Note that if the payment_hash already exists elsewhere (eg you're sending a duplicative
2050 /// payment), we don't do anything to stop you! We always try to ensure that if the provided
2051 /// next hop knows the preimage to payment_hash they can claim an additional amount as
2052 /// specified in the last hop in the route! Thus, you should probably do your own
2053 /// payment_preimage tracking (which you should already be doing as they represent "proof of
2054 /// payment") and prevent double-sends yourself.
2056 /// May generate SendHTLCs message(s) event on success, which should be relayed.
2058 /// Each path may have a different return value, and PaymentSendValue may return a Vec with
2059 /// each entry matching the corresponding-index entry in the route paths, see
2060 /// PaymentSendFailure for more info.
2062 /// In general, a path may raise:
2063 /// * APIError::RouteError when an invalid route or forwarding parameter (cltv_delta, fee,
2064 /// node public key) is specified.
2065 /// * APIError::ChannelUnavailable if the next-hop channel is not available for updates
2066 /// (including due to previous monitor update failure or new permanent monitor update
2068 /// * APIError::MonitorUpdateFailed if a new monitor update failure prevented sending the
2069 /// relevant updates.
2071 /// Note that depending on the type of the PaymentSendFailure the HTLC may have been
2072 /// irrevocably committed to on our end. In such a case, do NOT retry the payment with a
2073 /// different route unless you intend to pay twice!
2075 /// payment_secret is unrelated to payment_hash (or PaymentPreimage) and exists to authenticate
2076 /// the sender to the recipient and prevent payment-probing (deanonymization) attacks. For
2077 /// newer nodes, it will be provided to you in the invoice. If you do not have one, the Route
2078 /// must not contain multiple paths as multi-path payments require a recipient-provided
2080 /// If a payment_secret *is* provided, we assume that the invoice had the payment_secret feature
2081 /// bit set (either as required or as available). If multiple paths are present in the Route,
2082 /// we assume the invoice had the basic_mpp feature set.
2083 pub fn send_payment(&self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>) -> Result<PaymentId, PaymentSendFailure> {
2084 self.send_payment_internal(route, payment_hash, payment_secret, None, None, None)
2087 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> {
2088 if route.paths.len() < 1 {
2089 return Err(PaymentSendFailure::ParameterError(APIError::RouteError{err: "There must be at least one path to send over"}));
2091 if route.paths.len() > 10 {
2092 // This limit is completely arbitrary - there aren't any real fundamental path-count
2093 // limits. After we support retrying individual paths we should likely bump this, but
2094 // for now more than 10 paths likely carries too much one-path failure.
2095 return Err(PaymentSendFailure::ParameterError(APIError::RouteError{err: "Sending over more than 10 paths is not currently supported"}));
2097 if payment_secret.is_none() && route.paths.len() > 1 {
2098 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError{err: "Payment secret is required for multi-path payments".to_string()}));
2100 let mut total_value = 0;
2101 let our_node_id = self.get_our_node_id();
2102 let mut path_errs = Vec::with_capacity(route.paths.len());
2103 let payment_id = if let Some(id) = payment_id { id } else { PaymentId(self.keys_manager.get_secure_random_bytes()) };
2104 'path_check: for path in route.paths.iter() {
2105 if path.len() < 1 || path.len() > 20 {
2106 path_errs.push(Err(APIError::RouteError{err: "Path didn't go anywhere/had bogus size"}));
2107 continue 'path_check;
2109 for (idx, hop) in path.iter().enumerate() {
2110 if idx != path.len() - 1 && hop.pubkey == our_node_id {
2111 path_errs.push(Err(APIError::RouteError{err: "Path went through us but wasn't a simple rebalance loop to us"}));
2112 continue 'path_check;
2115 total_value += path.last().unwrap().fee_msat;
2116 path_errs.push(Ok(()));
2118 if path_errs.iter().any(|e| e.is_err()) {
2119 return Err(PaymentSendFailure::PathParameterError(path_errs));
2121 if let Some(amt_msat) = recv_value_msat {
2122 debug_assert!(amt_msat >= total_value);
2123 total_value = amt_msat;
2126 let cur_height = self.best_block.read().unwrap().height() + 1;
2127 let mut results = Vec::new();
2128 for path in route.paths.iter() {
2129 results.push(self.send_payment_along_path(&path, &payment_hash, payment_secret, total_value, cur_height, payment_id, &keysend_preimage));
2131 let mut has_ok = false;
2132 let mut has_err = false;
2133 for res in results.iter() {
2134 if res.is_ok() { has_ok = true; }
2135 if res.is_err() { has_err = true; }
2136 if let &Err(APIError::MonitorUpdateFailed) = res {
2137 // MonitorUpdateFailed is inherently unsafe to retry, so we call it a
2144 if has_err && has_ok {
2145 Err(PaymentSendFailure::PartialFailure(results))
2147 Err(PaymentSendFailure::AllFailedRetrySafe(results.drain(..).map(|r| r.unwrap_err()).collect()))
2153 /// Retries a payment along the given [`Route`].
2155 /// Errors returned are a superset of those returned from [`send_payment`], so see
2156 /// [`send_payment`] documentation for more details on errors. This method will also error if the
2157 /// retry amount puts the payment more than 10% over the payment's total amount, or if the payment
2158 /// for the given `payment_id` cannot be found (likely due to timeout or success).
2160 /// [`send_payment`]: [`ChannelManager::send_payment`]
2161 pub fn retry_payment(&self, route: &Route, payment_id: PaymentId) -> Result<(), PaymentSendFailure> {
2162 const RETRY_OVERFLOW_PERCENTAGE: u64 = 10;
2163 for path in route.paths.iter() {
2164 if path.len() == 0 {
2165 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
2166 err: "length-0 path in route".to_string()
2171 let (total_msat, payment_hash, payment_secret) = {
2172 let outbounds = self.pending_outbound_payments.lock().unwrap();
2173 if let Some(payment) = outbounds.get(&payment_id) {
2175 PendingOutboundPayment::Retryable {
2176 total_msat, payment_hash, payment_secret, pending_amt_msat, ..
2178 let retry_amt_msat: u64 = route.paths.iter().map(|path| path.last().unwrap().fee_msat).sum();
2179 if retry_amt_msat + *pending_amt_msat > *total_msat * (100 + RETRY_OVERFLOW_PERCENTAGE) / 100 {
2180 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
2181 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()
2184 (*total_msat, *payment_hash, *payment_secret)
2186 PendingOutboundPayment::Legacy { .. } => {
2187 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
2188 err: "Unable to retry payments that were initially sent on LDK versions prior to 0.0.102".to_string()
2193 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError {
2194 err: format!("Payment with ID {} not found", log_bytes!(payment_id.0)),
2198 return self.send_payment_internal(route, payment_hash, &payment_secret, None, Some(payment_id), Some(total_msat)).map(|_| ())
2201 /// Send a spontaneous payment, which is a payment that does not require the recipient to have
2202 /// generated an invoice. Optionally, you may specify the preimage. If you do choose to specify
2203 /// the preimage, it must be a cryptographically secure random value that no intermediate node
2204 /// would be able to guess -- otherwise, an intermediate node may claim the payment and it will
2205 /// never reach the recipient.
2207 /// See [`send_payment`] documentation for more details on the return value of this function.
2209 /// Similar to regular payments, you MUST NOT reuse a `payment_preimage` value. See
2210 /// [`send_payment`] for more information about the risks of duplicate preimage usage.
2212 /// Note that `route` must have exactly one path.
2214 /// [`send_payment`]: Self::send_payment
2215 pub fn send_spontaneous_payment(&self, route: &Route, payment_preimage: Option<PaymentPreimage>) -> Result<(PaymentHash, PaymentId), PaymentSendFailure> {
2216 let preimage = match payment_preimage {
2218 None => PaymentPreimage(self.keys_manager.get_secure_random_bytes()),
2220 let payment_hash = PaymentHash(Sha256::hash(&preimage.0).into_inner());
2221 match self.send_payment_internal(route, payment_hash, &None, Some(preimage), None, None) {
2222 Ok(payment_id) => Ok((payment_hash, payment_id)),
2227 /// Handles the generation of a funding transaction, optionally (for tests) with a function
2228 /// which checks the correctness of the funding transaction given the associated channel.
2229 fn funding_transaction_generated_intern<FundingOutput: Fn(&Channel<Signer>, &Transaction) -> Result<OutPoint, APIError>>
2230 (&self, temporary_channel_id: &[u8; 32], funding_transaction: Transaction, find_funding_output: FundingOutput) -> Result<(), APIError> {
2232 let (res, chan) = match self.channel_state.lock().unwrap().by_id.remove(temporary_channel_id) {
2234 let funding_txo = find_funding_output(&chan, &funding_transaction)?;
2236 (chan.get_outbound_funding_created(funding_transaction, funding_txo, &self.logger)
2237 .map_err(|e| if let ChannelError::Close(msg) = e {
2238 MsgHandleErrInternal::from_finish_shutdown(msg, chan.channel_id(), chan.force_shutdown(true), None)
2239 } else { unreachable!(); })
2242 None => { return Err(APIError::ChannelUnavailable { err: "No such channel".to_owned() }) },
2244 match handle_error!(self, res, chan.get_counterparty_node_id()) {
2245 Ok(funding_msg) => {
2248 Err(_) => { return Err(APIError::ChannelUnavailable {
2249 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()
2254 let mut channel_state = self.channel_state.lock().unwrap();
2255 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
2256 node_id: chan.get_counterparty_node_id(),
2259 match channel_state.by_id.entry(chan.channel_id()) {
2260 hash_map::Entry::Occupied(_) => {
2261 panic!("Generated duplicate funding txid?");
2263 hash_map::Entry::Vacant(e) => {
2271 pub(crate) fn funding_transaction_generated_unchecked(&self, temporary_channel_id: &[u8; 32], funding_transaction: Transaction, output_index: u16) -> Result<(), APIError> {
2272 self.funding_transaction_generated_intern(temporary_channel_id, funding_transaction, |_, tx| {
2273 Ok(OutPoint { txid: tx.txid(), index: output_index })
2277 /// Call this upon creation of a funding transaction for the given channel.
2279 /// Returns an [`APIError::APIMisuseError`] if the funding_transaction spent non-SegWit outputs
2280 /// or if no output was found which matches the parameters in [`Event::FundingGenerationReady`].
2282 /// Panics if a funding transaction has already been provided for this channel.
2284 /// May panic if the output found in the funding transaction is duplicative with some other
2285 /// channel (note that this should be trivially prevented by using unique funding transaction
2286 /// keys per-channel).
2288 /// Do NOT broadcast the funding transaction yourself. When we have safely received our
2289 /// counterparty's signature the funding transaction will automatically be broadcast via the
2290 /// [`BroadcasterInterface`] provided when this `ChannelManager` was constructed.
2292 /// Note that this includes RBF or similar transaction replacement strategies - lightning does
2293 /// not currently support replacing a funding transaction on an existing channel. Instead,
2294 /// create a new channel with a conflicting funding transaction.
2296 /// [`Event::FundingGenerationReady`]: crate::util::events::Event::FundingGenerationReady
2297 pub fn funding_transaction_generated(&self, temporary_channel_id: &[u8; 32], funding_transaction: Transaction) -> Result<(), APIError> {
2298 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2300 for inp in funding_transaction.input.iter() {
2301 if inp.witness.is_empty() {
2302 return Err(APIError::APIMisuseError {
2303 err: "Funding transaction must be fully signed and spend Segwit outputs".to_owned()
2307 self.funding_transaction_generated_intern(temporary_channel_id, funding_transaction, |chan, tx| {
2308 let mut output_index = None;
2309 let expected_spk = chan.get_funding_redeemscript().to_v0_p2wsh();
2310 for (idx, outp) in tx.output.iter().enumerate() {
2311 if outp.script_pubkey == expected_spk && outp.value == chan.get_value_satoshis() {
2312 if output_index.is_some() {
2313 return Err(APIError::APIMisuseError {
2314 err: "Multiple outputs matched the expected script and value".to_owned()
2317 if idx > u16::max_value() as usize {
2318 return Err(APIError::APIMisuseError {
2319 err: "Transaction had more than 2^16 outputs, which is not supported".to_owned()
2322 output_index = Some(idx as u16);
2325 if output_index.is_none() {
2326 return Err(APIError::APIMisuseError {
2327 err: "No output matched the script_pubkey and value in the FundingGenerationReady event".to_owned()
2330 Ok(OutPoint { txid: tx.txid(), index: output_index.unwrap() })
2334 fn get_announcement_sigs(&self, chan: &Channel<Signer>) -> Option<msgs::AnnouncementSignatures> {
2335 if !chan.should_announce() {
2336 log_trace!(self.logger, "Can't send announcement_signatures for private channel {}", log_bytes!(chan.channel_id()));
2340 let (announcement, our_bitcoin_sig) = match chan.get_channel_announcement(self.get_our_node_id(), self.genesis_hash.clone()) {
2342 Err(_) => return None, // Only in case of state precondition violations eg channel is closing
2344 let msghash = hash_to_message!(&Sha256dHash::hash(&announcement.encode()[..])[..]);
2345 let our_node_sig = self.secp_ctx.sign(&msghash, &self.our_network_key);
2347 Some(msgs::AnnouncementSignatures {
2348 channel_id: chan.channel_id(),
2349 short_channel_id: chan.get_short_channel_id().unwrap(),
2350 node_signature: our_node_sig,
2351 bitcoin_signature: our_bitcoin_sig,
2356 // Messages of up to 64KB should never end up more than half full with addresses, as that would
2357 // be absurd. We ensure this by checking that at least 500 (our stated public contract on when
2358 // broadcast_node_announcement panics) of the maximum-length addresses would fit in a 64KB
2360 const HALF_MESSAGE_IS_ADDRS: u32 = ::core::u16::MAX as u32 / (NetAddress::MAX_LEN as u32 + 1) / 2;
2363 // ...by failing to compile if the number of addresses that would be half of a message is
2364 // smaller than 500:
2365 const STATIC_ASSERT: u32 = Self::HALF_MESSAGE_IS_ADDRS - 500;
2367 /// Regenerates channel_announcements and generates a signed node_announcement from the given
2368 /// arguments, providing them in corresponding events via
2369 /// [`get_and_clear_pending_msg_events`], if at least one public channel has been confirmed
2370 /// on-chain. This effectively re-broadcasts all channel announcements and sends our node
2371 /// announcement to ensure that the lightning P2P network is aware of the channels we have and
2372 /// our network addresses.
2374 /// `rgb` is a node "color" and `alias` is a printable human-readable string to describe this
2375 /// node to humans. They carry no in-protocol meaning.
2377 /// `addresses` represent the set (possibly empty) of socket addresses on which this node
2378 /// accepts incoming connections. These will be included in the node_announcement, publicly
2379 /// tying these addresses together and to this node. If you wish to preserve user privacy,
2380 /// addresses should likely contain only Tor Onion addresses.
2382 /// Panics if `addresses` is absurdly large (more than 500).
2384 /// [`get_and_clear_pending_msg_events`]: MessageSendEventsProvider::get_and_clear_pending_msg_events
2385 pub fn broadcast_node_announcement(&self, rgb: [u8; 3], alias: [u8; 32], mut addresses: Vec<NetAddress>) {
2386 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2388 if addresses.len() > 500 {
2389 panic!("More than half the message size was taken up by public addresses!");
2392 // While all existing nodes handle unsorted addresses just fine, the spec requires that
2393 // addresses be sorted for future compatibility.
2394 addresses.sort_by_key(|addr| addr.get_id());
2396 let announcement = msgs::UnsignedNodeAnnouncement {
2397 features: NodeFeatures::known(),
2398 timestamp: self.last_node_announcement_serial.fetch_add(1, Ordering::AcqRel) as u32,
2399 node_id: self.get_our_node_id(),
2400 rgb, alias, addresses,
2401 excess_address_data: Vec::new(),
2402 excess_data: Vec::new(),
2404 let msghash = hash_to_message!(&Sha256dHash::hash(&announcement.encode()[..])[..]);
2405 let node_announce_sig = self.secp_ctx.sign(&msghash, &self.our_network_key);
2407 let mut channel_state_lock = self.channel_state.lock().unwrap();
2408 let channel_state = &mut *channel_state_lock;
2410 let mut announced_chans = false;
2411 for (_, chan) in channel_state.by_id.iter() {
2412 if let Some(msg) = chan.get_signed_channel_announcement(&self.our_network_key, self.get_our_node_id(), self.genesis_hash.clone()) {
2413 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
2415 update_msg: match self.get_channel_update_for_broadcast(chan) {
2420 announced_chans = true;
2422 // If the channel is not public or has not yet reached funding_locked, check the
2423 // next channel. If we don't yet have any public channels, we'll skip the broadcast
2424 // below as peers may not accept it without channels on chain first.
2428 if announced_chans {
2429 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastNodeAnnouncement {
2430 msg: msgs::NodeAnnouncement {
2431 signature: node_announce_sig,
2432 contents: announcement
2438 /// Processes HTLCs which are pending waiting on random forward delay.
2440 /// Should only really ever be called in response to a PendingHTLCsForwardable event.
2441 /// Will likely generate further events.
2442 pub fn process_pending_htlc_forwards(&self) {
2443 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2445 let mut new_events = Vec::new();
2446 let mut failed_forwards = Vec::new();
2447 let mut handle_errors = Vec::new();
2449 let mut channel_state_lock = self.channel_state.lock().unwrap();
2450 let channel_state = &mut *channel_state_lock;
2452 for (short_chan_id, mut pending_forwards) in channel_state.forward_htlcs.drain() {
2453 if short_chan_id != 0 {
2454 let forward_chan_id = match channel_state.short_to_id.get(&short_chan_id) {
2455 Some(chan_id) => chan_id.clone(),
2457 failed_forwards.reserve(pending_forwards.len());
2458 for forward_info in pending_forwards.drain(..) {
2459 match forward_info {
2460 HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info,
2461 prev_funding_outpoint } => {
2462 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
2463 short_channel_id: prev_short_channel_id,
2464 outpoint: prev_funding_outpoint,
2465 htlc_id: prev_htlc_id,
2466 incoming_packet_shared_secret: forward_info.incoming_shared_secret,
2468 failed_forwards.push((htlc_source, forward_info.payment_hash,
2469 HTLCFailReason::Reason { failure_code: 0x4000 | 10, data: Vec::new() }
2472 HTLCForwardInfo::FailHTLC { .. } => {
2473 // Channel went away before we could fail it. This implies
2474 // the channel is now on chain and our counterparty is
2475 // trying to broadcast the HTLC-Timeout, but that's their
2476 // problem, not ours.
2483 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(forward_chan_id) {
2484 let mut add_htlc_msgs = Vec::new();
2485 let mut fail_htlc_msgs = Vec::new();
2486 for forward_info in pending_forwards.drain(..) {
2487 match forward_info {
2488 HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info: PendingHTLCInfo {
2489 routing: PendingHTLCRouting::Forward {
2491 }, incoming_shared_secret, payment_hash, amt_to_forward, outgoing_cltv_value },
2492 prev_funding_outpoint } => {
2493 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);
2494 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
2495 short_channel_id: prev_short_channel_id,
2496 outpoint: prev_funding_outpoint,
2497 htlc_id: prev_htlc_id,
2498 incoming_packet_shared_secret: incoming_shared_secret,
2500 match chan.get_mut().send_htlc(amt_to_forward, payment_hash, outgoing_cltv_value, htlc_source.clone(), onion_packet) {
2502 if let ChannelError::Ignore(msg) = e {
2503 log_trace!(self.logger, "Failed to forward HTLC with payment_hash {}: {}", log_bytes!(payment_hash.0), msg);
2505 panic!("Stated return value requirements in send_htlc() were not met");
2507 let chan_update = self.get_channel_update_for_unicast(chan.get()).unwrap();
2508 failed_forwards.push((htlc_source, payment_hash,
2509 HTLCFailReason::Reason { failure_code: 0x1000 | 7, data: chan_update.encode_with_len() }
2515 Some(msg) => { add_htlc_msgs.push(msg); },
2517 // Nothing to do here...we're waiting on a remote
2518 // revoke_and_ack before we can add anymore HTLCs. The Channel
2519 // will automatically handle building the update_add_htlc and
2520 // commitment_signed messages when we can.
2521 // TODO: Do some kind of timer to set the channel as !is_live()
2522 // as we don't really want others relying on us relaying through
2523 // this channel currently :/.
2529 HTLCForwardInfo::AddHTLC { .. } => {
2530 panic!("short_channel_id != 0 should imply any pending_forward entries are of type Forward");
2532 HTLCForwardInfo::FailHTLC { htlc_id, err_packet } => {
2533 log_trace!(self.logger, "Failing HTLC back to channel with short id {} (backward HTLC ID {}) after delay", short_chan_id, htlc_id);
2534 match chan.get_mut().get_update_fail_htlc(htlc_id, err_packet, &self.logger) {
2536 if let ChannelError::Ignore(msg) = e {
2537 log_trace!(self.logger, "Failed to fail HTLC with ID {} backwards to short_id {}: {}", htlc_id, short_chan_id, msg);
2539 panic!("Stated return value requirements in get_update_fail_htlc() were not met");
2541 // fail-backs are best-effort, we probably already have one
2542 // pending, and if not that's OK, if not, the channel is on
2543 // the chain and sending the HTLC-Timeout is their problem.
2546 Ok(Some(msg)) => { fail_htlc_msgs.push(msg); },
2548 // Nothing to do here...we're waiting on a remote
2549 // revoke_and_ack before we can update the commitment
2550 // transaction. The Channel will automatically handle
2551 // building the update_fail_htlc and commitment_signed
2552 // messages when we can.
2553 // We don't need any kind of timer here as they should fail
2554 // the channel onto the chain if they can't get our
2555 // update_fail_htlc in time, it's not our problem.
2562 if !add_htlc_msgs.is_empty() || !fail_htlc_msgs.is_empty() {
2563 let (commitment_msg, monitor_update) = match chan.get_mut().send_commitment(&self.logger) {
2566 // We surely failed send_commitment due to bad keys, in that case
2567 // close channel and then send error message to peer.
2568 let counterparty_node_id = chan.get().get_counterparty_node_id();
2569 let err: Result<(), _> = match e {
2570 ChannelError::Ignore(_) | ChannelError::Warn(_) => {
2571 panic!("Stated return value requirements in send_commitment() were not met");
2573 ChannelError::Close(msg) => {
2574 log_trace!(self.logger, "Closing channel {} due to Close-required error: {}", log_bytes!(chan.key()[..]), msg);
2575 let (channel_id, mut channel) = chan.remove_entry();
2576 if let Some(short_id) = channel.get_short_channel_id() {
2577 channel_state.short_to_id.remove(&short_id);
2579 // ChannelClosed event is generated by handle_error for us.
2580 Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, channel.force_shutdown(true), self.get_channel_update_for_broadcast(&channel).ok()))
2582 ChannelError::CloseDelayBroadcast(_) => { panic!("Wait is only generated on receipt of channel_reestablish, which is handled by try_chan_entry, we don't bother to support it here"); }
2584 handle_errors.push((counterparty_node_id, err));
2588 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
2589 handle_errors.push((chan.get().get_counterparty_node_id(), handle_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, true)));
2592 log_debug!(self.logger, "Forwarding HTLCs resulted in a commitment update with {} HTLCs added and {} HTLCs failed for channel {}",
2593 add_htlc_msgs.len(), fail_htlc_msgs.len(), log_bytes!(chan.get().channel_id()));
2594 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2595 node_id: chan.get().get_counterparty_node_id(),
2596 updates: msgs::CommitmentUpdate {
2597 update_add_htlcs: add_htlc_msgs,
2598 update_fulfill_htlcs: Vec::new(),
2599 update_fail_htlcs: fail_htlc_msgs,
2600 update_fail_malformed_htlcs: Vec::new(),
2602 commitment_signed: commitment_msg,
2610 for forward_info in pending_forwards.drain(..) {
2611 match forward_info {
2612 HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info: PendingHTLCInfo {
2613 routing, incoming_shared_secret, payment_hash, amt_to_forward, .. },
2614 prev_funding_outpoint } => {
2615 let (cltv_expiry, onion_payload) = match routing {
2616 PendingHTLCRouting::Receive { payment_data, incoming_cltv_expiry } =>
2617 (incoming_cltv_expiry, OnionPayload::Invoice(payment_data)),
2618 PendingHTLCRouting::ReceiveKeysend { payment_preimage, incoming_cltv_expiry } =>
2619 (incoming_cltv_expiry, OnionPayload::Spontaneous(payment_preimage)),
2621 panic!("short_channel_id == 0 should imply any pending_forward entries are of type Receive");
2624 let claimable_htlc = ClaimableHTLC {
2625 prev_hop: HTLCPreviousHopData {
2626 short_channel_id: prev_short_channel_id,
2627 outpoint: prev_funding_outpoint,
2628 htlc_id: prev_htlc_id,
2629 incoming_packet_shared_secret: incoming_shared_secret,
2631 value: amt_to_forward,
2636 macro_rules! fail_htlc {
2638 let mut htlc_msat_height_data = byte_utils::be64_to_array($htlc.value).to_vec();
2639 htlc_msat_height_data.extend_from_slice(
2640 &byte_utils::be32_to_array(self.best_block.read().unwrap().height()),
2642 failed_forwards.push((HTLCSource::PreviousHopData(HTLCPreviousHopData {
2643 short_channel_id: $htlc.prev_hop.short_channel_id,
2644 outpoint: prev_funding_outpoint,
2645 htlc_id: $htlc.prev_hop.htlc_id,
2646 incoming_packet_shared_secret: $htlc.prev_hop.incoming_packet_shared_secret,
2648 HTLCFailReason::Reason { failure_code: 0x4000 | 15, data: htlc_msat_height_data }
2653 // Check that the payment hash and secret are known. Note that we
2654 // MUST take care to handle the "unknown payment hash" and
2655 // "incorrect payment secret" cases here identically or we'd expose
2656 // that we are the ultimate recipient of the given payment hash.
2657 // Further, we must not expose whether we have any other HTLCs
2658 // associated with the same payment_hash pending or not.
2659 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
2660 match payment_secrets.entry(payment_hash) {
2661 hash_map::Entry::Vacant(_) => {
2662 match claimable_htlc.onion_payload {
2663 OnionPayload::Invoice(_) => {
2664 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as we didn't have a corresponding inbound payment.", log_bytes!(payment_hash.0));
2665 fail_htlc!(claimable_htlc);
2667 OnionPayload::Spontaneous(preimage) => {
2668 match channel_state.claimable_htlcs.entry(payment_hash) {
2669 hash_map::Entry::Vacant(e) => {
2670 e.insert(vec![claimable_htlc]);
2671 new_events.push(events::Event::PaymentReceived {
2673 amt: amt_to_forward,
2674 purpose: events::PaymentPurpose::SpontaneousPayment(preimage),
2677 hash_map::Entry::Occupied(_) => {
2678 log_trace!(self.logger, "Failing new keysend HTLC with payment_hash {} for a duplicative payment hash", log_bytes!(payment_hash.0));
2679 fail_htlc!(claimable_htlc);
2685 hash_map::Entry::Occupied(inbound_payment) => {
2687 if let OnionPayload::Invoice(ref data) = claimable_htlc.onion_payload {
2690 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));
2691 fail_htlc!(claimable_htlc);
2694 if inbound_payment.get().payment_secret != payment_data.payment_secret {
2695 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our expected payment secret.", log_bytes!(payment_hash.0));
2696 fail_htlc!(claimable_htlc);
2697 } else if inbound_payment.get().min_value_msat.is_some() && payment_data.total_msat < inbound_payment.get().min_value_msat.unwrap() {
2698 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our minimum value (had {}, needed {}).",
2699 log_bytes!(payment_hash.0), payment_data.total_msat, inbound_payment.get().min_value_msat.unwrap());
2700 fail_htlc!(claimable_htlc);
2702 let mut total_value = 0;
2703 let htlcs = channel_state.claimable_htlcs.entry(payment_hash)
2704 .or_insert(Vec::new());
2705 if htlcs.len() == 1 {
2706 if let OnionPayload::Spontaneous(_) = htlcs[0].onion_payload {
2707 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));
2708 fail_htlc!(claimable_htlc);
2712 htlcs.push(claimable_htlc);
2713 for htlc in htlcs.iter() {
2714 total_value += htlc.value;
2715 match &htlc.onion_payload {
2716 OnionPayload::Invoice(htlc_payment_data) => {
2717 if htlc_payment_data.total_msat != payment_data.total_msat {
2718 log_trace!(self.logger, "Failing HTLCs with payment_hash {} as the HTLCs had inconsistent total values (eg {} and {})",
2719 log_bytes!(payment_hash.0), payment_data.total_msat, htlc_payment_data.total_msat);
2720 total_value = msgs::MAX_VALUE_MSAT;
2722 if total_value >= msgs::MAX_VALUE_MSAT { break; }
2724 _ => unreachable!(),
2727 if total_value >= msgs::MAX_VALUE_MSAT || total_value > payment_data.total_msat {
2728 log_trace!(self.logger, "Failing HTLCs with payment_hash {} as the total value {} ran over expected value {} (or HTLCs were inconsistent)",
2729 log_bytes!(payment_hash.0), total_value, payment_data.total_msat);
2730 for htlc in htlcs.iter() {
2733 } else if total_value == payment_data.total_msat {
2734 new_events.push(events::Event::PaymentReceived {
2736 purpose: events::PaymentPurpose::InvoicePayment {
2737 payment_preimage: inbound_payment.get().payment_preimage,
2738 payment_secret: payment_data.payment_secret,
2739 user_payment_id: inbound_payment.get().user_payment_id,
2743 // Only ever generate at most one PaymentReceived
2744 // per registered payment_hash, even if it isn't
2746 inbound_payment.remove_entry();
2748 // Nothing to do - we haven't reached the total
2749 // payment value yet, wait until we receive more
2756 HTLCForwardInfo::FailHTLC { .. } => {
2757 panic!("Got pending fail of our own HTLC");
2765 for (htlc_source, payment_hash, failure_reason) in failed_forwards.drain(..) {
2766 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source, &payment_hash, failure_reason);
2769 for (counterparty_node_id, err) in handle_errors.drain(..) {
2770 let _ = handle_error!(self, err, counterparty_node_id);
2773 if new_events.is_empty() { return }
2774 let mut events = self.pending_events.lock().unwrap();
2775 events.append(&mut new_events);
2778 /// Free the background events, generally called from timer_tick_occurred.
2780 /// Exposed for testing to allow us to process events quickly without generating accidental
2781 /// BroadcastChannelUpdate events in timer_tick_occurred.
2783 /// Expects the caller to have a total_consistency_lock read lock.
2784 fn process_background_events(&self) -> bool {
2785 let mut background_events = Vec::new();
2786 mem::swap(&mut *self.pending_background_events.lock().unwrap(), &mut background_events);
2787 if background_events.is_empty() {
2791 for event in background_events.drain(..) {
2793 BackgroundEvent::ClosingMonitorUpdate((funding_txo, update)) => {
2794 // The channel has already been closed, so no use bothering to care about the
2795 // monitor updating completing.
2796 let _ = self.chain_monitor.update_channel(funding_txo, update);
2803 #[cfg(any(test, feature = "_test_utils"))]
2804 /// Process background events, for functional testing
2805 pub fn test_process_background_events(&self) {
2806 self.process_background_events();
2809 fn update_channel_fee(&self, short_to_id: &mut HashMap<u64, [u8; 32]>, pending_msg_events: &mut Vec<events::MessageSendEvent>, chan_id: &[u8; 32], chan: &mut Channel<Signer>, new_feerate: u32) -> (bool, NotifyOption, Result<(), MsgHandleErrInternal>) {
2810 if !chan.is_outbound() { return (true, NotifyOption::SkipPersist, Ok(())); }
2811 // If the feerate has decreased by less than half, don't bother
2812 if new_feerate <= chan.get_feerate() && new_feerate * 2 > chan.get_feerate() {
2813 log_trace!(self.logger, "Channel {} does not qualify for a feerate change from {} to {}.",
2814 log_bytes!(chan_id[..]), chan.get_feerate(), new_feerate);
2815 return (true, NotifyOption::SkipPersist, Ok(()));
2817 if !chan.is_live() {
2818 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).",
2819 log_bytes!(chan_id[..]), chan.get_feerate(), new_feerate);
2820 return (true, NotifyOption::SkipPersist, Ok(()));
2822 log_trace!(self.logger, "Channel {} qualifies for a feerate change from {} to {}.",
2823 log_bytes!(chan_id[..]), chan.get_feerate(), new_feerate);
2825 let mut retain_channel = true;
2826 let res = match chan.send_update_fee_and_commit(new_feerate, &self.logger) {
2829 let (drop, res) = convert_chan_err!(self, e, short_to_id, chan, chan_id);
2830 if drop { retain_channel = false; }
2834 let ret_err = match res {
2835 Ok(Some((update_fee, commitment_signed, monitor_update))) => {
2836 if let Err(e) = self.chain_monitor.update_channel(chan.get_funding_txo().unwrap(), monitor_update) {
2837 let (res, drop) = handle_monitor_err!(self, e, short_to_id, chan, RAACommitmentOrder::CommitmentFirst, false, true, Vec::new(), Vec::new(), chan_id);
2838 if drop { retain_channel = false; }
2841 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2842 node_id: chan.get_counterparty_node_id(),
2843 updates: msgs::CommitmentUpdate {
2844 update_add_htlcs: Vec::new(),
2845 update_fulfill_htlcs: Vec::new(),
2846 update_fail_htlcs: Vec::new(),
2847 update_fail_malformed_htlcs: Vec::new(),
2848 update_fee: Some(update_fee),
2858 (retain_channel, NotifyOption::DoPersist, ret_err)
2862 /// In chanmon_consistency we want to sometimes do the channel fee updates done in
2863 /// timer_tick_occurred, but we can't generate the disabled channel updates as it considers
2864 /// these a fuzz failure (as they usually indicate a channel force-close, which is exactly what
2865 /// it wants to detect). Thus, we have a variant exposed here for its benefit.
2866 pub fn maybe_update_chan_fees(&self) {
2867 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
2868 let mut should_persist = NotifyOption::SkipPersist;
2870 let new_feerate = self.fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
2872 let mut handle_errors = Vec::new();
2874 let mut channel_state_lock = self.channel_state.lock().unwrap();
2875 let channel_state = &mut *channel_state_lock;
2876 let pending_msg_events = &mut channel_state.pending_msg_events;
2877 let short_to_id = &mut channel_state.short_to_id;
2878 channel_state.by_id.retain(|chan_id, chan| {
2879 let (retain_channel, chan_needs_persist, err) = self.update_channel_fee(short_to_id, pending_msg_events, chan_id, chan, new_feerate);
2880 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
2882 handle_errors.push(err);
2892 /// Performs actions which should happen on startup and roughly once per minute thereafter.
2894 /// This currently includes:
2895 /// * Increasing or decreasing the on-chain feerate estimates for our outbound channels,
2896 /// * Broadcasting `ChannelUpdate` messages if we've been disconnected from our peer for more
2897 /// than a minute, informing the network that they should no longer attempt to route over
2900 /// Note that this may cause reentrancy through `chain::Watch::update_channel` calls or feerate
2901 /// estimate fetches.
2902 pub fn timer_tick_occurred(&self) {
2903 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
2904 let mut should_persist = NotifyOption::SkipPersist;
2905 if self.process_background_events() { should_persist = NotifyOption::DoPersist; }
2907 let new_feerate = self.fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
2909 let mut handle_errors = Vec::new();
2911 let mut channel_state_lock = self.channel_state.lock().unwrap();
2912 let channel_state = &mut *channel_state_lock;
2913 let pending_msg_events = &mut channel_state.pending_msg_events;
2914 let short_to_id = &mut channel_state.short_to_id;
2915 channel_state.by_id.retain(|chan_id, chan| {
2916 let counterparty_node_id = chan.get_counterparty_node_id();
2917 let (retain_channel, chan_needs_persist, err) = self.update_channel_fee(short_to_id, pending_msg_events, chan_id, chan, new_feerate);
2918 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
2920 handle_errors.push((err, counterparty_node_id));
2922 if !retain_channel { return false; }
2924 if let Err(e) = chan.timer_check_closing_negotiation_progress() {
2925 let (needs_close, err) = convert_chan_err!(self, e, short_to_id, chan, chan_id);
2926 handle_errors.push((Err(err), chan.get_counterparty_node_id()));
2927 if needs_close { return false; }
2930 match chan.channel_update_status() {
2931 ChannelUpdateStatus::Enabled if !chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::DisabledStaged),
2932 ChannelUpdateStatus::Disabled if chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::EnabledStaged),
2933 ChannelUpdateStatus::DisabledStaged if chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::Enabled),
2934 ChannelUpdateStatus::EnabledStaged if !chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::Disabled),
2935 ChannelUpdateStatus::DisabledStaged if !chan.is_live() => {
2936 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
2937 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2941 should_persist = NotifyOption::DoPersist;
2942 chan.set_channel_update_status(ChannelUpdateStatus::Disabled);
2944 ChannelUpdateStatus::EnabledStaged if chan.is_live() => {
2945 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
2946 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2950 should_persist = NotifyOption::DoPersist;
2951 chan.set_channel_update_status(ChannelUpdateStatus::Enabled);
2960 for (err, counterparty_node_id) in handle_errors.drain(..) {
2961 let _ = handle_error!(self, err, counterparty_node_id);
2967 /// Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
2968 /// after a PaymentReceived event, failing the HTLC back to its origin and freeing resources
2969 /// along the path (including in our own channel on which we received it).
2970 /// Returns false if no payment was found to fail backwards, true if the process of failing the
2971 /// HTLC backwards has been started.
2972 pub fn fail_htlc_backwards(&self, payment_hash: &PaymentHash) -> bool {
2973 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2975 let mut channel_state = Some(self.channel_state.lock().unwrap());
2976 let removed_source = channel_state.as_mut().unwrap().claimable_htlcs.remove(payment_hash);
2977 if let Some(mut sources) = removed_source {
2978 for htlc in sources.drain(..) {
2979 if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
2980 let mut htlc_msat_height_data = byte_utils::be64_to_array(htlc.value).to_vec();
2981 htlc_msat_height_data.extend_from_slice(&byte_utils::be32_to_array(
2982 self.best_block.read().unwrap().height()));
2983 self.fail_htlc_backwards_internal(channel_state.take().unwrap(),
2984 HTLCSource::PreviousHopData(htlc.prev_hop), payment_hash,
2985 HTLCFailReason::Reason { failure_code: 0x4000 | 15, data: htlc_msat_height_data });
2991 // Fail a list of HTLCs that were just freed from the holding cell. The HTLCs need to be
2992 // failed backwards or, if they were one of our outgoing HTLCs, then their failure needs to
2993 // be surfaced to the user.
2994 fn fail_holding_cell_htlcs(&self, mut htlcs_to_fail: Vec<(HTLCSource, PaymentHash)>, channel_id: [u8; 32]) {
2995 for (htlc_src, payment_hash) in htlcs_to_fail.drain(..) {
2997 HTLCSource::PreviousHopData(HTLCPreviousHopData { .. }) => {
2998 let (failure_code, onion_failure_data) =
2999 match self.channel_state.lock().unwrap().by_id.entry(channel_id) {
3000 hash_map::Entry::Occupied(chan_entry) => {
3001 if let Ok(upd) = self.get_channel_update_for_unicast(&chan_entry.get()) {
3002 (0x1000|7, upd.encode_with_len())
3004 (0x4000|10, Vec::new())
3007 hash_map::Entry::Vacant(_) => (0x4000|10, Vec::new())
3009 let channel_state = self.channel_state.lock().unwrap();
3010 self.fail_htlc_backwards_internal(channel_state,
3011 htlc_src, &payment_hash, HTLCFailReason::Reason { failure_code, data: onion_failure_data});
3013 HTLCSource::OutboundRoute { session_priv, payment_id, path, .. } => {
3014 let mut session_priv_bytes = [0; 32];
3015 session_priv_bytes.copy_from_slice(&session_priv[..]);
3016 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
3017 if let hash_map::Entry::Occupied(mut payment) = outbounds.entry(payment_id) {
3018 if payment.get_mut().remove(&session_priv_bytes, path.last().unwrap().fee_msat) {
3019 self.pending_events.lock().unwrap().push(
3020 events::Event::PaymentPathFailed {
3022 rejected_by_dest: false,
3023 network_update: None,
3024 all_paths_failed: payment.get().remaining_parts() == 0,
3026 short_channel_id: None,
3035 log_trace!(self.logger, "Received duplicative fail for HTLC with payment_hash {}", log_bytes!(payment_hash.0));
3042 /// Fails an HTLC backwards to the sender of it to us.
3043 /// Note that while we take a channel_state lock as input, we do *not* assume consistency here.
3044 /// There are several callsites that do stupid things like loop over a list of payment_hashes
3045 /// to fail and take the channel_state lock for each iteration (as we take ownership and may
3046 /// drop it). In other words, no assumptions are made that entries in claimable_htlcs point to
3047 /// still-available channels.
3048 fn fail_htlc_backwards_internal(&self, mut channel_state_lock: MutexGuard<ChannelHolder<Signer>>, source: HTLCSource, payment_hash: &PaymentHash, onion_error: HTLCFailReason) {
3049 //TODO: There is a timing attack here where if a node fails an HTLC back to us they can
3050 //identify whether we sent it or not based on the (I presume) very different runtime
3051 //between the branches here. We should make this async and move it into the forward HTLCs
3054 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
3055 // from block_connected which may run during initialization prior to the chain_monitor
3056 // being fully configured. See the docs for `ChannelManagerReadArgs` for more.
3058 HTLCSource::OutboundRoute { ref path, session_priv, payment_id, .. } => {
3059 let mut session_priv_bytes = [0; 32];
3060 session_priv_bytes.copy_from_slice(&session_priv[..]);
3061 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
3062 let mut all_paths_failed = false;
3063 if let hash_map::Entry::Occupied(mut sessions) = outbounds.entry(payment_id) {
3064 if !sessions.get_mut().remove(&session_priv_bytes, path.last().unwrap().fee_msat) {
3065 log_trace!(self.logger, "Received duplicative fail for HTLC with payment_hash {}", log_bytes!(payment_hash.0));
3068 if sessions.get().remaining_parts() == 0 {
3069 all_paths_failed = true;
3072 log_trace!(self.logger, "Received duplicative fail for HTLC with payment_hash {}", log_bytes!(payment_hash.0));
3075 log_trace!(self.logger, "Failing outbound payment HTLC with payment_hash {}", log_bytes!(payment_hash.0));
3076 mem::drop(channel_state_lock);
3077 match &onion_error {
3078 &HTLCFailReason::LightningError { ref err } => {
3080 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());
3082 let (network_update, short_channel_id, payment_retryable, _, _) = onion_utils::process_onion_failure(&self.secp_ctx, &self.logger, &source, err.data.clone());
3083 // TODO: If we decided to blame ourselves (or one of our channels) in
3084 // process_onion_failure we should close that channel as it implies our
3085 // next-hop is needlessly blaming us!
3086 self.pending_events.lock().unwrap().push(
3087 events::Event::PaymentPathFailed {
3088 payment_hash: payment_hash.clone(),
3089 rejected_by_dest: !payment_retryable,
3095 error_code: onion_error_code,
3097 error_data: onion_error_data
3101 &HTLCFailReason::Reason {
3107 // we get a fail_malformed_htlc from the first hop
3108 // TODO: We'd like to generate a NetworkUpdate for temporary
3109 // failures here, but that would be insufficient as get_route
3110 // generally ignores its view of our own channels as we provide them via
3112 // TODO: For non-temporary failures, we really should be closing the
3113 // channel here as we apparently can't relay through them anyway.
3114 self.pending_events.lock().unwrap().push(
3115 events::Event::PaymentPathFailed {
3116 payment_hash: payment_hash.clone(),
3117 rejected_by_dest: path.len() == 1,
3118 network_update: None,
3121 short_channel_id: Some(path.first().unwrap().short_channel_id),
3123 error_code: Some(*failure_code),
3125 error_data: Some(data.clone()),
3131 HTLCSource::PreviousHopData(HTLCPreviousHopData { short_channel_id, htlc_id, incoming_packet_shared_secret, .. }) => {
3132 let err_packet = match onion_error {
3133 HTLCFailReason::Reason { failure_code, data } => {
3134 log_trace!(self.logger, "Failing HTLC with payment_hash {} backwards from us with code {}", log_bytes!(payment_hash.0), failure_code);
3135 let packet = onion_utils::build_failure_packet(&incoming_packet_shared_secret, failure_code, &data[..]).encode();
3136 onion_utils::encrypt_failure_packet(&incoming_packet_shared_secret, &packet)
3138 HTLCFailReason::LightningError { err } => {
3139 log_trace!(self.logger, "Failing HTLC with payment_hash {} backwards with pre-built LightningError", log_bytes!(payment_hash.0));
3140 onion_utils::encrypt_failure_packet(&incoming_packet_shared_secret, &err.data)
3144 let mut forward_event = None;
3145 if channel_state_lock.forward_htlcs.is_empty() {
3146 forward_event = Some(Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS));
3148 match channel_state_lock.forward_htlcs.entry(short_channel_id) {
3149 hash_map::Entry::Occupied(mut entry) => {
3150 entry.get_mut().push(HTLCForwardInfo::FailHTLC { htlc_id, err_packet });
3152 hash_map::Entry::Vacant(entry) => {
3153 entry.insert(vec!(HTLCForwardInfo::FailHTLC { htlc_id, err_packet }));
3156 mem::drop(channel_state_lock);
3157 if let Some(time) = forward_event {
3158 let mut pending_events = self.pending_events.lock().unwrap();
3159 pending_events.push(events::Event::PendingHTLCsForwardable {
3160 time_forwardable: time
3167 /// Provides a payment preimage in response to a PaymentReceived event, returning true and
3168 /// generating message events for the net layer to claim the payment, if possible. Thus, you
3169 /// should probably kick the net layer to go send messages if this returns true!
3171 /// Note that if you did not set an `amount_msat` when calling [`create_inbound_payment`] or
3172 /// [`create_inbound_payment_for_hash`] you must check that the amount in the `PaymentReceived`
3173 /// event matches your expectation. If you fail to do so and call this method, you may provide
3174 /// the sender "proof-of-payment" when they did not fulfill the full expected payment.
3176 /// May panic if called except in response to a PaymentReceived event.
3178 /// [`create_inbound_payment`]: Self::create_inbound_payment
3179 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
3180 pub fn claim_funds(&self, payment_preimage: PaymentPreimage) -> bool {
3181 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
3183 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
3185 let mut channel_state = Some(self.channel_state.lock().unwrap());
3186 let removed_source = channel_state.as_mut().unwrap().claimable_htlcs.remove(&payment_hash);
3187 if let Some(mut sources) = removed_source {
3188 assert!(!sources.is_empty());
3190 // If we are claiming an MPP payment, we have to take special care to ensure that each
3191 // channel exists before claiming all of the payments (inside one lock).
3192 // Note that channel existance is sufficient as we should always get a monitor update
3193 // which will take care of the real HTLC claim enforcement.
3195 // If we find an HTLC which we would need to claim but for which we do not have a
3196 // channel, we will fail all parts of the MPP payment. While we could wait and see if
3197 // the sender retries the already-failed path(s), it should be a pretty rare case where
3198 // we got all the HTLCs and then a channel closed while we were waiting for the user to
3199 // provide the preimage, so worrying too much about the optimal handling isn't worth
3201 let mut valid_mpp = true;
3202 for htlc in sources.iter() {
3203 if let None = channel_state.as_ref().unwrap().short_to_id.get(&htlc.prev_hop.short_channel_id) {
3209 let mut errs = Vec::new();
3210 let mut claimed_any_htlcs = false;
3211 for htlc in sources.drain(..) {
3213 if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
3214 let mut htlc_msat_height_data = byte_utils::be64_to_array(htlc.value).to_vec();
3215 htlc_msat_height_data.extend_from_slice(&byte_utils::be32_to_array(
3216 self.best_block.read().unwrap().height()));
3217 self.fail_htlc_backwards_internal(channel_state.take().unwrap(),
3218 HTLCSource::PreviousHopData(htlc.prev_hop), &payment_hash,
3219 HTLCFailReason::Reason { failure_code: 0x4000|15, data: htlc_msat_height_data });
3221 match self.claim_funds_from_hop(channel_state.as_mut().unwrap(), htlc.prev_hop, payment_preimage) {
3222 ClaimFundsFromHop::MonitorUpdateFail(pk, err, _) => {
3223 if let msgs::ErrorAction::IgnoreError = err.err.action {
3224 // We got a temporary failure updating monitor, but will claim the
3225 // HTLC when the monitor updating is restored (or on chain).
3226 log_error!(self.logger, "Temporary failure claiming HTLC, treating as success: {}", err.err.err);
3227 claimed_any_htlcs = true;
3228 } else { errs.push((pk, err)); }
3230 ClaimFundsFromHop::PrevHopForceClosed => unreachable!("We already checked for channel existence, we can't fail here!"),
3231 ClaimFundsFromHop::DuplicateClaim => {
3232 // While we should never get here in most cases, if we do, it likely
3233 // indicates that the HTLC was timed out some time ago and is no longer
3234 // available to be claimed. Thus, it does not make sense to set
3235 // `claimed_any_htlcs`.
3237 ClaimFundsFromHop::Success(_) => claimed_any_htlcs = true,
3242 // Now that we've done the entire above loop in one lock, we can handle any errors
3243 // which were generated.
3244 channel_state.take();
3246 for (counterparty_node_id, err) in errs.drain(..) {
3247 let res: Result<(), _> = Err(err);
3248 let _ = handle_error!(self, res, counterparty_node_id);
3255 fn claim_funds_from_hop(&self, channel_state_lock: &mut MutexGuard<ChannelHolder<Signer>>, prev_hop: HTLCPreviousHopData, payment_preimage: PaymentPreimage) -> ClaimFundsFromHop {
3256 //TODO: Delay the claimed_funds relaying just like we do outbound relay!
3257 let channel_state = &mut **channel_state_lock;
3258 let chan_id = match channel_state.short_to_id.get(&prev_hop.short_channel_id) {
3259 Some(chan_id) => chan_id.clone(),
3261 return ClaimFundsFromHop::PrevHopForceClosed
3265 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(chan_id) {
3266 match chan.get_mut().get_update_fulfill_htlc_and_commit(prev_hop.htlc_id, payment_preimage, &self.logger) {
3267 Ok(msgs_monitor_option) => {
3268 if let UpdateFulfillCommitFetch::NewClaim { msgs, htlc_value_msat, monitor_update } = msgs_monitor_option {
3269 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
3270 log_given_level!(self.logger, if e == ChannelMonitorUpdateErr::PermanentFailure { Level::Error } else { Level::Debug },
3271 "Failed to update channel monitor with preimage {:?}: {:?}",
3272 payment_preimage, e);
3273 return ClaimFundsFromHop::MonitorUpdateFail(
3274 chan.get().get_counterparty_node_id(),
3275 handle_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, msgs.is_some()).unwrap_err(),
3276 Some(htlc_value_msat)
3279 if let Some((msg, commitment_signed)) = msgs {
3280 log_debug!(self.logger, "Claiming funds for HTLC with preimage {} resulted in a commitment_signed for channel {}",
3281 log_bytes!(payment_preimage.0), 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: Vec::new(),
3286 update_fulfill_htlcs: vec![msg],
3287 update_fail_htlcs: Vec::new(),
3288 update_fail_malformed_htlcs: Vec::new(),
3294 return ClaimFundsFromHop::Success(htlc_value_msat);
3296 return ClaimFundsFromHop::DuplicateClaim;
3299 Err((e, monitor_update)) => {
3300 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
3301 log_given_level!(self.logger, if e == ChannelMonitorUpdateErr::PermanentFailure { Level::Error } else { Level::Info },
3302 "Failed to update channel monitor with preimage {:?} immediately prior to force-close: {:?}",
3303 payment_preimage, e);
3305 let counterparty_node_id = chan.get().get_counterparty_node_id();
3306 let (drop, res) = convert_chan_err!(self, e, channel_state.short_to_id, chan.get_mut(), &chan_id);
3308 chan.remove_entry();
3310 return ClaimFundsFromHop::MonitorUpdateFail(counterparty_node_id, res, None);
3313 } else { unreachable!(); }
3316 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) {
3318 HTLCSource::OutboundRoute { session_priv, payment_id, path, .. } => {
3319 mem::drop(channel_state_lock);
3320 let mut session_priv_bytes = [0; 32];
3321 session_priv_bytes.copy_from_slice(&session_priv[..]);
3322 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
3323 let found_payment = if let Some(mut sessions) = outbounds.remove(&payment_id) {
3324 sessions.remove(&session_priv_bytes, path.last().unwrap().fee_msat)
3327 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
3328 self.pending_events.lock().unwrap().push(
3329 events::Event::PaymentSent {
3331 payment_hash: payment_hash
3335 log_trace!(self.logger, "Received duplicative fulfill for HTLC with payment_preimage {}", log_bytes!(payment_preimage.0));
3338 HTLCSource::PreviousHopData(hop_data) => {
3339 let prev_outpoint = hop_data.outpoint;
3340 let res = self.claim_funds_from_hop(&mut channel_state_lock, hop_data, payment_preimage);
3341 let claimed_htlc = if let ClaimFundsFromHop::DuplicateClaim = res { false } else { true };
3342 let htlc_claim_value_msat = match res {
3343 ClaimFundsFromHop::MonitorUpdateFail(_, _, amt_opt) => amt_opt,
3344 ClaimFundsFromHop::Success(amt) => Some(amt),
3347 if let ClaimFundsFromHop::PrevHopForceClosed = res {
3348 let preimage_update = ChannelMonitorUpdate {
3349 update_id: CLOSED_CHANNEL_UPDATE_ID,
3350 updates: vec![ChannelMonitorUpdateStep::PaymentPreimage {
3351 payment_preimage: payment_preimage.clone(),
3354 // We update the ChannelMonitor on the backward link, after
3355 // receiving an offchain preimage event from the forward link (the
3356 // event being update_fulfill_htlc).
3357 if let Err(e) = self.chain_monitor.update_channel(prev_outpoint, preimage_update) {
3358 log_error!(self.logger, "Critical error: failed to update channel monitor with preimage {:?}: {:?}",
3359 payment_preimage, e);
3361 // Note that we do *not* set `claimed_htlc` to false here. In fact, this
3362 // totally could be a duplicate claim, but we have no way of knowing
3363 // without interrogating the `ChannelMonitor` we've provided the above
3364 // update to. Instead, we simply document in `PaymentForwarded` that this
3367 mem::drop(channel_state_lock);
3368 if let ClaimFundsFromHop::MonitorUpdateFail(pk, err, _) = res {
3369 let result: Result<(), _> = Err(err);
3370 let _ = handle_error!(self, result, pk);
3374 if let Some(forwarded_htlc_value) = forwarded_htlc_value_msat {
3375 let fee_earned_msat = if let Some(claimed_htlc_value) = htlc_claim_value_msat {
3376 Some(claimed_htlc_value - forwarded_htlc_value)
3379 let mut pending_events = self.pending_events.lock().unwrap();
3380 pending_events.push(events::Event::PaymentForwarded {
3382 claim_from_onchain_tx: from_onchain,
3390 /// Gets the node_id held by this ChannelManager
3391 pub fn get_our_node_id(&self) -> PublicKey {
3392 self.our_network_pubkey.clone()
3395 /// Restores a single, given channel to normal operation after a
3396 /// ChannelMonitorUpdateErr::TemporaryFailure was returned from a channel monitor update
3399 /// All ChannelMonitor updates up to and including highest_applied_update_id must have been
3400 /// fully committed in every copy of the given channels' ChannelMonitors.
3402 /// Note that there is no effect to calling with a highest_applied_update_id other than the
3403 /// current latest ChannelMonitorUpdate and one call to this function after multiple
3404 /// ChannelMonitorUpdateErr::TemporaryFailures is fine. The highest_applied_update_id field
3405 /// exists largely only to prevent races between this and concurrent update_monitor calls.
3407 /// Thus, the anticipated use is, at a high level:
3408 /// 1) You register a chain::Watch with this ChannelManager,
3409 /// 2) it stores each update to disk, and begins updating any remote (eg watchtower) copies of
3410 /// said ChannelMonitors as it can, returning ChannelMonitorUpdateErr::TemporaryFailures
3411 /// any time it cannot do so instantly,
3412 /// 3) update(s) are applied to each remote copy of a ChannelMonitor,
3413 /// 4) once all remote copies are updated, you call this function with the update_id that
3414 /// completed, and once it is the latest the Channel will be re-enabled.
3415 pub fn channel_monitor_updated(&self, funding_txo: &OutPoint, highest_applied_update_id: u64) {
3416 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
3418 let chan_restoration_res;
3419 let mut pending_failures = {
3420 let mut channel_lock = self.channel_state.lock().unwrap();
3421 let channel_state = &mut *channel_lock;
3422 let mut channel = match channel_state.by_id.entry(funding_txo.to_channel_id()) {
3423 hash_map::Entry::Occupied(chan) => chan,
3424 hash_map::Entry::Vacant(_) => return,
3426 if !channel.get().is_awaiting_monitor_update() || channel.get().get_latest_monitor_update_id() != highest_applied_update_id {
3430 let (raa, commitment_update, order, pending_forwards, pending_failures, funding_broadcastable, funding_locked) = channel.get_mut().monitor_updating_restored(&self.logger);
3431 let channel_update = if funding_locked.is_some() && channel.get().is_usable() && !channel.get().should_announce() {
3432 // We only send a channel_update in the case where we are just now sending a
3433 // funding_locked and the channel is in a usable state. Further, we rely on the
3434 // normal announcement_signatures process to send a channel_update for public
3435 // channels, only generating a unicast channel_update if this is a private channel.
3436 Some(events::MessageSendEvent::SendChannelUpdate {
3437 node_id: channel.get().get_counterparty_node_id(),
3438 msg: self.get_channel_update_for_unicast(channel.get()).unwrap(),
3441 chan_restoration_res = handle_chan_restoration_locked!(self, channel_lock, channel_state, channel, raa, commitment_update, order, None, pending_forwards, funding_broadcastable, funding_locked);
3442 if let Some(upd) = channel_update {
3443 channel_state.pending_msg_events.push(upd);
3447 post_handle_chan_restoration!(self, chan_restoration_res);
3448 for failure in pending_failures.drain(..) {
3449 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), failure.0, &failure.1, failure.2);
3453 fn internal_open_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::OpenChannel) -> Result<(), MsgHandleErrInternal> {
3454 if msg.chain_hash != self.genesis_hash {
3455 return Err(MsgHandleErrInternal::send_err_msg_no_close("Unknown genesis block hash".to_owned(), msg.temporary_channel_id.clone()));
3458 let channel = Channel::new_from_req(&self.fee_estimator, &self.keys_manager, counterparty_node_id.clone(), &their_features, msg, 0, &self.default_configuration)
3459 .map_err(|e| MsgHandleErrInternal::from_chan_no_close(e, msg.temporary_channel_id))?;
3460 let mut channel_state_lock = self.channel_state.lock().unwrap();
3461 let channel_state = &mut *channel_state_lock;
3462 match channel_state.by_id.entry(channel.channel_id()) {
3463 hash_map::Entry::Occupied(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("temporary_channel_id collision!".to_owned(), msg.temporary_channel_id.clone())),
3464 hash_map::Entry::Vacant(entry) => {
3465 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
3466 node_id: counterparty_node_id.clone(),
3467 msg: channel.get_accept_channel(),
3469 entry.insert(channel);
3475 fn internal_accept_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::AcceptChannel) -> Result<(), MsgHandleErrInternal> {
3476 let (value, output_script, user_id) = {
3477 let mut channel_lock = self.channel_state.lock().unwrap();
3478 let channel_state = &mut *channel_lock;
3479 match channel_state.by_id.entry(msg.temporary_channel_id) {
3480 hash_map::Entry::Occupied(mut chan) => {
3481 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3482 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.temporary_channel_id));
3484 try_chan_entry!(self, chan.get_mut().accept_channel(&msg, &self.default_configuration, &their_features), channel_state, chan);
3485 (chan.get().get_value_satoshis(), chan.get().get_funding_redeemscript().to_v0_p2wsh(), chan.get().get_user_id())
3487 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.temporary_channel_id))
3490 let mut pending_events = self.pending_events.lock().unwrap();
3491 pending_events.push(events::Event::FundingGenerationReady {
3492 temporary_channel_id: msg.temporary_channel_id,
3493 channel_value_satoshis: value,
3495 user_channel_id: user_id,
3500 fn internal_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), MsgHandleErrInternal> {
3501 let ((funding_msg, monitor), mut chan) = {
3502 let best_block = *self.best_block.read().unwrap();
3503 let mut channel_lock = self.channel_state.lock().unwrap();
3504 let channel_state = &mut *channel_lock;
3505 match channel_state.by_id.entry(msg.temporary_channel_id.clone()) {
3506 hash_map::Entry::Occupied(mut chan) => {
3507 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3508 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.temporary_channel_id));
3510 (try_chan_entry!(self, chan.get_mut().funding_created(msg, best_block, &self.logger), channel_state, chan), chan.remove())
3512 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.temporary_channel_id))
3515 // Because we have exclusive ownership of the channel here we can release the channel_state
3516 // lock before watch_channel
3517 if let Err(e) = self.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor) {
3519 ChannelMonitorUpdateErr::PermanentFailure => {
3520 // Note that we reply with the new channel_id in error messages if we gave up on the
3521 // channel, not the temporary_channel_id. This is compatible with ourselves, but the
3522 // spec is somewhat ambiguous here. Not a huge deal since we'll send error messages for
3523 // any messages referencing a previously-closed channel anyway.
3524 // We do not do a force-close here as that would generate a monitor update for
3525 // a monitor that we didn't manage to store (and that we don't care about - we
3526 // don't respond with the funding_signed so the channel can never go on chain).
3527 let (_monitor_update, failed_htlcs) = chan.force_shutdown(true);
3528 assert!(failed_htlcs.is_empty());
3529 return Err(MsgHandleErrInternal::send_err_msg_no_close("ChannelMonitor storage failure".to_owned(), funding_msg.channel_id));
3531 ChannelMonitorUpdateErr::TemporaryFailure => {
3532 // There's no problem signing a counterparty's funding transaction if our monitor
3533 // hasn't persisted to disk yet - we can't lose money on a transaction that we haven't
3534 // accepted payment from yet. We do, however, need to wait to send our funding_locked
3535 // until we have persisted our monitor.
3536 chan.monitor_update_failed(false, false, Vec::new(), Vec::new());
3540 let mut channel_state_lock = self.channel_state.lock().unwrap();
3541 let channel_state = &mut *channel_state_lock;
3542 match channel_state.by_id.entry(funding_msg.channel_id) {
3543 hash_map::Entry::Occupied(_) => {
3544 return Err(MsgHandleErrInternal::send_err_msg_no_close("Already had channel with the new channel_id".to_owned(), funding_msg.channel_id))
3546 hash_map::Entry::Vacant(e) => {
3547 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
3548 node_id: counterparty_node_id.clone(),
3557 fn internal_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), MsgHandleErrInternal> {
3559 let best_block = *self.best_block.read().unwrap();
3560 let mut channel_lock = self.channel_state.lock().unwrap();
3561 let channel_state = &mut *channel_lock;
3562 match channel_state.by_id.entry(msg.channel_id) {
3563 hash_map::Entry::Occupied(mut chan) => {
3564 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3565 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3567 let (monitor, funding_tx) = match chan.get_mut().funding_signed(&msg, best_block, &self.logger) {
3568 Ok(update) => update,
3569 Err(e) => try_chan_entry!(self, Err(e), channel_state, chan),
3571 if let Err(e) = self.chain_monitor.watch_channel(chan.get().get_funding_txo().unwrap(), monitor) {
3572 let mut res = handle_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::RevokeAndACKFirst, false, false);
3573 if let Err(MsgHandleErrInternal { ref mut shutdown_finish, .. }) = res {
3574 // We weren't able to watch the channel to begin with, so no updates should be made on
3575 // it. Previously, full_stack_target found an (unreachable) panic when the
3576 // monitor update contained within `shutdown_finish` was applied.
3577 if let Some((ref mut shutdown_finish, _)) = shutdown_finish {
3578 shutdown_finish.0.take();
3585 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3588 log_info!(self.logger, "Broadcasting funding transaction with txid {}", funding_tx.txid());
3589 self.tx_broadcaster.broadcast_transaction(&funding_tx);
3593 fn internal_funding_locked(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingLocked) -> Result<(), MsgHandleErrInternal> {
3594 let mut channel_state_lock = self.channel_state.lock().unwrap();
3595 let channel_state = &mut *channel_state_lock;
3596 match channel_state.by_id.entry(msg.channel_id) {
3597 hash_map::Entry::Occupied(mut chan) => {
3598 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3599 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3601 try_chan_entry!(self, chan.get_mut().funding_locked(&msg, &self.logger), channel_state, chan);
3602 if let Some(announcement_sigs) = self.get_announcement_sigs(chan.get()) {
3603 log_trace!(self.logger, "Sending announcement_signatures for {} in response to funding_locked", log_bytes!(chan.get().channel_id()));
3604 // If we see locking block before receiving remote funding_locked, we broadcast our
3605 // announcement_sigs at remote funding_locked reception. If we receive remote
3606 // funding_locked before seeing locking block, we broadcast our announcement_sigs at locking
3607 // block connection. We should guanrantee to broadcast announcement_sigs to our peer whatever
3608 // the order of the events but our peer may not receive it due to disconnection. The specs
3609 // lacking an acknowledgement for announcement_sigs we may have to re-send them at peer
3610 // connection in the future if simultaneous misses by both peers due to network/hardware
3611 // failures is an issue. Note, to achieve its goal, only one of the announcement_sigs needs
3612 // to be received, from then sigs are going to be flood to the whole network.
3613 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
3614 node_id: counterparty_node_id.clone(),
3615 msg: announcement_sigs,
3617 } else if chan.get().is_usable() {
3618 channel_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
3619 node_id: counterparty_node_id.clone(),
3620 msg: self.get_channel_update_for_unicast(chan.get()).unwrap(),
3625 hash_map::Entry::Vacant(_) => Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3629 fn internal_shutdown(&self, counterparty_node_id: &PublicKey, their_features: &InitFeatures, msg: &msgs::Shutdown) -> Result<(), MsgHandleErrInternal> {
3630 let mut dropped_htlcs: Vec<(HTLCSource, PaymentHash)>;
3631 let result: Result<(), _> = loop {
3632 let mut channel_state_lock = self.channel_state.lock().unwrap();
3633 let channel_state = &mut *channel_state_lock;
3635 match channel_state.by_id.entry(msg.channel_id.clone()) {
3636 hash_map::Entry::Occupied(mut chan_entry) => {
3637 if chan_entry.get().get_counterparty_node_id() != *counterparty_node_id {
3638 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3641 if !chan_entry.get().received_shutdown() {
3642 log_info!(self.logger, "Received a shutdown message from our counterparty for channel {}{}.",
3643 log_bytes!(msg.channel_id),
3644 if chan_entry.get().sent_shutdown() { " after we initiated shutdown" } else { "" });
3647 let (shutdown, monitor_update, htlcs) = try_chan_entry!(self, chan_entry.get_mut().shutdown(&self.keys_manager, &their_features, &msg), channel_state, chan_entry);
3648 dropped_htlcs = htlcs;
3650 // Update the monitor with the shutdown script if necessary.
3651 if let Some(monitor_update) = monitor_update {
3652 if let Err(e) = self.chain_monitor.update_channel(chan_entry.get().get_funding_txo().unwrap(), monitor_update) {
3653 let (result, is_permanent) =
3654 handle_monitor_err!(self, e, channel_state.short_to_id, chan_entry.get_mut(), RAACommitmentOrder::CommitmentFirst, false, false, Vec::new(), Vec::new(), chan_entry.key());
3656 remove_channel!(channel_state, chan_entry);
3662 if let Some(msg) = shutdown {
3663 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
3664 node_id: *counterparty_node_id,
3671 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3674 for htlc_source in dropped_htlcs.drain(..) {
3675 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() });
3678 let _ = handle_error!(self, result, *counterparty_node_id);
3682 fn internal_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<(), MsgHandleErrInternal> {
3683 let (tx, chan_option) = {
3684 let mut channel_state_lock = self.channel_state.lock().unwrap();
3685 let channel_state = &mut *channel_state_lock;
3686 match channel_state.by_id.entry(msg.channel_id.clone()) {
3687 hash_map::Entry::Occupied(mut chan_entry) => {
3688 if chan_entry.get().get_counterparty_node_id() != *counterparty_node_id {
3689 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3691 let (closing_signed, tx) = try_chan_entry!(self, chan_entry.get_mut().closing_signed(&self.fee_estimator, &msg), channel_state, chan_entry);
3692 if let Some(msg) = closing_signed {
3693 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
3694 node_id: counterparty_node_id.clone(),
3699 // We're done with this channel, we've got a signed closing transaction and
3700 // will send the closing_signed back to the remote peer upon return. This
3701 // also implies there are no pending HTLCs left on the channel, so we can
3702 // fully delete it from tracking (the channel monitor is still around to
3703 // watch for old state broadcasts)!
3704 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
3705 channel_state.short_to_id.remove(&short_id);
3707 (tx, Some(chan_entry.remove_entry().1))
3708 } else { (tx, None) }
3710 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3713 if let Some(broadcast_tx) = tx {
3714 log_info!(self.logger, "Broadcasting {}", log_tx!(broadcast_tx));
3715 self.tx_broadcaster.broadcast_transaction(&broadcast_tx);
3717 if let Some(chan) = chan_option {
3718 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
3719 let mut channel_state = self.channel_state.lock().unwrap();
3720 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
3724 self.issue_channel_close_events(&chan, ClosureReason::CooperativeClosure);
3729 fn internal_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), MsgHandleErrInternal> {
3730 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
3731 //determine the state of the payment based on our response/if we forward anything/the time
3732 //we take to respond. We should take care to avoid allowing such an attack.
3734 //TODO: There exists a further attack where a node may garble the onion data, forward it to
3735 //us repeatedly garbled in different ways, and compare our error messages, which are
3736 //encrypted with the same key. It's not immediately obvious how to usefully exploit that,
3737 //but we should prevent it anyway.
3739 let (pending_forward_info, mut channel_state_lock) = self.decode_update_add_htlc_onion(msg);
3740 let channel_state = &mut *channel_state_lock;
3742 match channel_state.by_id.entry(msg.channel_id) {
3743 hash_map::Entry::Occupied(mut chan) => {
3744 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3745 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3748 let create_pending_htlc_status = |chan: &Channel<Signer>, pending_forward_info: PendingHTLCStatus, error_code: u16| {
3749 // If the update_add is completely bogus, the call will Err and we will close,
3750 // but if we've sent a shutdown and they haven't acknowledged it yet, we just
3751 // want to reject the new HTLC and fail it backwards instead of forwarding.
3752 match pending_forward_info {
3753 PendingHTLCStatus::Forward(PendingHTLCInfo { ref incoming_shared_secret, .. }) => {
3754 let reason = if (error_code & 0x1000) != 0 {
3755 if let Ok(upd) = self.get_channel_update_for_unicast(chan) {
3756 onion_utils::build_first_hop_failure_packet(incoming_shared_secret, error_code, &{
3757 let mut res = Vec::with_capacity(8 + 128);
3758 // TODO: underspecified, follow https://github.com/lightningnetwork/lightning-rfc/issues/791
3759 res.extend_from_slice(&byte_utils::be16_to_array(0));
3760 res.extend_from_slice(&upd.encode_with_len()[..]);
3764 // The only case where we'd be unable to
3765 // successfully get a channel update is if the
3766 // channel isn't in the fully-funded state yet,
3767 // implying our counterparty is trying to route
3768 // payments over the channel back to themselves
3769 // (because no one else should know the short_id
3770 // is a lightning channel yet). We should have
3771 // no problem just calling this
3772 // unknown_next_peer (0x4000|10).
3773 onion_utils::build_first_hop_failure_packet(incoming_shared_secret, 0x4000|10, &[])
3776 onion_utils::build_first_hop_failure_packet(incoming_shared_secret, error_code, &[])
3778 let msg = msgs::UpdateFailHTLC {
3779 channel_id: msg.channel_id,
3780 htlc_id: msg.htlc_id,
3783 PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msg))
3785 _ => pending_forward_info
3788 try_chan_entry!(self, chan.get_mut().update_add_htlc(&msg, pending_forward_info, create_pending_htlc_status, &self.logger), channel_state, chan);
3790 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3795 fn internal_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), MsgHandleErrInternal> {
3796 let mut channel_lock = self.channel_state.lock().unwrap();
3797 let (htlc_source, forwarded_htlc_value) = {
3798 let channel_state = &mut *channel_lock;
3799 match channel_state.by_id.entry(msg.channel_id) {
3800 hash_map::Entry::Occupied(mut chan) => {
3801 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3802 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3804 try_chan_entry!(self, chan.get_mut().update_fulfill_htlc(&msg), channel_state, chan)
3806 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3809 self.claim_funds_internal(channel_lock, htlc_source, msg.payment_preimage.clone(), Some(forwarded_htlc_value), false);
3813 fn internal_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), MsgHandleErrInternal> {
3814 let mut channel_lock = self.channel_state.lock().unwrap();
3815 let channel_state = &mut *channel_lock;
3816 match channel_state.by_id.entry(msg.channel_id) {
3817 hash_map::Entry::Occupied(mut chan) => {
3818 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3819 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3821 try_chan_entry!(self, chan.get_mut().update_fail_htlc(&msg, HTLCFailReason::LightningError { err: msg.reason.clone() }), channel_state, chan);
3823 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3828 fn internal_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), MsgHandleErrInternal> {
3829 let mut channel_lock = self.channel_state.lock().unwrap();
3830 let channel_state = &mut *channel_lock;
3831 match channel_state.by_id.entry(msg.channel_id) {
3832 hash_map::Entry::Occupied(mut chan) => {
3833 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3834 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3836 if (msg.failure_code & 0x8000) == 0 {
3837 let chan_err: ChannelError = ChannelError::Close("Got update_fail_malformed_htlc with BADONION not set".to_owned());
3838 try_chan_entry!(self, Err(chan_err), channel_state, chan);
3840 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);
3843 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3847 fn internal_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), MsgHandleErrInternal> {
3848 let mut channel_state_lock = self.channel_state.lock().unwrap();
3849 let channel_state = &mut *channel_state_lock;
3850 match channel_state.by_id.entry(msg.channel_id) {
3851 hash_map::Entry::Occupied(mut chan) => {
3852 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3853 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3855 let (revoke_and_ack, commitment_signed, monitor_update) =
3856 match chan.get_mut().commitment_signed(&msg, &self.logger) {
3857 Err((None, e)) => try_chan_entry!(self, Err(e), channel_state, chan),
3858 Err((Some(update), e)) => {
3859 assert!(chan.get().is_awaiting_monitor_update());
3860 let _ = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), update);
3861 try_chan_entry!(self, Err(e), channel_state, chan);
3866 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
3867 return_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::RevokeAndACKFirst, true, commitment_signed.is_some());
3869 channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
3870 node_id: counterparty_node_id.clone(),
3871 msg: revoke_and_ack,
3873 if let Some(msg) = commitment_signed {
3874 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
3875 node_id: counterparty_node_id.clone(),
3876 updates: msgs::CommitmentUpdate {
3877 update_add_htlcs: Vec::new(),
3878 update_fulfill_htlcs: Vec::new(),
3879 update_fail_htlcs: Vec::new(),
3880 update_fail_malformed_htlcs: Vec::new(),
3882 commitment_signed: msg,
3888 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3893 fn forward_htlcs(&self, per_source_pending_forwards: &mut [(u64, OutPoint, Vec<(PendingHTLCInfo, u64)>)]) {
3894 for &mut (prev_short_channel_id, prev_funding_outpoint, ref mut pending_forwards) in per_source_pending_forwards {
3895 let mut forward_event = None;
3896 if !pending_forwards.is_empty() {
3897 let mut channel_state = self.channel_state.lock().unwrap();
3898 if channel_state.forward_htlcs.is_empty() {
3899 forward_event = Some(Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS))
3901 for (forward_info, prev_htlc_id) in pending_forwards.drain(..) {
3902 match channel_state.forward_htlcs.entry(match forward_info.routing {
3903 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
3904 PendingHTLCRouting::Receive { .. } => 0,
3905 PendingHTLCRouting::ReceiveKeysend { .. } => 0,
3907 hash_map::Entry::Occupied(mut entry) => {
3908 entry.get_mut().push(HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_funding_outpoint,
3909 prev_htlc_id, forward_info });
3911 hash_map::Entry::Vacant(entry) => {
3912 entry.insert(vec!(HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_funding_outpoint,
3913 prev_htlc_id, forward_info }));
3918 match forward_event {
3920 let mut pending_events = self.pending_events.lock().unwrap();
3921 pending_events.push(events::Event::PendingHTLCsForwardable {
3922 time_forwardable: time
3930 fn internal_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), MsgHandleErrInternal> {
3931 let mut htlcs_to_fail = Vec::new();
3933 let mut channel_state_lock = self.channel_state.lock().unwrap();
3934 let channel_state = &mut *channel_state_lock;
3935 match channel_state.by_id.entry(msg.channel_id) {
3936 hash_map::Entry::Occupied(mut chan) => {
3937 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3938 break Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3940 let was_frozen_for_monitor = chan.get().is_awaiting_monitor_update();
3941 let (commitment_update, pending_forwards, pending_failures, monitor_update, htlcs_to_fail_in) =
3942 break_chan_entry!(self, chan.get_mut().revoke_and_ack(&msg, &self.logger), channel_state, chan);
3943 htlcs_to_fail = htlcs_to_fail_in;
3944 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
3945 if was_frozen_for_monitor {
3946 assert!(commitment_update.is_none() && pending_forwards.is_empty() && pending_failures.is_empty());
3947 break Err(MsgHandleErrInternal::ignore_no_close("Previous monitor update failure prevented responses to RAA".to_owned()));
3949 if let Err(e) = handle_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, commitment_update.is_some(), pending_forwards, pending_failures) {
3951 } else { unreachable!(); }
3954 if let Some(updates) = commitment_update {
3955 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
3956 node_id: counterparty_node_id.clone(),
3960 break Ok((pending_forwards, pending_failures, chan.get().get_short_channel_id().expect("RAA should only work on a short-id-available channel"), chan.get().get_funding_txo().unwrap()))
3962 hash_map::Entry::Vacant(_) => break Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3965 self.fail_holding_cell_htlcs(htlcs_to_fail, msg.channel_id);
3967 Ok((pending_forwards, mut pending_failures, short_channel_id, channel_outpoint)) => {
3968 for failure in pending_failures.drain(..) {
3969 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), failure.0, &failure.1, failure.2);
3971 self.forward_htlcs(&mut [(short_channel_id, channel_outpoint, pending_forwards)]);
3978 fn internal_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), MsgHandleErrInternal> {
3979 let mut channel_lock = self.channel_state.lock().unwrap();
3980 let channel_state = &mut *channel_lock;
3981 match channel_state.by_id.entry(msg.channel_id) {
3982 hash_map::Entry::Occupied(mut chan) => {
3983 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3984 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3986 try_chan_entry!(self, chan.get_mut().update_fee(&self.fee_estimator, &msg), channel_state, chan);
3988 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3993 fn internal_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), MsgHandleErrInternal> {
3994 let mut channel_state_lock = self.channel_state.lock().unwrap();
3995 let channel_state = &mut *channel_state_lock;
3997 match channel_state.by_id.entry(msg.channel_id) {
3998 hash_map::Entry::Occupied(mut chan) => {
3999 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4000 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4002 if !chan.get().is_usable() {
4003 return Err(MsgHandleErrInternal::from_no_close(LightningError{err: "Got an announcement_signatures before we were ready for it".to_owned(), action: msgs::ErrorAction::IgnoreError}));
4006 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
4007 msg: try_chan_entry!(self, chan.get_mut().announcement_signatures(&self.our_network_key, self.get_our_node_id(), self.genesis_hash.clone(), msg), channel_state, chan),
4008 // Note that announcement_signatures fails if the channel cannot be announced,
4009 // so get_channel_update_for_broadcast will never fail by the time we get here.
4010 update_msg: self.get_channel_update_for_broadcast(chan.get()).unwrap(),
4013 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4018 /// Returns ShouldPersist if anything changed, otherwise either SkipPersist or an Err.
4019 fn internal_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) -> Result<NotifyOption, MsgHandleErrInternal> {
4020 let mut channel_state_lock = self.channel_state.lock().unwrap();
4021 let channel_state = &mut *channel_state_lock;
4022 let chan_id = match channel_state.short_to_id.get(&msg.contents.short_channel_id) {
4023 Some(chan_id) => chan_id.clone(),
4025 // It's not a local channel
4026 return Ok(NotifyOption::SkipPersist)
4029 match channel_state.by_id.entry(chan_id) {
4030 hash_map::Entry::Occupied(mut chan) => {
4031 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4032 if chan.get().should_announce() {
4033 // If the announcement is about a channel of ours which is public, some
4034 // other peer may simply be forwarding all its gossip to us. Don't provide
4035 // a scary-looking error message and return Ok instead.
4036 return Ok(NotifyOption::SkipPersist);
4038 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));
4040 let were_node_one = self.get_our_node_id().serialize()[..] < chan.get().get_counterparty_node_id().serialize()[..];
4041 let msg_from_node_one = msg.contents.flags & 1 == 0;
4042 if were_node_one == msg_from_node_one {
4043 return Ok(NotifyOption::SkipPersist);
4045 try_chan_entry!(self, chan.get_mut().channel_update(&msg), channel_state, chan);
4048 hash_map::Entry::Vacant(_) => unreachable!()
4050 Ok(NotifyOption::DoPersist)
4053 fn internal_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<(), MsgHandleErrInternal> {
4054 let chan_restoration_res;
4055 let (htlcs_failed_forward, need_lnd_workaround) = {
4056 let mut channel_state_lock = self.channel_state.lock().unwrap();
4057 let channel_state = &mut *channel_state_lock;
4059 match channel_state.by_id.entry(msg.channel_id) {
4060 hash_map::Entry::Occupied(mut chan) => {
4061 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
4062 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
4064 // Currently, we expect all holding cell update_adds to be dropped on peer
4065 // disconnect, so Channel's reestablish will never hand us any holding cell
4066 // freed HTLCs to fail backwards. If in the future we no longer drop pending
4067 // add-HTLCs on disconnect, we may be handed HTLCs to fail backwards here.
4068 let (funding_locked, revoke_and_ack, commitment_update, monitor_update_opt, order, htlcs_failed_forward, shutdown) =
4069 try_chan_entry!(self, chan.get_mut().channel_reestablish(msg, &self.logger), channel_state, chan);
4070 let mut channel_update = None;
4071 if let Some(msg) = shutdown {
4072 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
4073 node_id: counterparty_node_id.clone(),
4076 } else if chan.get().is_usable() {
4077 // If the channel is in a usable state (ie the channel is not being shut
4078 // down), send a unicast channel_update to our counterparty to make sure
4079 // they have the latest channel parameters.
4080 channel_update = Some(events::MessageSendEvent::SendChannelUpdate {
4081 node_id: chan.get().get_counterparty_node_id(),
4082 msg: self.get_channel_update_for_unicast(chan.get()).unwrap(),
4085 let need_lnd_workaround = chan.get_mut().workaround_lnd_bug_4006.take();
4086 chan_restoration_res = handle_chan_restoration_locked!(self, channel_state_lock, channel_state, chan, revoke_and_ack, commitment_update, order, monitor_update_opt, Vec::new(), None, funding_locked);
4087 if let Some(upd) = channel_update {
4088 channel_state.pending_msg_events.push(upd);
4090 (htlcs_failed_forward, need_lnd_workaround)
4092 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
4095 post_handle_chan_restoration!(self, chan_restoration_res);
4096 self.fail_holding_cell_htlcs(htlcs_failed_forward, msg.channel_id);
4098 if let Some(funding_locked_msg) = need_lnd_workaround {
4099 self.internal_funding_locked(counterparty_node_id, &funding_locked_msg)?;
4104 /// Process pending events from the `chain::Watch`, returning whether any events were processed.
4105 fn process_pending_monitor_events(&self) -> bool {
4106 let mut failed_channels = Vec::new();
4107 let mut pending_monitor_events = self.chain_monitor.release_pending_monitor_events();
4108 let has_pending_monitor_events = !pending_monitor_events.is_empty();
4109 for monitor_event in pending_monitor_events.drain(..) {
4110 match monitor_event {
4111 MonitorEvent::HTLCEvent(htlc_update) => {
4112 if let Some(preimage) = htlc_update.payment_preimage {
4113 log_trace!(self.logger, "Claiming HTLC with preimage {} from our monitor", log_bytes!(preimage.0));
4114 self.claim_funds_internal(self.channel_state.lock().unwrap(), htlc_update.source, preimage, htlc_update.onchain_value_satoshis.map(|v| v * 1000), true);
4116 log_trace!(self.logger, "Failing HTLC with hash {} from our monitor", log_bytes!(htlc_update.payment_hash.0));
4117 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() });
4120 MonitorEvent::CommitmentTxConfirmed(funding_outpoint) => {
4121 let mut channel_lock = self.channel_state.lock().unwrap();
4122 let channel_state = &mut *channel_lock;
4123 let by_id = &mut channel_state.by_id;
4124 let short_to_id = &mut channel_state.short_to_id;
4125 let pending_msg_events = &mut channel_state.pending_msg_events;
4126 if let Some(mut chan) = by_id.remove(&funding_outpoint.to_channel_id()) {
4127 if let Some(short_id) = chan.get_short_channel_id() {
4128 short_to_id.remove(&short_id);
4130 failed_channels.push(chan.force_shutdown(false));
4131 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
4132 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
4136 self.issue_channel_close_events(&chan, ClosureReason::CommitmentTxConfirmed);
4137 pending_msg_events.push(events::MessageSendEvent::HandleError {
4138 node_id: chan.get_counterparty_node_id(),
4139 action: msgs::ErrorAction::SendErrorMessage {
4140 msg: msgs::ErrorMessage { channel_id: chan.channel_id(), data: "Channel force-closed".to_owned() }
4148 for failure in failed_channels.drain(..) {
4149 self.finish_force_close_channel(failure);
4152 has_pending_monitor_events
4155 /// Check the holding cell in each channel and free any pending HTLCs in them if possible.
4156 /// Returns whether there were any updates such as if pending HTLCs were freed or a monitor
4157 /// update was applied.
4159 /// This should only apply to HTLCs which were added to the holding cell because we were
4160 /// waiting on a monitor update to finish. In that case, we don't want to free the holding cell
4161 /// directly in `channel_monitor_updated` as it may introduce deadlocks calling back into user
4162 /// code to inform them of a channel monitor update.
4163 fn check_free_holding_cells(&self) -> bool {
4164 let mut has_monitor_update = false;
4165 let mut failed_htlcs = Vec::new();
4166 let mut handle_errors = Vec::new();
4168 let mut channel_state_lock = self.channel_state.lock().unwrap();
4169 let channel_state = &mut *channel_state_lock;
4170 let by_id = &mut channel_state.by_id;
4171 let short_to_id = &mut channel_state.short_to_id;
4172 let pending_msg_events = &mut channel_state.pending_msg_events;
4174 by_id.retain(|channel_id, chan| {
4175 match chan.maybe_free_holding_cell_htlcs(&self.logger) {
4176 Ok((commitment_opt, holding_cell_failed_htlcs)) => {
4177 if !holding_cell_failed_htlcs.is_empty() {
4178 failed_htlcs.push((holding_cell_failed_htlcs, *channel_id));
4180 if let Some((commitment_update, monitor_update)) = commitment_opt {
4181 if let Err(e) = self.chain_monitor.update_channel(chan.get_funding_txo().unwrap(), monitor_update) {
4182 has_monitor_update = true;
4183 let (res, close_channel) = handle_monitor_err!(self, e, short_to_id, chan, RAACommitmentOrder::CommitmentFirst, false, true, Vec::new(), Vec::new(), channel_id);
4184 handle_errors.push((chan.get_counterparty_node_id(), res));
4185 if close_channel { return false; }
4187 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
4188 node_id: chan.get_counterparty_node_id(),
4189 updates: commitment_update,
4196 let (close_channel, res) = convert_chan_err!(self, e, short_to_id, chan, channel_id);
4197 handle_errors.push((chan.get_counterparty_node_id(), Err(res)));
4198 // ChannelClosed event is generated by handle_error for us
4205 let has_update = has_monitor_update || !failed_htlcs.is_empty() || !handle_errors.is_empty();
4206 for (failures, channel_id) in failed_htlcs.drain(..) {
4207 self.fail_holding_cell_htlcs(failures, channel_id);
4210 for (counterparty_node_id, err) in handle_errors.drain(..) {
4211 let _ = handle_error!(self, err, counterparty_node_id);
4217 /// Check whether any channels have finished removing all pending updates after a shutdown
4218 /// exchange and can now send a closing_signed.
4219 /// Returns whether any closing_signed messages were generated.
4220 fn maybe_generate_initial_closing_signed(&self) -> bool {
4221 let mut handle_errors: Vec<(PublicKey, Result<(), _>)> = Vec::new();
4222 let mut has_update = false;
4224 let mut channel_state_lock = self.channel_state.lock().unwrap();
4225 let channel_state = &mut *channel_state_lock;
4226 let by_id = &mut channel_state.by_id;
4227 let short_to_id = &mut channel_state.short_to_id;
4228 let pending_msg_events = &mut channel_state.pending_msg_events;
4230 by_id.retain(|channel_id, chan| {
4231 match chan.maybe_propose_closing_signed(&self.fee_estimator, &self.logger) {
4232 Ok((msg_opt, tx_opt)) => {
4233 if let Some(msg) = msg_opt {
4235 pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
4236 node_id: chan.get_counterparty_node_id(), msg,
4239 if let Some(tx) = tx_opt {
4240 // We're done with this channel. We got a closing_signed and sent back
4241 // a closing_signed with a closing transaction to broadcast.
4242 if let Some(short_id) = chan.get_short_channel_id() {
4243 short_to_id.remove(&short_id);
4246 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
4247 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
4252 self.issue_channel_close_events(chan, ClosureReason::CooperativeClosure);
4254 log_info!(self.logger, "Broadcasting {}", log_tx!(tx));
4255 self.tx_broadcaster.broadcast_transaction(&tx);
4261 let (close_channel, res) = convert_chan_err!(self, e, short_to_id, chan, channel_id);
4262 handle_errors.push((chan.get_counterparty_node_id(), Err(res)));
4269 for (counterparty_node_id, err) in handle_errors.drain(..) {
4270 let _ = handle_error!(self, err, counterparty_node_id);
4276 /// Handle a list of channel failures during a block_connected or block_disconnected call,
4277 /// pushing the channel monitor update (if any) to the background events queue and removing the
4279 fn handle_init_event_channel_failures(&self, mut failed_channels: Vec<ShutdownResult>) {
4280 for mut failure in failed_channels.drain(..) {
4281 // Either a commitment transactions has been confirmed on-chain or
4282 // Channel::block_disconnected detected that the funding transaction has been
4283 // reorganized out of the main chain.
4284 // We cannot broadcast our latest local state via monitor update (as
4285 // Channel::force_shutdown tries to make us do) as we may still be in initialization,
4286 // so we track the update internally and handle it when the user next calls
4287 // timer_tick_occurred, guaranteeing we're running normally.
4288 if let Some((funding_txo, update)) = failure.0.take() {
4289 assert_eq!(update.updates.len(), 1);
4290 if let ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } = update.updates[0] {
4291 assert!(should_broadcast);
4292 } else { unreachable!(); }
4293 self.pending_background_events.lock().unwrap().push(BackgroundEvent::ClosingMonitorUpdate((funding_txo, update)));
4295 self.finish_force_close_channel(failure);
4299 fn set_payment_hash_secret_map(&self, payment_hash: PaymentHash, payment_preimage: Option<PaymentPreimage>, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32, user_payment_id: u64) -> Result<PaymentSecret, APIError> {
4300 assert!(invoice_expiry_delta_secs <= 60*60*24*365); // Sadly bitcoin timestamps are u32s, so panic before 2106
4302 let payment_secret = PaymentSecret(self.keys_manager.get_secure_random_bytes());
4304 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4305 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
4306 match payment_secrets.entry(payment_hash) {
4307 hash_map::Entry::Vacant(e) => {
4308 e.insert(PendingInboundPayment {
4309 payment_secret, min_value_msat, user_payment_id, payment_preimage,
4310 // We assume that highest_seen_timestamp is pretty close to the current time -
4311 // its updated when we receive a new block with the maximum time we've seen in
4312 // a header. It should never be more than two hours in the future.
4313 // Thus, we add two hours here as a buffer to ensure we absolutely
4314 // never fail a payment too early.
4315 // Note that we assume that received blocks have reasonably up-to-date
4317 expiry_time: self.highest_seen_timestamp.load(Ordering::Acquire) as u64 + invoice_expiry_delta_secs as u64 + 7200,
4320 hash_map::Entry::Occupied(_) => return Err(APIError::APIMisuseError { err: "Duplicate payment hash".to_owned() }),
4325 /// Gets a payment secret and payment hash for use in an invoice given to a third party wishing
4328 /// This differs from [`create_inbound_payment_for_hash`] only in that it generates the
4329 /// [`PaymentHash`] and [`PaymentPreimage`] for you, returning the first and storing the second.
4331 /// The [`PaymentPreimage`] will ultimately be returned to you in the [`PaymentReceived`], which
4332 /// will have the [`PaymentReceived::payment_preimage`] field filled in. That should then be
4333 /// passed directly to [`claim_funds`].
4335 /// See [`create_inbound_payment_for_hash`] for detailed documentation on behavior and requirements.
4337 /// [`claim_funds`]: Self::claim_funds
4338 /// [`PaymentReceived`]: events::Event::PaymentReceived
4339 /// [`PaymentReceived::payment_preimage`]: events::Event::PaymentReceived::payment_preimage
4340 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
4341 pub fn create_inbound_payment(&self, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32, user_payment_id: u64) -> (PaymentHash, PaymentSecret) {
4342 let payment_preimage = PaymentPreimage(self.keys_manager.get_secure_random_bytes());
4343 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
4346 self.set_payment_hash_secret_map(payment_hash, Some(payment_preimage), min_value_msat, invoice_expiry_delta_secs, user_payment_id)
4347 .expect("RNG Generated Duplicate PaymentHash"))
4350 /// Gets a [`PaymentSecret`] for a given [`PaymentHash`], for which the payment preimage is
4351 /// stored external to LDK.
4353 /// A [`PaymentReceived`] event will only be generated if the [`PaymentSecret`] matches a
4354 /// payment secret fetched via this method or [`create_inbound_payment`], and which is at least
4355 /// the `min_value_msat` provided here, if one is provided.
4357 /// The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) must be globally unique. This
4358 /// method may return an Err if another payment with the same payment_hash is still pending.
4360 /// `user_payment_id` will be provided back in [`PaymentPurpose::InvoicePayment::user_payment_id`] events to
4361 /// allow tracking of which events correspond with which calls to this and
4362 /// [`create_inbound_payment`]. `user_payment_id` has no meaning inside of LDK, it is simply
4363 /// copied to events and otherwise ignored. It may be used to correlate PaymentReceived events
4364 /// with invoice metadata stored elsewhere.
4366 /// `min_value_msat` should be set if the invoice being generated contains a value. Any payment
4367 /// received for the returned [`PaymentHash`] will be required to be at least `min_value_msat`
4368 /// before a [`PaymentReceived`] event will be generated, ensuring that we do not provide the
4369 /// sender "proof-of-payment" unless they have paid the required amount.
4371 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
4372 /// in excess of the current time. This should roughly match the expiry time set in the invoice.
4373 /// After this many seconds, we will remove the inbound payment, resulting in any attempts to
4374 /// pay the invoice failing. The BOLT spec suggests 3,600 secs as a default validity time for
4375 /// invoices when no timeout is set.
4377 /// Note that we use block header time to time-out pending inbound payments (with some margin
4378 /// to compensate for the inaccuracy of block header timestamps). Thus, in practice we will
4379 /// accept a payment and generate a [`PaymentReceived`] event for some time after the expiry.
4380 /// If you need exact expiry semantics, you should enforce them upon receipt of
4381 /// [`PaymentReceived`].
4383 /// Pending inbound payments are stored in memory and in serialized versions of this
4384 /// [`ChannelManager`]. If potentially unbounded numbers of inbound payments may exist and
4385 /// space is limited, you may wish to rate-limit inbound payment creation.
4387 /// May panic if `invoice_expiry_delta_secs` is greater than one year.
4389 /// Note that invoices generated for inbound payments should have their `min_final_cltv_expiry`
4390 /// set to at least [`MIN_FINAL_CLTV_EXPIRY`].
4392 /// [`create_inbound_payment`]: Self::create_inbound_payment
4393 /// [`PaymentReceived`]: events::Event::PaymentReceived
4394 /// [`PaymentPurpose::InvoicePayment::user_payment_id`]: events::PaymentPurpose::InvoicePayment::user_payment_id
4395 pub fn create_inbound_payment_for_hash(&self, payment_hash: PaymentHash, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32, user_payment_id: u64) -> Result<PaymentSecret, APIError> {
4396 self.set_payment_hash_secret_map(payment_hash, None, min_value_msat, invoice_expiry_delta_secs, user_payment_id)
4399 #[cfg(any(test, feature = "fuzztarget", feature = "_test_utils"))]
4400 pub fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
4401 let events = core::cell::RefCell::new(Vec::new());
4402 let event_handler = |event: &events::Event| events.borrow_mut().push(event.clone());
4403 self.process_pending_events(&event_handler);
4408 pub fn has_pending_payments(&self) -> bool {
4409 !self.pending_outbound_payments.lock().unwrap().is_empty()
4413 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> MessageSendEventsProvider for ChannelManager<Signer, M, T, K, F, L>
4414 where M::Target: chain::Watch<Signer>,
4415 T::Target: BroadcasterInterface,
4416 K::Target: KeysInterface<Signer = Signer>,
4417 F::Target: FeeEstimator,
4420 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
4421 let events = RefCell::new(Vec::new());
4422 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
4423 let mut result = NotifyOption::SkipPersist;
4425 // TODO: This behavior should be documented. It's unintuitive that we query
4426 // ChannelMonitors when clearing other events.
4427 if self.process_pending_monitor_events() {
4428 result = NotifyOption::DoPersist;
4431 if self.check_free_holding_cells() {
4432 result = NotifyOption::DoPersist;
4434 if self.maybe_generate_initial_closing_signed() {
4435 result = NotifyOption::DoPersist;
4438 let mut pending_events = Vec::new();
4439 let mut channel_state = self.channel_state.lock().unwrap();
4440 mem::swap(&mut pending_events, &mut channel_state.pending_msg_events);
4442 if !pending_events.is_empty() {
4443 events.replace(pending_events);
4452 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> EventsProvider for ChannelManager<Signer, M, T, K, F, L>
4454 M::Target: chain::Watch<Signer>,
4455 T::Target: BroadcasterInterface,
4456 K::Target: KeysInterface<Signer = Signer>,
4457 F::Target: FeeEstimator,
4460 /// Processes events that must be periodically handled.
4462 /// An [`EventHandler`] may safely call back to the provider in order to handle an event.
4463 /// However, it must not call [`Writeable::write`] as doing so would result in a deadlock.
4465 /// Pending events are persisted as part of [`ChannelManager`]. While these events are cleared
4466 /// when processed, an [`EventHandler`] must be able to handle previously seen events when
4467 /// restarting from an old state.
4468 fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler {
4469 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
4470 let mut result = NotifyOption::SkipPersist;
4472 // TODO: This behavior should be documented. It's unintuitive that we query
4473 // ChannelMonitors when clearing other events.
4474 if self.process_pending_monitor_events() {
4475 result = NotifyOption::DoPersist;
4478 let mut pending_events = mem::replace(&mut *self.pending_events.lock().unwrap(), vec![]);
4479 if !pending_events.is_empty() {
4480 result = NotifyOption::DoPersist;
4483 for event in pending_events.drain(..) {
4484 handler.handle_event(&event);
4492 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> chain::Listen for ChannelManager<Signer, M, T, K, F, L>
4494 M::Target: chain::Watch<Signer>,
4495 T::Target: BroadcasterInterface,
4496 K::Target: KeysInterface<Signer = Signer>,
4497 F::Target: FeeEstimator,
4500 fn block_connected(&self, block: &Block, height: u32) {
4502 let best_block = self.best_block.read().unwrap();
4503 assert_eq!(best_block.block_hash(), block.header.prev_blockhash,
4504 "Blocks must be connected in chain-order - the connected header must build on the last connected header");
4505 assert_eq!(best_block.height(), height - 1,
4506 "Blocks must be connected in chain-order - the connected block height must be one greater than the previous height");
4509 let txdata: Vec<_> = block.txdata.iter().enumerate().collect();
4510 self.transactions_confirmed(&block.header, &txdata, height);
4511 self.best_block_updated(&block.header, height);
4514 fn block_disconnected(&self, header: &BlockHeader, height: u32) {
4515 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4516 let new_height = height - 1;
4518 let mut best_block = self.best_block.write().unwrap();
4519 assert_eq!(best_block.block_hash(), header.block_hash(),
4520 "Blocks must be disconnected in chain-order - the disconnected header must be the last connected header");
4521 assert_eq!(best_block.height(), height,
4522 "Blocks must be disconnected in chain-order - the disconnected block must have the correct height");
4523 *best_block = BestBlock::new(header.prev_blockhash, new_height)
4526 self.do_chain_event(Some(new_height), |channel| channel.best_block_updated(new_height, header.time, &self.logger));
4530 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> chain::Confirm for ChannelManager<Signer, M, T, K, F, L>
4532 M::Target: chain::Watch<Signer>,
4533 T::Target: BroadcasterInterface,
4534 K::Target: KeysInterface<Signer = Signer>,
4535 F::Target: FeeEstimator,
4538 fn transactions_confirmed(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
4539 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
4540 // during initialization prior to the chain_monitor being fully configured in some cases.
4541 // See the docs for `ChannelManagerReadArgs` for more.
4543 let block_hash = header.block_hash();
4544 log_trace!(self.logger, "{} transactions included in block {} at height {} provided", txdata.len(), block_hash, height);
4546 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4547 self.do_chain_event(Some(height), |channel| channel.transactions_confirmed(&block_hash, height, txdata, &self.logger).map(|a| (a, Vec::new())));
4550 fn best_block_updated(&self, header: &BlockHeader, height: u32) {
4551 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
4552 // during initialization prior to the chain_monitor being fully configured in some cases.
4553 // See the docs for `ChannelManagerReadArgs` for more.
4555 let block_hash = header.block_hash();
4556 log_trace!(self.logger, "New best block: {} at height {}", block_hash, height);
4558 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4560 *self.best_block.write().unwrap() = BestBlock::new(block_hash, height);
4562 self.do_chain_event(Some(height), |channel| channel.best_block_updated(height, header.time, &self.logger));
4564 macro_rules! max_time {
4565 ($timestamp: expr) => {
4567 // Update $timestamp to be the max of its current value and the block
4568 // timestamp. This should keep us close to the current time without relying on
4569 // having an explicit local time source.
4570 // Just in case we end up in a race, we loop until we either successfully
4571 // update $timestamp or decide we don't need to.
4572 let old_serial = $timestamp.load(Ordering::Acquire);
4573 if old_serial >= header.time as usize { break; }
4574 if $timestamp.compare_exchange(old_serial, header.time as usize, Ordering::AcqRel, Ordering::Relaxed).is_ok() {
4580 max_time!(self.last_node_announcement_serial);
4581 max_time!(self.highest_seen_timestamp);
4582 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
4583 payment_secrets.retain(|_, inbound_payment| {
4584 inbound_payment.expiry_time > header.time as u64
4587 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
4588 outbounds.retain(|_, payment| {
4589 const PAYMENT_EXPIRY_BLOCKS: u32 = 3;
4590 if payment.remaining_parts() != 0 { return true }
4591 if let PendingOutboundPayment::Retryable { starting_block_height, .. } = payment {
4592 return *starting_block_height + PAYMENT_EXPIRY_BLOCKS > height
4598 fn get_relevant_txids(&self) -> Vec<Txid> {
4599 let channel_state = self.channel_state.lock().unwrap();
4600 let mut res = Vec::with_capacity(channel_state.short_to_id.len());
4601 for chan in channel_state.by_id.values() {
4602 if let Some(funding_txo) = chan.get_funding_txo() {
4603 res.push(funding_txo.txid);
4609 fn transaction_unconfirmed(&self, txid: &Txid) {
4610 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4611 self.do_chain_event(None, |channel| {
4612 if let Some(funding_txo) = channel.get_funding_txo() {
4613 if funding_txo.txid == *txid {
4614 channel.funding_transaction_unconfirmed(&self.logger).map(|_| (None, Vec::new()))
4615 } else { Ok((None, Vec::new())) }
4616 } else { Ok((None, Vec::new())) }
4621 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<Signer, M, T, K, F, L>
4623 M::Target: chain::Watch<Signer>,
4624 T::Target: BroadcasterInterface,
4625 K::Target: KeysInterface<Signer = Signer>,
4626 F::Target: FeeEstimator,
4629 /// Calls a function which handles an on-chain event (blocks dis/connected, transactions
4630 /// un/confirmed, etc) on each channel, handling any resulting errors or messages generated by
4632 fn do_chain_event<FN: Fn(&mut Channel<Signer>) -> Result<(Option<msgs::FundingLocked>, Vec<(HTLCSource, PaymentHash)>), msgs::ErrorMessage>>
4633 (&self, height_opt: Option<u32>, f: FN) {
4634 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
4635 // during initialization prior to the chain_monitor being fully configured in some cases.
4636 // See the docs for `ChannelManagerReadArgs` for more.
4638 let mut failed_channels = Vec::new();
4639 let mut timed_out_htlcs = Vec::new();
4641 let mut channel_lock = self.channel_state.lock().unwrap();
4642 let channel_state = &mut *channel_lock;
4643 let short_to_id = &mut channel_state.short_to_id;
4644 let pending_msg_events = &mut channel_state.pending_msg_events;
4645 channel_state.by_id.retain(|_, channel| {
4646 let res = f(channel);
4647 if let Ok((chan_res, mut timed_out_pending_htlcs)) = res {
4648 for (source, payment_hash) in timed_out_pending_htlcs.drain(..) {
4649 let chan_update = self.get_channel_update_for_unicast(&channel).map(|u| u.encode_with_len()).unwrap(); // Cannot add/recv HTLCs before we have a short_id so unwrap is safe
4650 timed_out_htlcs.push((source, payment_hash, HTLCFailReason::Reason {
4651 failure_code: 0x1000 | 14, // expiry_too_soon, or at least it is now
4655 if let Some(funding_locked) = chan_res {
4656 pending_msg_events.push(events::MessageSendEvent::SendFundingLocked {
4657 node_id: channel.get_counterparty_node_id(),
4658 msg: funding_locked,
4660 if let Some(announcement_sigs) = self.get_announcement_sigs(channel) {
4661 log_trace!(self.logger, "Sending funding_locked and announcement_signatures for {}", log_bytes!(channel.channel_id()));
4662 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
4663 node_id: channel.get_counterparty_node_id(),
4664 msg: announcement_sigs,
4666 } else if channel.is_usable() {
4667 log_trace!(self.logger, "Sending funding_locked WITHOUT announcement_signatures but with private channel_update for our counterparty on channel {}", log_bytes!(channel.channel_id()));
4668 pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
4669 node_id: channel.get_counterparty_node_id(),
4670 msg: self.get_channel_update_for_unicast(channel).unwrap(),
4673 log_trace!(self.logger, "Sending funding_locked WITHOUT announcement_signatures for {}", log_bytes!(channel.channel_id()));
4675 short_to_id.insert(channel.get_short_channel_id().unwrap(), channel.channel_id());
4677 } else if let Err(e) = res {
4678 if let Some(short_id) = channel.get_short_channel_id() {
4679 short_to_id.remove(&short_id);
4681 // It looks like our counterparty went on-chain or funding transaction was
4682 // reorged out of the main chain. Close the channel.
4683 failed_channels.push(channel.force_shutdown(true));
4684 if let Ok(update) = self.get_channel_update_for_broadcast(&channel) {
4685 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
4689 self.issue_channel_close_events(channel, ClosureReason::CommitmentTxConfirmed);
4690 pending_msg_events.push(events::MessageSendEvent::HandleError {
4691 node_id: channel.get_counterparty_node_id(),
4692 action: msgs::ErrorAction::SendErrorMessage { msg: e },
4699 if let Some(height) = height_opt {
4700 channel_state.claimable_htlcs.retain(|payment_hash, htlcs| {
4701 htlcs.retain(|htlc| {
4702 // If height is approaching the number of blocks we think it takes us to get
4703 // our commitment transaction confirmed before the HTLC expires, plus the
4704 // number of blocks we generally consider it to take to do a commitment update,
4705 // just give up on it and fail the HTLC.
4706 if height >= htlc.cltv_expiry - HTLC_FAIL_BACK_BUFFER {
4707 let mut htlc_msat_height_data = byte_utils::be64_to_array(htlc.value).to_vec();
4708 htlc_msat_height_data.extend_from_slice(&byte_utils::be32_to_array(height));
4709 timed_out_htlcs.push((HTLCSource::PreviousHopData(htlc.prev_hop.clone()), payment_hash.clone(), HTLCFailReason::Reason {
4710 failure_code: 0x4000 | 15,
4711 data: htlc_msat_height_data
4716 !htlcs.is_empty() // Only retain this entry if htlcs has at least one entry.
4721 self.handle_init_event_channel_failures(failed_channels);
4723 for (source, payment_hash, reason) in timed_out_htlcs.drain(..) {
4724 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), source, &payment_hash, reason);
4728 /// Blocks until ChannelManager needs to be persisted or a timeout is reached. It returns a bool
4729 /// indicating whether persistence is necessary. Only one listener on
4730 /// `await_persistable_update` or `await_persistable_update_timeout` is guaranteed to be woken
4732 /// Note that the feature `allow_wallclock_use` must be enabled to use this function.
4733 #[cfg(any(test, feature = "allow_wallclock_use"))]
4734 pub fn await_persistable_update_timeout(&self, max_wait: Duration) -> bool {
4735 self.persistence_notifier.wait_timeout(max_wait)
4738 /// Blocks until ChannelManager needs to be persisted. Only one listener on
4739 /// `await_persistable_update` or `await_persistable_update_timeout` is guaranteed to be woken
4741 pub fn await_persistable_update(&self) {
4742 self.persistence_notifier.wait()
4745 #[cfg(any(test, feature = "_test_utils"))]
4746 pub fn get_persistence_condvar_value(&self) -> bool {
4747 let mutcond = &self.persistence_notifier.persistence_lock;
4748 let &(ref mtx, _) = mutcond;
4749 let guard = mtx.lock().unwrap();
4753 /// Gets the latest best block which was connected either via the [`chain::Listen`] or
4754 /// [`chain::Confirm`] interfaces.
4755 pub fn current_best_block(&self) -> BestBlock {
4756 self.best_block.read().unwrap().clone()
4760 impl<Signer: Sign, M: Deref , T: Deref , K: Deref , F: Deref , L: Deref >
4761 ChannelMessageHandler for ChannelManager<Signer, M, T, K, F, L>
4762 where M::Target: chain::Watch<Signer>,
4763 T::Target: BroadcasterInterface,
4764 K::Target: KeysInterface<Signer = Signer>,
4765 F::Target: FeeEstimator,
4768 fn handle_open_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::OpenChannel) {
4769 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4770 let _ = handle_error!(self, self.internal_open_channel(counterparty_node_id, their_features, msg), *counterparty_node_id);
4773 fn handle_accept_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::AcceptChannel) {
4774 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4775 let _ = handle_error!(self, self.internal_accept_channel(counterparty_node_id, their_features, msg), *counterparty_node_id);
4778 fn handle_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) {
4779 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4780 let _ = handle_error!(self, self.internal_funding_created(counterparty_node_id, msg), *counterparty_node_id);
4783 fn handle_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) {
4784 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4785 let _ = handle_error!(self, self.internal_funding_signed(counterparty_node_id, msg), *counterparty_node_id);
4788 fn handle_funding_locked(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingLocked) {
4789 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4790 let _ = handle_error!(self, self.internal_funding_locked(counterparty_node_id, msg), *counterparty_node_id);
4793 fn handle_shutdown(&self, counterparty_node_id: &PublicKey, their_features: &InitFeatures, msg: &msgs::Shutdown) {
4794 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4795 let _ = handle_error!(self, self.internal_shutdown(counterparty_node_id, their_features, msg), *counterparty_node_id);
4798 fn handle_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
4799 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4800 let _ = handle_error!(self, self.internal_closing_signed(counterparty_node_id, msg), *counterparty_node_id);
4803 fn handle_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
4804 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4805 let _ = handle_error!(self, self.internal_update_add_htlc(counterparty_node_id, msg), *counterparty_node_id);
4808 fn handle_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
4809 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4810 let _ = handle_error!(self, self.internal_update_fulfill_htlc(counterparty_node_id, msg), *counterparty_node_id);
4813 fn handle_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
4814 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4815 let _ = handle_error!(self, self.internal_update_fail_htlc(counterparty_node_id, msg), *counterparty_node_id);
4818 fn handle_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
4819 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4820 let _ = handle_error!(self, self.internal_update_fail_malformed_htlc(counterparty_node_id, msg), *counterparty_node_id);
4823 fn handle_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
4824 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4825 let _ = handle_error!(self, self.internal_commitment_signed(counterparty_node_id, msg), *counterparty_node_id);
4828 fn handle_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
4829 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4830 let _ = handle_error!(self, self.internal_revoke_and_ack(counterparty_node_id, msg), *counterparty_node_id);
4833 fn handle_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) {
4834 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4835 let _ = handle_error!(self, self.internal_update_fee(counterparty_node_id, msg), *counterparty_node_id);
4838 fn handle_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
4839 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4840 let _ = handle_error!(self, self.internal_announcement_signatures(counterparty_node_id, msg), *counterparty_node_id);
4843 fn handle_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) {
4844 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
4845 if let Ok(persist) = handle_error!(self, self.internal_channel_update(counterparty_node_id, msg), *counterparty_node_id) {
4848 NotifyOption::SkipPersist
4853 fn handle_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
4854 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4855 let _ = handle_error!(self, self.internal_channel_reestablish(counterparty_node_id, msg), *counterparty_node_id);
4858 fn peer_disconnected(&self, counterparty_node_id: &PublicKey, no_connection_possible: bool) {
4859 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4860 let mut failed_channels = Vec::new();
4861 let mut no_channels_remain = true;
4863 let mut channel_state_lock = self.channel_state.lock().unwrap();
4864 let channel_state = &mut *channel_state_lock;
4865 let short_to_id = &mut channel_state.short_to_id;
4866 let pending_msg_events = &mut channel_state.pending_msg_events;
4867 if no_connection_possible {
4868 log_debug!(self.logger, "Failing all channels with {} due to no_connection_possible", log_pubkey!(counterparty_node_id));
4869 channel_state.by_id.retain(|_, chan| {
4870 if chan.get_counterparty_node_id() == *counterparty_node_id {
4871 if let Some(short_id) = chan.get_short_channel_id() {
4872 short_to_id.remove(&short_id);
4874 failed_channels.push(chan.force_shutdown(true));
4875 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
4876 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
4880 self.issue_channel_close_events(chan, ClosureReason::DisconnectedPeer);
4887 log_debug!(self.logger, "Marking channels with {} disconnected and generating channel_updates", log_pubkey!(counterparty_node_id));
4888 channel_state.by_id.retain(|_, chan| {
4889 if chan.get_counterparty_node_id() == *counterparty_node_id {
4890 chan.remove_uncommitted_htlcs_and_mark_paused(&self.logger);
4891 if chan.is_shutdown() {
4892 if let Some(short_id) = chan.get_short_channel_id() {
4893 short_to_id.remove(&short_id);
4895 self.issue_channel_close_events(chan, ClosureReason::DisconnectedPeer);
4898 no_channels_remain = false;
4904 pending_msg_events.retain(|msg| {
4906 &events::MessageSendEvent::SendAcceptChannel { ref node_id, .. } => node_id != counterparty_node_id,
4907 &events::MessageSendEvent::SendOpenChannel { ref node_id, .. } => node_id != counterparty_node_id,
4908 &events::MessageSendEvent::SendFundingCreated { ref node_id, .. } => node_id != counterparty_node_id,
4909 &events::MessageSendEvent::SendFundingSigned { ref node_id, .. } => node_id != counterparty_node_id,
4910 &events::MessageSendEvent::SendFundingLocked { ref node_id, .. } => node_id != counterparty_node_id,
4911 &events::MessageSendEvent::SendAnnouncementSignatures { ref node_id, .. } => node_id != counterparty_node_id,
4912 &events::MessageSendEvent::UpdateHTLCs { ref node_id, .. } => node_id != counterparty_node_id,
4913 &events::MessageSendEvent::SendRevokeAndACK { ref node_id, .. } => node_id != counterparty_node_id,
4914 &events::MessageSendEvent::SendClosingSigned { ref node_id, .. } => node_id != counterparty_node_id,
4915 &events::MessageSendEvent::SendShutdown { ref node_id, .. } => node_id != counterparty_node_id,
4916 &events::MessageSendEvent::SendChannelReestablish { ref node_id, .. } => node_id != counterparty_node_id,
4917 &events::MessageSendEvent::BroadcastChannelAnnouncement { .. } => true,
4918 &events::MessageSendEvent::BroadcastNodeAnnouncement { .. } => true,
4919 &events::MessageSendEvent::BroadcastChannelUpdate { .. } => true,
4920 &events::MessageSendEvent::SendChannelUpdate { ref node_id, .. } => node_id != counterparty_node_id,
4921 &events::MessageSendEvent::HandleError { ref node_id, .. } => node_id != counterparty_node_id,
4922 &events::MessageSendEvent::SendChannelRangeQuery { .. } => false,
4923 &events::MessageSendEvent::SendShortIdsQuery { .. } => false,
4924 &events::MessageSendEvent::SendReplyChannelRange { .. } => false,
4928 if no_channels_remain {
4929 self.per_peer_state.write().unwrap().remove(counterparty_node_id);
4932 for failure in failed_channels.drain(..) {
4933 self.finish_force_close_channel(failure);
4937 fn peer_connected(&self, counterparty_node_id: &PublicKey, init_msg: &msgs::Init) {
4938 log_debug!(self.logger, "Generating channel_reestablish events for {}", log_pubkey!(counterparty_node_id));
4940 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4943 let mut peer_state_lock = self.per_peer_state.write().unwrap();
4944 match peer_state_lock.entry(counterparty_node_id.clone()) {
4945 hash_map::Entry::Vacant(e) => {
4946 e.insert(Mutex::new(PeerState {
4947 latest_features: init_msg.features.clone(),
4950 hash_map::Entry::Occupied(e) => {
4951 e.get().lock().unwrap().latest_features = init_msg.features.clone();
4956 let mut channel_state_lock = self.channel_state.lock().unwrap();
4957 let channel_state = &mut *channel_state_lock;
4958 let pending_msg_events = &mut channel_state.pending_msg_events;
4959 channel_state.by_id.retain(|_, chan| {
4960 if chan.get_counterparty_node_id() == *counterparty_node_id {
4961 if !chan.have_received_message() {
4962 // If we created this (outbound) channel while we were disconnected from the
4963 // peer we probably failed to send the open_channel message, which is now
4964 // lost. We can't have had anything pending related to this channel, so we just
4968 pending_msg_events.push(events::MessageSendEvent::SendChannelReestablish {
4969 node_id: chan.get_counterparty_node_id(),
4970 msg: chan.get_channel_reestablish(&self.logger),
4976 //TODO: Also re-broadcast announcement_signatures
4979 fn handle_error(&self, counterparty_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
4980 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4982 if msg.channel_id == [0; 32] {
4983 for chan in self.list_channels() {
4984 if chan.counterparty.node_id == *counterparty_node_id {
4985 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
4986 let _ = self.force_close_channel_with_peer(&chan.channel_id, Some(counterparty_node_id), Some(&msg.data));
4990 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
4991 let _ = self.force_close_channel_with_peer(&msg.channel_id, Some(counterparty_node_id), Some(&msg.data));
4996 /// Used to signal to the ChannelManager persister that the manager needs to be re-persisted to
4997 /// disk/backups, through `await_persistable_update_timeout` and `await_persistable_update`.
4998 struct PersistenceNotifier {
4999 /// Users won't access the persistence_lock directly, but rather wait on its bool using
5000 /// `wait_timeout` and `wait`.
5001 persistence_lock: (Mutex<bool>, Condvar),
5004 impl PersistenceNotifier {
5007 persistence_lock: (Mutex::new(false), Condvar::new()),
5013 let &(ref mtx, ref cvar) = &self.persistence_lock;
5014 let mut guard = mtx.lock().unwrap();
5019 guard = cvar.wait(guard).unwrap();
5020 let result = *guard;
5028 #[cfg(any(test, feature = "allow_wallclock_use"))]
5029 fn wait_timeout(&self, max_wait: Duration) -> bool {
5030 let current_time = Instant::now();
5032 let &(ref mtx, ref cvar) = &self.persistence_lock;
5033 let mut guard = mtx.lock().unwrap();
5038 guard = cvar.wait_timeout(guard, max_wait).unwrap().0;
5039 // Due to spurious wakeups that can happen on `wait_timeout`, here we need to check if the
5040 // desired wait time has actually passed, and if not then restart the loop with a reduced wait
5041 // time. Note that this logic can be highly simplified through the use of
5042 // `Condvar::wait_while` and `Condvar::wait_timeout_while`, if and when our MSRV is raised to
5044 let elapsed = current_time.elapsed();
5045 let result = *guard;
5046 if result || elapsed >= max_wait {
5050 match max_wait.checked_sub(elapsed) {
5051 None => return result,
5057 // Signal to the ChannelManager persister that there are updates necessitating persisting to disk.
5059 let &(ref persist_mtx, ref cnd) = &self.persistence_lock;
5060 let mut persistence_lock = persist_mtx.lock().unwrap();
5061 *persistence_lock = true;
5062 mem::drop(persistence_lock);
5067 const SERIALIZATION_VERSION: u8 = 1;
5068 const MIN_SERIALIZATION_VERSION: u8 = 1;
5070 impl_writeable_tlv_based_enum!(PendingHTLCRouting,
5072 (0, onion_packet, required),
5073 (2, short_channel_id, required),
5076 (0, payment_data, required),
5077 (2, incoming_cltv_expiry, required),
5079 (2, ReceiveKeysend) => {
5080 (0, payment_preimage, required),
5081 (2, incoming_cltv_expiry, required),
5085 impl_writeable_tlv_based!(PendingHTLCInfo, {
5086 (0, routing, required),
5087 (2, incoming_shared_secret, required),
5088 (4, payment_hash, required),
5089 (6, amt_to_forward, required),
5090 (8, outgoing_cltv_value, required)
5094 impl Writeable for HTLCFailureMsg {
5095 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
5097 HTLCFailureMsg::Relay(msgs::UpdateFailHTLC { channel_id, htlc_id, reason }) => {
5099 channel_id.write(writer)?;
5100 htlc_id.write(writer)?;
5101 reason.write(writer)?;
5103 HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
5104 channel_id, htlc_id, sha256_of_onion, failure_code
5107 channel_id.write(writer)?;
5108 htlc_id.write(writer)?;
5109 sha256_of_onion.write(writer)?;
5110 failure_code.write(writer)?;
5117 impl Readable for HTLCFailureMsg {
5118 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
5119 let id: u8 = Readable::read(reader)?;
5122 Ok(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
5123 channel_id: Readable::read(reader)?,
5124 htlc_id: Readable::read(reader)?,
5125 reason: Readable::read(reader)?,
5129 Ok(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
5130 channel_id: Readable::read(reader)?,
5131 htlc_id: Readable::read(reader)?,
5132 sha256_of_onion: Readable::read(reader)?,
5133 failure_code: Readable::read(reader)?,
5136 // In versions prior to 0.0.101, HTLCFailureMsg objects were written with type 0 or 1 but
5137 // weren't length-prefixed and thus didn't support reading the TLV stream suffix of the network
5138 // messages contained in the variants.
5139 // In version 0.0.101, support for reading the variants with these types was added, and
5140 // we should migrate to writing these variants when UpdateFailHTLC or
5141 // UpdateFailMalformedHTLC get TLV fields.
5143 let length: BigSize = Readable::read(reader)?;
5144 let mut s = FixedLengthReader::new(reader, length.0);
5145 let res = Readable::read(&mut s)?;
5146 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
5147 Ok(HTLCFailureMsg::Relay(res))
5150 let length: BigSize = Readable::read(reader)?;
5151 let mut s = FixedLengthReader::new(reader, length.0);
5152 let res = Readable::read(&mut s)?;
5153 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
5154 Ok(HTLCFailureMsg::Malformed(res))
5156 _ => Err(DecodeError::UnknownRequiredFeature),
5161 impl_writeable_tlv_based_enum!(PendingHTLCStatus, ;
5166 impl_writeable_tlv_based!(HTLCPreviousHopData, {
5167 (0, short_channel_id, required),
5168 (2, outpoint, required),
5169 (4, htlc_id, required),
5170 (6, incoming_packet_shared_secret, required)
5173 impl Writeable for ClaimableHTLC {
5174 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
5175 let payment_data = match &self.onion_payload {
5176 OnionPayload::Invoice(data) => Some(data.clone()),
5179 let keysend_preimage = match self.onion_payload {
5180 OnionPayload::Invoice(_) => None,
5181 OnionPayload::Spontaneous(preimage) => Some(preimage.clone()),
5186 (0, self.prev_hop, required), (2, self.value, required),
5187 (4, payment_data, option), (6, self.cltv_expiry, required),
5188 (8, keysend_preimage, option),
5194 impl Readable for ClaimableHTLC {
5195 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
5196 let mut prev_hop = ::util::ser::OptionDeserWrapper(None);
5198 let mut payment_data: Option<msgs::FinalOnionHopData> = None;
5199 let mut cltv_expiry = 0;
5200 let mut keysend_preimage: Option<PaymentPreimage> = None;
5204 (0, prev_hop, required), (2, value, required),
5205 (4, payment_data, option), (6, cltv_expiry, required),
5206 (8, keysend_preimage, option)
5208 let onion_payload = match keysend_preimage {
5210 if payment_data.is_some() {
5211 return Err(DecodeError::InvalidValue)
5213 OnionPayload::Spontaneous(p)
5216 if payment_data.is_none() {
5217 return Err(DecodeError::InvalidValue)
5219 OnionPayload::Invoice(payment_data.unwrap())
5223 prev_hop: prev_hop.0.unwrap(),
5231 impl Readable for HTLCSource {
5232 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
5233 let id: u8 = Readable::read(reader)?;
5236 let mut session_priv: ::util::ser::OptionDeserWrapper<SecretKey> = ::util::ser::OptionDeserWrapper(None);
5237 let mut first_hop_htlc_msat: u64 = 0;
5238 let mut path = Some(Vec::new());
5239 let mut payment_id = None;
5240 read_tlv_fields!(reader, {
5241 (0, session_priv, required),
5242 (1, payment_id, option),
5243 (2, first_hop_htlc_msat, required),
5244 (4, path, vec_type),
5246 if payment_id.is_none() {
5247 // For backwards compat, if there was no payment_id written, use the session_priv bytes
5249 payment_id = Some(PaymentId(*session_priv.0.unwrap().as_ref()));
5251 Ok(HTLCSource::OutboundRoute {
5252 session_priv: session_priv.0.unwrap(),
5253 first_hop_htlc_msat: first_hop_htlc_msat,
5254 path: path.unwrap(),
5255 payment_id: payment_id.unwrap(),
5258 1 => Ok(HTLCSource::PreviousHopData(Readable::read(reader)?)),
5259 _ => Err(DecodeError::UnknownRequiredFeature),
5264 impl Writeable for HTLCSource {
5265 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::io::Error> {
5267 HTLCSource::OutboundRoute { ref session_priv, ref first_hop_htlc_msat, ref path, payment_id } => {
5269 let payment_id_opt = Some(payment_id);
5270 write_tlv_fields!(writer, {
5271 (0, session_priv, required),
5272 (1, payment_id_opt, option),
5273 (2, first_hop_htlc_msat, required),
5274 (4, path, vec_type),
5277 HTLCSource::PreviousHopData(ref field) => {
5279 field.write(writer)?;
5286 impl_writeable_tlv_based_enum!(HTLCFailReason,
5287 (0, LightningError) => {
5291 (0, failure_code, required),
5292 (2, data, vec_type),
5296 impl_writeable_tlv_based_enum!(HTLCForwardInfo,
5298 (0, forward_info, required),
5299 (2, prev_short_channel_id, required),
5300 (4, prev_htlc_id, required),
5301 (6, prev_funding_outpoint, required),
5304 (0, htlc_id, required),
5305 (2, err_packet, required),
5309 impl_writeable_tlv_based!(PendingInboundPayment, {
5310 (0, payment_secret, required),
5311 (2, expiry_time, required),
5312 (4, user_payment_id, required),
5313 (6, payment_preimage, required),
5314 (8, min_value_msat, required),
5317 impl_writeable_tlv_based_enum!(PendingOutboundPayment,
5319 (0, session_privs, required),
5322 (0, session_privs, required),
5323 (2, payment_hash, required),
5324 (4, payment_secret, option),
5325 (6, total_msat, required),
5326 (8, pending_amt_msat, required),
5327 (10, starting_block_height, required),
5331 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> Writeable for ChannelManager<Signer, M, T, K, F, L>
5332 where M::Target: chain::Watch<Signer>,
5333 T::Target: BroadcasterInterface,
5334 K::Target: KeysInterface<Signer = Signer>,
5335 F::Target: FeeEstimator,
5338 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
5339 let _consistency_lock = self.total_consistency_lock.write().unwrap();
5341 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
5343 self.genesis_hash.write(writer)?;
5345 let best_block = self.best_block.read().unwrap();
5346 best_block.height().write(writer)?;
5347 best_block.block_hash().write(writer)?;
5350 let channel_state = self.channel_state.lock().unwrap();
5351 let mut unfunded_channels = 0;
5352 for (_, channel) in channel_state.by_id.iter() {
5353 if !channel.is_funding_initiated() {
5354 unfunded_channels += 1;
5357 ((channel_state.by_id.len() - unfunded_channels) as u64).write(writer)?;
5358 for (_, channel) in channel_state.by_id.iter() {
5359 if channel.is_funding_initiated() {
5360 channel.write(writer)?;
5364 (channel_state.forward_htlcs.len() as u64).write(writer)?;
5365 for (short_channel_id, pending_forwards) in channel_state.forward_htlcs.iter() {
5366 short_channel_id.write(writer)?;
5367 (pending_forwards.len() as u64).write(writer)?;
5368 for forward in pending_forwards {
5369 forward.write(writer)?;
5373 (channel_state.claimable_htlcs.len() as u64).write(writer)?;
5374 for (payment_hash, previous_hops) in channel_state.claimable_htlcs.iter() {
5375 payment_hash.write(writer)?;
5376 (previous_hops.len() as u64).write(writer)?;
5377 for htlc in previous_hops.iter() {
5378 htlc.write(writer)?;
5382 let per_peer_state = self.per_peer_state.write().unwrap();
5383 (per_peer_state.len() as u64).write(writer)?;
5384 for (peer_pubkey, peer_state_mutex) in per_peer_state.iter() {
5385 peer_pubkey.write(writer)?;
5386 let peer_state = peer_state_mutex.lock().unwrap();
5387 peer_state.latest_features.write(writer)?;
5390 let events = self.pending_events.lock().unwrap();
5391 (events.len() as u64).write(writer)?;
5392 for event in events.iter() {
5393 event.write(writer)?;
5396 let background_events = self.pending_background_events.lock().unwrap();
5397 (background_events.len() as u64).write(writer)?;
5398 for event in background_events.iter() {
5400 BackgroundEvent::ClosingMonitorUpdate((funding_txo, monitor_update)) => {
5402 funding_txo.write(writer)?;
5403 monitor_update.write(writer)?;
5408 (self.last_node_announcement_serial.load(Ordering::Acquire) as u32).write(writer)?;
5409 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
5411 let pending_inbound_payments = self.pending_inbound_payments.lock().unwrap();
5412 (pending_inbound_payments.len() as u64).write(writer)?;
5413 for (hash, pending_payment) in pending_inbound_payments.iter() {
5414 hash.write(writer)?;
5415 pending_payment.write(writer)?;
5418 let pending_outbound_payments = self.pending_outbound_payments.lock().unwrap();
5419 // For backwards compat, write the session privs and their total length.
5420 let mut num_pending_outbounds_compat: u64 = 0;
5421 for (_, outbound) in pending_outbound_payments.iter() {
5422 num_pending_outbounds_compat += outbound.remaining_parts() as u64;
5424 num_pending_outbounds_compat.write(writer)?;
5425 for (_, outbound) in pending_outbound_payments.iter() {
5427 PendingOutboundPayment::Legacy { session_privs } |
5428 PendingOutboundPayment::Retryable { session_privs, .. } => {
5429 for session_priv in session_privs.iter() {
5430 session_priv.write(writer)?;
5436 // Encode without retry info for 0.0.101 compatibility.
5437 let mut pending_outbound_payments_no_retry: HashMap<PaymentId, HashSet<[u8; 32]>> = HashMap::new();
5438 for (id, outbound) in pending_outbound_payments.iter() {
5440 PendingOutboundPayment::Legacy { session_privs } |
5441 PendingOutboundPayment::Retryable { session_privs, .. } => {
5442 pending_outbound_payments_no_retry.insert(*id, session_privs.clone());
5446 write_tlv_fields!(writer, {
5447 (1, pending_outbound_payments_no_retry, required),
5448 (3, pending_outbound_payments, required),
5455 /// Arguments for the creation of a ChannelManager that are not deserialized.
5457 /// At a high-level, the process for deserializing a ChannelManager and resuming normal operation
5459 /// 1) Deserialize all stored ChannelMonitors.
5460 /// 2) Deserialize the ChannelManager by filling in this struct and calling:
5461 /// <(BlockHash, ChannelManager)>::read(reader, args)
5462 /// This may result in closing some Channels if the ChannelMonitor is newer than the stored
5463 /// ChannelManager state to ensure no loss of funds. Thus, transactions may be broadcasted.
5464 /// 3) If you are not fetching full blocks, register all relevant ChannelMonitor outpoints the same
5465 /// way you would handle a `chain::Filter` call using ChannelMonitor::get_outputs_to_watch() and
5466 /// ChannelMonitor::get_funding_txo().
5467 /// 4) Reconnect blocks on your ChannelMonitors.
5468 /// 5) Disconnect/connect blocks on the ChannelManager.
5469 /// 6) Move the ChannelMonitors into your local chain::Watch.
5471 /// Note that the ordering of #4-6 is not of importance, however all three must occur before you
5472 /// call any other methods on the newly-deserialized ChannelManager.
5474 /// Note that because some channels may be closed during deserialization, it is critical that you
5475 /// always deserialize only the latest version of a ChannelManager and ChannelMonitors available to
5476 /// you. If you deserialize an old ChannelManager (during which force-closure transactions may be
5477 /// broadcast), and then later deserialize a newer version of the same ChannelManager (which will
5478 /// not force-close the same channels but consider them live), you may end up revoking a state for
5479 /// which you've already broadcasted the transaction.
5480 pub struct ChannelManagerReadArgs<'a, Signer: 'a + Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
5481 where M::Target: chain::Watch<Signer>,
5482 T::Target: BroadcasterInterface,
5483 K::Target: KeysInterface<Signer = Signer>,
5484 F::Target: FeeEstimator,
5487 /// The keys provider which will give us relevant keys. Some keys will be loaded during
5488 /// deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
5490 pub keys_manager: K,
5492 /// The fee_estimator for use in the ChannelManager in the future.
5494 /// No calls to the FeeEstimator will be made during deserialization.
5495 pub fee_estimator: F,
5496 /// The chain::Watch for use in the ChannelManager in the future.
5498 /// No calls to the chain::Watch will be made during deserialization. It is assumed that
5499 /// you have deserialized ChannelMonitors separately and will add them to your
5500 /// chain::Watch after deserializing this ChannelManager.
5501 pub chain_monitor: M,
5503 /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
5504 /// used to broadcast the latest local commitment transactions of channels which must be
5505 /// force-closed during deserialization.
5506 pub tx_broadcaster: T,
5507 /// The Logger for use in the ChannelManager and which may be used to log information during
5508 /// deserialization.
5510 /// Default settings used for new channels. Any existing channels will continue to use the
5511 /// runtime settings which were stored when the ChannelManager was serialized.
5512 pub default_config: UserConfig,
5514 /// A map from channel funding outpoints to ChannelMonitors for those channels (ie
5515 /// value.get_funding_txo() should be the key).
5517 /// If a monitor is inconsistent with the channel state during deserialization the channel will
5518 /// be force-closed using the data in the ChannelMonitor and the channel will be dropped. This
5519 /// is true for missing channels as well. If there is a monitor missing for which we find
5520 /// channel data Err(DecodeError::InvalidValue) will be returned.
5522 /// In such cases the latest local transactions will be sent to the tx_broadcaster included in
5525 /// (C-not exported) because we have no HashMap bindings
5526 pub channel_monitors: HashMap<OutPoint, &'a mut ChannelMonitor<Signer>>,
5529 impl<'a, Signer: 'a + Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
5530 ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>
5531 where M::Target: chain::Watch<Signer>,
5532 T::Target: BroadcasterInterface,
5533 K::Target: KeysInterface<Signer = Signer>,
5534 F::Target: FeeEstimator,
5537 /// Simple utility function to create a ChannelManagerReadArgs which creates the monitor
5538 /// HashMap for you. This is primarily useful for C bindings where it is not practical to
5539 /// populate a HashMap directly from C.
5540 pub fn new(keys_manager: K, fee_estimator: F, chain_monitor: M, tx_broadcaster: T, logger: L, default_config: UserConfig,
5541 mut channel_monitors: Vec<&'a mut ChannelMonitor<Signer>>) -> Self {
5543 keys_manager, fee_estimator, chain_monitor, tx_broadcaster, logger, default_config,
5544 channel_monitors: channel_monitors.drain(..).map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect()
5549 // Implement ReadableArgs for an Arc'd ChannelManager to make it a bit easier to work with the
5550 // SipmleArcChannelManager type:
5551 impl<'a, Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
5552 ReadableArgs<ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>> for (BlockHash, Arc<ChannelManager<Signer, M, T, K, F, L>>)
5553 where M::Target: chain::Watch<Signer>,
5554 T::Target: BroadcasterInterface,
5555 K::Target: KeysInterface<Signer = Signer>,
5556 F::Target: FeeEstimator,
5559 fn read<R: io::Read>(reader: &mut R, args: ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>) -> Result<Self, DecodeError> {
5560 let (blockhash, chan_manager) = <(BlockHash, ChannelManager<Signer, M, T, K, F, L>)>::read(reader, args)?;
5561 Ok((blockhash, Arc::new(chan_manager)))
5565 impl<'a, Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
5566 ReadableArgs<ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>> for (BlockHash, ChannelManager<Signer, M, T, K, F, L>)
5567 where M::Target: chain::Watch<Signer>,
5568 T::Target: BroadcasterInterface,
5569 K::Target: KeysInterface<Signer = Signer>,
5570 F::Target: FeeEstimator,
5573 fn read<R: io::Read>(reader: &mut R, mut args: ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>) -> Result<Self, DecodeError> {
5574 let _ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
5576 let genesis_hash: BlockHash = Readable::read(reader)?;
5577 let best_block_height: u32 = Readable::read(reader)?;
5578 let best_block_hash: BlockHash = Readable::read(reader)?;
5580 let mut failed_htlcs = Vec::new();
5582 let channel_count: u64 = Readable::read(reader)?;
5583 let mut funding_txo_set = HashSet::with_capacity(cmp::min(channel_count as usize, 128));
5584 let mut by_id = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
5585 let mut short_to_id = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
5586 let mut channel_closures = Vec::new();
5587 for _ in 0..channel_count {
5588 let mut channel: Channel<Signer> = Channel::read(reader, &args.keys_manager)?;
5589 let funding_txo = channel.get_funding_txo().ok_or(DecodeError::InvalidValue)?;
5590 funding_txo_set.insert(funding_txo.clone());
5591 if let Some(ref mut monitor) = args.channel_monitors.get_mut(&funding_txo) {
5592 if channel.get_cur_holder_commitment_transaction_number() < monitor.get_cur_holder_commitment_number() ||
5593 channel.get_revoked_counterparty_commitment_transaction_number() < monitor.get_min_seen_secret() ||
5594 channel.get_cur_counterparty_commitment_transaction_number() < monitor.get_cur_counterparty_commitment_number() ||
5595 channel.get_latest_monitor_update_id() > monitor.get_latest_update_id() {
5596 // If the channel is ahead of the monitor, return InvalidValue:
5597 log_error!(args.logger, "A ChannelMonitor is stale compared to the current ChannelManager! This indicates a potentially-critical violation of the chain::Watch API!");
5598 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
5599 log_bytes!(channel.channel_id()), monitor.get_latest_update_id(), channel.get_latest_monitor_update_id());
5600 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
5601 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
5602 log_error!(args.logger, " Without the latest ChannelMonitor we cannot continue without risking funds.");
5603 log_error!(args.logger, " Please ensure the chain::Watch API requirements are met and file a bug report at https://github.com/rust-bitcoin/rust-lightning");
5604 return Err(DecodeError::InvalidValue);
5605 } else if channel.get_cur_holder_commitment_transaction_number() > monitor.get_cur_holder_commitment_number() ||
5606 channel.get_revoked_counterparty_commitment_transaction_number() > monitor.get_min_seen_secret() ||
5607 channel.get_cur_counterparty_commitment_transaction_number() > monitor.get_cur_counterparty_commitment_number() ||
5608 channel.get_latest_monitor_update_id() < monitor.get_latest_update_id() {
5609 // But if the channel is behind of the monitor, close the channel:
5610 log_error!(args.logger, "A ChannelManager is stale compared to the current ChannelMonitor!");
5611 log_error!(args.logger, " The channel will be force-closed and the latest commitment transaction from the ChannelMonitor broadcast.");
5612 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
5613 log_bytes!(channel.channel_id()), monitor.get_latest_update_id(), channel.get_latest_monitor_update_id());
5614 let (_, mut new_failed_htlcs) = channel.force_shutdown(true);
5615 failed_htlcs.append(&mut new_failed_htlcs);
5616 monitor.broadcast_latest_holder_commitment_txn(&args.tx_broadcaster, &args.logger);
5617 channel_closures.push(events::Event::ChannelClosed {
5618 channel_id: channel.channel_id(),
5619 reason: ClosureReason::OutdatedChannelManager
5622 if let Some(short_channel_id) = channel.get_short_channel_id() {
5623 short_to_id.insert(short_channel_id, channel.channel_id());
5625 by_id.insert(channel.channel_id(), channel);
5628 log_error!(args.logger, "Missing ChannelMonitor for channel {} needed by ChannelManager.", log_bytes!(channel.channel_id()));
5629 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
5630 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
5631 log_error!(args.logger, " Without the ChannelMonitor we cannot continue without risking funds.");
5632 log_error!(args.logger, " Please ensure the chain::Watch API requirements are met and file a bug report at https://github.com/rust-bitcoin/rust-lightning");
5633 return Err(DecodeError::InvalidValue);
5637 for (ref funding_txo, ref mut monitor) in args.channel_monitors.iter_mut() {
5638 if !funding_txo_set.contains(funding_txo) {
5639 monitor.broadcast_latest_holder_commitment_txn(&args.tx_broadcaster, &args.logger);
5643 const MAX_ALLOC_SIZE: usize = 1024 * 64;
5644 let forward_htlcs_count: u64 = Readable::read(reader)?;
5645 let mut forward_htlcs = HashMap::with_capacity(cmp::min(forward_htlcs_count as usize, 128));
5646 for _ in 0..forward_htlcs_count {
5647 let short_channel_id = Readable::read(reader)?;
5648 let pending_forwards_count: u64 = Readable::read(reader)?;
5649 let mut pending_forwards = Vec::with_capacity(cmp::min(pending_forwards_count as usize, MAX_ALLOC_SIZE/mem::size_of::<HTLCForwardInfo>()));
5650 for _ in 0..pending_forwards_count {
5651 pending_forwards.push(Readable::read(reader)?);
5653 forward_htlcs.insert(short_channel_id, pending_forwards);
5656 let claimable_htlcs_count: u64 = Readable::read(reader)?;
5657 let mut claimable_htlcs = HashMap::with_capacity(cmp::min(claimable_htlcs_count as usize, 128));
5658 for _ in 0..claimable_htlcs_count {
5659 let payment_hash = Readable::read(reader)?;
5660 let previous_hops_len: u64 = Readable::read(reader)?;
5661 let mut previous_hops = Vec::with_capacity(cmp::min(previous_hops_len as usize, MAX_ALLOC_SIZE/mem::size_of::<ClaimableHTLC>()));
5662 for _ in 0..previous_hops_len {
5663 previous_hops.push(Readable::read(reader)?);
5665 claimable_htlcs.insert(payment_hash, previous_hops);
5668 let peer_count: u64 = Readable::read(reader)?;
5669 let mut per_peer_state = HashMap::with_capacity(cmp::min(peer_count as usize, MAX_ALLOC_SIZE/mem::size_of::<(PublicKey, Mutex<PeerState>)>()));
5670 for _ in 0..peer_count {
5671 let peer_pubkey = Readable::read(reader)?;
5672 let peer_state = PeerState {
5673 latest_features: Readable::read(reader)?,
5675 per_peer_state.insert(peer_pubkey, Mutex::new(peer_state));
5678 let event_count: u64 = Readable::read(reader)?;
5679 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>()));
5680 for _ in 0..event_count {
5681 match MaybeReadable::read(reader)? {
5682 Some(event) => pending_events_read.push(event),
5686 if forward_htlcs_count > 0 {
5687 // If we have pending HTLCs to forward, assume we either dropped a
5688 // `PendingHTLCsForwardable` or the user received it but never processed it as they
5689 // shut down before the timer hit. Either way, set the time_forwardable to a small
5690 // constant as enough time has likely passed that we should simply handle the forwards
5691 // now, or at least after the user gets a chance to reconnect to our peers.
5692 pending_events_read.push(events::Event::PendingHTLCsForwardable {
5693 time_forwardable: Duration::from_secs(2),
5697 let background_event_count: u64 = Readable::read(reader)?;
5698 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>()));
5699 for _ in 0..background_event_count {
5700 match <u8 as Readable>::read(reader)? {
5701 0 => pending_background_events_read.push(BackgroundEvent::ClosingMonitorUpdate((Readable::read(reader)?, Readable::read(reader)?))),
5702 _ => return Err(DecodeError::InvalidValue),
5706 let last_node_announcement_serial: u32 = Readable::read(reader)?;
5707 let highest_seen_timestamp: u32 = Readable::read(reader)?;
5709 let pending_inbound_payment_count: u64 = Readable::read(reader)?;
5710 let mut pending_inbound_payments: HashMap<PaymentHash, PendingInboundPayment> = HashMap::with_capacity(cmp::min(pending_inbound_payment_count as usize, MAX_ALLOC_SIZE/(3*32)));
5711 for _ in 0..pending_inbound_payment_count {
5712 if pending_inbound_payments.insert(Readable::read(reader)?, Readable::read(reader)?).is_some() {
5713 return Err(DecodeError::InvalidValue);
5717 let pending_outbound_payments_count_compat: u64 = Readable::read(reader)?;
5718 let mut pending_outbound_payments_compat: HashMap<PaymentId, PendingOutboundPayment> =
5719 HashMap::with_capacity(cmp::min(pending_outbound_payments_count_compat as usize, MAX_ALLOC_SIZE/32));
5720 for _ in 0..pending_outbound_payments_count_compat {
5721 let session_priv = Readable::read(reader)?;
5722 let payment = PendingOutboundPayment::Legacy {
5723 session_privs: [session_priv].iter().cloned().collect()
5725 if pending_outbound_payments_compat.insert(PaymentId(session_priv), payment).is_some() {
5726 return Err(DecodeError::InvalidValue)
5730 // pending_outbound_payments_no_retry is for compatibility with 0.0.101 clients.
5731 let mut pending_outbound_payments_no_retry: Option<HashMap<PaymentId, HashSet<[u8; 32]>>> = None;
5732 let mut pending_outbound_payments = None;
5733 read_tlv_fields!(reader, {
5734 (1, pending_outbound_payments_no_retry, option),
5735 (3, pending_outbound_payments, option),
5737 if pending_outbound_payments.is_none() && pending_outbound_payments_no_retry.is_none() {
5738 pending_outbound_payments = Some(pending_outbound_payments_compat);
5739 } else if pending_outbound_payments.is_none() {
5740 let mut outbounds = HashMap::new();
5741 for (id, session_privs) in pending_outbound_payments_no_retry.unwrap().drain() {
5742 outbounds.insert(id, PendingOutboundPayment::Legacy { session_privs });
5744 pending_outbound_payments = Some(outbounds);
5747 let mut secp_ctx = Secp256k1::new();
5748 secp_ctx.seeded_randomize(&args.keys_manager.get_secure_random_bytes());
5750 if !channel_closures.is_empty() {
5751 pending_events_read.append(&mut channel_closures);
5754 let channel_manager = ChannelManager {
5756 fee_estimator: args.fee_estimator,
5757 chain_monitor: args.chain_monitor,
5758 tx_broadcaster: args.tx_broadcaster,
5760 best_block: RwLock::new(BestBlock::new(best_block_hash, best_block_height)),
5762 channel_state: Mutex::new(ChannelHolder {
5767 pending_msg_events: Vec::new(),
5769 pending_inbound_payments: Mutex::new(pending_inbound_payments),
5770 pending_outbound_payments: Mutex::new(pending_outbound_payments.unwrap()),
5772 our_network_key: args.keys_manager.get_node_secret(),
5773 our_network_pubkey: PublicKey::from_secret_key(&secp_ctx, &args.keys_manager.get_node_secret()),
5776 last_node_announcement_serial: AtomicUsize::new(last_node_announcement_serial as usize),
5777 highest_seen_timestamp: AtomicUsize::new(highest_seen_timestamp as usize),
5779 per_peer_state: RwLock::new(per_peer_state),
5781 pending_events: Mutex::new(pending_events_read),
5782 pending_background_events: Mutex::new(pending_background_events_read),
5783 total_consistency_lock: RwLock::new(()),
5784 persistence_notifier: PersistenceNotifier::new(),
5786 keys_manager: args.keys_manager,
5787 logger: args.logger,
5788 default_configuration: args.default_config,
5791 for htlc_source in failed_htlcs.drain(..) {
5792 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() });
5795 //TODO: Broadcast channel update for closed channels, but only after we've made a
5796 //connection or two.
5798 Ok((best_block_hash.clone(), channel_manager))
5804 use bitcoin::hashes::Hash;
5805 use bitcoin::hashes::sha256::Hash as Sha256;
5806 use core::time::Duration;
5807 use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
5808 use ln::channelmanager::{PaymentId, PaymentSendFailure};
5809 use ln::features::{InitFeatures, InvoiceFeatures};
5810 use ln::functional_test_utils::*;
5812 use ln::msgs::ChannelMessageHandler;
5813 use routing::router::{get_keysend_route, get_route};
5814 use util::errors::APIError;
5815 use util::events::{Event, MessageSendEvent, MessageSendEventsProvider};
5816 use util::test_utils;
5818 #[cfg(feature = "std")]
5820 fn test_wait_timeout() {
5821 use ln::channelmanager::PersistenceNotifier;
5823 use core::sync::atomic::{AtomicBool, Ordering};
5826 let persistence_notifier = Arc::new(PersistenceNotifier::new());
5827 let thread_notifier = Arc::clone(&persistence_notifier);
5829 let exit_thread = Arc::new(AtomicBool::new(false));
5830 let exit_thread_clone = exit_thread.clone();
5831 thread::spawn(move || {
5833 let &(ref persist_mtx, ref cnd) = &thread_notifier.persistence_lock;
5834 let mut persistence_lock = persist_mtx.lock().unwrap();
5835 *persistence_lock = true;
5838 if exit_thread_clone.load(Ordering::SeqCst) {
5844 // Check that we can block indefinitely until updates are available.
5845 let _ = persistence_notifier.wait();
5847 // Check that the PersistenceNotifier will return after the given duration if updates are
5850 if persistence_notifier.wait_timeout(Duration::from_millis(100)) {
5855 exit_thread.store(true, Ordering::SeqCst);
5857 // Check that the PersistenceNotifier will return after the given duration even if no updates
5860 if !persistence_notifier.wait_timeout(Duration::from_millis(100)) {
5867 fn test_notify_limits() {
5868 // Check that a few cases which don't require the persistence of a new ChannelManager,
5869 // indeed, do not cause the persistence of a new ChannelManager.
5870 let chanmon_cfgs = create_chanmon_cfgs(3);
5871 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5872 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5873 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5875 // All nodes start with a persistable update pending as `create_network` connects each node
5876 // with all other nodes to make most tests simpler.
5877 assert!(nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
5878 assert!(nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
5879 assert!(nodes[2].node.await_persistable_update_timeout(Duration::from_millis(1)));
5881 let mut chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5883 // We check that the channel info nodes have doesn't change too early, even though we try
5884 // to connect messages with new values
5885 chan.0.contents.fee_base_msat *= 2;
5886 chan.1.contents.fee_base_msat *= 2;
5887 let node_a_chan_info = nodes[0].node.list_channels()[0].clone();
5888 let node_b_chan_info = nodes[1].node.list_channels()[0].clone();
5890 // The first two nodes (which opened a channel) should now require fresh persistence
5891 assert!(nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
5892 assert!(nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
5893 // ... but the last node should not.
5894 assert!(!nodes[2].node.await_persistable_update_timeout(Duration::from_millis(1)));
5895 // After persisting the first two nodes they should no longer need fresh persistence.
5896 assert!(!nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
5897 assert!(!nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
5899 // Node 3, unrelated to the only channel, shouldn't care if it receives a channel_update
5900 // about the channel.
5901 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.0);
5902 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.1);
5903 assert!(!nodes[2].node.await_persistable_update_timeout(Duration::from_millis(1)));
5905 // The nodes which are a party to the channel should also ignore messages from unrelated
5907 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
5908 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
5909 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
5910 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
5911 assert!(!nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
5912 assert!(!nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
5914 // At this point the channel info given by peers should still be the same.
5915 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
5916 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
5918 // An earlier version of handle_channel_update didn't check the directionality of the
5919 // update message and would always update the local fee info, even if our peer was
5920 // (spuriously) forwarding us our own channel_update.
5921 let as_node_one = nodes[0].node.get_our_node_id().serialize()[..] < nodes[1].node.get_our_node_id().serialize()[..];
5922 let as_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.0 } else { &chan.1 };
5923 let bs_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.1 } else { &chan.0 };
5925 // First deliver each peers' own message, checking that the node doesn't need to be
5926 // persisted and that its channel info remains the same.
5927 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &as_update);
5928 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &bs_update);
5929 assert!(!nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
5930 assert!(!nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
5931 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
5932 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
5934 // Finally, deliver the other peers' message, ensuring each node needs to be persisted and
5935 // the channel info has updated.
5936 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &bs_update);
5937 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &as_update);
5938 assert!(nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
5939 assert!(nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
5940 assert_ne!(nodes[0].node.list_channels()[0], node_a_chan_info);
5941 assert_ne!(nodes[1].node.list_channels()[0], node_b_chan_info);
5945 fn test_keysend_dup_hash_partial_mpp() {
5946 // Test that a keysend payment with a duplicate hash to an existing partial MPP payment fails as
5948 let chanmon_cfgs = create_chanmon_cfgs(2);
5949 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5950 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5951 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5952 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5953 let logger = test_utils::TestLogger::new();
5955 // First, send a partial MPP payment.
5956 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5957 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100_000, TEST_FINAL_CLTV, &logger).unwrap();
5958 let (payment_preimage, our_payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[1]);
5959 let payment_id = PaymentId([42; 32]);
5960 // Use the utility function send_payment_along_path to send the payment with MPP data which
5961 // indicates there are more HTLCs coming.
5962 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.
5963 nodes[0].node.send_payment_along_path(&route.paths[0], &our_payment_hash, &Some(payment_secret), 200_000, cur_height, payment_id, &None).unwrap();
5964 check_added_monitors!(nodes[0], 1);
5965 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5966 assert_eq!(events.len(), 1);
5967 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false, None);
5969 // Next, send a keysend payment with the same payment_hash and make sure it fails.
5970 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage)).unwrap();
5971 check_added_monitors!(nodes[0], 1);
5972 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5973 assert_eq!(events.len(), 1);
5974 let ev = events.drain(..).next().unwrap();
5975 let payment_event = SendEvent::from_event(ev);
5976 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
5977 check_added_monitors!(nodes[1], 0);
5978 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
5979 expect_pending_htlcs_forwardable!(nodes[1]);
5980 expect_pending_htlcs_forwardable!(nodes[1]);
5981 check_added_monitors!(nodes[1], 1);
5982 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5983 assert!(updates.update_add_htlcs.is_empty());
5984 assert!(updates.update_fulfill_htlcs.is_empty());
5985 assert_eq!(updates.update_fail_htlcs.len(), 1);
5986 assert!(updates.update_fail_malformed_htlcs.is_empty());
5987 assert!(updates.update_fee.is_none());
5988 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5989 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
5990 expect_payment_failed!(nodes[0], our_payment_hash, true);
5992 // Send the second half of the original MPP payment.
5993 nodes[0].node.send_payment_along_path(&route.paths[0], &our_payment_hash, &Some(payment_secret), 200_000, cur_height, payment_id, &None).unwrap();
5994 check_added_monitors!(nodes[0], 1);
5995 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5996 assert_eq!(events.len(), 1);
5997 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), true, None);
5999 // Claim the full MPP payment. Note that we can't use a test utility like
6000 // claim_funds_along_route because the ordering of the messages causes the second half of the
6001 // payment to be put in the holding cell, which confuses the test utilities. So we exchange the
6002 // lightning messages manually.
6003 assert!(nodes[1].node.claim_funds(payment_preimage));
6004 check_added_monitors!(nodes[1], 2);
6005 let bs_first_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6006 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_first_updates.update_fulfill_htlcs[0]);
6007 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_first_updates.commitment_signed);
6008 check_added_monitors!(nodes[0], 1);
6009 let (as_first_raa, as_first_cs) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6010 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_first_raa);
6011 check_added_monitors!(nodes[1], 1);
6012 let bs_second_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6013 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_first_cs);
6014 check_added_monitors!(nodes[1], 1);
6015 let bs_first_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
6016 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_second_updates.update_fulfill_htlcs[0]);
6017 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_updates.commitment_signed);
6018 check_added_monitors!(nodes[0], 1);
6019 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
6020 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
6021 let as_second_updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6022 check_added_monitors!(nodes[0], 1);
6023 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
6024 check_added_monitors!(nodes[1], 1);
6025 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_updates.commitment_signed);
6026 check_added_monitors!(nodes[1], 1);
6027 let bs_third_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
6028 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_third_raa);
6029 check_added_monitors!(nodes[0], 1);
6031 // Note that successful MPP payments will generate 1 event upon the first path's success. No
6032 // further events will be generated for subsequence path successes.
6033 let events = nodes[0].node.get_and_clear_pending_events();
6035 Event::PaymentSent { payment_preimage: ref preimage, payment_hash: ref hash } => {
6036 assert_eq!(payment_preimage, *preimage);
6037 assert_eq!(our_payment_hash, *hash);
6039 _ => panic!("Unexpected event"),
6044 fn test_keysend_dup_payment_hash() {
6045 // (1): Test that a keysend payment with a duplicate payment hash to an existing pending
6046 // outbound regular payment fails as expected.
6047 // (2): Test that a regular payment with a duplicate payment hash to an existing keysend payment
6048 // fails as expected.
6049 let chanmon_cfgs = create_chanmon_cfgs(2);
6050 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6051 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6052 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6053 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6054 let logger = test_utils::TestLogger::new();
6056 // To start (1), send a regular payment but don't claim it.
6057 let expected_route = [&nodes[1]];
6058 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &expected_route, 100_000);
6060 // Next, attempt a keysend payment and make sure it fails.
6061 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100_000, TEST_FINAL_CLTV, &logger).unwrap();
6062 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage)).unwrap();
6063 check_added_monitors!(nodes[0], 1);
6064 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6065 assert_eq!(events.len(), 1);
6066 let ev = events.drain(..).next().unwrap();
6067 let payment_event = SendEvent::from_event(ev);
6068 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6069 check_added_monitors!(nodes[1], 0);
6070 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6071 expect_pending_htlcs_forwardable!(nodes[1]);
6072 expect_pending_htlcs_forwardable!(nodes[1]);
6073 check_added_monitors!(nodes[1], 1);
6074 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6075 assert!(updates.update_add_htlcs.is_empty());
6076 assert!(updates.update_fulfill_htlcs.is_empty());
6077 assert_eq!(updates.update_fail_htlcs.len(), 1);
6078 assert!(updates.update_fail_malformed_htlcs.is_empty());
6079 assert!(updates.update_fee.is_none());
6080 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
6081 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
6082 expect_payment_failed!(nodes[0], payment_hash, true);
6084 // Finally, claim the original payment.
6085 claim_payment(&nodes[0], &expected_route, payment_preimage);
6087 // To start (2), send a keysend payment but don't claim it.
6088 let payment_preimage = PaymentPreimage([42; 32]);
6089 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100_000, TEST_FINAL_CLTV, &logger).unwrap();
6090 let (payment_hash, _) = nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage)).unwrap();
6091 check_added_monitors!(nodes[0], 1);
6092 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6093 assert_eq!(events.len(), 1);
6094 let event = events.pop().unwrap();
6095 let path = vec![&nodes[1]];
6096 pass_along_path(&nodes[0], &path, 100_000, payment_hash, None, event, true, Some(payment_preimage));
6098 // Next, attempt a regular payment and make sure it fails.
6099 let payment_secret = PaymentSecret([43; 32]);
6100 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
6101 check_added_monitors!(nodes[0], 1);
6102 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6103 assert_eq!(events.len(), 1);
6104 let ev = events.drain(..).next().unwrap();
6105 let payment_event = SendEvent::from_event(ev);
6106 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6107 check_added_monitors!(nodes[1], 0);
6108 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6109 expect_pending_htlcs_forwardable!(nodes[1]);
6110 expect_pending_htlcs_forwardable!(nodes[1]);
6111 check_added_monitors!(nodes[1], 1);
6112 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6113 assert!(updates.update_add_htlcs.is_empty());
6114 assert!(updates.update_fulfill_htlcs.is_empty());
6115 assert_eq!(updates.update_fail_htlcs.len(), 1);
6116 assert!(updates.update_fail_malformed_htlcs.is_empty());
6117 assert!(updates.update_fee.is_none());
6118 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
6119 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
6120 expect_payment_failed!(nodes[0], payment_hash, true);
6122 // Finally, succeed the keysend payment.
6123 claim_payment(&nodes[0], &expected_route, payment_preimage);
6127 fn test_keysend_hash_mismatch() {
6128 // Test that if we receive a keysend `update_add_htlc` msg, we fail as expected if the keysend
6129 // preimage doesn't match the msg's payment hash.
6130 let chanmon_cfgs = create_chanmon_cfgs(2);
6131 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6132 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6133 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6135 let payer_pubkey = nodes[0].node.get_our_node_id();
6136 let payee_pubkey = nodes[1].node.get_our_node_id();
6137 nodes[0].node.peer_connected(&payee_pubkey, &msgs::Init { features: InitFeatures::known() });
6138 nodes[1].node.peer_connected(&payer_pubkey, &msgs::Init { features: InitFeatures::known() });
6140 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
6141 let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
6142 let first_hops = nodes[0].node.list_usable_channels();
6143 let route = get_keysend_route(&payer_pubkey, network_graph, &payee_pubkey,
6144 Some(&first_hops.iter().collect::<Vec<_>>()), &vec![], 10000, 40,
6145 nodes[0].logger).unwrap();
6147 let test_preimage = PaymentPreimage([42; 32]);
6148 let mismatch_payment_hash = PaymentHash([43; 32]);
6149 let _ = nodes[0].node.send_payment_internal(&route, mismatch_payment_hash, &None, Some(test_preimage), None, None).unwrap();
6150 check_added_monitors!(nodes[0], 1);
6152 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6153 assert_eq!(updates.update_add_htlcs.len(), 1);
6154 assert!(updates.update_fulfill_htlcs.is_empty());
6155 assert!(updates.update_fail_htlcs.is_empty());
6156 assert!(updates.update_fail_malformed_htlcs.is_empty());
6157 assert!(updates.update_fee.is_none());
6158 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6160 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Payment preimage didn't match payment hash".to_string(), 1);
6164 fn test_keysend_msg_with_secret_err() {
6165 // Test that we error as expected if we receive a keysend payment that includes a payment secret.
6166 let chanmon_cfgs = create_chanmon_cfgs(2);
6167 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6168 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6169 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6171 let payer_pubkey = nodes[0].node.get_our_node_id();
6172 let payee_pubkey = nodes[1].node.get_our_node_id();
6173 nodes[0].node.peer_connected(&payee_pubkey, &msgs::Init { features: InitFeatures::known() });
6174 nodes[1].node.peer_connected(&payer_pubkey, &msgs::Init { features: InitFeatures::known() });
6176 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
6177 let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
6178 let first_hops = nodes[0].node.list_usable_channels();
6179 let route = get_keysend_route(&payer_pubkey, network_graph, &payee_pubkey,
6180 Some(&first_hops.iter().collect::<Vec<_>>()), &vec![], 10000, 40,
6181 nodes[0].logger).unwrap();
6183 let test_preimage = PaymentPreimage([42; 32]);
6184 let test_secret = PaymentSecret([43; 32]);
6185 let payment_hash = PaymentHash(Sha256::hash(&test_preimage.0).into_inner());
6186 let _ = nodes[0].node.send_payment_internal(&route, payment_hash, &Some(test_secret), Some(test_preimage), None, None).unwrap();
6187 check_added_monitors!(nodes[0], 1);
6189 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6190 assert_eq!(updates.update_add_htlcs.len(), 1);
6191 assert!(updates.update_fulfill_htlcs.is_empty());
6192 assert!(updates.update_fail_htlcs.is_empty());
6193 assert!(updates.update_fail_malformed_htlcs.is_empty());
6194 assert!(updates.update_fee.is_none());
6195 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6197 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "We don't support MPP keysend payments".to_string(), 1);
6201 fn test_multi_hop_missing_secret() {
6202 let chanmon_cfgs = create_chanmon_cfgs(4);
6203 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
6204 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
6205 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
6207 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
6208 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
6209 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
6210 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
6211 let logger = test_utils::TestLogger::new();
6213 // Marshall an MPP route.
6214 let (_, payment_hash, _) = get_payment_preimage_hash!(&nodes[3]);
6215 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6216 let mut route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[3].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6217 let path = route.paths[0].clone();
6218 route.paths.push(path);
6219 route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
6220 route.paths[0][0].short_channel_id = chan_1_id;
6221 route.paths[0][1].short_channel_id = chan_3_id;
6222 route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
6223 route.paths[1][0].short_channel_id = chan_2_id;
6224 route.paths[1][1].short_channel_id = chan_4_id;
6226 match nodes[0].node.send_payment(&route, payment_hash, &None).unwrap_err() {
6227 PaymentSendFailure::ParameterError(APIError::APIMisuseError { ref err }) => {
6228 assert!(regex::Regex::new(r"Payment secret is required for multi-path payments").unwrap().is_match(err)) },
6229 _ => panic!("unexpected error")
6234 #[cfg(all(any(test, feature = "_test_utils"), feature = "unstable"))]
6237 use chain::chainmonitor::ChainMonitor;
6238 use chain::channelmonitor::Persist;
6239 use chain::keysinterface::{KeysManager, InMemorySigner};
6240 use ln::channelmanager::{BestBlock, ChainParameters, ChannelManager, PaymentHash, PaymentPreimage};
6241 use ln::features::{InitFeatures, InvoiceFeatures};
6242 use ln::functional_test_utils::*;
6243 use ln::msgs::{ChannelMessageHandler, Init};
6244 use routing::network_graph::NetworkGraph;
6245 use routing::router::get_route;
6246 use util::test_utils;
6247 use util::config::UserConfig;
6248 use util::events::{Event, MessageSendEvent, MessageSendEventsProvider, PaymentPurpose};
6250 use bitcoin::hashes::Hash;
6251 use bitcoin::hashes::sha256::Hash as Sha256;
6252 use bitcoin::{Block, BlockHeader, Transaction, TxOut};
6254 use sync::{Arc, Mutex};
6258 struct NodeHolder<'a, P: Persist<InMemorySigner>> {
6259 node: &'a ChannelManager<InMemorySigner,
6260 &'a ChainMonitor<InMemorySigner, &'a test_utils::TestChainSource,
6261 &'a test_utils::TestBroadcaster, &'a test_utils::TestFeeEstimator,
6262 &'a test_utils::TestLogger, &'a P>,
6263 &'a test_utils::TestBroadcaster, &'a KeysManager,
6264 &'a test_utils::TestFeeEstimator, &'a test_utils::TestLogger>
6269 fn bench_sends(bench: &mut Bencher) {
6270 bench_two_sends(bench, test_utils::TestPersister::new(), test_utils::TestPersister::new());
6273 pub fn bench_two_sends<P: Persist<InMemorySigner>>(bench: &mut Bencher, persister_a: P, persister_b: P) {
6274 // Do a simple benchmark of sending a payment back and forth between two nodes.
6275 // Note that this is unrealistic as each payment send will require at least two fsync
6277 let network = bitcoin::Network::Testnet;
6278 let genesis_hash = bitcoin::blockdata::constants::genesis_block(network).header.block_hash();
6280 let tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), blocks: Arc::new(Mutex::new(Vec::new()))};
6281 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
6283 let mut config: UserConfig = Default::default();
6284 config.own_channel_config.minimum_depth = 1;
6286 let logger_a = test_utils::TestLogger::with_id("node a".to_owned());
6287 let chain_monitor_a = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_a);
6288 let seed_a = [1u8; 32];
6289 let keys_manager_a = KeysManager::new(&seed_a, 42, 42);
6290 let node_a = ChannelManager::new(&fee_estimator, &chain_monitor_a, &tx_broadcaster, &logger_a, &keys_manager_a, config.clone(), ChainParameters {
6292 best_block: BestBlock::from_genesis(network),
6294 let node_a_holder = NodeHolder { node: &node_a };
6296 let logger_b = test_utils::TestLogger::with_id("node a".to_owned());
6297 let chain_monitor_b = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_b);
6298 let seed_b = [2u8; 32];
6299 let keys_manager_b = KeysManager::new(&seed_b, 42, 42);
6300 let node_b = ChannelManager::new(&fee_estimator, &chain_monitor_b, &tx_broadcaster, &logger_b, &keys_manager_b, config.clone(), ChainParameters {
6302 best_block: BestBlock::from_genesis(network),
6304 let node_b_holder = NodeHolder { node: &node_b };
6306 node_a.peer_connected(&node_b.get_our_node_id(), &Init { features: InitFeatures::known() });
6307 node_b.peer_connected(&node_a.get_our_node_id(), &Init { features: InitFeatures::known() });
6308 node_a.create_channel(node_b.get_our_node_id(), 8_000_000, 100_000_000, 42, None).unwrap();
6309 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()));
6310 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()));
6313 if let Event::FundingGenerationReady { temporary_channel_id, output_script, .. } = get_event!(node_a_holder, Event::FundingGenerationReady) {
6314 tx = Transaction { version: 2, lock_time: 0, input: Vec::new(), output: vec![TxOut {
6315 value: 8_000_000, script_pubkey: output_script,
6317 node_a.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
6318 } else { panic!(); }
6320 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()));
6321 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()));
6323 assert_eq!(&tx_broadcaster.txn_broadcasted.lock().unwrap()[..], &[tx.clone()]);
6326 header: BlockHeader { version: 0x20000000, prev_blockhash: genesis_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
6329 Listen::block_connected(&node_a, &block, 1);
6330 Listen::block_connected(&node_b, &block, 1);
6332 node_a.handle_funding_locked(&node_b.get_our_node_id(), &get_event_msg!(node_b_holder, MessageSendEvent::SendFundingLocked, node_a.get_our_node_id()));
6333 let msg_events = node_a.get_and_clear_pending_msg_events();
6334 assert_eq!(msg_events.len(), 2);
6335 match msg_events[0] {
6336 MessageSendEvent::SendFundingLocked { ref msg, .. } => {
6337 node_b.handle_funding_locked(&node_a.get_our_node_id(), msg);
6338 get_event_msg!(node_b_holder, MessageSendEvent::SendChannelUpdate, node_a.get_our_node_id());
6342 match msg_events[1] {
6343 MessageSendEvent::SendChannelUpdate { .. } => {},
6347 let dummy_graph = NetworkGraph::new(genesis_hash);
6349 let mut payment_count: u64 = 0;
6350 macro_rules! send_payment {
6351 ($node_a: expr, $node_b: expr) => {
6352 let usable_channels = $node_a.list_usable_channels();
6353 let route = get_route(&$node_a.get_our_node_id(), &dummy_graph, &$node_b.get_our_node_id(), Some(InvoiceFeatures::known()),
6354 Some(&usable_channels.iter().map(|r| r).collect::<Vec<_>>()), &[], 10_000, TEST_FINAL_CLTV, &logger_a).unwrap();
6356 let mut payment_preimage = PaymentPreimage([0; 32]);
6357 payment_preimage.0[0..8].copy_from_slice(&payment_count.to_le_bytes());
6359 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
6360 let payment_secret = $node_b.create_inbound_payment_for_hash(payment_hash, None, 7200, 0).unwrap();
6362 $node_a.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
6363 let payment_event = SendEvent::from_event($node_a.get_and_clear_pending_msg_events().pop().unwrap());
6364 $node_b.handle_update_add_htlc(&$node_a.get_our_node_id(), &payment_event.msgs[0]);
6365 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &payment_event.commitment_msg);
6366 let (raa, cs) = get_revoke_commit_msgs!(NodeHolder { node: &$node_b }, $node_a.get_our_node_id());
6367 $node_a.handle_revoke_and_ack(&$node_b.get_our_node_id(), &raa);
6368 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &cs);
6369 $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()));
6371 expect_pending_htlcs_forwardable!(NodeHolder { node: &$node_b });
6372 expect_payment_received!(NodeHolder { node: &$node_b }, payment_hash, payment_secret, 10_000);
6373 assert!($node_b.claim_funds(payment_preimage));
6375 match $node_b.get_and_clear_pending_msg_events().pop().unwrap() {
6376 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
6377 assert_eq!(node_id, $node_a.get_our_node_id());
6378 $node_a.handle_update_fulfill_htlc(&$node_b.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
6379 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &updates.commitment_signed);
6381 _ => panic!("Failed to generate claim event"),
6384 let (raa, cs) = get_revoke_commit_msgs!(NodeHolder { node: &$node_a }, $node_b.get_our_node_id());
6385 $node_b.handle_revoke_and_ack(&$node_a.get_our_node_id(), &raa);
6386 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &cs);
6387 $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()));
6389 expect_payment_sent!(NodeHolder { node: &$node_a }, payment_preimage);
6394 send_payment!(node_a, node_b);
6395 send_payment!(node_b, node_a);