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, 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 pub use ln::channel::CounterpartyForwardingInfo;
47 use ln::channel::{Channel, ChannelError, ChannelUpdateStatus, UpdateFulfillCommitFetch};
48 use ln::features::{InitFeatures, NodeFeatures};
49 use routing::router::{Route, RouteHop};
51 use ln::msgs::NetAddress;
53 use ln::msgs::{ChannelMessageHandler, DecodeError, LightningError, OptionalField};
54 use chain::keysinterface::{Sign, KeysInterface, KeysManager, InMemorySigner};
55 use util::config::UserConfig;
56 use util::events::{EventHandler, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
57 use util::{byte_utils, events};
58 use util::ser::{Readable, ReadableArgs, MaybeReadable, Writeable, Writer};
59 use util::chacha20::{ChaCha20, ChaChaReader};
60 use util::logger::{Logger, Level};
61 use util::errors::APIError;
65 use core::cell::RefCell;
66 use std::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;
73 use bitcoin::hashes::hex::ToHex;
75 // We hold various information about HTLC relay in the HTLC objects in Channel itself:
77 // Upon receipt of an HTLC from a peer, we'll give it a PendingHTLCStatus indicating if it should
78 // forward the HTLC with information it will give back to us when it does so, or if it should Fail
79 // the HTLC with the relevant message for the Channel to handle giving to the remote peer.
81 // Once said HTLC is committed in the Channel, if the PendingHTLCStatus indicated Forward, the
82 // Channel will return the PendingHTLCInfo back to us, and we will create an HTLCForwardInfo
83 // with it to track where it came from (in case of onwards-forward error), waiting a random delay
84 // before we forward it.
86 // We will then use HTLCForwardInfo's PendingHTLCInfo to construct an outbound HTLC, with a
87 // relevant HTLCSource::PreviousHopData filled in to indicate where it came from (which we can use
88 // to either fail-backwards or fulfill the HTLC backwards along the relevant path).
89 // Alternatively, we can fill an outbound HTLC with a HTLCSource::OutboundRoute indicating this is
90 // our payment, which we can use to decode errors or inform the user that the payment was sent.
92 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
93 enum PendingHTLCRouting {
95 onion_packet: msgs::OnionPacket,
96 short_channel_id: u64, // This should be NonZero<u64> eventually when we bump MSRV
99 payment_data: msgs::FinalOnionHopData,
100 incoming_cltv_expiry: u32, // Used to track when we should expire pending HTLCs that go unclaimed
103 payment_preimage: PaymentPreimage,
104 incoming_cltv_expiry: u32, // Used to track when we should expire pending HTLCs that go unclaimed
108 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
109 pub(super) struct PendingHTLCInfo {
110 routing: PendingHTLCRouting,
111 incoming_shared_secret: [u8; 32],
112 payment_hash: PaymentHash,
113 pub(super) amt_to_forward: u64,
114 pub(super) outgoing_cltv_value: u32,
117 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
118 pub(super) enum HTLCFailureMsg {
119 Relay(msgs::UpdateFailHTLC),
120 Malformed(msgs::UpdateFailMalformedHTLC),
123 /// Stores whether we can't forward an HTLC or relevant forwarding info
124 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
125 pub(super) enum PendingHTLCStatus {
126 Forward(PendingHTLCInfo),
127 Fail(HTLCFailureMsg),
130 pub(super) enum HTLCForwardInfo {
132 forward_info: PendingHTLCInfo,
134 // These fields are produced in `forward_htlcs()` and consumed in
135 // `process_pending_htlc_forwards()` for constructing the
136 // `HTLCSource::PreviousHopData` for failed and forwarded
138 prev_short_channel_id: u64,
140 prev_funding_outpoint: OutPoint,
144 err_packet: msgs::OnionErrorPacket,
148 /// Tracks the inbound corresponding to an outbound HTLC
149 #[derive(Clone, PartialEq)]
150 pub(crate) struct HTLCPreviousHopData {
151 short_channel_id: u64,
153 incoming_packet_shared_secret: [u8; 32],
155 // This field is consumed by `claim_funds_from_hop()` when updating a force-closed backwards
156 // channel with a preimage provided by the forward channel.
161 /// Contains a total_msat (which may differ from value if this is a Multi-Path Payment) and a
162 /// payment_secret which prevents path-probing attacks and can associate different HTLCs which
163 /// are part of the same payment.
164 Invoice(msgs::FinalOnionHopData),
165 /// Contains the payer-provided preimage.
166 Spontaneous(PaymentPreimage),
169 struct ClaimableHTLC {
170 prev_hop: HTLCPreviousHopData,
173 onion_payload: OnionPayload,
176 /// Tracks the inbound corresponding to an outbound HTLC
177 #[derive(Clone, PartialEq)]
178 pub(crate) enum HTLCSource {
179 PreviousHopData(HTLCPreviousHopData),
182 session_priv: SecretKey,
183 /// Technically we can recalculate this from the route, but we cache it here to avoid
184 /// doing a double-pass on route when we get a failure back
185 first_hop_htlc_msat: u64,
190 pub fn dummy() -> Self {
191 HTLCSource::OutboundRoute {
193 session_priv: SecretKey::from_slice(&[1; 32]).unwrap(),
194 first_hop_htlc_msat: 0,
199 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
200 pub(super) enum HTLCFailReason {
202 err: msgs::OnionErrorPacket,
210 type ShutdownResult = (Option<(OutPoint, ChannelMonitorUpdate)>, Vec<(HTLCSource, PaymentHash)>);
212 /// Error type returned across the channel_state mutex boundary. When an Err is generated for a
213 /// Channel, we generally end up with a ChannelError::Close for which we have to close the channel
214 /// immediately (ie with no further calls on it made). Thus, this step happens inside a
215 /// channel_state lock. We then return the set of things that need to be done outside the lock in
216 /// this struct and call handle_error!() on it.
218 struct MsgHandleErrInternal {
219 err: msgs::LightningError,
220 shutdown_finish: Option<(ShutdownResult, Option<msgs::ChannelUpdate>)>,
222 impl MsgHandleErrInternal {
224 fn send_err_msg_no_close(err: String, channel_id: [u8; 32]) -> Self {
226 err: LightningError {
228 action: msgs::ErrorAction::SendErrorMessage {
229 msg: msgs::ErrorMessage {
235 shutdown_finish: None,
239 fn ignore_no_close(err: String) -> Self {
241 err: LightningError {
243 action: msgs::ErrorAction::IgnoreError,
245 shutdown_finish: None,
249 fn from_no_close(err: msgs::LightningError) -> Self {
250 Self { err, shutdown_finish: None }
253 fn from_finish_shutdown(err: String, channel_id: [u8; 32], shutdown_res: ShutdownResult, channel_update: Option<msgs::ChannelUpdate>) -> Self {
255 err: LightningError {
257 action: msgs::ErrorAction::SendErrorMessage {
258 msg: msgs::ErrorMessage {
264 shutdown_finish: Some((shutdown_res, channel_update)),
268 fn from_chan_no_close(err: ChannelError, channel_id: [u8; 32]) -> Self {
271 ChannelError::Ignore(msg) => LightningError {
273 action: msgs::ErrorAction::IgnoreError,
275 ChannelError::Close(msg) => LightningError {
277 action: msgs::ErrorAction::SendErrorMessage {
278 msg: msgs::ErrorMessage {
284 ChannelError::CloseDelayBroadcast(msg) => LightningError {
286 action: msgs::ErrorAction::SendErrorMessage {
287 msg: msgs::ErrorMessage {
294 shutdown_finish: None,
299 /// We hold back HTLCs we intend to relay for a random interval greater than this (see
300 /// Event::PendingHTLCsForwardable for the API guidelines indicating how long should be waited).
301 /// This provides some limited amount of privacy. Ideally this would range from somewhere like one
302 /// second to 30 seconds, but people expect lightning to be, you know, kinda fast, sadly.
303 const MIN_HTLC_RELAY_HOLDING_CELL_MILLIS: u64 = 100;
305 /// For events which result in both a RevokeAndACK and a CommitmentUpdate, by default they should
306 /// be sent in the order they appear in the return value, however sometimes the order needs to be
307 /// variable at runtime (eg Channel::channel_reestablish needs to re-send messages in the order
308 /// they were originally sent). In those cases, this enum is also returned.
309 #[derive(Clone, PartialEq)]
310 pub(super) enum RAACommitmentOrder {
311 /// Send the CommitmentUpdate messages first
313 /// Send the RevokeAndACK message first
317 // Note this is only exposed in cfg(test):
318 pub(super) struct ChannelHolder<Signer: Sign> {
319 pub(super) by_id: HashMap<[u8; 32], Channel<Signer>>,
320 pub(super) short_to_id: HashMap<u64, [u8; 32]>,
321 /// short channel id -> forward infos. Key of 0 means payments received
322 /// Note that while this is held in the same mutex as the channels themselves, no consistency
323 /// guarantees are made about the existence of a channel with the short id here, nor the short
324 /// ids in the PendingHTLCInfo!
325 pub(super) forward_htlcs: HashMap<u64, Vec<HTLCForwardInfo>>,
326 /// Map from payment hash to any HTLCs which are to us and can be failed/claimed by the user.
327 /// Note that while this is held in the same mutex as the channels themselves, no consistency
328 /// guarantees are made about the channels given here actually existing anymore by the time you
330 claimable_htlcs: HashMap<PaymentHash, Vec<ClaimableHTLC>>,
331 /// Messages to send to peers - pushed to in the same lock that they are generated in (except
332 /// for broadcast messages, where ordering isn't as strict).
333 pub(super) pending_msg_events: Vec<MessageSendEvent>,
336 /// Events which we process internally but cannot be procsesed immediately at the generation site
337 /// for some reason. They are handled in timer_tick_occurred, so may be processed with
338 /// quite some time lag.
339 enum BackgroundEvent {
340 /// Handle a ChannelMonitorUpdate that closes a channel, broadcasting its current latest holder
341 /// commitment transaction.
342 ClosingMonitorUpdate((OutPoint, ChannelMonitorUpdate)),
345 /// State we hold per-peer. In the future we should put channels in here, but for now we only hold
346 /// the latest Init features we heard from the peer.
348 latest_features: InitFeatures,
351 /// Stores a PaymentSecret and any other data we may need to validate an inbound payment is
352 /// actually ours and not some duplicate HTLC sent to us by a node along the route.
354 /// For users who don't want to bother doing their own payment preimage storage, we also store that
356 struct PendingInboundPayment {
357 /// The payment secret that the sender must use for us to accept this payment
358 payment_secret: PaymentSecret,
359 /// Time at which this HTLC expires - blocks with a header time above this value will result in
360 /// this payment being removed.
362 /// Arbitrary identifier the user specifies (or not)
363 user_payment_id: u64,
364 // Other required attributes of the payment, optionally enforced:
365 payment_preimage: Option<PaymentPreimage>,
366 min_value_msat: Option<u64>,
369 /// SimpleArcChannelManager is useful when you need a ChannelManager with a static lifetime, e.g.
370 /// when you're using lightning-net-tokio (since tokio::spawn requires parameters with static
371 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
372 /// SimpleRefChannelManager is the more appropriate type. Defining these type aliases prevents
373 /// issues such as overly long function definitions. Note that the ChannelManager can take any
374 /// type that implements KeysInterface for its keys manager, but this type alias chooses the
375 /// concrete type of the KeysManager.
376 pub type SimpleArcChannelManager<M, T, F, L> = ChannelManager<InMemorySigner, Arc<M>, Arc<T>, Arc<KeysManager>, Arc<F>, Arc<L>>;
378 /// SimpleRefChannelManager is a type alias for a ChannelManager reference, and is the reference
379 /// counterpart to the SimpleArcChannelManager type alias. Use this type by default when you don't
380 /// need a ChannelManager with a static lifetime. You'll need a static lifetime in cases such as
381 /// usage of lightning-net-tokio (since tokio::spawn requires parameters with static lifetimes).
382 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
383 /// helps with issues such as long function definitions. Note that the ChannelManager can take any
384 /// type that implements KeysInterface for its keys manager, but this type alias chooses the
385 /// concrete type of the KeysManager.
386 pub type SimpleRefChannelManager<'a, 'b, 'c, 'd, 'e, M, T, F, L> = ChannelManager<InMemorySigner, &'a M, &'b T, &'c KeysManager, &'d F, &'e L>;
388 /// Manager which keeps track of a number of channels and sends messages to the appropriate
389 /// channel, also tracking HTLC preimages and forwarding onion packets appropriately.
391 /// Implements ChannelMessageHandler, handling the multi-channel parts and passing things through
392 /// to individual Channels.
394 /// Implements Writeable to write out all channel state to disk. Implies peer_disconnected() for
395 /// all peers during write/read (though does not modify this instance, only the instance being
396 /// serialized). This will result in any channels which have not yet exchanged funding_created (ie
397 /// called funding_transaction_generated for outbound channels).
399 /// Note that you can be a bit lazier about writing out ChannelManager than you can be with
400 /// ChannelMonitors. With ChannelMonitors you MUST write each monitor update out to disk before
401 /// returning from chain::Watch::watch_/update_channel, with ChannelManagers, writing updates
402 /// happens out-of-band (and will prevent any other ChannelManager operations from occurring during
403 /// the serialization process). If the deserialized version is out-of-date compared to the
404 /// ChannelMonitors passed by reference to read(), those channels will be force-closed based on the
405 /// ChannelMonitor state and no funds will be lost (mod on-chain transaction fees).
407 /// Note that the deserializer is only implemented for (BlockHash, ChannelManager), which
408 /// tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
409 /// the "reorg path" (ie call block_disconnected() until you get to a common block and then call
410 /// block_connected() to step towards your best block) upon deserialization before using the
413 /// Note that ChannelManager is responsible for tracking liveness of its channels and generating
414 /// ChannelUpdate messages informing peers that the channel is temporarily disabled. To avoid
415 /// spam due to quick disconnection/reconnection, updates are not sent until the channel has been
416 /// offline for a full minute. In order to track this, you must call
417 /// timer_tick_occurred roughly once per minute, though it doesn't have to be perfect.
419 /// Rather than using a plain ChannelManager, it is preferable to use either a SimpleArcChannelManager
420 /// a SimpleRefChannelManager, for conciseness. See their documentation for more details, but
421 /// essentially you should default to using a SimpleRefChannelManager, and use a
422 /// SimpleArcChannelManager when you require a ChannelManager with a static lifetime, such as when
423 /// you're using lightning-net-tokio.
424 pub struct ChannelManager<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
425 where M::Target: chain::Watch<Signer>,
426 T::Target: BroadcasterInterface,
427 K::Target: KeysInterface<Signer = Signer>,
428 F::Target: FeeEstimator,
431 default_configuration: UserConfig,
432 genesis_hash: BlockHash,
438 pub(super) best_block: RwLock<BestBlock>,
440 best_block: RwLock<BestBlock>,
441 secp_ctx: Secp256k1<secp256k1::All>,
443 #[cfg(any(test, feature = "_test_utils"))]
444 pub(super) channel_state: Mutex<ChannelHolder<Signer>>,
445 #[cfg(not(any(test, feature = "_test_utils")))]
446 channel_state: Mutex<ChannelHolder<Signer>>,
448 /// Storage for PaymentSecrets and any requirements on future inbound payments before we will
449 /// expose them to users via a PaymentReceived event. HTLCs which do not meet the requirements
450 /// here are failed when we process them as pending-forwardable-HTLCs, and entries are removed
451 /// after we generate a PaymentReceived upon receipt of all MPP parts or when they time out.
452 /// Locked *after* channel_state.
453 pending_inbound_payments: Mutex<HashMap<PaymentHash, PendingInboundPayment>>,
455 /// The session_priv bytes of outbound payments which are pending resolution.
456 /// The authoritative state of these HTLCs resides either within Channels or ChannelMonitors
457 /// (if the channel has been force-closed), however we track them here to prevent duplicative
458 /// PaymentSent/PaymentFailed events. Specifically, in the case of a duplicative
459 /// update_fulfill_htlc message after a reconnect, we may "claim" a payment twice.
460 /// Additionally, because ChannelMonitors are often not re-serialized after connecting block(s)
461 /// which may generate a claim event, we may receive similar duplicate claim/fail MonitorEvents
462 /// after reloading from disk while replaying blocks against ChannelMonitors.
464 /// Locked *after* channel_state.
465 pending_outbound_payments: Mutex<HashSet<[u8; 32]>>,
467 our_network_key: SecretKey,
468 our_network_pubkey: PublicKey,
470 /// Used to track the last value sent in a node_announcement "timestamp" field. We ensure this
471 /// value increases strictly since we don't assume access to a time source.
472 last_node_announcement_serial: AtomicUsize,
474 /// The highest block timestamp we've seen, which is usually a good guess at the current time.
475 /// Assuming most miners are generating blocks with reasonable timestamps, this shouldn't be
476 /// very far in the past, and can only ever be up to two hours in the future.
477 highest_seen_timestamp: AtomicUsize,
479 /// The bulk of our storage will eventually be here (channels and message queues and the like).
480 /// If we are connected to a peer we always at least have an entry here, even if no channels
481 /// are currently open with that peer.
482 /// Because adding or removing an entry is rare, we usually take an outer read lock and then
483 /// operate on the inner value freely. Sadly, this prevents parallel operation when opening a
485 per_peer_state: RwLock<HashMap<PublicKey, Mutex<PeerState>>>,
487 pending_events: Mutex<Vec<events::Event>>,
488 pending_background_events: Mutex<Vec<BackgroundEvent>>,
489 /// Used when we have to take a BIG lock to make sure everything is self-consistent.
490 /// Essentially just when we're serializing ourselves out.
491 /// Taken first everywhere where we are making changes before any other locks.
492 /// When acquiring this lock in read mode, rather than acquiring it directly, call
493 /// `PersistenceNotifierGuard::notify_on_drop(..)` and pass the lock to it, to ensure the
494 /// PersistenceNotifier the lock contains sends out a notification when the lock is released.
495 total_consistency_lock: RwLock<()>,
497 persistence_notifier: PersistenceNotifier,
504 /// Chain-related parameters used to construct a new `ChannelManager`.
506 /// Typically, the block-specific parameters are derived from the best block hash for the network,
507 /// as a newly constructed `ChannelManager` will not have created any channels yet. These parameters
508 /// are not needed when deserializing a previously constructed `ChannelManager`.
509 #[derive(Clone, Copy, PartialEq)]
510 pub struct ChainParameters {
511 /// The network for determining the `chain_hash` in Lightning messages.
512 pub network: Network,
514 /// The hash and height of the latest block successfully connected.
516 /// Used to track on-chain channel funding outputs and send payments with reliable timelocks.
517 pub best_block: BestBlock,
520 #[derive(Copy, Clone, PartialEq)]
526 /// Whenever we release the `ChannelManager`'s `total_consistency_lock`, from read mode, it is
527 /// desirable to notify any listeners on `await_persistable_update_timeout`/
528 /// `await_persistable_update` when new updates are available for persistence. Therefore, this
529 /// struct is responsible for locking the total consistency lock and, upon going out of scope,
530 /// sending the aforementioned notification (since the lock being released indicates that the
531 /// updates are ready for persistence).
533 /// We allow callers to either always notify by constructing with `notify_on_drop` or choose to
534 /// notify or not based on whether relevant changes have been made, providing a closure to
535 /// `optionally_notify` which returns a `NotifyOption`.
536 struct PersistenceNotifierGuard<'a, F: Fn() -> NotifyOption> {
537 persistence_notifier: &'a PersistenceNotifier,
539 // We hold onto this result so the lock doesn't get released immediately.
540 _read_guard: RwLockReadGuard<'a, ()>,
543 impl<'a> PersistenceNotifierGuard<'a, fn() -> NotifyOption> { // We don't care what the concrete F is here, it's unused
544 fn notify_on_drop(lock: &'a RwLock<()>, notifier: &'a PersistenceNotifier) -> PersistenceNotifierGuard<'a, impl Fn() -> NotifyOption> {
545 PersistenceNotifierGuard::optionally_notify(lock, notifier, || -> NotifyOption { NotifyOption::DoPersist })
548 fn optionally_notify<F: Fn() -> NotifyOption>(lock: &'a RwLock<()>, notifier: &'a PersistenceNotifier, persist_check: F) -> PersistenceNotifierGuard<'a, F> {
549 let read_guard = lock.read().unwrap();
551 PersistenceNotifierGuard {
552 persistence_notifier: notifier,
553 should_persist: persist_check,
554 _read_guard: read_guard,
559 impl<'a, F: Fn() -> NotifyOption> Drop for PersistenceNotifierGuard<'a, F> {
561 if (self.should_persist)() == NotifyOption::DoPersist {
562 self.persistence_notifier.notify();
567 /// The amount of time in blocks we require our counterparty wait to claim their money (ie time
568 /// between when we, or our watchtower, must check for them having broadcast a theft transaction).
570 /// This can be increased (but not decreased) through [`ChannelHandshakeConfig::our_to_self_delay`]
572 /// [`ChannelHandshakeConfig::our_to_self_delay`]: crate::util::config::ChannelHandshakeConfig::our_to_self_delay
573 pub const BREAKDOWN_TIMEOUT: u16 = 6 * 24;
574 /// The amount of time in blocks we're willing to wait to claim money back to us. This matches
575 /// the maximum required amount in lnd as of March 2021.
576 pub(crate) const MAX_LOCAL_BREAKDOWN_TIMEOUT: u16 = 2 * 6 * 24 * 7;
578 /// The minimum number of blocks between an inbound HTLC's CLTV and the corresponding outbound
579 /// HTLC's CLTV. The current default represents roughly seven hours of blocks at six blocks/hour.
581 /// This can be increased (but not decreased) through [`ChannelConfig::cltv_expiry_delta`]
583 /// [`ChannelConfig::cltv_expiry_delta`]: crate::util::config::ChannelConfig::cltv_expiry_delta
584 // This should always be a few blocks greater than channelmonitor::CLTV_CLAIM_BUFFER,
585 // i.e. the node we forwarded the payment on to should always have enough room to reliably time out
586 // the HTLC via a full update_fail_htlc/commitment_signed dance before we hit the
587 // CLTV_CLAIM_BUFFER point (we static assert that it's at least 3 blocks more).
588 pub const MIN_CLTV_EXPIRY_DELTA: u16 = 6*7;
589 pub(super) const CLTV_FAR_FAR_AWAY: u32 = 6 * 24 * 7; //TODO?
591 /// Minimum CLTV difference between the current block height and received inbound payments.
592 /// Invoices generated for payment to us must set their `min_final_cltv_expiry` field to at least
594 // Note that we fail if exactly HTLC_FAIL_BACK_BUFFER + 1 was used, so we need to add one for
595 // any payments to succeed. Further, we don't want payments to fail if a block was found while
596 // a payment was being routed, so we add an extra block to be safe.
597 pub const MIN_FINAL_CLTV_EXPIRY: u32 = HTLC_FAIL_BACK_BUFFER + 3;
599 // Check that our CLTV_EXPIRY is at least CLTV_CLAIM_BUFFER + ANTI_REORG_DELAY + LATENCY_GRACE_PERIOD_BLOCKS,
600 // ie that if the next-hop peer fails the HTLC within
601 // LATENCY_GRACE_PERIOD_BLOCKS then we'll still have CLTV_CLAIM_BUFFER left to timeout it onchain,
602 // then waiting ANTI_REORG_DELAY to be reorg-safe on the outbound HLTC and
603 // failing the corresponding htlc backward, and us now seeing the last block of ANTI_REORG_DELAY before
604 // LATENCY_GRACE_PERIOD_BLOCKS.
607 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;
609 // Check for ability of an attacker to make us fail on-chain by delaying an HTLC claim. See
610 // ChannelMonitor::should_broadcast_holder_commitment_txn for a description of why this is needed.
613 const CHECK_CLTV_EXPIRY_SANITY_2: u32 = MIN_CLTV_EXPIRY_DELTA as u32 - LATENCY_GRACE_PERIOD_BLOCKS - 2*CLTV_CLAIM_BUFFER;
615 /// Channel parameters which apply to our counterparty. These are split out from [`ChannelDetails`]
616 /// to better separate parameters.
617 #[derive(Clone, Debug, PartialEq)]
618 pub struct ChannelCounterparty {
619 /// The node_id of our counterparty
620 pub node_id: PublicKey,
621 /// The Features the channel counterparty provided upon last connection.
622 /// Useful for routing as it is the most up-to-date copy of the counterparty's features and
623 /// many routing-relevant features are present in the init context.
624 pub features: InitFeatures,
625 /// The value, in satoshis, that must always be held in the channel for our counterparty. This
626 /// value ensures that if our counterparty broadcasts a revoked state, we can punish them by
627 /// claiming at least this value on chain.
629 /// This value is not included in [`inbound_capacity_msat`] as it can never be spent.
631 /// [`inbound_capacity_msat`]: ChannelDetails::inbound_capacity_msat
632 pub unspendable_punishment_reserve: u64,
633 /// Information on the fees and requirements that the counterparty requires when forwarding
634 /// payments to us through this channel.
635 pub forwarding_info: Option<CounterpartyForwardingInfo>,
638 /// Details of a channel, as returned by ChannelManager::list_channels and ChannelManager::list_usable_channels
639 #[derive(Clone, Debug, PartialEq)]
640 pub struct ChannelDetails {
641 /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
642 /// thereafter this is the txid of the funding transaction xor the funding transaction output).
643 /// Note that this means this value is *not* persistent - it can change once during the
644 /// lifetime of the channel.
645 pub channel_id: [u8; 32],
646 /// Parameters which apply to our counterparty. See individual fields for more information.
647 pub counterparty: ChannelCounterparty,
648 /// The Channel's funding transaction output, if we've negotiated the funding transaction with
649 /// our counterparty already.
651 /// Note that, if this has been set, `channel_id` will be equivalent to
652 /// `funding_txo.unwrap().to_channel_id()`.
653 pub funding_txo: Option<OutPoint>,
654 /// The position of the funding transaction in the chain. None if the funding transaction has
655 /// not yet been confirmed and the channel fully opened.
656 pub short_channel_id: Option<u64>,
657 /// The value, in satoshis, of this channel as appears in the funding output
658 pub channel_value_satoshis: u64,
659 /// The value, in satoshis, that must always be held in the channel for us. This value ensures
660 /// that if we broadcast a revoked state, our counterparty can punish us by claiming at least
661 /// this value on chain.
663 /// This value is not included in [`outbound_capacity_msat`] as it can never be spent.
665 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
667 /// [`outbound_capacity_msat`]: ChannelDetails::outbound_capacity_msat
668 pub unspendable_punishment_reserve: Option<u64>,
669 /// The user_id passed in to create_channel, or 0 if the channel was inbound.
671 /// The available outbound capacity for sending HTLCs to the remote peer. This does not include
672 /// any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
673 /// available for inclusion in new outbound HTLCs). This further does not include any pending
674 /// outgoing HTLCs which are awaiting some other resolution to be sent.
676 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
677 /// conflict-avoidance policy, exactly this amount is not likely to be spendable. However, we
678 /// should be able to spend nearly this amount.
679 pub outbound_capacity_msat: u64,
680 /// The available inbound capacity for the remote peer to send HTLCs to us. This does not
681 /// include any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
682 /// available for inclusion in new inbound HTLCs).
683 /// Note that there are some corner cases not fully handled here, so the actual available
684 /// inbound capacity may be slightly higher than this.
686 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
687 /// counterparty's conflict-avoidance policy, exactly this amount is not likely to be spendable.
688 /// However, our counterparty should be able to spend nearly this amount.
689 pub inbound_capacity_msat: u64,
690 /// The number of required confirmations on the funding transaction before the funding will be
691 /// considered "locked". This number is selected by the channel fundee (i.e. us if
692 /// [`is_outbound`] is *not* set), and can be selected for inbound channels with
693 /// [`ChannelHandshakeConfig::minimum_depth`] or limited for outbound channels with
694 /// [`ChannelHandshakeLimits::max_minimum_depth`].
696 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
698 /// [`is_outbound`]: ChannelDetails::is_outbound
699 /// [`ChannelHandshakeConfig::minimum_depth`]: crate::util::config::ChannelHandshakeConfig::minimum_depth
700 /// [`ChannelHandshakeLimits::max_minimum_depth`]: crate::util::config::ChannelHandshakeLimits::max_minimum_depth
701 pub confirmations_required: Option<u32>,
702 /// The number of blocks (after our commitment transaction confirms) that we will need to wait
703 /// until we can claim our funds after we force-close the channel. During this time our
704 /// counterparty is allowed to punish us if we broadcasted a stale state. If our counterparty
705 /// force-closes the channel and broadcasts a commitment transaction we do not have to wait any
706 /// time to claim our non-HTLC-encumbered funds.
708 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
709 pub force_close_spend_delay: Option<u16>,
710 /// True if the channel was initiated (and thus funded) by us.
711 pub is_outbound: bool,
712 /// True if the channel is confirmed, funding_locked messages have been exchanged, and the
713 /// channel is not currently being shut down. `funding_locked` message exchange implies the
714 /// required confirmation count has been reached (and we were connected to the peer at some
715 /// point after the funding transaction received enough confirmations). The required
716 /// confirmation count is provided in [`confirmations_required`].
718 /// [`confirmations_required`]: ChannelDetails::confirmations_required
719 pub is_funding_locked: bool,
720 /// True if the channel is (a) confirmed and funding_locked messages have been exchanged, (b)
721 /// the peer is connected, and (c) the channel is not currently negotiating a shutdown.
723 /// This is a strict superset of `is_funding_locked`.
725 /// True if this channel is (or will be) publicly-announced.
729 /// If a payment fails to send, it can be in one of several states. This enum is returned as the
730 /// Err() type describing which state the payment is in, see the description of individual enum
732 #[derive(Clone, Debug)]
733 pub enum PaymentSendFailure {
734 /// A parameter which was passed to send_payment was invalid, preventing us from attempting to
735 /// send the payment at all. No channel state has been changed or messages sent to peers, and
736 /// once you've changed the parameter at error, you can freely retry the payment in full.
737 ParameterError(APIError),
738 /// A parameter in a single path which was passed to send_payment was invalid, preventing us
739 /// from attempting to send the payment at all. No channel state has been changed or messages
740 /// sent to peers, and once you've changed the parameter at error, you can freely retry the
743 /// The results here are ordered the same as the paths in the route object which was passed to
745 PathParameterError(Vec<Result<(), APIError>>),
746 /// All paths which were attempted failed to send, with no channel state change taking place.
747 /// You can freely retry the payment in full (though you probably want to do so over different
748 /// paths than the ones selected).
749 AllFailedRetrySafe(Vec<APIError>),
750 /// Some paths which were attempted failed to send, though possibly not all. At least some
751 /// paths have irrevocably committed to the HTLC and retrying the payment in full would result
752 /// in over-/re-payment.
754 /// The results here are ordered the same as the paths in the route object which was passed to
755 /// send_payment, and any Errs which are not APIError::MonitorUpdateFailed can be safely
756 /// retried (though there is currently no API with which to do so).
758 /// Any entries which contain Err(APIError::MonitorUpdateFailed) or Ok(()) MUST NOT be retried
759 /// as they will result in over-/re-payment. These HTLCs all either successfully sent (in the
760 /// case of Ok(())) or will send once channel_monitor_updated is called on the next-hop channel
761 /// with the latest update_id.
762 PartialFailure(Vec<Result<(), APIError>>),
765 macro_rules! handle_error {
766 ($self: ident, $internal: expr, $counterparty_node_id: expr) => {
769 Err(MsgHandleErrInternal { err, shutdown_finish }) => {
770 #[cfg(debug_assertions)]
772 // In testing, ensure there are no deadlocks where the lock is already held upon
773 // entering the macro.
774 assert!($self.channel_state.try_lock().is_ok());
777 let mut msg_events = Vec::with_capacity(2);
779 if let Some((shutdown_res, update_option)) = shutdown_finish {
780 $self.finish_force_close_channel(shutdown_res);
781 if let Some(update) = update_option {
782 msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
788 log_error!($self.logger, "{}", err.err);
789 if let msgs::ErrorAction::IgnoreError = err.action {
791 msg_events.push(events::MessageSendEvent::HandleError {
792 node_id: $counterparty_node_id,
793 action: err.action.clone()
797 if !msg_events.is_empty() {
798 $self.channel_state.lock().unwrap().pending_msg_events.append(&mut msg_events);
801 // Return error in case higher-API need one
808 /// Returns (boolean indicating if we should remove the Channel object from memory, a mapped error)
809 macro_rules! convert_chan_err {
810 ($self: ident, $err: expr, $short_to_id: expr, $channel: expr, $channel_id: expr) => {
812 ChannelError::Ignore(msg) => {
813 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore(msg), $channel_id.clone()))
815 ChannelError::Close(msg) => {
816 log_error!($self.logger, "Closing channel {} due to close-required error: {}", log_bytes!($channel_id[..]), msg);
817 if let Some(short_id) = $channel.get_short_channel_id() {
818 $short_to_id.remove(&short_id);
820 let shutdown_res = $channel.force_shutdown(true);
821 (true, MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, shutdown_res, $self.get_channel_update_for_broadcast(&$channel).ok()))
823 ChannelError::CloseDelayBroadcast(msg) => {
824 log_error!($self.logger, "Channel {} need to be shutdown but closing transactions not broadcast due to {}", log_bytes!($channel_id[..]), msg);
825 if let Some(short_id) = $channel.get_short_channel_id() {
826 $short_to_id.remove(&short_id);
828 let shutdown_res = $channel.force_shutdown(false);
829 (true, MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, shutdown_res, $self.get_channel_update_for_broadcast(&$channel).ok()))
835 macro_rules! break_chan_entry {
836 ($self: ident, $res: expr, $channel_state: expr, $entry: expr) => {
840 let (drop, res) = convert_chan_err!($self, e, $channel_state.short_to_id, $entry.get_mut(), $entry.key());
842 $entry.remove_entry();
850 macro_rules! try_chan_entry {
851 ($self: ident, $res: expr, $channel_state: expr, $entry: expr) => {
855 let (drop, res) = convert_chan_err!($self, e, $channel_state.short_to_id, $entry.get_mut(), $entry.key());
857 $entry.remove_entry();
865 macro_rules! handle_monitor_err {
866 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
867 handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment, Vec::new(), Vec::new())
869 ($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) => {
871 ChannelMonitorUpdateErr::PermanentFailure => {
872 log_error!($self.logger, "Closing channel {} due to monitor update ChannelMonitorUpdateErr::PermanentFailure", log_bytes!($chan_id[..]));
873 if let Some(short_id) = $chan.get_short_channel_id() {
874 $short_to_id.remove(&short_id);
876 // TODO: $failed_fails is dropped here, which will cause other channels to hit the
877 // chain in a confused state! We need to move them into the ChannelMonitor which
878 // will be responsible for failing backwards once things confirm on-chain.
879 // It's ok that we drop $failed_forwards here - at this point we'd rather they
880 // broadcast HTLC-Timeout and pay the associated fees to get their funds back than
881 // us bother trying to claim it just to forward on to another peer. If we're
882 // splitting hairs we'd prefer to claim payments that were to us, but we haven't
883 // given up the preimage yet, so might as well just wait until the payment is
884 // retried, avoiding the on-chain fees.
885 let res: Result<(), _> = Err(MsgHandleErrInternal::from_finish_shutdown("ChannelMonitor storage failure".to_owned(), *$chan_id,
886 $chan.force_shutdown(true), $self.get_channel_update_for_broadcast(&$chan).ok() ));
889 ChannelMonitorUpdateErr::TemporaryFailure => {
890 log_info!($self.logger, "Disabling channel {} due to monitor update TemporaryFailure. On restore will send {} and process {} forwards and {} fails",
891 log_bytes!($chan_id[..]),
892 if $resend_commitment && $resend_raa {
894 RAACommitmentOrder::CommitmentFirst => { "commitment then RAA" },
895 RAACommitmentOrder::RevokeAndACKFirst => { "RAA then commitment" },
897 } else if $resend_commitment { "commitment" }
898 else if $resend_raa { "RAA" }
900 (&$failed_forwards as &Vec<(PendingHTLCInfo, u64)>).len(),
901 (&$failed_fails as &Vec<(HTLCSource, PaymentHash, HTLCFailReason)>).len());
902 if !$resend_commitment {
903 debug_assert!($action_type == RAACommitmentOrder::RevokeAndACKFirst || !$resend_raa);
906 debug_assert!($action_type == RAACommitmentOrder::CommitmentFirst || !$resend_commitment);
908 $chan.monitor_update_failed($resend_raa, $resend_commitment, $failed_forwards, $failed_fails);
909 (Err(MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore("Failed to update ChannelMonitor".to_owned()), *$chan_id)), false)
913 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr, $failed_forwards: expr, $failed_fails: expr) => { {
914 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());
916 $entry.remove_entry();
922 macro_rules! return_monitor_err {
923 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
924 return handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment);
926 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr, $failed_forwards: expr, $failed_fails: expr) => {
927 return handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment, $failed_forwards, $failed_fails);
931 // Does not break in case of TemporaryFailure!
932 macro_rules! maybe_break_monitor_err {
933 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
934 match (handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment), $err) {
935 (e, ChannelMonitorUpdateErr::PermanentFailure) => {
938 (_, ChannelMonitorUpdateErr::TemporaryFailure) => { },
943 macro_rules! handle_chan_restoration_locked {
944 ($self: ident, $channel_lock: expr, $channel_state: expr, $channel_entry: expr,
945 $raa: expr, $commitment_update: expr, $order: expr, $chanmon_update: expr,
946 $pending_forwards: expr, $funding_broadcastable: expr, $funding_locked: expr) => { {
947 let mut htlc_forwards = None;
948 let counterparty_node_id = $channel_entry.get().get_counterparty_node_id();
950 let chanmon_update: Option<ChannelMonitorUpdate> = $chanmon_update; // Force type-checking to resolve
951 let chanmon_update_is_none = chanmon_update.is_none();
953 let forwards: Vec<(PendingHTLCInfo, u64)> = $pending_forwards; // Force type-checking to resolve
954 if !forwards.is_empty() {
955 htlc_forwards = Some(($channel_entry.get().get_short_channel_id().expect("We can't have pending forwards before funding confirmation"),
956 $channel_entry.get().get_funding_txo().unwrap(), forwards));
959 if chanmon_update.is_some() {
960 // On reconnect, we, by definition, only resend a funding_locked if there have been
961 // no commitment updates, so the only channel monitor update which could also be
962 // associated with a funding_locked would be the funding_created/funding_signed
963 // monitor update. That monitor update failing implies that we won't send
964 // funding_locked until it's been updated, so we can't have a funding_locked and a
965 // monitor update here (so we don't bother to handle it correctly below).
966 assert!($funding_locked.is_none());
967 // A channel monitor update makes no sense without either a funding_locked or a
968 // commitment update to process after it. Since we can't have a funding_locked, we
969 // only bother to handle the monitor-update + commitment_update case below.
970 assert!($commitment_update.is_some());
973 if let Some(msg) = $funding_locked {
974 // Similar to the above, this implies that we're letting the funding_locked fly
975 // before it should be allowed to.
976 assert!(chanmon_update.is_none());
977 $channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingLocked {
978 node_id: counterparty_node_id,
981 if let Some(announcement_sigs) = $self.get_announcement_sigs($channel_entry.get()) {
982 $channel_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
983 node_id: counterparty_node_id,
984 msg: announcement_sigs,
987 $channel_state.short_to_id.insert($channel_entry.get().get_short_channel_id().unwrap(), $channel_entry.get().channel_id());
990 let funding_broadcastable: Option<Transaction> = $funding_broadcastable; // Force type-checking to resolve
991 if let Some(monitor_update) = chanmon_update {
992 // We only ever broadcast a funding transaction in response to a funding_signed
993 // message and the resulting monitor update. Thus, on channel_reestablish
994 // message handling we can't have a funding transaction to broadcast. When
995 // processing a monitor update finishing resulting in a funding broadcast, we
996 // cannot have a second monitor update, thus this case would indicate a bug.
997 assert!(funding_broadcastable.is_none());
998 // Given we were just reconnected or finished updating a channel monitor, the
999 // only case where we can get a new ChannelMonitorUpdate would be if we also
1000 // have some commitment updates to send as well.
1001 assert!($commitment_update.is_some());
1002 if let Err(e) = $self.chain_monitor.update_channel($channel_entry.get().get_funding_txo().unwrap(), monitor_update) {
1003 // channel_reestablish doesn't guarantee the order it returns is sensical
1004 // for the messages it returns, but if we're setting what messages to
1005 // re-transmit on monitor update success, we need to make sure it is sane.
1006 let mut order = $order;
1008 order = RAACommitmentOrder::CommitmentFirst;
1010 break handle_monitor_err!($self, e, $channel_state, $channel_entry, order, $raa.is_some(), true);
1014 macro_rules! handle_cs { () => {
1015 if let Some(update) = $commitment_update {
1016 $channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1017 node_id: counterparty_node_id,
1022 macro_rules! handle_raa { () => {
1023 if let Some(revoke_and_ack) = $raa {
1024 $channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
1025 node_id: counterparty_node_id,
1026 msg: revoke_and_ack,
1031 RAACommitmentOrder::CommitmentFirst => {
1035 RAACommitmentOrder::RevokeAndACKFirst => {
1040 if let Some(tx) = funding_broadcastable {
1041 log_info!($self.logger, "Broadcasting funding transaction with txid {}", tx.txid());
1042 $self.tx_broadcaster.broadcast_transaction(&tx);
1047 if chanmon_update_is_none {
1048 // If there was no ChannelMonitorUpdate, we should never generate an Err in the res loop
1049 // above. Doing so would imply calling handle_err!() from channel_monitor_updated() which
1050 // should *never* end up calling back to `chain_monitor.update_channel()`.
1051 assert!(res.is_ok());
1054 (htlc_forwards, res, counterparty_node_id)
1058 macro_rules! post_handle_chan_restoration {
1059 ($self: ident, $locked_res: expr) => { {
1060 let (htlc_forwards, res, counterparty_node_id) = $locked_res;
1062 let _ = handle_error!($self, res, counterparty_node_id);
1064 if let Some(forwards) = htlc_forwards {
1065 $self.forward_htlcs(&mut [forwards][..]);
1070 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<Signer, M, T, K, F, L>
1071 where M::Target: chain::Watch<Signer>,
1072 T::Target: BroadcasterInterface,
1073 K::Target: KeysInterface<Signer = Signer>,
1074 F::Target: FeeEstimator,
1077 /// Constructs a new ChannelManager to hold several channels and route between them.
1079 /// This is the main "logic hub" for all channel-related actions, and implements
1080 /// ChannelMessageHandler.
1082 /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
1084 /// panics if channel_value_satoshis is >= `MAX_FUNDING_SATOSHIS`!
1086 /// Users need to notify the new ChannelManager when a new block is connected or
1087 /// disconnected using its `block_connected` and `block_disconnected` methods, starting
1088 /// from after `params.latest_hash`.
1089 pub fn new(fee_est: F, chain_monitor: M, tx_broadcaster: T, logger: L, keys_manager: K, config: UserConfig, params: ChainParameters) -> Self {
1090 let mut secp_ctx = Secp256k1::new();
1091 secp_ctx.seeded_randomize(&keys_manager.get_secure_random_bytes());
1094 default_configuration: config.clone(),
1095 genesis_hash: genesis_block(params.network).header.block_hash(),
1096 fee_estimator: fee_est,
1100 best_block: RwLock::new(params.best_block),
1102 channel_state: Mutex::new(ChannelHolder{
1103 by_id: HashMap::new(),
1104 short_to_id: HashMap::new(),
1105 forward_htlcs: HashMap::new(),
1106 claimable_htlcs: HashMap::new(),
1107 pending_msg_events: Vec::new(),
1109 pending_inbound_payments: Mutex::new(HashMap::new()),
1110 pending_outbound_payments: Mutex::new(HashSet::new()),
1112 our_network_key: keys_manager.get_node_secret(),
1113 our_network_pubkey: PublicKey::from_secret_key(&secp_ctx, &keys_manager.get_node_secret()),
1116 last_node_announcement_serial: AtomicUsize::new(0),
1117 highest_seen_timestamp: AtomicUsize::new(0),
1119 per_peer_state: RwLock::new(HashMap::new()),
1121 pending_events: Mutex::new(Vec::new()),
1122 pending_background_events: Mutex::new(Vec::new()),
1123 total_consistency_lock: RwLock::new(()),
1124 persistence_notifier: PersistenceNotifier::new(),
1132 /// Gets the current configuration applied to all new channels, as
1133 pub fn get_current_default_configuration(&self) -> &UserConfig {
1134 &self.default_configuration
1137 /// Creates a new outbound channel to the given remote node and with the given value.
1139 /// user_id will be provided back as user_channel_id in FundingGenerationReady events to allow
1140 /// tracking of which events correspond with which create_channel call. Note that the
1141 /// user_channel_id defaults to 0 for inbound channels, so you may wish to avoid using 0 for
1142 /// user_id here. user_id has no meaning inside of LDK, it is simply copied to events and
1143 /// otherwise ignored.
1145 /// If successful, will generate a SendOpenChannel message event, so you should probably poll
1146 /// PeerManager::process_events afterwards.
1148 /// Raises APIError::APIMisuseError when channel_value_satoshis > 2**24 or push_msat is
1149 /// greater than channel_value_satoshis * 1k or channel_value_satoshis is < 1000.
1151 /// Note that we do not check if you are currently connected to the given peer. If no
1152 /// connection is available, the outbound `open_channel` message may fail to send, resulting in
1153 /// the channel eventually being silently forgotten.
1154 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> {
1155 if channel_value_satoshis < 1000 {
1156 return Err(APIError::APIMisuseError { err: format!("Channel value must be at least 1000 satoshis. It was {}", channel_value_satoshis) });
1159 let config = if override_config.is_some() { override_config.as_ref().unwrap() } else { &self.default_configuration };
1160 let channel = Channel::new_outbound(&self.fee_estimator, &self.keys_manager, their_network_key, channel_value_satoshis, push_msat, user_id, config)?;
1161 let res = channel.get_open_channel(self.genesis_hash.clone());
1163 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1164 // We want to make sure the lock is actually acquired by PersistenceNotifierGuard.
1165 debug_assert!(&self.total_consistency_lock.try_write().is_err());
1167 let mut channel_state = self.channel_state.lock().unwrap();
1168 match channel_state.by_id.entry(channel.channel_id()) {
1169 hash_map::Entry::Occupied(_) => {
1170 if cfg!(feature = "fuzztarget") {
1171 return Err(APIError::APIMisuseError { err: "Fuzzy bad RNG".to_owned() });
1173 panic!("RNG is bad???");
1176 hash_map::Entry::Vacant(entry) => { entry.insert(channel); }
1178 channel_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
1179 node_id: their_network_key,
1185 fn list_channels_with_filter<Fn: FnMut(&(&[u8; 32], &Channel<Signer>)) -> bool>(&self, f: Fn) -> Vec<ChannelDetails> {
1186 let mut res = Vec::new();
1188 let channel_state = self.channel_state.lock().unwrap();
1189 res.reserve(channel_state.by_id.len());
1190 for (channel_id, channel) in channel_state.by_id.iter().filter(f) {
1191 let (inbound_capacity_msat, outbound_capacity_msat) = channel.get_inbound_outbound_available_balance_msat();
1192 let (to_remote_reserve_satoshis, to_self_reserve_satoshis) =
1193 channel.get_holder_counterparty_selected_channel_reserve_satoshis();
1194 res.push(ChannelDetails {
1195 channel_id: (*channel_id).clone(),
1196 counterparty: ChannelCounterparty {
1197 node_id: channel.get_counterparty_node_id(),
1198 features: InitFeatures::empty(),
1199 unspendable_punishment_reserve: to_remote_reserve_satoshis,
1200 forwarding_info: channel.counterparty_forwarding_info(),
1202 funding_txo: channel.get_funding_txo(),
1203 short_channel_id: channel.get_short_channel_id(),
1204 channel_value_satoshis: channel.get_value_satoshis(),
1205 unspendable_punishment_reserve: to_self_reserve_satoshis,
1206 inbound_capacity_msat,
1207 outbound_capacity_msat,
1208 user_id: channel.get_user_id(),
1209 confirmations_required: channel.minimum_depth(),
1210 force_close_spend_delay: channel.get_counterparty_selected_contest_delay(),
1211 is_outbound: channel.is_outbound(),
1212 is_funding_locked: channel.is_usable(),
1213 is_usable: channel.is_live(),
1214 is_public: channel.should_announce(),
1218 let per_peer_state = self.per_peer_state.read().unwrap();
1219 for chan in res.iter_mut() {
1220 if let Some(peer_state) = per_peer_state.get(&chan.counterparty.node_id) {
1221 chan.counterparty.features = peer_state.lock().unwrap().latest_features.clone();
1227 /// Gets the list of open channels, in random order. See ChannelDetail field documentation for
1228 /// more information.
1229 pub fn list_channels(&self) -> Vec<ChannelDetails> {
1230 self.list_channels_with_filter(|_| true)
1233 /// Gets the list of usable channels, in random order. Useful as an argument to
1234 /// get_route to ensure non-announced channels are used.
1236 /// These are guaranteed to have their [`ChannelDetails::is_usable`] value set to true, see the
1237 /// documentation for [`ChannelDetails::is_usable`] for more info on exactly what the criteria
1239 pub fn list_usable_channels(&self) -> Vec<ChannelDetails> {
1240 // Note we use is_live here instead of usable which leads to somewhat confused
1241 // internal/external nomenclature, but that's ok cause that's probably what the user
1242 // really wanted anyway.
1243 self.list_channels_with_filter(|&(_, ref channel)| channel.is_live())
1246 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
1247 /// will be accepted on the given channel, and after additional timeout/the closing of all
1248 /// pending HTLCs, the channel will be closed on chain.
1250 /// May generate a SendShutdown message event on success, which should be relayed.
1251 pub fn close_channel(&self, channel_id: &[u8; 32]) -> Result<(), APIError> {
1252 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1254 let (mut failed_htlcs, chan_option) = {
1255 let mut channel_state_lock = self.channel_state.lock().unwrap();
1256 let channel_state = &mut *channel_state_lock;
1257 match channel_state.by_id.entry(channel_id.clone()) {
1258 hash_map::Entry::Occupied(mut chan_entry) => {
1259 let (shutdown_msg, failed_htlcs) = chan_entry.get_mut().get_shutdown()?;
1260 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
1261 node_id: chan_entry.get().get_counterparty_node_id(),
1264 if chan_entry.get().is_shutdown() {
1265 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
1266 channel_state.short_to_id.remove(&short_id);
1268 (failed_htlcs, Some(chan_entry.remove_entry().1))
1269 } else { (failed_htlcs, None) }
1271 hash_map::Entry::Vacant(_) => return Err(APIError::ChannelUnavailable{err: "No such channel".to_owned()})
1274 for htlc_source in failed_htlcs.drain(..) {
1275 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() });
1277 let chan_update = if let Some(chan) = chan_option {
1278 self.get_channel_update_for_broadcast(&chan).ok()
1281 if let Some(update) = chan_update {
1282 let mut channel_state = self.channel_state.lock().unwrap();
1283 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1292 fn finish_force_close_channel(&self, shutdown_res: ShutdownResult) {
1293 let (monitor_update_option, mut failed_htlcs) = shutdown_res;
1294 log_debug!(self.logger, "Finishing force-closure of channel with {} HTLCs to fail", failed_htlcs.len());
1295 for htlc_source in failed_htlcs.drain(..) {
1296 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() });
1298 if let Some((funding_txo, monitor_update)) = monitor_update_option {
1299 // There isn't anything we can do if we get an update failure - we're already
1300 // force-closing. The monitor update on the required in-memory copy should broadcast
1301 // the latest local state, which is the best we can do anyway. Thus, it is safe to
1302 // ignore the result here.
1303 let _ = self.chain_monitor.update_channel(funding_txo, monitor_update);
1307 fn force_close_channel_with_peer(&self, channel_id: &[u8; 32], peer_node_id: Option<&PublicKey>) -> Result<PublicKey, APIError> {
1309 let mut channel_state_lock = self.channel_state.lock().unwrap();
1310 let channel_state = &mut *channel_state_lock;
1311 if let hash_map::Entry::Occupied(chan) = channel_state.by_id.entry(channel_id.clone()) {
1312 if let Some(node_id) = peer_node_id {
1313 if chan.get().get_counterparty_node_id() != *node_id {
1314 return Err(APIError::ChannelUnavailable{err: "No such channel".to_owned()});
1317 if let Some(short_id) = chan.get().get_short_channel_id() {
1318 channel_state.short_to_id.remove(&short_id);
1320 chan.remove_entry().1
1322 return Err(APIError::ChannelUnavailable{err: "No such channel".to_owned()});
1325 log_error!(self.logger, "Force-closing channel {}", log_bytes!(channel_id[..]));
1326 self.finish_force_close_channel(chan.force_shutdown(true));
1327 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
1328 let mut channel_state = self.channel_state.lock().unwrap();
1329 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1334 Ok(chan.get_counterparty_node_id())
1337 /// Force closes a channel, immediately broadcasting the latest local commitment transaction to
1338 /// the chain and rejecting new HTLCs on the given channel. Fails if channel_id is unknown to the manager.
1339 pub fn force_close_channel(&self, channel_id: &[u8; 32]) -> Result<(), APIError> {
1340 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1341 match self.force_close_channel_with_peer(channel_id, None) {
1342 Ok(counterparty_node_id) => {
1343 self.channel_state.lock().unwrap().pending_msg_events.push(
1344 events::MessageSendEvent::HandleError {
1345 node_id: counterparty_node_id,
1346 action: msgs::ErrorAction::SendErrorMessage {
1347 msg: msgs::ErrorMessage { channel_id: *channel_id, data: "Channel force-closed".to_owned() }
1357 /// Force close all channels, immediately broadcasting the latest local commitment transaction
1358 /// for each to the chain and rejecting new HTLCs on each.
1359 pub fn force_close_all_channels(&self) {
1360 for chan in self.list_channels() {
1361 let _ = self.force_close_channel(&chan.channel_id);
1365 fn decode_update_add_htlc_onion(&self, msg: &msgs::UpdateAddHTLC) -> (PendingHTLCStatus, MutexGuard<ChannelHolder<Signer>>) {
1366 macro_rules! return_malformed_err {
1367 ($msg: expr, $err_code: expr) => {
1369 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
1370 return (PendingHTLCStatus::Fail(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
1371 channel_id: msg.channel_id,
1372 htlc_id: msg.htlc_id,
1373 sha256_of_onion: Sha256::hash(&msg.onion_routing_packet.hop_data).into_inner(),
1374 failure_code: $err_code,
1375 })), self.channel_state.lock().unwrap());
1380 if let Err(_) = msg.onion_routing_packet.public_key {
1381 return_malformed_err!("invalid ephemeral pubkey", 0x8000 | 0x4000 | 6);
1384 let shared_secret = {
1385 let mut arr = [0; 32];
1386 arr.copy_from_slice(&SharedSecret::new(&msg.onion_routing_packet.public_key.unwrap(), &self.our_network_key)[..]);
1389 let (rho, mu) = onion_utils::gen_rho_mu_from_shared_secret(&shared_secret);
1391 if msg.onion_routing_packet.version != 0 {
1392 //TODO: Spec doesn't indicate if we should only hash hop_data here (and in other
1393 //sha256_of_onion error data packets), or the entire onion_routing_packet. Either way,
1394 //the hash doesn't really serve any purpose - in the case of hashing all data, the
1395 //receiving node would have to brute force to figure out which version was put in the
1396 //packet by the node that send us the message, in the case of hashing the hop_data, the
1397 //node knows the HMAC matched, so they already know what is there...
1398 return_malformed_err!("Unknown onion packet version", 0x8000 | 0x4000 | 4);
1401 let mut hmac = HmacEngine::<Sha256>::new(&mu);
1402 hmac.input(&msg.onion_routing_packet.hop_data);
1403 hmac.input(&msg.payment_hash.0[..]);
1404 if !fixed_time_eq(&Hmac::from_engine(hmac).into_inner(), &msg.onion_routing_packet.hmac) {
1405 return_malformed_err!("HMAC Check failed", 0x8000 | 0x4000 | 5);
1408 let mut channel_state = None;
1409 macro_rules! return_err {
1410 ($msg: expr, $err_code: expr, $data: expr) => {
1412 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
1413 if channel_state.is_none() {
1414 channel_state = Some(self.channel_state.lock().unwrap());
1416 return (PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
1417 channel_id: msg.channel_id,
1418 htlc_id: msg.htlc_id,
1419 reason: onion_utils::build_first_hop_failure_packet(&shared_secret, $err_code, $data),
1420 })), channel_state.unwrap());
1425 let mut chacha = ChaCha20::new(&rho, &[0u8; 8]);
1426 let mut chacha_stream = ChaChaReader { chacha: &mut chacha, read: Cursor::new(&msg.onion_routing_packet.hop_data[..]) };
1427 let (next_hop_data, next_hop_hmac) = {
1428 match msgs::OnionHopData::read(&mut chacha_stream) {
1430 let error_code = match err {
1431 msgs::DecodeError::UnknownVersion => 0x4000 | 1, // unknown realm byte
1432 msgs::DecodeError::UnknownRequiredFeature|
1433 msgs::DecodeError::InvalidValue|
1434 msgs::DecodeError::ShortRead => 0x4000 | 22, // invalid_onion_payload
1435 _ => 0x2000 | 2, // Should never happen
1437 return_err!("Unable to decode our hop data", error_code, &[0;0]);
1440 let mut hmac = [0; 32];
1441 if let Err(_) = chacha_stream.read_exact(&mut hmac[..]) {
1442 return_err!("Unable to decode hop data", 0x4000 | 22, &[0;0]);
1449 let pending_forward_info = if next_hop_hmac == [0; 32] {
1452 // In tests, make sure that the initial onion pcket data is, at least, non-0.
1453 // We could do some fancy randomness test here, but, ehh, whatever.
1454 // This checks for the issue where you can calculate the path length given the
1455 // onion data as all the path entries that the originator sent will be here
1456 // as-is (and were originally 0s).
1457 // Of course reverse path calculation is still pretty easy given naive routing
1458 // algorithms, but this fixes the most-obvious case.
1459 let mut next_bytes = [0; 32];
1460 chacha_stream.read_exact(&mut next_bytes).unwrap();
1461 assert_ne!(next_bytes[..], [0; 32][..]);
1462 chacha_stream.read_exact(&mut next_bytes).unwrap();
1463 assert_ne!(next_bytes[..], [0; 32][..]);
1467 // final_expiry_too_soon
1468 // We have to have some headroom to broadcast on chain if we have the preimage, so make sure
1469 // we have at least HTLC_FAIL_BACK_BUFFER blocks to go.
1470 // Also, ensure that, in the case of an unknown preimage for the received payment hash, our
1471 // payment logic has enough time to fail the HTLC backward before our onchain logic triggers a
1472 // channel closure (see HTLC_FAIL_BACK_BUFFER rationale).
1473 if (msg.cltv_expiry as u64) <= self.best_block.read().unwrap().height() as u64 + HTLC_FAIL_BACK_BUFFER as u64 + 1 {
1474 return_err!("The final CLTV expiry is too soon to handle", 17, &[0;0]);
1476 // final_incorrect_htlc_amount
1477 if next_hop_data.amt_to_forward > msg.amount_msat {
1478 return_err!("Upstream node sent less than we were supposed to receive in payment", 19, &byte_utils::be64_to_array(msg.amount_msat));
1480 // final_incorrect_cltv_expiry
1481 if next_hop_data.outgoing_cltv_value != msg.cltv_expiry {
1482 return_err!("Upstream node set CLTV to the wrong value", 18, &byte_utils::be32_to_array(msg.cltv_expiry));
1485 let routing = match next_hop_data.format {
1486 msgs::OnionHopDataFormat::Legacy { .. } => return_err!("We require payment_secrets", 0x4000|0x2000|3, &[0;0]),
1487 msgs::OnionHopDataFormat::NonFinalNode { .. } => return_err!("Got non final data with an HMAC of 0", 0x4000 | 22, &[0;0]),
1488 msgs::OnionHopDataFormat::FinalNode { payment_data, keysend_preimage } => {
1489 if payment_data.is_some() && keysend_preimage.is_some() {
1490 return_err!("We don't support MPP keysend payments", 0x4000|22, &[0;0]);
1491 } else if let Some(data) = payment_data {
1492 PendingHTLCRouting::Receive {
1494 incoming_cltv_expiry: msg.cltv_expiry,
1496 } else if let Some(payment_preimage) = keysend_preimage {
1497 // We need to check that the sender knows the keysend preimage before processing this
1498 // payment further. Otherwise, an intermediary routing hop forwarding non-keysend-HTLC X
1499 // could discover the final destination of X, by probing the adjacent nodes on the route
1500 // with a keysend payment of identical payment hash to X and observing the processing
1501 // time discrepancies due to a hash collision with X.
1502 let hashed_preimage = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
1503 if hashed_preimage != msg.payment_hash {
1504 return_err!("Payment preimage didn't match payment hash", 0x4000|22, &[0;0]);
1507 PendingHTLCRouting::ReceiveKeysend {
1509 incoming_cltv_expiry: msg.cltv_expiry,
1512 return_err!("We require payment_secrets", 0x4000|0x2000|3, &[0;0]);
1517 // Note that we could obviously respond immediately with an update_fulfill_htlc
1518 // message, however that would leak that we are the recipient of this payment, so
1519 // instead we stay symmetric with the forwarding case, only responding (after a
1520 // delay) once they've send us a commitment_signed!
1522 PendingHTLCStatus::Forward(PendingHTLCInfo {
1524 payment_hash: msg.payment_hash.clone(),
1525 incoming_shared_secret: shared_secret,
1526 amt_to_forward: next_hop_data.amt_to_forward,
1527 outgoing_cltv_value: next_hop_data.outgoing_cltv_value,
1530 let mut new_packet_data = [0; 20*65];
1531 let read_pos = chacha_stream.read(&mut new_packet_data).unwrap();
1532 #[cfg(debug_assertions)]
1534 // Check two things:
1535 // a) that the behavior of our stream here will return Ok(0) even if the TLV
1536 // read above emptied out our buffer and the unwrap() wont needlessly panic
1537 // b) that we didn't somehow magically end up with extra data.
1539 debug_assert!(chacha_stream.read(&mut t).unwrap() == 0);
1541 // Once we've emptied the set of bytes our peer gave us, encrypt 0 bytes until we
1542 // fill the onion hop data we'll forward to our next-hop peer.
1543 chacha_stream.chacha.process_in_place(&mut new_packet_data[read_pos..]);
1545 let mut new_pubkey = msg.onion_routing_packet.public_key.unwrap();
1547 let blinding_factor = {
1548 let mut sha = Sha256::engine();
1549 sha.input(&new_pubkey.serialize()[..]);
1550 sha.input(&shared_secret);
1551 Sha256::from_engine(sha).into_inner()
1554 let public_key = if let Err(e) = new_pubkey.mul_assign(&self.secp_ctx, &blinding_factor[..]) {
1556 } else { Ok(new_pubkey) };
1558 let outgoing_packet = msgs::OnionPacket {
1561 hop_data: new_packet_data,
1562 hmac: next_hop_hmac.clone(),
1565 let short_channel_id = match next_hop_data.format {
1566 msgs::OnionHopDataFormat::Legacy { short_channel_id } => short_channel_id,
1567 msgs::OnionHopDataFormat::NonFinalNode { short_channel_id } => short_channel_id,
1568 msgs::OnionHopDataFormat::FinalNode { .. } => {
1569 return_err!("Final Node OnionHopData provided for us as an intermediary node", 0x4000 | 22, &[0;0]);
1573 PendingHTLCStatus::Forward(PendingHTLCInfo {
1574 routing: PendingHTLCRouting::Forward {
1575 onion_packet: outgoing_packet,
1578 payment_hash: msg.payment_hash.clone(),
1579 incoming_shared_secret: shared_secret,
1580 amt_to_forward: next_hop_data.amt_to_forward,
1581 outgoing_cltv_value: next_hop_data.outgoing_cltv_value,
1585 channel_state = Some(self.channel_state.lock().unwrap());
1586 if let &PendingHTLCStatus::Forward(PendingHTLCInfo { ref routing, ref amt_to_forward, ref outgoing_cltv_value, .. }) = &pending_forward_info {
1587 // If short_channel_id is 0 here, we'll reject the HTLC as there cannot be a channel
1588 // with a short_channel_id of 0. This is important as various things later assume
1589 // short_channel_id is non-0 in any ::Forward.
1590 if let &PendingHTLCRouting::Forward { ref short_channel_id, .. } = routing {
1591 let id_option = channel_state.as_ref().unwrap().short_to_id.get(&short_channel_id).cloned();
1592 if let Some((err, code, chan_update)) = loop {
1593 let forwarding_id = match id_option {
1594 None => { // unknown_next_peer
1595 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
1597 Some(id) => id.clone(),
1600 let chan = channel_state.as_mut().unwrap().by_id.get_mut(&forwarding_id).unwrap();
1602 if !chan.should_announce() && !self.default_configuration.accept_forwards_to_priv_channels {
1603 // Note that the behavior here should be identical to the above block - we
1604 // should NOT reveal the existence or non-existence of a private channel if
1605 // we don't allow forwards outbound over them.
1606 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
1609 // Note that we could technically not return an error yet here and just hope
1610 // that the connection is reestablished or monitor updated by the time we get
1611 // around to doing the actual forward, but better to fail early if we can and
1612 // hopefully an attacker trying to path-trace payments cannot make this occur
1613 // on a small/per-node/per-channel scale.
1614 if !chan.is_live() { // channel_disabled
1615 break Some(("Forwarding channel is not in a ready state.", 0x1000 | 20, Some(self.get_channel_update_for_unicast(chan).unwrap())));
1617 if *amt_to_forward < chan.get_counterparty_htlc_minimum_msat() { // amount_below_minimum
1618 break Some(("HTLC amount was below the htlc_minimum_msat", 0x1000 | 11, Some(self.get_channel_update_for_unicast(chan).unwrap())));
1620 let fee = amt_to_forward.checked_mul(chan.get_fee_proportional_millionths() as u64)
1621 .and_then(|prop_fee| { (prop_fee / 1000000)
1622 .checked_add(chan.get_outbound_forwarding_fee_base_msat() as u64) });
1623 if fee.is_none() || msg.amount_msat < fee.unwrap() || (msg.amount_msat - fee.unwrap()) < *amt_to_forward { // fee_insufficient
1624 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())));
1626 if (msg.cltv_expiry as u64) < (*outgoing_cltv_value) as u64 + chan.get_cltv_expiry_delta() as u64 { // incorrect_cltv_expiry
1627 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())));
1629 let cur_height = self.best_block.read().unwrap().height() + 1;
1630 // Theoretically, channel counterparty shouldn't send us a HTLC expiring now, but we want to be robust wrt to counterparty
1631 // packet sanitization (see HTLC_FAIL_BACK_BUFFER rational)
1632 if msg.cltv_expiry <= cur_height + HTLC_FAIL_BACK_BUFFER as u32 { // expiry_too_soon
1633 break Some(("CLTV expiry is too close", 0x1000 | 14, Some(self.get_channel_update_for_unicast(chan).unwrap())));
1635 if msg.cltv_expiry > cur_height + CLTV_FAR_FAR_AWAY as u32 { // expiry_too_far
1636 break Some(("CLTV expiry is too far in the future", 21, None));
1638 // In theory, we would be safe against unintentional channel-closure, if we only required a margin of LATENCY_GRACE_PERIOD_BLOCKS.
1639 // But, to be safe against policy reception, we use a longer delay.
1640 if (*outgoing_cltv_value) as u64 <= (cur_height + HTLC_FAIL_BACK_BUFFER) as u64 {
1641 break Some(("Outgoing CLTV value is too soon", 0x1000 | 14, Some(self.get_channel_update_for_unicast(chan).unwrap())));
1647 let mut res = Vec::with_capacity(8 + 128);
1648 if let Some(chan_update) = chan_update {
1649 if code == 0x1000 | 11 || code == 0x1000 | 12 {
1650 res.extend_from_slice(&byte_utils::be64_to_array(msg.amount_msat));
1652 else if code == 0x1000 | 13 {
1653 res.extend_from_slice(&byte_utils::be32_to_array(msg.cltv_expiry));
1655 else if code == 0x1000 | 20 {
1656 // TODO: underspecified, follow https://github.com/lightningnetwork/lightning-rfc/issues/791
1657 res.extend_from_slice(&byte_utils::be16_to_array(0));
1659 res.extend_from_slice(&chan_update.encode_with_len()[..]);
1661 return_err!(err, code, &res[..]);
1666 (pending_forward_info, channel_state.unwrap())
1669 /// Gets the current channel_update for the given channel. This first checks if the channel is
1670 /// public, and thus should be called whenever the result is going to be passed out in a
1671 /// [`MessageSendEvent::BroadcastChannelUpdate`] event.
1673 /// May be called with channel_state already locked!
1674 fn get_channel_update_for_broadcast(&self, chan: &Channel<Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
1675 if !chan.should_announce() {
1676 return Err(LightningError {
1677 err: "Cannot broadcast a channel_update for a private channel".to_owned(),
1678 action: msgs::ErrorAction::IgnoreError
1681 log_trace!(self.logger, "Attempting to generate broadcast channel update for channel {}", log_bytes!(chan.channel_id()));
1682 self.get_channel_update_for_unicast(chan)
1685 /// Gets the current channel_update for the given channel. This does not check if the channel
1686 /// is public (only returning an Err if the channel does not yet have an assigned short_id),
1687 /// and thus MUST NOT be called unless the recipient of the resulting message has already
1688 /// provided evidence that they know about the existence of the channel.
1689 /// May be called with channel_state already locked!
1690 fn get_channel_update_for_unicast(&self, chan: &Channel<Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
1691 log_trace!(self.logger, "Attempting to generate channel update for channel {}", log_bytes!(chan.channel_id()));
1692 let short_channel_id = match chan.get_short_channel_id() {
1693 None => return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError}),
1697 let were_node_one = PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key).serialize()[..] < chan.get_counterparty_node_id().serialize()[..];
1699 let unsigned = msgs::UnsignedChannelUpdate {
1700 chain_hash: self.genesis_hash,
1702 timestamp: chan.get_update_time_counter(),
1703 flags: (!were_node_one) as u8 | ((!chan.is_live() as u8) << 1),
1704 cltv_expiry_delta: chan.get_cltv_expiry_delta(),
1705 htlc_minimum_msat: chan.get_counterparty_htlc_minimum_msat(),
1706 htlc_maximum_msat: OptionalField::Present(chan.get_announced_htlc_max_msat()),
1707 fee_base_msat: chan.get_outbound_forwarding_fee_base_msat(),
1708 fee_proportional_millionths: chan.get_fee_proportional_millionths(),
1709 excess_data: Vec::new(),
1712 let msg_hash = Sha256dHash::hash(&unsigned.encode()[..]);
1713 let sig = self.secp_ctx.sign(&hash_to_message!(&msg_hash[..]), &self.our_network_key);
1715 Ok(msgs::ChannelUpdate {
1721 // Only public for testing, this should otherwise never be called direcly
1722 pub(crate) fn send_payment_along_path(&self, path: &Vec<RouteHop>, payment_hash: &PaymentHash, payment_secret: &Option<PaymentSecret>, total_value: u64, cur_height: u32, keysend_preimage: &Option<PaymentPreimage>) -> Result<(), APIError> {
1723 log_trace!(self.logger, "Attempting to send payment for path with next hop {}", path.first().unwrap().short_channel_id);
1724 let prng_seed = self.keys_manager.get_secure_random_bytes();
1725 let session_priv_bytes = self.keys_manager.get_secure_random_bytes();
1726 let session_priv = SecretKey::from_slice(&session_priv_bytes[..]).expect("RNG is busted");
1728 let onion_keys = onion_utils::construct_onion_keys(&self.secp_ctx, &path, &session_priv)
1729 .map_err(|_| APIError::RouteError{err: "Pubkey along hop was maliciously selected"})?;
1730 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(path, total_value, payment_secret, cur_height, keysend_preimage)?;
1731 if onion_utils::route_size_insane(&onion_payloads) {
1732 return Err(APIError::RouteError{err: "Route size too large considering onion data"});
1734 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, prng_seed, payment_hash);
1736 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1737 assert!(self.pending_outbound_payments.lock().unwrap().insert(session_priv_bytes));
1739 let err: Result<(), _> = loop {
1740 let mut channel_lock = self.channel_state.lock().unwrap();
1741 let id = match channel_lock.short_to_id.get(&path.first().unwrap().short_channel_id) {
1742 None => return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()}),
1743 Some(id) => id.clone(),
1746 let channel_state = &mut *channel_lock;
1747 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(id) {
1749 if chan.get().get_counterparty_node_id() != path.first().unwrap().pubkey {
1750 return Err(APIError::RouteError{err: "Node ID mismatch on first hop!"});
1752 if !chan.get().is_live() {
1753 return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected/pending monitor update!".to_owned()});
1755 break_chan_entry!(self, chan.get_mut().send_htlc_and_commit(htlc_msat, payment_hash.clone(), htlc_cltv, HTLCSource::OutboundRoute {
1757 session_priv: session_priv.clone(),
1758 first_hop_htlc_msat: htlc_msat,
1759 }, onion_packet, &self.logger), channel_state, chan)
1761 Some((update_add, commitment_signed, monitor_update)) => {
1762 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
1763 maybe_break_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, true);
1764 // Note that MonitorUpdateFailed here indicates (per function docs)
1765 // that we will resend the commitment update once monitor updating
1766 // is restored. Therefore, we must return an error indicating that
1767 // it is unsafe to retry the payment wholesale, which we do in the
1768 // send_payment check for MonitorUpdateFailed, below.
1769 return Err(APIError::MonitorUpdateFailed);
1772 log_debug!(self.logger, "Sending payment along path resulted in a commitment_signed for channel {}", log_bytes!(chan.get().channel_id()));
1773 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1774 node_id: path.first().unwrap().pubkey,
1775 updates: msgs::CommitmentUpdate {
1776 update_add_htlcs: vec![update_add],
1777 update_fulfill_htlcs: Vec::new(),
1778 update_fail_htlcs: Vec::new(),
1779 update_fail_malformed_htlcs: Vec::new(),
1787 } else { unreachable!(); }
1791 match handle_error!(self, err, path.first().unwrap().pubkey) {
1792 Ok(_) => unreachable!(),
1794 Err(APIError::ChannelUnavailable { err: e.err })
1799 /// Sends a payment along a given route.
1801 /// Value parameters are provided via the last hop in route, see documentation for RouteHop
1802 /// fields for more info.
1804 /// Note that if the payment_hash already exists elsewhere (eg you're sending a duplicative
1805 /// payment), we don't do anything to stop you! We always try to ensure that if the provided
1806 /// next hop knows the preimage to payment_hash they can claim an additional amount as
1807 /// specified in the last hop in the route! Thus, you should probably do your own
1808 /// payment_preimage tracking (which you should already be doing as they represent "proof of
1809 /// payment") and prevent double-sends yourself.
1811 /// May generate SendHTLCs message(s) event on success, which should be relayed.
1813 /// Each path may have a different return value, and PaymentSendValue may return a Vec with
1814 /// each entry matching the corresponding-index entry in the route paths, see
1815 /// PaymentSendFailure for more info.
1817 /// In general, a path may raise:
1818 /// * APIError::RouteError when an invalid route or forwarding parameter (cltv_delta, fee,
1819 /// node public key) is specified.
1820 /// * APIError::ChannelUnavailable if the next-hop channel is not available for updates
1821 /// (including due to previous monitor update failure or new permanent monitor update
1823 /// * APIError::MonitorUpdateFailed if a new monitor update failure prevented sending the
1824 /// relevant updates.
1826 /// Note that depending on the type of the PaymentSendFailure the HTLC may have been
1827 /// irrevocably committed to on our end. In such a case, do NOT retry the payment with a
1828 /// different route unless you intend to pay twice!
1830 /// payment_secret is unrelated to payment_hash (or PaymentPreimage) and exists to authenticate
1831 /// the sender to the recipient and prevent payment-probing (deanonymization) attacks. For
1832 /// newer nodes, it will be provided to you in the invoice. If you do not have one, the Route
1833 /// must not contain multiple paths as multi-path payments require a recipient-provided
1835 /// If a payment_secret *is* provided, we assume that the invoice had the payment_secret feature
1836 /// bit set (either as required or as available). If multiple paths are present in the Route,
1837 /// we assume the invoice had the basic_mpp feature set.
1838 pub fn send_payment(&self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>) -> Result<(), PaymentSendFailure> {
1839 self.send_payment_internal(route, payment_hash, payment_secret, None)
1842 fn send_payment_internal(&self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>, keysend_preimage: Option<PaymentPreimage>) -> Result<(), PaymentSendFailure> {
1843 if route.paths.len() < 1 {
1844 return Err(PaymentSendFailure::ParameterError(APIError::RouteError{err: "There must be at least one path to send over"}));
1846 if route.paths.len() > 10 {
1847 // This limit is completely arbitrary - there aren't any real fundamental path-count
1848 // limits. After we support retrying individual paths we should likely bump this, but
1849 // for now more than 10 paths likely carries too much one-path failure.
1850 return Err(PaymentSendFailure::ParameterError(APIError::RouteError{err: "Sending over more than 10 paths is not currently supported"}));
1852 let mut total_value = 0;
1853 let our_node_id = self.get_our_node_id();
1854 let mut path_errs = Vec::with_capacity(route.paths.len());
1855 'path_check: for path in route.paths.iter() {
1856 if path.len() < 1 || path.len() > 20 {
1857 path_errs.push(Err(APIError::RouteError{err: "Path didn't go anywhere/had bogus size"}));
1858 continue 'path_check;
1860 for (idx, hop) in path.iter().enumerate() {
1861 if idx != path.len() - 1 && hop.pubkey == our_node_id {
1862 path_errs.push(Err(APIError::RouteError{err: "Path went through us but wasn't a simple rebalance loop to us"}));
1863 continue 'path_check;
1866 total_value += path.last().unwrap().fee_msat;
1867 path_errs.push(Ok(()));
1869 if path_errs.iter().any(|e| e.is_err()) {
1870 return Err(PaymentSendFailure::PathParameterError(path_errs));
1873 let cur_height = self.best_block.read().unwrap().height() + 1;
1874 let mut results = Vec::new();
1875 for path in route.paths.iter() {
1876 results.push(self.send_payment_along_path(&path, &payment_hash, payment_secret, total_value, cur_height, &keysend_preimage));
1878 let mut has_ok = false;
1879 let mut has_err = false;
1880 for res in results.iter() {
1881 if res.is_ok() { has_ok = true; }
1882 if res.is_err() { has_err = true; }
1883 if let &Err(APIError::MonitorUpdateFailed) = res {
1884 // MonitorUpdateFailed is inherently unsafe to retry, so we call it a
1891 if has_err && has_ok {
1892 Err(PaymentSendFailure::PartialFailure(results))
1894 Err(PaymentSendFailure::AllFailedRetrySafe(results.drain(..).map(|r| r.unwrap_err()).collect()))
1900 /// Send a spontaneous payment, which is a payment that does not require the recipient to have
1901 /// generated an invoice. Optionally, you may specify the preimage. If you do choose to specify
1902 /// the preimage, it must be a cryptographically secure random value that no intermediate node
1903 /// would be able to guess -- otherwise, an intermediate node may claim the payment and it will
1904 /// never reach the recipient.
1906 /// Similar to regular payments, you MUST NOT reuse a `payment_preimage` value. See
1907 /// [`send_payment`] for more information about the risks of duplicate preimage usage.
1909 /// [`send_payment`]: Self::send_payment
1910 pub fn send_spontaneous_payment(&self, route: &Route, payment_preimage: Option<PaymentPreimage>) -> Result<PaymentHash, PaymentSendFailure> {
1911 let preimage = match payment_preimage {
1913 None => PaymentPreimage(self.keys_manager.get_secure_random_bytes()),
1915 let payment_hash = PaymentHash(Sha256::hash(&preimage.0).into_inner());
1916 match self.send_payment_internal(route, payment_hash, &None, Some(preimage)) {
1917 Ok(()) => Ok(payment_hash),
1922 /// Handles the generation of a funding transaction, optionally (for tests) with a function
1923 /// which checks the correctness of the funding transaction given the associated channel.
1924 fn funding_transaction_generated_intern<FundingOutput: Fn(&Channel<Signer>, &Transaction) -> Result<OutPoint, APIError>>
1925 (&self, temporary_channel_id: &[u8; 32], funding_transaction: Transaction, find_funding_output: FundingOutput) -> Result<(), APIError> {
1927 let (res, chan) = match self.channel_state.lock().unwrap().by_id.remove(temporary_channel_id) {
1929 let funding_txo = find_funding_output(&chan, &funding_transaction)?;
1931 (chan.get_outbound_funding_created(funding_transaction, funding_txo, &self.logger)
1932 .map_err(|e| if let ChannelError::Close(msg) = e {
1933 MsgHandleErrInternal::from_finish_shutdown(msg, chan.channel_id(), chan.force_shutdown(true), None)
1934 } else { unreachable!(); })
1937 None => { return Err(APIError::ChannelUnavailable { err: "No such channel".to_owned() }) },
1939 match handle_error!(self, res, chan.get_counterparty_node_id()) {
1940 Ok(funding_msg) => {
1943 Err(_) => { return Err(APIError::ChannelUnavailable {
1944 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()
1949 let mut channel_state = self.channel_state.lock().unwrap();
1950 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
1951 node_id: chan.get_counterparty_node_id(),
1954 match channel_state.by_id.entry(chan.channel_id()) {
1955 hash_map::Entry::Occupied(_) => {
1956 panic!("Generated duplicate funding txid?");
1958 hash_map::Entry::Vacant(e) => {
1966 pub(crate) fn funding_transaction_generated_unchecked(&self, temporary_channel_id: &[u8; 32], funding_transaction: Transaction, output_index: u16) -> Result<(), APIError> {
1967 self.funding_transaction_generated_intern(temporary_channel_id, funding_transaction, |_, tx| {
1968 Ok(OutPoint { txid: tx.txid(), index: output_index })
1972 /// Call this upon creation of a funding transaction for the given channel.
1974 /// Returns an [`APIError::APIMisuseError`] if the funding_transaction spent non-SegWit outputs
1975 /// or if no output was found which matches the parameters in [`Event::FundingGenerationReady`].
1977 /// Panics if a funding transaction has already been provided for this channel.
1979 /// May panic if the output found in the funding transaction is duplicative with some other
1980 /// channel (note that this should be trivially prevented by using unique funding transaction
1981 /// keys per-channel).
1983 /// Do NOT broadcast the funding transaction yourself. When we have safely received our
1984 /// counterparty's signature the funding transaction will automatically be broadcast via the
1985 /// [`BroadcasterInterface`] provided when this `ChannelManager` was constructed.
1987 /// Note that this includes RBF or similar transaction replacement strategies - lightning does
1988 /// not currently support replacing a funding transaction on an existing channel. Instead,
1989 /// create a new channel with a conflicting funding transaction.
1991 /// [`Event::FundingGenerationReady`]: crate::util::events::Event::FundingGenerationReady
1992 pub fn funding_transaction_generated(&self, temporary_channel_id: &[u8; 32], funding_transaction: Transaction) -> Result<(), APIError> {
1993 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1995 for inp in funding_transaction.input.iter() {
1996 if inp.witness.is_empty() {
1997 return Err(APIError::APIMisuseError {
1998 err: "Funding transaction must be fully signed and spend Segwit outputs".to_owned()
2002 self.funding_transaction_generated_intern(temporary_channel_id, funding_transaction, |chan, tx| {
2003 let mut output_index = None;
2004 let expected_spk = chan.get_funding_redeemscript().to_v0_p2wsh();
2005 for (idx, outp) in tx.output.iter().enumerate() {
2006 if outp.script_pubkey == expected_spk && outp.value == chan.get_value_satoshis() {
2007 if output_index.is_some() {
2008 return Err(APIError::APIMisuseError {
2009 err: "Multiple outputs matched the expected script and value".to_owned()
2012 if idx > u16::max_value() as usize {
2013 return Err(APIError::APIMisuseError {
2014 err: "Transaction had more than 2^16 outputs, which is not supported".to_owned()
2017 output_index = Some(idx as u16);
2020 if output_index.is_none() {
2021 return Err(APIError::APIMisuseError {
2022 err: "No output matched the script_pubkey and value in the FundingGenerationReady event".to_owned()
2025 Ok(OutPoint { txid: tx.txid(), index: output_index.unwrap() })
2029 fn get_announcement_sigs(&self, chan: &Channel<Signer>) -> Option<msgs::AnnouncementSignatures> {
2030 if !chan.should_announce() {
2031 log_trace!(self.logger, "Can't send announcement_signatures for private channel {}", log_bytes!(chan.channel_id()));
2035 let (announcement, our_bitcoin_sig) = match chan.get_channel_announcement(self.get_our_node_id(), self.genesis_hash.clone()) {
2037 Err(_) => return None, // Only in case of state precondition violations eg channel is closing
2039 let msghash = hash_to_message!(&Sha256dHash::hash(&announcement.encode()[..])[..]);
2040 let our_node_sig = self.secp_ctx.sign(&msghash, &self.our_network_key);
2042 Some(msgs::AnnouncementSignatures {
2043 channel_id: chan.channel_id(),
2044 short_channel_id: chan.get_short_channel_id().unwrap(),
2045 node_signature: our_node_sig,
2046 bitcoin_signature: our_bitcoin_sig,
2051 // Messages of up to 64KB should never end up more than half full with addresses, as that would
2052 // be absurd. We ensure this by checking that at least 500 (our stated public contract on when
2053 // broadcast_node_announcement panics) of the maximum-length addresses would fit in a 64KB
2055 const HALF_MESSAGE_IS_ADDRS: u32 = ::core::u16::MAX as u32 / (NetAddress::MAX_LEN as u32 + 1) / 2;
2058 // ...by failing to compile if the number of addresses that would be half of a message is
2059 // smaller than 500:
2060 const STATIC_ASSERT: u32 = Self::HALF_MESSAGE_IS_ADDRS - 500;
2062 /// Regenerates channel_announcements and generates a signed node_announcement from the given
2063 /// arguments, providing them in corresponding events via
2064 /// [`get_and_clear_pending_msg_events`], if at least one public channel has been confirmed
2065 /// on-chain. This effectively re-broadcasts all channel announcements and sends our node
2066 /// announcement to ensure that the lightning P2P network is aware of the channels we have and
2067 /// our network addresses.
2069 /// `rgb` is a node "color" and `alias` is a printable human-readable string to describe this
2070 /// node to humans. They carry no in-protocol meaning.
2072 /// `addresses` represent the set (possibly empty) of socket addresses on which this node
2073 /// accepts incoming connections. These will be included in the node_announcement, publicly
2074 /// tying these addresses together and to this node. If you wish to preserve user privacy,
2075 /// addresses should likely contain only Tor Onion addresses.
2077 /// Panics if `addresses` is absurdly large (more than 500).
2079 /// [`get_and_clear_pending_msg_events`]: MessageSendEventsProvider::get_and_clear_pending_msg_events
2080 pub fn broadcast_node_announcement(&self, rgb: [u8; 3], alias: [u8; 32], mut addresses: Vec<NetAddress>) {
2081 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2083 if addresses.len() > 500 {
2084 panic!("More than half the message size was taken up by public addresses!");
2087 // While all existing nodes handle unsorted addresses just fine, the spec requires that
2088 // addresses be sorted for future compatibility.
2089 addresses.sort_by_key(|addr| addr.get_id());
2091 let announcement = msgs::UnsignedNodeAnnouncement {
2092 features: NodeFeatures::known(),
2093 timestamp: self.last_node_announcement_serial.fetch_add(1, Ordering::AcqRel) as u32,
2094 node_id: self.get_our_node_id(),
2095 rgb, alias, addresses,
2096 excess_address_data: Vec::new(),
2097 excess_data: Vec::new(),
2099 let msghash = hash_to_message!(&Sha256dHash::hash(&announcement.encode()[..])[..]);
2100 let node_announce_sig = self.secp_ctx.sign(&msghash, &self.our_network_key);
2102 let mut channel_state_lock = self.channel_state.lock().unwrap();
2103 let channel_state = &mut *channel_state_lock;
2105 let mut announced_chans = false;
2106 for (_, chan) in channel_state.by_id.iter() {
2107 if let Some(msg) = chan.get_signed_channel_announcement(&self.our_network_key, self.get_our_node_id(), self.genesis_hash.clone()) {
2108 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
2110 update_msg: match self.get_channel_update_for_broadcast(chan) {
2115 announced_chans = true;
2117 // If the channel is not public or has not yet reached funding_locked, check the
2118 // next channel. If we don't yet have any public channels, we'll skip the broadcast
2119 // below as peers may not accept it without channels on chain first.
2123 if announced_chans {
2124 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastNodeAnnouncement {
2125 msg: msgs::NodeAnnouncement {
2126 signature: node_announce_sig,
2127 contents: announcement
2133 /// Processes HTLCs which are pending waiting on random forward delay.
2135 /// Should only really ever be called in response to a PendingHTLCsForwardable event.
2136 /// Will likely generate further events.
2137 pub fn process_pending_htlc_forwards(&self) {
2138 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2140 let mut new_events = Vec::new();
2141 let mut failed_forwards = Vec::new();
2142 let mut handle_errors = Vec::new();
2144 let mut channel_state_lock = self.channel_state.lock().unwrap();
2145 let channel_state = &mut *channel_state_lock;
2147 for (short_chan_id, mut pending_forwards) in channel_state.forward_htlcs.drain() {
2148 if short_chan_id != 0 {
2149 let forward_chan_id = match channel_state.short_to_id.get(&short_chan_id) {
2150 Some(chan_id) => chan_id.clone(),
2152 failed_forwards.reserve(pending_forwards.len());
2153 for forward_info in pending_forwards.drain(..) {
2154 match forward_info {
2155 HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info,
2156 prev_funding_outpoint } => {
2157 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
2158 short_channel_id: prev_short_channel_id,
2159 outpoint: prev_funding_outpoint,
2160 htlc_id: prev_htlc_id,
2161 incoming_packet_shared_secret: forward_info.incoming_shared_secret,
2163 failed_forwards.push((htlc_source, forward_info.payment_hash,
2164 HTLCFailReason::Reason { failure_code: 0x4000 | 10, data: Vec::new() }
2167 HTLCForwardInfo::FailHTLC { .. } => {
2168 // Channel went away before we could fail it. This implies
2169 // the channel is now on chain and our counterparty is
2170 // trying to broadcast the HTLC-Timeout, but that's their
2171 // problem, not ours.
2178 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(forward_chan_id) {
2179 let mut add_htlc_msgs = Vec::new();
2180 let mut fail_htlc_msgs = Vec::new();
2181 for forward_info in pending_forwards.drain(..) {
2182 match forward_info {
2183 HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info: PendingHTLCInfo {
2184 routing: PendingHTLCRouting::Forward {
2186 }, incoming_shared_secret, payment_hash, amt_to_forward, outgoing_cltv_value },
2187 prev_funding_outpoint } => {
2188 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);
2189 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
2190 short_channel_id: prev_short_channel_id,
2191 outpoint: prev_funding_outpoint,
2192 htlc_id: prev_htlc_id,
2193 incoming_packet_shared_secret: incoming_shared_secret,
2195 match chan.get_mut().send_htlc(amt_to_forward, payment_hash, outgoing_cltv_value, htlc_source.clone(), onion_packet) {
2197 if let ChannelError::Ignore(msg) = e {
2198 log_trace!(self.logger, "Failed to forward HTLC with payment_hash {}: {}", log_bytes!(payment_hash.0), msg);
2200 panic!("Stated return value requirements in send_htlc() were not met");
2202 let chan_update = self.get_channel_update_for_unicast(chan.get()).unwrap();
2203 failed_forwards.push((htlc_source, payment_hash,
2204 HTLCFailReason::Reason { failure_code: 0x1000 | 7, data: chan_update.encode_with_len() }
2210 Some(msg) => { add_htlc_msgs.push(msg); },
2212 // Nothing to do here...we're waiting on a remote
2213 // revoke_and_ack before we can add anymore HTLCs. The Channel
2214 // will automatically handle building the update_add_htlc and
2215 // commitment_signed messages when we can.
2216 // TODO: Do some kind of timer to set the channel as !is_live()
2217 // as we don't really want others relying on us relaying through
2218 // this channel currently :/.
2224 HTLCForwardInfo::AddHTLC { .. } => {
2225 panic!("short_channel_id != 0 should imply any pending_forward entries are of type Forward");
2227 HTLCForwardInfo::FailHTLC { htlc_id, err_packet } => {
2228 log_trace!(self.logger, "Failing HTLC back to channel with short id {} (backward HTLC ID {}) after delay", short_chan_id, htlc_id);
2229 match chan.get_mut().get_update_fail_htlc(htlc_id, err_packet, &self.logger) {
2231 if let ChannelError::Ignore(msg) = e {
2232 log_trace!(self.logger, "Failed to fail HTLC with ID {} backwards to short_id {}: {}", htlc_id, short_chan_id, msg);
2234 panic!("Stated return value requirements in get_update_fail_htlc() were not met");
2236 // fail-backs are best-effort, we probably already have one
2237 // pending, and if not that's OK, if not, the channel is on
2238 // the chain and sending the HTLC-Timeout is their problem.
2241 Ok(Some(msg)) => { fail_htlc_msgs.push(msg); },
2243 // Nothing to do here...we're waiting on a remote
2244 // revoke_and_ack before we can update the commitment
2245 // transaction. The Channel will automatically handle
2246 // building the update_fail_htlc and commitment_signed
2247 // messages when we can.
2248 // We don't need any kind of timer here as they should fail
2249 // the channel onto the chain if they can't get our
2250 // update_fail_htlc in time, it's not our problem.
2257 if !add_htlc_msgs.is_empty() || !fail_htlc_msgs.is_empty() {
2258 let (commitment_msg, monitor_update) = match chan.get_mut().send_commitment(&self.logger) {
2261 // We surely failed send_commitment due to bad keys, in that case
2262 // close channel and then send error message to peer.
2263 let counterparty_node_id = chan.get().get_counterparty_node_id();
2264 let err: Result<(), _> = match e {
2265 ChannelError::Ignore(_) => {
2266 panic!("Stated return value requirements in send_commitment() were not met");
2268 ChannelError::Close(msg) => {
2269 log_trace!(self.logger, "Closing channel {} due to Close-required error: {}", log_bytes!(chan.key()[..]), msg);
2270 let (channel_id, mut channel) = chan.remove_entry();
2271 if let Some(short_id) = channel.get_short_channel_id() {
2272 channel_state.short_to_id.remove(&short_id);
2274 Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, channel.force_shutdown(true), self.get_channel_update_for_broadcast(&channel).ok()))
2276 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"); }
2278 handle_errors.push((counterparty_node_id, err));
2282 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
2283 handle_errors.push((chan.get().get_counterparty_node_id(), handle_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, true)));
2286 log_debug!(self.logger, "Forwarding HTLCs resulted in a commitment update with {} HTLCs added and {} HTLCs failed for channel {}",
2287 add_htlc_msgs.len(), fail_htlc_msgs.len(), log_bytes!(chan.get().channel_id()));
2288 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2289 node_id: chan.get().get_counterparty_node_id(),
2290 updates: msgs::CommitmentUpdate {
2291 update_add_htlcs: add_htlc_msgs,
2292 update_fulfill_htlcs: Vec::new(),
2293 update_fail_htlcs: fail_htlc_msgs,
2294 update_fail_malformed_htlcs: Vec::new(),
2296 commitment_signed: commitment_msg,
2304 for forward_info in pending_forwards.drain(..) {
2305 match forward_info {
2306 HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info: PendingHTLCInfo {
2307 routing, incoming_shared_secret, payment_hash, amt_to_forward, .. },
2308 prev_funding_outpoint } => {
2309 let (cltv_expiry, onion_payload) = match routing {
2310 PendingHTLCRouting::Receive { payment_data, incoming_cltv_expiry } =>
2311 (incoming_cltv_expiry, OnionPayload::Invoice(payment_data)),
2312 PendingHTLCRouting::ReceiveKeysend { payment_preimage, incoming_cltv_expiry } =>
2313 (incoming_cltv_expiry, OnionPayload::Spontaneous(payment_preimage)),
2315 panic!("short_channel_id == 0 should imply any pending_forward entries are of type Receive");
2318 let claimable_htlc = ClaimableHTLC {
2319 prev_hop: HTLCPreviousHopData {
2320 short_channel_id: prev_short_channel_id,
2321 outpoint: prev_funding_outpoint,
2322 htlc_id: prev_htlc_id,
2323 incoming_packet_shared_secret: incoming_shared_secret,
2325 value: amt_to_forward,
2330 macro_rules! fail_htlc {
2332 let mut htlc_msat_height_data = byte_utils::be64_to_array($htlc.value).to_vec();
2333 htlc_msat_height_data.extend_from_slice(
2334 &byte_utils::be32_to_array(self.best_block.read().unwrap().height()),
2336 failed_forwards.push((HTLCSource::PreviousHopData(HTLCPreviousHopData {
2337 short_channel_id: $htlc.prev_hop.short_channel_id,
2338 outpoint: prev_funding_outpoint,
2339 htlc_id: $htlc.prev_hop.htlc_id,
2340 incoming_packet_shared_secret: $htlc.prev_hop.incoming_packet_shared_secret,
2342 HTLCFailReason::Reason { failure_code: 0x4000 | 15, data: htlc_msat_height_data }
2347 // Check that the payment hash and secret are known. Note that we
2348 // MUST take care to handle the "unknown payment hash" and
2349 // "incorrect payment secret" cases here identically or we'd expose
2350 // that we are the ultimate recipient of the given payment hash.
2351 // Further, we must not expose whether we have any other HTLCs
2352 // associated with the same payment_hash pending or not.
2353 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
2354 match payment_secrets.entry(payment_hash) {
2355 hash_map::Entry::Vacant(_) => {
2356 match claimable_htlc.onion_payload {
2357 OnionPayload::Invoice(_) => {
2358 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as we didn't have a corresponding inbound payment.", log_bytes!(payment_hash.0));
2359 fail_htlc!(claimable_htlc);
2361 OnionPayload::Spontaneous(preimage) => {
2362 match channel_state.claimable_htlcs.entry(payment_hash) {
2363 hash_map::Entry::Vacant(e) => {
2364 e.insert(vec![claimable_htlc]);
2365 new_events.push(events::Event::PaymentReceived {
2367 amt: amt_to_forward,
2368 purpose: events::PaymentPurpose::SpontaneousPayment(preimage),
2371 hash_map::Entry::Occupied(_) => {
2372 log_trace!(self.logger, "Failing new keysend HTLC with payment_hash {} for a duplicative payment hash", log_bytes!(payment_hash.0));
2373 fail_htlc!(claimable_htlc);
2379 hash_map::Entry::Occupied(inbound_payment) => {
2381 if let OnionPayload::Invoice(ref data) = claimable_htlc.onion_payload {
2384 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));
2385 fail_htlc!(claimable_htlc);
2388 if inbound_payment.get().payment_secret != payment_data.payment_secret {
2389 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our expected payment secret.", log_bytes!(payment_hash.0));
2390 fail_htlc!(claimable_htlc);
2391 } else if inbound_payment.get().min_value_msat.is_some() && payment_data.total_msat < inbound_payment.get().min_value_msat.unwrap() {
2392 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our minimum value (had {}, needed {}).",
2393 log_bytes!(payment_hash.0), payment_data.total_msat, inbound_payment.get().min_value_msat.unwrap());
2394 fail_htlc!(claimable_htlc);
2396 let mut total_value = 0;
2397 let htlcs = channel_state.claimable_htlcs.entry(payment_hash)
2398 .or_insert(Vec::new());
2399 if htlcs.len() == 1 {
2400 if let OnionPayload::Spontaneous(_) = htlcs[0].onion_payload {
2401 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));
2402 fail_htlc!(claimable_htlc);
2406 htlcs.push(claimable_htlc);
2407 for htlc in htlcs.iter() {
2408 total_value += htlc.value;
2409 match &htlc.onion_payload {
2410 OnionPayload::Invoice(htlc_payment_data) => {
2411 if htlc_payment_data.total_msat != payment_data.total_msat {
2412 log_trace!(self.logger, "Failing HTLCs with payment_hash {} as the HTLCs had inconsistent total values (eg {} and {})",
2413 log_bytes!(payment_hash.0), payment_data.total_msat, htlc_payment_data.total_msat);
2414 total_value = msgs::MAX_VALUE_MSAT;
2416 if total_value >= msgs::MAX_VALUE_MSAT { break; }
2418 _ => unreachable!(),
2421 if total_value >= msgs::MAX_VALUE_MSAT || total_value > payment_data.total_msat {
2422 log_trace!(self.logger, "Failing HTLCs with payment_hash {} as the total value {} ran over expected value {} (or HTLCs were inconsistent)",
2423 log_bytes!(payment_hash.0), total_value, payment_data.total_msat);
2424 for htlc in htlcs.iter() {
2427 } else if total_value == payment_data.total_msat {
2428 new_events.push(events::Event::PaymentReceived {
2430 purpose: events::PaymentPurpose::InvoicePayment {
2431 payment_preimage: inbound_payment.get().payment_preimage,
2432 payment_secret: payment_data.payment_secret,
2433 user_payment_id: inbound_payment.get().user_payment_id,
2437 // Only ever generate at most one PaymentReceived
2438 // per registered payment_hash, even if it isn't
2440 inbound_payment.remove_entry();
2442 // Nothing to do - we haven't reached the total
2443 // payment value yet, wait until we receive more
2450 HTLCForwardInfo::FailHTLC { .. } => {
2451 panic!("Got pending fail of our own HTLC");
2459 for (htlc_source, payment_hash, failure_reason) in failed_forwards.drain(..) {
2460 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source, &payment_hash, failure_reason);
2463 for (counterparty_node_id, err) in handle_errors.drain(..) {
2464 let _ = handle_error!(self, err, counterparty_node_id);
2467 if new_events.is_empty() { return }
2468 let mut events = self.pending_events.lock().unwrap();
2469 events.append(&mut new_events);
2472 /// Free the background events, generally called from timer_tick_occurred.
2474 /// Exposed for testing to allow us to process events quickly without generating accidental
2475 /// BroadcastChannelUpdate events in timer_tick_occurred.
2477 /// Expects the caller to have a total_consistency_lock read lock.
2478 fn process_background_events(&self) -> bool {
2479 let mut background_events = Vec::new();
2480 mem::swap(&mut *self.pending_background_events.lock().unwrap(), &mut background_events);
2481 if background_events.is_empty() {
2485 for event in background_events.drain(..) {
2487 BackgroundEvent::ClosingMonitorUpdate((funding_txo, update)) => {
2488 // The channel has already been closed, so no use bothering to care about the
2489 // monitor updating completing.
2490 let _ = self.chain_monitor.update_channel(funding_txo, update);
2497 #[cfg(any(test, feature = "_test_utils"))]
2498 /// Process background events, for functional testing
2499 pub fn test_process_background_events(&self) {
2500 self.process_background_events();
2503 /// If a peer is disconnected we mark any channels with that peer as 'disabled'.
2504 /// After some time, if channels are still disabled we need to broadcast a ChannelUpdate
2505 /// to inform the network about the uselessness of these channels.
2507 /// This method handles all the details, and must be called roughly once per minute.
2509 /// Note that in some rare cases this may generate a `chain::Watch::update_channel` call.
2510 pub fn timer_tick_occurred(&self) {
2511 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
2512 let mut should_persist = NotifyOption::SkipPersist;
2513 if self.process_background_events() { should_persist = NotifyOption::DoPersist; }
2515 let mut channel_state_lock = self.channel_state.lock().unwrap();
2516 let channel_state = &mut *channel_state_lock;
2517 for (_, chan) in channel_state.by_id.iter_mut() {
2518 match chan.channel_update_status() {
2519 ChannelUpdateStatus::Enabled if !chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::DisabledStaged),
2520 ChannelUpdateStatus::Disabled if chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::EnabledStaged),
2521 ChannelUpdateStatus::DisabledStaged if chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::Enabled),
2522 ChannelUpdateStatus::EnabledStaged if !chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::Disabled),
2523 ChannelUpdateStatus::DisabledStaged if !chan.is_live() => {
2524 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
2525 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2529 should_persist = NotifyOption::DoPersist;
2530 chan.set_channel_update_status(ChannelUpdateStatus::Disabled);
2532 ChannelUpdateStatus::EnabledStaged if chan.is_live() => {
2533 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
2534 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2538 should_persist = NotifyOption::DoPersist;
2539 chan.set_channel_update_status(ChannelUpdateStatus::Enabled);
2549 /// Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
2550 /// after a PaymentReceived event, failing the HTLC back to its origin and freeing resources
2551 /// along the path (including in our own channel on which we received it).
2552 /// Returns false if no payment was found to fail backwards, true if the process of failing the
2553 /// HTLC backwards has been started.
2554 pub fn fail_htlc_backwards(&self, payment_hash: &PaymentHash) -> bool {
2555 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2557 let mut channel_state = Some(self.channel_state.lock().unwrap());
2558 let removed_source = channel_state.as_mut().unwrap().claimable_htlcs.remove(payment_hash);
2559 if let Some(mut sources) = removed_source {
2560 for htlc in sources.drain(..) {
2561 if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
2562 let mut htlc_msat_height_data = byte_utils::be64_to_array(htlc.value).to_vec();
2563 htlc_msat_height_data.extend_from_slice(&byte_utils::be32_to_array(
2564 self.best_block.read().unwrap().height()));
2565 self.fail_htlc_backwards_internal(channel_state.take().unwrap(),
2566 HTLCSource::PreviousHopData(htlc.prev_hop), payment_hash,
2567 HTLCFailReason::Reason { failure_code: 0x4000 | 15, data: htlc_msat_height_data });
2573 // Fail a list of HTLCs that were just freed from the holding cell. The HTLCs need to be
2574 // failed backwards or, if they were one of our outgoing HTLCs, then their failure needs to
2575 // be surfaced to the user.
2576 fn fail_holding_cell_htlcs(&self, mut htlcs_to_fail: Vec<(HTLCSource, PaymentHash)>, channel_id: [u8; 32]) {
2577 for (htlc_src, payment_hash) in htlcs_to_fail.drain(..) {
2579 HTLCSource::PreviousHopData(HTLCPreviousHopData { .. }) => {
2580 let (failure_code, onion_failure_data) =
2581 match self.channel_state.lock().unwrap().by_id.entry(channel_id) {
2582 hash_map::Entry::Occupied(chan_entry) => {
2583 if let Ok(upd) = self.get_channel_update_for_unicast(&chan_entry.get()) {
2584 (0x1000|7, upd.encode_with_len())
2586 (0x4000|10, Vec::new())
2589 hash_map::Entry::Vacant(_) => (0x4000|10, Vec::new())
2591 let channel_state = self.channel_state.lock().unwrap();
2592 self.fail_htlc_backwards_internal(channel_state,
2593 htlc_src, &payment_hash, HTLCFailReason::Reason { failure_code, data: onion_failure_data});
2595 HTLCSource::OutboundRoute { session_priv, .. } => {
2597 let mut session_priv_bytes = [0; 32];
2598 session_priv_bytes.copy_from_slice(&session_priv[..]);
2599 self.pending_outbound_payments.lock().unwrap().remove(&session_priv_bytes)
2601 self.pending_events.lock().unwrap().push(
2602 events::Event::PaymentFailed {
2604 rejected_by_dest: false,
2612 log_trace!(self.logger, "Received duplicative fail for HTLC with payment_hash {}", log_bytes!(payment_hash.0));
2619 /// Fails an HTLC backwards to the sender of it to us.
2620 /// Note that while we take a channel_state lock as input, we do *not* assume consistency here.
2621 /// There are several callsites that do stupid things like loop over a list of payment_hashes
2622 /// to fail and take the channel_state lock for each iteration (as we take ownership and may
2623 /// drop it). In other words, no assumptions are made that entries in claimable_htlcs point to
2624 /// still-available channels.
2625 fn fail_htlc_backwards_internal(&self, mut channel_state_lock: MutexGuard<ChannelHolder<Signer>>, source: HTLCSource, payment_hash: &PaymentHash, onion_error: HTLCFailReason) {
2626 //TODO: There is a timing attack here where if a node fails an HTLC back to us they can
2627 //identify whether we sent it or not based on the (I presume) very different runtime
2628 //between the branches here. We should make this async and move it into the forward HTLCs
2631 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
2632 // from block_connected which may run during initialization prior to the chain_monitor
2633 // being fully configured. See the docs for `ChannelManagerReadArgs` for more.
2635 HTLCSource::OutboundRoute { ref path, session_priv, .. } => {
2637 let mut session_priv_bytes = [0; 32];
2638 session_priv_bytes.copy_from_slice(&session_priv[..]);
2639 !self.pending_outbound_payments.lock().unwrap().remove(&session_priv_bytes)
2641 log_trace!(self.logger, "Received duplicative fail for HTLC with payment_hash {}", log_bytes!(payment_hash.0));
2644 log_trace!(self.logger, "Failing outbound payment HTLC with payment_hash {}", log_bytes!(payment_hash.0));
2645 mem::drop(channel_state_lock);
2646 match &onion_error {
2647 &HTLCFailReason::LightningError { ref err } => {
2649 let (channel_update, payment_retryable, onion_error_code, onion_error_data) = onion_utils::process_onion_failure(&self.secp_ctx, &self.logger, &source, err.data.clone());
2651 let (channel_update, payment_retryable, _, _) = onion_utils::process_onion_failure(&self.secp_ctx, &self.logger, &source, err.data.clone());
2652 // TODO: If we decided to blame ourselves (or one of our channels) in
2653 // process_onion_failure we should close that channel as it implies our
2654 // next-hop is needlessly blaming us!
2655 if let Some(update) = channel_update {
2656 self.channel_state.lock().unwrap().pending_msg_events.push(
2657 events::MessageSendEvent::PaymentFailureNetworkUpdate {
2662 self.pending_events.lock().unwrap().push(
2663 events::Event::PaymentFailed {
2664 payment_hash: payment_hash.clone(),
2665 rejected_by_dest: !payment_retryable,
2667 error_code: onion_error_code,
2669 error_data: onion_error_data
2673 &HTLCFailReason::Reason {
2679 // we get a fail_malformed_htlc from the first hop
2680 // TODO: We'd like to generate a PaymentFailureNetworkUpdate for temporary
2681 // failures here, but that would be insufficient as get_route
2682 // generally ignores its view of our own channels as we provide them via
2684 // TODO: For non-temporary failures, we really should be closing the
2685 // channel here as we apparently can't relay through them anyway.
2686 self.pending_events.lock().unwrap().push(
2687 events::Event::PaymentFailed {
2688 payment_hash: payment_hash.clone(),
2689 rejected_by_dest: path.len() == 1,
2691 error_code: Some(*failure_code),
2693 error_data: Some(data.clone()),
2699 HTLCSource::PreviousHopData(HTLCPreviousHopData { short_channel_id, htlc_id, incoming_packet_shared_secret, .. }) => {
2700 let err_packet = match onion_error {
2701 HTLCFailReason::Reason { failure_code, data } => {
2702 log_trace!(self.logger, "Failing HTLC with payment_hash {} backwards from us with code {}", log_bytes!(payment_hash.0), failure_code);
2703 let packet = onion_utils::build_failure_packet(&incoming_packet_shared_secret, failure_code, &data[..]).encode();
2704 onion_utils::encrypt_failure_packet(&incoming_packet_shared_secret, &packet)
2706 HTLCFailReason::LightningError { err } => {
2707 log_trace!(self.logger, "Failing HTLC with payment_hash {} backwards with pre-built LightningError", log_bytes!(payment_hash.0));
2708 onion_utils::encrypt_failure_packet(&incoming_packet_shared_secret, &err.data)
2712 let mut forward_event = None;
2713 if channel_state_lock.forward_htlcs.is_empty() {
2714 forward_event = Some(Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS));
2716 match channel_state_lock.forward_htlcs.entry(short_channel_id) {
2717 hash_map::Entry::Occupied(mut entry) => {
2718 entry.get_mut().push(HTLCForwardInfo::FailHTLC { htlc_id, err_packet });
2720 hash_map::Entry::Vacant(entry) => {
2721 entry.insert(vec!(HTLCForwardInfo::FailHTLC { htlc_id, err_packet }));
2724 mem::drop(channel_state_lock);
2725 if let Some(time) = forward_event {
2726 let mut pending_events = self.pending_events.lock().unwrap();
2727 pending_events.push(events::Event::PendingHTLCsForwardable {
2728 time_forwardable: time
2735 /// Provides a payment preimage in response to a PaymentReceived event, returning true and
2736 /// generating message events for the net layer to claim the payment, if possible. Thus, you
2737 /// should probably kick the net layer to go send messages if this returns true!
2739 /// Note that if you did not set an `amount_msat` when calling [`create_inbound_payment`] or
2740 /// [`create_inbound_payment_for_hash`] you must check that the amount in the `PaymentReceived`
2741 /// event matches your expectation. If you fail to do so and call this method, you may provide
2742 /// the sender "proof-of-payment" when they did not fulfill the full expected payment.
2744 /// May panic if called except in response to a PaymentReceived event.
2746 /// [`create_inbound_payment`]: Self::create_inbound_payment
2747 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
2748 pub fn claim_funds(&self, payment_preimage: PaymentPreimage) -> bool {
2749 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
2751 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2753 let mut channel_state = Some(self.channel_state.lock().unwrap());
2754 let removed_source = channel_state.as_mut().unwrap().claimable_htlcs.remove(&payment_hash);
2755 if let Some(mut sources) = removed_source {
2756 assert!(!sources.is_empty());
2758 // If we are claiming an MPP payment, we have to take special care to ensure that each
2759 // channel exists before claiming all of the payments (inside one lock).
2760 // Note that channel existance is sufficient as we should always get a monitor update
2761 // which will take care of the real HTLC claim enforcement.
2763 // If we find an HTLC which we would need to claim but for which we do not have a
2764 // channel, we will fail all parts of the MPP payment. While we could wait and see if
2765 // the sender retries the already-failed path(s), it should be a pretty rare case where
2766 // we got all the HTLCs and then a channel closed while we were waiting for the user to
2767 // provide the preimage, so worrying too much about the optimal handling isn't worth
2769 let mut valid_mpp = true;
2770 for htlc in sources.iter() {
2771 if let None = channel_state.as_ref().unwrap().short_to_id.get(&htlc.prev_hop.short_channel_id) {
2777 let mut errs = Vec::new();
2778 let mut claimed_any_htlcs = false;
2779 for htlc in sources.drain(..) {
2781 if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
2782 let mut htlc_msat_height_data = byte_utils::be64_to_array(htlc.value).to_vec();
2783 htlc_msat_height_data.extend_from_slice(&byte_utils::be32_to_array(
2784 self.best_block.read().unwrap().height()));
2785 self.fail_htlc_backwards_internal(channel_state.take().unwrap(),
2786 HTLCSource::PreviousHopData(htlc.prev_hop), &payment_hash,
2787 HTLCFailReason::Reason { failure_code: 0x4000|15, data: htlc_msat_height_data });
2789 match self.claim_funds_from_hop(channel_state.as_mut().unwrap(), htlc.prev_hop, payment_preimage) {
2791 if let msgs::ErrorAction::IgnoreError = e.1.err.action {
2792 // We got a temporary failure updating monitor, but will claim the
2793 // HTLC when the monitor updating is restored (or on chain).
2794 log_error!(self.logger, "Temporary failure claiming HTLC, treating as success: {}", e.1.err.err);
2795 claimed_any_htlcs = true;
2796 } else { errs.push(e); }
2798 Err(None) => unreachable!("We already checked for channel existence, we can't fail here!"),
2799 Ok(()) => claimed_any_htlcs = true,
2804 // Now that we've done the entire above loop in one lock, we can handle any errors
2805 // which were generated.
2806 channel_state.take();
2808 for (counterparty_node_id, err) in errs.drain(..) {
2809 let res: Result<(), _> = Err(err);
2810 let _ = handle_error!(self, res, counterparty_node_id);
2817 fn claim_funds_from_hop(&self, channel_state_lock: &mut MutexGuard<ChannelHolder<Signer>>, prev_hop: HTLCPreviousHopData, payment_preimage: PaymentPreimage) -> Result<(), Option<(PublicKey, MsgHandleErrInternal)>> {
2818 //TODO: Delay the claimed_funds relaying just like we do outbound relay!
2819 let channel_state = &mut **channel_state_lock;
2820 let chan_id = match channel_state.short_to_id.get(&prev_hop.short_channel_id) {
2821 Some(chan_id) => chan_id.clone(),
2827 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(chan_id) {
2828 match chan.get_mut().get_update_fulfill_htlc_and_commit(prev_hop.htlc_id, payment_preimage, &self.logger) {
2829 Ok(msgs_monitor_option) => {
2830 if let UpdateFulfillCommitFetch::NewClaim { msgs, monitor_update } = msgs_monitor_option {
2831 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
2832 log_given_level!(self.logger, if e == ChannelMonitorUpdateErr::PermanentFailure { Level::Error } else { Level::Debug },
2833 "Failed to update channel monitor with preimage {:?}: {:?}",
2834 payment_preimage, e);
2836 chan.get().get_counterparty_node_id(),
2837 handle_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, msgs.is_some()).unwrap_err(),
2840 if let Some((msg, commitment_signed)) = msgs {
2841 log_debug!(self.logger, "Claiming funds for HTLC with preimage {} resulted in a commitment_signed for channel {}",
2842 log_bytes!(payment_preimage.0), log_bytes!(chan.get().channel_id()));
2843 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2844 node_id: chan.get().get_counterparty_node_id(),
2845 updates: msgs::CommitmentUpdate {
2846 update_add_htlcs: Vec::new(),
2847 update_fulfill_htlcs: vec![msg],
2848 update_fail_htlcs: Vec::new(),
2849 update_fail_malformed_htlcs: Vec::new(),
2858 Err((e, monitor_update)) => {
2859 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
2860 log_given_level!(self.logger, if e == ChannelMonitorUpdateErr::PermanentFailure { Level::Error } else { Level::Info },
2861 "Failed to update channel monitor with preimage {:?} immediately prior to force-close: {:?}",
2862 payment_preimage, e);
2864 let counterparty_node_id = chan.get().get_counterparty_node_id();
2865 let (drop, res) = convert_chan_err!(self, e, channel_state.short_to_id, chan.get_mut(), &chan_id);
2867 chan.remove_entry();
2869 return Err(Some((counterparty_node_id, res)));
2872 } else { unreachable!(); }
2875 fn claim_funds_internal(&self, mut channel_state_lock: MutexGuard<ChannelHolder<Signer>>, source: HTLCSource, payment_preimage: PaymentPreimage) {
2877 HTLCSource::OutboundRoute { session_priv, .. } => {
2878 mem::drop(channel_state_lock);
2880 let mut session_priv_bytes = [0; 32];
2881 session_priv_bytes.copy_from_slice(&session_priv[..]);
2882 self.pending_outbound_payments.lock().unwrap().remove(&session_priv_bytes)
2884 let mut pending_events = self.pending_events.lock().unwrap();
2885 pending_events.push(events::Event::PaymentSent {
2889 log_trace!(self.logger, "Received duplicative fulfill for HTLC with payment_preimage {}", log_bytes!(payment_preimage.0));
2892 HTLCSource::PreviousHopData(hop_data) => {
2893 let prev_outpoint = hop_data.outpoint;
2894 if let Err((counterparty_node_id, err)) = match self.claim_funds_from_hop(&mut channel_state_lock, hop_data, payment_preimage) {
2897 let preimage_update = ChannelMonitorUpdate {
2898 update_id: CLOSED_CHANNEL_UPDATE_ID,
2899 updates: vec![ChannelMonitorUpdateStep::PaymentPreimage {
2900 payment_preimage: payment_preimage.clone(),
2903 // We update the ChannelMonitor on the backward link, after
2904 // receiving an offchain preimage event from the forward link (the
2905 // event being update_fulfill_htlc).
2906 if let Err(e) = self.chain_monitor.update_channel(prev_outpoint, preimage_update) {
2907 log_error!(self.logger, "Critical error: failed to update channel monitor with preimage {:?}: {:?}",
2908 payment_preimage, e);
2912 Err(Some(res)) => Err(res),
2914 mem::drop(channel_state_lock);
2915 let res: Result<(), _> = Err(err);
2916 let _ = handle_error!(self, res, counterparty_node_id);
2922 /// Gets the node_id held by this ChannelManager
2923 pub fn get_our_node_id(&self) -> PublicKey {
2924 self.our_network_pubkey.clone()
2927 /// Restores a single, given channel to normal operation after a
2928 /// ChannelMonitorUpdateErr::TemporaryFailure was returned from a channel monitor update
2931 /// All ChannelMonitor updates up to and including highest_applied_update_id must have been
2932 /// fully committed in every copy of the given channels' ChannelMonitors.
2934 /// Note that there is no effect to calling with a highest_applied_update_id other than the
2935 /// current latest ChannelMonitorUpdate and one call to this function after multiple
2936 /// ChannelMonitorUpdateErr::TemporaryFailures is fine. The highest_applied_update_id field
2937 /// exists largely only to prevent races between this and concurrent update_monitor calls.
2939 /// Thus, the anticipated use is, at a high level:
2940 /// 1) You register a chain::Watch with this ChannelManager,
2941 /// 2) it stores each update to disk, and begins updating any remote (eg watchtower) copies of
2942 /// said ChannelMonitors as it can, returning ChannelMonitorUpdateErr::TemporaryFailures
2943 /// any time it cannot do so instantly,
2944 /// 3) update(s) are applied to each remote copy of a ChannelMonitor,
2945 /// 4) once all remote copies are updated, you call this function with the update_id that
2946 /// completed, and once it is the latest the Channel will be re-enabled.
2947 pub fn channel_monitor_updated(&self, funding_txo: &OutPoint, highest_applied_update_id: u64) {
2948 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2950 let chan_restoration_res;
2951 let mut pending_failures = {
2952 let mut channel_lock = self.channel_state.lock().unwrap();
2953 let channel_state = &mut *channel_lock;
2954 let mut channel = match channel_state.by_id.entry(funding_txo.to_channel_id()) {
2955 hash_map::Entry::Occupied(chan) => chan,
2956 hash_map::Entry::Vacant(_) => return,
2958 if !channel.get().is_awaiting_monitor_update() || channel.get().get_latest_monitor_update_id() != highest_applied_update_id {
2962 let (raa, commitment_update, order, pending_forwards, pending_failures, funding_broadcastable, funding_locked) = channel.get_mut().monitor_updating_restored(&self.logger);
2963 let channel_update = if funding_locked.is_some() && channel.get().is_usable() && !channel.get().should_announce() {
2964 // We only send a channel_update in the case where we are just now sending a
2965 // funding_locked and the channel is in a usable state. Further, we rely on the
2966 // normal announcement_signatures process to send a channel_update for public
2967 // channels, only generating a unicast channel_update if this is a private channel.
2968 Some(events::MessageSendEvent::SendChannelUpdate {
2969 node_id: channel.get().get_counterparty_node_id(),
2970 msg: self.get_channel_update_for_unicast(channel.get()).unwrap(),
2973 chan_restoration_res = handle_chan_restoration_locked!(self, channel_lock, channel_state, channel, raa, commitment_update, order, None, pending_forwards, funding_broadcastable, funding_locked);
2974 if let Some(upd) = channel_update {
2975 channel_state.pending_msg_events.push(upd);
2979 post_handle_chan_restoration!(self, chan_restoration_res);
2980 for failure in pending_failures.drain(..) {
2981 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), failure.0, &failure.1, failure.2);
2985 fn internal_open_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::OpenChannel) -> Result<(), MsgHandleErrInternal> {
2986 if msg.chain_hash != self.genesis_hash {
2987 return Err(MsgHandleErrInternal::send_err_msg_no_close("Unknown genesis block hash".to_owned(), msg.temporary_channel_id.clone()));
2990 let channel = Channel::new_from_req(&self.fee_estimator, &self.keys_manager, counterparty_node_id.clone(), their_features, msg, 0, &self.default_configuration)
2991 .map_err(|e| MsgHandleErrInternal::from_chan_no_close(e, msg.temporary_channel_id))?;
2992 let mut channel_state_lock = self.channel_state.lock().unwrap();
2993 let channel_state = &mut *channel_state_lock;
2994 match channel_state.by_id.entry(channel.channel_id()) {
2995 hash_map::Entry::Occupied(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("temporary_channel_id collision!".to_owned(), msg.temporary_channel_id.clone())),
2996 hash_map::Entry::Vacant(entry) => {
2997 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
2998 node_id: counterparty_node_id.clone(),
2999 msg: channel.get_accept_channel(),
3001 entry.insert(channel);
3007 fn internal_accept_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::AcceptChannel) -> Result<(), MsgHandleErrInternal> {
3008 let (value, output_script, user_id) = {
3009 let mut channel_lock = self.channel_state.lock().unwrap();
3010 let channel_state = &mut *channel_lock;
3011 match channel_state.by_id.entry(msg.temporary_channel_id) {
3012 hash_map::Entry::Occupied(mut chan) => {
3013 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3014 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.temporary_channel_id));
3016 try_chan_entry!(self, chan.get_mut().accept_channel(&msg, &self.default_configuration, their_features), channel_state, chan);
3017 (chan.get().get_value_satoshis(), chan.get().get_funding_redeemscript().to_v0_p2wsh(), chan.get().get_user_id())
3019 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.temporary_channel_id))
3022 let mut pending_events = self.pending_events.lock().unwrap();
3023 pending_events.push(events::Event::FundingGenerationReady {
3024 temporary_channel_id: msg.temporary_channel_id,
3025 channel_value_satoshis: value,
3027 user_channel_id: user_id,
3032 fn internal_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), MsgHandleErrInternal> {
3033 let ((funding_msg, monitor), mut chan) = {
3034 let best_block = *self.best_block.read().unwrap();
3035 let mut channel_lock = self.channel_state.lock().unwrap();
3036 let channel_state = &mut *channel_lock;
3037 match channel_state.by_id.entry(msg.temporary_channel_id.clone()) {
3038 hash_map::Entry::Occupied(mut chan) => {
3039 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3040 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.temporary_channel_id));
3042 (try_chan_entry!(self, chan.get_mut().funding_created(msg, best_block, &self.logger), channel_state, chan), chan.remove())
3044 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.temporary_channel_id))
3047 // Because we have exclusive ownership of the channel here we can release the channel_state
3048 // lock before watch_channel
3049 if let Err(e) = self.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor) {
3051 ChannelMonitorUpdateErr::PermanentFailure => {
3052 // Note that we reply with the new channel_id in error messages if we gave up on the
3053 // channel, not the temporary_channel_id. This is compatible with ourselves, but the
3054 // spec is somewhat ambiguous here. Not a huge deal since we'll send error messages for
3055 // any messages referencing a previously-closed channel anyway.
3056 // We do not do a force-close here as that would generate a monitor update for
3057 // a monitor that we didn't manage to store (and that we don't care about - we
3058 // don't respond with the funding_signed so the channel can never go on chain).
3059 let (_monitor_update, failed_htlcs) = chan.force_shutdown(true);
3060 assert!(failed_htlcs.is_empty());
3061 return Err(MsgHandleErrInternal::send_err_msg_no_close("ChannelMonitor storage failure".to_owned(), funding_msg.channel_id));
3063 ChannelMonitorUpdateErr::TemporaryFailure => {
3064 // There's no problem signing a counterparty's funding transaction if our monitor
3065 // hasn't persisted to disk yet - we can't lose money on a transaction that we haven't
3066 // accepted payment from yet. We do, however, need to wait to send our funding_locked
3067 // until we have persisted our monitor.
3068 chan.monitor_update_failed(false, false, Vec::new(), Vec::new());
3072 let mut channel_state_lock = self.channel_state.lock().unwrap();
3073 let channel_state = &mut *channel_state_lock;
3074 match channel_state.by_id.entry(funding_msg.channel_id) {
3075 hash_map::Entry::Occupied(_) => {
3076 return Err(MsgHandleErrInternal::send_err_msg_no_close("Already had channel with the new channel_id".to_owned(), funding_msg.channel_id))
3078 hash_map::Entry::Vacant(e) => {
3079 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
3080 node_id: counterparty_node_id.clone(),
3089 fn internal_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), MsgHandleErrInternal> {
3091 let best_block = *self.best_block.read().unwrap();
3092 let mut channel_lock = self.channel_state.lock().unwrap();
3093 let channel_state = &mut *channel_lock;
3094 match channel_state.by_id.entry(msg.channel_id) {
3095 hash_map::Entry::Occupied(mut chan) => {
3096 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3097 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3099 let (monitor, funding_tx) = match chan.get_mut().funding_signed(&msg, best_block, &self.logger) {
3100 Ok(update) => update,
3101 Err(e) => try_chan_entry!(self, Err(e), channel_state, chan),
3103 if let Err(e) = self.chain_monitor.watch_channel(chan.get().get_funding_txo().unwrap(), monitor) {
3104 return_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::RevokeAndACKFirst, false, false);
3108 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3111 log_info!(self.logger, "Broadcasting funding transaction with txid {}", funding_tx.txid());
3112 self.tx_broadcaster.broadcast_transaction(&funding_tx);
3116 fn internal_funding_locked(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingLocked) -> Result<(), MsgHandleErrInternal> {
3117 let mut channel_state_lock = self.channel_state.lock().unwrap();
3118 let channel_state = &mut *channel_state_lock;
3119 match channel_state.by_id.entry(msg.channel_id) {
3120 hash_map::Entry::Occupied(mut chan) => {
3121 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3122 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3124 try_chan_entry!(self, chan.get_mut().funding_locked(&msg, &self.logger), channel_state, chan);
3125 if let Some(announcement_sigs) = self.get_announcement_sigs(chan.get()) {
3126 log_trace!(self.logger, "Sending announcement_signatures for {} in response to funding_locked", log_bytes!(chan.get().channel_id()));
3127 // If we see locking block before receiving remote funding_locked, we broadcast our
3128 // announcement_sigs at remote funding_locked reception. If we receive remote
3129 // funding_locked before seeing locking block, we broadcast our announcement_sigs at locking
3130 // block connection. We should guanrantee to broadcast announcement_sigs to our peer whatever
3131 // the order of the events but our peer may not receive it due to disconnection. The specs
3132 // lacking an acknowledgement for announcement_sigs we may have to re-send them at peer
3133 // connection in the future if simultaneous misses by both peers due to network/hardware
3134 // failures is an issue. Note, to achieve its goal, only one of the announcement_sigs needs
3135 // to be received, from then sigs are going to be flood to the whole network.
3136 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
3137 node_id: counterparty_node_id.clone(),
3138 msg: announcement_sigs,
3140 } else if chan.get().is_usable() {
3141 channel_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
3142 node_id: counterparty_node_id.clone(),
3143 msg: self.get_channel_update_for_unicast(chan.get()).unwrap(),
3148 hash_map::Entry::Vacant(_) => Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3152 fn internal_shutdown(&self, counterparty_node_id: &PublicKey, their_features: &InitFeatures, msg: &msgs::Shutdown) -> Result<(), MsgHandleErrInternal> {
3153 let (mut dropped_htlcs, chan_option) = {
3154 let mut channel_state_lock = self.channel_state.lock().unwrap();
3155 let channel_state = &mut *channel_state_lock;
3157 match channel_state.by_id.entry(msg.channel_id.clone()) {
3158 hash_map::Entry::Occupied(mut chan_entry) => {
3159 if chan_entry.get().get_counterparty_node_id() != *counterparty_node_id {
3160 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3162 let (shutdown, closing_signed, dropped_htlcs) = try_chan_entry!(self, chan_entry.get_mut().shutdown(&self.fee_estimator, &their_features, &msg), channel_state, chan_entry);
3163 if let Some(msg) = shutdown {
3164 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
3165 node_id: counterparty_node_id.clone(),
3169 if let Some(msg) = closing_signed {
3170 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
3171 node_id: counterparty_node_id.clone(),
3175 if chan_entry.get().is_shutdown() {
3176 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
3177 channel_state.short_to_id.remove(&short_id);
3179 (dropped_htlcs, Some(chan_entry.remove_entry().1))
3180 } else { (dropped_htlcs, None) }
3182 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3185 for htlc_source in dropped_htlcs.drain(..) {
3186 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() });
3188 if let Some(chan) = chan_option {
3189 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
3190 let mut channel_state = self.channel_state.lock().unwrap();
3191 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
3199 fn internal_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<(), MsgHandleErrInternal> {
3200 let (tx, chan_option) = {
3201 let mut channel_state_lock = self.channel_state.lock().unwrap();
3202 let channel_state = &mut *channel_state_lock;
3203 match channel_state.by_id.entry(msg.channel_id.clone()) {
3204 hash_map::Entry::Occupied(mut chan_entry) => {
3205 if chan_entry.get().get_counterparty_node_id() != *counterparty_node_id {
3206 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3208 let (closing_signed, tx) = try_chan_entry!(self, chan_entry.get_mut().closing_signed(&self.fee_estimator, &msg), channel_state, chan_entry);
3209 if let Some(msg) = closing_signed {
3210 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
3211 node_id: counterparty_node_id.clone(),
3216 // We're done with this channel, we've got a signed closing transaction and
3217 // will send the closing_signed back to the remote peer upon return. This
3218 // also implies there are no pending HTLCs left on the channel, so we can
3219 // fully delete it from tracking (the channel monitor is still around to
3220 // watch for old state broadcasts)!
3221 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
3222 channel_state.short_to_id.remove(&short_id);
3224 (tx, Some(chan_entry.remove_entry().1))
3225 } else { (tx, None) }
3227 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3230 if let Some(broadcast_tx) = tx {
3231 log_info!(self.logger, "Broadcasting {}", log_tx!(broadcast_tx));
3232 self.tx_broadcaster.broadcast_transaction(&broadcast_tx);
3234 if let Some(chan) = chan_option {
3235 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
3236 let mut channel_state = self.channel_state.lock().unwrap();
3237 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
3245 fn internal_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), MsgHandleErrInternal> {
3246 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
3247 //determine the state of the payment based on our response/if we forward anything/the time
3248 //we take to respond. We should take care to avoid allowing such an attack.
3250 //TODO: There exists a further attack where a node may garble the onion data, forward it to
3251 //us repeatedly garbled in different ways, and compare our error messages, which are
3252 //encrypted with the same key. It's not immediately obvious how to usefully exploit that,
3253 //but we should prevent it anyway.
3255 let (pending_forward_info, mut channel_state_lock) = self.decode_update_add_htlc_onion(msg);
3256 let channel_state = &mut *channel_state_lock;
3258 match channel_state.by_id.entry(msg.channel_id) {
3259 hash_map::Entry::Occupied(mut chan) => {
3260 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3261 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3264 let create_pending_htlc_status = |chan: &Channel<Signer>, pending_forward_info: PendingHTLCStatus, error_code: u16| {
3265 // Ensure error_code has the UPDATE flag set, since by default we send a
3266 // channel update along as part of failing the HTLC.
3267 assert!((error_code & 0x1000) != 0);
3268 // If the update_add is completely bogus, the call will Err and we will close,
3269 // but if we've sent a shutdown and they haven't acknowledged it yet, we just
3270 // want to reject the new HTLC and fail it backwards instead of forwarding.
3271 match pending_forward_info {
3272 PendingHTLCStatus::Forward(PendingHTLCInfo { ref incoming_shared_secret, .. }) => {
3273 let reason = if let Ok(upd) = self.get_channel_update_for_unicast(chan) {
3274 onion_utils::build_first_hop_failure_packet(incoming_shared_secret, error_code, &{
3275 let mut res = Vec::with_capacity(8 + 128);
3276 // TODO: underspecified, follow https://github.com/lightningnetwork/lightning-rfc/issues/791
3277 res.extend_from_slice(&byte_utils::be16_to_array(0));
3278 res.extend_from_slice(&upd.encode_with_len()[..]);
3282 // The only case where we'd be unable to
3283 // successfully get a channel update is if the
3284 // channel isn't in the fully-funded state yet,
3285 // implying our counterparty is trying to route
3286 // payments over the channel back to themselves
3287 // (cause no one else should know the short_id
3288 // is a lightning channel yet). We should have
3289 // no problem just calling this
3290 // unknown_next_peer (0x4000|10).
3291 onion_utils::build_first_hop_failure_packet(incoming_shared_secret, 0x4000|10, &[])
3293 let msg = msgs::UpdateFailHTLC {
3294 channel_id: msg.channel_id,
3295 htlc_id: msg.htlc_id,
3298 PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msg))
3300 _ => pending_forward_info
3303 try_chan_entry!(self, chan.get_mut().update_add_htlc(&msg, pending_forward_info, create_pending_htlc_status, &self.logger), channel_state, chan);
3305 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3310 fn internal_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), MsgHandleErrInternal> {
3311 let mut channel_lock = self.channel_state.lock().unwrap();
3313 let channel_state = &mut *channel_lock;
3314 match channel_state.by_id.entry(msg.channel_id) {
3315 hash_map::Entry::Occupied(mut chan) => {
3316 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3317 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3319 try_chan_entry!(self, chan.get_mut().update_fulfill_htlc(&msg), channel_state, chan)
3321 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3324 self.claim_funds_internal(channel_lock, htlc_source, msg.payment_preimage.clone());
3328 fn internal_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), MsgHandleErrInternal> {
3329 let mut channel_lock = self.channel_state.lock().unwrap();
3330 let channel_state = &mut *channel_lock;
3331 match channel_state.by_id.entry(msg.channel_id) {
3332 hash_map::Entry::Occupied(mut chan) => {
3333 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3334 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3336 try_chan_entry!(self, chan.get_mut().update_fail_htlc(&msg, HTLCFailReason::LightningError { err: msg.reason.clone() }), channel_state, chan);
3338 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3343 fn internal_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), MsgHandleErrInternal> {
3344 let mut channel_lock = self.channel_state.lock().unwrap();
3345 let channel_state = &mut *channel_lock;
3346 match channel_state.by_id.entry(msg.channel_id) {
3347 hash_map::Entry::Occupied(mut chan) => {
3348 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3349 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3351 if (msg.failure_code & 0x8000) == 0 {
3352 let chan_err: ChannelError = ChannelError::Close("Got update_fail_malformed_htlc with BADONION not set".to_owned());
3353 try_chan_entry!(self, Err(chan_err), channel_state, chan);
3355 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);
3358 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3362 fn internal_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), MsgHandleErrInternal> {
3363 let mut channel_state_lock = self.channel_state.lock().unwrap();
3364 let channel_state = &mut *channel_state_lock;
3365 match channel_state.by_id.entry(msg.channel_id) {
3366 hash_map::Entry::Occupied(mut chan) => {
3367 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3368 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3370 let (revoke_and_ack, commitment_signed, closing_signed, monitor_update) =
3371 match chan.get_mut().commitment_signed(&msg, &self.fee_estimator, &self.logger) {
3372 Err((None, e)) => try_chan_entry!(self, Err(e), channel_state, chan),
3373 Err((Some(update), e)) => {
3374 assert!(chan.get().is_awaiting_monitor_update());
3375 let _ = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), update);
3376 try_chan_entry!(self, Err(e), channel_state, chan);
3381 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
3382 return_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::RevokeAndACKFirst, true, commitment_signed.is_some());
3383 //TODO: Rebroadcast closing_signed if present on monitor update restoration
3385 channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
3386 node_id: counterparty_node_id.clone(),
3387 msg: revoke_and_ack,
3389 if let Some(msg) = commitment_signed {
3390 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
3391 node_id: counterparty_node_id.clone(),
3392 updates: msgs::CommitmentUpdate {
3393 update_add_htlcs: Vec::new(),
3394 update_fulfill_htlcs: Vec::new(),
3395 update_fail_htlcs: Vec::new(),
3396 update_fail_malformed_htlcs: Vec::new(),
3398 commitment_signed: msg,
3402 if let Some(msg) = closing_signed {
3403 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
3404 node_id: counterparty_node_id.clone(),
3410 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3415 fn forward_htlcs(&self, per_source_pending_forwards: &mut [(u64, OutPoint, Vec<(PendingHTLCInfo, u64)>)]) {
3416 for &mut (prev_short_channel_id, prev_funding_outpoint, ref mut pending_forwards) in per_source_pending_forwards {
3417 let mut forward_event = None;
3418 if !pending_forwards.is_empty() {
3419 let mut channel_state = self.channel_state.lock().unwrap();
3420 if channel_state.forward_htlcs.is_empty() {
3421 forward_event = Some(Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS))
3423 for (forward_info, prev_htlc_id) in pending_forwards.drain(..) {
3424 match channel_state.forward_htlcs.entry(match forward_info.routing {
3425 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
3426 PendingHTLCRouting::Receive { .. } => 0,
3427 PendingHTLCRouting::ReceiveKeysend { .. } => 0,
3429 hash_map::Entry::Occupied(mut entry) => {
3430 entry.get_mut().push(HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_funding_outpoint,
3431 prev_htlc_id, forward_info });
3433 hash_map::Entry::Vacant(entry) => {
3434 entry.insert(vec!(HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_funding_outpoint,
3435 prev_htlc_id, forward_info }));
3440 match forward_event {
3442 let mut pending_events = self.pending_events.lock().unwrap();
3443 pending_events.push(events::Event::PendingHTLCsForwardable {
3444 time_forwardable: time
3452 fn internal_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), MsgHandleErrInternal> {
3453 let mut htlcs_to_fail = Vec::new();
3455 let mut channel_state_lock = self.channel_state.lock().unwrap();
3456 let channel_state = &mut *channel_state_lock;
3457 match channel_state.by_id.entry(msg.channel_id) {
3458 hash_map::Entry::Occupied(mut chan) => {
3459 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3460 break Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3462 let was_frozen_for_monitor = chan.get().is_awaiting_monitor_update();
3463 let (commitment_update, pending_forwards, pending_failures, closing_signed, monitor_update, htlcs_to_fail_in) =
3464 break_chan_entry!(self, chan.get_mut().revoke_and_ack(&msg, &self.fee_estimator, &self.logger), channel_state, chan);
3465 htlcs_to_fail = htlcs_to_fail_in;
3466 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
3467 if was_frozen_for_monitor {
3468 assert!(commitment_update.is_none() && closing_signed.is_none() && pending_forwards.is_empty() && pending_failures.is_empty());
3469 break Err(MsgHandleErrInternal::ignore_no_close("Previous monitor update failure prevented responses to RAA".to_owned()));
3471 if let Err(e) = handle_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, commitment_update.is_some(), pending_forwards, pending_failures) {
3473 } else { unreachable!(); }
3476 if let Some(updates) = commitment_update {
3477 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
3478 node_id: counterparty_node_id.clone(),
3482 if let Some(msg) = closing_signed {
3483 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
3484 node_id: counterparty_node_id.clone(),
3488 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()))
3490 hash_map::Entry::Vacant(_) => break Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3493 self.fail_holding_cell_htlcs(htlcs_to_fail, msg.channel_id);
3495 Ok((pending_forwards, mut pending_failures, short_channel_id, channel_outpoint)) => {
3496 for failure in pending_failures.drain(..) {
3497 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), failure.0, &failure.1, failure.2);
3499 self.forward_htlcs(&mut [(short_channel_id, channel_outpoint, pending_forwards)]);
3506 fn internal_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), MsgHandleErrInternal> {
3507 let mut channel_lock = self.channel_state.lock().unwrap();
3508 let channel_state = &mut *channel_lock;
3509 match channel_state.by_id.entry(msg.channel_id) {
3510 hash_map::Entry::Occupied(mut chan) => {
3511 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3512 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3514 try_chan_entry!(self, chan.get_mut().update_fee(&self.fee_estimator, &msg), channel_state, chan);
3516 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3521 fn internal_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), MsgHandleErrInternal> {
3522 let mut channel_state_lock = self.channel_state.lock().unwrap();
3523 let channel_state = &mut *channel_state_lock;
3525 match channel_state.by_id.entry(msg.channel_id) {
3526 hash_map::Entry::Occupied(mut chan) => {
3527 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3528 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3530 if !chan.get().is_usable() {
3531 return Err(MsgHandleErrInternal::from_no_close(LightningError{err: "Got an announcement_signatures before we were ready for it".to_owned(), action: msgs::ErrorAction::IgnoreError}));
3534 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
3535 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),
3536 // Note that announcement_signatures fails if the channel cannot be announced,
3537 // so get_channel_update_for_broadcast will never fail by the time we get here.
3538 update_msg: self.get_channel_update_for_broadcast(chan.get()).unwrap(),
3541 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3546 /// Returns ShouldPersist if anything changed, otherwise either SkipPersist or an Err.
3547 fn internal_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) -> Result<NotifyOption, MsgHandleErrInternal> {
3548 let mut channel_state_lock = self.channel_state.lock().unwrap();
3549 let channel_state = &mut *channel_state_lock;
3550 let chan_id = match channel_state.short_to_id.get(&msg.contents.short_channel_id) {
3551 Some(chan_id) => chan_id.clone(),
3553 // It's not a local channel
3554 return Ok(NotifyOption::SkipPersist)
3557 match channel_state.by_id.entry(chan_id) {
3558 hash_map::Entry::Occupied(mut chan) => {
3559 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3560 if chan.get().should_announce() {
3561 // If the announcement is about a channel of ours which is public, some
3562 // other peer may simply be forwarding all its gossip to us. Don't provide
3563 // a scary-looking error message and return Ok instead.
3564 return Ok(NotifyOption::SkipPersist);
3566 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));
3568 let were_node_one = self.get_our_node_id().serialize()[..] < chan.get().get_counterparty_node_id().serialize()[..];
3569 let msg_from_node_one = msg.contents.flags & 1 == 0;
3570 if were_node_one == msg_from_node_one {
3571 return Ok(NotifyOption::SkipPersist);
3573 try_chan_entry!(self, chan.get_mut().channel_update(&msg), channel_state, chan);
3576 hash_map::Entry::Vacant(_) => unreachable!()
3578 Ok(NotifyOption::DoPersist)
3581 fn internal_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<(), MsgHandleErrInternal> {
3582 let chan_restoration_res;
3583 let (htlcs_failed_forward, need_lnd_workaround) = {
3584 let mut channel_state_lock = self.channel_state.lock().unwrap();
3585 let channel_state = &mut *channel_state_lock;
3587 match channel_state.by_id.entry(msg.channel_id) {
3588 hash_map::Entry::Occupied(mut chan) => {
3589 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3590 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3592 // Currently, we expect all holding cell update_adds to be dropped on peer
3593 // disconnect, so Channel's reestablish will never hand us any holding cell
3594 // freed HTLCs to fail backwards. If in the future we no longer drop pending
3595 // add-HTLCs on disconnect, we may be handed HTLCs to fail backwards here.
3596 let (funding_locked, revoke_and_ack, commitment_update, monitor_update_opt, order, htlcs_failed_forward, shutdown) =
3597 try_chan_entry!(self, chan.get_mut().channel_reestablish(msg, &self.logger), channel_state, chan);
3598 let mut channel_update = None;
3599 if let Some(msg) = shutdown {
3600 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
3601 node_id: counterparty_node_id.clone(),
3604 } else if chan.get().is_usable() {
3605 // If the channel is in a usable state (ie the channel is not being shut
3606 // down), send a unicast channel_update to our counterparty to make sure
3607 // they have the latest channel parameters.
3608 channel_update = Some(events::MessageSendEvent::SendChannelUpdate {
3609 node_id: chan.get().get_counterparty_node_id(),
3610 msg: self.get_channel_update_for_unicast(chan.get()).unwrap(),
3613 let need_lnd_workaround = chan.get_mut().workaround_lnd_bug_4006.take();
3614 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);
3615 if let Some(upd) = channel_update {
3616 channel_state.pending_msg_events.push(upd);
3618 (htlcs_failed_forward, need_lnd_workaround)
3620 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3623 post_handle_chan_restoration!(self, chan_restoration_res);
3624 self.fail_holding_cell_htlcs(htlcs_failed_forward, msg.channel_id);
3626 if let Some(funding_locked_msg) = need_lnd_workaround {
3627 self.internal_funding_locked(counterparty_node_id, &funding_locked_msg)?;
3632 /// Begin Update fee process. Allowed only on an outbound channel.
3633 /// If successful, will generate a UpdateHTLCs event, so you should probably poll
3634 /// PeerManager::process_events afterwards.
3635 /// Note: This API is likely to change!
3636 /// (C-not exported) Cause its doc(hidden) anyway
3638 pub fn update_fee(&self, channel_id: [u8;32], feerate_per_kw: u32) -> Result<(), APIError> {
3639 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
3640 let counterparty_node_id;
3641 let err: Result<(), _> = loop {
3642 let mut channel_state_lock = self.channel_state.lock().unwrap();
3643 let channel_state = &mut *channel_state_lock;
3645 match channel_state.by_id.entry(channel_id) {
3646 hash_map::Entry::Vacant(_) => return Err(APIError::APIMisuseError{err: format!("Failed to find corresponding channel for id {}", channel_id.to_hex())}),
3647 hash_map::Entry::Occupied(mut chan) => {
3648 if !chan.get().is_outbound() {
3649 return Err(APIError::APIMisuseError{err: "update_fee cannot be sent for an inbound channel".to_owned()});
3651 if chan.get().is_awaiting_monitor_update() {
3652 return Err(APIError::MonitorUpdateFailed);
3654 if !chan.get().is_live() {
3655 return Err(APIError::ChannelUnavailable{err: "Channel is either not yet fully established or peer is currently disconnected".to_owned()});
3657 counterparty_node_id = chan.get().get_counterparty_node_id();
3658 if let Some((update_fee, commitment_signed, monitor_update)) =
3659 break_chan_entry!(self, chan.get_mut().send_update_fee_and_commit(feerate_per_kw, &self.logger), channel_state, chan)
3661 if let Err(_e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
3664 log_debug!(self.logger, "Updating fee resulted in a commitment_signed for channel {}", log_bytes!(chan.get().channel_id()));
3665 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
3666 node_id: chan.get().get_counterparty_node_id(),
3667 updates: msgs::CommitmentUpdate {
3668 update_add_htlcs: Vec::new(),
3669 update_fulfill_htlcs: Vec::new(),
3670 update_fail_htlcs: Vec::new(),
3671 update_fail_malformed_htlcs: Vec::new(),
3672 update_fee: Some(update_fee),
3682 match handle_error!(self, err, counterparty_node_id) {
3683 Ok(_) => unreachable!(),
3684 Err(e) => { Err(APIError::APIMisuseError { err: e.err })}
3688 /// Process pending events from the `chain::Watch`, returning whether any events were processed.
3689 fn process_pending_monitor_events(&self) -> bool {
3690 let mut failed_channels = Vec::new();
3691 let pending_monitor_events = self.chain_monitor.release_pending_monitor_events();
3692 let has_pending_monitor_events = !pending_monitor_events.is_empty();
3693 for monitor_event in pending_monitor_events {
3694 match monitor_event {
3695 MonitorEvent::HTLCEvent(htlc_update) => {
3696 if let Some(preimage) = htlc_update.payment_preimage {
3697 log_trace!(self.logger, "Claiming HTLC with preimage {} from our monitor", log_bytes!(preimage.0));
3698 self.claim_funds_internal(self.channel_state.lock().unwrap(), htlc_update.source, preimage);
3700 log_trace!(self.logger, "Failing HTLC with hash {} from our monitor", log_bytes!(htlc_update.payment_hash.0));
3701 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() });
3704 MonitorEvent::CommitmentTxBroadcasted(funding_outpoint) => {
3705 let mut channel_lock = self.channel_state.lock().unwrap();
3706 let channel_state = &mut *channel_lock;
3707 let by_id = &mut channel_state.by_id;
3708 let short_to_id = &mut channel_state.short_to_id;
3709 let pending_msg_events = &mut channel_state.pending_msg_events;
3710 if let Some(mut chan) = by_id.remove(&funding_outpoint.to_channel_id()) {
3711 if let Some(short_id) = chan.get_short_channel_id() {
3712 short_to_id.remove(&short_id);
3714 failed_channels.push(chan.force_shutdown(false));
3715 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
3716 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
3720 pending_msg_events.push(events::MessageSendEvent::HandleError {
3721 node_id: chan.get_counterparty_node_id(),
3722 action: msgs::ErrorAction::SendErrorMessage {
3723 msg: msgs::ErrorMessage { channel_id: chan.channel_id(), data: "Channel force-closed".to_owned() }
3731 for failure in failed_channels.drain(..) {
3732 self.finish_force_close_channel(failure);
3735 has_pending_monitor_events
3738 /// Check the holding cell in each channel and free any pending HTLCs in them if possible.
3739 /// Returns whether there were any updates such as if pending HTLCs were freed or a monitor
3740 /// update was applied.
3742 /// This should only apply to HTLCs which were added to the holding cell because we were
3743 /// waiting on a monitor update to finish. In that case, we don't want to free the holding cell
3744 /// directly in `channel_monitor_updated` as it may introduce deadlocks calling back into user
3745 /// code to inform them of a channel monitor update.
3746 fn check_free_holding_cells(&self) -> bool {
3747 let mut has_monitor_update = false;
3748 let mut failed_htlcs = Vec::new();
3749 let mut handle_errors = Vec::new();
3751 let mut channel_state_lock = self.channel_state.lock().unwrap();
3752 let channel_state = &mut *channel_state_lock;
3753 let by_id = &mut channel_state.by_id;
3754 let short_to_id = &mut channel_state.short_to_id;
3755 let pending_msg_events = &mut channel_state.pending_msg_events;
3757 by_id.retain(|channel_id, chan| {
3758 match chan.maybe_free_holding_cell_htlcs(&self.logger) {
3759 Ok((commitment_opt, holding_cell_failed_htlcs)) => {
3760 if !holding_cell_failed_htlcs.is_empty() {
3761 failed_htlcs.push((holding_cell_failed_htlcs, *channel_id));
3763 if let Some((commitment_update, monitor_update)) = commitment_opt {
3764 if let Err(e) = self.chain_monitor.update_channel(chan.get_funding_txo().unwrap(), monitor_update) {
3765 has_monitor_update = true;
3766 let (res, close_channel) = handle_monitor_err!(self, e, short_to_id, chan, RAACommitmentOrder::CommitmentFirst, false, true, Vec::new(), Vec::new(), channel_id);
3767 handle_errors.push((chan.get_counterparty_node_id(), res));
3768 if close_channel { return false; }
3770 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
3771 node_id: chan.get_counterparty_node_id(),
3772 updates: commitment_update,
3779 let (close_channel, res) = convert_chan_err!(self, e, short_to_id, chan, channel_id);
3780 handle_errors.push((chan.get_counterparty_node_id(), Err(res)));
3787 let has_update = has_monitor_update || !failed_htlcs.is_empty();
3788 for (failures, channel_id) in failed_htlcs.drain(..) {
3789 self.fail_holding_cell_htlcs(failures, channel_id);
3792 for (counterparty_node_id, err) in handle_errors.drain(..) {
3793 let _ = handle_error!(self, err, counterparty_node_id);
3799 /// Handle a list of channel failures during a block_connected or block_disconnected call,
3800 /// pushing the channel monitor update (if any) to the background events queue and removing the
3802 fn handle_init_event_channel_failures(&self, mut failed_channels: Vec<ShutdownResult>) {
3803 for mut failure in failed_channels.drain(..) {
3804 // Either a commitment transactions has been confirmed on-chain or
3805 // Channel::block_disconnected detected that the funding transaction has been
3806 // reorganized out of the main chain.
3807 // We cannot broadcast our latest local state via monitor update (as
3808 // Channel::force_shutdown tries to make us do) as we may still be in initialization,
3809 // so we track the update internally and handle it when the user next calls
3810 // timer_tick_occurred, guaranteeing we're running normally.
3811 if let Some((funding_txo, update)) = failure.0.take() {
3812 assert_eq!(update.updates.len(), 1);
3813 if let ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } = update.updates[0] {
3814 assert!(should_broadcast);
3815 } else { unreachable!(); }
3816 self.pending_background_events.lock().unwrap().push(BackgroundEvent::ClosingMonitorUpdate((funding_txo, update)));
3818 self.finish_force_close_channel(failure);
3822 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> {
3823 assert!(invoice_expiry_delta_secs <= 60*60*24*365); // Sadly bitcoin timestamps are u32s, so panic before 2106
3825 let payment_secret = PaymentSecret(self.keys_manager.get_secure_random_bytes());
3827 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
3828 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
3829 match payment_secrets.entry(payment_hash) {
3830 hash_map::Entry::Vacant(e) => {
3831 e.insert(PendingInboundPayment {
3832 payment_secret, min_value_msat, user_payment_id, payment_preimage,
3833 // We assume that highest_seen_timestamp is pretty close to the current time -
3834 // its updated when we receive a new block with the maximum time we've seen in
3835 // a header. It should never be more than two hours in the future.
3836 // Thus, we add two hours here as a buffer to ensure we absolutely
3837 // never fail a payment too early.
3838 // Note that we assume that received blocks have reasonably up-to-date
3840 expiry_time: self.highest_seen_timestamp.load(Ordering::Acquire) as u64 + invoice_expiry_delta_secs as u64 + 7200,
3843 hash_map::Entry::Occupied(_) => return Err(APIError::APIMisuseError { err: "Duplicate payment hash".to_owned() }),
3848 /// Gets a payment secret and payment hash for use in an invoice given to a third party wishing
3851 /// This differs from [`create_inbound_payment_for_hash`] only in that it generates the
3852 /// [`PaymentHash`] and [`PaymentPreimage`] for you, returning the first and storing the second.
3854 /// The [`PaymentPreimage`] will ultimately be returned to you in the [`PaymentReceived`], which
3855 /// will have the [`PaymentReceived::payment_preimage`] field filled in. That should then be
3856 /// passed directly to [`claim_funds`].
3858 /// See [`create_inbound_payment_for_hash`] for detailed documentation on behavior and requirements.
3860 /// [`claim_funds`]: Self::claim_funds
3861 /// [`PaymentReceived`]: events::Event::PaymentReceived
3862 /// [`PaymentReceived::payment_preimage`]: events::Event::PaymentReceived::payment_preimage
3863 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
3864 pub fn create_inbound_payment(&self, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32, user_payment_id: u64) -> (PaymentHash, PaymentSecret) {
3865 let payment_preimage = PaymentPreimage(self.keys_manager.get_secure_random_bytes());
3866 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
3869 self.set_payment_hash_secret_map(payment_hash, Some(payment_preimage), min_value_msat, invoice_expiry_delta_secs, user_payment_id)
3870 .expect("RNG Generated Duplicate PaymentHash"))
3873 /// Gets a [`PaymentSecret`] for a given [`PaymentHash`], for which the payment preimage is
3874 /// stored external to LDK.
3876 /// A [`PaymentReceived`] event will only be generated if the [`PaymentSecret`] matches a
3877 /// payment secret fetched via this method or [`create_inbound_payment`], and which is at least
3878 /// the `min_value_msat` provided here, if one is provided.
3880 /// The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) must be globally unique. This
3881 /// method may return an Err if another payment with the same payment_hash is still pending.
3883 /// `user_payment_id` will be provided back in [`PaymentPurpose::InvoicePayment::user_payment_id`] events to
3884 /// allow tracking of which events correspond with which calls to this and
3885 /// [`create_inbound_payment`]. `user_payment_id` has no meaning inside of LDK, it is simply
3886 /// copied to events and otherwise ignored. It may be used to correlate PaymentReceived events
3887 /// with invoice metadata stored elsewhere.
3889 /// `min_value_msat` should be set if the invoice being generated contains a value. Any payment
3890 /// received for the returned [`PaymentHash`] will be required to be at least `min_value_msat`
3891 /// before a [`PaymentReceived`] event will be generated, ensuring that we do not provide the
3892 /// sender "proof-of-payment" unless they have paid the required amount.
3894 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
3895 /// in excess of the current time. This should roughly match the expiry time set in the invoice.
3896 /// After this many seconds, we will remove the inbound payment, resulting in any attempts to
3897 /// pay the invoice failing. The BOLT spec suggests 3,600 secs as a default validity time for
3898 /// invoices when no timeout is set.
3900 /// Note that we use block header time to time-out pending inbound payments (with some margin
3901 /// to compensate for the inaccuracy of block header timestamps). Thus, in practice we will
3902 /// accept a payment and generate a [`PaymentReceived`] event for some time after the expiry.
3903 /// If you need exact expiry semantics, you should enforce them upon receipt of
3904 /// [`PaymentReceived`].
3906 /// Pending inbound payments are stored in memory and in serialized versions of this
3907 /// [`ChannelManager`]. If potentially unbounded numbers of inbound payments may exist and
3908 /// space is limited, you may wish to rate-limit inbound payment creation.
3910 /// May panic if `invoice_expiry_delta_secs` is greater than one year.
3912 /// Note that invoices generated for inbound payments should have their `min_final_cltv_expiry`
3913 /// set to at least [`MIN_FINAL_CLTV_EXPIRY`].
3915 /// [`create_inbound_payment`]: Self::create_inbound_payment
3916 /// [`PaymentReceived`]: events::Event::PaymentReceived
3917 /// [`PaymentPurpose::InvoicePayment::user_payment_id`]: events::PaymentPurpose::InvoicePayment::user_payment_id
3918 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> {
3919 self.set_payment_hash_secret_map(payment_hash, None, min_value_msat, invoice_expiry_delta_secs, user_payment_id)
3922 #[cfg(any(test, feature = "fuzztarget", feature = "_test_utils"))]
3923 pub fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
3924 let events = core::cell::RefCell::new(Vec::new());
3925 let event_handler = |event| events.borrow_mut().push(event);
3926 self.process_pending_events(&event_handler);
3931 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> MessageSendEventsProvider for ChannelManager<Signer, M, T, K, F, L>
3932 where M::Target: chain::Watch<Signer>,
3933 T::Target: BroadcasterInterface,
3934 K::Target: KeysInterface<Signer = Signer>,
3935 F::Target: FeeEstimator,
3938 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
3939 let events = RefCell::new(Vec::new());
3940 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
3941 let mut result = NotifyOption::SkipPersist;
3943 // TODO: This behavior should be documented. It's unintuitive that we query
3944 // ChannelMonitors when clearing other events.
3945 if self.process_pending_monitor_events() {
3946 result = NotifyOption::DoPersist;
3949 if self.check_free_holding_cells() {
3950 result = NotifyOption::DoPersist;
3953 let mut pending_events = Vec::new();
3954 let mut channel_state = self.channel_state.lock().unwrap();
3955 mem::swap(&mut pending_events, &mut channel_state.pending_msg_events);
3957 if !pending_events.is_empty() {
3958 events.replace(pending_events);
3967 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> EventsProvider for ChannelManager<Signer, M, T, K, F, L>
3969 M::Target: chain::Watch<Signer>,
3970 T::Target: BroadcasterInterface,
3971 K::Target: KeysInterface<Signer = Signer>,
3972 F::Target: FeeEstimator,
3975 /// Processes events that must be periodically handled.
3977 /// An [`EventHandler`] may safely call back to the provider in order to handle an event.
3978 /// However, it must not call [`Writeable::write`] as doing so would result in a deadlock.
3980 /// Pending events are persisted as part of [`ChannelManager`]. While these events are cleared
3981 /// when processed, an [`EventHandler`] must be able to handle previously seen events when
3982 /// restarting from an old state.
3983 fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler {
3984 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
3985 let mut result = NotifyOption::SkipPersist;
3987 // TODO: This behavior should be documented. It's unintuitive that we query
3988 // ChannelMonitors when clearing other events.
3989 if self.process_pending_monitor_events() {
3990 result = NotifyOption::DoPersist;
3993 let mut pending_events = std::mem::replace(&mut *self.pending_events.lock().unwrap(), vec![]);
3994 if !pending_events.is_empty() {
3995 result = NotifyOption::DoPersist;
3998 for event in pending_events.drain(..) {
3999 handler.handle_event(event);
4007 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> chain::Listen for ChannelManager<Signer, M, T, K, F, L>
4009 M::Target: chain::Watch<Signer>,
4010 T::Target: BroadcasterInterface,
4011 K::Target: KeysInterface<Signer = Signer>,
4012 F::Target: FeeEstimator,
4015 fn block_connected(&self, block: &Block, height: u32) {
4017 let best_block = self.best_block.read().unwrap();
4018 assert_eq!(best_block.block_hash(), block.header.prev_blockhash,
4019 "Blocks must be connected in chain-order - the connected header must build on the last connected header");
4020 assert_eq!(best_block.height(), height - 1,
4021 "Blocks must be connected in chain-order - the connected block height must be one greater than the previous height");
4024 let txdata: Vec<_> = block.txdata.iter().enumerate().collect();
4025 self.transactions_confirmed(&block.header, &txdata, height);
4026 self.best_block_updated(&block.header, height);
4029 fn block_disconnected(&self, header: &BlockHeader, height: u32) {
4030 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4031 let new_height = height - 1;
4033 let mut best_block = self.best_block.write().unwrap();
4034 assert_eq!(best_block.block_hash(), header.block_hash(),
4035 "Blocks must be disconnected in chain-order - the disconnected header must be the last connected header");
4036 assert_eq!(best_block.height(), height,
4037 "Blocks must be disconnected in chain-order - the disconnected block must have the correct height");
4038 *best_block = BestBlock::new(header.prev_blockhash, new_height)
4041 self.do_chain_event(Some(new_height), |channel| channel.best_block_updated(new_height, header.time, &self.logger));
4045 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> chain::Confirm for ChannelManager<Signer, M, T, K, F, L>
4047 M::Target: chain::Watch<Signer>,
4048 T::Target: BroadcasterInterface,
4049 K::Target: KeysInterface<Signer = Signer>,
4050 F::Target: FeeEstimator,
4053 fn transactions_confirmed(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
4054 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
4055 // during initialization prior to the chain_monitor being fully configured in some cases.
4056 // See the docs for `ChannelManagerReadArgs` for more.
4058 let block_hash = header.block_hash();
4059 log_trace!(self.logger, "{} transactions included in block {} at height {} provided", txdata.len(), block_hash, height);
4061 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4062 self.do_chain_event(Some(height), |channel| channel.transactions_confirmed(&block_hash, height, txdata, &self.logger).map(|a| (a, Vec::new())));
4065 fn best_block_updated(&self, header: &BlockHeader, height: u32) {
4066 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
4067 // during initialization prior to the chain_monitor being fully configured in some cases.
4068 // See the docs for `ChannelManagerReadArgs` for more.
4070 let block_hash = header.block_hash();
4071 log_trace!(self.logger, "New best block: {} at height {}", block_hash, height);
4073 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4075 *self.best_block.write().unwrap() = BestBlock::new(block_hash, height);
4077 self.do_chain_event(Some(height), |channel| channel.best_block_updated(height, header.time, &self.logger));
4079 macro_rules! max_time {
4080 ($timestamp: expr) => {
4082 // Update $timestamp to be the max of its current value and the block
4083 // timestamp. This should keep us close to the current time without relying on
4084 // having an explicit local time source.
4085 // Just in case we end up in a race, we loop until we either successfully
4086 // update $timestamp or decide we don't need to.
4087 let old_serial = $timestamp.load(Ordering::Acquire);
4088 if old_serial >= header.time as usize { break; }
4089 if $timestamp.compare_exchange(old_serial, header.time as usize, Ordering::AcqRel, Ordering::Relaxed).is_ok() {
4095 max_time!(self.last_node_announcement_serial);
4096 max_time!(self.highest_seen_timestamp);
4097 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
4098 payment_secrets.retain(|_, inbound_payment| {
4099 inbound_payment.expiry_time > header.time as u64
4103 fn get_relevant_txids(&self) -> Vec<Txid> {
4104 let channel_state = self.channel_state.lock().unwrap();
4105 let mut res = Vec::with_capacity(channel_state.short_to_id.len());
4106 for chan in channel_state.by_id.values() {
4107 if let Some(funding_txo) = chan.get_funding_txo() {
4108 res.push(funding_txo.txid);
4114 fn transaction_unconfirmed(&self, txid: &Txid) {
4115 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4116 self.do_chain_event(None, |channel| {
4117 if let Some(funding_txo) = channel.get_funding_txo() {
4118 if funding_txo.txid == *txid {
4119 channel.funding_transaction_unconfirmed(&self.logger).map(|_| (None, Vec::new()))
4120 } else { Ok((None, Vec::new())) }
4121 } else { Ok((None, Vec::new())) }
4126 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<Signer, M, T, K, F, L>
4128 M::Target: chain::Watch<Signer>,
4129 T::Target: BroadcasterInterface,
4130 K::Target: KeysInterface<Signer = Signer>,
4131 F::Target: FeeEstimator,
4134 /// Calls a function which handles an on-chain event (blocks dis/connected, transactions
4135 /// un/confirmed, etc) on each channel, handling any resulting errors or messages generated by
4137 fn do_chain_event<FN: Fn(&mut Channel<Signer>) -> Result<(Option<msgs::FundingLocked>, Vec<(HTLCSource, PaymentHash)>), msgs::ErrorMessage>>
4138 (&self, height_opt: Option<u32>, f: FN) {
4139 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
4140 // during initialization prior to the chain_monitor being fully configured in some cases.
4141 // See the docs for `ChannelManagerReadArgs` for more.
4143 let mut failed_channels = Vec::new();
4144 let mut timed_out_htlcs = Vec::new();
4146 let mut channel_lock = self.channel_state.lock().unwrap();
4147 let channel_state = &mut *channel_lock;
4148 let short_to_id = &mut channel_state.short_to_id;
4149 let pending_msg_events = &mut channel_state.pending_msg_events;
4150 channel_state.by_id.retain(|_, channel| {
4151 let res = f(channel);
4152 if let Ok((chan_res, mut timed_out_pending_htlcs)) = res {
4153 for (source, payment_hash) in timed_out_pending_htlcs.drain(..) {
4154 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
4155 timed_out_htlcs.push((source, payment_hash, HTLCFailReason::Reason {
4156 failure_code: 0x1000 | 14, // expiry_too_soon, or at least it is now
4160 if let Some(funding_locked) = chan_res {
4161 pending_msg_events.push(events::MessageSendEvent::SendFundingLocked {
4162 node_id: channel.get_counterparty_node_id(),
4163 msg: funding_locked,
4165 if let Some(announcement_sigs) = self.get_announcement_sigs(channel) {
4166 log_trace!(self.logger, "Sending funding_locked and announcement_signatures for {}", log_bytes!(channel.channel_id()));
4167 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
4168 node_id: channel.get_counterparty_node_id(),
4169 msg: announcement_sigs,
4171 } else if channel.is_usable() {
4172 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()));
4173 pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
4174 node_id: channel.get_counterparty_node_id(),
4175 msg: self.get_channel_update_for_unicast(channel).unwrap(),
4178 log_trace!(self.logger, "Sending funding_locked WITHOUT announcement_signatures for {}", log_bytes!(channel.channel_id()));
4180 short_to_id.insert(channel.get_short_channel_id().unwrap(), channel.channel_id());
4182 } else if let Err(e) = res {
4183 if let Some(short_id) = channel.get_short_channel_id() {
4184 short_to_id.remove(&short_id);
4186 // It looks like our counterparty went on-chain or funding transaction was
4187 // reorged out of the main chain. Close the channel.
4188 failed_channels.push(channel.force_shutdown(true));
4189 if let Ok(update) = self.get_channel_update_for_broadcast(&channel) {
4190 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
4194 pending_msg_events.push(events::MessageSendEvent::HandleError {
4195 node_id: channel.get_counterparty_node_id(),
4196 action: msgs::ErrorAction::SendErrorMessage { msg: e },
4203 if let Some(height) = height_opt {
4204 channel_state.claimable_htlcs.retain(|payment_hash, htlcs| {
4205 htlcs.retain(|htlc| {
4206 // If height is approaching the number of blocks we think it takes us to get
4207 // our commitment transaction confirmed before the HTLC expires, plus the
4208 // number of blocks we generally consider it to take to do a commitment update,
4209 // just give up on it and fail the HTLC.
4210 if height >= htlc.cltv_expiry - HTLC_FAIL_BACK_BUFFER {
4211 let mut htlc_msat_height_data = byte_utils::be64_to_array(htlc.value).to_vec();
4212 htlc_msat_height_data.extend_from_slice(&byte_utils::be32_to_array(height));
4213 timed_out_htlcs.push((HTLCSource::PreviousHopData(htlc.prev_hop.clone()), payment_hash.clone(), HTLCFailReason::Reason {
4214 failure_code: 0x4000 | 15,
4215 data: htlc_msat_height_data
4220 !htlcs.is_empty() // Only retain this entry if htlcs has at least one entry.
4225 self.handle_init_event_channel_failures(failed_channels);
4227 for (source, payment_hash, reason) in timed_out_htlcs.drain(..) {
4228 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), source, &payment_hash, reason);
4232 /// Blocks until ChannelManager needs to be persisted or a timeout is reached. It returns a bool
4233 /// indicating whether persistence is necessary. Only one listener on
4234 /// `await_persistable_update` or `await_persistable_update_timeout` is guaranteed to be woken
4236 /// Note that the feature `allow_wallclock_use` must be enabled to use this function.
4237 #[cfg(any(test, feature = "allow_wallclock_use"))]
4238 pub fn await_persistable_update_timeout(&self, max_wait: Duration) -> bool {
4239 self.persistence_notifier.wait_timeout(max_wait)
4242 /// Blocks until ChannelManager needs to be persisted. Only one listener on
4243 /// `await_persistable_update` or `await_persistable_update_timeout` is guaranteed to be woken
4245 pub fn await_persistable_update(&self) {
4246 self.persistence_notifier.wait()
4249 #[cfg(any(test, feature = "_test_utils"))]
4250 pub fn get_persistence_condvar_value(&self) -> bool {
4251 let mutcond = &self.persistence_notifier.persistence_lock;
4252 let &(ref mtx, _) = mutcond;
4253 let guard = mtx.lock().unwrap();
4257 /// Gets the latest best block which was connected either via the [`chain::Listen`] or
4258 /// [`chain::Confirm`] interfaces.
4259 pub fn current_best_block(&self) -> BestBlock {
4260 self.best_block.read().unwrap().clone()
4264 impl<Signer: Sign, M: Deref , T: Deref , K: Deref , F: Deref , L: Deref >
4265 ChannelMessageHandler for ChannelManager<Signer, M, T, K, F, L>
4266 where M::Target: chain::Watch<Signer>,
4267 T::Target: BroadcasterInterface,
4268 K::Target: KeysInterface<Signer = Signer>,
4269 F::Target: FeeEstimator,
4272 fn handle_open_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::OpenChannel) {
4273 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4274 let _ = handle_error!(self, self.internal_open_channel(counterparty_node_id, their_features, msg), *counterparty_node_id);
4277 fn handle_accept_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::AcceptChannel) {
4278 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4279 let _ = handle_error!(self, self.internal_accept_channel(counterparty_node_id, their_features, msg), *counterparty_node_id);
4282 fn handle_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) {
4283 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4284 let _ = handle_error!(self, self.internal_funding_created(counterparty_node_id, msg), *counterparty_node_id);
4287 fn handle_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) {
4288 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4289 let _ = handle_error!(self, self.internal_funding_signed(counterparty_node_id, msg), *counterparty_node_id);
4292 fn handle_funding_locked(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingLocked) {
4293 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4294 let _ = handle_error!(self, self.internal_funding_locked(counterparty_node_id, msg), *counterparty_node_id);
4297 fn handle_shutdown(&self, counterparty_node_id: &PublicKey, their_features: &InitFeatures, msg: &msgs::Shutdown) {
4298 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4299 let _ = handle_error!(self, self.internal_shutdown(counterparty_node_id, their_features, msg), *counterparty_node_id);
4302 fn handle_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
4303 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4304 let _ = handle_error!(self, self.internal_closing_signed(counterparty_node_id, msg), *counterparty_node_id);
4307 fn handle_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
4308 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4309 let _ = handle_error!(self, self.internal_update_add_htlc(counterparty_node_id, msg), *counterparty_node_id);
4312 fn handle_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
4313 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4314 let _ = handle_error!(self, self.internal_update_fulfill_htlc(counterparty_node_id, msg), *counterparty_node_id);
4317 fn handle_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
4318 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4319 let _ = handle_error!(self, self.internal_update_fail_htlc(counterparty_node_id, msg), *counterparty_node_id);
4322 fn handle_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
4323 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4324 let _ = handle_error!(self, self.internal_update_fail_malformed_htlc(counterparty_node_id, msg), *counterparty_node_id);
4327 fn handle_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
4328 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4329 let _ = handle_error!(self, self.internal_commitment_signed(counterparty_node_id, msg), *counterparty_node_id);
4332 fn handle_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
4333 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4334 let _ = handle_error!(self, self.internal_revoke_and_ack(counterparty_node_id, msg), *counterparty_node_id);
4337 fn handle_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) {
4338 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4339 let _ = handle_error!(self, self.internal_update_fee(counterparty_node_id, msg), *counterparty_node_id);
4342 fn handle_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
4343 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4344 let _ = handle_error!(self, self.internal_announcement_signatures(counterparty_node_id, msg), *counterparty_node_id);
4347 fn handle_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) {
4348 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
4349 if let Ok(persist) = handle_error!(self, self.internal_channel_update(counterparty_node_id, msg), *counterparty_node_id) {
4352 NotifyOption::SkipPersist
4357 fn handle_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
4358 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4359 let _ = handle_error!(self, self.internal_channel_reestablish(counterparty_node_id, msg), *counterparty_node_id);
4362 fn peer_disconnected(&self, counterparty_node_id: &PublicKey, no_connection_possible: bool) {
4363 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4364 let mut failed_channels = Vec::new();
4365 let mut no_channels_remain = true;
4367 let mut channel_state_lock = self.channel_state.lock().unwrap();
4368 let channel_state = &mut *channel_state_lock;
4369 let short_to_id = &mut channel_state.short_to_id;
4370 let pending_msg_events = &mut channel_state.pending_msg_events;
4371 if no_connection_possible {
4372 log_debug!(self.logger, "Failing all channels with {} due to no_connection_possible", log_pubkey!(counterparty_node_id));
4373 channel_state.by_id.retain(|_, chan| {
4374 if chan.get_counterparty_node_id() == *counterparty_node_id {
4375 if let Some(short_id) = chan.get_short_channel_id() {
4376 short_to_id.remove(&short_id);
4378 failed_channels.push(chan.force_shutdown(true));
4379 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
4380 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
4390 log_debug!(self.logger, "Marking channels with {} disconnected and generating channel_updates", log_pubkey!(counterparty_node_id));
4391 channel_state.by_id.retain(|_, chan| {
4392 if chan.get_counterparty_node_id() == *counterparty_node_id {
4393 chan.remove_uncommitted_htlcs_and_mark_paused(&self.logger);
4394 if chan.is_shutdown() {
4395 if let Some(short_id) = chan.get_short_channel_id() {
4396 short_to_id.remove(&short_id);
4400 no_channels_remain = false;
4406 pending_msg_events.retain(|msg| {
4408 &events::MessageSendEvent::SendAcceptChannel { ref node_id, .. } => node_id != counterparty_node_id,
4409 &events::MessageSendEvent::SendOpenChannel { ref node_id, .. } => node_id != counterparty_node_id,
4410 &events::MessageSendEvent::SendFundingCreated { ref node_id, .. } => node_id != counterparty_node_id,
4411 &events::MessageSendEvent::SendFundingSigned { ref node_id, .. } => node_id != counterparty_node_id,
4412 &events::MessageSendEvent::SendFundingLocked { ref node_id, .. } => node_id != counterparty_node_id,
4413 &events::MessageSendEvent::SendAnnouncementSignatures { ref node_id, .. } => node_id != counterparty_node_id,
4414 &events::MessageSendEvent::UpdateHTLCs { ref node_id, .. } => node_id != counterparty_node_id,
4415 &events::MessageSendEvent::SendRevokeAndACK { ref node_id, .. } => node_id != counterparty_node_id,
4416 &events::MessageSendEvent::SendClosingSigned { ref node_id, .. } => node_id != counterparty_node_id,
4417 &events::MessageSendEvent::SendShutdown { ref node_id, .. } => node_id != counterparty_node_id,
4418 &events::MessageSendEvent::SendChannelReestablish { ref node_id, .. } => node_id != counterparty_node_id,
4419 &events::MessageSendEvent::BroadcastChannelAnnouncement { .. } => true,
4420 &events::MessageSendEvent::BroadcastNodeAnnouncement { .. } => true,
4421 &events::MessageSendEvent::BroadcastChannelUpdate { .. } => true,
4422 &events::MessageSendEvent::SendChannelUpdate { ref node_id, .. } => node_id != counterparty_node_id,
4423 &events::MessageSendEvent::HandleError { ref node_id, .. } => node_id != counterparty_node_id,
4424 &events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => true,
4425 &events::MessageSendEvent::SendChannelRangeQuery { .. } => false,
4426 &events::MessageSendEvent::SendShortIdsQuery { .. } => false,
4427 &events::MessageSendEvent::SendReplyChannelRange { .. } => false,
4431 if no_channels_remain {
4432 self.per_peer_state.write().unwrap().remove(counterparty_node_id);
4435 for failure in failed_channels.drain(..) {
4436 self.finish_force_close_channel(failure);
4440 fn peer_connected(&self, counterparty_node_id: &PublicKey, init_msg: &msgs::Init) {
4441 log_debug!(self.logger, "Generating channel_reestablish events for {}", log_pubkey!(counterparty_node_id));
4443 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4446 let mut peer_state_lock = self.per_peer_state.write().unwrap();
4447 match peer_state_lock.entry(counterparty_node_id.clone()) {
4448 hash_map::Entry::Vacant(e) => {
4449 e.insert(Mutex::new(PeerState {
4450 latest_features: init_msg.features.clone(),
4453 hash_map::Entry::Occupied(e) => {
4454 e.get().lock().unwrap().latest_features = init_msg.features.clone();
4459 let mut channel_state_lock = self.channel_state.lock().unwrap();
4460 let channel_state = &mut *channel_state_lock;
4461 let pending_msg_events = &mut channel_state.pending_msg_events;
4462 channel_state.by_id.retain(|_, chan| {
4463 if chan.get_counterparty_node_id() == *counterparty_node_id {
4464 if !chan.have_received_message() {
4465 // If we created this (outbound) channel while we were disconnected from the
4466 // peer we probably failed to send the open_channel message, which is now
4467 // lost. We can't have had anything pending related to this channel, so we just
4471 pending_msg_events.push(events::MessageSendEvent::SendChannelReestablish {
4472 node_id: chan.get_counterparty_node_id(),
4473 msg: chan.get_channel_reestablish(&self.logger),
4479 //TODO: Also re-broadcast announcement_signatures
4482 fn handle_error(&self, counterparty_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
4483 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4485 if msg.channel_id == [0; 32] {
4486 for chan in self.list_channels() {
4487 if chan.counterparty.node_id == *counterparty_node_id {
4488 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
4489 let _ = self.force_close_channel_with_peer(&chan.channel_id, Some(counterparty_node_id));
4493 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
4494 let _ = self.force_close_channel_with_peer(&msg.channel_id, Some(counterparty_node_id));
4499 /// Used to signal to the ChannelManager persister that the manager needs to be re-persisted to
4500 /// disk/backups, through `await_persistable_update_timeout` and `await_persistable_update`.
4501 struct PersistenceNotifier {
4502 /// Users won't access the persistence_lock directly, but rather wait on its bool using
4503 /// `wait_timeout` and `wait`.
4504 persistence_lock: (Mutex<bool>, Condvar),
4507 impl PersistenceNotifier {
4510 persistence_lock: (Mutex::new(false), Condvar::new()),
4516 let &(ref mtx, ref cvar) = &self.persistence_lock;
4517 let mut guard = mtx.lock().unwrap();
4522 guard = cvar.wait(guard).unwrap();
4523 let result = *guard;
4531 #[cfg(any(test, feature = "allow_wallclock_use"))]
4532 fn wait_timeout(&self, max_wait: Duration) -> bool {
4533 let current_time = Instant::now();
4535 let &(ref mtx, ref cvar) = &self.persistence_lock;
4536 let mut guard = mtx.lock().unwrap();
4541 guard = cvar.wait_timeout(guard, max_wait).unwrap().0;
4542 // Due to spurious wakeups that can happen on `wait_timeout`, here we need to check if the
4543 // desired wait time has actually passed, and if not then restart the loop with a reduced wait
4544 // time. Note that this logic can be highly simplified through the use of
4545 // `Condvar::wait_while` and `Condvar::wait_timeout_while`, if and when our MSRV is raised to
4547 let elapsed = current_time.elapsed();
4548 let result = *guard;
4549 if result || elapsed >= max_wait {
4553 match max_wait.checked_sub(elapsed) {
4554 None => return result,
4560 // Signal to the ChannelManager persister that there are updates necessitating persisting to disk.
4562 let &(ref persist_mtx, ref cnd) = &self.persistence_lock;
4563 let mut persistence_lock = persist_mtx.lock().unwrap();
4564 *persistence_lock = true;
4565 mem::drop(persistence_lock);
4570 const SERIALIZATION_VERSION: u8 = 1;
4571 const MIN_SERIALIZATION_VERSION: u8 = 1;
4573 impl_writeable_tlv_based_enum!(PendingHTLCRouting,
4575 (0, onion_packet, required),
4576 (2, short_channel_id, required),
4579 (0, payment_data, required),
4580 (2, incoming_cltv_expiry, required),
4582 (2, ReceiveKeysend) => {
4583 (0, payment_preimage, required),
4584 (2, incoming_cltv_expiry, required),
4588 impl_writeable_tlv_based!(PendingHTLCInfo, {
4589 (0, routing, required),
4590 (2, incoming_shared_secret, required),
4591 (4, payment_hash, required),
4592 (6, amt_to_forward, required),
4593 (8, outgoing_cltv_value, required)
4596 impl_writeable_tlv_based_enum!(HTLCFailureMsg, ;
4600 impl_writeable_tlv_based_enum!(PendingHTLCStatus, ;
4605 impl_writeable_tlv_based!(HTLCPreviousHopData, {
4606 (0, short_channel_id, required),
4607 (2, outpoint, required),
4608 (4, htlc_id, required),
4609 (6, incoming_packet_shared_secret, required)
4612 impl Writeable for ClaimableHTLC {
4613 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
4614 let payment_data = match &self.onion_payload {
4615 OnionPayload::Invoice(data) => Some(data.clone()),
4618 let keysend_preimage = match self.onion_payload {
4619 OnionPayload::Invoice(_) => None,
4620 OnionPayload::Spontaneous(preimage) => Some(preimage.clone()),
4625 (0, self.prev_hop, required), (2, self.value, required),
4626 (4, payment_data, option), (6, self.cltv_expiry, required),
4627 (8, keysend_preimage, option),
4633 impl Readable for ClaimableHTLC {
4634 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
4635 let mut prev_hop = ::util::ser::OptionDeserWrapper(None);
4637 let mut payment_data: Option<msgs::FinalOnionHopData> = None;
4638 let mut cltv_expiry = 0;
4639 let mut keysend_preimage: Option<PaymentPreimage> = None;
4643 (0, prev_hop, required), (2, value, required),
4644 (4, payment_data, option), (6, cltv_expiry, required),
4645 (8, keysend_preimage, option)
4647 let onion_payload = match keysend_preimage {
4649 if payment_data.is_some() {
4650 return Err(DecodeError::InvalidValue)
4652 OnionPayload::Spontaneous(p)
4655 if payment_data.is_none() {
4656 return Err(DecodeError::InvalidValue)
4658 OnionPayload::Invoice(payment_data.unwrap())
4662 prev_hop: prev_hop.0.unwrap(),
4670 impl_writeable_tlv_based_enum!(HTLCSource,
4671 (0, OutboundRoute) => {
4672 (0, session_priv, required),
4673 (2, first_hop_htlc_msat, required),
4674 (4, path, vec_type),
4676 (1, PreviousHopData)
4679 impl_writeable_tlv_based_enum!(HTLCFailReason,
4680 (0, LightningError) => {
4684 (0, failure_code, required),
4685 (2, data, vec_type),
4689 impl_writeable_tlv_based_enum!(HTLCForwardInfo,
4691 (0, forward_info, required),
4692 (2, prev_short_channel_id, required),
4693 (4, prev_htlc_id, required),
4694 (6, prev_funding_outpoint, required),
4697 (0, htlc_id, required),
4698 (2, err_packet, required),
4702 impl_writeable_tlv_based!(PendingInboundPayment, {
4703 (0, payment_secret, required),
4704 (2, expiry_time, required),
4705 (4, user_payment_id, required),
4706 (6, payment_preimage, required),
4707 (8, min_value_msat, required),
4710 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> Writeable for ChannelManager<Signer, M, T, K, F, L>
4711 where M::Target: chain::Watch<Signer>,
4712 T::Target: BroadcasterInterface,
4713 K::Target: KeysInterface<Signer = Signer>,
4714 F::Target: FeeEstimator,
4717 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
4718 let _consistency_lock = self.total_consistency_lock.write().unwrap();
4720 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
4722 self.genesis_hash.write(writer)?;
4724 let best_block = self.best_block.read().unwrap();
4725 best_block.height().write(writer)?;
4726 best_block.block_hash().write(writer)?;
4729 let channel_state = self.channel_state.lock().unwrap();
4730 let mut unfunded_channels = 0;
4731 for (_, channel) in channel_state.by_id.iter() {
4732 if !channel.is_funding_initiated() {
4733 unfunded_channels += 1;
4736 ((channel_state.by_id.len() - unfunded_channels) as u64).write(writer)?;
4737 for (_, channel) in channel_state.by_id.iter() {
4738 if channel.is_funding_initiated() {
4739 channel.write(writer)?;
4743 (channel_state.forward_htlcs.len() as u64).write(writer)?;
4744 for (short_channel_id, pending_forwards) in channel_state.forward_htlcs.iter() {
4745 short_channel_id.write(writer)?;
4746 (pending_forwards.len() as u64).write(writer)?;
4747 for forward in pending_forwards {
4748 forward.write(writer)?;
4752 (channel_state.claimable_htlcs.len() as u64).write(writer)?;
4753 for (payment_hash, previous_hops) in channel_state.claimable_htlcs.iter() {
4754 payment_hash.write(writer)?;
4755 (previous_hops.len() as u64).write(writer)?;
4756 for htlc in previous_hops.iter() {
4757 htlc.write(writer)?;
4761 let per_peer_state = self.per_peer_state.write().unwrap();
4762 (per_peer_state.len() as u64).write(writer)?;
4763 for (peer_pubkey, peer_state_mutex) in per_peer_state.iter() {
4764 peer_pubkey.write(writer)?;
4765 let peer_state = peer_state_mutex.lock().unwrap();
4766 peer_state.latest_features.write(writer)?;
4769 let events = self.pending_events.lock().unwrap();
4770 (events.len() as u64).write(writer)?;
4771 for event in events.iter() {
4772 event.write(writer)?;
4775 let background_events = self.pending_background_events.lock().unwrap();
4776 (background_events.len() as u64).write(writer)?;
4777 for event in background_events.iter() {
4779 BackgroundEvent::ClosingMonitorUpdate((funding_txo, monitor_update)) => {
4781 funding_txo.write(writer)?;
4782 monitor_update.write(writer)?;
4787 (self.last_node_announcement_serial.load(Ordering::Acquire) as u32).write(writer)?;
4788 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
4790 let pending_inbound_payments = self.pending_inbound_payments.lock().unwrap();
4791 (pending_inbound_payments.len() as u64).write(writer)?;
4792 for (hash, pending_payment) in pending_inbound_payments.iter() {
4793 hash.write(writer)?;
4794 pending_payment.write(writer)?;
4797 let pending_outbound_payments = self.pending_outbound_payments.lock().unwrap();
4798 (pending_outbound_payments.len() as u64).write(writer)?;
4799 for session_priv in pending_outbound_payments.iter() {
4800 session_priv.write(writer)?;
4803 write_tlv_fields!(writer, {});
4809 /// Arguments for the creation of a ChannelManager that are not deserialized.
4811 /// At a high-level, the process for deserializing a ChannelManager and resuming normal operation
4813 /// 1) Deserialize all stored ChannelMonitors.
4814 /// 2) Deserialize the ChannelManager by filling in this struct and calling:
4815 /// <(BlockHash, ChannelManager)>::read(reader, args)
4816 /// This may result in closing some Channels if the ChannelMonitor is newer than the stored
4817 /// ChannelManager state to ensure no loss of funds. Thus, transactions may be broadcasted.
4818 /// 3) If you are not fetching full blocks, register all relevant ChannelMonitor outpoints the same
4819 /// way you would handle a `chain::Filter` call using ChannelMonitor::get_outputs_to_watch() and
4820 /// ChannelMonitor::get_funding_txo().
4821 /// 4) Reconnect blocks on your ChannelMonitors.
4822 /// 5) Disconnect/connect blocks on the ChannelManager.
4823 /// 6) Move the ChannelMonitors into your local chain::Watch.
4825 /// Note that the ordering of #4-6 is not of importance, however all three must occur before you
4826 /// call any other methods on the newly-deserialized ChannelManager.
4828 /// Note that because some channels may be closed during deserialization, it is critical that you
4829 /// always deserialize only the latest version of a ChannelManager and ChannelMonitors available to
4830 /// you. If you deserialize an old ChannelManager (during which force-closure transactions may be
4831 /// broadcast), and then later deserialize a newer version of the same ChannelManager (which will
4832 /// not force-close the same channels but consider them live), you may end up revoking a state for
4833 /// which you've already broadcasted the transaction.
4834 pub struct ChannelManagerReadArgs<'a, Signer: 'a + Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
4835 where M::Target: chain::Watch<Signer>,
4836 T::Target: BroadcasterInterface,
4837 K::Target: KeysInterface<Signer = Signer>,
4838 F::Target: FeeEstimator,
4841 /// The keys provider which will give us relevant keys. Some keys will be loaded during
4842 /// deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
4844 pub keys_manager: K,
4846 /// The fee_estimator for use in the ChannelManager in the future.
4848 /// No calls to the FeeEstimator will be made during deserialization.
4849 pub fee_estimator: F,
4850 /// The chain::Watch for use in the ChannelManager in the future.
4852 /// No calls to the chain::Watch will be made during deserialization. It is assumed that
4853 /// you have deserialized ChannelMonitors separately and will add them to your
4854 /// chain::Watch after deserializing this ChannelManager.
4855 pub chain_monitor: M,
4857 /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
4858 /// used to broadcast the latest local commitment transactions of channels which must be
4859 /// force-closed during deserialization.
4860 pub tx_broadcaster: T,
4861 /// The Logger for use in the ChannelManager and which may be used to log information during
4862 /// deserialization.
4864 /// Default settings used for new channels. Any existing channels will continue to use the
4865 /// runtime settings which were stored when the ChannelManager was serialized.
4866 pub default_config: UserConfig,
4868 /// A map from channel funding outpoints to ChannelMonitors for those channels (ie
4869 /// value.get_funding_txo() should be the key).
4871 /// If a monitor is inconsistent with the channel state during deserialization the channel will
4872 /// be force-closed using the data in the ChannelMonitor and the channel will be dropped. This
4873 /// is true for missing channels as well. If there is a monitor missing for which we find
4874 /// channel data Err(DecodeError::InvalidValue) will be returned.
4876 /// In such cases the latest local transactions will be sent to the tx_broadcaster included in
4879 /// (C-not exported) because we have no HashMap bindings
4880 pub channel_monitors: HashMap<OutPoint, &'a mut ChannelMonitor<Signer>>,
4883 impl<'a, Signer: 'a + Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
4884 ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>
4885 where M::Target: chain::Watch<Signer>,
4886 T::Target: BroadcasterInterface,
4887 K::Target: KeysInterface<Signer = Signer>,
4888 F::Target: FeeEstimator,
4891 /// Simple utility function to create a ChannelManagerReadArgs which creates the monitor
4892 /// HashMap for you. This is primarily useful for C bindings where it is not practical to
4893 /// populate a HashMap directly from C.
4894 pub fn new(keys_manager: K, fee_estimator: F, chain_monitor: M, tx_broadcaster: T, logger: L, default_config: UserConfig,
4895 mut channel_monitors: Vec<&'a mut ChannelMonitor<Signer>>) -> Self {
4897 keys_manager, fee_estimator, chain_monitor, tx_broadcaster, logger, default_config,
4898 channel_monitors: channel_monitors.drain(..).map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect()
4903 // Implement ReadableArgs for an Arc'd ChannelManager to make it a bit easier to work with the
4904 // SipmleArcChannelManager type:
4905 impl<'a, Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
4906 ReadableArgs<ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>> for (BlockHash, Arc<ChannelManager<Signer, M, T, K, F, L>>)
4907 where M::Target: chain::Watch<Signer>,
4908 T::Target: BroadcasterInterface,
4909 K::Target: KeysInterface<Signer = Signer>,
4910 F::Target: FeeEstimator,
4913 fn read<R: ::std::io::Read>(reader: &mut R, args: ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>) -> Result<Self, DecodeError> {
4914 let (blockhash, chan_manager) = <(BlockHash, ChannelManager<Signer, M, T, K, F, L>)>::read(reader, args)?;
4915 Ok((blockhash, Arc::new(chan_manager)))
4919 impl<'a, Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
4920 ReadableArgs<ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>> for (BlockHash, ChannelManager<Signer, M, T, K, F, L>)
4921 where M::Target: chain::Watch<Signer>,
4922 T::Target: BroadcasterInterface,
4923 K::Target: KeysInterface<Signer = Signer>,
4924 F::Target: FeeEstimator,
4927 fn read<R: ::std::io::Read>(reader: &mut R, mut args: ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>) -> Result<Self, DecodeError> {
4928 let _ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
4930 let genesis_hash: BlockHash = Readable::read(reader)?;
4931 let best_block_height: u32 = Readable::read(reader)?;
4932 let best_block_hash: BlockHash = Readable::read(reader)?;
4934 let mut failed_htlcs = Vec::new();
4936 let channel_count: u64 = Readable::read(reader)?;
4937 let mut funding_txo_set = HashSet::with_capacity(cmp::min(channel_count as usize, 128));
4938 let mut by_id = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
4939 let mut short_to_id = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
4940 for _ in 0..channel_count {
4941 let mut channel: Channel<Signer> = Channel::read(reader, &args.keys_manager)?;
4942 let funding_txo = channel.get_funding_txo().ok_or(DecodeError::InvalidValue)?;
4943 funding_txo_set.insert(funding_txo.clone());
4944 if let Some(ref mut monitor) = args.channel_monitors.get_mut(&funding_txo) {
4945 if channel.get_cur_holder_commitment_transaction_number() < monitor.get_cur_holder_commitment_number() ||
4946 channel.get_revoked_counterparty_commitment_transaction_number() < monitor.get_min_seen_secret() ||
4947 channel.get_cur_counterparty_commitment_transaction_number() < monitor.get_cur_counterparty_commitment_number() ||
4948 channel.get_latest_monitor_update_id() > monitor.get_latest_update_id() {
4949 // If the channel is ahead of the monitor, return InvalidValue:
4950 log_error!(args.logger, "A ChannelMonitor is stale compared to the current ChannelManager! This indicates a potentially-critical violation of the chain::Watch API!");
4951 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
4952 log_bytes!(channel.channel_id()), monitor.get_latest_update_id(), channel.get_latest_monitor_update_id());
4953 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
4954 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
4955 log_error!(args.logger, " Without the latest ChannelMonitor we cannot continue without risking funds.");
4956 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");
4957 return Err(DecodeError::InvalidValue);
4958 } else if channel.get_cur_holder_commitment_transaction_number() > monitor.get_cur_holder_commitment_number() ||
4959 channel.get_revoked_counterparty_commitment_transaction_number() > monitor.get_min_seen_secret() ||
4960 channel.get_cur_counterparty_commitment_transaction_number() > monitor.get_cur_counterparty_commitment_number() ||
4961 channel.get_latest_monitor_update_id() < monitor.get_latest_update_id() {
4962 // But if the channel is behind of the monitor, close the channel:
4963 let (_, mut new_failed_htlcs) = channel.force_shutdown(true);
4964 failed_htlcs.append(&mut new_failed_htlcs);
4965 monitor.broadcast_latest_holder_commitment_txn(&args.tx_broadcaster, &args.logger);
4967 if let Some(short_channel_id) = channel.get_short_channel_id() {
4968 short_to_id.insert(short_channel_id, channel.channel_id());
4970 by_id.insert(channel.channel_id(), channel);
4973 log_error!(args.logger, "Missing ChannelMonitor for channel {} needed by ChannelManager.", log_bytes!(channel.channel_id()));
4974 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
4975 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
4976 log_error!(args.logger, " Without the ChannelMonitor we cannot continue without risking funds.");
4977 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");
4978 return Err(DecodeError::InvalidValue);
4982 for (ref funding_txo, ref mut monitor) in args.channel_monitors.iter_mut() {
4983 if !funding_txo_set.contains(funding_txo) {
4984 monitor.broadcast_latest_holder_commitment_txn(&args.tx_broadcaster, &args.logger);
4988 const MAX_ALLOC_SIZE: usize = 1024 * 64;
4989 let forward_htlcs_count: u64 = Readable::read(reader)?;
4990 let mut forward_htlcs = HashMap::with_capacity(cmp::min(forward_htlcs_count as usize, 128));
4991 for _ in 0..forward_htlcs_count {
4992 let short_channel_id = Readable::read(reader)?;
4993 let pending_forwards_count: u64 = Readable::read(reader)?;
4994 let mut pending_forwards = Vec::with_capacity(cmp::min(pending_forwards_count as usize, MAX_ALLOC_SIZE/mem::size_of::<HTLCForwardInfo>()));
4995 for _ in 0..pending_forwards_count {
4996 pending_forwards.push(Readable::read(reader)?);
4998 forward_htlcs.insert(short_channel_id, pending_forwards);
5001 let claimable_htlcs_count: u64 = Readable::read(reader)?;
5002 let mut claimable_htlcs = HashMap::with_capacity(cmp::min(claimable_htlcs_count as usize, 128));
5003 for _ in 0..claimable_htlcs_count {
5004 let payment_hash = Readable::read(reader)?;
5005 let previous_hops_len: u64 = Readable::read(reader)?;
5006 let mut previous_hops = Vec::with_capacity(cmp::min(previous_hops_len as usize, MAX_ALLOC_SIZE/mem::size_of::<ClaimableHTLC>()));
5007 for _ in 0..previous_hops_len {
5008 previous_hops.push(Readable::read(reader)?);
5010 claimable_htlcs.insert(payment_hash, previous_hops);
5013 let peer_count: u64 = Readable::read(reader)?;
5014 let mut per_peer_state = HashMap::with_capacity(cmp::min(peer_count as usize, MAX_ALLOC_SIZE/mem::size_of::<(PublicKey, Mutex<PeerState>)>()));
5015 for _ in 0..peer_count {
5016 let peer_pubkey = Readable::read(reader)?;
5017 let peer_state = PeerState {
5018 latest_features: Readable::read(reader)?,
5020 per_peer_state.insert(peer_pubkey, Mutex::new(peer_state));
5023 let event_count: u64 = Readable::read(reader)?;
5024 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>()));
5025 for _ in 0..event_count {
5026 match MaybeReadable::read(reader)? {
5027 Some(event) => pending_events_read.push(event),
5032 let background_event_count: u64 = Readable::read(reader)?;
5033 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>()));
5034 for _ in 0..background_event_count {
5035 match <u8 as Readable>::read(reader)? {
5036 0 => pending_background_events_read.push(BackgroundEvent::ClosingMonitorUpdate((Readable::read(reader)?, Readable::read(reader)?))),
5037 _ => return Err(DecodeError::InvalidValue),
5041 let last_node_announcement_serial: u32 = Readable::read(reader)?;
5042 let highest_seen_timestamp: u32 = Readable::read(reader)?;
5044 let pending_inbound_payment_count: u64 = Readable::read(reader)?;
5045 let mut pending_inbound_payments: HashMap<PaymentHash, PendingInboundPayment> = HashMap::with_capacity(cmp::min(pending_inbound_payment_count as usize, MAX_ALLOC_SIZE/(3*32)));
5046 for _ in 0..pending_inbound_payment_count {
5047 if pending_inbound_payments.insert(Readable::read(reader)?, Readable::read(reader)?).is_some() {
5048 return Err(DecodeError::InvalidValue);
5052 let pending_outbound_payments_count: u64 = Readable::read(reader)?;
5053 let mut pending_outbound_payments: HashSet<[u8; 32]> = HashSet::with_capacity(cmp::min(pending_outbound_payments_count as usize, MAX_ALLOC_SIZE/32));
5054 for _ in 0..pending_outbound_payments_count {
5055 if !pending_outbound_payments.insert(Readable::read(reader)?) {
5056 return Err(DecodeError::InvalidValue);
5060 read_tlv_fields!(reader, {});
5062 let mut secp_ctx = Secp256k1::new();
5063 secp_ctx.seeded_randomize(&args.keys_manager.get_secure_random_bytes());
5065 let channel_manager = ChannelManager {
5067 fee_estimator: args.fee_estimator,
5068 chain_monitor: args.chain_monitor,
5069 tx_broadcaster: args.tx_broadcaster,
5071 best_block: RwLock::new(BestBlock::new(best_block_hash, best_block_height)),
5073 channel_state: Mutex::new(ChannelHolder {
5078 pending_msg_events: Vec::new(),
5080 pending_inbound_payments: Mutex::new(pending_inbound_payments),
5081 pending_outbound_payments: Mutex::new(pending_outbound_payments),
5083 our_network_key: args.keys_manager.get_node_secret(),
5084 our_network_pubkey: PublicKey::from_secret_key(&secp_ctx, &args.keys_manager.get_node_secret()),
5087 last_node_announcement_serial: AtomicUsize::new(last_node_announcement_serial as usize),
5088 highest_seen_timestamp: AtomicUsize::new(highest_seen_timestamp as usize),
5090 per_peer_state: RwLock::new(per_peer_state),
5092 pending_events: Mutex::new(pending_events_read),
5093 pending_background_events: Mutex::new(pending_background_events_read),
5094 total_consistency_lock: RwLock::new(()),
5095 persistence_notifier: PersistenceNotifier::new(),
5097 keys_manager: args.keys_manager,
5098 logger: args.logger,
5099 default_configuration: args.default_config,
5102 for htlc_source in failed_htlcs.drain(..) {
5103 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() });
5106 //TODO: Broadcast channel update for closed channels, but only after we've made a
5107 //connection or two.
5109 Ok((best_block_hash.clone(), channel_manager))
5115 use bitcoin::hashes::Hash;
5116 use bitcoin::hashes::sha256::Hash as Sha256;
5117 use core::sync::atomic::{AtomicBool, Ordering};
5118 use core::time::Duration;
5119 use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
5120 use ln::channelmanager::PersistenceNotifier;
5121 use ln::features::{InitFeatures, InvoiceFeatures};
5122 use ln::functional_test_utils::*;
5124 use ln::msgs::ChannelMessageHandler;
5125 use routing::router::{get_keysend_route, get_route};
5126 use util::events::{Event, MessageSendEvent, MessageSendEventsProvider};
5127 use util::test_utils;
5131 #[cfg(feature = "std")]
5133 fn test_wait_timeout() {
5134 let persistence_notifier = Arc::new(PersistenceNotifier::new());
5135 let thread_notifier = Arc::clone(&persistence_notifier);
5137 let exit_thread = Arc::new(AtomicBool::new(false));
5138 let exit_thread_clone = exit_thread.clone();
5139 thread::spawn(move || {
5141 let &(ref persist_mtx, ref cnd) = &thread_notifier.persistence_lock;
5142 let mut persistence_lock = persist_mtx.lock().unwrap();
5143 *persistence_lock = true;
5146 if exit_thread_clone.load(Ordering::SeqCst) {
5152 // Check that we can block indefinitely until updates are available.
5153 let _ = persistence_notifier.wait();
5155 // Check that the PersistenceNotifier will return after the given duration if updates are
5158 if persistence_notifier.wait_timeout(Duration::from_millis(100)) {
5163 exit_thread.store(true, Ordering::SeqCst);
5165 // Check that the PersistenceNotifier will return after the given duration even if no updates
5168 if !persistence_notifier.wait_timeout(Duration::from_millis(100)) {
5175 fn test_notify_limits() {
5176 // Check that a few cases which don't require the persistence of a new ChannelManager,
5177 // indeed, do not cause the persistence of a new ChannelManager.
5178 let chanmon_cfgs = create_chanmon_cfgs(3);
5179 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5180 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5181 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5183 // All nodes start with a persistable update pending as `create_network` connects each node
5184 // with all other nodes to make most tests simpler.
5185 assert!(nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
5186 assert!(nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
5187 assert!(nodes[2].node.await_persistable_update_timeout(Duration::from_millis(1)));
5189 let mut chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5191 // We check that the channel info nodes have doesn't change too early, even though we try
5192 // to connect messages with new values
5193 chan.0.contents.fee_base_msat *= 2;
5194 chan.1.contents.fee_base_msat *= 2;
5195 let node_a_chan_info = nodes[0].node.list_channels()[0].clone();
5196 let node_b_chan_info = nodes[1].node.list_channels()[0].clone();
5198 // The first two nodes (which opened a channel) should now require fresh persistence
5199 assert!(nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
5200 assert!(nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
5201 // ... but the last node should not.
5202 assert!(!nodes[2].node.await_persistable_update_timeout(Duration::from_millis(1)));
5203 // After persisting the first two nodes they should no longer need fresh persistence.
5204 assert!(!nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
5205 assert!(!nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
5207 // Node 3, unrelated to the only channel, shouldn't care if it receives a channel_update
5208 // about the channel.
5209 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.0);
5210 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.1);
5211 assert!(!nodes[2].node.await_persistable_update_timeout(Duration::from_millis(1)));
5213 // The nodes which are a party to the channel should also ignore messages from unrelated
5215 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
5216 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
5217 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
5218 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
5219 assert!(!nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
5220 assert!(!nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
5222 // At this point the channel info given by peers should still be the same.
5223 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
5224 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
5226 // An earlier version of handle_channel_update didn't check the directionality of the
5227 // update message and would always update the local fee info, even if our peer was
5228 // (spuriously) forwarding us our own channel_update.
5229 let as_node_one = nodes[0].node.get_our_node_id().serialize()[..] < nodes[1].node.get_our_node_id().serialize()[..];
5230 let as_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.0 } else { &chan.1 };
5231 let bs_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.1 } else { &chan.0 };
5233 // First deliver each peers' own message, checking that the node doesn't need to be
5234 // persisted and that its channel info remains the same.
5235 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &as_update);
5236 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &bs_update);
5237 assert!(!nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
5238 assert!(!nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
5239 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
5240 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
5242 // Finally, deliver the other peers' message, ensuring each node needs to be persisted and
5243 // the channel info has updated.
5244 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &bs_update);
5245 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &as_update);
5246 assert!(nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
5247 assert!(nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
5248 assert_ne!(nodes[0].node.list_channels()[0], node_a_chan_info);
5249 assert_ne!(nodes[1].node.list_channels()[0], node_b_chan_info);
5253 fn test_keysend_dup_hash_partial_mpp() {
5254 // Test that a keysend payment with a duplicate hash to an existing partial MPP payment fails as
5256 let chanmon_cfgs = create_chanmon_cfgs(2);
5257 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5258 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5259 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5260 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5261 let logger = test_utils::TestLogger::new();
5263 // First, send a partial MPP payment.
5264 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5265 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100_000, TEST_FINAL_CLTV, &logger).unwrap();
5266 let (payment_preimage, our_payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[1]);
5267 // Use the utility function send_payment_along_path to send the payment with MPP data which
5268 // indicates there are more HTLCs coming.
5269 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.
5270 nodes[0].node.send_payment_along_path(&route.paths[0], &our_payment_hash, &Some(payment_secret), 200_000, cur_height, &None).unwrap();
5271 check_added_monitors!(nodes[0], 1);
5272 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5273 assert_eq!(events.len(), 1);
5274 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false, None);
5276 // Next, send a keysend payment with the same payment_hash and make sure it fails.
5277 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage)).unwrap();
5278 check_added_monitors!(nodes[0], 1);
5279 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5280 assert_eq!(events.len(), 1);
5281 let ev = events.drain(..).next().unwrap();
5282 let payment_event = SendEvent::from_event(ev);
5283 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
5284 check_added_monitors!(nodes[1], 0);
5285 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
5286 expect_pending_htlcs_forwardable!(nodes[1]);
5287 expect_pending_htlcs_forwardable!(nodes[1]);
5288 check_added_monitors!(nodes[1], 1);
5289 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5290 assert!(updates.update_add_htlcs.is_empty());
5291 assert!(updates.update_fulfill_htlcs.is_empty());
5292 assert_eq!(updates.update_fail_htlcs.len(), 1);
5293 assert!(updates.update_fail_malformed_htlcs.is_empty());
5294 assert!(updates.update_fee.is_none());
5295 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5296 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
5297 expect_payment_failed!(nodes[0], our_payment_hash, true);
5299 // Send the second half of the original MPP payment.
5300 nodes[0].node.send_payment_along_path(&route.paths[0], &our_payment_hash, &Some(payment_secret), 200_000, cur_height, &None).unwrap();
5301 check_added_monitors!(nodes[0], 1);
5302 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5303 assert_eq!(events.len(), 1);
5304 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), true, None);
5306 // Claim the full MPP payment. Note that we can't use a test utility like
5307 // claim_funds_along_route because the ordering of the messages causes the second half of the
5308 // payment to be put in the holding cell, which confuses the test utilities. So we exchange the
5309 // lightning messages manually.
5310 assert!(nodes[1].node.claim_funds(payment_preimage));
5311 check_added_monitors!(nodes[1], 2);
5312 let bs_first_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5313 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_first_updates.update_fulfill_htlcs[0]);
5314 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_first_updates.commitment_signed);
5315 check_added_monitors!(nodes[0], 1);
5316 let (as_first_raa, as_first_cs) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5317 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_first_raa);
5318 check_added_monitors!(nodes[1], 1);
5319 let bs_second_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5320 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_first_cs);
5321 check_added_monitors!(nodes[1], 1);
5322 let bs_first_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
5323 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_second_updates.update_fulfill_htlcs[0]);
5324 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_updates.commitment_signed);
5325 check_added_monitors!(nodes[0], 1);
5326 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
5327 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
5328 let as_second_updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5329 check_added_monitors!(nodes[0], 1);
5330 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
5331 check_added_monitors!(nodes[1], 1);
5332 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_updates.commitment_signed);
5333 check_added_monitors!(nodes[1], 1);
5334 let bs_third_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
5335 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_third_raa);
5336 check_added_monitors!(nodes[0], 1);
5338 // There's an existing bug that generates a PaymentSent event for each MPP path, so handle that here.
5339 let events = nodes[0].node.get_and_clear_pending_events();
5341 Event::PaymentSent { payment_preimage: ref preimage } => {
5342 assert_eq!(payment_preimage, *preimage);
5344 _ => panic!("Unexpected event"),
5347 Event::PaymentSent { payment_preimage: ref preimage } => {
5348 assert_eq!(payment_preimage, *preimage);
5350 _ => panic!("Unexpected event"),
5355 fn test_keysend_dup_payment_hash() {
5356 // (1): Test that a keysend payment with a duplicate payment hash to an existing pending
5357 // outbound regular payment fails as expected.
5358 // (2): Test that a regular payment with a duplicate payment hash to an existing keysend payment
5359 // fails as expected.
5360 let chanmon_cfgs = create_chanmon_cfgs(2);
5361 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5362 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5363 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5364 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5365 let logger = test_utils::TestLogger::new();
5367 // To start (1), send a regular payment but don't claim it.
5368 let expected_route = [&nodes[1]];
5369 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &expected_route, 100_000);
5371 // Next, attempt a keysend payment and make sure it fails.
5372 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(), &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100_000, TEST_FINAL_CLTV, &logger).unwrap();
5373 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage)).unwrap();
5374 check_added_monitors!(nodes[0], 1);
5375 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5376 assert_eq!(events.len(), 1);
5377 let ev = events.drain(..).next().unwrap();
5378 let payment_event = SendEvent::from_event(ev);
5379 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
5380 check_added_monitors!(nodes[1], 0);
5381 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
5382 expect_pending_htlcs_forwardable!(nodes[1]);
5383 expect_pending_htlcs_forwardable!(nodes[1]);
5384 check_added_monitors!(nodes[1], 1);
5385 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5386 assert!(updates.update_add_htlcs.is_empty());
5387 assert!(updates.update_fulfill_htlcs.is_empty());
5388 assert_eq!(updates.update_fail_htlcs.len(), 1);
5389 assert!(updates.update_fail_malformed_htlcs.is_empty());
5390 assert!(updates.update_fee.is_none());
5391 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5392 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
5393 expect_payment_failed!(nodes[0], payment_hash, true);
5395 // Finally, claim the original payment.
5396 claim_payment(&nodes[0], &expected_route, payment_preimage);
5398 // To start (2), send a keysend payment but don't claim it.
5399 let payment_preimage = PaymentPreimage([42; 32]);
5400 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph.read().unwrap(), &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100_000, TEST_FINAL_CLTV, &logger).unwrap();
5401 let payment_hash = nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage)).unwrap();
5402 check_added_monitors!(nodes[0], 1);
5403 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5404 assert_eq!(events.len(), 1);
5405 let event = events.pop().unwrap();
5406 let path = vec![&nodes[1]];
5407 pass_along_path(&nodes[0], &path, 100_000, payment_hash, None, event, true, Some(payment_preimage));
5409 // Next, attempt a regular payment and make sure it fails.
5410 let payment_secret = PaymentSecret([43; 32]);
5411 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
5412 check_added_monitors!(nodes[0], 1);
5413 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5414 assert_eq!(events.len(), 1);
5415 let ev = events.drain(..).next().unwrap();
5416 let payment_event = SendEvent::from_event(ev);
5417 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
5418 check_added_monitors!(nodes[1], 0);
5419 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
5420 expect_pending_htlcs_forwardable!(nodes[1]);
5421 expect_pending_htlcs_forwardable!(nodes[1]);
5422 check_added_monitors!(nodes[1], 1);
5423 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5424 assert!(updates.update_add_htlcs.is_empty());
5425 assert!(updates.update_fulfill_htlcs.is_empty());
5426 assert_eq!(updates.update_fail_htlcs.len(), 1);
5427 assert!(updates.update_fail_malformed_htlcs.is_empty());
5428 assert!(updates.update_fee.is_none());
5429 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5430 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
5431 expect_payment_failed!(nodes[0], payment_hash, true);
5433 // Finally, succeed the keysend payment.
5434 claim_payment(&nodes[0], &expected_route, payment_preimage);
5438 fn test_keysend_hash_mismatch() {
5439 // Test that if we receive a keysend `update_add_htlc` msg, we fail as expected if the keysend
5440 // preimage doesn't match the msg's payment hash.
5441 let chanmon_cfgs = create_chanmon_cfgs(2);
5442 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5443 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5444 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5446 let payer_pubkey = nodes[0].node.get_our_node_id();
5447 let payee_pubkey = nodes[1].node.get_our_node_id();
5448 nodes[0].node.peer_connected(&payee_pubkey, &msgs::Init { features: InitFeatures::known() });
5449 nodes[1].node.peer_connected(&payer_pubkey, &msgs::Init { features: InitFeatures::known() });
5451 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
5452 let network_graph = nodes[0].net_graph_msg_handler.network_graph.read().unwrap();
5453 let first_hops = nodes[0].node.list_usable_channels();
5454 let route = get_keysend_route(&payer_pubkey, &network_graph, &payee_pubkey,
5455 Some(&first_hops.iter().collect::<Vec<_>>()), &vec![], 10000, 40,
5456 nodes[0].logger).unwrap();
5458 let test_preimage = PaymentPreimage([42; 32]);
5459 let mismatch_payment_hash = PaymentHash([43; 32]);
5460 let _ = nodes[0].node.send_payment_internal(&route, mismatch_payment_hash, &None, Some(test_preimage)).unwrap();
5461 check_added_monitors!(nodes[0], 1);
5463 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5464 assert_eq!(updates.update_add_htlcs.len(), 1);
5465 assert!(updates.update_fulfill_htlcs.is_empty());
5466 assert!(updates.update_fail_htlcs.is_empty());
5467 assert!(updates.update_fail_malformed_htlcs.is_empty());
5468 assert!(updates.update_fee.is_none());
5469 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5471 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Payment preimage didn't match payment hash".to_string(), 1);
5475 fn test_keysend_msg_with_secret_err() {
5476 // Test that we error as expected if we receive a keysend payment that includes a payment secret.
5477 let chanmon_cfgs = create_chanmon_cfgs(2);
5478 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5479 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5480 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5482 let payer_pubkey = nodes[0].node.get_our_node_id();
5483 let payee_pubkey = nodes[1].node.get_our_node_id();
5484 nodes[0].node.peer_connected(&payee_pubkey, &msgs::Init { features: InitFeatures::known() });
5485 nodes[1].node.peer_connected(&payer_pubkey, &msgs::Init { features: InitFeatures::known() });
5487 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
5488 let network_graph = nodes[0].net_graph_msg_handler.network_graph.read().unwrap();
5489 let first_hops = nodes[0].node.list_usable_channels();
5490 let route = get_keysend_route(&payer_pubkey, &network_graph, &payee_pubkey,
5491 Some(&first_hops.iter().collect::<Vec<_>>()), &vec![], 10000, 40,
5492 nodes[0].logger).unwrap();
5494 let test_preimage = PaymentPreimage([42; 32]);
5495 let test_secret = PaymentSecret([43; 32]);
5496 let payment_hash = PaymentHash(Sha256::hash(&test_preimage.0).into_inner());
5497 let _ = nodes[0].node.send_payment_internal(&route, payment_hash, &Some(test_secret), Some(test_preimage)).unwrap();
5498 check_added_monitors!(nodes[0], 1);
5500 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5501 assert_eq!(updates.update_add_htlcs.len(), 1);
5502 assert!(updates.update_fulfill_htlcs.is_empty());
5503 assert!(updates.update_fail_htlcs.is_empty());
5504 assert!(updates.update_fail_malformed_htlcs.is_empty());
5505 assert!(updates.update_fee.is_none());
5506 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5508 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "We don't support MPP keysend payments".to_string(), 1);
5512 #[cfg(all(any(test, feature = "_test_utils"), feature = "unstable"))]
5515 use chain::chainmonitor::ChainMonitor;
5516 use chain::channelmonitor::Persist;
5517 use chain::keysinterface::{KeysManager, InMemorySigner};
5518 use ln::channelmanager::{BestBlock, ChainParameters, ChannelManager, PaymentHash, PaymentPreimage};
5519 use ln::features::{InitFeatures, InvoiceFeatures};
5520 use ln::functional_test_utils::*;
5521 use ln::msgs::ChannelMessageHandler;
5522 use routing::network_graph::NetworkGraph;
5523 use routing::router::get_route;
5524 use util::test_utils;
5525 use util::config::UserConfig;
5526 use util::events::{Event, MessageSendEvent, MessageSendEventsProvider, PaymentPurpose};
5528 use bitcoin::hashes::Hash;
5529 use bitcoin::hashes::sha256::Hash as Sha256;
5530 use bitcoin::{Block, BlockHeader, Transaction, TxOut};
5532 use sync::{Arc, Mutex};
5536 struct NodeHolder<'a, P: Persist<InMemorySigner>> {
5537 node: &'a ChannelManager<InMemorySigner,
5538 &'a ChainMonitor<InMemorySigner, &'a test_utils::TestChainSource,
5539 &'a test_utils::TestBroadcaster, &'a test_utils::TestFeeEstimator,
5540 &'a test_utils::TestLogger, &'a P>,
5541 &'a test_utils::TestBroadcaster, &'a KeysManager,
5542 &'a test_utils::TestFeeEstimator, &'a test_utils::TestLogger>
5547 fn bench_sends(bench: &mut Bencher) {
5548 bench_two_sends(bench, test_utils::TestPersister::new(), test_utils::TestPersister::new());
5551 pub fn bench_two_sends<P: Persist<InMemorySigner>>(bench: &mut Bencher, persister_a: P, persister_b: P) {
5552 // Do a simple benchmark of sending a payment back and forth between two nodes.
5553 // Note that this is unrealistic as each payment send will require at least two fsync
5555 let network = bitcoin::Network::Testnet;
5556 let genesis_hash = bitcoin::blockdata::constants::genesis_block(network).header.block_hash();
5558 let tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), blocks: Arc::new(Mutex::new(Vec::new()))};
5559 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
5561 let mut config: UserConfig = Default::default();
5562 config.own_channel_config.minimum_depth = 1;
5564 let logger_a = test_utils::TestLogger::with_id("node a".to_owned());
5565 let chain_monitor_a = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_a);
5566 let seed_a = [1u8; 32];
5567 let keys_manager_a = KeysManager::new(&seed_a, 42, 42);
5568 let node_a = ChannelManager::new(&fee_estimator, &chain_monitor_a, &tx_broadcaster, &logger_a, &keys_manager_a, config.clone(), ChainParameters {
5570 best_block: BestBlock::from_genesis(network),
5572 let node_a_holder = NodeHolder { node: &node_a };
5574 let logger_b = test_utils::TestLogger::with_id("node a".to_owned());
5575 let chain_monitor_b = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_b);
5576 let seed_b = [2u8; 32];
5577 let keys_manager_b = KeysManager::new(&seed_b, 42, 42);
5578 let node_b = ChannelManager::new(&fee_estimator, &chain_monitor_b, &tx_broadcaster, &logger_b, &keys_manager_b, config.clone(), ChainParameters {
5580 best_block: BestBlock::from_genesis(network),
5582 let node_b_holder = NodeHolder { node: &node_b };
5584 node_a.create_channel(node_b.get_our_node_id(), 8_000_000, 100_000_000, 42, None).unwrap();
5585 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()));
5586 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()));
5589 if let Event::FundingGenerationReady { temporary_channel_id, output_script, .. } = get_event!(node_a_holder, Event::FundingGenerationReady) {
5590 tx = Transaction { version: 2, lock_time: 0, input: Vec::new(), output: vec![TxOut {
5591 value: 8_000_000, script_pubkey: output_script,
5593 node_a.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
5594 } else { panic!(); }
5596 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()));
5597 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()));
5599 assert_eq!(&tx_broadcaster.txn_broadcasted.lock().unwrap()[..], &[tx.clone()]);
5602 header: BlockHeader { version: 0x20000000, prev_blockhash: genesis_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5605 Listen::block_connected(&node_a, &block, 1);
5606 Listen::block_connected(&node_b, &block, 1);
5608 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()));
5609 let msg_events = node_a.get_and_clear_pending_msg_events();
5610 assert_eq!(msg_events.len(), 2);
5611 match msg_events[0] {
5612 MessageSendEvent::SendFundingLocked { ref msg, .. } => {
5613 node_b.handle_funding_locked(&node_a.get_our_node_id(), msg);
5614 get_event_msg!(node_b_holder, MessageSendEvent::SendChannelUpdate, node_a.get_our_node_id());
5618 match msg_events[1] {
5619 MessageSendEvent::SendChannelUpdate { .. } => {},
5623 let dummy_graph = NetworkGraph::new(genesis_hash);
5625 let mut payment_count: u64 = 0;
5626 macro_rules! send_payment {
5627 ($node_a: expr, $node_b: expr) => {
5628 let usable_channels = $node_a.list_usable_channels();
5629 let route = get_route(&$node_a.get_our_node_id(), &dummy_graph, &$node_b.get_our_node_id(), Some(InvoiceFeatures::known()),
5630 Some(&usable_channels.iter().map(|r| r).collect::<Vec<_>>()), &[], 10_000, TEST_FINAL_CLTV, &logger_a).unwrap();
5632 let mut payment_preimage = PaymentPreimage([0; 32]);
5633 payment_preimage.0[0..8].copy_from_slice(&payment_count.to_le_bytes());
5635 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
5636 let payment_secret = $node_b.create_inbound_payment_for_hash(payment_hash, None, 7200, 0).unwrap();
5638 $node_a.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
5639 let payment_event = SendEvent::from_event($node_a.get_and_clear_pending_msg_events().pop().unwrap());
5640 $node_b.handle_update_add_htlc(&$node_a.get_our_node_id(), &payment_event.msgs[0]);
5641 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &payment_event.commitment_msg);
5642 let (raa, cs) = get_revoke_commit_msgs!(NodeHolder { node: &$node_b }, $node_a.get_our_node_id());
5643 $node_a.handle_revoke_and_ack(&$node_b.get_our_node_id(), &raa);
5644 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &cs);
5645 $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()));
5647 expect_pending_htlcs_forwardable!(NodeHolder { node: &$node_b });
5648 expect_payment_received!(NodeHolder { node: &$node_b }, payment_hash, payment_secret, 10_000);
5649 assert!($node_b.claim_funds(payment_preimage));
5651 match $node_b.get_and_clear_pending_msg_events().pop().unwrap() {
5652 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
5653 assert_eq!(node_id, $node_a.get_our_node_id());
5654 $node_a.handle_update_fulfill_htlc(&$node_b.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
5655 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &updates.commitment_signed);
5657 _ => panic!("Failed to generate claim event"),
5660 let (raa, cs) = get_revoke_commit_msgs!(NodeHolder { node: &$node_a }, $node_b.get_our_node_id());
5661 $node_b.handle_revoke_and_ack(&$node_a.get_our_node_id(), &raa);
5662 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &cs);
5663 $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()));
5665 expect_payment_sent!(NodeHolder { node: &$node_a }, payment_preimage);
5670 send_payment!(node_a, node_b);
5671 send_payment!(node_b, node_a);