1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! The top-level channel management and payment tracking stuff lives here.
12 //! The ChannelManager is the main chunk of logic implementing the lightning protocol and is
13 //! responsible for tracking which channels are open, HTLCs are in flight and reestablishing those
14 //! upon reconnect to the relevant peer(s).
16 //! It does not manage routing logic (see routing::router::get_route for that) nor does it manage constructing
17 //! on-chain transactions (it only monitors the chain to watch for any force-closes that might
18 //! imply it needs to fail HTLCs/payments/channels it manages).
21 use bitcoin::blockdata::block::{Block, BlockHeader};
22 use bitcoin::blockdata::transaction::Transaction;
23 use bitcoin::blockdata::constants::genesis_block;
24 use bitcoin::network::constants::Network;
26 use bitcoin::hashes::{Hash, HashEngine};
27 use bitcoin::hashes::hmac::{Hmac, HmacEngine};
28 use bitcoin::hashes::sha256::Hash as Sha256;
29 use bitcoin::hashes::sha256d::Hash as Sha256dHash;
30 use bitcoin::hashes::cmp::fixed_time_eq;
31 use bitcoin::hash_types::{BlockHash, Txid};
33 use bitcoin::secp256k1::key::{SecretKey,PublicKey};
34 use bitcoin::secp256k1::Secp256k1;
35 use bitcoin::secp256k1::ecdh::SharedSecret;
36 use bitcoin::secp256k1;
39 use chain::{Confirm, Watch, BestBlock};
40 use chain::chaininterface::{BroadcasterInterface, ConfirmationTarget, FeeEstimator};
41 use chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, ChannelMonitorUpdateStep, ChannelMonitorUpdateErr, HTLC_FAIL_BACK_BUFFER, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY, MonitorEvent, CLOSED_CHANNEL_UPDATE_ID};
42 use chain::transaction::{OutPoint, TransactionData};
43 // Since this struct is returned in `list_channels` methods, expose it here in case users want to
44 // construct one themselves.
45 use ln::{PaymentHash, PaymentPreimage, PaymentSecret};
46 use ln::channel::{Channel, ChannelError, ChannelUpdateStatus, UpdateFulfillCommitFetch};
47 use ln::features::{InitFeatures, NodeFeatures};
48 use routing::router::{Route, RouteHop};
50 use ln::msgs::NetAddress;
52 use ln::msgs::{ChannelMessageHandler, DecodeError, LightningError, OptionalField};
53 use chain::keysinterface::{Sign, KeysInterface, KeysManager, InMemorySigner};
54 use util::config::UserConfig;
55 use util::events::{EventHandler, EventsProvider, MessageSendEvent, MessageSendEventsProvider, ClosureReason};
56 use util::{byte_utils, events};
57 use util::ser::{BigSize, FixedLengthReader, Readable, ReadableArgs, MaybeReadable, Writeable, Writer};
58 use util::chacha20::{ChaCha20, ChaChaReader};
59 use util::logger::{Logger, Level};
60 use util::errors::APIError;
65 use core::cell::RefCell;
66 use io::{Cursor, Read};
67 use sync::{Arc, Condvar, Mutex, MutexGuard, RwLock, RwLockReadGuard};
68 use core::sync::atomic::{AtomicUsize, Ordering};
69 use core::time::Duration;
70 #[cfg(any(test, feature = "allow_wallclock_use"))]
71 use std::time::Instant;
74 // We hold various information about HTLC relay in the HTLC objects in Channel itself:
76 // Upon receipt of an HTLC from a peer, we'll give it a PendingHTLCStatus indicating if it should
77 // forward the HTLC with information it will give back to us when it does so, or if it should Fail
78 // the HTLC with the relevant message for the Channel to handle giving to the remote peer.
80 // Once said HTLC is committed in the Channel, if the PendingHTLCStatus indicated Forward, the
81 // Channel will return the PendingHTLCInfo back to us, and we will create an HTLCForwardInfo
82 // with it to track where it came from (in case of onwards-forward error), waiting a random delay
83 // before we forward it.
85 // We will then use HTLCForwardInfo's PendingHTLCInfo to construct an outbound HTLC, with a
86 // relevant HTLCSource::PreviousHopData filled in to indicate where it came from (which we can use
87 // to either fail-backwards or fulfill the HTLC backwards along the relevant path).
88 // Alternatively, we can fill an outbound HTLC with a HTLCSource::OutboundRoute indicating this is
89 // our payment, which we can use to decode errors or inform the user that the payment was sent.
91 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
92 enum PendingHTLCRouting {
94 onion_packet: msgs::OnionPacket,
95 short_channel_id: u64, // This should be NonZero<u64> eventually when we bump MSRV
98 payment_data: msgs::FinalOnionHopData,
99 incoming_cltv_expiry: u32, // Used to track when we should expire pending HTLCs that go unclaimed
102 payment_preimage: PaymentPreimage,
103 incoming_cltv_expiry: u32, // Used to track when we should expire pending HTLCs that go unclaimed
107 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
108 pub(super) struct PendingHTLCInfo {
109 routing: PendingHTLCRouting,
110 incoming_shared_secret: [u8; 32],
111 payment_hash: PaymentHash,
112 pub(super) amt_to_forward: u64,
113 pub(super) outgoing_cltv_value: u32,
116 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
117 pub(super) enum HTLCFailureMsg {
118 Relay(msgs::UpdateFailHTLC),
119 Malformed(msgs::UpdateFailMalformedHTLC),
122 /// Stores whether we can't forward an HTLC or relevant forwarding info
123 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
124 pub(super) enum PendingHTLCStatus {
125 Forward(PendingHTLCInfo),
126 Fail(HTLCFailureMsg),
129 pub(super) enum HTLCForwardInfo {
131 forward_info: PendingHTLCInfo,
133 // These fields are produced in `forward_htlcs()` and consumed in
134 // `process_pending_htlc_forwards()` for constructing the
135 // `HTLCSource::PreviousHopData` for failed and forwarded
137 prev_short_channel_id: u64,
139 prev_funding_outpoint: OutPoint,
143 err_packet: msgs::OnionErrorPacket,
147 /// Tracks the inbound corresponding to an outbound HTLC
148 #[derive(Clone, PartialEq)]
149 pub(crate) struct HTLCPreviousHopData {
150 short_channel_id: u64,
152 incoming_packet_shared_secret: [u8; 32],
154 // This field is consumed by `claim_funds_from_hop()` when updating a force-closed backwards
155 // channel with a preimage provided by the forward channel.
160 /// Contains a total_msat (which may differ from value if this is a Multi-Path Payment) and a
161 /// payment_secret which prevents path-probing attacks and can associate different HTLCs which
162 /// are part of the same payment.
163 Invoice(msgs::FinalOnionHopData),
164 /// Contains the payer-provided preimage.
165 Spontaneous(PaymentPreimage),
168 struct ClaimableHTLC {
169 prev_hop: HTLCPreviousHopData,
172 onion_payload: OnionPayload,
175 /// A payment identifier used to uniquely identify a payment to LDK.
176 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
177 pub struct PaymentId(pub [u8; 32]);
179 impl Writeable for PaymentId {
180 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
185 impl Readable for PaymentId {
186 fn read<R: Read>(r: &mut R) -> Result<Self, DecodeError> {
187 let buf: [u8; 32] = Readable::read(r)?;
191 /// Tracks the inbound corresponding to an outbound HTLC
192 #[derive(Clone, PartialEq)]
193 pub(crate) enum HTLCSource {
194 PreviousHopData(HTLCPreviousHopData),
197 session_priv: SecretKey,
198 /// Technically we can recalculate this from the route, but we cache it here to avoid
199 /// doing a double-pass on route when we get a failure back
200 first_hop_htlc_msat: u64,
201 payment_id: PaymentId,
206 pub fn dummy() -> Self {
207 HTLCSource::OutboundRoute {
209 session_priv: SecretKey::from_slice(&[1; 32]).unwrap(),
210 first_hop_htlc_msat: 0,
211 payment_id: PaymentId([2; 32]),
216 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
217 pub(super) enum HTLCFailReason {
219 err: msgs::OnionErrorPacket,
227 /// Return value for claim_funds_from_hop
228 enum ClaimFundsFromHop {
230 MonitorUpdateFail(PublicKey, MsgHandleErrInternal, Option<u64>),
235 type ShutdownResult = (Option<(OutPoint, ChannelMonitorUpdate)>, Vec<(HTLCSource, PaymentHash)>);
237 /// Error type returned across the channel_state mutex boundary. When an Err is generated for a
238 /// Channel, we generally end up with a ChannelError::Close for which we have to close the channel
239 /// immediately (ie with no further calls on it made). Thus, this step happens inside a
240 /// channel_state lock. We then return the set of things that need to be done outside the lock in
241 /// this struct and call handle_error!() on it.
243 struct MsgHandleErrInternal {
244 err: msgs::LightningError,
245 chan_id: Option<[u8; 32]>, // If Some a channel of ours has been closed
246 shutdown_finish: Option<(ShutdownResult, Option<msgs::ChannelUpdate>)>,
248 impl MsgHandleErrInternal {
250 fn send_err_msg_no_close(err: String, channel_id: [u8; 32]) -> Self {
252 err: LightningError {
254 action: msgs::ErrorAction::SendErrorMessage {
255 msg: msgs::ErrorMessage {
262 shutdown_finish: None,
266 fn ignore_no_close(err: String) -> Self {
268 err: LightningError {
270 action: msgs::ErrorAction::IgnoreError,
273 shutdown_finish: None,
277 fn from_no_close(err: msgs::LightningError) -> Self {
278 Self { err, chan_id: None, shutdown_finish: None }
281 fn from_finish_shutdown(err: String, channel_id: [u8; 32], shutdown_res: ShutdownResult, channel_update: Option<msgs::ChannelUpdate>) -> Self {
283 err: LightningError {
285 action: msgs::ErrorAction::SendErrorMessage {
286 msg: msgs::ErrorMessage {
292 chan_id: Some(channel_id),
293 shutdown_finish: Some((shutdown_res, channel_update)),
297 fn from_chan_no_close(err: ChannelError, channel_id: [u8; 32]) -> Self {
300 ChannelError::Warn(msg) => LightningError {
302 action: msgs::ErrorAction::IgnoreError,
304 ChannelError::Ignore(msg) => LightningError {
306 action: msgs::ErrorAction::IgnoreError,
308 ChannelError::Close(msg) => LightningError {
310 action: msgs::ErrorAction::SendErrorMessage {
311 msg: msgs::ErrorMessage {
317 ChannelError::CloseDelayBroadcast(msg) => LightningError {
319 action: msgs::ErrorAction::SendErrorMessage {
320 msg: msgs::ErrorMessage {
328 shutdown_finish: None,
333 /// We hold back HTLCs we intend to relay for a random interval greater than this (see
334 /// Event::PendingHTLCsForwardable for the API guidelines indicating how long should be waited).
335 /// This provides some limited amount of privacy. Ideally this would range from somewhere like one
336 /// second to 30 seconds, but people expect lightning to be, you know, kinda fast, sadly.
337 const MIN_HTLC_RELAY_HOLDING_CELL_MILLIS: u64 = 100;
339 /// For events which result in both a RevokeAndACK and a CommitmentUpdate, by default they should
340 /// be sent in the order they appear in the return value, however sometimes the order needs to be
341 /// variable at runtime (eg Channel::channel_reestablish needs to re-send messages in the order
342 /// they were originally sent). In those cases, this enum is also returned.
343 #[derive(Clone, PartialEq)]
344 pub(super) enum RAACommitmentOrder {
345 /// Send the CommitmentUpdate messages first
347 /// Send the RevokeAndACK message first
351 // Note this is only exposed in cfg(test):
352 pub(super) struct ChannelHolder<Signer: Sign> {
353 pub(super) by_id: HashMap<[u8; 32], Channel<Signer>>,
354 pub(super) short_to_id: HashMap<u64, [u8; 32]>,
355 /// short channel id -> forward infos. Key of 0 means payments received
356 /// Note that while this is held in the same mutex as the channels themselves, no consistency
357 /// guarantees are made about the existence of a channel with the short id here, nor the short
358 /// ids in the PendingHTLCInfo!
359 pub(super) forward_htlcs: HashMap<u64, Vec<HTLCForwardInfo>>,
360 /// Map from payment hash to any HTLCs which are to us and can be failed/claimed by the user.
361 /// Note that while this is held in the same mutex as the channels themselves, no consistency
362 /// guarantees are made about the channels given here actually existing anymore by the time you
364 claimable_htlcs: HashMap<PaymentHash, Vec<ClaimableHTLC>>,
365 /// Messages to send to peers - pushed to in the same lock that they are generated in (except
366 /// for broadcast messages, where ordering isn't as strict).
367 pub(super) pending_msg_events: Vec<MessageSendEvent>,
370 /// Events which we process internally but cannot be procsesed immediately at the generation site
371 /// for some reason. They are handled in timer_tick_occurred, so may be processed with
372 /// quite some time lag.
373 enum BackgroundEvent {
374 /// Handle a ChannelMonitorUpdate that closes a channel, broadcasting its current latest holder
375 /// commitment transaction.
376 ClosingMonitorUpdate((OutPoint, ChannelMonitorUpdate)),
379 /// State we hold per-peer. In the future we should put channels in here, but for now we only hold
380 /// the latest Init features we heard from the peer.
382 latest_features: InitFeatures,
385 /// Stores a PaymentSecret and any other data we may need to validate an inbound payment is
386 /// actually ours and not some duplicate HTLC sent to us by a node along the route.
388 /// For users who don't want to bother doing their own payment preimage storage, we also store that
390 struct PendingInboundPayment {
391 /// The payment secret that the sender must use for us to accept this payment
392 payment_secret: PaymentSecret,
393 /// Time at which this HTLC expires - blocks with a header time above this value will result in
394 /// this payment being removed.
396 /// Arbitrary identifier the user specifies (or not)
397 user_payment_id: u64,
398 // Other required attributes of the payment, optionally enforced:
399 payment_preimage: Option<PaymentPreimage>,
400 min_value_msat: Option<u64>,
403 /// SimpleArcChannelManager is useful when you need a ChannelManager with a static lifetime, e.g.
404 /// when you're using lightning-net-tokio (since tokio::spawn requires parameters with static
405 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
406 /// SimpleRefChannelManager is the more appropriate type. Defining these type aliases prevents
407 /// issues such as overly long function definitions. Note that the ChannelManager can take any
408 /// type that implements KeysInterface for its keys manager, but this type alias chooses the
409 /// concrete type of the KeysManager.
410 pub type SimpleArcChannelManager<M, T, F, L> = ChannelManager<InMemorySigner, Arc<M>, Arc<T>, Arc<KeysManager>, Arc<F>, Arc<L>>;
412 /// SimpleRefChannelManager is a type alias for a ChannelManager reference, and is the reference
413 /// counterpart to the SimpleArcChannelManager type alias. Use this type by default when you don't
414 /// need a ChannelManager with a static lifetime. You'll need a static lifetime in cases such as
415 /// usage of lightning-net-tokio (since tokio::spawn requires parameters with static lifetimes).
416 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
417 /// helps with issues such as long function definitions. Note that the ChannelManager can take any
418 /// type that implements KeysInterface for its keys manager, but this type alias chooses the
419 /// concrete type of the KeysManager.
420 pub type SimpleRefChannelManager<'a, 'b, 'c, 'd, 'e, M, T, F, L> = ChannelManager<InMemorySigner, &'a M, &'b T, &'c KeysManager, &'d F, &'e L>;
422 /// Manager which keeps track of a number of channels and sends messages to the appropriate
423 /// channel, also tracking HTLC preimages and forwarding onion packets appropriately.
425 /// Implements ChannelMessageHandler, handling the multi-channel parts and passing things through
426 /// to individual Channels.
428 /// Implements Writeable to write out all channel state to disk. Implies peer_disconnected() for
429 /// all peers during write/read (though does not modify this instance, only the instance being
430 /// serialized). This will result in any channels which have not yet exchanged funding_created (ie
431 /// called funding_transaction_generated for outbound channels).
433 /// Note that you can be a bit lazier about writing out ChannelManager than you can be with
434 /// ChannelMonitors. With ChannelMonitors you MUST write each monitor update out to disk before
435 /// returning from chain::Watch::watch_/update_channel, with ChannelManagers, writing updates
436 /// happens out-of-band (and will prevent any other ChannelManager operations from occurring during
437 /// the serialization process). If the deserialized version is out-of-date compared to the
438 /// ChannelMonitors passed by reference to read(), those channels will be force-closed based on the
439 /// ChannelMonitor state and no funds will be lost (mod on-chain transaction fees).
441 /// Note that the deserializer is only implemented for (BlockHash, ChannelManager), which
442 /// tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
443 /// the "reorg path" (ie call block_disconnected() until you get to a common block and then call
444 /// block_connected() to step towards your best block) upon deserialization before using the
447 /// Note that ChannelManager is responsible for tracking liveness of its channels and generating
448 /// ChannelUpdate messages informing peers that the channel is temporarily disabled. To avoid
449 /// spam due to quick disconnection/reconnection, updates are not sent until the channel has been
450 /// offline for a full minute. In order to track this, you must call
451 /// timer_tick_occurred roughly once per minute, though it doesn't have to be perfect.
453 /// Rather than using a plain ChannelManager, it is preferable to use either a SimpleArcChannelManager
454 /// a SimpleRefChannelManager, for conciseness. See their documentation for more details, but
455 /// essentially you should default to using a SimpleRefChannelManager, and use a
456 /// SimpleArcChannelManager when you require a ChannelManager with a static lifetime, such as when
457 /// you're using lightning-net-tokio.
458 pub struct ChannelManager<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
459 where M::Target: chain::Watch<Signer>,
460 T::Target: BroadcasterInterface,
461 K::Target: KeysInterface<Signer = Signer>,
462 F::Target: FeeEstimator,
465 default_configuration: UserConfig,
466 genesis_hash: BlockHash,
472 pub(super) best_block: RwLock<BestBlock>,
474 best_block: RwLock<BestBlock>,
475 secp_ctx: Secp256k1<secp256k1::All>,
477 #[cfg(any(test, feature = "_test_utils"))]
478 pub(super) channel_state: Mutex<ChannelHolder<Signer>>,
479 #[cfg(not(any(test, feature = "_test_utils")))]
480 channel_state: Mutex<ChannelHolder<Signer>>,
482 /// Storage for PaymentSecrets and any requirements on future inbound payments before we will
483 /// expose them to users via a PaymentReceived event. HTLCs which do not meet the requirements
484 /// here are failed when we process them as pending-forwardable-HTLCs, and entries are removed
485 /// after we generate a PaymentReceived upon receipt of all MPP parts or when they time out.
486 /// Locked *after* channel_state.
487 pending_inbound_payments: Mutex<HashMap<PaymentHash, PendingInboundPayment>>,
489 /// The session_priv bytes of outbound payments which are pending resolution.
490 /// The authoritative state of these HTLCs resides either within Channels or ChannelMonitors
491 /// (if the channel has been force-closed), however we track them here to prevent duplicative
492 /// PaymentSent/PaymentPathFailed events. Specifically, in the case of a duplicative
493 /// update_fulfill_htlc message after a reconnect, we may "claim" a payment twice.
494 /// Additionally, because ChannelMonitors are often not re-serialized after connecting block(s)
495 /// which may generate a claim event, we may receive similar duplicate claim/fail MonitorEvents
496 /// after reloading from disk while replaying blocks against ChannelMonitors.
498 /// Each payment has each of its MPP part's session_priv bytes in the HashSet of the map (even
499 /// payments over a single path).
501 /// Locked *after* channel_state.
502 pending_outbound_payments: Mutex<HashMap<PaymentId, HashSet<[u8; 32]>>>,
504 our_network_key: SecretKey,
505 our_network_pubkey: PublicKey,
507 /// Used to track the last value sent in a node_announcement "timestamp" field. We ensure this
508 /// value increases strictly since we don't assume access to a time source.
509 last_node_announcement_serial: AtomicUsize,
511 /// The highest block timestamp we've seen, which is usually a good guess at the current time.
512 /// Assuming most miners are generating blocks with reasonable timestamps, this shouldn't be
513 /// very far in the past, and can only ever be up to two hours in the future.
514 highest_seen_timestamp: AtomicUsize,
516 /// The bulk of our storage will eventually be here (channels and message queues and the like).
517 /// If we are connected to a peer we always at least have an entry here, even if no channels
518 /// are currently open with that peer.
519 /// Because adding or removing an entry is rare, we usually take an outer read lock and then
520 /// operate on the inner value freely. Sadly, this prevents parallel operation when opening a
523 /// If also holding `channel_state` lock, must lock `channel_state` prior to `per_peer_state`.
524 per_peer_state: RwLock<HashMap<PublicKey, Mutex<PeerState>>>,
526 pending_events: Mutex<Vec<events::Event>>,
527 pending_background_events: Mutex<Vec<BackgroundEvent>>,
528 /// Used when we have to take a BIG lock to make sure everything is self-consistent.
529 /// Essentially just when we're serializing ourselves out.
530 /// Taken first everywhere where we are making changes before any other locks.
531 /// When acquiring this lock in read mode, rather than acquiring it directly, call
532 /// `PersistenceNotifierGuard::notify_on_drop(..)` and pass the lock to it, to ensure the
533 /// PersistenceNotifier the lock contains sends out a notification when the lock is released.
534 total_consistency_lock: RwLock<()>,
536 persistence_notifier: PersistenceNotifier,
543 /// Chain-related parameters used to construct a new `ChannelManager`.
545 /// Typically, the block-specific parameters are derived from the best block hash for the network,
546 /// as a newly constructed `ChannelManager` will not have created any channels yet. These parameters
547 /// are not needed when deserializing a previously constructed `ChannelManager`.
548 #[derive(Clone, Copy, PartialEq)]
549 pub struct ChainParameters {
550 /// The network for determining the `chain_hash` in Lightning messages.
551 pub network: Network,
553 /// The hash and height of the latest block successfully connected.
555 /// Used to track on-chain channel funding outputs and send payments with reliable timelocks.
556 pub best_block: BestBlock,
559 #[derive(Copy, Clone, PartialEq)]
565 /// Whenever we release the `ChannelManager`'s `total_consistency_lock`, from read mode, it is
566 /// desirable to notify any listeners on `await_persistable_update_timeout`/
567 /// `await_persistable_update` when new updates are available for persistence. Therefore, this
568 /// struct is responsible for locking the total consistency lock and, upon going out of scope,
569 /// sending the aforementioned notification (since the lock being released indicates that the
570 /// updates are ready for persistence).
572 /// We allow callers to either always notify by constructing with `notify_on_drop` or choose to
573 /// notify or not based on whether relevant changes have been made, providing a closure to
574 /// `optionally_notify` which returns a `NotifyOption`.
575 struct PersistenceNotifierGuard<'a, F: Fn() -> NotifyOption> {
576 persistence_notifier: &'a PersistenceNotifier,
578 // We hold onto this result so the lock doesn't get released immediately.
579 _read_guard: RwLockReadGuard<'a, ()>,
582 impl<'a> PersistenceNotifierGuard<'a, fn() -> NotifyOption> { // We don't care what the concrete F is here, it's unused
583 fn notify_on_drop(lock: &'a RwLock<()>, notifier: &'a PersistenceNotifier) -> PersistenceNotifierGuard<'a, impl Fn() -> NotifyOption> {
584 PersistenceNotifierGuard::optionally_notify(lock, notifier, || -> NotifyOption { NotifyOption::DoPersist })
587 fn optionally_notify<F: Fn() -> NotifyOption>(lock: &'a RwLock<()>, notifier: &'a PersistenceNotifier, persist_check: F) -> PersistenceNotifierGuard<'a, F> {
588 let read_guard = lock.read().unwrap();
590 PersistenceNotifierGuard {
591 persistence_notifier: notifier,
592 should_persist: persist_check,
593 _read_guard: read_guard,
598 impl<'a, F: Fn() -> NotifyOption> Drop for PersistenceNotifierGuard<'a, F> {
600 if (self.should_persist)() == NotifyOption::DoPersist {
601 self.persistence_notifier.notify();
606 /// The amount of time in blocks we require our counterparty wait to claim their money (ie time
607 /// between when we, or our watchtower, must check for them having broadcast a theft transaction).
609 /// This can be increased (but not decreased) through [`ChannelHandshakeConfig::our_to_self_delay`]
611 /// [`ChannelHandshakeConfig::our_to_self_delay`]: crate::util::config::ChannelHandshakeConfig::our_to_self_delay
612 pub const BREAKDOWN_TIMEOUT: u16 = 6 * 24;
613 /// The amount of time in blocks we're willing to wait to claim money back to us. This matches
614 /// the maximum required amount in lnd as of March 2021.
615 pub(crate) const MAX_LOCAL_BREAKDOWN_TIMEOUT: u16 = 2 * 6 * 24 * 7;
617 /// The minimum number of blocks between an inbound HTLC's CLTV and the corresponding outbound
618 /// HTLC's CLTV. The current default represents roughly seven hours of blocks at six blocks/hour.
620 /// This can be increased (but not decreased) through [`ChannelConfig::cltv_expiry_delta`]
622 /// [`ChannelConfig::cltv_expiry_delta`]: crate::util::config::ChannelConfig::cltv_expiry_delta
623 // This should always be a few blocks greater than channelmonitor::CLTV_CLAIM_BUFFER,
624 // i.e. the node we forwarded the payment on to should always have enough room to reliably time out
625 // the HTLC via a full update_fail_htlc/commitment_signed dance before we hit the
626 // CLTV_CLAIM_BUFFER point (we static assert that it's at least 3 blocks more).
627 pub const MIN_CLTV_EXPIRY_DELTA: u16 = 6*7;
628 pub(super) const CLTV_FAR_FAR_AWAY: u32 = 6 * 24 * 7; //TODO?
630 /// Minimum CLTV difference between the current block height and received inbound payments.
631 /// Invoices generated for payment to us must set their `min_final_cltv_expiry` field to at least
633 // Note that we fail if exactly HTLC_FAIL_BACK_BUFFER + 1 was used, so we need to add one for
634 // any payments to succeed. Further, we don't want payments to fail if a block was found while
635 // a payment was being routed, so we add an extra block to be safe.
636 pub const MIN_FINAL_CLTV_EXPIRY: u32 = HTLC_FAIL_BACK_BUFFER + 3;
638 // Check that our CLTV_EXPIRY is at least CLTV_CLAIM_BUFFER + ANTI_REORG_DELAY + LATENCY_GRACE_PERIOD_BLOCKS,
639 // ie that if the next-hop peer fails the HTLC within
640 // LATENCY_GRACE_PERIOD_BLOCKS then we'll still have CLTV_CLAIM_BUFFER left to timeout it onchain,
641 // then waiting ANTI_REORG_DELAY to be reorg-safe on the outbound HLTC and
642 // failing the corresponding htlc backward, and us now seeing the last block of ANTI_REORG_DELAY before
643 // LATENCY_GRACE_PERIOD_BLOCKS.
646 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;
648 // Check for ability of an attacker to make us fail on-chain by delaying an HTLC claim. See
649 // ChannelMonitor::should_broadcast_holder_commitment_txn for a description of why this is needed.
652 const CHECK_CLTV_EXPIRY_SANITY_2: u32 = MIN_CLTV_EXPIRY_DELTA as u32 - LATENCY_GRACE_PERIOD_BLOCKS - 2*CLTV_CLAIM_BUFFER;
654 /// Information needed for constructing an invoice route hint for this channel.
655 #[derive(Clone, Debug, PartialEq)]
656 pub struct CounterpartyForwardingInfo {
657 /// Base routing fee in millisatoshis.
658 pub fee_base_msat: u32,
659 /// Amount in millionths of a satoshi the channel will charge per transferred satoshi.
660 pub fee_proportional_millionths: u32,
661 /// The minimum difference in cltv_expiry between an ingoing HTLC and its outgoing counterpart,
662 /// such that the outgoing HTLC is forwardable to this counterparty. See `msgs::ChannelUpdate`'s
663 /// `cltv_expiry_delta` for more details.
664 pub cltv_expiry_delta: u16,
667 /// Channel parameters which apply to our counterparty. These are split out from [`ChannelDetails`]
668 /// to better separate parameters.
669 #[derive(Clone, Debug, PartialEq)]
670 pub struct ChannelCounterparty {
671 /// The node_id of our counterparty
672 pub node_id: PublicKey,
673 /// The Features the channel counterparty provided upon last connection.
674 /// Useful for routing as it is the most up-to-date copy of the counterparty's features and
675 /// many routing-relevant features are present in the init context.
676 pub features: InitFeatures,
677 /// The value, in satoshis, that must always be held in the channel for our counterparty. This
678 /// value ensures that if our counterparty broadcasts a revoked state, we can punish them by
679 /// claiming at least this value on chain.
681 /// This value is not included in [`inbound_capacity_msat`] as it can never be spent.
683 /// [`inbound_capacity_msat`]: ChannelDetails::inbound_capacity_msat
684 pub unspendable_punishment_reserve: u64,
685 /// Information on the fees and requirements that the counterparty requires when forwarding
686 /// payments to us through this channel.
687 pub forwarding_info: Option<CounterpartyForwardingInfo>,
690 /// Details of a channel, as returned by ChannelManager::list_channels and ChannelManager::list_usable_channels
691 #[derive(Clone, Debug, PartialEq)]
692 pub struct ChannelDetails {
693 /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
694 /// thereafter this is the txid of the funding transaction xor the funding transaction output).
695 /// Note that this means this value is *not* persistent - it can change once during the
696 /// lifetime of the channel.
697 pub channel_id: [u8; 32],
698 /// Parameters which apply to our counterparty. See individual fields for more information.
699 pub counterparty: ChannelCounterparty,
700 /// The Channel's funding transaction output, if we've negotiated the funding transaction with
701 /// our counterparty already.
703 /// Note that, if this has been set, `channel_id` will be equivalent to
704 /// `funding_txo.unwrap().to_channel_id()`.
705 pub funding_txo: Option<OutPoint>,
706 /// The position of the funding transaction in the chain. None if the funding transaction has
707 /// not yet been confirmed and the channel fully opened.
708 pub short_channel_id: Option<u64>,
709 /// The value, in satoshis, of this channel as appears in the funding output
710 pub channel_value_satoshis: u64,
711 /// The value, in satoshis, that must always be held in the channel for us. This value ensures
712 /// that if we broadcast a revoked state, our counterparty can punish us by claiming at least
713 /// this value on chain.
715 /// This value is not included in [`outbound_capacity_msat`] as it can never be spent.
717 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
719 /// [`outbound_capacity_msat`]: ChannelDetails::outbound_capacity_msat
720 pub unspendable_punishment_reserve: Option<u64>,
721 /// The user_id passed in to create_channel, or 0 if the channel was inbound.
723 /// The available outbound capacity for sending HTLCs to the remote peer. This does not include
724 /// any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
725 /// available for inclusion in new outbound HTLCs). This further does not include any pending
726 /// outgoing HTLCs which are awaiting some other resolution to be sent.
728 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
729 /// conflict-avoidance policy, exactly this amount is not likely to be spendable. However, we
730 /// should be able to spend nearly this amount.
731 pub outbound_capacity_msat: u64,
732 /// The available inbound capacity for the remote peer to send HTLCs to us. This does not
733 /// include any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
734 /// available for inclusion in new inbound HTLCs).
735 /// Note that there are some corner cases not fully handled here, so the actual available
736 /// inbound capacity may be slightly higher than this.
738 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
739 /// counterparty's conflict-avoidance policy, exactly this amount is not likely to be spendable.
740 /// However, our counterparty should be able to spend nearly this amount.
741 pub inbound_capacity_msat: u64,
742 /// The number of required confirmations on the funding transaction before the funding will be
743 /// considered "locked". This number is selected by the channel fundee (i.e. us if
744 /// [`is_outbound`] is *not* set), and can be selected for inbound channels with
745 /// [`ChannelHandshakeConfig::minimum_depth`] or limited for outbound channels with
746 /// [`ChannelHandshakeLimits::max_minimum_depth`].
748 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
750 /// [`is_outbound`]: ChannelDetails::is_outbound
751 /// [`ChannelHandshakeConfig::minimum_depth`]: crate::util::config::ChannelHandshakeConfig::minimum_depth
752 /// [`ChannelHandshakeLimits::max_minimum_depth`]: crate::util::config::ChannelHandshakeLimits::max_minimum_depth
753 pub confirmations_required: Option<u32>,
754 /// The number of blocks (after our commitment transaction confirms) that we will need to wait
755 /// until we can claim our funds after we force-close the channel. During this time our
756 /// counterparty is allowed to punish us if we broadcasted a stale state. If our counterparty
757 /// force-closes the channel and broadcasts a commitment transaction we do not have to wait any
758 /// time to claim our non-HTLC-encumbered funds.
760 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
761 pub force_close_spend_delay: Option<u16>,
762 /// True if the channel was initiated (and thus funded) by us.
763 pub is_outbound: bool,
764 /// True if the channel is confirmed, funding_locked messages have been exchanged, and the
765 /// channel is not currently being shut down. `funding_locked` message exchange implies the
766 /// required confirmation count has been reached (and we were connected to the peer at some
767 /// point after the funding transaction received enough confirmations). The required
768 /// confirmation count is provided in [`confirmations_required`].
770 /// [`confirmations_required`]: ChannelDetails::confirmations_required
771 pub is_funding_locked: bool,
772 /// True if the channel is (a) confirmed and funding_locked messages have been exchanged, (b)
773 /// the peer is connected, and (c) the channel is not currently negotiating a shutdown.
775 /// This is a strict superset of `is_funding_locked`.
777 /// True if this channel is (or will be) publicly-announced.
781 /// If a payment fails to send, it can be in one of several states. This enum is returned as the
782 /// Err() type describing which state the payment is in, see the description of individual enum
784 #[derive(Clone, Debug)]
785 pub enum PaymentSendFailure {
786 /// A parameter which was passed to send_payment was invalid, preventing us from attempting to
787 /// send the payment at all. No channel state has been changed or messages sent to peers, and
788 /// once you've changed the parameter at error, you can freely retry the payment in full.
789 ParameterError(APIError),
790 /// A parameter in a single path which was passed to send_payment was invalid, preventing us
791 /// from attempting to send the payment at all. No channel state has been changed or messages
792 /// sent to peers, and once you've changed the parameter at error, you can freely retry the
795 /// The results here are ordered the same as the paths in the route object which was passed to
797 PathParameterError(Vec<Result<(), APIError>>),
798 /// All paths which were attempted failed to send, with no channel state change taking place.
799 /// You can freely retry the payment in full (though you probably want to do so over different
800 /// paths than the ones selected).
801 AllFailedRetrySafe(Vec<APIError>),
802 /// Some paths which were attempted failed to send, though possibly not all. At least some
803 /// paths have irrevocably committed to the HTLC and retrying the payment in full would result
804 /// in over-/re-payment.
806 /// The results here are ordered the same as the paths in the route object which was passed to
807 /// send_payment, and any Errs which are not APIError::MonitorUpdateFailed can be safely
808 /// retried (though there is currently no API with which to do so).
810 /// Any entries which contain Err(APIError::MonitorUpdateFailed) or Ok(()) MUST NOT be retried
811 /// as they will result in over-/re-payment. These HTLCs all either successfully sent (in the
812 /// case of Ok(())) or will send once channel_monitor_updated is called on the next-hop channel
813 /// with the latest update_id.
814 PartialFailure(Vec<Result<(), APIError>>),
817 macro_rules! handle_error {
818 ($self: ident, $internal: expr, $counterparty_node_id: expr) => {
821 Err(MsgHandleErrInternal { err, chan_id, shutdown_finish }) => {
822 #[cfg(debug_assertions)]
824 // In testing, ensure there are no deadlocks where the lock is already held upon
825 // entering the macro.
826 assert!($self.channel_state.try_lock().is_ok());
827 assert!($self.pending_events.try_lock().is_ok());
830 let mut msg_events = Vec::with_capacity(2);
832 if let Some((shutdown_res, update_option)) = shutdown_finish {
833 $self.finish_force_close_channel(shutdown_res);
834 if let Some(update) = update_option {
835 msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
839 if let Some(channel_id) = chan_id {
840 $self.pending_events.lock().unwrap().push(events::Event::ChannelClosed { channel_id, reason: ClosureReason::ProcessingError { err: err.err.clone() } });
844 log_error!($self.logger, "{}", err.err);
845 if let msgs::ErrorAction::IgnoreError = err.action {
847 msg_events.push(events::MessageSendEvent::HandleError {
848 node_id: $counterparty_node_id,
849 action: err.action.clone()
853 if !msg_events.is_empty() {
854 $self.channel_state.lock().unwrap().pending_msg_events.append(&mut msg_events);
857 // Return error in case higher-API need one
864 /// Returns (boolean indicating if we should remove the Channel object from memory, a mapped error)
865 macro_rules! convert_chan_err {
866 ($self: ident, $err: expr, $short_to_id: expr, $channel: expr, $channel_id: expr) => {
868 ChannelError::Warn(msg) => {
869 //TODO: Once warning messages are merged, we should send a `warning` message to our
871 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore(msg), $channel_id.clone()))
873 ChannelError::Ignore(msg) => {
874 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore(msg), $channel_id.clone()))
876 ChannelError::Close(msg) => {
877 log_error!($self.logger, "Closing channel {} due to close-required error: {}", log_bytes!($channel_id[..]), msg);
878 if let Some(short_id) = $channel.get_short_channel_id() {
879 $short_to_id.remove(&short_id);
881 let shutdown_res = $channel.force_shutdown(true);
882 (true, MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, shutdown_res, $self.get_channel_update_for_broadcast(&$channel).ok()))
884 ChannelError::CloseDelayBroadcast(msg) => {
885 log_error!($self.logger, "Channel {} need to be shutdown but closing transactions not broadcast due to {}", log_bytes!($channel_id[..]), msg);
886 if let Some(short_id) = $channel.get_short_channel_id() {
887 $short_to_id.remove(&short_id);
889 let shutdown_res = $channel.force_shutdown(false);
890 (true, MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, shutdown_res, $self.get_channel_update_for_broadcast(&$channel).ok()))
896 macro_rules! break_chan_entry {
897 ($self: ident, $res: expr, $channel_state: expr, $entry: expr) => {
901 let (drop, res) = convert_chan_err!($self, e, $channel_state.short_to_id, $entry.get_mut(), $entry.key());
903 $entry.remove_entry();
911 macro_rules! try_chan_entry {
912 ($self: ident, $res: expr, $channel_state: expr, $entry: expr) => {
916 let (drop, res) = convert_chan_err!($self, e, $channel_state.short_to_id, $entry.get_mut(), $entry.key());
918 $entry.remove_entry();
926 macro_rules! remove_channel {
927 ($channel_state: expr, $entry: expr) => {
929 let channel = $entry.remove_entry().1;
930 if let Some(short_id) = channel.get_short_channel_id() {
931 $channel_state.short_to_id.remove(&short_id);
938 macro_rules! handle_monitor_err {
939 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
940 handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment, Vec::new(), Vec::new())
942 ($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) => {
944 ChannelMonitorUpdateErr::PermanentFailure => {
945 log_error!($self.logger, "Closing channel {} due to monitor update ChannelMonitorUpdateErr::PermanentFailure", log_bytes!($chan_id[..]));
946 if let Some(short_id) = $chan.get_short_channel_id() {
947 $short_to_id.remove(&short_id);
949 // TODO: $failed_fails is dropped here, which will cause other channels to hit the
950 // chain in a confused state! We need to move them into the ChannelMonitor which
951 // will be responsible for failing backwards once things confirm on-chain.
952 // It's ok that we drop $failed_forwards here - at this point we'd rather they
953 // broadcast HTLC-Timeout and pay the associated fees to get their funds back than
954 // us bother trying to claim it just to forward on to another peer. If we're
955 // splitting hairs we'd prefer to claim payments that were to us, but we haven't
956 // given up the preimage yet, so might as well just wait until the payment is
957 // retried, avoiding the on-chain fees.
958 let res: Result<(), _> = Err(MsgHandleErrInternal::from_finish_shutdown("ChannelMonitor storage failure".to_owned(), *$chan_id,
959 $chan.force_shutdown(true), $self.get_channel_update_for_broadcast(&$chan).ok() ));
962 ChannelMonitorUpdateErr::TemporaryFailure => {
963 log_info!($self.logger, "Disabling channel {} due to monitor update TemporaryFailure. On restore will send {} and process {} forwards and {} fails",
964 log_bytes!($chan_id[..]),
965 if $resend_commitment && $resend_raa {
967 RAACommitmentOrder::CommitmentFirst => { "commitment then RAA" },
968 RAACommitmentOrder::RevokeAndACKFirst => { "RAA then commitment" },
970 } else if $resend_commitment { "commitment" }
971 else if $resend_raa { "RAA" }
973 (&$failed_forwards as &Vec<(PendingHTLCInfo, u64)>).len(),
974 (&$failed_fails as &Vec<(HTLCSource, PaymentHash, HTLCFailReason)>).len());
975 if !$resend_commitment {
976 debug_assert!($action_type == RAACommitmentOrder::RevokeAndACKFirst || !$resend_raa);
979 debug_assert!($action_type == RAACommitmentOrder::CommitmentFirst || !$resend_commitment);
981 $chan.monitor_update_failed($resend_raa, $resend_commitment, $failed_forwards, $failed_fails);
982 (Err(MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore("Failed to update ChannelMonitor".to_owned()), *$chan_id)), false)
986 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr, $failed_forwards: expr, $failed_fails: expr) => { {
987 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());
989 $entry.remove_entry();
995 macro_rules! return_monitor_err {
996 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
997 return handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment);
999 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr, $failed_forwards: expr, $failed_fails: expr) => {
1000 return handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment, $failed_forwards, $failed_fails);
1004 // Does not break in case of TemporaryFailure!
1005 macro_rules! maybe_break_monitor_err {
1006 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
1007 match (handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment), $err) {
1008 (e, ChannelMonitorUpdateErr::PermanentFailure) => {
1011 (_, ChannelMonitorUpdateErr::TemporaryFailure) => { },
1016 macro_rules! handle_chan_restoration_locked {
1017 ($self: ident, $channel_lock: expr, $channel_state: expr, $channel_entry: expr,
1018 $raa: expr, $commitment_update: expr, $order: expr, $chanmon_update: expr,
1019 $pending_forwards: expr, $funding_broadcastable: expr, $funding_locked: expr) => { {
1020 let mut htlc_forwards = None;
1021 let counterparty_node_id = $channel_entry.get().get_counterparty_node_id();
1023 let chanmon_update: Option<ChannelMonitorUpdate> = $chanmon_update; // Force type-checking to resolve
1024 let chanmon_update_is_none = chanmon_update.is_none();
1026 let forwards: Vec<(PendingHTLCInfo, u64)> = $pending_forwards; // Force type-checking to resolve
1027 if !forwards.is_empty() {
1028 htlc_forwards = Some(($channel_entry.get().get_short_channel_id().expect("We can't have pending forwards before funding confirmation"),
1029 $channel_entry.get().get_funding_txo().unwrap(), forwards));
1032 if chanmon_update.is_some() {
1033 // On reconnect, we, by definition, only resend a funding_locked if there have been
1034 // no commitment updates, so the only channel monitor update which could also be
1035 // associated with a funding_locked would be the funding_created/funding_signed
1036 // monitor update. That monitor update failing implies that we won't send
1037 // funding_locked until it's been updated, so we can't have a funding_locked and a
1038 // monitor update here (so we don't bother to handle it correctly below).
1039 assert!($funding_locked.is_none());
1040 // A channel monitor update makes no sense without either a funding_locked or a
1041 // commitment update to process after it. Since we can't have a funding_locked, we
1042 // only bother to handle the monitor-update + commitment_update case below.
1043 assert!($commitment_update.is_some());
1046 if let Some(msg) = $funding_locked {
1047 // Similar to the above, this implies that we're letting the funding_locked fly
1048 // before it should be allowed to.
1049 assert!(chanmon_update.is_none());
1050 $channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingLocked {
1051 node_id: counterparty_node_id,
1054 if let Some(announcement_sigs) = $self.get_announcement_sigs($channel_entry.get()) {
1055 $channel_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
1056 node_id: counterparty_node_id,
1057 msg: announcement_sigs,
1060 $channel_state.short_to_id.insert($channel_entry.get().get_short_channel_id().unwrap(), $channel_entry.get().channel_id());
1063 let funding_broadcastable: Option<Transaction> = $funding_broadcastable; // Force type-checking to resolve
1064 if let Some(monitor_update) = chanmon_update {
1065 // We only ever broadcast a funding transaction in response to a funding_signed
1066 // message and the resulting monitor update. Thus, on channel_reestablish
1067 // message handling we can't have a funding transaction to broadcast. When
1068 // processing a monitor update finishing resulting in a funding broadcast, we
1069 // cannot have a second monitor update, thus this case would indicate a bug.
1070 assert!(funding_broadcastable.is_none());
1071 // Given we were just reconnected or finished updating a channel monitor, the
1072 // only case where we can get a new ChannelMonitorUpdate would be if we also
1073 // have some commitment updates to send as well.
1074 assert!($commitment_update.is_some());
1075 if let Err(e) = $self.chain_monitor.update_channel($channel_entry.get().get_funding_txo().unwrap(), monitor_update) {
1076 // channel_reestablish doesn't guarantee the order it returns is sensical
1077 // for the messages it returns, but if we're setting what messages to
1078 // re-transmit on monitor update success, we need to make sure it is sane.
1079 let mut order = $order;
1081 order = RAACommitmentOrder::CommitmentFirst;
1083 break handle_monitor_err!($self, e, $channel_state, $channel_entry, order, $raa.is_some(), true);
1087 macro_rules! handle_cs { () => {
1088 if let Some(update) = $commitment_update {
1089 $channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1090 node_id: counterparty_node_id,
1095 macro_rules! handle_raa { () => {
1096 if let Some(revoke_and_ack) = $raa {
1097 $channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
1098 node_id: counterparty_node_id,
1099 msg: revoke_and_ack,
1104 RAACommitmentOrder::CommitmentFirst => {
1108 RAACommitmentOrder::RevokeAndACKFirst => {
1113 if let Some(tx) = funding_broadcastable {
1114 log_info!($self.logger, "Broadcasting funding transaction with txid {}", tx.txid());
1115 $self.tx_broadcaster.broadcast_transaction(&tx);
1120 if chanmon_update_is_none {
1121 // If there was no ChannelMonitorUpdate, we should never generate an Err in the res loop
1122 // above. Doing so would imply calling handle_err!() from channel_monitor_updated() which
1123 // should *never* end up calling back to `chain_monitor.update_channel()`.
1124 assert!(res.is_ok());
1127 (htlc_forwards, res, counterparty_node_id)
1131 macro_rules! post_handle_chan_restoration {
1132 ($self: ident, $locked_res: expr) => { {
1133 let (htlc_forwards, res, counterparty_node_id) = $locked_res;
1135 let _ = handle_error!($self, res, counterparty_node_id);
1137 if let Some(forwards) = htlc_forwards {
1138 $self.forward_htlcs(&mut [forwards][..]);
1143 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<Signer, M, T, K, F, L>
1144 where M::Target: chain::Watch<Signer>,
1145 T::Target: BroadcasterInterface,
1146 K::Target: KeysInterface<Signer = Signer>,
1147 F::Target: FeeEstimator,
1150 /// Constructs a new ChannelManager to hold several channels and route between them.
1152 /// This is the main "logic hub" for all channel-related actions, and implements
1153 /// ChannelMessageHandler.
1155 /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
1157 /// panics if channel_value_satoshis is >= `MAX_FUNDING_SATOSHIS`!
1159 /// Users need to notify the new ChannelManager when a new block is connected or
1160 /// disconnected using its `block_connected` and `block_disconnected` methods, starting
1161 /// from after `params.latest_hash`.
1162 pub fn new(fee_est: F, chain_monitor: M, tx_broadcaster: T, logger: L, keys_manager: K, config: UserConfig, params: ChainParameters) -> Self {
1163 let mut secp_ctx = Secp256k1::new();
1164 secp_ctx.seeded_randomize(&keys_manager.get_secure_random_bytes());
1167 default_configuration: config.clone(),
1168 genesis_hash: genesis_block(params.network).header.block_hash(),
1169 fee_estimator: fee_est,
1173 best_block: RwLock::new(params.best_block),
1175 channel_state: Mutex::new(ChannelHolder{
1176 by_id: HashMap::new(),
1177 short_to_id: HashMap::new(),
1178 forward_htlcs: HashMap::new(),
1179 claimable_htlcs: HashMap::new(),
1180 pending_msg_events: Vec::new(),
1182 pending_inbound_payments: Mutex::new(HashMap::new()),
1183 pending_outbound_payments: Mutex::new(HashMap::new()),
1185 our_network_key: keys_manager.get_node_secret(),
1186 our_network_pubkey: PublicKey::from_secret_key(&secp_ctx, &keys_manager.get_node_secret()),
1189 last_node_announcement_serial: AtomicUsize::new(0),
1190 highest_seen_timestamp: AtomicUsize::new(0),
1192 per_peer_state: RwLock::new(HashMap::new()),
1194 pending_events: Mutex::new(Vec::new()),
1195 pending_background_events: Mutex::new(Vec::new()),
1196 total_consistency_lock: RwLock::new(()),
1197 persistence_notifier: PersistenceNotifier::new(),
1205 /// Gets the current configuration applied to all new channels, as
1206 pub fn get_current_default_configuration(&self) -> &UserConfig {
1207 &self.default_configuration
1210 /// Creates a new outbound channel to the given remote node and with the given value.
1212 /// user_id will be provided back as user_channel_id in FundingGenerationReady events to allow
1213 /// tracking of which events correspond with which create_channel call. Note that the
1214 /// user_channel_id defaults to 0 for inbound channels, so you may wish to avoid using 0 for
1215 /// user_id here. user_id has no meaning inside of LDK, it is simply copied to events and
1216 /// otherwise ignored.
1218 /// If successful, will generate a SendOpenChannel message event, so you should probably poll
1219 /// PeerManager::process_events afterwards.
1221 /// Raises APIError::APIMisuseError when channel_value_satoshis > 2**24 or push_msat is
1222 /// greater than channel_value_satoshis * 1k or channel_value_satoshis is < 1000.
1224 /// Note that we do not check if you are currently connected to the given peer. If no
1225 /// connection is available, the outbound `open_channel` message may fail to send, resulting in
1226 /// the channel eventually being silently forgotten.
1227 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> {
1228 if channel_value_satoshis < 1000 {
1229 return Err(APIError::APIMisuseError { err: format!("Channel value must be at least 1000 satoshis. It was {}", channel_value_satoshis) });
1233 let per_peer_state = self.per_peer_state.read().unwrap();
1234 match per_peer_state.get(&their_network_key) {
1235 Some(peer_state) => {
1236 let peer_state = peer_state.lock().unwrap();
1237 let their_features = &peer_state.latest_features;
1238 let config = if override_config.is_some() { override_config.as_ref().unwrap() } else { &self.default_configuration };
1239 Channel::new_outbound(&self.fee_estimator, &self.keys_manager, their_network_key, their_features, channel_value_satoshis, push_msat, user_id, config)?
1241 None => return Err(APIError::ChannelUnavailable { err: format!("Not connected to node: {}", their_network_key) }),
1244 let res = channel.get_open_channel(self.genesis_hash.clone());
1246 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1247 // We want to make sure the lock is actually acquired by PersistenceNotifierGuard.
1248 debug_assert!(&self.total_consistency_lock.try_write().is_err());
1250 let mut channel_state = self.channel_state.lock().unwrap();
1251 match channel_state.by_id.entry(channel.channel_id()) {
1252 hash_map::Entry::Occupied(_) => {
1253 if cfg!(feature = "fuzztarget") {
1254 return Err(APIError::APIMisuseError { err: "Fuzzy bad RNG".to_owned() });
1256 panic!("RNG is bad???");
1259 hash_map::Entry::Vacant(entry) => { entry.insert(channel); }
1261 channel_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
1262 node_id: their_network_key,
1268 fn list_channels_with_filter<Fn: FnMut(&(&[u8; 32], &Channel<Signer>)) -> bool>(&self, f: Fn) -> Vec<ChannelDetails> {
1269 let mut res = Vec::new();
1271 let channel_state = self.channel_state.lock().unwrap();
1272 res.reserve(channel_state.by_id.len());
1273 for (channel_id, channel) in channel_state.by_id.iter().filter(f) {
1274 let (inbound_capacity_msat, outbound_capacity_msat) = channel.get_inbound_outbound_available_balance_msat();
1275 let (to_remote_reserve_satoshis, to_self_reserve_satoshis) =
1276 channel.get_holder_counterparty_selected_channel_reserve_satoshis();
1277 res.push(ChannelDetails {
1278 channel_id: (*channel_id).clone(),
1279 counterparty: ChannelCounterparty {
1280 node_id: channel.get_counterparty_node_id(),
1281 features: InitFeatures::empty(),
1282 unspendable_punishment_reserve: to_remote_reserve_satoshis,
1283 forwarding_info: channel.counterparty_forwarding_info(),
1285 funding_txo: channel.get_funding_txo(),
1286 short_channel_id: channel.get_short_channel_id(),
1287 channel_value_satoshis: channel.get_value_satoshis(),
1288 unspendable_punishment_reserve: to_self_reserve_satoshis,
1289 inbound_capacity_msat,
1290 outbound_capacity_msat,
1291 user_id: channel.get_user_id(),
1292 confirmations_required: channel.minimum_depth(),
1293 force_close_spend_delay: channel.get_counterparty_selected_contest_delay(),
1294 is_outbound: channel.is_outbound(),
1295 is_funding_locked: channel.is_usable(),
1296 is_usable: channel.is_live(),
1297 is_public: channel.should_announce(),
1301 let per_peer_state = self.per_peer_state.read().unwrap();
1302 for chan in res.iter_mut() {
1303 if let Some(peer_state) = per_peer_state.get(&chan.counterparty.node_id) {
1304 chan.counterparty.features = peer_state.lock().unwrap().latest_features.clone();
1310 /// Gets the list of open channels, in random order. See ChannelDetail field documentation for
1311 /// more information.
1312 pub fn list_channels(&self) -> Vec<ChannelDetails> {
1313 self.list_channels_with_filter(|_| true)
1316 /// Gets the list of usable channels, in random order. Useful as an argument to
1317 /// get_route to ensure non-announced channels are used.
1319 /// These are guaranteed to have their [`ChannelDetails::is_usable`] value set to true, see the
1320 /// documentation for [`ChannelDetails::is_usable`] for more info on exactly what the criteria
1322 pub fn list_usable_channels(&self) -> Vec<ChannelDetails> {
1323 // Note we use is_live here instead of usable which leads to somewhat confused
1324 // internal/external nomenclature, but that's ok cause that's probably what the user
1325 // really wanted anyway.
1326 self.list_channels_with_filter(|&(_, ref channel)| channel.is_live())
1329 fn close_channel_internal(&self, channel_id: &[u8; 32], target_feerate_sats_per_1000_weight: Option<u32>) -> Result<(), APIError> {
1330 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1332 let counterparty_node_id;
1333 let mut failed_htlcs: Vec<(HTLCSource, PaymentHash)>;
1334 let result: Result<(), _> = loop {
1335 let mut channel_state_lock = self.channel_state.lock().unwrap();
1336 let channel_state = &mut *channel_state_lock;
1337 match channel_state.by_id.entry(channel_id.clone()) {
1338 hash_map::Entry::Occupied(mut chan_entry) => {
1339 counterparty_node_id = chan_entry.get().get_counterparty_node_id();
1340 let per_peer_state = self.per_peer_state.read().unwrap();
1341 let (shutdown_msg, monitor_update, htlcs) = match per_peer_state.get(&counterparty_node_id) {
1342 Some(peer_state) => {
1343 let peer_state = peer_state.lock().unwrap();
1344 let their_features = &peer_state.latest_features;
1345 chan_entry.get_mut().get_shutdown(&self.keys_manager, their_features, target_feerate_sats_per_1000_weight)?
1347 None => return Err(APIError::ChannelUnavailable { err: format!("Not connected to node: {}", counterparty_node_id) }),
1349 failed_htlcs = htlcs;
1351 // Update the monitor with the shutdown script if necessary.
1352 if let Some(monitor_update) = monitor_update {
1353 if let Err(e) = self.chain_monitor.update_channel(chan_entry.get().get_funding_txo().unwrap(), monitor_update) {
1354 let (result, is_permanent) =
1355 handle_monitor_err!(self, e, channel_state.short_to_id, chan_entry.get_mut(), RAACommitmentOrder::CommitmentFirst, false, false, Vec::new(), Vec::new(), chan_entry.key());
1357 remove_channel!(channel_state, chan_entry);
1363 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
1364 node_id: counterparty_node_id,
1368 if chan_entry.get().is_shutdown() {
1369 let channel = remove_channel!(channel_state, chan_entry);
1370 if let Ok(channel_update) = self.get_channel_update_for_broadcast(&channel) {
1371 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1375 if let Ok(mut pending_events_lock) = self.pending_events.lock() {
1376 pending_events_lock.push(events::Event::ChannelClosed {
1377 channel_id: *channel_id,
1378 reason: ClosureReason::HolderForceClosed
1384 hash_map::Entry::Vacant(_) => return Err(APIError::ChannelUnavailable{err: "No such channel".to_owned()})
1388 for htlc_source in failed_htlcs.drain(..) {
1389 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() });
1392 let _ = handle_error!(self, result, counterparty_node_id);
1396 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
1397 /// will be accepted on the given channel, and after additional timeout/the closing of all
1398 /// pending HTLCs, the channel will be closed on chain.
1400 /// * If we are the channel initiator, we will pay between our [`Background`] and
1401 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
1403 /// * If our counterparty is the channel initiator, we will require a channel closing
1404 /// transaction feerate of at least our [`Background`] feerate or the feerate which
1405 /// would appear on a force-closure transaction, whichever is lower. We will allow our
1406 /// counterparty to pay as much fee as they'd like, however.
1408 /// May generate a SendShutdown message event on success, which should be relayed.
1410 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
1411 /// [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
1412 /// [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
1413 pub fn close_channel(&self, channel_id: &[u8; 32]) -> Result<(), APIError> {
1414 self.close_channel_internal(channel_id, None)
1417 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
1418 /// will be accepted on the given channel, and after additional timeout/the closing of all
1419 /// pending HTLCs, the channel will be closed on chain.
1421 /// `target_feerate_sat_per_1000_weight` has different meanings depending on if we initiated
1422 /// the channel being closed or not:
1423 /// * If we are the channel initiator, we will pay at least this feerate on the closing
1424 /// transaction. The upper-bound is set by
1425 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
1426 /// estimate (or `target_feerate_sat_per_1000_weight`, if it is greater).
1427 /// * If our counterparty is the channel initiator, we will refuse to accept a channel closure
1428 /// transaction feerate below `target_feerate_sat_per_1000_weight` (or the feerate which
1429 /// will appear on a force-closure transaction, whichever is lower).
1431 /// May generate a SendShutdown message event on success, which should be relayed.
1433 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
1434 /// [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
1435 /// [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
1436 pub fn close_channel_with_target_feerate(&self, channel_id: &[u8; 32], target_feerate_sats_per_1000_weight: u32) -> Result<(), APIError> {
1437 self.close_channel_internal(channel_id, Some(target_feerate_sats_per_1000_weight))
1441 fn finish_force_close_channel(&self, shutdown_res: ShutdownResult) {
1442 let (monitor_update_option, mut failed_htlcs) = shutdown_res;
1443 log_debug!(self.logger, "Finishing force-closure of channel with {} HTLCs to fail", failed_htlcs.len());
1444 for htlc_source in failed_htlcs.drain(..) {
1445 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() });
1447 if let Some((funding_txo, monitor_update)) = monitor_update_option {
1448 // There isn't anything we can do if we get an update failure - we're already
1449 // force-closing. The monitor update on the required in-memory copy should broadcast
1450 // the latest local state, which is the best we can do anyway. Thus, it is safe to
1451 // ignore the result here.
1452 let _ = self.chain_monitor.update_channel(funding_txo, monitor_update);
1456 /// `peer_node_id` should be set when we receive a message from a peer, but not set when the
1457 /// user closes, which will be re-exposed as the `ChannelClosed` reason.
1458 fn force_close_channel_with_peer(&self, channel_id: &[u8; 32], peer_node_id: Option<&PublicKey>, peer_msg: Option<&String>) -> Result<PublicKey, APIError> {
1460 let mut channel_state_lock = self.channel_state.lock().unwrap();
1461 let channel_state = &mut *channel_state_lock;
1462 if let hash_map::Entry::Occupied(chan) = channel_state.by_id.entry(channel_id.clone()) {
1463 if let Some(node_id) = peer_node_id {
1464 if chan.get().get_counterparty_node_id() != *node_id {
1465 return Err(APIError::ChannelUnavailable{err: "No such channel".to_owned()});
1468 if let Some(short_id) = chan.get().get_short_channel_id() {
1469 channel_state.short_to_id.remove(&short_id);
1471 let mut pending_events_lock = self.pending_events.lock().unwrap();
1472 if peer_node_id.is_some() {
1473 if let Some(peer_msg) = peer_msg {
1474 pending_events_lock.push(events::Event::ChannelClosed { channel_id: *channel_id, reason: ClosureReason::CounterpartyForceClosed { peer_msg: peer_msg.to_string() } });
1477 pending_events_lock.push(events::Event::ChannelClosed { channel_id: *channel_id, reason: ClosureReason::HolderForceClosed });
1479 chan.remove_entry().1
1481 return Err(APIError::ChannelUnavailable{err: "No such channel".to_owned()});
1484 log_error!(self.logger, "Force-closing channel {}", log_bytes!(channel_id[..]));
1485 self.finish_force_close_channel(chan.force_shutdown(true));
1486 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
1487 let mut channel_state = self.channel_state.lock().unwrap();
1488 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1493 Ok(chan.get_counterparty_node_id())
1496 /// Force closes a channel, immediately broadcasting the latest local commitment transaction to
1497 /// the chain and rejecting new HTLCs on the given channel. Fails if channel_id is unknown to the manager.
1498 pub fn force_close_channel(&self, channel_id: &[u8; 32]) -> Result<(), APIError> {
1499 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1500 match self.force_close_channel_with_peer(channel_id, None, None) {
1501 Ok(counterparty_node_id) => {
1502 self.channel_state.lock().unwrap().pending_msg_events.push(
1503 events::MessageSendEvent::HandleError {
1504 node_id: counterparty_node_id,
1505 action: msgs::ErrorAction::SendErrorMessage {
1506 msg: msgs::ErrorMessage { channel_id: *channel_id, data: "Channel force-closed".to_owned() }
1516 /// Force close all channels, immediately broadcasting the latest local commitment transaction
1517 /// for each to the chain and rejecting new HTLCs on each.
1518 pub fn force_close_all_channels(&self) {
1519 for chan in self.list_channels() {
1520 let _ = self.force_close_channel(&chan.channel_id);
1524 fn decode_update_add_htlc_onion(&self, msg: &msgs::UpdateAddHTLC) -> (PendingHTLCStatus, MutexGuard<ChannelHolder<Signer>>) {
1525 macro_rules! return_malformed_err {
1526 ($msg: expr, $err_code: expr) => {
1528 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
1529 return (PendingHTLCStatus::Fail(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
1530 channel_id: msg.channel_id,
1531 htlc_id: msg.htlc_id,
1532 sha256_of_onion: Sha256::hash(&msg.onion_routing_packet.hop_data).into_inner(),
1533 failure_code: $err_code,
1534 })), self.channel_state.lock().unwrap());
1539 if let Err(_) = msg.onion_routing_packet.public_key {
1540 return_malformed_err!("invalid ephemeral pubkey", 0x8000 | 0x4000 | 6);
1543 let shared_secret = {
1544 let mut arr = [0; 32];
1545 arr.copy_from_slice(&SharedSecret::new(&msg.onion_routing_packet.public_key.unwrap(), &self.our_network_key)[..]);
1548 let (rho, mu) = onion_utils::gen_rho_mu_from_shared_secret(&shared_secret);
1550 if msg.onion_routing_packet.version != 0 {
1551 //TODO: Spec doesn't indicate if we should only hash hop_data here (and in other
1552 //sha256_of_onion error data packets), or the entire onion_routing_packet. Either way,
1553 //the hash doesn't really serve any purpose - in the case of hashing all data, the
1554 //receiving node would have to brute force to figure out which version was put in the
1555 //packet by the node that send us the message, in the case of hashing the hop_data, the
1556 //node knows the HMAC matched, so they already know what is there...
1557 return_malformed_err!("Unknown onion packet version", 0x8000 | 0x4000 | 4);
1560 let mut hmac = HmacEngine::<Sha256>::new(&mu);
1561 hmac.input(&msg.onion_routing_packet.hop_data);
1562 hmac.input(&msg.payment_hash.0[..]);
1563 if !fixed_time_eq(&Hmac::from_engine(hmac).into_inner(), &msg.onion_routing_packet.hmac) {
1564 return_malformed_err!("HMAC Check failed", 0x8000 | 0x4000 | 5);
1567 let mut channel_state = None;
1568 macro_rules! return_err {
1569 ($msg: expr, $err_code: expr, $data: expr) => {
1571 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
1572 if channel_state.is_none() {
1573 channel_state = Some(self.channel_state.lock().unwrap());
1575 return (PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
1576 channel_id: msg.channel_id,
1577 htlc_id: msg.htlc_id,
1578 reason: onion_utils::build_first_hop_failure_packet(&shared_secret, $err_code, $data),
1579 })), channel_state.unwrap());
1584 let mut chacha = ChaCha20::new(&rho, &[0u8; 8]);
1585 let mut chacha_stream = ChaChaReader { chacha: &mut chacha, read: Cursor::new(&msg.onion_routing_packet.hop_data[..]) };
1586 let (next_hop_data, next_hop_hmac): (msgs::OnionHopData, _) = {
1587 match <msgs::OnionHopData as Readable>::read(&mut chacha_stream) {
1589 let error_code = match err {
1590 msgs::DecodeError::UnknownVersion => 0x4000 | 1, // unknown realm byte
1591 msgs::DecodeError::UnknownRequiredFeature|
1592 msgs::DecodeError::InvalidValue|
1593 msgs::DecodeError::ShortRead => 0x4000 | 22, // invalid_onion_payload
1594 _ => 0x2000 | 2, // Should never happen
1596 return_err!("Unable to decode our hop data", error_code, &[0;0]);
1599 let mut hmac = [0; 32];
1600 if let Err(_) = chacha_stream.read_exact(&mut hmac[..]) {
1601 return_err!("Unable to decode hop data", 0x4000 | 22, &[0;0]);
1608 let pending_forward_info = if next_hop_hmac == [0; 32] {
1611 // In tests, make sure that the initial onion pcket data is, at least, non-0.
1612 // We could do some fancy randomness test here, but, ehh, whatever.
1613 // This checks for the issue where you can calculate the path length given the
1614 // onion data as all the path entries that the originator sent will be here
1615 // as-is (and were originally 0s).
1616 // Of course reverse path calculation is still pretty easy given naive routing
1617 // algorithms, but this fixes the most-obvious case.
1618 let mut next_bytes = [0; 32];
1619 chacha_stream.read_exact(&mut next_bytes).unwrap();
1620 assert_ne!(next_bytes[..], [0; 32][..]);
1621 chacha_stream.read_exact(&mut next_bytes).unwrap();
1622 assert_ne!(next_bytes[..], [0; 32][..]);
1626 // final_expiry_too_soon
1627 // We have to have some headroom to broadcast on chain if we have the preimage, so make sure
1628 // we have at least HTLC_FAIL_BACK_BUFFER blocks to go.
1629 // Also, ensure that, in the case of an unknown preimage for the received payment hash, our
1630 // payment logic has enough time to fail the HTLC backward before our onchain logic triggers a
1631 // channel closure (see HTLC_FAIL_BACK_BUFFER rationale).
1632 if (msg.cltv_expiry as u64) <= self.best_block.read().unwrap().height() as u64 + HTLC_FAIL_BACK_BUFFER as u64 + 1 {
1633 return_err!("The final CLTV expiry is too soon to handle", 17, &[0;0]);
1635 // final_incorrect_htlc_amount
1636 if next_hop_data.amt_to_forward > msg.amount_msat {
1637 return_err!("Upstream node sent less than we were supposed to receive in payment", 19, &byte_utils::be64_to_array(msg.amount_msat));
1639 // final_incorrect_cltv_expiry
1640 if next_hop_data.outgoing_cltv_value != msg.cltv_expiry {
1641 return_err!("Upstream node set CLTV to the wrong value", 18, &byte_utils::be32_to_array(msg.cltv_expiry));
1644 let routing = match next_hop_data.format {
1645 msgs::OnionHopDataFormat::Legacy { .. } => return_err!("We require payment_secrets", 0x4000|0x2000|3, &[0;0]),
1646 msgs::OnionHopDataFormat::NonFinalNode { .. } => return_err!("Got non final data with an HMAC of 0", 0x4000 | 22, &[0;0]),
1647 msgs::OnionHopDataFormat::FinalNode { payment_data, keysend_preimage } => {
1648 if payment_data.is_some() && keysend_preimage.is_some() {
1649 return_err!("We don't support MPP keysend payments", 0x4000|22, &[0;0]);
1650 } else if let Some(data) = payment_data {
1651 PendingHTLCRouting::Receive {
1653 incoming_cltv_expiry: msg.cltv_expiry,
1655 } else if let Some(payment_preimage) = keysend_preimage {
1656 // We need to check that the sender knows the keysend preimage before processing this
1657 // payment further. Otherwise, an intermediary routing hop forwarding non-keysend-HTLC X
1658 // could discover the final destination of X, by probing the adjacent nodes on the route
1659 // with a keysend payment of identical payment hash to X and observing the processing
1660 // time discrepancies due to a hash collision with X.
1661 let hashed_preimage = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
1662 if hashed_preimage != msg.payment_hash {
1663 return_err!("Payment preimage didn't match payment hash", 0x4000|22, &[0;0]);
1666 PendingHTLCRouting::ReceiveKeysend {
1668 incoming_cltv_expiry: msg.cltv_expiry,
1671 return_err!("We require payment_secrets", 0x4000|0x2000|3, &[0;0]);
1676 // Note that we could obviously respond immediately with an update_fulfill_htlc
1677 // message, however that would leak that we are the recipient of this payment, so
1678 // instead we stay symmetric with the forwarding case, only responding (after a
1679 // delay) once they've send us a commitment_signed!
1681 PendingHTLCStatus::Forward(PendingHTLCInfo {
1683 payment_hash: msg.payment_hash.clone(),
1684 incoming_shared_secret: shared_secret,
1685 amt_to_forward: next_hop_data.amt_to_forward,
1686 outgoing_cltv_value: next_hop_data.outgoing_cltv_value,
1689 let mut new_packet_data = [0; 20*65];
1690 let read_pos = chacha_stream.read(&mut new_packet_data).unwrap();
1691 #[cfg(debug_assertions)]
1693 // Check two things:
1694 // a) that the behavior of our stream here will return Ok(0) even if the TLV
1695 // read above emptied out our buffer and the unwrap() wont needlessly panic
1696 // b) that we didn't somehow magically end up with extra data.
1698 debug_assert!(chacha_stream.read(&mut t).unwrap() == 0);
1700 // Once we've emptied the set of bytes our peer gave us, encrypt 0 bytes until we
1701 // fill the onion hop data we'll forward to our next-hop peer.
1702 chacha_stream.chacha.process_in_place(&mut new_packet_data[read_pos..]);
1704 let mut new_pubkey = msg.onion_routing_packet.public_key.unwrap();
1706 let blinding_factor = {
1707 let mut sha = Sha256::engine();
1708 sha.input(&new_pubkey.serialize()[..]);
1709 sha.input(&shared_secret);
1710 Sha256::from_engine(sha).into_inner()
1713 let public_key = if let Err(e) = new_pubkey.mul_assign(&self.secp_ctx, &blinding_factor[..]) {
1715 } else { Ok(new_pubkey) };
1717 let outgoing_packet = msgs::OnionPacket {
1720 hop_data: new_packet_data,
1721 hmac: next_hop_hmac.clone(),
1724 let short_channel_id = match next_hop_data.format {
1725 msgs::OnionHopDataFormat::Legacy { short_channel_id } => short_channel_id,
1726 msgs::OnionHopDataFormat::NonFinalNode { short_channel_id } => short_channel_id,
1727 msgs::OnionHopDataFormat::FinalNode { .. } => {
1728 return_err!("Final Node OnionHopData provided for us as an intermediary node", 0x4000 | 22, &[0;0]);
1732 PendingHTLCStatus::Forward(PendingHTLCInfo {
1733 routing: PendingHTLCRouting::Forward {
1734 onion_packet: outgoing_packet,
1737 payment_hash: msg.payment_hash.clone(),
1738 incoming_shared_secret: shared_secret,
1739 amt_to_forward: next_hop_data.amt_to_forward,
1740 outgoing_cltv_value: next_hop_data.outgoing_cltv_value,
1744 channel_state = Some(self.channel_state.lock().unwrap());
1745 if let &PendingHTLCStatus::Forward(PendingHTLCInfo { ref routing, ref amt_to_forward, ref outgoing_cltv_value, .. }) = &pending_forward_info {
1746 // If short_channel_id is 0 here, we'll reject the HTLC as there cannot be a channel
1747 // with a short_channel_id of 0. This is important as various things later assume
1748 // short_channel_id is non-0 in any ::Forward.
1749 if let &PendingHTLCRouting::Forward { ref short_channel_id, .. } = routing {
1750 let id_option = channel_state.as_ref().unwrap().short_to_id.get(&short_channel_id).cloned();
1751 if let Some((err, code, chan_update)) = loop {
1752 let forwarding_id = match id_option {
1753 None => { // unknown_next_peer
1754 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
1756 Some(id) => id.clone(),
1759 let chan = channel_state.as_mut().unwrap().by_id.get_mut(&forwarding_id).unwrap();
1761 if !chan.should_announce() && !self.default_configuration.accept_forwards_to_priv_channels {
1762 // Note that the behavior here should be identical to the above block - we
1763 // should NOT reveal the existence or non-existence of a private channel if
1764 // we don't allow forwards outbound over them.
1765 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
1768 // Note that we could technically not return an error yet here and just hope
1769 // that the connection is reestablished or monitor updated by the time we get
1770 // around to doing the actual forward, but better to fail early if we can and
1771 // hopefully an attacker trying to path-trace payments cannot make this occur
1772 // on a small/per-node/per-channel scale.
1773 if !chan.is_live() { // channel_disabled
1774 break Some(("Forwarding channel is not in a ready state.", 0x1000 | 20, Some(self.get_channel_update_for_unicast(chan).unwrap())));
1776 if *amt_to_forward < chan.get_counterparty_htlc_minimum_msat() { // amount_below_minimum
1777 break Some(("HTLC amount was below the htlc_minimum_msat", 0x1000 | 11, Some(self.get_channel_update_for_unicast(chan).unwrap())));
1779 let fee = amt_to_forward.checked_mul(chan.get_fee_proportional_millionths() as u64)
1780 .and_then(|prop_fee| { (prop_fee / 1000000)
1781 .checked_add(chan.get_outbound_forwarding_fee_base_msat() as u64) });
1782 if fee.is_none() || msg.amount_msat < fee.unwrap() || (msg.amount_msat - fee.unwrap()) < *amt_to_forward { // fee_insufficient
1783 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())));
1785 if (msg.cltv_expiry as u64) < (*outgoing_cltv_value) as u64 + chan.get_cltv_expiry_delta() as u64 { // incorrect_cltv_expiry
1786 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())));
1788 let cur_height = self.best_block.read().unwrap().height() + 1;
1789 // Theoretically, channel counterparty shouldn't send us a HTLC expiring now, but we want to be robust wrt to counterparty
1790 // packet sanitization (see HTLC_FAIL_BACK_BUFFER rational)
1791 if msg.cltv_expiry <= cur_height + HTLC_FAIL_BACK_BUFFER as u32 { // expiry_too_soon
1792 break Some(("CLTV expiry is too close", 0x1000 | 14, Some(self.get_channel_update_for_unicast(chan).unwrap())));
1794 if msg.cltv_expiry > cur_height + CLTV_FAR_FAR_AWAY as u32 { // expiry_too_far
1795 break Some(("CLTV expiry is too far in the future", 21, None));
1797 // In theory, we would be safe against unintentional channel-closure, if we only required a margin of LATENCY_GRACE_PERIOD_BLOCKS.
1798 // But, to be safe against policy reception, we use a longer delay.
1799 if (*outgoing_cltv_value) as u64 <= (cur_height + HTLC_FAIL_BACK_BUFFER) as u64 {
1800 break Some(("Outgoing CLTV value is too soon", 0x1000 | 14, Some(self.get_channel_update_for_unicast(chan).unwrap())));
1806 let mut res = Vec::with_capacity(8 + 128);
1807 if let Some(chan_update) = chan_update {
1808 if code == 0x1000 | 11 || code == 0x1000 | 12 {
1809 res.extend_from_slice(&byte_utils::be64_to_array(msg.amount_msat));
1811 else if code == 0x1000 | 13 {
1812 res.extend_from_slice(&byte_utils::be32_to_array(msg.cltv_expiry));
1814 else if code == 0x1000 | 20 {
1815 // TODO: underspecified, follow https://github.com/lightningnetwork/lightning-rfc/issues/791
1816 res.extend_from_slice(&byte_utils::be16_to_array(0));
1818 res.extend_from_slice(&chan_update.encode_with_len()[..]);
1820 return_err!(err, code, &res[..]);
1825 (pending_forward_info, channel_state.unwrap())
1828 /// Gets the current channel_update for the given channel. This first checks if the channel is
1829 /// public, and thus should be called whenever the result is going to be passed out in a
1830 /// [`MessageSendEvent::BroadcastChannelUpdate`] event.
1832 /// May be called with channel_state already locked!
1833 fn get_channel_update_for_broadcast(&self, chan: &Channel<Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
1834 if !chan.should_announce() {
1835 return Err(LightningError {
1836 err: "Cannot broadcast a channel_update for a private channel".to_owned(),
1837 action: msgs::ErrorAction::IgnoreError
1840 log_trace!(self.logger, "Attempting to generate broadcast channel update for channel {}", log_bytes!(chan.channel_id()));
1841 self.get_channel_update_for_unicast(chan)
1844 /// Gets the current channel_update for the given channel. This does not check if the channel
1845 /// is public (only returning an Err if the channel does not yet have an assigned short_id),
1846 /// and thus MUST NOT be called unless the recipient of the resulting message has already
1847 /// provided evidence that they know about the existence of the channel.
1848 /// May be called with channel_state already locked!
1849 fn get_channel_update_for_unicast(&self, chan: &Channel<Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
1850 log_trace!(self.logger, "Attempting to generate channel update for channel {}", log_bytes!(chan.channel_id()));
1851 let short_channel_id = match chan.get_short_channel_id() {
1852 None => return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError}),
1856 let were_node_one = PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key).serialize()[..] < chan.get_counterparty_node_id().serialize()[..];
1858 let unsigned = msgs::UnsignedChannelUpdate {
1859 chain_hash: self.genesis_hash,
1861 timestamp: chan.get_update_time_counter(),
1862 flags: (!were_node_one) as u8 | ((!chan.is_live() as u8) << 1),
1863 cltv_expiry_delta: chan.get_cltv_expiry_delta(),
1864 htlc_minimum_msat: chan.get_counterparty_htlc_minimum_msat(),
1865 htlc_maximum_msat: OptionalField::Present(chan.get_announced_htlc_max_msat()),
1866 fee_base_msat: chan.get_outbound_forwarding_fee_base_msat(),
1867 fee_proportional_millionths: chan.get_fee_proportional_millionths(),
1868 excess_data: Vec::new(),
1871 let msg_hash = Sha256dHash::hash(&unsigned.encode()[..]);
1872 let sig = self.secp_ctx.sign(&hash_to_message!(&msg_hash[..]), &self.our_network_key);
1874 Ok(msgs::ChannelUpdate {
1880 // Only public for testing, this should otherwise never be called direcly
1881 pub(crate) fn send_payment_along_path(&self, path: &Vec<RouteHop>, payment_hash: &PaymentHash, payment_secret: &Option<PaymentSecret>, total_value: u64, cur_height: u32, payment_id: PaymentId, keysend_preimage: &Option<PaymentPreimage>) -> Result<(), APIError> {
1882 log_trace!(self.logger, "Attempting to send payment for path with next hop {}", path.first().unwrap().short_channel_id);
1883 let prng_seed = self.keys_manager.get_secure_random_bytes();
1884 let session_priv_bytes = self.keys_manager.get_secure_random_bytes();
1885 let session_priv = SecretKey::from_slice(&session_priv_bytes[..]).expect("RNG is busted");
1887 let onion_keys = onion_utils::construct_onion_keys(&self.secp_ctx, &path, &session_priv)
1888 .map_err(|_| APIError::RouteError{err: "Pubkey along hop was maliciously selected"})?;
1889 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(path, total_value, payment_secret, cur_height, keysend_preimage)?;
1890 if onion_utils::route_size_insane(&onion_payloads) {
1891 return Err(APIError::RouteError{err: "Route size too large considering onion data"});
1893 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, prng_seed, payment_hash);
1895 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1896 let mut pending_outbounds = self.pending_outbound_payments.lock().unwrap();
1897 let sessions = pending_outbounds.entry(payment_id).or_insert(HashSet::new());
1898 assert!(sessions.insert(session_priv_bytes));
1900 let err: Result<(), _> = loop {
1901 let mut channel_lock = self.channel_state.lock().unwrap();
1902 let id = match channel_lock.short_to_id.get(&path.first().unwrap().short_channel_id) {
1903 None => return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()}),
1904 Some(id) => id.clone(),
1907 let channel_state = &mut *channel_lock;
1908 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(id) {
1910 if chan.get().get_counterparty_node_id() != path.first().unwrap().pubkey {
1911 return Err(APIError::RouteError{err: "Node ID mismatch on first hop!"});
1913 if !chan.get().is_live() {
1914 return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected/pending monitor update!".to_owned()});
1916 break_chan_entry!(self, chan.get_mut().send_htlc_and_commit(htlc_msat, payment_hash.clone(), htlc_cltv, HTLCSource::OutboundRoute {
1918 session_priv: session_priv.clone(),
1919 first_hop_htlc_msat: htlc_msat,
1921 }, onion_packet, &self.logger), channel_state, chan)
1923 Some((update_add, commitment_signed, monitor_update)) => {
1924 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
1925 maybe_break_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, true);
1926 // Note that MonitorUpdateFailed here indicates (per function docs)
1927 // that we will resend the commitment update once monitor updating
1928 // is restored. Therefore, we must return an error indicating that
1929 // it is unsafe to retry the payment wholesale, which we do in the
1930 // send_payment check for MonitorUpdateFailed, below.
1931 return Err(APIError::MonitorUpdateFailed);
1934 log_debug!(self.logger, "Sending payment along path resulted in a commitment_signed for channel {}", log_bytes!(chan.get().channel_id()));
1935 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1936 node_id: path.first().unwrap().pubkey,
1937 updates: msgs::CommitmentUpdate {
1938 update_add_htlcs: vec![update_add],
1939 update_fulfill_htlcs: Vec::new(),
1940 update_fail_htlcs: Vec::new(),
1941 update_fail_malformed_htlcs: Vec::new(),
1949 } else { unreachable!(); }
1953 match handle_error!(self, err, path.first().unwrap().pubkey) {
1954 Ok(_) => unreachable!(),
1956 Err(APIError::ChannelUnavailable { err: e.err })
1961 /// Sends a payment along a given route.
1963 /// Value parameters are provided via the last hop in route, see documentation for RouteHop
1964 /// fields for more info.
1966 /// Note that if the payment_hash already exists elsewhere (eg you're sending a duplicative
1967 /// payment), we don't do anything to stop you! We always try to ensure that if the provided
1968 /// next hop knows the preimage to payment_hash they can claim an additional amount as
1969 /// specified in the last hop in the route! Thus, you should probably do your own
1970 /// payment_preimage tracking (which you should already be doing as they represent "proof of
1971 /// payment") and prevent double-sends yourself.
1973 /// May generate SendHTLCs message(s) event on success, which should be relayed.
1975 /// Each path may have a different return value, and PaymentSendValue may return a Vec with
1976 /// each entry matching the corresponding-index entry in the route paths, see
1977 /// PaymentSendFailure for more info.
1979 /// In general, a path may raise:
1980 /// * APIError::RouteError when an invalid route or forwarding parameter (cltv_delta, fee,
1981 /// node public key) is specified.
1982 /// * APIError::ChannelUnavailable if the next-hop channel is not available for updates
1983 /// (including due to previous monitor update failure or new permanent monitor update
1985 /// * APIError::MonitorUpdateFailed if a new monitor update failure prevented sending the
1986 /// relevant updates.
1988 /// Note that depending on the type of the PaymentSendFailure the HTLC may have been
1989 /// irrevocably committed to on our end. In such a case, do NOT retry the payment with a
1990 /// different route unless you intend to pay twice!
1992 /// payment_secret is unrelated to payment_hash (or PaymentPreimage) and exists to authenticate
1993 /// the sender to the recipient and prevent payment-probing (deanonymization) attacks. For
1994 /// newer nodes, it will be provided to you in the invoice. If you do not have one, the Route
1995 /// must not contain multiple paths as multi-path payments require a recipient-provided
1997 /// If a payment_secret *is* provided, we assume that the invoice had the payment_secret feature
1998 /// bit set (either as required or as available). If multiple paths are present in the Route,
1999 /// we assume the invoice had the basic_mpp feature set.
2000 pub fn send_payment(&self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>) -> Result<PaymentId, PaymentSendFailure> {
2001 self.send_payment_internal(route, payment_hash, payment_secret, None, None, None)
2004 fn send_payment_internal(&self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>, keysend_preimage: Option<PaymentPreimage>, payment_id: Option<PaymentId>, recv_value_msat: Option<u64>) -> Result<PaymentId, PaymentSendFailure> {
2005 if route.paths.len() < 1 {
2006 return Err(PaymentSendFailure::ParameterError(APIError::RouteError{err: "There must be at least one path to send over"}));
2008 if route.paths.len() > 10 {
2009 // This limit is completely arbitrary - there aren't any real fundamental path-count
2010 // limits. After we support retrying individual paths we should likely bump this, but
2011 // for now more than 10 paths likely carries too much one-path failure.
2012 return Err(PaymentSendFailure::ParameterError(APIError::RouteError{err: "Sending over more than 10 paths is not currently supported"}));
2014 if payment_secret.is_none() && route.paths.len() > 1 {
2015 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError{err: "Payment secret is required for multi-path payments".to_string()}));
2017 let mut total_value = 0;
2018 let our_node_id = self.get_our_node_id();
2019 let mut path_errs = Vec::with_capacity(route.paths.len());
2020 let payment_id = if let Some(id) = payment_id { id } else { PaymentId(self.keys_manager.get_secure_random_bytes()) };
2021 'path_check: for path in route.paths.iter() {
2022 if path.len() < 1 || path.len() > 20 {
2023 path_errs.push(Err(APIError::RouteError{err: "Path didn't go anywhere/had bogus size"}));
2024 continue 'path_check;
2026 for (idx, hop) in path.iter().enumerate() {
2027 if idx != path.len() - 1 && hop.pubkey == our_node_id {
2028 path_errs.push(Err(APIError::RouteError{err: "Path went through us but wasn't a simple rebalance loop to us"}));
2029 continue 'path_check;
2032 total_value += path.last().unwrap().fee_msat;
2033 path_errs.push(Ok(()));
2035 if path_errs.iter().any(|e| e.is_err()) {
2036 return Err(PaymentSendFailure::PathParameterError(path_errs));
2038 if let Some(amt_msat) = recv_value_msat {
2039 debug_assert!(amt_msat >= total_value);
2040 total_value = amt_msat;
2043 let cur_height = self.best_block.read().unwrap().height() + 1;
2044 let mut results = Vec::new();
2045 for path in route.paths.iter() {
2046 results.push(self.send_payment_along_path(&path, &payment_hash, payment_secret, total_value, cur_height, payment_id, &keysend_preimage));
2048 let mut has_ok = false;
2049 let mut has_err = false;
2050 for res in results.iter() {
2051 if res.is_ok() { has_ok = true; }
2052 if res.is_err() { has_err = true; }
2053 if let &Err(APIError::MonitorUpdateFailed) = res {
2054 // MonitorUpdateFailed is inherently unsafe to retry, so we call it a
2061 if has_err && has_ok {
2062 Err(PaymentSendFailure::PartialFailure(results))
2064 Err(PaymentSendFailure::AllFailedRetrySafe(results.drain(..).map(|r| r.unwrap_err()).collect()))
2070 /// Send a spontaneous payment, which is a payment that does not require the recipient to have
2071 /// generated an invoice. Optionally, you may specify the preimage. If you do choose to specify
2072 /// the preimage, it must be a cryptographically secure random value that no intermediate node
2073 /// would be able to guess -- otherwise, an intermediate node may claim the payment and it will
2074 /// never reach the recipient.
2076 /// See [`send_payment`] documentation for more details on the return value of this function.
2078 /// Similar to regular payments, you MUST NOT reuse a `payment_preimage` value. See
2079 /// [`send_payment`] for more information about the risks of duplicate preimage usage.
2081 /// Note that `route` must have exactly one path.
2083 /// [`send_payment`]: Self::send_payment
2084 pub fn send_spontaneous_payment(&self, route: &Route, payment_preimage: Option<PaymentPreimage>) -> Result<(PaymentHash, PaymentId), PaymentSendFailure> {
2085 let preimage = match payment_preimage {
2087 None => PaymentPreimage(self.keys_manager.get_secure_random_bytes()),
2089 let payment_hash = PaymentHash(Sha256::hash(&preimage.0).into_inner());
2090 match self.send_payment_internal(route, payment_hash, &None, Some(preimage), None, None) {
2091 Ok(payment_id) => Ok((payment_hash, payment_id)),
2096 /// Handles the generation of a funding transaction, optionally (for tests) with a function
2097 /// which checks the correctness of the funding transaction given the associated channel.
2098 fn funding_transaction_generated_intern<FundingOutput: Fn(&Channel<Signer>, &Transaction) -> Result<OutPoint, APIError>>
2099 (&self, temporary_channel_id: &[u8; 32], funding_transaction: Transaction, find_funding_output: FundingOutput) -> Result<(), APIError> {
2101 let (res, chan) = match self.channel_state.lock().unwrap().by_id.remove(temporary_channel_id) {
2103 let funding_txo = find_funding_output(&chan, &funding_transaction)?;
2105 (chan.get_outbound_funding_created(funding_transaction, funding_txo, &self.logger)
2106 .map_err(|e| if let ChannelError::Close(msg) = e {
2107 MsgHandleErrInternal::from_finish_shutdown(msg, chan.channel_id(), chan.force_shutdown(true), None)
2108 } else { unreachable!(); })
2111 None => { return Err(APIError::ChannelUnavailable { err: "No such channel".to_owned() }) },
2113 match handle_error!(self, res, chan.get_counterparty_node_id()) {
2114 Ok(funding_msg) => {
2117 Err(_) => { return Err(APIError::ChannelUnavailable {
2118 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()
2123 let mut channel_state = self.channel_state.lock().unwrap();
2124 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
2125 node_id: chan.get_counterparty_node_id(),
2128 match channel_state.by_id.entry(chan.channel_id()) {
2129 hash_map::Entry::Occupied(_) => {
2130 panic!("Generated duplicate funding txid?");
2132 hash_map::Entry::Vacant(e) => {
2140 pub(crate) fn funding_transaction_generated_unchecked(&self, temporary_channel_id: &[u8; 32], funding_transaction: Transaction, output_index: u16) -> Result<(), APIError> {
2141 self.funding_transaction_generated_intern(temporary_channel_id, funding_transaction, |_, tx| {
2142 Ok(OutPoint { txid: tx.txid(), index: output_index })
2146 /// Call this upon creation of a funding transaction for the given channel.
2148 /// Returns an [`APIError::APIMisuseError`] if the funding_transaction spent non-SegWit outputs
2149 /// or if no output was found which matches the parameters in [`Event::FundingGenerationReady`].
2151 /// Panics if a funding transaction has already been provided for this channel.
2153 /// May panic if the output found in the funding transaction is duplicative with some other
2154 /// channel (note that this should be trivially prevented by using unique funding transaction
2155 /// keys per-channel).
2157 /// Do NOT broadcast the funding transaction yourself. When we have safely received our
2158 /// counterparty's signature the funding transaction will automatically be broadcast via the
2159 /// [`BroadcasterInterface`] provided when this `ChannelManager` was constructed.
2161 /// Note that this includes RBF or similar transaction replacement strategies - lightning does
2162 /// not currently support replacing a funding transaction on an existing channel. Instead,
2163 /// create a new channel with a conflicting funding transaction.
2165 /// [`Event::FundingGenerationReady`]: crate::util::events::Event::FundingGenerationReady
2166 pub fn funding_transaction_generated(&self, temporary_channel_id: &[u8; 32], funding_transaction: Transaction) -> Result<(), APIError> {
2167 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2169 for inp in funding_transaction.input.iter() {
2170 if inp.witness.is_empty() {
2171 return Err(APIError::APIMisuseError {
2172 err: "Funding transaction must be fully signed and spend Segwit outputs".to_owned()
2176 self.funding_transaction_generated_intern(temporary_channel_id, funding_transaction, |chan, tx| {
2177 let mut output_index = None;
2178 let expected_spk = chan.get_funding_redeemscript().to_v0_p2wsh();
2179 for (idx, outp) in tx.output.iter().enumerate() {
2180 if outp.script_pubkey == expected_spk && outp.value == chan.get_value_satoshis() {
2181 if output_index.is_some() {
2182 return Err(APIError::APIMisuseError {
2183 err: "Multiple outputs matched the expected script and value".to_owned()
2186 if idx > u16::max_value() as usize {
2187 return Err(APIError::APIMisuseError {
2188 err: "Transaction had more than 2^16 outputs, which is not supported".to_owned()
2191 output_index = Some(idx as u16);
2194 if output_index.is_none() {
2195 return Err(APIError::APIMisuseError {
2196 err: "No output matched the script_pubkey and value in the FundingGenerationReady event".to_owned()
2199 Ok(OutPoint { txid: tx.txid(), index: output_index.unwrap() })
2203 fn get_announcement_sigs(&self, chan: &Channel<Signer>) -> Option<msgs::AnnouncementSignatures> {
2204 if !chan.should_announce() {
2205 log_trace!(self.logger, "Can't send announcement_signatures for private channel {}", log_bytes!(chan.channel_id()));
2209 let (announcement, our_bitcoin_sig) = match chan.get_channel_announcement(self.get_our_node_id(), self.genesis_hash.clone()) {
2211 Err(_) => return None, // Only in case of state precondition violations eg channel is closing
2213 let msghash = hash_to_message!(&Sha256dHash::hash(&announcement.encode()[..])[..]);
2214 let our_node_sig = self.secp_ctx.sign(&msghash, &self.our_network_key);
2216 Some(msgs::AnnouncementSignatures {
2217 channel_id: chan.channel_id(),
2218 short_channel_id: chan.get_short_channel_id().unwrap(),
2219 node_signature: our_node_sig,
2220 bitcoin_signature: our_bitcoin_sig,
2225 // Messages of up to 64KB should never end up more than half full with addresses, as that would
2226 // be absurd. We ensure this by checking that at least 500 (our stated public contract on when
2227 // broadcast_node_announcement panics) of the maximum-length addresses would fit in a 64KB
2229 const HALF_MESSAGE_IS_ADDRS: u32 = ::core::u16::MAX as u32 / (NetAddress::MAX_LEN as u32 + 1) / 2;
2232 // ...by failing to compile if the number of addresses that would be half of a message is
2233 // smaller than 500:
2234 const STATIC_ASSERT: u32 = Self::HALF_MESSAGE_IS_ADDRS - 500;
2236 /// Regenerates channel_announcements and generates a signed node_announcement from the given
2237 /// arguments, providing them in corresponding events via
2238 /// [`get_and_clear_pending_msg_events`], if at least one public channel has been confirmed
2239 /// on-chain. This effectively re-broadcasts all channel announcements and sends our node
2240 /// announcement to ensure that the lightning P2P network is aware of the channels we have and
2241 /// our network addresses.
2243 /// `rgb` is a node "color" and `alias` is a printable human-readable string to describe this
2244 /// node to humans. They carry no in-protocol meaning.
2246 /// `addresses` represent the set (possibly empty) of socket addresses on which this node
2247 /// accepts incoming connections. These will be included in the node_announcement, publicly
2248 /// tying these addresses together and to this node. If you wish to preserve user privacy,
2249 /// addresses should likely contain only Tor Onion addresses.
2251 /// Panics if `addresses` is absurdly large (more than 500).
2253 /// [`get_and_clear_pending_msg_events`]: MessageSendEventsProvider::get_and_clear_pending_msg_events
2254 pub fn broadcast_node_announcement(&self, rgb: [u8; 3], alias: [u8; 32], mut addresses: Vec<NetAddress>) {
2255 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2257 if addresses.len() > 500 {
2258 panic!("More than half the message size was taken up by public addresses!");
2261 // While all existing nodes handle unsorted addresses just fine, the spec requires that
2262 // addresses be sorted for future compatibility.
2263 addresses.sort_by_key(|addr| addr.get_id());
2265 let announcement = msgs::UnsignedNodeAnnouncement {
2266 features: NodeFeatures::known(),
2267 timestamp: self.last_node_announcement_serial.fetch_add(1, Ordering::AcqRel) as u32,
2268 node_id: self.get_our_node_id(),
2269 rgb, alias, addresses,
2270 excess_address_data: Vec::new(),
2271 excess_data: Vec::new(),
2273 let msghash = hash_to_message!(&Sha256dHash::hash(&announcement.encode()[..])[..]);
2274 let node_announce_sig = self.secp_ctx.sign(&msghash, &self.our_network_key);
2276 let mut channel_state_lock = self.channel_state.lock().unwrap();
2277 let channel_state = &mut *channel_state_lock;
2279 let mut announced_chans = false;
2280 for (_, chan) in channel_state.by_id.iter() {
2281 if let Some(msg) = chan.get_signed_channel_announcement(&self.our_network_key, self.get_our_node_id(), self.genesis_hash.clone()) {
2282 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
2284 update_msg: match self.get_channel_update_for_broadcast(chan) {
2289 announced_chans = true;
2291 // If the channel is not public or has not yet reached funding_locked, check the
2292 // next channel. If we don't yet have any public channels, we'll skip the broadcast
2293 // below as peers may not accept it without channels on chain first.
2297 if announced_chans {
2298 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastNodeAnnouncement {
2299 msg: msgs::NodeAnnouncement {
2300 signature: node_announce_sig,
2301 contents: announcement
2307 /// Processes HTLCs which are pending waiting on random forward delay.
2309 /// Should only really ever be called in response to a PendingHTLCsForwardable event.
2310 /// Will likely generate further events.
2311 pub fn process_pending_htlc_forwards(&self) {
2312 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2314 let mut new_events = Vec::new();
2315 let mut failed_forwards = Vec::new();
2316 let mut handle_errors = Vec::new();
2318 let mut channel_state_lock = self.channel_state.lock().unwrap();
2319 let channel_state = &mut *channel_state_lock;
2321 for (short_chan_id, mut pending_forwards) in channel_state.forward_htlcs.drain() {
2322 if short_chan_id != 0 {
2323 let forward_chan_id = match channel_state.short_to_id.get(&short_chan_id) {
2324 Some(chan_id) => chan_id.clone(),
2326 failed_forwards.reserve(pending_forwards.len());
2327 for forward_info in pending_forwards.drain(..) {
2328 match forward_info {
2329 HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info,
2330 prev_funding_outpoint } => {
2331 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
2332 short_channel_id: prev_short_channel_id,
2333 outpoint: prev_funding_outpoint,
2334 htlc_id: prev_htlc_id,
2335 incoming_packet_shared_secret: forward_info.incoming_shared_secret,
2337 failed_forwards.push((htlc_source, forward_info.payment_hash,
2338 HTLCFailReason::Reason { failure_code: 0x4000 | 10, data: Vec::new() }
2341 HTLCForwardInfo::FailHTLC { .. } => {
2342 // Channel went away before we could fail it. This implies
2343 // the channel is now on chain and our counterparty is
2344 // trying to broadcast the HTLC-Timeout, but that's their
2345 // problem, not ours.
2352 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(forward_chan_id) {
2353 let mut add_htlc_msgs = Vec::new();
2354 let mut fail_htlc_msgs = Vec::new();
2355 for forward_info in pending_forwards.drain(..) {
2356 match forward_info {
2357 HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info: PendingHTLCInfo {
2358 routing: PendingHTLCRouting::Forward {
2360 }, incoming_shared_secret, payment_hash, amt_to_forward, outgoing_cltv_value },
2361 prev_funding_outpoint } => {
2362 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);
2363 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
2364 short_channel_id: prev_short_channel_id,
2365 outpoint: prev_funding_outpoint,
2366 htlc_id: prev_htlc_id,
2367 incoming_packet_shared_secret: incoming_shared_secret,
2369 match chan.get_mut().send_htlc(amt_to_forward, payment_hash, outgoing_cltv_value, htlc_source.clone(), onion_packet) {
2371 if let ChannelError::Ignore(msg) = e {
2372 log_trace!(self.logger, "Failed to forward HTLC with payment_hash {}: {}", log_bytes!(payment_hash.0), msg);
2374 panic!("Stated return value requirements in send_htlc() were not met");
2376 let chan_update = self.get_channel_update_for_unicast(chan.get()).unwrap();
2377 failed_forwards.push((htlc_source, payment_hash,
2378 HTLCFailReason::Reason { failure_code: 0x1000 | 7, data: chan_update.encode_with_len() }
2384 Some(msg) => { add_htlc_msgs.push(msg); },
2386 // Nothing to do here...we're waiting on a remote
2387 // revoke_and_ack before we can add anymore HTLCs. The Channel
2388 // will automatically handle building the update_add_htlc and
2389 // commitment_signed messages when we can.
2390 // TODO: Do some kind of timer to set the channel as !is_live()
2391 // as we don't really want others relying on us relaying through
2392 // this channel currently :/.
2398 HTLCForwardInfo::AddHTLC { .. } => {
2399 panic!("short_channel_id != 0 should imply any pending_forward entries are of type Forward");
2401 HTLCForwardInfo::FailHTLC { htlc_id, err_packet } => {
2402 log_trace!(self.logger, "Failing HTLC back to channel with short id {} (backward HTLC ID {}) after delay", short_chan_id, htlc_id);
2403 match chan.get_mut().get_update_fail_htlc(htlc_id, err_packet, &self.logger) {
2405 if let ChannelError::Ignore(msg) = e {
2406 log_trace!(self.logger, "Failed to fail HTLC with ID {} backwards to short_id {}: {}", htlc_id, short_chan_id, msg);
2408 panic!("Stated return value requirements in get_update_fail_htlc() were not met");
2410 // fail-backs are best-effort, we probably already have one
2411 // pending, and if not that's OK, if not, the channel is on
2412 // the chain and sending the HTLC-Timeout is their problem.
2415 Ok(Some(msg)) => { fail_htlc_msgs.push(msg); },
2417 // Nothing to do here...we're waiting on a remote
2418 // revoke_and_ack before we can update the commitment
2419 // transaction. The Channel will automatically handle
2420 // building the update_fail_htlc and commitment_signed
2421 // messages when we can.
2422 // We don't need any kind of timer here as they should fail
2423 // the channel onto the chain if they can't get our
2424 // update_fail_htlc in time, it's not our problem.
2431 if !add_htlc_msgs.is_empty() || !fail_htlc_msgs.is_empty() {
2432 let (commitment_msg, monitor_update) = match chan.get_mut().send_commitment(&self.logger) {
2435 // We surely failed send_commitment due to bad keys, in that case
2436 // close channel and then send error message to peer.
2437 let counterparty_node_id = chan.get().get_counterparty_node_id();
2438 let err: Result<(), _> = match e {
2439 ChannelError::Ignore(_) | ChannelError::Warn(_) => {
2440 panic!("Stated return value requirements in send_commitment() were not met");
2442 ChannelError::Close(msg) => {
2443 log_trace!(self.logger, "Closing channel {} due to Close-required error: {}", log_bytes!(chan.key()[..]), msg);
2444 let (channel_id, mut channel) = chan.remove_entry();
2445 if let Some(short_id) = channel.get_short_channel_id() {
2446 channel_state.short_to_id.remove(&short_id);
2448 // ChannelClosed event is generated by handle_error for us.
2449 Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, channel.force_shutdown(true), self.get_channel_update_for_broadcast(&channel).ok()))
2451 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"); }
2453 handle_errors.push((counterparty_node_id, err));
2457 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
2458 handle_errors.push((chan.get().get_counterparty_node_id(), handle_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, true)));
2461 log_debug!(self.logger, "Forwarding HTLCs resulted in a commitment update with {} HTLCs added and {} HTLCs failed for channel {}",
2462 add_htlc_msgs.len(), fail_htlc_msgs.len(), log_bytes!(chan.get().channel_id()));
2463 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2464 node_id: chan.get().get_counterparty_node_id(),
2465 updates: msgs::CommitmentUpdate {
2466 update_add_htlcs: add_htlc_msgs,
2467 update_fulfill_htlcs: Vec::new(),
2468 update_fail_htlcs: fail_htlc_msgs,
2469 update_fail_malformed_htlcs: Vec::new(),
2471 commitment_signed: commitment_msg,
2479 for forward_info in pending_forwards.drain(..) {
2480 match forward_info {
2481 HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info: PendingHTLCInfo {
2482 routing, incoming_shared_secret, payment_hash, amt_to_forward, .. },
2483 prev_funding_outpoint } => {
2484 let (cltv_expiry, onion_payload) = match routing {
2485 PendingHTLCRouting::Receive { payment_data, incoming_cltv_expiry } =>
2486 (incoming_cltv_expiry, OnionPayload::Invoice(payment_data)),
2487 PendingHTLCRouting::ReceiveKeysend { payment_preimage, incoming_cltv_expiry } =>
2488 (incoming_cltv_expiry, OnionPayload::Spontaneous(payment_preimage)),
2490 panic!("short_channel_id == 0 should imply any pending_forward entries are of type Receive");
2493 let claimable_htlc = ClaimableHTLC {
2494 prev_hop: HTLCPreviousHopData {
2495 short_channel_id: prev_short_channel_id,
2496 outpoint: prev_funding_outpoint,
2497 htlc_id: prev_htlc_id,
2498 incoming_packet_shared_secret: incoming_shared_secret,
2500 value: amt_to_forward,
2505 macro_rules! fail_htlc {
2507 let mut htlc_msat_height_data = byte_utils::be64_to_array($htlc.value).to_vec();
2508 htlc_msat_height_data.extend_from_slice(
2509 &byte_utils::be32_to_array(self.best_block.read().unwrap().height()),
2511 failed_forwards.push((HTLCSource::PreviousHopData(HTLCPreviousHopData {
2512 short_channel_id: $htlc.prev_hop.short_channel_id,
2513 outpoint: prev_funding_outpoint,
2514 htlc_id: $htlc.prev_hop.htlc_id,
2515 incoming_packet_shared_secret: $htlc.prev_hop.incoming_packet_shared_secret,
2517 HTLCFailReason::Reason { failure_code: 0x4000 | 15, data: htlc_msat_height_data }
2522 // Check that the payment hash and secret are known. Note that we
2523 // MUST take care to handle the "unknown payment hash" and
2524 // "incorrect payment secret" cases here identically or we'd expose
2525 // that we are the ultimate recipient of the given payment hash.
2526 // Further, we must not expose whether we have any other HTLCs
2527 // associated with the same payment_hash pending or not.
2528 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
2529 match payment_secrets.entry(payment_hash) {
2530 hash_map::Entry::Vacant(_) => {
2531 match claimable_htlc.onion_payload {
2532 OnionPayload::Invoice(_) => {
2533 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as we didn't have a corresponding inbound payment.", log_bytes!(payment_hash.0));
2534 fail_htlc!(claimable_htlc);
2536 OnionPayload::Spontaneous(preimage) => {
2537 match channel_state.claimable_htlcs.entry(payment_hash) {
2538 hash_map::Entry::Vacant(e) => {
2539 e.insert(vec![claimable_htlc]);
2540 new_events.push(events::Event::PaymentReceived {
2542 amt: amt_to_forward,
2543 purpose: events::PaymentPurpose::SpontaneousPayment(preimage),
2546 hash_map::Entry::Occupied(_) => {
2547 log_trace!(self.logger, "Failing new keysend HTLC with payment_hash {} for a duplicative payment hash", log_bytes!(payment_hash.0));
2548 fail_htlc!(claimable_htlc);
2554 hash_map::Entry::Occupied(inbound_payment) => {
2556 if let OnionPayload::Invoice(ref data) = claimable_htlc.onion_payload {
2559 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));
2560 fail_htlc!(claimable_htlc);
2563 if inbound_payment.get().payment_secret != payment_data.payment_secret {
2564 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our expected payment secret.", log_bytes!(payment_hash.0));
2565 fail_htlc!(claimable_htlc);
2566 } else if inbound_payment.get().min_value_msat.is_some() && payment_data.total_msat < inbound_payment.get().min_value_msat.unwrap() {
2567 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our minimum value (had {}, needed {}).",
2568 log_bytes!(payment_hash.0), payment_data.total_msat, inbound_payment.get().min_value_msat.unwrap());
2569 fail_htlc!(claimable_htlc);
2571 let mut total_value = 0;
2572 let htlcs = channel_state.claimable_htlcs.entry(payment_hash)
2573 .or_insert(Vec::new());
2574 if htlcs.len() == 1 {
2575 if let OnionPayload::Spontaneous(_) = htlcs[0].onion_payload {
2576 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));
2577 fail_htlc!(claimable_htlc);
2581 htlcs.push(claimable_htlc);
2582 for htlc in htlcs.iter() {
2583 total_value += htlc.value;
2584 match &htlc.onion_payload {
2585 OnionPayload::Invoice(htlc_payment_data) => {
2586 if htlc_payment_data.total_msat != payment_data.total_msat {
2587 log_trace!(self.logger, "Failing HTLCs with payment_hash {} as the HTLCs had inconsistent total values (eg {} and {})",
2588 log_bytes!(payment_hash.0), payment_data.total_msat, htlc_payment_data.total_msat);
2589 total_value = msgs::MAX_VALUE_MSAT;
2591 if total_value >= msgs::MAX_VALUE_MSAT { break; }
2593 _ => unreachable!(),
2596 if total_value >= msgs::MAX_VALUE_MSAT || total_value > payment_data.total_msat {
2597 log_trace!(self.logger, "Failing HTLCs with payment_hash {} as the total value {} ran over expected value {} (or HTLCs were inconsistent)",
2598 log_bytes!(payment_hash.0), total_value, payment_data.total_msat);
2599 for htlc in htlcs.iter() {
2602 } else if total_value == payment_data.total_msat {
2603 new_events.push(events::Event::PaymentReceived {
2605 purpose: events::PaymentPurpose::InvoicePayment {
2606 payment_preimage: inbound_payment.get().payment_preimage,
2607 payment_secret: payment_data.payment_secret,
2608 user_payment_id: inbound_payment.get().user_payment_id,
2612 // Only ever generate at most one PaymentReceived
2613 // per registered payment_hash, even if it isn't
2615 inbound_payment.remove_entry();
2617 // Nothing to do - we haven't reached the total
2618 // payment value yet, wait until we receive more
2625 HTLCForwardInfo::FailHTLC { .. } => {
2626 panic!("Got pending fail of our own HTLC");
2634 for (htlc_source, payment_hash, failure_reason) in failed_forwards.drain(..) {
2635 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source, &payment_hash, failure_reason);
2638 for (counterparty_node_id, err) in handle_errors.drain(..) {
2639 let _ = handle_error!(self, err, counterparty_node_id);
2642 if new_events.is_empty() { return }
2643 let mut events = self.pending_events.lock().unwrap();
2644 events.append(&mut new_events);
2647 /// Free the background events, generally called from timer_tick_occurred.
2649 /// Exposed for testing to allow us to process events quickly without generating accidental
2650 /// BroadcastChannelUpdate events in timer_tick_occurred.
2652 /// Expects the caller to have a total_consistency_lock read lock.
2653 fn process_background_events(&self) -> bool {
2654 let mut background_events = Vec::new();
2655 mem::swap(&mut *self.pending_background_events.lock().unwrap(), &mut background_events);
2656 if background_events.is_empty() {
2660 for event in background_events.drain(..) {
2662 BackgroundEvent::ClosingMonitorUpdate((funding_txo, update)) => {
2663 // The channel has already been closed, so no use bothering to care about the
2664 // monitor updating completing.
2665 let _ = self.chain_monitor.update_channel(funding_txo, update);
2672 #[cfg(any(test, feature = "_test_utils"))]
2673 /// Process background events, for functional testing
2674 pub fn test_process_background_events(&self) {
2675 self.process_background_events();
2678 fn update_channel_fee(&self, short_to_id: &mut HashMap<u64, [u8; 32]>, pending_msg_events: &mut Vec<events::MessageSendEvent>, chan_id: &[u8; 32], chan: &mut Channel<Signer>, new_feerate: u32) -> (bool, NotifyOption, Result<(), MsgHandleErrInternal>) {
2679 if !chan.is_outbound() { return (true, NotifyOption::SkipPersist, Ok(())); }
2680 // If the feerate has decreased by less than half, don't bother
2681 if new_feerate <= chan.get_feerate() && new_feerate * 2 > chan.get_feerate() {
2682 log_trace!(self.logger, "Channel {} does not qualify for a feerate change from {} to {}.",
2683 log_bytes!(chan_id[..]), chan.get_feerate(), new_feerate);
2684 return (true, NotifyOption::SkipPersist, Ok(()));
2686 if !chan.is_live() {
2687 log_trace!(self.logger, "Channel {} does not qualify for a feerate change from {} to {} as it cannot currently be updated (probably the peer is disconnected).",
2688 log_bytes!(chan_id[..]), chan.get_feerate(), new_feerate);
2689 return (true, NotifyOption::SkipPersist, Ok(()));
2691 log_trace!(self.logger, "Channel {} qualifies for a feerate change from {} to {}.",
2692 log_bytes!(chan_id[..]), chan.get_feerate(), new_feerate);
2694 let mut retain_channel = true;
2695 let res = match chan.send_update_fee_and_commit(new_feerate, &self.logger) {
2698 let (drop, res) = convert_chan_err!(self, e, short_to_id, chan, chan_id);
2699 if drop { retain_channel = false; }
2703 let ret_err = match res {
2704 Ok(Some((update_fee, commitment_signed, monitor_update))) => {
2705 if let Err(e) = self.chain_monitor.update_channel(chan.get_funding_txo().unwrap(), monitor_update) {
2706 let (res, drop) = handle_monitor_err!(self, e, short_to_id, chan, RAACommitmentOrder::CommitmentFirst, false, true, Vec::new(), Vec::new(), chan_id);
2707 if drop { retain_channel = false; }
2710 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2711 node_id: chan.get_counterparty_node_id(),
2712 updates: msgs::CommitmentUpdate {
2713 update_add_htlcs: Vec::new(),
2714 update_fulfill_htlcs: Vec::new(),
2715 update_fail_htlcs: Vec::new(),
2716 update_fail_malformed_htlcs: Vec::new(),
2717 update_fee: Some(update_fee),
2727 (retain_channel, NotifyOption::DoPersist, ret_err)
2731 /// In chanmon_consistency we want to sometimes do the channel fee updates done in
2732 /// timer_tick_occurred, but we can't generate the disabled channel updates as it considers
2733 /// these a fuzz failure (as they usually indicate a channel force-close, which is exactly what
2734 /// it wants to detect). Thus, we have a variant exposed here for its benefit.
2735 pub fn maybe_update_chan_fees(&self) {
2736 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
2737 let mut should_persist = NotifyOption::SkipPersist;
2739 let new_feerate = self.fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
2741 let mut handle_errors = Vec::new();
2743 let mut channel_state_lock = self.channel_state.lock().unwrap();
2744 let channel_state = &mut *channel_state_lock;
2745 let pending_msg_events = &mut channel_state.pending_msg_events;
2746 let short_to_id = &mut channel_state.short_to_id;
2747 channel_state.by_id.retain(|chan_id, chan| {
2748 let (retain_channel, chan_needs_persist, err) = self.update_channel_fee(short_to_id, pending_msg_events, chan_id, chan, new_feerate);
2749 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
2751 handle_errors.push(err);
2761 /// Performs actions which should happen on startup and roughly once per minute thereafter.
2763 /// This currently includes:
2764 /// * Increasing or decreasing the on-chain feerate estimates for our outbound channels,
2765 /// * Broadcasting `ChannelUpdate` messages if we've been disconnected from our peer for more
2766 /// than a minute, informing the network that they should no longer attempt to route over
2769 /// Note that this may cause reentrancy through `chain::Watch::update_channel` calls or feerate
2770 /// estimate fetches.
2771 pub fn timer_tick_occurred(&self) {
2772 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
2773 let mut should_persist = NotifyOption::SkipPersist;
2774 if self.process_background_events() { should_persist = NotifyOption::DoPersist; }
2776 let new_feerate = self.fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
2778 let mut handle_errors = Vec::new();
2780 let mut channel_state_lock = self.channel_state.lock().unwrap();
2781 let channel_state = &mut *channel_state_lock;
2782 let pending_msg_events = &mut channel_state.pending_msg_events;
2783 let short_to_id = &mut channel_state.short_to_id;
2784 channel_state.by_id.retain(|chan_id, chan| {
2785 let counterparty_node_id = chan.get_counterparty_node_id();
2786 let (retain_channel, chan_needs_persist, err) = self.update_channel_fee(short_to_id, pending_msg_events, chan_id, chan, new_feerate);
2787 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
2789 handle_errors.push((err, counterparty_node_id));
2791 if !retain_channel { return false; }
2793 if let Err(e) = chan.timer_check_closing_negotiation_progress() {
2794 let (needs_close, err) = convert_chan_err!(self, e, short_to_id, chan, chan_id);
2795 handle_errors.push((Err(err), chan.get_counterparty_node_id()));
2796 if needs_close { return false; }
2799 match chan.channel_update_status() {
2800 ChannelUpdateStatus::Enabled if !chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::DisabledStaged),
2801 ChannelUpdateStatus::Disabled if chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::EnabledStaged),
2802 ChannelUpdateStatus::DisabledStaged if chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::Enabled),
2803 ChannelUpdateStatus::EnabledStaged if !chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::Disabled),
2804 ChannelUpdateStatus::DisabledStaged if !chan.is_live() => {
2805 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
2806 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2810 should_persist = NotifyOption::DoPersist;
2811 chan.set_channel_update_status(ChannelUpdateStatus::Disabled);
2813 ChannelUpdateStatus::EnabledStaged if chan.is_live() => {
2814 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
2815 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2819 should_persist = NotifyOption::DoPersist;
2820 chan.set_channel_update_status(ChannelUpdateStatus::Enabled);
2829 for (err, counterparty_node_id) in handle_errors.drain(..) {
2830 let _ = handle_error!(self, err, counterparty_node_id);
2836 /// Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
2837 /// after a PaymentReceived event, failing the HTLC back to its origin and freeing resources
2838 /// along the path (including in our own channel on which we received it).
2839 /// Returns false if no payment was found to fail backwards, true if the process of failing the
2840 /// HTLC backwards has been started.
2841 pub fn fail_htlc_backwards(&self, payment_hash: &PaymentHash) -> bool {
2842 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2844 let mut channel_state = Some(self.channel_state.lock().unwrap());
2845 let removed_source = channel_state.as_mut().unwrap().claimable_htlcs.remove(payment_hash);
2846 if let Some(mut sources) = removed_source {
2847 for htlc in sources.drain(..) {
2848 if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
2849 let mut htlc_msat_height_data = byte_utils::be64_to_array(htlc.value).to_vec();
2850 htlc_msat_height_data.extend_from_slice(&byte_utils::be32_to_array(
2851 self.best_block.read().unwrap().height()));
2852 self.fail_htlc_backwards_internal(channel_state.take().unwrap(),
2853 HTLCSource::PreviousHopData(htlc.prev_hop), payment_hash,
2854 HTLCFailReason::Reason { failure_code: 0x4000 | 15, data: htlc_msat_height_data });
2860 // Fail a list of HTLCs that were just freed from the holding cell. The HTLCs need to be
2861 // failed backwards or, if they were one of our outgoing HTLCs, then their failure needs to
2862 // be surfaced to the user.
2863 fn fail_holding_cell_htlcs(&self, mut htlcs_to_fail: Vec<(HTLCSource, PaymentHash)>, channel_id: [u8; 32]) {
2864 for (htlc_src, payment_hash) in htlcs_to_fail.drain(..) {
2866 HTLCSource::PreviousHopData(HTLCPreviousHopData { .. }) => {
2867 let (failure_code, onion_failure_data) =
2868 match self.channel_state.lock().unwrap().by_id.entry(channel_id) {
2869 hash_map::Entry::Occupied(chan_entry) => {
2870 if let Ok(upd) = self.get_channel_update_for_unicast(&chan_entry.get()) {
2871 (0x1000|7, upd.encode_with_len())
2873 (0x4000|10, Vec::new())
2876 hash_map::Entry::Vacant(_) => (0x4000|10, Vec::new())
2878 let channel_state = self.channel_state.lock().unwrap();
2879 self.fail_htlc_backwards_internal(channel_state,
2880 htlc_src, &payment_hash, HTLCFailReason::Reason { failure_code, data: onion_failure_data});
2882 HTLCSource::OutboundRoute { session_priv, payment_id, path, .. } => {
2883 let mut session_priv_bytes = [0; 32];
2884 session_priv_bytes.copy_from_slice(&session_priv[..]);
2885 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
2886 if let hash_map::Entry::Occupied(mut sessions) = outbounds.entry(payment_id) {
2887 if sessions.get_mut().remove(&session_priv_bytes) {
2888 self.pending_events.lock().unwrap().push(
2889 events::Event::PaymentPathFailed {
2891 rejected_by_dest: false,
2892 network_update: None,
2893 all_paths_failed: sessions.get().len() == 0,
2901 if sessions.get().len() == 0 {
2906 log_trace!(self.logger, "Received duplicative fail for HTLC with payment_hash {}", log_bytes!(payment_hash.0));
2913 /// Fails an HTLC backwards to the sender of it to us.
2914 /// Note that while we take a channel_state lock as input, we do *not* assume consistency here.
2915 /// There are several callsites that do stupid things like loop over a list of payment_hashes
2916 /// to fail and take the channel_state lock for each iteration (as we take ownership and may
2917 /// drop it). In other words, no assumptions are made that entries in claimable_htlcs point to
2918 /// still-available channels.
2919 fn fail_htlc_backwards_internal(&self, mut channel_state_lock: MutexGuard<ChannelHolder<Signer>>, source: HTLCSource, payment_hash: &PaymentHash, onion_error: HTLCFailReason) {
2920 //TODO: There is a timing attack here where if a node fails an HTLC back to us they can
2921 //identify whether we sent it or not based on the (I presume) very different runtime
2922 //between the branches here. We should make this async and move it into the forward HTLCs
2925 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
2926 // from block_connected which may run during initialization prior to the chain_monitor
2927 // being fully configured. See the docs for `ChannelManagerReadArgs` for more.
2929 HTLCSource::OutboundRoute { ref path, session_priv, payment_id, .. } => {
2930 let mut session_priv_bytes = [0; 32];
2931 session_priv_bytes.copy_from_slice(&session_priv[..]);
2932 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
2933 let mut all_paths_failed = false;
2934 if let hash_map::Entry::Occupied(mut sessions) = outbounds.entry(payment_id) {
2935 if !sessions.get_mut().remove(&session_priv_bytes) {
2936 log_trace!(self.logger, "Received duplicative fail for HTLC with payment_hash {}", log_bytes!(payment_hash.0));
2939 if sessions.get().len() == 0 {
2940 all_paths_failed = true;
2944 log_trace!(self.logger, "Received duplicative fail for HTLC with payment_hash {}", log_bytes!(payment_hash.0));
2947 log_trace!(self.logger, "Failing outbound payment HTLC with payment_hash {}", log_bytes!(payment_hash.0));
2948 mem::drop(channel_state_lock);
2949 match &onion_error {
2950 &HTLCFailReason::LightningError { ref err } => {
2952 let (network_update, payment_retryable, onion_error_code, onion_error_data) = onion_utils::process_onion_failure(&self.secp_ctx, &self.logger, &source, err.data.clone());
2954 let (network_update, payment_retryable, _, _) = onion_utils::process_onion_failure(&self.secp_ctx, &self.logger, &source, err.data.clone());
2955 // TODO: If we decided to blame ourselves (or one of our channels) in
2956 // process_onion_failure we should close that channel as it implies our
2957 // next-hop is needlessly blaming us!
2958 self.pending_events.lock().unwrap().push(
2959 events::Event::PaymentPathFailed {
2960 payment_hash: payment_hash.clone(),
2961 rejected_by_dest: !payment_retryable,
2966 error_code: onion_error_code,
2968 error_data: onion_error_data
2972 &HTLCFailReason::Reason {
2978 // we get a fail_malformed_htlc from the first hop
2979 // TODO: We'd like to generate a NetworkUpdate for temporary
2980 // failures here, but that would be insufficient as get_route
2981 // generally ignores its view of our own channels as we provide them via
2983 // TODO: For non-temporary failures, we really should be closing the
2984 // channel here as we apparently can't relay through them anyway.
2985 self.pending_events.lock().unwrap().push(
2986 events::Event::PaymentPathFailed {
2987 payment_hash: payment_hash.clone(),
2988 rejected_by_dest: path.len() == 1,
2989 network_update: None,
2993 error_code: Some(*failure_code),
2995 error_data: Some(data.clone()),
3001 HTLCSource::PreviousHopData(HTLCPreviousHopData { short_channel_id, htlc_id, incoming_packet_shared_secret, .. }) => {
3002 let err_packet = match onion_error {
3003 HTLCFailReason::Reason { failure_code, data } => {
3004 log_trace!(self.logger, "Failing HTLC with payment_hash {} backwards from us with code {}", log_bytes!(payment_hash.0), failure_code);
3005 let packet = onion_utils::build_failure_packet(&incoming_packet_shared_secret, failure_code, &data[..]).encode();
3006 onion_utils::encrypt_failure_packet(&incoming_packet_shared_secret, &packet)
3008 HTLCFailReason::LightningError { err } => {
3009 log_trace!(self.logger, "Failing HTLC with payment_hash {} backwards with pre-built LightningError", log_bytes!(payment_hash.0));
3010 onion_utils::encrypt_failure_packet(&incoming_packet_shared_secret, &err.data)
3014 let mut forward_event = None;
3015 if channel_state_lock.forward_htlcs.is_empty() {
3016 forward_event = Some(Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS));
3018 match channel_state_lock.forward_htlcs.entry(short_channel_id) {
3019 hash_map::Entry::Occupied(mut entry) => {
3020 entry.get_mut().push(HTLCForwardInfo::FailHTLC { htlc_id, err_packet });
3022 hash_map::Entry::Vacant(entry) => {
3023 entry.insert(vec!(HTLCForwardInfo::FailHTLC { htlc_id, err_packet }));
3026 mem::drop(channel_state_lock);
3027 if let Some(time) = forward_event {
3028 let mut pending_events = self.pending_events.lock().unwrap();
3029 pending_events.push(events::Event::PendingHTLCsForwardable {
3030 time_forwardable: time
3037 /// Provides a payment preimage in response to a PaymentReceived event, returning true and
3038 /// generating message events for the net layer to claim the payment, if possible. Thus, you
3039 /// should probably kick the net layer to go send messages if this returns true!
3041 /// Note that if you did not set an `amount_msat` when calling [`create_inbound_payment`] or
3042 /// [`create_inbound_payment_for_hash`] you must check that the amount in the `PaymentReceived`
3043 /// event matches your expectation. If you fail to do so and call this method, you may provide
3044 /// the sender "proof-of-payment" when they did not fulfill the full expected payment.
3046 /// May panic if called except in response to a PaymentReceived event.
3048 /// [`create_inbound_payment`]: Self::create_inbound_payment
3049 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
3050 pub fn claim_funds(&self, payment_preimage: PaymentPreimage) -> bool {
3051 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
3053 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
3055 let mut channel_state = Some(self.channel_state.lock().unwrap());
3056 let removed_source = channel_state.as_mut().unwrap().claimable_htlcs.remove(&payment_hash);
3057 if let Some(mut sources) = removed_source {
3058 assert!(!sources.is_empty());
3060 // If we are claiming an MPP payment, we have to take special care to ensure that each
3061 // channel exists before claiming all of the payments (inside one lock).
3062 // Note that channel existance is sufficient as we should always get a monitor update
3063 // which will take care of the real HTLC claim enforcement.
3065 // If we find an HTLC which we would need to claim but for which we do not have a
3066 // channel, we will fail all parts of the MPP payment. While we could wait and see if
3067 // the sender retries the already-failed path(s), it should be a pretty rare case where
3068 // we got all the HTLCs and then a channel closed while we were waiting for the user to
3069 // provide the preimage, so worrying too much about the optimal handling isn't worth
3071 let mut valid_mpp = true;
3072 for htlc in sources.iter() {
3073 if let None = channel_state.as_ref().unwrap().short_to_id.get(&htlc.prev_hop.short_channel_id) {
3079 let mut errs = Vec::new();
3080 let mut claimed_any_htlcs = false;
3081 for htlc in sources.drain(..) {
3083 if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
3084 let mut htlc_msat_height_data = byte_utils::be64_to_array(htlc.value).to_vec();
3085 htlc_msat_height_data.extend_from_slice(&byte_utils::be32_to_array(
3086 self.best_block.read().unwrap().height()));
3087 self.fail_htlc_backwards_internal(channel_state.take().unwrap(),
3088 HTLCSource::PreviousHopData(htlc.prev_hop), &payment_hash,
3089 HTLCFailReason::Reason { failure_code: 0x4000|15, data: htlc_msat_height_data });
3091 match self.claim_funds_from_hop(channel_state.as_mut().unwrap(), htlc.prev_hop, payment_preimage) {
3092 ClaimFundsFromHop::MonitorUpdateFail(pk, err, _) => {
3093 if let msgs::ErrorAction::IgnoreError = err.err.action {
3094 // We got a temporary failure updating monitor, but will claim the
3095 // HTLC when the monitor updating is restored (or on chain).
3096 log_error!(self.logger, "Temporary failure claiming HTLC, treating as success: {}", err.err.err);
3097 claimed_any_htlcs = true;
3098 } else { errs.push((pk, err)); }
3100 ClaimFundsFromHop::PrevHopForceClosed => unreachable!("We already checked for channel existence, we can't fail here!"),
3101 ClaimFundsFromHop::DuplicateClaim => {
3102 // While we should never get here in most cases, if we do, it likely
3103 // indicates that the HTLC was timed out some time ago and is no longer
3104 // available to be claimed. Thus, it does not make sense to set
3105 // `claimed_any_htlcs`.
3107 ClaimFundsFromHop::Success(_) => claimed_any_htlcs = true,
3112 // Now that we've done the entire above loop in one lock, we can handle any errors
3113 // which were generated.
3114 channel_state.take();
3116 for (counterparty_node_id, err) in errs.drain(..) {
3117 let res: Result<(), _> = Err(err);
3118 let _ = handle_error!(self, res, counterparty_node_id);
3125 fn claim_funds_from_hop(&self, channel_state_lock: &mut MutexGuard<ChannelHolder<Signer>>, prev_hop: HTLCPreviousHopData, payment_preimage: PaymentPreimage) -> ClaimFundsFromHop {
3126 //TODO: Delay the claimed_funds relaying just like we do outbound relay!
3127 let channel_state = &mut **channel_state_lock;
3128 let chan_id = match channel_state.short_to_id.get(&prev_hop.short_channel_id) {
3129 Some(chan_id) => chan_id.clone(),
3131 return ClaimFundsFromHop::PrevHopForceClosed
3135 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(chan_id) {
3136 match chan.get_mut().get_update_fulfill_htlc_and_commit(prev_hop.htlc_id, payment_preimage, &self.logger) {
3137 Ok(msgs_monitor_option) => {
3138 if let UpdateFulfillCommitFetch::NewClaim { msgs, htlc_value_msat, monitor_update } = msgs_monitor_option {
3139 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
3140 log_given_level!(self.logger, if e == ChannelMonitorUpdateErr::PermanentFailure { Level::Error } else { Level::Debug },
3141 "Failed to update channel monitor with preimage {:?}: {:?}",
3142 payment_preimage, e);
3143 return ClaimFundsFromHop::MonitorUpdateFail(
3144 chan.get().get_counterparty_node_id(),
3145 handle_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, msgs.is_some()).unwrap_err(),
3146 Some(htlc_value_msat)
3149 if let Some((msg, commitment_signed)) = msgs {
3150 log_debug!(self.logger, "Claiming funds for HTLC with preimage {} resulted in a commitment_signed for channel {}",
3151 log_bytes!(payment_preimage.0), log_bytes!(chan.get().channel_id()));
3152 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
3153 node_id: chan.get().get_counterparty_node_id(),
3154 updates: msgs::CommitmentUpdate {
3155 update_add_htlcs: Vec::new(),
3156 update_fulfill_htlcs: vec![msg],
3157 update_fail_htlcs: Vec::new(),
3158 update_fail_malformed_htlcs: Vec::new(),
3164 return ClaimFundsFromHop::Success(htlc_value_msat);
3166 return ClaimFundsFromHop::DuplicateClaim;
3169 Err((e, monitor_update)) => {
3170 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
3171 log_given_level!(self.logger, if e == ChannelMonitorUpdateErr::PermanentFailure { Level::Error } else { Level::Info },
3172 "Failed to update channel monitor with preimage {:?} immediately prior to force-close: {:?}",
3173 payment_preimage, e);
3175 let counterparty_node_id = chan.get().get_counterparty_node_id();
3176 let (drop, res) = convert_chan_err!(self, e, channel_state.short_to_id, chan.get_mut(), &chan_id);
3178 chan.remove_entry();
3180 return ClaimFundsFromHop::MonitorUpdateFail(counterparty_node_id, res, None);
3183 } else { unreachable!(); }
3186 fn claim_funds_internal(&self, mut channel_state_lock: MutexGuard<ChannelHolder<Signer>>, source: HTLCSource, payment_preimage: PaymentPreimage, forwarded_htlc_value_msat: Option<u64>, from_onchain: bool) {
3188 HTLCSource::OutboundRoute { session_priv, payment_id, .. } => {
3189 mem::drop(channel_state_lock);
3190 let mut session_priv_bytes = [0; 32];
3191 session_priv_bytes.copy_from_slice(&session_priv[..]);
3192 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
3193 let found_payment = if let Some(mut sessions) = outbounds.remove(&payment_id) {
3194 sessions.remove(&session_priv_bytes)
3197 self.pending_events.lock().unwrap().push(
3198 events::Event::PaymentSent { payment_preimage }
3201 log_trace!(self.logger, "Received duplicative fulfill for HTLC with payment_preimage {}", log_bytes!(payment_preimage.0));
3204 HTLCSource::PreviousHopData(hop_data) => {
3205 let prev_outpoint = hop_data.outpoint;
3206 let res = self.claim_funds_from_hop(&mut channel_state_lock, hop_data, payment_preimage);
3207 let claimed_htlc = if let ClaimFundsFromHop::DuplicateClaim = res { false } else { true };
3208 let htlc_claim_value_msat = match res {
3209 ClaimFundsFromHop::MonitorUpdateFail(_, _, amt_opt) => amt_opt,
3210 ClaimFundsFromHop::Success(amt) => Some(amt),
3213 if let ClaimFundsFromHop::PrevHopForceClosed = res {
3214 let preimage_update = ChannelMonitorUpdate {
3215 update_id: CLOSED_CHANNEL_UPDATE_ID,
3216 updates: vec![ChannelMonitorUpdateStep::PaymentPreimage {
3217 payment_preimage: payment_preimage.clone(),
3220 // We update the ChannelMonitor on the backward link, after
3221 // receiving an offchain preimage event from the forward link (the
3222 // event being update_fulfill_htlc).
3223 if let Err(e) = self.chain_monitor.update_channel(prev_outpoint, preimage_update) {
3224 log_error!(self.logger, "Critical error: failed to update channel monitor with preimage {:?}: {:?}",
3225 payment_preimage, e);
3227 // Note that we do *not* set `claimed_htlc` to false here. In fact, this
3228 // totally could be a duplicate claim, but we have no way of knowing
3229 // without interrogating the `ChannelMonitor` we've provided the above
3230 // update to. Instead, we simply document in `PaymentForwarded` that this
3233 mem::drop(channel_state_lock);
3234 if let ClaimFundsFromHop::MonitorUpdateFail(pk, err, _) = res {
3235 let result: Result<(), _> = Err(err);
3236 let _ = handle_error!(self, result, pk);
3240 if let Some(forwarded_htlc_value) = forwarded_htlc_value_msat {
3241 let fee_earned_msat = if let Some(claimed_htlc_value) = htlc_claim_value_msat {
3242 Some(claimed_htlc_value - forwarded_htlc_value)
3245 let mut pending_events = self.pending_events.lock().unwrap();
3246 pending_events.push(events::Event::PaymentForwarded {
3248 claim_from_onchain_tx: from_onchain,
3256 /// Gets the node_id held by this ChannelManager
3257 pub fn get_our_node_id(&self) -> PublicKey {
3258 self.our_network_pubkey.clone()
3261 /// Restores a single, given channel to normal operation after a
3262 /// ChannelMonitorUpdateErr::TemporaryFailure was returned from a channel monitor update
3265 /// All ChannelMonitor updates up to and including highest_applied_update_id must have been
3266 /// fully committed in every copy of the given channels' ChannelMonitors.
3268 /// Note that there is no effect to calling with a highest_applied_update_id other than the
3269 /// current latest ChannelMonitorUpdate and one call to this function after multiple
3270 /// ChannelMonitorUpdateErr::TemporaryFailures is fine. The highest_applied_update_id field
3271 /// exists largely only to prevent races between this and concurrent update_monitor calls.
3273 /// Thus, the anticipated use is, at a high level:
3274 /// 1) You register a chain::Watch with this ChannelManager,
3275 /// 2) it stores each update to disk, and begins updating any remote (eg watchtower) copies of
3276 /// said ChannelMonitors as it can, returning ChannelMonitorUpdateErr::TemporaryFailures
3277 /// any time it cannot do so instantly,
3278 /// 3) update(s) are applied to each remote copy of a ChannelMonitor,
3279 /// 4) once all remote copies are updated, you call this function with the update_id that
3280 /// completed, and once it is the latest the Channel will be re-enabled.
3281 pub fn channel_monitor_updated(&self, funding_txo: &OutPoint, highest_applied_update_id: u64) {
3282 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
3284 let chan_restoration_res;
3285 let mut pending_failures = {
3286 let mut channel_lock = self.channel_state.lock().unwrap();
3287 let channel_state = &mut *channel_lock;
3288 let mut channel = match channel_state.by_id.entry(funding_txo.to_channel_id()) {
3289 hash_map::Entry::Occupied(chan) => chan,
3290 hash_map::Entry::Vacant(_) => return,
3292 if !channel.get().is_awaiting_monitor_update() || channel.get().get_latest_monitor_update_id() != highest_applied_update_id {
3296 let (raa, commitment_update, order, pending_forwards, pending_failures, funding_broadcastable, funding_locked) = channel.get_mut().monitor_updating_restored(&self.logger);
3297 let channel_update = if funding_locked.is_some() && channel.get().is_usable() && !channel.get().should_announce() {
3298 // We only send a channel_update in the case where we are just now sending a
3299 // funding_locked and the channel is in a usable state. Further, we rely on the
3300 // normal announcement_signatures process to send a channel_update for public
3301 // channels, only generating a unicast channel_update if this is a private channel.
3302 Some(events::MessageSendEvent::SendChannelUpdate {
3303 node_id: channel.get().get_counterparty_node_id(),
3304 msg: self.get_channel_update_for_unicast(channel.get()).unwrap(),
3307 chan_restoration_res = handle_chan_restoration_locked!(self, channel_lock, channel_state, channel, raa, commitment_update, order, None, pending_forwards, funding_broadcastable, funding_locked);
3308 if let Some(upd) = channel_update {
3309 channel_state.pending_msg_events.push(upd);
3313 post_handle_chan_restoration!(self, chan_restoration_res);
3314 for failure in pending_failures.drain(..) {
3315 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), failure.0, &failure.1, failure.2);
3319 fn internal_open_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::OpenChannel) -> Result<(), MsgHandleErrInternal> {
3320 if msg.chain_hash != self.genesis_hash {
3321 return Err(MsgHandleErrInternal::send_err_msg_no_close("Unknown genesis block hash".to_owned(), msg.temporary_channel_id.clone()));
3324 let channel = Channel::new_from_req(&self.fee_estimator, &self.keys_manager, counterparty_node_id.clone(), &their_features, msg, 0, &self.default_configuration)
3325 .map_err(|e| MsgHandleErrInternal::from_chan_no_close(e, msg.temporary_channel_id))?;
3326 let mut channel_state_lock = self.channel_state.lock().unwrap();
3327 let channel_state = &mut *channel_state_lock;
3328 match channel_state.by_id.entry(channel.channel_id()) {
3329 hash_map::Entry::Occupied(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("temporary_channel_id collision!".to_owned(), msg.temporary_channel_id.clone())),
3330 hash_map::Entry::Vacant(entry) => {
3331 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
3332 node_id: counterparty_node_id.clone(),
3333 msg: channel.get_accept_channel(),
3335 entry.insert(channel);
3341 fn internal_accept_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::AcceptChannel) -> Result<(), MsgHandleErrInternal> {
3342 let (value, output_script, user_id) = {
3343 let mut channel_lock = self.channel_state.lock().unwrap();
3344 let channel_state = &mut *channel_lock;
3345 match channel_state.by_id.entry(msg.temporary_channel_id) {
3346 hash_map::Entry::Occupied(mut chan) => {
3347 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3348 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.temporary_channel_id));
3350 try_chan_entry!(self, chan.get_mut().accept_channel(&msg, &self.default_configuration, &their_features), channel_state, chan);
3351 (chan.get().get_value_satoshis(), chan.get().get_funding_redeemscript().to_v0_p2wsh(), chan.get().get_user_id())
3353 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.temporary_channel_id))
3356 let mut pending_events = self.pending_events.lock().unwrap();
3357 pending_events.push(events::Event::FundingGenerationReady {
3358 temporary_channel_id: msg.temporary_channel_id,
3359 channel_value_satoshis: value,
3361 user_channel_id: user_id,
3366 fn internal_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), MsgHandleErrInternal> {
3367 let ((funding_msg, monitor), mut chan) = {
3368 let best_block = *self.best_block.read().unwrap();
3369 let mut channel_lock = self.channel_state.lock().unwrap();
3370 let channel_state = &mut *channel_lock;
3371 match channel_state.by_id.entry(msg.temporary_channel_id.clone()) {
3372 hash_map::Entry::Occupied(mut chan) => {
3373 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3374 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.temporary_channel_id));
3376 (try_chan_entry!(self, chan.get_mut().funding_created(msg, best_block, &self.logger), channel_state, chan), chan.remove())
3378 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.temporary_channel_id))
3381 // Because we have exclusive ownership of the channel here we can release the channel_state
3382 // lock before watch_channel
3383 if let Err(e) = self.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor) {
3385 ChannelMonitorUpdateErr::PermanentFailure => {
3386 // Note that we reply with the new channel_id in error messages if we gave up on the
3387 // channel, not the temporary_channel_id. This is compatible with ourselves, but the
3388 // spec is somewhat ambiguous here. Not a huge deal since we'll send error messages for
3389 // any messages referencing a previously-closed channel anyway.
3390 // We do not do a force-close here as that would generate a monitor update for
3391 // a monitor that we didn't manage to store (and that we don't care about - we
3392 // don't respond with the funding_signed so the channel can never go on chain).
3393 let (_monitor_update, failed_htlcs) = chan.force_shutdown(true);
3394 assert!(failed_htlcs.is_empty());
3395 return Err(MsgHandleErrInternal::send_err_msg_no_close("ChannelMonitor storage failure".to_owned(), funding_msg.channel_id));
3397 ChannelMonitorUpdateErr::TemporaryFailure => {
3398 // There's no problem signing a counterparty's funding transaction if our monitor
3399 // hasn't persisted to disk yet - we can't lose money on a transaction that we haven't
3400 // accepted payment from yet. We do, however, need to wait to send our funding_locked
3401 // until we have persisted our monitor.
3402 chan.monitor_update_failed(false, false, Vec::new(), Vec::new());
3406 let mut channel_state_lock = self.channel_state.lock().unwrap();
3407 let channel_state = &mut *channel_state_lock;
3408 match channel_state.by_id.entry(funding_msg.channel_id) {
3409 hash_map::Entry::Occupied(_) => {
3410 return Err(MsgHandleErrInternal::send_err_msg_no_close("Already had channel with the new channel_id".to_owned(), funding_msg.channel_id))
3412 hash_map::Entry::Vacant(e) => {
3413 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
3414 node_id: counterparty_node_id.clone(),
3423 fn internal_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), MsgHandleErrInternal> {
3425 let best_block = *self.best_block.read().unwrap();
3426 let mut channel_lock = self.channel_state.lock().unwrap();
3427 let channel_state = &mut *channel_lock;
3428 match channel_state.by_id.entry(msg.channel_id) {
3429 hash_map::Entry::Occupied(mut chan) => {
3430 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3431 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3433 let (monitor, funding_tx) = match chan.get_mut().funding_signed(&msg, best_block, &self.logger) {
3434 Ok(update) => update,
3435 Err(e) => try_chan_entry!(self, Err(e), channel_state, chan),
3437 if let Err(e) = self.chain_monitor.watch_channel(chan.get().get_funding_txo().unwrap(), monitor) {
3438 return_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::RevokeAndACKFirst, false, false);
3442 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3445 log_info!(self.logger, "Broadcasting funding transaction with txid {}", funding_tx.txid());
3446 self.tx_broadcaster.broadcast_transaction(&funding_tx);
3450 fn internal_funding_locked(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingLocked) -> Result<(), MsgHandleErrInternal> {
3451 let mut channel_state_lock = self.channel_state.lock().unwrap();
3452 let channel_state = &mut *channel_state_lock;
3453 match channel_state.by_id.entry(msg.channel_id) {
3454 hash_map::Entry::Occupied(mut chan) => {
3455 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3456 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3458 try_chan_entry!(self, chan.get_mut().funding_locked(&msg, &self.logger), channel_state, chan);
3459 if let Some(announcement_sigs) = self.get_announcement_sigs(chan.get()) {
3460 log_trace!(self.logger, "Sending announcement_signatures for {} in response to funding_locked", log_bytes!(chan.get().channel_id()));
3461 // If we see locking block before receiving remote funding_locked, we broadcast our
3462 // announcement_sigs at remote funding_locked reception. If we receive remote
3463 // funding_locked before seeing locking block, we broadcast our announcement_sigs at locking
3464 // block connection. We should guanrantee to broadcast announcement_sigs to our peer whatever
3465 // the order of the events but our peer may not receive it due to disconnection. The specs
3466 // lacking an acknowledgement for announcement_sigs we may have to re-send them at peer
3467 // connection in the future if simultaneous misses by both peers due to network/hardware
3468 // failures is an issue. Note, to achieve its goal, only one of the announcement_sigs needs
3469 // to be received, from then sigs are going to be flood to the whole network.
3470 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
3471 node_id: counterparty_node_id.clone(),
3472 msg: announcement_sigs,
3474 } else if chan.get().is_usable() {
3475 channel_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
3476 node_id: counterparty_node_id.clone(),
3477 msg: self.get_channel_update_for_unicast(chan.get()).unwrap(),
3482 hash_map::Entry::Vacant(_) => Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3486 fn internal_shutdown(&self, counterparty_node_id: &PublicKey, their_features: &InitFeatures, msg: &msgs::Shutdown) -> Result<(), MsgHandleErrInternal> {
3487 let mut dropped_htlcs: Vec<(HTLCSource, PaymentHash)>;
3488 let result: Result<(), _> = loop {
3489 let mut channel_state_lock = self.channel_state.lock().unwrap();
3490 let channel_state = &mut *channel_state_lock;
3492 match channel_state.by_id.entry(msg.channel_id.clone()) {
3493 hash_map::Entry::Occupied(mut chan_entry) => {
3494 if chan_entry.get().get_counterparty_node_id() != *counterparty_node_id {
3495 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3498 if !chan_entry.get().received_shutdown() {
3499 log_info!(self.logger, "Received a shutdown message from our counterparty for channel {}{}.",
3500 log_bytes!(msg.channel_id),
3501 if chan_entry.get().sent_shutdown() { " after we initiated shutdown" } else { "" });
3504 let (shutdown, monitor_update, htlcs) = try_chan_entry!(self, chan_entry.get_mut().shutdown(&self.keys_manager, &their_features, &msg), channel_state, chan_entry);
3505 dropped_htlcs = htlcs;
3507 // Update the monitor with the shutdown script if necessary.
3508 if let Some(monitor_update) = monitor_update {
3509 if let Err(e) = self.chain_monitor.update_channel(chan_entry.get().get_funding_txo().unwrap(), monitor_update) {
3510 let (result, is_permanent) =
3511 handle_monitor_err!(self, e, channel_state.short_to_id, chan_entry.get_mut(), RAACommitmentOrder::CommitmentFirst, false, false, Vec::new(), Vec::new(), chan_entry.key());
3513 remove_channel!(channel_state, chan_entry);
3519 if let Some(msg) = shutdown {
3520 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
3521 node_id: *counterparty_node_id,
3528 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3531 for htlc_source in dropped_htlcs.drain(..) {
3532 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() });
3535 let _ = handle_error!(self, result, *counterparty_node_id);
3539 fn internal_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<(), MsgHandleErrInternal> {
3540 let (tx, chan_option) = {
3541 let mut channel_state_lock = self.channel_state.lock().unwrap();
3542 let channel_state = &mut *channel_state_lock;
3543 match channel_state.by_id.entry(msg.channel_id.clone()) {
3544 hash_map::Entry::Occupied(mut chan_entry) => {
3545 if chan_entry.get().get_counterparty_node_id() != *counterparty_node_id {
3546 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3548 let (closing_signed, tx) = try_chan_entry!(self, chan_entry.get_mut().closing_signed(&self.fee_estimator, &msg), channel_state, chan_entry);
3549 if let Some(msg) = closing_signed {
3550 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
3551 node_id: counterparty_node_id.clone(),
3556 // We're done with this channel, we've got a signed closing transaction and
3557 // will send the closing_signed back to the remote peer upon return. This
3558 // also implies there are no pending HTLCs left on the channel, so we can
3559 // fully delete it from tracking (the channel monitor is still around to
3560 // watch for old state broadcasts)!
3561 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
3562 channel_state.short_to_id.remove(&short_id);
3564 (tx, Some(chan_entry.remove_entry().1))
3565 } else { (tx, None) }
3567 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3570 if let Some(broadcast_tx) = tx {
3571 log_info!(self.logger, "Broadcasting {}", log_tx!(broadcast_tx));
3572 self.tx_broadcaster.broadcast_transaction(&broadcast_tx);
3574 if let Some(chan) = chan_option {
3575 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
3576 let mut channel_state = self.channel_state.lock().unwrap();
3577 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
3581 self.pending_events.lock().unwrap().push(events::Event::ChannelClosed { channel_id: msg.channel_id, reason: ClosureReason::CooperativeClosure });
3586 fn internal_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), MsgHandleErrInternal> {
3587 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
3588 //determine the state of the payment based on our response/if we forward anything/the time
3589 //we take to respond. We should take care to avoid allowing such an attack.
3591 //TODO: There exists a further attack where a node may garble the onion data, forward it to
3592 //us repeatedly garbled in different ways, and compare our error messages, which are
3593 //encrypted with the same key. It's not immediately obvious how to usefully exploit that,
3594 //but we should prevent it anyway.
3596 let (pending_forward_info, mut channel_state_lock) = self.decode_update_add_htlc_onion(msg);
3597 let channel_state = &mut *channel_state_lock;
3599 match channel_state.by_id.entry(msg.channel_id) {
3600 hash_map::Entry::Occupied(mut chan) => {
3601 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3602 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3605 let create_pending_htlc_status = |chan: &Channel<Signer>, pending_forward_info: PendingHTLCStatus, error_code: u16| {
3606 // If the update_add is completely bogus, the call will Err and we will close,
3607 // but if we've sent a shutdown and they haven't acknowledged it yet, we just
3608 // want to reject the new HTLC and fail it backwards instead of forwarding.
3609 match pending_forward_info {
3610 PendingHTLCStatus::Forward(PendingHTLCInfo { ref incoming_shared_secret, .. }) => {
3611 let reason = if (error_code & 0x1000) != 0 {
3612 if let Ok(upd) = self.get_channel_update_for_unicast(chan) {
3613 onion_utils::build_first_hop_failure_packet(incoming_shared_secret, error_code, &{
3614 let mut res = Vec::with_capacity(8 + 128);
3615 // TODO: underspecified, follow https://github.com/lightningnetwork/lightning-rfc/issues/791
3616 res.extend_from_slice(&byte_utils::be16_to_array(0));
3617 res.extend_from_slice(&upd.encode_with_len()[..]);
3621 // The only case where we'd be unable to
3622 // successfully get a channel update is if the
3623 // channel isn't in the fully-funded state yet,
3624 // implying our counterparty is trying to route
3625 // payments over the channel back to themselves
3626 // (because no one else should know the short_id
3627 // is a lightning channel yet). We should have
3628 // no problem just calling this
3629 // unknown_next_peer (0x4000|10).
3630 onion_utils::build_first_hop_failure_packet(incoming_shared_secret, 0x4000|10, &[])
3633 onion_utils::build_first_hop_failure_packet(incoming_shared_secret, error_code, &[])
3635 let msg = msgs::UpdateFailHTLC {
3636 channel_id: msg.channel_id,
3637 htlc_id: msg.htlc_id,
3640 PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msg))
3642 _ => pending_forward_info
3645 try_chan_entry!(self, chan.get_mut().update_add_htlc(&msg, pending_forward_info, create_pending_htlc_status, &self.logger), channel_state, chan);
3647 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3652 fn internal_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), MsgHandleErrInternal> {
3653 let mut channel_lock = self.channel_state.lock().unwrap();
3654 let (htlc_source, forwarded_htlc_value) = {
3655 let channel_state = &mut *channel_lock;
3656 match channel_state.by_id.entry(msg.channel_id) {
3657 hash_map::Entry::Occupied(mut chan) => {
3658 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3659 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3661 try_chan_entry!(self, chan.get_mut().update_fulfill_htlc(&msg), channel_state, chan)
3663 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3666 self.claim_funds_internal(channel_lock, htlc_source, msg.payment_preimage.clone(), Some(forwarded_htlc_value), false);
3670 fn internal_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), MsgHandleErrInternal> {
3671 let mut channel_lock = self.channel_state.lock().unwrap();
3672 let channel_state = &mut *channel_lock;
3673 match channel_state.by_id.entry(msg.channel_id) {
3674 hash_map::Entry::Occupied(mut chan) => {
3675 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3676 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3678 try_chan_entry!(self, chan.get_mut().update_fail_htlc(&msg, HTLCFailReason::LightningError { err: msg.reason.clone() }), channel_state, chan);
3680 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3685 fn internal_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), MsgHandleErrInternal> {
3686 let mut channel_lock = self.channel_state.lock().unwrap();
3687 let channel_state = &mut *channel_lock;
3688 match channel_state.by_id.entry(msg.channel_id) {
3689 hash_map::Entry::Occupied(mut chan) => {
3690 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3691 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3693 if (msg.failure_code & 0x8000) == 0 {
3694 let chan_err: ChannelError = ChannelError::Close("Got update_fail_malformed_htlc with BADONION not set".to_owned());
3695 try_chan_entry!(self, Err(chan_err), channel_state, chan);
3697 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);
3700 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3704 fn internal_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), MsgHandleErrInternal> {
3705 let mut channel_state_lock = self.channel_state.lock().unwrap();
3706 let channel_state = &mut *channel_state_lock;
3707 match channel_state.by_id.entry(msg.channel_id) {
3708 hash_map::Entry::Occupied(mut chan) => {
3709 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3710 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3712 let (revoke_and_ack, commitment_signed, monitor_update) =
3713 match chan.get_mut().commitment_signed(&msg, &self.logger) {
3714 Err((None, e)) => try_chan_entry!(self, Err(e), channel_state, chan),
3715 Err((Some(update), e)) => {
3716 assert!(chan.get().is_awaiting_monitor_update());
3717 let _ = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), update);
3718 try_chan_entry!(self, Err(e), channel_state, chan);
3723 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
3724 return_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::RevokeAndACKFirst, true, commitment_signed.is_some());
3726 channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
3727 node_id: counterparty_node_id.clone(),
3728 msg: revoke_and_ack,
3730 if let Some(msg) = commitment_signed {
3731 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
3732 node_id: counterparty_node_id.clone(),
3733 updates: msgs::CommitmentUpdate {
3734 update_add_htlcs: Vec::new(),
3735 update_fulfill_htlcs: Vec::new(),
3736 update_fail_htlcs: Vec::new(),
3737 update_fail_malformed_htlcs: Vec::new(),
3739 commitment_signed: msg,
3745 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3750 fn forward_htlcs(&self, per_source_pending_forwards: &mut [(u64, OutPoint, Vec<(PendingHTLCInfo, u64)>)]) {
3751 for &mut (prev_short_channel_id, prev_funding_outpoint, ref mut pending_forwards) in per_source_pending_forwards {
3752 let mut forward_event = None;
3753 if !pending_forwards.is_empty() {
3754 let mut channel_state = self.channel_state.lock().unwrap();
3755 if channel_state.forward_htlcs.is_empty() {
3756 forward_event = Some(Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS))
3758 for (forward_info, prev_htlc_id) in pending_forwards.drain(..) {
3759 match channel_state.forward_htlcs.entry(match forward_info.routing {
3760 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
3761 PendingHTLCRouting::Receive { .. } => 0,
3762 PendingHTLCRouting::ReceiveKeysend { .. } => 0,
3764 hash_map::Entry::Occupied(mut entry) => {
3765 entry.get_mut().push(HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_funding_outpoint,
3766 prev_htlc_id, forward_info });
3768 hash_map::Entry::Vacant(entry) => {
3769 entry.insert(vec!(HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_funding_outpoint,
3770 prev_htlc_id, forward_info }));
3775 match forward_event {
3777 let mut pending_events = self.pending_events.lock().unwrap();
3778 pending_events.push(events::Event::PendingHTLCsForwardable {
3779 time_forwardable: time
3787 fn internal_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), MsgHandleErrInternal> {
3788 let mut htlcs_to_fail = Vec::new();
3790 let mut channel_state_lock = self.channel_state.lock().unwrap();
3791 let channel_state = &mut *channel_state_lock;
3792 match channel_state.by_id.entry(msg.channel_id) {
3793 hash_map::Entry::Occupied(mut chan) => {
3794 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3795 break Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3797 let was_frozen_for_monitor = chan.get().is_awaiting_monitor_update();
3798 let (commitment_update, pending_forwards, pending_failures, monitor_update, htlcs_to_fail_in) =
3799 break_chan_entry!(self, chan.get_mut().revoke_and_ack(&msg, &self.logger), channel_state, chan);
3800 htlcs_to_fail = htlcs_to_fail_in;
3801 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
3802 if was_frozen_for_monitor {
3803 assert!(commitment_update.is_none() && pending_forwards.is_empty() && pending_failures.is_empty());
3804 break Err(MsgHandleErrInternal::ignore_no_close("Previous monitor update failure prevented responses to RAA".to_owned()));
3806 if let Err(e) = handle_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, commitment_update.is_some(), pending_forwards, pending_failures) {
3808 } else { unreachable!(); }
3811 if let Some(updates) = commitment_update {
3812 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
3813 node_id: counterparty_node_id.clone(),
3817 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()))
3819 hash_map::Entry::Vacant(_) => break Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3822 self.fail_holding_cell_htlcs(htlcs_to_fail, msg.channel_id);
3824 Ok((pending_forwards, mut pending_failures, short_channel_id, channel_outpoint)) => {
3825 for failure in pending_failures.drain(..) {
3826 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), failure.0, &failure.1, failure.2);
3828 self.forward_htlcs(&mut [(short_channel_id, channel_outpoint, pending_forwards)]);
3835 fn internal_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), MsgHandleErrInternal> {
3836 let mut channel_lock = self.channel_state.lock().unwrap();
3837 let channel_state = &mut *channel_lock;
3838 match channel_state.by_id.entry(msg.channel_id) {
3839 hash_map::Entry::Occupied(mut chan) => {
3840 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3841 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3843 try_chan_entry!(self, chan.get_mut().update_fee(&self.fee_estimator, &msg), channel_state, chan);
3845 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3850 fn internal_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), MsgHandleErrInternal> {
3851 let mut channel_state_lock = self.channel_state.lock().unwrap();
3852 let channel_state = &mut *channel_state_lock;
3854 match channel_state.by_id.entry(msg.channel_id) {
3855 hash_map::Entry::Occupied(mut chan) => {
3856 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3857 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3859 if !chan.get().is_usable() {
3860 return Err(MsgHandleErrInternal::from_no_close(LightningError{err: "Got an announcement_signatures before we were ready for it".to_owned(), action: msgs::ErrorAction::IgnoreError}));
3863 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
3864 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),
3865 // Note that announcement_signatures fails if the channel cannot be announced,
3866 // so get_channel_update_for_broadcast will never fail by the time we get here.
3867 update_msg: self.get_channel_update_for_broadcast(chan.get()).unwrap(),
3870 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3875 /// Returns ShouldPersist if anything changed, otherwise either SkipPersist or an Err.
3876 fn internal_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) -> Result<NotifyOption, MsgHandleErrInternal> {
3877 let mut channel_state_lock = self.channel_state.lock().unwrap();
3878 let channel_state = &mut *channel_state_lock;
3879 let chan_id = match channel_state.short_to_id.get(&msg.contents.short_channel_id) {
3880 Some(chan_id) => chan_id.clone(),
3882 // It's not a local channel
3883 return Ok(NotifyOption::SkipPersist)
3886 match channel_state.by_id.entry(chan_id) {
3887 hash_map::Entry::Occupied(mut chan) => {
3888 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3889 if chan.get().should_announce() {
3890 // If the announcement is about a channel of ours which is public, some
3891 // other peer may simply be forwarding all its gossip to us. Don't provide
3892 // a scary-looking error message and return Ok instead.
3893 return Ok(NotifyOption::SkipPersist);
3895 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));
3897 let were_node_one = self.get_our_node_id().serialize()[..] < chan.get().get_counterparty_node_id().serialize()[..];
3898 let msg_from_node_one = msg.contents.flags & 1 == 0;
3899 if were_node_one == msg_from_node_one {
3900 return Ok(NotifyOption::SkipPersist);
3902 try_chan_entry!(self, chan.get_mut().channel_update(&msg), channel_state, chan);
3905 hash_map::Entry::Vacant(_) => unreachable!()
3907 Ok(NotifyOption::DoPersist)
3910 fn internal_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<(), MsgHandleErrInternal> {
3911 let chan_restoration_res;
3912 let (htlcs_failed_forward, need_lnd_workaround) = {
3913 let mut channel_state_lock = self.channel_state.lock().unwrap();
3914 let channel_state = &mut *channel_state_lock;
3916 match channel_state.by_id.entry(msg.channel_id) {
3917 hash_map::Entry::Occupied(mut chan) => {
3918 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3919 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3921 // Currently, we expect all holding cell update_adds to be dropped on peer
3922 // disconnect, so Channel's reestablish will never hand us any holding cell
3923 // freed HTLCs to fail backwards. If in the future we no longer drop pending
3924 // add-HTLCs on disconnect, we may be handed HTLCs to fail backwards here.
3925 let (funding_locked, revoke_and_ack, commitment_update, monitor_update_opt, order, htlcs_failed_forward, shutdown) =
3926 try_chan_entry!(self, chan.get_mut().channel_reestablish(msg, &self.logger), channel_state, chan);
3927 let mut channel_update = None;
3928 if let Some(msg) = shutdown {
3929 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
3930 node_id: counterparty_node_id.clone(),
3933 } else if chan.get().is_usable() {
3934 // If the channel is in a usable state (ie the channel is not being shut
3935 // down), send a unicast channel_update to our counterparty to make sure
3936 // they have the latest channel parameters.
3937 channel_update = Some(events::MessageSendEvent::SendChannelUpdate {
3938 node_id: chan.get().get_counterparty_node_id(),
3939 msg: self.get_channel_update_for_unicast(chan.get()).unwrap(),
3942 let need_lnd_workaround = chan.get_mut().workaround_lnd_bug_4006.take();
3943 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);
3944 if let Some(upd) = channel_update {
3945 channel_state.pending_msg_events.push(upd);
3947 (htlcs_failed_forward, need_lnd_workaround)
3949 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3952 post_handle_chan_restoration!(self, chan_restoration_res);
3953 self.fail_holding_cell_htlcs(htlcs_failed_forward, msg.channel_id);
3955 if let Some(funding_locked_msg) = need_lnd_workaround {
3956 self.internal_funding_locked(counterparty_node_id, &funding_locked_msg)?;
3961 /// Process pending events from the `chain::Watch`, returning whether any events were processed.
3962 fn process_pending_monitor_events(&self) -> bool {
3963 let mut failed_channels = Vec::new();
3964 let mut pending_monitor_events = self.chain_monitor.release_pending_monitor_events();
3965 let has_pending_monitor_events = !pending_monitor_events.is_empty();
3966 for monitor_event in pending_monitor_events.drain(..) {
3967 match monitor_event {
3968 MonitorEvent::HTLCEvent(htlc_update) => {
3969 if let Some(preimage) = htlc_update.payment_preimage {
3970 log_trace!(self.logger, "Claiming HTLC with preimage {} from our monitor", log_bytes!(preimage.0));
3971 self.claim_funds_internal(self.channel_state.lock().unwrap(), htlc_update.source, preimage, htlc_update.onchain_value_satoshis.map(|v| v * 1000), true);
3973 log_trace!(self.logger, "Failing HTLC with hash {} from our monitor", log_bytes!(htlc_update.payment_hash.0));
3974 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() });
3977 MonitorEvent::CommitmentTxConfirmed(funding_outpoint) => {
3978 let mut channel_lock = self.channel_state.lock().unwrap();
3979 let channel_state = &mut *channel_lock;
3980 let by_id = &mut channel_state.by_id;
3981 let short_to_id = &mut channel_state.short_to_id;
3982 let pending_msg_events = &mut channel_state.pending_msg_events;
3983 if let Some(mut chan) = by_id.remove(&funding_outpoint.to_channel_id()) {
3984 if let Some(short_id) = chan.get_short_channel_id() {
3985 short_to_id.remove(&short_id);
3987 failed_channels.push(chan.force_shutdown(false));
3988 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
3989 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
3993 self.pending_events.lock().unwrap().push(events::Event::ChannelClosed { channel_id: chan.channel_id(), reason: ClosureReason::CommitmentTxConfirmed });
3994 pending_msg_events.push(events::MessageSendEvent::HandleError {
3995 node_id: chan.get_counterparty_node_id(),
3996 action: msgs::ErrorAction::SendErrorMessage {
3997 msg: msgs::ErrorMessage { channel_id: chan.channel_id(), data: "Channel force-closed".to_owned() }
4005 for failure in failed_channels.drain(..) {
4006 self.finish_force_close_channel(failure);
4009 has_pending_monitor_events
4012 /// Check the holding cell in each channel and free any pending HTLCs in them if possible.
4013 /// Returns whether there were any updates such as if pending HTLCs were freed or a monitor
4014 /// update was applied.
4016 /// This should only apply to HTLCs which were added to the holding cell because we were
4017 /// waiting on a monitor update to finish. In that case, we don't want to free the holding cell
4018 /// directly in `channel_monitor_updated` as it may introduce deadlocks calling back into user
4019 /// code to inform them of a channel monitor update.
4020 fn check_free_holding_cells(&self) -> bool {
4021 let mut has_monitor_update = false;
4022 let mut failed_htlcs = Vec::new();
4023 let mut handle_errors = Vec::new();
4025 let mut channel_state_lock = self.channel_state.lock().unwrap();
4026 let channel_state = &mut *channel_state_lock;
4027 let by_id = &mut channel_state.by_id;
4028 let short_to_id = &mut channel_state.short_to_id;
4029 let pending_msg_events = &mut channel_state.pending_msg_events;
4031 by_id.retain(|channel_id, chan| {
4032 match chan.maybe_free_holding_cell_htlcs(&self.logger) {
4033 Ok((commitment_opt, holding_cell_failed_htlcs)) => {
4034 if !holding_cell_failed_htlcs.is_empty() {
4035 failed_htlcs.push((holding_cell_failed_htlcs, *channel_id));
4037 if let Some((commitment_update, monitor_update)) = commitment_opt {
4038 if let Err(e) = self.chain_monitor.update_channel(chan.get_funding_txo().unwrap(), monitor_update) {
4039 has_monitor_update = true;
4040 let (res, close_channel) = handle_monitor_err!(self, e, short_to_id, chan, RAACommitmentOrder::CommitmentFirst, false, true, Vec::new(), Vec::new(), channel_id);
4041 handle_errors.push((chan.get_counterparty_node_id(), res));
4042 if close_channel { return false; }
4044 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
4045 node_id: chan.get_counterparty_node_id(),
4046 updates: commitment_update,
4053 let (close_channel, res) = convert_chan_err!(self, e, short_to_id, chan, channel_id);
4054 handle_errors.push((chan.get_counterparty_node_id(), Err(res)));
4055 // ChannelClosed event is generated by handle_error for us
4062 let has_update = has_monitor_update || !failed_htlcs.is_empty() || !handle_errors.is_empty();
4063 for (failures, channel_id) in failed_htlcs.drain(..) {
4064 self.fail_holding_cell_htlcs(failures, channel_id);
4067 for (counterparty_node_id, err) in handle_errors.drain(..) {
4068 let _ = handle_error!(self, err, counterparty_node_id);
4074 /// Check whether any channels have finished removing all pending updates after a shutdown
4075 /// exchange and can now send a closing_signed.
4076 /// Returns whether any closing_signed messages were generated.
4077 fn maybe_generate_initial_closing_signed(&self) -> bool {
4078 let mut handle_errors: Vec<(PublicKey, Result<(), _>)> = Vec::new();
4079 let mut has_update = false;
4081 let mut channel_state_lock = self.channel_state.lock().unwrap();
4082 let channel_state = &mut *channel_state_lock;
4083 let by_id = &mut channel_state.by_id;
4084 let short_to_id = &mut channel_state.short_to_id;
4085 let pending_msg_events = &mut channel_state.pending_msg_events;
4087 by_id.retain(|channel_id, chan| {
4088 match chan.maybe_propose_closing_signed(&self.fee_estimator, &self.logger) {
4089 Ok((msg_opt, tx_opt)) => {
4090 if let Some(msg) = msg_opt {
4092 pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
4093 node_id: chan.get_counterparty_node_id(), msg,
4096 if let Some(tx) = tx_opt {
4097 // We're done with this channel. We got a closing_signed and sent back
4098 // a closing_signed with a closing transaction to broadcast.
4099 if let Some(short_id) = chan.get_short_channel_id() {
4100 short_to_id.remove(&short_id);
4103 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
4104 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
4109 if let Ok(mut pending_events_lock) = self.pending_events.lock() {
4110 pending_events_lock.push(events::Event::ChannelClosed {
4111 channel_id: *channel_id,
4112 reason: ClosureReason::CooperativeClosure
4116 log_info!(self.logger, "Broadcasting {}", log_tx!(tx));
4117 self.tx_broadcaster.broadcast_transaction(&tx);
4123 let (close_channel, res) = convert_chan_err!(self, e, short_to_id, chan, channel_id);
4124 handle_errors.push((chan.get_counterparty_node_id(), Err(res)));
4131 for (counterparty_node_id, err) in handle_errors.drain(..) {
4132 let _ = handle_error!(self, err, counterparty_node_id);
4138 /// Handle a list of channel failures during a block_connected or block_disconnected call,
4139 /// pushing the channel monitor update (if any) to the background events queue and removing the
4141 fn handle_init_event_channel_failures(&self, mut failed_channels: Vec<ShutdownResult>) {
4142 for mut failure in failed_channels.drain(..) {
4143 // Either a commitment transactions has been confirmed on-chain or
4144 // Channel::block_disconnected detected that the funding transaction has been
4145 // reorganized out of the main chain.
4146 // We cannot broadcast our latest local state via monitor update (as
4147 // Channel::force_shutdown tries to make us do) as we may still be in initialization,
4148 // so we track the update internally and handle it when the user next calls
4149 // timer_tick_occurred, guaranteeing we're running normally.
4150 if let Some((funding_txo, update)) = failure.0.take() {
4151 assert_eq!(update.updates.len(), 1);
4152 if let ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } = update.updates[0] {
4153 assert!(should_broadcast);
4154 } else { unreachable!(); }
4155 self.pending_background_events.lock().unwrap().push(BackgroundEvent::ClosingMonitorUpdate((funding_txo, update)));
4157 self.finish_force_close_channel(failure);
4161 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> {
4162 assert!(invoice_expiry_delta_secs <= 60*60*24*365); // Sadly bitcoin timestamps are u32s, so panic before 2106
4164 let payment_secret = PaymentSecret(self.keys_manager.get_secure_random_bytes());
4166 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4167 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
4168 match payment_secrets.entry(payment_hash) {
4169 hash_map::Entry::Vacant(e) => {
4170 e.insert(PendingInboundPayment {
4171 payment_secret, min_value_msat, user_payment_id, payment_preimage,
4172 // We assume that highest_seen_timestamp is pretty close to the current time -
4173 // its updated when we receive a new block with the maximum time we've seen in
4174 // a header. It should never be more than two hours in the future.
4175 // Thus, we add two hours here as a buffer to ensure we absolutely
4176 // never fail a payment too early.
4177 // Note that we assume that received blocks have reasonably up-to-date
4179 expiry_time: self.highest_seen_timestamp.load(Ordering::Acquire) as u64 + invoice_expiry_delta_secs as u64 + 7200,
4182 hash_map::Entry::Occupied(_) => return Err(APIError::APIMisuseError { err: "Duplicate payment hash".to_owned() }),
4187 /// Gets a payment secret and payment hash for use in an invoice given to a third party wishing
4190 /// This differs from [`create_inbound_payment_for_hash`] only in that it generates the
4191 /// [`PaymentHash`] and [`PaymentPreimage`] for you, returning the first and storing the second.
4193 /// The [`PaymentPreimage`] will ultimately be returned to you in the [`PaymentReceived`], which
4194 /// will have the [`PaymentReceived::payment_preimage`] field filled in. That should then be
4195 /// passed directly to [`claim_funds`].
4197 /// See [`create_inbound_payment_for_hash`] for detailed documentation on behavior and requirements.
4199 /// [`claim_funds`]: Self::claim_funds
4200 /// [`PaymentReceived`]: events::Event::PaymentReceived
4201 /// [`PaymentReceived::payment_preimage`]: events::Event::PaymentReceived::payment_preimage
4202 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
4203 pub fn create_inbound_payment(&self, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32, user_payment_id: u64) -> (PaymentHash, PaymentSecret) {
4204 let payment_preimage = PaymentPreimage(self.keys_manager.get_secure_random_bytes());
4205 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
4208 self.set_payment_hash_secret_map(payment_hash, Some(payment_preimage), min_value_msat, invoice_expiry_delta_secs, user_payment_id)
4209 .expect("RNG Generated Duplicate PaymentHash"))
4212 /// Gets a [`PaymentSecret`] for a given [`PaymentHash`], for which the payment preimage is
4213 /// stored external to LDK.
4215 /// A [`PaymentReceived`] event will only be generated if the [`PaymentSecret`] matches a
4216 /// payment secret fetched via this method or [`create_inbound_payment`], and which is at least
4217 /// the `min_value_msat` provided here, if one is provided.
4219 /// The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) must be globally unique. This
4220 /// method may return an Err if another payment with the same payment_hash is still pending.
4222 /// `user_payment_id` will be provided back in [`PaymentPurpose::InvoicePayment::user_payment_id`] events to
4223 /// allow tracking of which events correspond with which calls to this and
4224 /// [`create_inbound_payment`]. `user_payment_id` has no meaning inside of LDK, it is simply
4225 /// copied to events and otherwise ignored. It may be used to correlate PaymentReceived events
4226 /// with invoice metadata stored elsewhere.
4228 /// `min_value_msat` should be set if the invoice being generated contains a value. Any payment
4229 /// received for the returned [`PaymentHash`] will be required to be at least `min_value_msat`
4230 /// before a [`PaymentReceived`] event will be generated, ensuring that we do not provide the
4231 /// sender "proof-of-payment" unless they have paid the required amount.
4233 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
4234 /// in excess of the current time. This should roughly match the expiry time set in the invoice.
4235 /// After this many seconds, we will remove the inbound payment, resulting in any attempts to
4236 /// pay the invoice failing. The BOLT spec suggests 3,600 secs as a default validity time for
4237 /// invoices when no timeout is set.
4239 /// Note that we use block header time to time-out pending inbound payments (with some margin
4240 /// to compensate for the inaccuracy of block header timestamps). Thus, in practice we will
4241 /// accept a payment and generate a [`PaymentReceived`] event for some time after the expiry.
4242 /// If you need exact expiry semantics, you should enforce them upon receipt of
4243 /// [`PaymentReceived`].
4245 /// Pending inbound payments are stored in memory and in serialized versions of this
4246 /// [`ChannelManager`]. If potentially unbounded numbers of inbound payments may exist and
4247 /// space is limited, you may wish to rate-limit inbound payment creation.
4249 /// May panic if `invoice_expiry_delta_secs` is greater than one year.
4251 /// Note that invoices generated for inbound payments should have their `min_final_cltv_expiry`
4252 /// set to at least [`MIN_FINAL_CLTV_EXPIRY`].
4254 /// [`create_inbound_payment`]: Self::create_inbound_payment
4255 /// [`PaymentReceived`]: events::Event::PaymentReceived
4256 /// [`PaymentPurpose::InvoicePayment::user_payment_id`]: events::PaymentPurpose::InvoicePayment::user_payment_id
4257 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> {
4258 self.set_payment_hash_secret_map(payment_hash, None, min_value_msat, invoice_expiry_delta_secs, user_payment_id)
4261 #[cfg(any(test, feature = "fuzztarget", feature = "_test_utils"))]
4262 pub fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
4263 let events = core::cell::RefCell::new(Vec::new());
4264 let event_handler = |event: &events::Event| events.borrow_mut().push(event.clone());
4265 self.process_pending_events(&event_handler);
4270 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> MessageSendEventsProvider for ChannelManager<Signer, M, T, K, F, L>
4271 where M::Target: chain::Watch<Signer>,
4272 T::Target: BroadcasterInterface,
4273 K::Target: KeysInterface<Signer = Signer>,
4274 F::Target: FeeEstimator,
4277 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
4278 let events = RefCell::new(Vec::new());
4279 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
4280 let mut result = NotifyOption::SkipPersist;
4282 // TODO: This behavior should be documented. It's unintuitive that we query
4283 // ChannelMonitors when clearing other events.
4284 if self.process_pending_monitor_events() {
4285 result = NotifyOption::DoPersist;
4288 if self.check_free_holding_cells() {
4289 result = NotifyOption::DoPersist;
4291 if self.maybe_generate_initial_closing_signed() {
4292 result = NotifyOption::DoPersist;
4295 let mut pending_events = Vec::new();
4296 let mut channel_state = self.channel_state.lock().unwrap();
4297 mem::swap(&mut pending_events, &mut channel_state.pending_msg_events);
4299 if !pending_events.is_empty() {
4300 events.replace(pending_events);
4309 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> EventsProvider for ChannelManager<Signer, M, T, K, F, L>
4311 M::Target: chain::Watch<Signer>,
4312 T::Target: BroadcasterInterface,
4313 K::Target: KeysInterface<Signer = Signer>,
4314 F::Target: FeeEstimator,
4317 /// Processes events that must be periodically handled.
4319 /// An [`EventHandler`] may safely call back to the provider in order to handle an event.
4320 /// However, it must not call [`Writeable::write`] as doing so would result in a deadlock.
4322 /// Pending events are persisted as part of [`ChannelManager`]. While these events are cleared
4323 /// when processed, an [`EventHandler`] must be able to handle previously seen events when
4324 /// restarting from an old state.
4325 fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler {
4326 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
4327 let mut result = NotifyOption::SkipPersist;
4329 // TODO: This behavior should be documented. It's unintuitive that we query
4330 // ChannelMonitors when clearing other events.
4331 if self.process_pending_monitor_events() {
4332 result = NotifyOption::DoPersist;
4335 let mut pending_events = mem::replace(&mut *self.pending_events.lock().unwrap(), vec![]);
4336 if !pending_events.is_empty() {
4337 result = NotifyOption::DoPersist;
4340 for event in pending_events.drain(..) {
4341 handler.handle_event(&event);
4349 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> chain::Listen for ChannelManager<Signer, M, T, K, F, L>
4351 M::Target: chain::Watch<Signer>,
4352 T::Target: BroadcasterInterface,
4353 K::Target: KeysInterface<Signer = Signer>,
4354 F::Target: FeeEstimator,
4357 fn block_connected(&self, block: &Block, height: u32) {
4359 let best_block = self.best_block.read().unwrap();
4360 assert_eq!(best_block.block_hash(), block.header.prev_blockhash,
4361 "Blocks must be connected in chain-order - the connected header must build on the last connected header");
4362 assert_eq!(best_block.height(), height - 1,
4363 "Blocks must be connected in chain-order - the connected block height must be one greater than the previous height");
4366 let txdata: Vec<_> = block.txdata.iter().enumerate().collect();
4367 self.transactions_confirmed(&block.header, &txdata, height);
4368 self.best_block_updated(&block.header, height);
4371 fn block_disconnected(&self, header: &BlockHeader, height: u32) {
4372 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4373 let new_height = height - 1;
4375 let mut best_block = self.best_block.write().unwrap();
4376 assert_eq!(best_block.block_hash(), header.block_hash(),
4377 "Blocks must be disconnected in chain-order - the disconnected header must be the last connected header");
4378 assert_eq!(best_block.height(), height,
4379 "Blocks must be disconnected in chain-order - the disconnected block must have the correct height");
4380 *best_block = BestBlock::new(header.prev_blockhash, new_height)
4383 self.do_chain_event(Some(new_height), |channel| channel.best_block_updated(new_height, header.time, &self.logger));
4387 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> chain::Confirm for ChannelManager<Signer, M, T, K, F, L>
4389 M::Target: chain::Watch<Signer>,
4390 T::Target: BroadcasterInterface,
4391 K::Target: KeysInterface<Signer = Signer>,
4392 F::Target: FeeEstimator,
4395 fn transactions_confirmed(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
4396 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
4397 // during initialization prior to the chain_monitor being fully configured in some cases.
4398 // See the docs for `ChannelManagerReadArgs` for more.
4400 let block_hash = header.block_hash();
4401 log_trace!(self.logger, "{} transactions included in block {} at height {} provided", txdata.len(), block_hash, height);
4403 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4404 self.do_chain_event(Some(height), |channel| channel.transactions_confirmed(&block_hash, height, txdata, &self.logger).map(|a| (a, Vec::new())));
4407 fn best_block_updated(&self, header: &BlockHeader, height: u32) {
4408 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
4409 // during initialization prior to the chain_monitor being fully configured in some cases.
4410 // See the docs for `ChannelManagerReadArgs` for more.
4412 let block_hash = header.block_hash();
4413 log_trace!(self.logger, "New best block: {} at height {}", block_hash, height);
4415 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4417 *self.best_block.write().unwrap() = BestBlock::new(block_hash, height);
4419 self.do_chain_event(Some(height), |channel| channel.best_block_updated(height, header.time, &self.logger));
4421 macro_rules! max_time {
4422 ($timestamp: expr) => {
4424 // Update $timestamp to be the max of its current value and the block
4425 // timestamp. This should keep us close to the current time without relying on
4426 // having an explicit local time source.
4427 // Just in case we end up in a race, we loop until we either successfully
4428 // update $timestamp or decide we don't need to.
4429 let old_serial = $timestamp.load(Ordering::Acquire);
4430 if old_serial >= header.time as usize { break; }
4431 if $timestamp.compare_exchange(old_serial, header.time as usize, Ordering::AcqRel, Ordering::Relaxed).is_ok() {
4437 max_time!(self.last_node_announcement_serial);
4438 max_time!(self.highest_seen_timestamp);
4439 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
4440 payment_secrets.retain(|_, inbound_payment| {
4441 inbound_payment.expiry_time > header.time as u64
4445 fn get_relevant_txids(&self) -> Vec<Txid> {
4446 let channel_state = self.channel_state.lock().unwrap();
4447 let mut res = Vec::with_capacity(channel_state.short_to_id.len());
4448 for chan in channel_state.by_id.values() {
4449 if let Some(funding_txo) = chan.get_funding_txo() {
4450 res.push(funding_txo.txid);
4456 fn transaction_unconfirmed(&self, txid: &Txid) {
4457 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4458 self.do_chain_event(None, |channel| {
4459 if let Some(funding_txo) = channel.get_funding_txo() {
4460 if funding_txo.txid == *txid {
4461 channel.funding_transaction_unconfirmed(&self.logger).map(|_| (None, Vec::new()))
4462 } else { Ok((None, Vec::new())) }
4463 } else { Ok((None, Vec::new())) }
4468 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<Signer, M, T, K, F, L>
4470 M::Target: chain::Watch<Signer>,
4471 T::Target: BroadcasterInterface,
4472 K::Target: KeysInterface<Signer = Signer>,
4473 F::Target: FeeEstimator,
4476 /// Calls a function which handles an on-chain event (blocks dis/connected, transactions
4477 /// un/confirmed, etc) on each channel, handling any resulting errors or messages generated by
4479 fn do_chain_event<FN: Fn(&mut Channel<Signer>) -> Result<(Option<msgs::FundingLocked>, Vec<(HTLCSource, PaymentHash)>), msgs::ErrorMessage>>
4480 (&self, height_opt: Option<u32>, f: FN) {
4481 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
4482 // during initialization prior to the chain_monitor being fully configured in some cases.
4483 // See the docs for `ChannelManagerReadArgs` for more.
4485 let mut failed_channels = Vec::new();
4486 let mut timed_out_htlcs = Vec::new();
4488 let mut channel_lock = self.channel_state.lock().unwrap();
4489 let channel_state = &mut *channel_lock;
4490 let short_to_id = &mut channel_state.short_to_id;
4491 let pending_msg_events = &mut channel_state.pending_msg_events;
4492 channel_state.by_id.retain(|_, channel| {
4493 let res = f(channel);
4494 if let Ok((chan_res, mut timed_out_pending_htlcs)) = res {
4495 for (source, payment_hash) in timed_out_pending_htlcs.drain(..) {
4496 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
4497 timed_out_htlcs.push((source, payment_hash, HTLCFailReason::Reason {
4498 failure_code: 0x1000 | 14, // expiry_too_soon, or at least it is now
4502 if let Some(funding_locked) = chan_res {
4503 pending_msg_events.push(events::MessageSendEvent::SendFundingLocked {
4504 node_id: channel.get_counterparty_node_id(),
4505 msg: funding_locked,
4507 if let Some(announcement_sigs) = self.get_announcement_sigs(channel) {
4508 log_trace!(self.logger, "Sending funding_locked and announcement_signatures for {}", log_bytes!(channel.channel_id()));
4509 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
4510 node_id: channel.get_counterparty_node_id(),
4511 msg: announcement_sigs,
4513 } else if channel.is_usable() {
4514 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()));
4515 pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
4516 node_id: channel.get_counterparty_node_id(),
4517 msg: self.get_channel_update_for_unicast(channel).unwrap(),
4520 log_trace!(self.logger, "Sending funding_locked WITHOUT announcement_signatures for {}", log_bytes!(channel.channel_id()));
4522 short_to_id.insert(channel.get_short_channel_id().unwrap(), channel.channel_id());
4524 } else if let Err(e) = res {
4525 if let Some(short_id) = channel.get_short_channel_id() {
4526 short_to_id.remove(&short_id);
4528 // It looks like our counterparty went on-chain or funding transaction was
4529 // reorged out of the main chain. Close the channel.
4530 failed_channels.push(channel.force_shutdown(true));
4531 if let Ok(update) = self.get_channel_update_for_broadcast(&channel) {
4532 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
4536 self.pending_events.lock().unwrap().push(events::Event::ChannelClosed { channel_id: channel.channel_id(), reason: ClosureReason::CommitmentTxConfirmed });
4537 pending_msg_events.push(events::MessageSendEvent::HandleError {
4538 node_id: channel.get_counterparty_node_id(),
4539 action: msgs::ErrorAction::SendErrorMessage { msg: e },
4546 if let Some(height) = height_opt {
4547 channel_state.claimable_htlcs.retain(|payment_hash, htlcs| {
4548 htlcs.retain(|htlc| {
4549 // If height is approaching the number of blocks we think it takes us to get
4550 // our commitment transaction confirmed before the HTLC expires, plus the
4551 // number of blocks we generally consider it to take to do a commitment update,
4552 // just give up on it and fail the HTLC.
4553 if height >= htlc.cltv_expiry - HTLC_FAIL_BACK_BUFFER {
4554 let mut htlc_msat_height_data = byte_utils::be64_to_array(htlc.value).to_vec();
4555 htlc_msat_height_data.extend_from_slice(&byte_utils::be32_to_array(height));
4556 timed_out_htlcs.push((HTLCSource::PreviousHopData(htlc.prev_hop.clone()), payment_hash.clone(), HTLCFailReason::Reason {
4557 failure_code: 0x4000 | 15,
4558 data: htlc_msat_height_data
4563 !htlcs.is_empty() // Only retain this entry if htlcs has at least one entry.
4568 self.handle_init_event_channel_failures(failed_channels);
4570 for (source, payment_hash, reason) in timed_out_htlcs.drain(..) {
4571 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), source, &payment_hash, reason);
4575 /// Blocks until ChannelManager needs to be persisted or a timeout is reached. It returns a bool
4576 /// indicating whether persistence is necessary. Only one listener on
4577 /// `await_persistable_update` or `await_persistable_update_timeout` is guaranteed to be woken
4579 /// Note that the feature `allow_wallclock_use` must be enabled to use this function.
4580 #[cfg(any(test, feature = "allow_wallclock_use"))]
4581 pub fn await_persistable_update_timeout(&self, max_wait: Duration) -> bool {
4582 self.persistence_notifier.wait_timeout(max_wait)
4585 /// Blocks until ChannelManager needs to be persisted. Only one listener on
4586 /// `await_persistable_update` or `await_persistable_update_timeout` is guaranteed to be woken
4588 pub fn await_persistable_update(&self) {
4589 self.persistence_notifier.wait()
4592 #[cfg(any(test, feature = "_test_utils"))]
4593 pub fn get_persistence_condvar_value(&self) -> bool {
4594 let mutcond = &self.persistence_notifier.persistence_lock;
4595 let &(ref mtx, _) = mutcond;
4596 let guard = mtx.lock().unwrap();
4600 /// Gets the latest best block which was connected either via the [`chain::Listen`] or
4601 /// [`chain::Confirm`] interfaces.
4602 pub fn current_best_block(&self) -> BestBlock {
4603 self.best_block.read().unwrap().clone()
4607 impl<Signer: Sign, M: Deref , T: Deref , K: Deref , F: Deref , L: Deref >
4608 ChannelMessageHandler for ChannelManager<Signer, M, T, K, F, L>
4609 where M::Target: chain::Watch<Signer>,
4610 T::Target: BroadcasterInterface,
4611 K::Target: KeysInterface<Signer = Signer>,
4612 F::Target: FeeEstimator,
4615 fn handle_open_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::OpenChannel) {
4616 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4617 let _ = handle_error!(self, self.internal_open_channel(counterparty_node_id, their_features, msg), *counterparty_node_id);
4620 fn handle_accept_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::AcceptChannel) {
4621 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4622 let _ = handle_error!(self, self.internal_accept_channel(counterparty_node_id, their_features, msg), *counterparty_node_id);
4625 fn handle_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) {
4626 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4627 let _ = handle_error!(self, self.internal_funding_created(counterparty_node_id, msg), *counterparty_node_id);
4630 fn handle_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) {
4631 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4632 let _ = handle_error!(self, self.internal_funding_signed(counterparty_node_id, msg), *counterparty_node_id);
4635 fn handle_funding_locked(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingLocked) {
4636 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4637 let _ = handle_error!(self, self.internal_funding_locked(counterparty_node_id, msg), *counterparty_node_id);
4640 fn handle_shutdown(&self, counterparty_node_id: &PublicKey, their_features: &InitFeatures, msg: &msgs::Shutdown) {
4641 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4642 let _ = handle_error!(self, self.internal_shutdown(counterparty_node_id, their_features, msg), *counterparty_node_id);
4645 fn handle_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
4646 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4647 let _ = handle_error!(self, self.internal_closing_signed(counterparty_node_id, msg), *counterparty_node_id);
4650 fn handle_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
4651 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4652 let _ = handle_error!(self, self.internal_update_add_htlc(counterparty_node_id, msg), *counterparty_node_id);
4655 fn handle_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
4656 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4657 let _ = handle_error!(self, self.internal_update_fulfill_htlc(counterparty_node_id, msg), *counterparty_node_id);
4660 fn handle_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
4661 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4662 let _ = handle_error!(self, self.internal_update_fail_htlc(counterparty_node_id, msg), *counterparty_node_id);
4665 fn handle_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
4666 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4667 let _ = handle_error!(self, self.internal_update_fail_malformed_htlc(counterparty_node_id, msg), *counterparty_node_id);
4670 fn handle_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
4671 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4672 let _ = handle_error!(self, self.internal_commitment_signed(counterparty_node_id, msg), *counterparty_node_id);
4675 fn handle_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
4676 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4677 let _ = handle_error!(self, self.internal_revoke_and_ack(counterparty_node_id, msg), *counterparty_node_id);
4680 fn handle_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) {
4681 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4682 let _ = handle_error!(self, self.internal_update_fee(counterparty_node_id, msg), *counterparty_node_id);
4685 fn handle_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
4686 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4687 let _ = handle_error!(self, self.internal_announcement_signatures(counterparty_node_id, msg), *counterparty_node_id);
4690 fn handle_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) {
4691 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
4692 if let Ok(persist) = handle_error!(self, self.internal_channel_update(counterparty_node_id, msg), *counterparty_node_id) {
4695 NotifyOption::SkipPersist
4700 fn handle_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
4701 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4702 let _ = handle_error!(self, self.internal_channel_reestablish(counterparty_node_id, msg), *counterparty_node_id);
4705 fn peer_disconnected(&self, counterparty_node_id: &PublicKey, no_connection_possible: bool) {
4706 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4707 let mut failed_channels = Vec::new();
4708 let mut no_channels_remain = true;
4710 let mut channel_state_lock = self.channel_state.lock().unwrap();
4711 let channel_state = &mut *channel_state_lock;
4712 let short_to_id = &mut channel_state.short_to_id;
4713 let pending_msg_events = &mut channel_state.pending_msg_events;
4714 if no_connection_possible {
4715 log_debug!(self.logger, "Failing all channels with {} due to no_connection_possible", log_pubkey!(counterparty_node_id));
4716 channel_state.by_id.retain(|_, chan| {
4717 if chan.get_counterparty_node_id() == *counterparty_node_id {
4718 if let Some(short_id) = chan.get_short_channel_id() {
4719 short_to_id.remove(&short_id);
4721 failed_channels.push(chan.force_shutdown(true));
4722 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
4723 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
4727 self.pending_events.lock().unwrap().push(events::Event::ChannelClosed { channel_id: chan.channel_id(), reason: ClosureReason::DisconnectedPeer });
4734 log_debug!(self.logger, "Marking channels with {} disconnected and generating channel_updates", log_pubkey!(counterparty_node_id));
4735 channel_state.by_id.retain(|_, chan| {
4736 if chan.get_counterparty_node_id() == *counterparty_node_id {
4737 chan.remove_uncommitted_htlcs_and_mark_paused(&self.logger);
4738 if chan.is_shutdown() {
4739 if let Some(short_id) = chan.get_short_channel_id() {
4740 short_to_id.remove(&short_id);
4742 self.pending_events.lock().unwrap().push(events::Event::ChannelClosed { channel_id: chan.channel_id(), reason: ClosureReason::DisconnectedPeer });
4745 no_channels_remain = false;
4751 pending_msg_events.retain(|msg| {
4753 &events::MessageSendEvent::SendAcceptChannel { ref node_id, .. } => node_id != counterparty_node_id,
4754 &events::MessageSendEvent::SendOpenChannel { ref node_id, .. } => node_id != counterparty_node_id,
4755 &events::MessageSendEvent::SendFundingCreated { ref node_id, .. } => node_id != counterparty_node_id,
4756 &events::MessageSendEvent::SendFundingSigned { ref node_id, .. } => node_id != counterparty_node_id,
4757 &events::MessageSendEvent::SendFundingLocked { ref node_id, .. } => node_id != counterparty_node_id,
4758 &events::MessageSendEvent::SendAnnouncementSignatures { ref node_id, .. } => node_id != counterparty_node_id,
4759 &events::MessageSendEvent::UpdateHTLCs { ref node_id, .. } => node_id != counterparty_node_id,
4760 &events::MessageSendEvent::SendRevokeAndACK { ref node_id, .. } => node_id != counterparty_node_id,
4761 &events::MessageSendEvent::SendClosingSigned { ref node_id, .. } => node_id != counterparty_node_id,
4762 &events::MessageSendEvent::SendShutdown { ref node_id, .. } => node_id != counterparty_node_id,
4763 &events::MessageSendEvent::SendChannelReestablish { ref node_id, .. } => node_id != counterparty_node_id,
4764 &events::MessageSendEvent::BroadcastChannelAnnouncement { .. } => true,
4765 &events::MessageSendEvent::BroadcastNodeAnnouncement { .. } => true,
4766 &events::MessageSendEvent::BroadcastChannelUpdate { .. } => true,
4767 &events::MessageSendEvent::SendChannelUpdate { ref node_id, .. } => node_id != counterparty_node_id,
4768 &events::MessageSendEvent::HandleError { ref node_id, .. } => node_id != counterparty_node_id,
4769 &events::MessageSendEvent::SendChannelRangeQuery { .. } => false,
4770 &events::MessageSendEvent::SendShortIdsQuery { .. } => false,
4771 &events::MessageSendEvent::SendReplyChannelRange { .. } => false,
4775 if no_channels_remain {
4776 self.per_peer_state.write().unwrap().remove(counterparty_node_id);
4779 for failure in failed_channels.drain(..) {
4780 self.finish_force_close_channel(failure);
4784 fn peer_connected(&self, counterparty_node_id: &PublicKey, init_msg: &msgs::Init) {
4785 log_debug!(self.logger, "Generating channel_reestablish events for {}", log_pubkey!(counterparty_node_id));
4787 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4790 let mut peer_state_lock = self.per_peer_state.write().unwrap();
4791 match peer_state_lock.entry(counterparty_node_id.clone()) {
4792 hash_map::Entry::Vacant(e) => {
4793 e.insert(Mutex::new(PeerState {
4794 latest_features: init_msg.features.clone(),
4797 hash_map::Entry::Occupied(e) => {
4798 e.get().lock().unwrap().latest_features = init_msg.features.clone();
4803 let mut channel_state_lock = self.channel_state.lock().unwrap();
4804 let channel_state = &mut *channel_state_lock;
4805 let pending_msg_events = &mut channel_state.pending_msg_events;
4806 channel_state.by_id.retain(|_, chan| {
4807 if chan.get_counterparty_node_id() == *counterparty_node_id {
4808 if !chan.have_received_message() {
4809 // If we created this (outbound) channel while we were disconnected from the
4810 // peer we probably failed to send the open_channel message, which is now
4811 // lost. We can't have had anything pending related to this channel, so we just
4815 pending_msg_events.push(events::MessageSendEvent::SendChannelReestablish {
4816 node_id: chan.get_counterparty_node_id(),
4817 msg: chan.get_channel_reestablish(&self.logger),
4823 //TODO: Also re-broadcast announcement_signatures
4826 fn handle_error(&self, counterparty_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
4827 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4829 if msg.channel_id == [0; 32] {
4830 for chan in self.list_channels() {
4831 if chan.counterparty.node_id == *counterparty_node_id {
4832 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
4833 let _ = self.force_close_channel_with_peer(&chan.channel_id, Some(counterparty_node_id), Some(&msg.data));
4837 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
4838 let _ = self.force_close_channel_with_peer(&msg.channel_id, Some(counterparty_node_id), Some(&msg.data));
4843 /// Used to signal to the ChannelManager persister that the manager needs to be re-persisted to
4844 /// disk/backups, through `await_persistable_update_timeout` and `await_persistable_update`.
4845 struct PersistenceNotifier {
4846 /// Users won't access the persistence_lock directly, but rather wait on its bool using
4847 /// `wait_timeout` and `wait`.
4848 persistence_lock: (Mutex<bool>, Condvar),
4851 impl PersistenceNotifier {
4854 persistence_lock: (Mutex::new(false), Condvar::new()),
4860 let &(ref mtx, ref cvar) = &self.persistence_lock;
4861 let mut guard = mtx.lock().unwrap();
4866 guard = cvar.wait(guard).unwrap();
4867 let result = *guard;
4875 #[cfg(any(test, feature = "allow_wallclock_use"))]
4876 fn wait_timeout(&self, max_wait: Duration) -> bool {
4877 let current_time = Instant::now();
4879 let &(ref mtx, ref cvar) = &self.persistence_lock;
4880 let mut guard = mtx.lock().unwrap();
4885 guard = cvar.wait_timeout(guard, max_wait).unwrap().0;
4886 // Due to spurious wakeups that can happen on `wait_timeout`, here we need to check if the
4887 // desired wait time has actually passed, and if not then restart the loop with a reduced wait
4888 // time. Note that this logic can be highly simplified through the use of
4889 // `Condvar::wait_while` and `Condvar::wait_timeout_while`, if and when our MSRV is raised to
4891 let elapsed = current_time.elapsed();
4892 let result = *guard;
4893 if result || elapsed >= max_wait {
4897 match max_wait.checked_sub(elapsed) {
4898 None => return result,
4904 // Signal to the ChannelManager persister that there are updates necessitating persisting to disk.
4906 let &(ref persist_mtx, ref cnd) = &self.persistence_lock;
4907 let mut persistence_lock = persist_mtx.lock().unwrap();
4908 *persistence_lock = true;
4909 mem::drop(persistence_lock);
4914 const SERIALIZATION_VERSION: u8 = 1;
4915 const MIN_SERIALIZATION_VERSION: u8 = 1;
4917 impl_writeable_tlv_based_enum!(PendingHTLCRouting,
4919 (0, onion_packet, required),
4920 (2, short_channel_id, required),
4923 (0, payment_data, required),
4924 (2, incoming_cltv_expiry, required),
4926 (2, ReceiveKeysend) => {
4927 (0, payment_preimage, required),
4928 (2, incoming_cltv_expiry, required),
4932 impl_writeable_tlv_based!(PendingHTLCInfo, {
4933 (0, routing, required),
4934 (2, incoming_shared_secret, required),
4935 (4, payment_hash, required),
4936 (6, amt_to_forward, required),
4937 (8, outgoing_cltv_value, required)
4941 impl Writeable for HTLCFailureMsg {
4942 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
4944 HTLCFailureMsg::Relay(msgs::UpdateFailHTLC { channel_id, htlc_id, reason }) => {
4946 channel_id.write(writer)?;
4947 htlc_id.write(writer)?;
4948 reason.write(writer)?;
4950 HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
4951 channel_id, htlc_id, sha256_of_onion, failure_code
4954 channel_id.write(writer)?;
4955 htlc_id.write(writer)?;
4956 sha256_of_onion.write(writer)?;
4957 failure_code.write(writer)?;
4964 impl Readable for HTLCFailureMsg {
4965 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
4966 let id: u8 = Readable::read(reader)?;
4969 Ok(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
4970 channel_id: Readable::read(reader)?,
4971 htlc_id: Readable::read(reader)?,
4972 reason: Readable::read(reader)?,
4976 Ok(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
4977 channel_id: Readable::read(reader)?,
4978 htlc_id: Readable::read(reader)?,
4979 sha256_of_onion: Readable::read(reader)?,
4980 failure_code: Readable::read(reader)?,
4983 // In versions prior to 0.0.101, HTLCFailureMsg objects were written with type 0 or 1 but
4984 // weren't length-prefixed and thus didn't support reading the TLV stream suffix of the network
4985 // messages contained in the variants.
4986 // In version 0.0.101, support for reading the variants with these types was added, and
4987 // we should migrate to writing these variants when UpdateFailHTLC or
4988 // UpdateFailMalformedHTLC get TLV fields.
4990 let length: BigSize = Readable::read(reader)?;
4991 let mut s = FixedLengthReader::new(reader, length.0);
4992 let res = Readable::read(&mut s)?;
4993 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
4994 Ok(HTLCFailureMsg::Relay(res))
4997 let length: BigSize = Readable::read(reader)?;
4998 let mut s = FixedLengthReader::new(reader, length.0);
4999 let res = Readable::read(&mut s)?;
5000 s.eat_remaining()?; // Return ShortRead if there's actually not enough bytes
5001 Ok(HTLCFailureMsg::Malformed(res))
5003 _ => Err(DecodeError::UnknownRequiredFeature),
5008 impl_writeable_tlv_based_enum!(PendingHTLCStatus, ;
5013 impl_writeable_tlv_based!(HTLCPreviousHopData, {
5014 (0, short_channel_id, required),
5015 (2, outpoint, required),
5016 (4, htlc_id, required),
5017 (6, incoming_packet_shared_secret, required)
5020 impl Writeable for ClaimableHTLC {
5021 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
5022 let payment_data = match &self.onion_payload {
5023 OnionPayload::Invoice(data) => Some(data.clone()),
5026 let keysend_preimage = match self.onion_payload {
5027 OnionPayload::Invoice(_) => None,
5028 OnionPayload::Spontaneous(preimage) => Some(preimage.clone()),
5033 (0, self.prev_hop, required), (2, self.value, required),
5034 (4, payment_data, option), (6, self.cltv_expiry, required),
5035 (8, keysend_preimage, option),
5041 impl Readable for ClaimableHTLC {
5042 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
5043 let mut prev_hop = ::util::ser::OptionDeserWrapper(None);
5045 let mut payment_data: Option<msgs::FinalOnionHopData> = None;
5046 let mut cltv_expiry = 0;
5047 let mut keysend_preimage: Option<PaymentPreimage> = None;
5051 (0, prev_hop, required), (2, value, required),
5052 (4, payment_data, option), (6, cltv_expiry, required),
5053 (8, keysend_preimage, option)
5055 let onion_payload = match keysend_preimage {
5057 if payment_data.is_some() {
5058 return Err(DecodeError::InvalidValue)
5060 OnionPayload::Spontaneous(p)
5063 if payment_data.is_none() {
5064 return Err(DecodeError::InvalidValue)
5066 OnionPayload::Invoice(payment_data.unwrap())
5070 prev_hop: prev_hop.0.unwrap(),
5078 impl Readable for HTLCSource {
5079 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
5080 let id: u8 = Readable::read(reader)?;
5083 let mut session_priv: ::util::ser::OptionDeserWrapper<SecretKey> = ::util::ser::OptionDeserWrapper(None);
5084 let mut first_hop_htlc_msat: u64 = 0;
5085 let mut path = Some(Vec::new());
5086 let mut payment_id = None;
5087 read_tlv_fields!(reader, {
5088 (0, session_priv, required),
5089 (1, payment_id, option),
5090 (2, first_hop_htlc_msat, required),
5091 (4, path, vec_type),
5093 if payment_id.is_none() {
5094 // For backwards compat, if there was no payment_id written, use the session_priv bytes
5096 payment_id = Some(PaymentId(*session_priv.0.unwrap().as_ref()));
5098 Ok(HTLCSource::OutboundRoute {
5099 session_priv: session_priv.0.unwrap(),
5100 first_hop_htlc_msat: first_hop_htlc_msat,
5101 path: path.unwrap(),
5102 payment_id: payment_id.unwrap(),
5105 1 => Ok(HTLCSource::PreviousHopData(Readable::read(reader)?)),
5106 _ => Err(DecodeError::UnknownRequiredFeature),
5111 impl Writeable for HTLCSource {
5112 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::io::Error> {
5114 HTLCSource::OutboundRoute { ref session_priv, ref first_hop_htlc_msat, ref path, payment_id } => {
5116 let payment_id_opt = Some(payment_id);
5117 write_tlv_fields!(writer, {
5118 (0, session_priv, required),
5119 (1, payment_id_opt, option),
5120 (2, first_hop_htlc_msat, required),
5121 (4, path, vec_type),
5124 HTLCSource::PreviousHopData(ref field) => {
5126 field.write(writer)?;
5133 impl_writeable_tlv_based_enum!(HTLCFailReason,
5134 (0, LightningError) => {
5138 (0, failure_code, required),
5139 (2, data, vec_type),
5143 impl_writeable_tlv_based_enum!(HTLCForwardInfo,
5145 (0, forward_info, required),
5146 (2, prev_short_channel_id, required),
5147 (4, prev_htlc_id, required),
5148 (6, prev_funding_outpoint, required),
5151 (0, htlc_id, required),
5152 (2, err_packet, required),
5156 impl_writeable_tlv_based!(PendingInboundPayment, {
5157 (0, payment_secret, required),
5158 (2, expiry_time, required),
5159 (4, user_payment_id, required),
5160 (6, payment_preimage, required),
5161 (8, min_value_msat, required),
5164 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> Writeable for ChannelManager<Signer, M, T, K, F, L>
5165 where M::Target: chain::Watch<Signer>,
5166 T::Target: BroadcasterInterface,
5167 K::Target: KeysInterface<Signer = Signer>,
5168 F::Target: FeeEstimator,
5171 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
5172 let _consistency_lock = self.total_consistency_lock.write().unwrap();
5174 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
5176 self.genesis_hash.write(writer)?;
5178 let best_block = self.best_block.read().unwrap();
5179 best_block.height().write(writer)?;
5180 best_block.block_hash().write(writer)?;
5183 let channel_state = self.channel_state.lock().unwrap();
5184 let mut unfunded_channels = 0;
5185 for (_, channel) in channel_state.by_id.iter() {
5186 if !channel.is_funding_initiated() {
5187 unfunded_channels += 1;
5190 ((channel_state.by_id.len() - unfunded_channels) as u64).write(writer)?;
5191 for (_, channel) in channel_state.by_id.iter() {
5192 if channel.is_funding_initiated() {
5193 channel.write(writer)?;
5197 (channel_state.forward_htlcs.len() as u64).write(writer)?;
5198 for (short_channel_id, pending_forwards) in channel_state.forward_htlcs.iter() {
5199 short_channel_id.write(writer)?;
5200 (pending_forwards.len() as u64).write(writer)?;
5201 for forward in pending_forwards {
5202 forward.write(writer)?;
5206 (channel_state.claimable_htlcs.len() as u64).write(writer)?;
5207 for (payment_hash, previous_hops) in channel_state.claimable_htlcs.iter() {
5208 payment_hash.write(writer)?;
5209 (previous_hops.len() as u64).write(writer)?;
5210 for htlc in previous_hops.iter() {
5211 htlc.write(writer)?;
5215 let per_peer_state = self.per_peer_state.write().unwrap();
5216 (per_peer_state.len() as u64).write(writer)?;
5217 for (peer_pubkey, peer_state_mutex) in per_peer_state.iter() {
5218 peer_pubkey.write(writer)?;
5219 let peer_state = peer_state_mutex.lock().unwrap();
5220 peer_state.latest_features.write(writer)?;
5223 let events = self.pending_events.lock().unwrap();
5224 (events.len() as u64).write(writer)?;
5225 for event in events.iter() {
5226 event.write(writer)?;
5229 let background_events = self.pending_background_events.lock().unwrap();
5230 (background_events.len() as u64).write(writer)?;
5231 for event in background_events.iter() {
5233 BackgroundEvent::ClosingMonitorUpdate((funding_txo, monitor_update)) => {
5235 funding_txo.write(writer)?;
5236 monitor_update.write(writer)?;
5241 (self.last_node_announcement_serial.load(Ordering::Acquire) as u32).write(writer)?;
5242 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
5244 let pending_inbound_payments = self.pending_inbound_payments.lock().unwrap();
5245 (pending_inbound_payments.len() as u64).write(writer)?;
5246 for (hash, pending_payment) in pending_inbound_payments.iter() {
5247 hash.write(writer)?;
5248 pending_payment.write(writer)?;
5251 let pending_outbound_payments = self.pending_outbound_payments.lock().unwrap();
5252 // For backwards compat, write the session privs and their total length.
5253 let mut num_pending_outbounds_compat: u64 = 0;
5254 for (_, outbounds) in pending_outbound_payments.iter() {
5255 num_pending_outbounds_compat += outbounds.len() as u64;
5257 num_pending_outbounds_compat.write(writer)?;
5258 for (_, outbounds) in pending_outbound_payments.iter() {
5259 for outbound in outbounds.iter() {
5260 outbound.write(writer)?;
5264 write_tlv_fields!(writer, {
5265 (1, pending_outbound_payments, required),
5272 /// Arguments for the creation of a ChannelManager that are not deserialized.
5274 /// At a high-level, the process for deserializing a ChannelManager and resuming normal operation
5276 /// 1) Deserialize all stored ChannelMonitors.
5277 /// 2) Deserialize the ChannelManager by filling in this struct and calling:
5278 /// <(BlockHash, ChannelManager)>::read(reader, args)
5279 /// This may result in closing some Channels if the ChannelMonitor is newer than the stored
5280 /// ChannelManager state to ensure no loss of funds. Thus, transactions may be broadcasted.
5281 /// 3) If you are not fetching full blocks, register all relevant ChannelMonitor outpoints the same
5282 /// way you would handle a `chain::Filter` call using ChannelMonitor::get_outputs_to_watch() and
5283 /// ChannelMonitor::get_funding_txo().
5284 /// 4) Reconnect blocks on your ChannelMonitors.
5285 /// 5) Disconnect/connect blocks on the ChannelManager.
5286 /// 6) Move the ChannelMonitors into your local chain::Watch.
5288 /// Note that the ordering of #4-6 is not of importance, however all three must occur before you
5289 /// call any other methods on the newly-deserialized ChannelManager.
5291 /// Note that because some channels may be closed during deserialization, it is critical that you
5292 /// always deserialize only the latest version of a ChannelManager and ChannelMonitors available to
5293 /// you. If you deserialize an old ChannelManager (during which force-closure transactions may be
5294 /// broadcast), and then later deserialize a newer version of the same ChannelManager (which will
5295 /// not force-close the same channels but consider them live), you may end up revoking a state for
5296 /// which you've already broadcasted the transaction.
5297 pub struct ChannelManagerReadArgs<'a, Signer: 'a + Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
5298 where M::Target: chain::Watch<Signer>,
5299 T::Target: BroadcasterInterface,
5300 K::Target: KeysInterface<Signer = Signer>,
5301 F::Target: FeeEstimator,
5304 /// The keys provider which will give us relevant keys. Some keys will be loaded during
5305 /// deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
5307 pub keys_manager: K,
5309 /// The fee_estimator for use in the ChannelManager in the future.
5311 /// No calls to the FeeEstimator will be made during deserialization.
5312 pub fee_estimator: F,
5313 /// The chain::Watch for use in the ChannelManager in the future.
5315 /// No calls to the chain::Watch will be made during deserialization. It is assumed that
5316 /// you have deserialized ChannelMonitors separately and will add them to your
5317 /// chain::Watch after deserializing this ChannelManager.
5318 pub chain_monitor: M,
5320 /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
5321 /// used to broadcast the latest local commitment transactions of channels which must be
5322 /// force-closed during deserialization.
5323 pub tx_broadcaster: T,
5324 /// The Logger for use in the ChannelManager and which may be used to log information during
5325 /// deserialization.
5327 /// Default settings used for new channels. Any existing channels will continue to use the
5328 /// runtime settings which were stored when the ChannelManager was serialized.
5329 pub default_config: UserConfig,
5331 /// A map from channel funding outpoints to ChannelMonitors for those channels (ie
5332 /// value.get_funding_txo() should be the key).
5334 /// If a monitor is inconsistent with the channel state during deserialization the channel will
5335 /// be force-closed using the data in the ChannelMonitor and the channel will be dropped. This
5336 /// is true for missing channels as well. If there is a monitor missing for which we find
5337 /// channel data Err(DecodeError::InvalidValue) will be returned.
5339 /// In such cases the latest local transactions will be sent to the tx_broadcaster included in
5342 /// (C-not exported) because we have no HashMap bindings
5343 pub channel_monitors: HashMap<OutPoint, &'a mut ChannelMonitor<Signer>>,
5346 impl<'a, Signer: 'a + Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
5347 ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>
5348 where M::Target: chain::Watch<Signer>,
5349 T::Target: BroadcasterInterface,
5350 K::Target: KeysInterface<Signer = Signer>,
5351 F::Target: FeeEstimator,
5354 /// Simple utility function to create a ChannelManagerReadArgs which creates the monitor
5355 /// HashMap for you. This is primarily useful for C bindings where it is not practical to
5356 /// populate a HashMap directly from C.
5357 pub fn new(keys_manager: K, fee_estimator: F, chain_monitor: M, tx_broadcaster: T, logger: L, default_config: UserConfig,
5358 mut channel_monitors: Vec<&'a mut ChannelMonitor<Signer>>) -> Self {
5360 keys_manager, fee_estimator, chain_monitor, tx_broadcaster, logger, default_config,
5361 channel_monitors: channel_monitors.drain(..).map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect()
5366 // Implement ReadableArgs for an Arc'd ChannelManager to make it a bit easier to work with the
5367 // SipmleArcChannelManager type:
5368 impl<'a, Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
5369 ReadableArgs<ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>> for (BlockHash, Arc<ChannelManager<Signer, M, T, K, F, L>>)
5370 where M::Target: chain::Watch<Signer>,
5371 T::Target: BroadcasterInterface,
5372 K::Target: KeysInterface<Signer = Signer>,
5373 F::Target: FeeEstimator,
5376 fn read<R: io::Read>(reader: &mut R, args: ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>) -> Result<Self, DecodeError> {
5377 let (blockhash, chan_manager) = <(BlockHash, ChannelManager<Signer, M, T, K, F, L>)>::read(reader, args)?;
5378 Ok((blockhash, Arc::new(chan_manager)))
5382 impl<'a, Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
5383 ReadableArgs<ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>> for (BlockHash, ChannelManager<Signer, M, T, K, F, L>)
5384 where M::Target: chain::Watch<Signer>,
5385 T::Target: BroadcasterInterface,
5386 K::Target: KeysInterface<Signer = Signer>,
5387 F::Target: FeeEstimator,
5390 fn read<R: io::Read>(reader: &mut R, mut args: ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>) -> Result<Self, DecodeError> {
5391 let _ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
5393 let genesis_hash: BlockHash = Readable::read(reader)?;
5394 let best_block_height: u32 = Readable::read(reader)?;
5395 let best_block_hash: BlockHash = Readable::read(reader)?;
5397 let mut failed_htlcs = Vec::new();
5399 let channel_count: u64 = Readable::read(reader)?;
5400 let mut funding_txo_set = HashSet::with_capacity(cmp::min(channel_count as usize, 128));
5401 let mut by_id = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
5402 let mut short_to_id = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
5403 let mut channel_closures = Vec::new();
5404 for _ in 0..channel_count {
5405 let mut channel: Channel<Signer> = Channel::read(reader, &args.keys_manager)?;
5406 let funding_txo = channel.get_funding_txo().ok_or(DecodeError::InvalidValue)?;
5407 funding_txo_set.insert(funding_txo.clone());
5408 if let Some(ref mut monitor) = args.channel_monitors.get_mut(&funding_txo) {
5409 if channel.get_cur_holder_commitment_transaction_number() < monitor.get_cur_holder_commitment_number() ||
5410 channel.get_revoked_counterparty_commitment_transaction_number() < monitor.get_min_seen_secret() ||
5411 channel.get_cur_counterparty_commitment_transaction_number() < monitor.get_cur_counterparty_commitment_number() ||
5412 channel.get_latest_monitor_update_id() > monitor.get_latest_update_id() {
5413 // If the channel is ahead of the monitor, return InvalidValue:
5414 log_error!(args.logger, "A ChannelMonitor is stale compared to the current ChannelManager! This indicates a potentially-critical violation of the chain::Watch API!");
5415 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
5416 log_bytes!(channel.channel_id()), monitor.get_latest_update_id(), channel.get_latest_monitor_update_id());
5417 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
5418 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
5419 log_error!(args.logger, " Without the latest ChannelMonitor we cannot continue without risking funds.");
5420 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");
5421 return Err(DecodeError::InvalidValue);
5422 } else if channel.get_cur_holder_commitment_transaction_number() > monitor.get_cur_holder_commitment_number() ||
5423 channel.get_revoked_counterparty_commitment_transaction_number() > monitor.get_min_seen_secret() ||
5424 channel.get_cur_counterparty_commitment_transaction_number() > monitor.get_cur_counterparty_commitment_number() ||
5425 channel.get_latest_monitor_update_id() < monitor.get_latest_update_id() {
5426 // But if the channel is behind of the monitor, close the channel:
5427 log_error!(args.logger, "A ChannelManager is stale compared to the current ChannelMonitor!");
5428 log_error!(args.logger, " The channel will be force-closed and the latest commitment transaction from the ChannelMonitor broadcast.");
5429 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
5430 log_bytes!(channel.channel_id()), monitor.get_latest_update_id(), channel.get_latest_monitor_update_id());
5431 let (_, mut new_failed_htlcs) = channel.force_shutdown(true);
5432 failed_htlcs.append(&mut new_failed_htlcs);
5433 monitor.broadcast_latest_holder_commitment_txn(&args.tx_broadcaster, &args.logger);
5434 channel_closures.push(events::Event::ChannelClosed {
5435 channel_id: channel.channel_id(),
5436 reason: ClosureReason::OutdatedChannelManager
5439 if let Some(short_channel_id) = channel.get_short_channel_id() {
5440 short_to_id.insert(short_channel_id, channel.channel_id());
5442 by_id.insert(channel.channel_id(), channel);
5445 log_error!(args.logger, "Missing ChannelMonitor for channel {} needed by ChannelManager.", log_bytes!(channel.channel_id()));
5446 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
5447 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
5448 log_error!(args.logger, " Without the ChannelMonitor we cannot continue without risking funds.");
5449 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");
5450 return Err(DecodeError::InvalidValue);
5454 for (ref funding_txo, ref mut monitor) in args.channel_monitors.iter_mut() {
5455 if !funding_txo_set.contains(funding_txo) {
5456 monitor.broadcast_latest_holder_commitment_txn(&args.tx_broadcaster, &args.logger);
5460 const MAX_ALLOC_SIZE: usize = 1024 * 64;
5461 let forward_htlcs_count: u64 = Readable::read(reader)?;
5462 let mut forward_htlcs = HashMap::with_capacity(cmp::min(forward_htlcs_count as usize, 128));
5463 for _ in 0..forward_htlcs_count {
5464 let short_channel_id = Readable::read(reader)?;
5465 let pending_forwards_count: u64 = Readable::read(reader)?;
5466 let mut pending_forwards = Vec::with_capacity(cmp::min(pending_forwards_count as usize, MAX_ALLOC_SIZE/mem::size_of::<HTLCForwardInfo>()));
5467 for _ in 0..pending_forwards_count {
5468 pending_forwards.push(Readable::read(reader)?);
5470 forward_htlcs.insert(short_channel_id, pending_forwards);
5473 let claimable_htlcs_count: u64 = Readable::read(reader)?;
5474 let mut claimable_htlcs = HashMap::with_capacity(cmp::min(claimable_htlcs_count as usize, 128));
5475 for _ in 0..claimable_htlcs_count {
5476 let payment_hash = Readable::read(reader)?;
5477 let previous_hops_len: u64 = Readable::read(reader)?;
5478 let mut previous_hops = Vec::with_capacity(cmp::min(previous_hops_len as usize, MAX_ALLOC_SIZE/mem::size_of::<ClaimableHTLC>()));
5479 for _ in 0..previous_hops_len {
5480 previous_hops.push(Readable::read(reader)?);
5482 claimable_htlcs.insert(payment_hash, previous_hops);
5485 let peer_count: u64 = Readable::read(reader)?;
5486 let mut per_peer_state = HashMap::with_capacity(cmp::min(peer_count as usize, MAX_ALLOC_SIZE/mem::size_of::<(PublicKey, Mutex<PeerState>)>()));
5487 for _ in 0..peer_count {
5488 let peer_pubkey = Readable::read(reader)?;
5489 let peer_state = PeerState {
5490 latest_features: Readable::read(reader)?,
5492 per_peer_state.insert(peer_pubkey, Mutex::new(peer_state));
5495 let event_count: u64 = Readable::read(reader)?;
5496 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>()));
5497 for _ in 0..event_count {
5498 match MaybeReadable::read(reader)? {
5499 Some(event) => pending_events_read.push(event),
5504 let background_event_count: u64 = Readable::read(reader)?;
5505 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>()));
5506 for _ in 0..background_event_count {
5507 match <u8 as Readable>::read(reader)? {
5508 0 => pending_background_events_read.push(BackgroundEvent::ClosingMonitorUpdate((Readable::read(reader)?, Readable::read(reader)?))),
5509 _ => return Err(DecodeError::InvalidValue),
5513 let last_node_announcement_serial: u32 = Readable::read(reader)?;
5514 let highest_seen_timestamp: u32 = Readable::read(reader)?;
5516 let pending_inbound_payment_count: u64 = Readable::read(reader)?;
5517 let mut pending_inbound_payments: HashMap<PaymentHash, PendingInboundPayment> = HashMap::with_capacity(cmp::min(pending_inbound_payment_count as usize, MAX_ALLOC_SIZE/(3*32)));
5518 for _ in 0..pending_inbound_payment_count {
5519 if pending_inbound_payments.insert(Readable::read(reader)?, Readable::read(reader)?).is_some() {
5520 return Err(DecodeError::InvalidValue);
5524 let pending_outbound_payments_count_compat: u64 = Readable::read(reader)?;
5525 let mut pending_outbound_payments_compat: HashMap<PaymentId, HashSet<[u8; 32]>> =
5526 HashMap::with_capacity(cmp::min(pending_outbound_payments_count_compat as usize, MAX_ALLOC_SIZE/32));
5527 for _ in 0..pending_outbound_payments_count_compat {
5528 let session_priv = Readable::read(reader)?;
5529 if pending_outbound_payments_compat.insert(PaymentId(session_priv), [session_priv].iter().cloned().collect()).is_some() {
5530 return Err(DecodeError::InvalidValue)
5534 let mut pending_outbound_payments = None;
5535 read_tlv_fields!(reader, {
5536 (1, pending_outbound_payments, option),
5538 if pending_outbound_payments.is_none() {
5539 pending_outbound_payments = Some(pending_outbound_payments_compat);
5542 let mut secp_ctx = Secp256k1::new();
5543 secp_ctx.seeded_randomize(&args.keys_manager.get_secure_random_bytes());
5545 if !channel_closures.is_empty() {
5546 pending_events_read.append(&mut channel_closures);
5549 let channel_manager = ChannelManager {
5551 fee_estimator: args.fee_estimator,
5552 chain_monitor: args.chain_monitor,
5553 tx_broadcaster: args.tx_broadcaster,
5555 best_block: RwLock::new(BestBlock::new(best_block_hash, best_block_height)),
5557 channel_state: Mutex::new(ChannelHolder {
5562 pending_msg_events: Vec::new(),
5564 pending_inbound_payments: Mutex::new(pending_inbound_payments),
5565 pending_outbound_payments: Mutex::new(pending_outbound_payments.unwrap()),
5567 our_network_key: args.keys_manager.get_node_secret(),
5568 our_network_pubkey: PublicKey::from_secret_key(&secp_ctx, &args.keys_manager.get_node_secret()),
5571 last_node_announcement_serial: AtomicUsize::new(last_node_announcement_serial as usize),
5572 highest_seen_timestamp: AtomicUsize::new(highest_seen_timestamp as usize),
5574 per_peer_state: RwLock::new(per_peer_state),
5576 pending_events: Mutex::new(pending_events_read),
5577 pending_background_events: Mutex::new(pending_background_events_read),
5578 total_consistency_lock: RwLock::new(()),
5579 persistence_notifier: PersistenceNotifier::new(),
5581 keys_manager: args.keys_manager,
5582 logger: args.logger,
5583 default_configuration: args.default_config,
5586 for htlc_source in failed_htlcs.drain(..) {
5587 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() });
5590 //TODO: Broadcast channel update for closed channels, but only after we've made a
5591 //connection or two.
5593 Ok((best_block_hash.clone(), channel_manager))
5599 use bitcoin::hashes::Hash;
5600 use bitcoin::hashes::sha256::Hash as Sha256;
5601 use core::time::Duration;
5602 use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
5603 use ln::channelmanager::{PaymentId, PaymentSendFailure};
5604 use ln::features::{InitFeatures, InvoiceFeatures};
5605 use ln::functional_test_utils::*;
5607 use ln::msgs::ChannelMessageHandler;
5608 use routing::router::{get_keysend_route, get_route};
5609 use util::errors::APIError;
5610 use util::events::{Event, MessageSendEvent, MessageSendEventsProvider};
5611 use util::test_utils;
5613 #[cfg(feature = "std")]
5615 fn test_wait_timeout() {
5616 use ln::channelmanager::PersistenceNotifier;
5618 use core::sync::atomic::{AtomicBool, Ordering};
5621 let persistence_notifier = Arc::new(PersistenceNotifier::new());
5622 let thread_notifier = Arc::clone(&persistence_notifier);
5624 let exit_thread = Arc::new(AtomicBool::new(false));
5625 let exit_thread_clone = exit_thread.clone();
5626 thread::spawn(move || {
5628 let &(ref persist_mtx, ref cnd) = &thread_notifier.persistence_lock;
5629 let mut persistence_lock = persist_mtx.lock().unwrap();
5630 *persistence_lock = true;
5633 if exit_thread_clone.load(Ordering::SeqCst) {
5639 // Check that we can block indefinitely until updates are available.
5640 let _ = persistence_notifier.wait();
5642 // Check that the PersistenceNotifier will return after the given duration if updates are
5645 if persistence_notifier.wait_timeout(Duration::from_millis(100)) {
5650 exit_thread.store(true, Ordering::SeqCst);
5652 // Check that the PersistenceNotifier will return after the given duration even if no updates
5655 if !persistence_notifier.wait_timeout(Duration::from_millis(100)) {
5662 fn test_notify_limits() {
5663 // Check that a few cases which don't require the persistence of a new ChannelManager,
5664 // indeed, do not cause the persistence of a new ChannelManager.
5665 let chanmon_cfgs = create_chanmon_cfgs(3);
5666 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5667 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5668 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5670 // All nodes start with a persistable update pending as `create_network` connects each node
5671 // with all other nodes to make most tests simpler.
5672 assert!(nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
5673 assert!(nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
5674 assert!(nodes[2].node.await_persistable_update_timeout(Duration::from_millis(1)));
5676 let mut chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5678 // We check that the channel info nodes have doesn't change too early, even though we try
5679 // to connect messages with new values
5680 chan.0.contents.fee_base_msat *= 2;
5681 chan.1.contents.fee_base_msat *= 2;
5682 let node_a_chan_info = nodes[0].node.list_channels()[0].clone();
5683 let node_b_chan_info = nodes[1].node.list_channels()[0].clone();
5685 // The first two nodes (which opened a channel) should now require fresh persistence
5686 assert!(nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
5687 assert!(nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
5688 // ... but the last node should not.
5689 assert!(!nodes[2].node.await_persistable_update_timeout(Duration::from_millis(1)));
5690 // After persisting the first two nodes they should no longer need fresh persistence.
5691 assert!(!nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
5692 assert!(!nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
5694 // Node 3, unrelated to the only channel, shouldn't care if it receives a channel_update
5695 // about the channel.
5696 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.0);
5697 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.1);
5698 assert!(!nodes[2].node.await_persistable_update_timeout(Duration::from_millis(1)));
5700 // The nodes which are a party to the channel should also ignore messages from unrelated
5702 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
5703 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
5704 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
5705 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
5706 assert!(!nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
5707 assert!(!nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
5709 // At this point the channel info given by peers should still be the same.
5710 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
5711 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
5713 // An earlier version of handle_channel_update didn't check the directionality of the
5714 // update message and would always update the local fee info, even if our peer was
5715 // (spuriously) forwarding us our own channel_update.
5716 let as_node_one = nodes[0].node.get_our_node_id().serialize()[..] < nodes[1].node.get_our_node_id().serialize()[..];
5717 let as_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.0 } else { &chan.1 };
5718 let bs_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.1 } else { &chan.0 };
5720 // First deliver each peers' own message, checking that the node doesn't need to be
5721 // persisted and that its channel info remains the same.
5722 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &as_update);
5723 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &bs_update);
5724 assert!(!nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
5725 assert!(!nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
5726 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
5727 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
5729 // Finally, deliver the other peers' message, ensuring each node needs to be persisted and
5730 // the channel info has updated.
5731 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &bs_update);
5732 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &as_update);
5733 assert!(nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
5734 assert!(nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
5735 assert_ne!(nodes[0].node.list_channels()[0], node_a_chan_info);
5736 assert_ne!(nodes[1].node.list_channels()[0], node_b_chan_info);
5740 fn test_keysend_dup_hash_partial_mpp() {
5741 // Test that a keysend payment with a duplicate hash to an existing partial MPP payment fails as
5743 let chanmon_cfgs = create_chanmon_cfgs(2);
5744 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5745 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5746 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5747 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5748 let logger = test_utils::TestLogger::new();
5750 // First, send a partial MPP payment.
5751 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5752 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[1].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100_000, TEST_FINAL_CLTV, &logger).unwrap();
5753 let (payment_preimage, our_payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[1]);
5754 let payment_id = PaymentId([42; 32]);
5755 // Use the utility function send_payment_along_path to send the payment with MPP data which
5756 // indicates there are more HTLCs coming.
5757 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.
5758 nodes[0].node.send_payment_along_path(&route.paths[0], &our_payment_hash, &Some(payment_secret), 200_000, cur_height, payment_id, &None).unwrap();
5759 check_added_monitors!(nodes[0], 1);
5760 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5761 assert_eq!(events.len(), 1);
5762 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false, None);
5764 // Next, send a keysend payment with the same payment_hash and make sure it fails.
5765 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage)).unwrap();
5766 check_added_monitors!(nodes[0], 1);
5767 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5768 assert_eq!(events.len(), 1);
5769 let ev = events.drain(..).next().unwrap();
5770 let payment_event = SendEvent::from_event(ev);
5771 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
5772 check_added_monitors!(nodes[1], 0);
5773 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
5774 expect_pending_htlcs_forwardable!(nodes[1]);
5775 expect_pending_htlcs_forwardable!(nodes[1]);
5776 check_added_monitors!(nodes[1], 1);
5777 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5778 assert!(updates.update_add_htlcs.is_empty());
5779 assert!(updates.update_fulfill_htlcs.is_empty());
5780 assert_eq!(updates.update_fail_htlcs.len(), 1);
5781 assert!(updates.update_fail_malformed_htlcs.is_empty());
5782 assert!(updates.update_fee.is_none());
5783 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5784 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
5785 expect_payment_failed!(nodes[0], our_payment_hash, true);
5787 // Send the second half of the original MPP payment.
5788 nodes[0].node.send_payment_along_path(&route.paths[0], &our_payment_hash, &Some(payment_secret), 200_000, cur_height, payment_id, &None).unwrap();
5789 check_added_monitors!(nodes[0], 1);
5790 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5791 assert_eq!(events.len(), 1);
5792 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), true, None);
5794 // Claim the full MPP payment. Note that we can't use a test utility like
5795 // claim_funds_along_route because the ordering of the messages causes the second half of the
5796 // payment to be put in the holding cell, which confuses the test utilities. So we exchange the
5797 // lightning messages manually.
5798 assert!(nodes[1].node.claim_funds(payment_preimage));
5799 check_added_monitors!(nodes[1], 2);
5800 let bs_first_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5801 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_first_updates.update_fulfill_htlcs[0]);
5802 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_first_updates.commitment_signed);
5803 check_added_monitors!(nodes[0], 1);
5804 let (as_first_raa, as_first_cs) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5805 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_first_raa);
5806 check_added_monitors!(nodes[1], 1);
5807 let bs_second_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5808 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_first_cs);
5809 check_added_monitors!(nodes[1], 1);
5810 let bs_first_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
5811 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_second_updates.update_fulfill_htlcs[0]);
5812 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_updates.commitment_signed);
5813 check_added_monitors!(nodes[0], 1);
5814 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
5815 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
5816 let as_second_updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5817 check_added_monitors!(nodes[0], 1);
5818 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
5819 check_added_monitors!(nodes[1], 1);
5820 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_updates.commitment_signed);
5821 check_added_monitors!(nodes[1], 1);
5822 let bs_third_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
5823 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_third_raa);
5824 check_added_monitors!(nodes[0], 1);
5826 // Note that successful MPP payments will generate 1 event upon the first path's success. No
5827 // further events will be generated for subsequence path successes.
5828 let events = nodes[0].node.get_and_clear_pending_events();
5830 Event::PaymentSent { payment_preimage: ref preimage } => {
5831 assert_eq!(payment_preimage, *preimage);
5833 _ => panic!("Unexpected event"),
5838 fn test_keysend_dup_payment_hash() {
5839 // (1): Test that a keysend payment with a duplicate payment hash to an existing pending
5840 // outbound regular payment fails as expected.
5841 // (2): Test that a regular payment with a duplicate payment hash to an existing keysend payment
5842 // fails as expected.
5843 let chanmon_cfgs = create_chanmon_cfgs(2);
5844 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5845 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5846 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5847 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5848 let logger = test_utils::TestLogger::new();
5850 // To start (1), send a regular payment but don't claim it.
5851 let expected_route = [&nodes[1]];
5852 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &expected_route, 100_000);
5854 // Next, attempt a keysend payment and make sure it fails.
5855 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100_000, TEST_FINAL_CLTV, &logger).unwrap();
5856 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage)).unwrap();
5857 check_added_monitors!(nodes[0], 1);
5858 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5859 assert_eq!(events.len(), 1);
5860 let ev = events.drain(..).next().unwrap();
5861 let payment_event = SendEvent::from_event(ev);
5862 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
5863 check_added_monitors!(nodes[1], 0);
5864 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
5865 expect_pending_htlcs_forwardable!(nodes[1]);
5866 expect_pending_htlcs_forwardable!(nodes[1]);
5867 check_added_monitors!(nodes[1], 1);
5868 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5869 assert!(updates.update_add_htlcs.is_empty());
5870 assert!(updates.update_fulfill_htlcs.is_empty());
5871 assert_eq!(updates.update_fail_htlcs.len(), 1);
5872 assert!(updates.update_fail_malformed_htlcs.is_empty());
5873 assert!(updates.update_fee.is_none());
5874 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5875 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
5876 expect_payment_failed!(nodes[0], payment_hash, true);
5878 // Finally, claim the original payment.
5879 claim_payment(&nodes[0], &expected_route, payment_preimage);
5881 // To start (2), send a keysend payment but don't claim it.
5882 let payment_preimage = PaymentPreimage([42; 32]);
5883 let route = get_route(&nodes[0].node.get_our_node_id(), &nodes[0].net_graph_msg_handler.network_graph, &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), 100_000, TEST_FINAL_CLTV, &logger).unwrap();
5884 let (payment_hash, _) = nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage)).unwrap();
5885 check_added_monitors!(nodes[0], 1);
5886 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5887 assert_eq!(events.len(), 1);
5888 let event = events.pop().unwrap();
5889 let path = vec![&nodes[1]];
5890 pass_along_path(&nodes[0], &path, 100_000, payment_hash, None, event, true, Some(payment_preimage));
5892 // Next, attempt a regular payment and make sure it fails.
5893 let payment_secret = PaymentSecret([43; 32]);
5894 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
5895 check_added_monitors!(nodes[0], 1);
5896 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5897 assert_eq!(events.len(), 1);
5898 let ev = events.drain(..).next().unwrap();
5899 let payment_event = SendEvent::from_event(ev);
5900 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
5901 check_added_monitors!(nodes[1], 0);
5902 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
5903 expect_pending_htlcs_forwardable!(nodes[1]);
5904 expect_pending_htlcs_forwardable!(nodes[1]);
5905 check_added_monitors!(nodes[1], 1);
5906 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5907 assert!(updates.update_add_htlcs.is_empty());
5908 assert!(updates.update_fulfill_htlcs.is_empty());
5909 assert_eq!(updates.update_fail_htlcs.len(), 1);
5910 assert!(updates.update_fail_malformed_htlcs.is_empty());
5911 assert!(updates.update_fee.is_none());
5912 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5913 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
5914 expect_payment_failed!(nodes[0], payment_hash, true);
5916 // Finally, succeed the keysend payment.
5917 claim_payment(&nodes[0], &expected_route, payment_preimage);
5921 fn test_keysend_hash_mismatch() {
5922 // Test that if we receive a keysend `update_add_htlc` msg, we fail as expected if the keysend
5923 // preimage doesn't match the msg's payment hash.
5924 let chanmon_cfgs = create_chanmon_cfgs(2);
5925 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5926 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5927 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5929 let payer_pubkey = nodes[0].node.get_our_node_id();
5930 let payee_pubkey = nodes[1].node.get_our_node_id();
5931 nodes[0].node.peer_connected(&payee_pubkey, &msgs::Init { features: InitFeatures::known() });
5932 nodes[1].node.peer_connected(&payer_pubkey, &msgs::Init { features: InitFeatures::known() });
5934 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
5935 let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
5936 let first_hops = nodes[0].node.list_usable_channels();
5937 let route = get_keysend_route(&payer_pubkey, network_graph, &payee_pubkey,
5938 Some(&first_hops.iter().collect::<Vec<_>>()), &vec![], 10000, 40,
5939 nodes[0].logger).unwrap();
5941 let test_preimage = PaymentPreimage([42; 32]);
5942 let mismatch_payment_hash = PaymentHash([43; 32]);
5943 let _ = nodes[0].node.send_payment_internal(&route, mismatch_payment_hash, &None, Some(test_preimage), None, None).unwrap();
5944 check_added_monitors!(nodes[0], 1);
5946 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5947 assert_eq!(updates.update_add_htlcs.len(), 1);
5948 assert!(updates.update_fulfill_htlcs.is_empty());
5949 assert!(updates.update_fail_htlcs.is_empty());
5950 assert!(updates.update_fail_malformed_htlcs.is_empty());
5951 assert!(updates.update_fee.is_none());
5952 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5954 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Payment preimage didn't match payment hash".to_string(), 1);
5958 fn test_keysend_msg_with_secret_err() {
5959 // Test that we error as expected if we receive a keysend payment that includes a payment secret.
5960 let chanmon_cfgs = create_chanmon_cfgs(2);
5961 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5962 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5963 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5965 let payer_pubkey = nodes[0].node.get_our_node_id();
5966 let payee_pubkey = nodes[1].node.get_our_node_id();
5967 nodes[0].node.peer_connected(&payee_pubkey, &msgs::Init { features: InitFeatures::known() });
5968 nodes[1].node.peer_connected(&payer_pubkey, &msgs::Init { features: InitFeatures::known() });
5970 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
5971 let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
5972 let first_hops = nodes[0].node.list_usable_channels();
5973 let route = get_keysend_route(&payer_pubkey, network_graph, &payee_pubkey,
5974 Some(&first_hops.iter().collect::<Vec<_>>()), &vec![], 10000, 40,
5975 nodes[0].logger).unwrap();
5977 let test_preimage = PaymentPreimage([42; 32]);
5978 let test_secret = PaymentSecret([43; 32]);
5979 let payment_hash = PaymentHash(Sha256::hash(&test_preimage.0).into_inner());
5980 let _ = nodes[0].node.send_payment_internal(&route, payment_hash, &Some(test_secret), Some(test_preimage), None, None).unwrap();
5981 check_added_monitors!(nodes[0], 1);
5983 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5984 assert_eq!(updates.update_add_htlcs.len(), 1);
5985 assert!(updates.update_fulfill_htlcs.is_empty());
5986 assert!(updates.update_fail_htlcs.is_empty());
5987 assert!(updates.update_fail_malformed_htlcs.is_empty());
5988 assert!(updates.update_fee.is_none());
5989 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5991 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "We don't support MPP keysend payments".to_string(), 1);
5995 fn test_multi_hop_missing_secret() {
5996 let chanmon_cfgs = create_chanmon_cfgs(4);
5997 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
5998 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
5999 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
6001 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
6002 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
6003 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
6004 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
6005 let logger = test_utils::TestLogger::new();
6007 // Marshall an MPP route.
6008 let (_, payment_hash, _) = get_payment_preimage_hash!(&nodes[3]);
6009 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6010 let mut route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph, &nodes[3].node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6011 let path = route.paths[0].clone();
6012 route.paths.push(path);
6013 route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
6014 route.paths[0][0].short_channel_id = chan_1_id;
6015 route.paths[0][1].short_channel_id = chan_3_id;
6016 route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
6017 route.paths[1][0].short_channel_id = chan_2_id;
6018 route.paths[1][1].short_channel_id = chan_4_id;
6020 match nodes[0].node.send_payment(&route, payment_hash, &None).unwrap_err() {
6021 PaymentSendFailure::ParameterError(APIError::APIMisuseError { ref err }) => {
6022 assert!(regex::Regex::new(r"Payment secret is required for multi-path payments").unwrap().is_match(err)) },
6023 _ => panic!("unexpected error")
6028 #[cfg(all(any(test, feature = "_test_utils"), feature = "unstable"))]
6031 use chain::chainmonitor::ChainMonitor;
6032 use chain::channelmonitor::Persist;
6033 use chain::keysinterface::{KeysManager, InMemorySigner};
6034 use ln::channelmanager::{BestBlock, ChainParameters, ChannelManager, PaymentHash, PaymentPreimage};
6035 use ln::features::{InitFeatures, InvoiceFeatures};
6036 use ln::functional_test_utils::*;
6037 use ln::msgs::{ChannelMessageHandler, Init};
6038 use routing::network_graph::NetworkGraph;
6039 use routing::router::get_route;
6040 use util::test_utils;
6041 use util::config::UserConfig;
6042 use util::events::{Event, MessageSendEvent, MessageSendEventsProvider, PaymentPurpose};
6044 use bitcoin::hashes::Hash;
6045 use bitcoin::hashes::sha256::Hash as Sha256;
6046 use bitcoin::{Block, BlockHeader, Transaction, TxOut};
6048 use sync::{Arc, Mutex};
6052 struct NodeHolder<'a, P: Persist<InMemorySigner>> {
6053 node: &'a ChannelManager<InMemorySigner,
6054 &'a ChainMonitor<InMemorySigner, &'a test_utils::TestChainSource,
6055 &'a test_utils::TestBroadcaster, &'a test_utils::TestFeeEstimator,
6056 &'a test_utils::TestLogger, &'a P>,
6057 &'a test_utils::TestBroadcaster, &'a KeysManager,
6058 &'a test_utils::TestFeeEstimator, &'a test_utils::TestLogger>
6063 fn bench_sends(bench: &mut Bencher) {
6064 bench_two_sends(bench, test_utils::TestPersister::new(), test_utils::TestPersister::new());
6067 pub fn bench_two_sends<P: Persist<InMemorySigner>>(bench: &mut Bencher, persister_a: P, persister_b: P) {
6068 // Do a simple benchmark of sending a payment back and forth between two nodes.
6069 // Note that this is unrealistic as each payment send will require at least two fsync
6071 let network = bitcoin::Network::Testnet;
6072 let genesis_hash = bitcoin::blockdata::constants::genesis_block(network).header.block_hash();
6074 let tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), blocks: Arc::new(Mutex::new(Vec::new()))};
6075 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
6077 let mut config: UserConfig = Default::default();
6078 config.own_channel_config.minimum_depth = 1;
6080 let logger_a = test_utils::TestLogger::with_id("node a".to_owned());
6081 let chain_monitor_a = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_a);
6082 let seed_a = [1u8; 32];
6083 let keys_manager_a = KeysManager::new(&seed_a, 42, 42);
6084 let node_a = ChannelManager::new(&fee_estimator, &chain_monitor_a, &tx_broadcaster, &logger_a, &keys_manager_a, config.clone(), ChainParameters {
6086 best_block: BestBlock::from_genesis(network),
6088 let node_a_holder = NodeHolder { node: &node_a };
6090 let logger_b = test_utils::TestLogger::with_id("node a".to_owned());
6091 let chain_monitor_b = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_b);
6092 let seed_b = [2u8; 32];
6093 let keys_manager_b = KeysManager::new(&seed_b, 42, 42);
6094 let node_b = ChannelManager::new(&fee_estimator, &chain_monitor_b, &tx_broadcaster, &logger_b, &keys_manager_b, config.clone(), ChainParameters {
6096 best_block: BestBlock::from_genesis(network),
6098 let node_b_holder = NodeHolder { node: &node_b };
6100 node_a.peer_connected(&node_b.get_our_node_id(), &Init { features: InitFeatures::known() });
6101 node_b.peer_connected(&node_a.get_our_node_id(), &Init { features: InitFeatures::known() });
6102 node_a.create_channel(node_b.get_our_node_id(), 8_000_000, 100_000_000, 42, None).unwrap();
6103 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()));
6104 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()));
6107 if let Event::FundingGenerationReady { temporary_channel_id, output_script, .. } = get_event!(node_a_holder, Event::FundingGenerationReady) {
6108 tx = Transaction { version: 2, lock_time: 0, input: Vec::new(), output: vec![TxOut {
6109 value: 8_000_000, script_pubkey: output_script,
6111 node_a.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
6112 } else { panic!(); }
6114 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()));
6115 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()));
6117 assert_eq!(&tx_broadcaster.txn_broadcasted.lock().unwrap()[..], &[tx.clone()]);
6120 header: BlockHeader { version: 0x20000000, prev_blockhash: genesis_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
6123 Listen::block_connected(&node_a, &block, 1);
6124 Listen::block_connected(&node_b, &block, 1);
6126 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()));
6127 let msg_events = node_a.get_and_clear_pending_msg_events();
6128 assert_eq!(msg_events.len(), 2);
6129 match msg_events[0] {
6130 MessageSendEvent::SendFundingLocked { ref msg, .. } => {
6131 node_b.handle_funding_locked(&node_a.get_our_node_id(), msg);
6132 get_event_msg!(node_b_holder, MessageSendEvent::SendChannelUpdate, node_a.get_our_node_id());
6136 match msg_events[1] {
6137 MessageSendEvent::SendChannelUpdate { .. } => {},
6141 let dummy_graph = NetworkGraph::new(genesis_hash);
6143 let mut payment_count: u64 = 0;
6144 macro_rules! send_payment {
6145 ($node_a: expr, $node_b: expr) => {
6146 let usable_channels = $node_a.list_usable_channels();
6147 let route = get_route(&$node_a.get_our_node_id(), &dummy_graph, &$node_b.get_our_node_id(), Some(InvoiceFeatures::known()),
6148 Some(&usable_channels.iter().map(|r| r).collect::<Vec<_>>()), &[], 10_000, TEST_FINAL_CLTV, &logger_a).unwrap();
6150 let mut payment_preimage = PaymentPreimage([0; 32]);
6151 payment_preimage.0[0..8].copy_from_slice(&payment_count.to_le_bytes());
6153 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
6154 let payment_secret = $node_b.create_inbound_payment_for_hash(payment_hash, None, 7200, 0).unwrap();
6156 $node_a.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
6157 let payment_event = SendEvent::from_event($node_a.get_and_clear_pending_msg_events().pop().unwrap());
6158 $node_b.handle_update_add_htlc(&$node_a.get_our_node_id(), &payment_event.msgs[0]);
6159 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &payment_event.commitment_msg);
6160 let (raa, cs) = get_revoke_commit_msgs!(NodeHolder { node: &$node_b }, $node_a.get_our_node_id());
6161 $node_a.handle_revoke_and_ack(&$node_b.get_our_node_id(), &raa);
6162 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &cs);
6163 $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()));
6165 expect_pending_htlcs_forwardable!(NodeHolder { node: &$node_b });
6166 expect_payment_received!(NodeHolder { node: &$node_b }, payment_hash, payment_secret, 10_000);
6167 assert!($node_b.claim_funds(payment_preimage));
6169 match $node_b.get_and_clear_pending_msg_events().pop().unwrap() {
6170 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
6171 assert_eq!(node_id, $node_a.get_our_node_id());
6172 $node_a.handle_update_fulfill_htlc(&$node_b.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
6173 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &updates.commitment_signed);
6175 _ => panic!("Failed to generate claim event"),
6178 let (raa, cs) = get_revoke_commit_msgs!(NodeHolder { node: &$node_a }, $node_b.get_our_node_id());
6179 $node_b.handle_revoke_and_ack(&$node_a.get_our_node_id(), &raa);
6180 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &cs);
6181 $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()));
6183 expect_payment_sent!(NodeHolder { node: &$node_a }, payment_preimage);
6188 send_payment!(node_a, node_b);
6189 send_payment!(node_b, node_a);