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};
56 use util::{byte_utils, events};
57 use util::ser::{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 correlate an MPP payment's per-path HTLC sources internally.
176 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
177 pub(crate) struct MppId(pub [u8; 32]);
179 impl Writeable for MppId {
180 fn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
185 impl Readable for MppId {
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,
206 pub fn dummy() -> Self {
207 HTLCSource::OutboundRoute {
209 session_priv: SecretKey::from_slice(&[1; 32]).unwrap(),
210 first_hop_htlc_msat: 0,
211 mpp_id: MppId([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 shutdown_finish: Option<(ShutdownResult, Option<msgs::ChannelUpdate>)>,
247 impl MsgHandleErrInternal {
249 fn send_err_msg_no_close(err: String, channel_id: [u8; 32]) -> Self {
251 err: LightningError {
253 action: msgs::ErrorAction::SendErrorMessage {
254 msg: msgs::ErrorMessage {
260 shutdown_finish: None,
264 fn ignore_no_close(err: String) -> Self {
266 err: LightningError {
268 action: msgs::ErrorAction::IgnoreError,
270 shutdown_finish: None,
274 fn from_no_close(err: msgs::LightningError) -> Self {
275 Self { err, shutdown_finish: None }
278 fn from_finish_shutdown(err: String, channel_id: [u8; 32], shutdown_res: ShutdownResult, channel_update: Option<msgs::ChannelUpdate>) -> Self {
280 err: LightningError {
282 action: msgs::ErrorAction::SendErrorMessage {
283 msg: msgs::ErrorMessage {
289 shutdown_finish: Some((shutdown_res, channel_update)),
293 fn from_chan_no_close(err: ChannelError, channel_id: [u8; 32]) -> Self {
296 ChannelError::Warn(msg) => LightningError {
298 action: msgs::ErrorAction::IgnoreError,
300 ChannelError::Ignore(msg) => LightningError {
302 action: msgs::ErrorAction::IgnoreError,
304 ChannelError::Close(msg) => LightningError {
306 action: msgs::ErrorAction::SendErrorMessage {
307 msg: msgs::ErrorMessage {
313 ChannelError::CloseDelayBroadcast(msg) => LightningError {
315 action: msgs::ErrorAction::SendErrorMessage {
316 msg: msgs::ErrorMessage {
323 shutdown_finish: None,
328 /// We hold back HTLCs we intend to relay for a random interval greater than this (see
329 /// Event::PendingHTLCsForwardable for the API guidelines indicating how long should be waited).
330 /// This provides some limited amount of privacy. Ideally this would range from somewhere like one
331 /// second to 30 seconds, but people expect lightning to be, you know, kinda fast, sadly.
332 const MIN_HTLC_RELAY_HOLDING_CELL_MILLIS: u64 = 100;
334 /// For events which result in both a RevokeAndACK and a CommitmentUpdate, by default they should
335 /// be sent in the order they appear in the return value, however sometimes the order needs to be
336 /// variable at runtime (eg Channel::channel_reestablish needs to re-send messages in the order
337 /// they were originally sent). In those cases, this enum is also returned.
338 #[derive(Clone, PartialEq)]
339 pub(super) enum RAACommitmentOrder {
340 /// Send the CommitmentUpdate messages first
342 /// Send the RevokeAndACK message first
346 // Note this is only exposed in cfg(test):
347 pub(super) struct ChannelHolder<Signer: Sign> {
348 pub(super) by_id: HashMap<[u8; 32], Channel<Signer>>,
349 pub(super) short_to_id: HashMap<u64, [u8; 32]>,
350 /// short channel id -> forward infos. Key of 0 means payments received
351 /// Note that while this is held in the same mutex as the channels themselves, no consistency
352 /// guarantees are made about the existence of a channel with the short id here, nor the short
353 /// ids in the PendingHTLCInfo!
354 pub(super) forward_htlcs: HashMap<u64, Vec<HTLCForwardInfo>>,
355 /// Map from payment hash to any HTLCs which are to us and can be failed/claimed by the user.
356 /// Note that while this is held in the same mutex as the channels themselves, no consistency
357 /// guarantees are made about the channels given here actually existing anymore by the time you
359 claimable_htlcs: HashMap<PaymentHash, Vec<ClaimableHTLC>>,
360 /// Messages to send to peers - pushed to in the same lock that they are generated in (except
361 /// for broadcast messages, where ordering isn't as strict).
362 pub(super) pending_msg_events: Vec<MessageSendEvent>,
365 /// Events which we process internally but cannot be procsesed immediately at the generation site
366 /// for some reason. They are handled in timer_tick_occurred, so may be processed with
367 /// quite some time lag.
368 enum BackgroundEvent {
369 /// Handle a ChannelMonitorUpdate that closes a channel, broadcasting its current latest holder
370 /// commitment transaction.
371 ClosingMonitorUpdate((OutPoint, ChannelMonitorUpdate)),
374 /// State we hold per-peer. In the future we should put channels in here, but for now we only hold
375 /// the latest Init features we heard from the peer.
377 latest_features: InitFeatures,
380 /// Stores a PaymentSecret and any other data we may need to validate an inbound payment is
381 /// actually ours and not some duplicate HTLC sent to us by a node along the route.
383 /// For users who don't want to bother doing their own payment preimage storage, we also store that
385 struct PendingInboundPayment {
386 /// The payment secret that the sender must use for us to accept this payment
387 payment_secret: PaymentSecret,
388 /// Time at which this HTLC expires - blocks with a header time above this value will result in
389 /// this payment being removed.
391 /// Arbitrary identifier the user specifies (or not)
392 user_payment_id: u64,
393 // Other required attributes of the payment, optionally enforced:
394 payment_preimage: Option<PaymentPreimage>,
395 min_value_msat: Option<u64>,
398 /// SimpleArcChannelManager is useful when you need a ChannelManager with a static lifetime, e.g.
399 /// when you're using lightning-net-tokio (since tokio::spawn requires parameters with static
400 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
401 /// SimpleRefChannelManager is the more appropriate type. Defining these type aliases prevents
402 /// issues such as overly long function definitions. Note that the ChannelManager can take any
403 /// type that implements KeysInterface for its keys manager, but this type alias chooses the
404 /// concrete type of the KeysManager.
405 pub type SimpleArcChannelManager<M, T, F, L> = ChannelManager<InMemorySigner, Arc<M>, Arc<T>, Arc<KeysManager>, Arc<F>, Arc<L>>;
407 /// SimpleRefChannelManager is a type alias for a ChannelManager reference, and is the reference
408 /// counterpart to the SimpleArcChannelManager type alias. Use this type by default when you don't
409 /// need a ChannelManager with a static lifetime. You'll need a static lifetime in cases such as
410 /// usage of lightning-net-tokio (since tokio::spawn requires parameters with static lifetimes).
411 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
412 /// helps with issues such as long function definitions. Note that the ChannelManager can take any
413 /// type that implements KeysInterface for its keys manager, but this type alias chooses the
414 /// concrete type of the KeysManager.
415 pub type SimpleRefChannelManager<'a, 'b, 'c, 'd, 'e, M, T, F, L> = ChannelManager<InMemorySigner, &'a M, &'b T, &'c KeysManager, &'d F, &'e L>;
417 /// Manager which keeps track of a number of channels and sends messages to the appropriate
418 /// channel, also tracking HTLC preimages and forwarding onion packets appropriately.
420 /// Implements ChannelMessageHandler, handling the multi-channel parts and passing things through
421 /// to individual Channels.
423 /// Implements Writeable to write out all channel state to disk. Implies peer_disconnected() for
424 /// all peers during write/read (though does not modify this instance, only the instance being
425 /// serialized). This will result in any channels which have not yet exchanged funding_created (ie
426 /// called funding_transaction_generated for outbound channels).
428 /// Note that you can be a bit lazier about writing out ChannelManager than you can be with
429 /// ChannelMonitors. With ChannelMonitors you MUST write each monitor update out to disk before
430 /// returning from chain::Watch::watch_/update_channel, with ChannelManagers, writing updates
431 /// happens out-of-band (and will prevent any other ChannelManager operations from occurring during
432 /// the serialization process). If the deserialized version is out-of-date compared to the
433 /// ChannelMonitors passed by reference to read(), those channels will be force-closed based on the
434 /// ChannelMonitor state and no funds will be lost (mod on-chain transaction fees).
436 /// Note that the deserializer is only implemented for (BlockHash, ChannelManager), which
437 /// tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
438 /// the "reorg path" (ie call block_disconnected() until you get to a common block and then call
439 /// block_connected() to step towards your best block) upon deserialization before using the
442 /// Note that ChannelManager is responsible for tracking liveness of its channels and generating
443 /// ChannelUpdate messages informing peers that the channel is temporarily disabled. To avoid
444 /// spam due to quick disconnection/reconnection, updates are not sent until the channel has been
445 /// offline for a full minute. In order to track this, you must call
446 /// timer_tick_occurred roughly once per minute, though it doesn't have to be perfect.
448 /// Rather than using a plain ChannelManager, it is preferable to use either a SimpleArcChannelManager
449 /// a SimpleRefChannelManager, for conciseness. See their documentation for more details, but
450 /// essentially you should default to using a SimpleRefChannelManager, and use a
451 /// SimpleArcChannelManager when you require a ChannelManager with a static lifetime, such as when
452 /// you're using lightning-net-tokio.
453 pub struct ChannelManager<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
454 where M::Target: chain::Watch<Signer>,
455 T::Target: BroadcasterInterface,
456 K::Target: KeysInterface<Signer = Signer>,
457 F::Target: FeeEstimator,
460 default_configuration: UserConfig,
461 genesis_hash: BlockHash,
467 pub(super) best_block: RwLock<BestBlock>,
469 best_block: RwLock<BestBlock>,
470 secp_ctx: Secp256k1<secp256k1::All>,
472 #[cfg(any(test, feature = "_test_utils"))]
473 pub(super) channel_state: Mutex<ChannelHolder<Signer>>,
474 #[cfg(not(any(test, feature = "_test_utils")))]
475 channel_state: Mutex<ChannelHolder<Signer>>,
477 /// Storage for PaymentSecrets and any requirements on future inbound payments before we will
478 /// expose them to users via a PaymentReceived event. HTLCs which do not meet the requirements
479 /// here are failed when we process them as pending-forwardable-HTLCs, and entries are removed
480 /// after we generate a PaymentReceived upon receipt of all MPP parts or when they time out.
481 /// Locked *after* channel_state.
482 pending_inbound_payments: Mutex<HashMap<PaymentHash, PendingInboundPayment>>,
484 /// The session_priv bytes of outbound payments which are pending resolution.
485 /// The authoritative state of these HTLCs resides either within Channels or ChannelMonitors
486 /// (if the channel has been force-closed), however we track them here to prevent duplicative
487 /// PaymentSent/PaymentFailed events. Specifically, in the case of a duplicative
488 /// update_fulfill_htlc message after a reconnect, we may "claim" a payment twice.
489 /// Additionally, because ChannelMonitors are often not re-serialized after connecting block(s)
490 /// which may generate a claim event, we may receive similar duplicate claim/fail MonitorEvents
491 /// after reloading from disk while replaying blocks against ChannelMonitors.
493 /// Each payment has each of its MPP part's session_priv bytes in the HashSet of the map (even
494 /// payments over a single path).
496 /// Locked *after* channel_state.
497 pending_outbound_payments: Mutex<HashMap<MppId, HashSet<[u8; 32]>>>,
499 our_network_key: SecretKey,
500 our_network_pubkey: PublicKey,
502 /// Used to track the last value sent in a node_announcement "timestamp" field. We ensure this
503 /// value increases strictly since we don't assume access to a time source.
504 last_node_announcement_serial: AtomicUsize,
506 /// The highest block timestamp we've seen, which is usually a good guess at the current time.
507 /// Assuming most miners are generating blocks with reasonable timestamps, this shouldn't be
508 /// very far in the past, and can only ever be up to two hours in the future.
509 highest_seen_timestamp: AtomicUsize,
511 /// The bulk of our storage will eventually be here (channels and message queues and the like).
512 /// If we are connected to a peer we always at least have an entry here, even if no channels
513 /// are currently open with that peer.
514 /// Because adding or removing an entry is rare, we usually take an outer read lock and then
515 /// operate on the inner value freely. Sadly, this prevents parallel operation when opening a
518 /// If also holding `channel_state` lock, must lock `channel_state` prior to `per_peer_state`.
519 per_peer_state: RwLock<HashMap<PublicKey, Mutex<PeerState>>>,
521 pending_events: Mutex<Vec<events::Event>>,
522 pending_background_events: Mutex<Vec<BackgroundEvent>>,
523 /// Used when we have to take a BIG lock to make sure everything is self-consistent.
524 /// Essentially just when we're serializing ourselves out.
525 /// Taken first everywhere where we are making changes before any other locks.
526 /// When acquiring this lock in read mode, rather than acquiring it directly, call
527 /// `PersistenceNotifierGuard::notify_on_drop(..)` and pass the lock to it, to ensure the
528 /// PersistenceNotifier the lock contains sends out a notification when the lock is released.
529 total_consistency_lock: RwLock<()>,
531 persistence_notifier: PersistenceNotifier,
538 /// Chain-related parameters used to construct a new `ChannelManager`.
540 /// Typically, the block-specific parameters are derived from the best block hash for the network,
541 /// as a newly constructed `ChannelManager` will not have created any channels yet. These parameters
542 /// are not needed when deserializing a previously constructed `ChannelManager`.
543 #[derive(Clone, Copy, PartialEq)]
544 pub struct ChainParameters {
545 /// The network for determining the `chain_hash` in Lightning messages.
546 pub network: Network,
548 /// The hash and height of the latest block successfully connected.
550 /// Used to track on-chain channel funding outputs and send payments with reliable timelocks.
551 pub best_block: BestBlock,
554 #[derive(Copy, Clone, PartialEq)]
560 /// Whenever we release the `ChannelManager`'s `total_consistency_lock`, from read mode, it is
561 /// desirable to notify any listeners on `await_persistable_update_timeout`/
562 /// `await_persistable_update` when new updates are available for persistence. Therefore, this
563 /// struct is responsible for locking the total consistency lock and, upon going out of scope,
564 /// sending the aforementioned notification (since the lock being released indicates that the
565 /// updates are ready for persistence).
567 /// We allow callers to either always notify by constructing with `notify_on_drop` or choose to
568 /// notify or not based on whether relevant changes have been made, providing a closure to
569 /// `optionally_notify` which returns a `NotifyOption`.
570 struct PersistenceNotifierGuard<'a, F: Fn() -> NotifyOption> {
571 persistence_notifier: &'a PersistenceNotifier,
573 // We hold onto this result so the lock doesn't get released immediately.
574 _read_guard: RwLockReadGuard<'a, ()>,
577 impl<'a> PersistenceNotifierGuard<'a, fn() -> NotifyOption> { // We don't care what the concrete F is here, it's unused
578 fn notify_on_drop(lock: &'a RwLock<()>, notifier: &'a PersistenceNotifier) -> PersistenceNotifierGuard<'a, impl Fn() -> NotifyOption> {
579 PersistenceNotifierGuard::optionally_notify(lock, notifier, || -> NotifyOption { NotifyOption::DoPersist })
582 fn optionally_notify<F: Fn() -> NotifyOption>(lock: &'a RwLock<()>, notifier: &'a PersistenceNotifier, persist_check: F) -> PersistenceNotifierGuard<'a, F> {
583 let read_guard = lock.read().unwrap();
585 PersistenceNotifierGuard {
586 persistence_notifier: notifier,
587 should_persist: persist_check,
588 _read_guard: read_guard,
593 impl<'a, F: Fn() -> NotifyOption> Drop for PersistenceNotifierGuard<'a, F> {
595 if (self.should_persist)() == NotifyOption::DoPersist {
596 self.persistence_notifier.notify();
601 /// The amount of time in blocks we require our counterparty wait to claim their money (ie time
602 /// between when we, or our watchtower, must check for them having broadcast a theft transaction).
604 /// This can be increased (but not decreased) through [`ChannelHandshakeConfig::our_to_self_delay`]
606 /// [`ChannelHandshakeConfig::our_to_self_delay`]: crate::util::config::ChannelHandshakeConfig::our_to_self_delay
607 pub const BREAKDOWN_TIMEOUT: u16 = 6 * 24;
608 /// The amount of time in blocks we're willing to wait to claim money back to us. This matches
609 /// the maximum required amount in lnd as of March 2021.
610 pub(crate) const MAX_LOCAL_BREAKDOWN_TIMEOUT: u16 = 2 * 6 * 24 * 7;
612 /// The minimum number of blocks between an inbound HTLC's CLTV and the corresponding outbound
613 /// HTLC's CLTV. The current default represents roughly seven hours of blocks at six blocks/hour.
615 /// This can be increased (but not decreased) through [`ChannelConfig::cltv_expiry_delta`]
617 /// [`ChannelConfig::cltv_expiry_delta`]: crate::util::config::ChannelConfig::cltv_expiry_delta
618 // This should always be a few blocks greater than channelmonitor::CLTV_CLAIM_BUFFER,
619 // i.e. the node we forwarded the payment on to should always have enough room to reliably time out
620 // the HTLC via a full update_fail_htlc/commitment_signed dance before we hit the
621 // CLTV_CLAIM_BUFFER point (we static assert that it's at least 3 blocks more).
622 pub const MIN_CLTV_EXPIRY_DELTA: u16 = 6*7;
623 pub(super) const CLTV_FAR_FAR_AWAY: u32 = 6 * 24 * 7; //TODO?
625 /// Minimum CLTV difference between the current block height and received inbound payments.
626 /// Invoices generated for payment to us must set their `min_final_cltv_expiry` field to at least
628 // Note that we fail if exactly HTLC_FAIL_BACK_BUFFER + 1 was used, so we need to add one for
629 // any payments to succeed. Further, we don't want payments to fail if a block was found while
630 // a payment was being routed, so we add an extra block to be safe.
631 pub const MIN_FINAL_CLTV_EXPIRY: u32 = HTLC_FAIL_BACK_BUFFER + 3;
633 // Check that our CLTV_EXPIRY is at least CLTV_CLAIM_BUFFER + ANTI_REORG_DELAY + LATENCY_GRACE_PERIOD_BLOCKS,
634 // ie that if the next-hop peer fails the HTLC within
635 // LATENCY_GRACE_PERIOD_BLOCKS then we'll still have CLTV_CLAIM_BUFFER left to timeout it onchain,
636 // then waiting ANTI_REORG_DELAY to be reorg-safe on the outbound HLTC and
637 // failing the corresponding htlc backward, and us now seeing the last block of ANTI_REORG_DELAY before
638 // LATENCY_GRACE_PERIOD_BLOCKS.
641 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;
643 // Check for ability of an attacker to make us fail on-chain by delaying an HTLC claim. See
644 // ChannelMonitor::should_broadcast_holder_commitment_txn for a description of why this is needed.
647 const CHECK_CLTV_EXPIRY_SANITY_2: u32 = MIN_CLTV_EXPIRY_DELTA as u32 - LATENCY_GRACE_PERIOD_BLOCKS - 2*CLTV_CLAIM_BUFFER;
649 /// Information needed for constructing an invoice route hint for this channel.
650 #[derive(Clone, Debug, PartialEq)]
651 pub struct CounterpartyForwardingInfo {
652 /// Base routing fee in millisatoshis.
653 pub fee_base_msat: u32,
654 /// Amount in millionths of a satoshi the channel will charge per transferred satoshi.
655 pub fee_proportional_millionths: u32,
656 /// The minimum difference in cltv_expiry between an ingoing HTLC and its outgoing counterpart,
657 /// such that the outgoing HTLC is forwardable to this counterparty. See `msgs::ChannelUpdate`'s
658 /// `cltv_expiry_delta` for more details.
659 pub cltv_expiry_delta: u16,
662 /// Channel parameters which apply to our counterparty. These are split out from [`ChannelDetails`]
663 /// to better separate parameters.
664 #[derive(Clone, Debug, PartialEq)]
665 pub struct ChannelCounterparty {
666 /// The node_id of our counterparty
667 pub node_id: PublicKey,
668 /// The Features the channel counterparty provided upon last connection.
669 /// Useful for routing as it is the most up-to-date copy of the counterparty's features and
670 /// many routing-relevant features are present in the init context.
671 pub features: InitFeatures,
672 /// The value, in satoshis, that must always be held in the channel for our counterparty. This
673 /// value ensures that if our counterparty broadcasts a revoked state, we can punish them by
674 /// claiming at least this value on chain.
676 /// This value is not included in [`inbound_capacity_msat`] as it can never be spent.
678 /// [`inbound_capacity_msat`]: ChannelDetails::inbound_capacity_msat
679 pub unspendable_punishment_reserve: u64,
680 /// Information on the fees and requirements that the counterparty requires when forwarding
681 /// payments to us through this channel.
682 pub forwarding_info: Option<CounterpartyForwardingInfo>,
685 /// Details of a channel, as returned by ChannelManager::list_channels and ChannelManager::list_usable_channels
686 #[derive(Clone, Debug, PartialEq)]
687 pub struct ChannelDetails {
688 /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
689 /// thereafter this is the txid of the funding transaction xor the funding transaction output).
690 /// Note that this means this value is *not* persistent - it can change once during the
691 /// lifetime of the channel.
692 pub channel_id: [u8; 32],
693 /// Parameters which apply to our counterparty. See individual fields for more information.
694 pub counterparty: ChannelCounterparty,
695 /// The Channel's funding transaction output, if we've negotiated the funding transaction with
696 /// our counterparty already.
698 /// Note that, if this has been set, `channel_id` will be equivalent to
699 /// `funding_txo.unwrap().to_channel_id()`.
700 pub funding_txo: Option<OutPoint>,
701 /// The position of the funding transaction in the chain. None if the funding transaction has
702 /// not yet been confirmed and the channel fully opened.
703 pub short_channel_id: Option<u64>,
704 /// The value, in satoshis, of this channel as appears in the funding output
705 pub channel_value_satoshis: u64,
706 /// The value, in satoshis, that must always be held in the channel for us. This value ensures
707 /// that if we broadcast a revoked state, our counterparty can punish us by claiming at least
708 /// this value on chain.
710 /// This value is not included in [`outbound_capacity_msat`] as it can never be spent.
712 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
714 /// [`outbound_capacity_msat`]: ChannelDetails::outbound_capacity_msat
715 pub unspendable_punishment_reserve: Option<u64>,
716 /// The user_id passed in to create_channel, or 0 if the channel was inbound.
718 /// The available outbound capacity for sending HTLCs to the remote peer. This does not include
719 /// any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
720 /// available for inclusion in new outbound HTLCs). This further does not include any pending
721 /// outgoing HTLCs which are awaiting some other resolution to be sent.
723 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
724 /// conflict-avoidance policy, exactly this amount is not likely to be spendable. However, we
725 /// should be able to spend nearly this amount.
726 pub outbound_capacity_msat: u64,
727 /// The available inbound capacity for the remote peer to send HTLCs to us. This does not
728 /// include any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
729 /// available for inclusion in new inbound HTLCs).
730 /// Note that there are some corner cases not fully handled here, so the actual available
731 /// inbound capacity may be slightly higher than this.
733 /// This value is not exact. Due to various in-flight changes, feerate changes, and our
734 /// counterparty's conflict-avoidance policy, exactly this amount is not likely to be spendable.
735 /// However, our counterparty should be able to spend nearly this amount.
736 pub inbound_capacity_msat: u64,
737 /// The number of required confirmations on the funding transaction before the funding will be
738 /// considered "locked". This number is selected by the channel fundee (i.e. us if
739 /// [`is_outbound`] is *not* set), and can be selected for inbound channels with
740 /// [`ChannelHandshakeConfig::minimum_depth`] or limited for outbound channels with
741 /// [`ChannelHandshakeLimits::max_minimum_depth`].
743 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
745 /// [`is_outbound`]: ChannelDetails::is_outbound
746 /// [`ChannelHandshakeConfig::minimum_depth`]: crate::util::config::ChannelHandshakeConfig::minimum_depth
747 /// [`ChannelHandshakeLimits::max_minimum_depth`]: crate::util::config::ChannelHandshakeLimits::max_minimum_depth
748 pub confirmations_required: Option<u32>,
749 /// The number of blocks (after our commitment transaction confirms) that we will need to wait
750 /// until we can claim our funds after we force-close the channel. During this time our
751 /// counterparty is allowed to punish us if we broadcasted a stale state. If our counterparty
752 /// force-closes the channel and broadcasts a commitment transaction we do not have to wait any
753 /// time to claim our non-HTLC-encumbered funds.
755 /// This value will be `None` for outbound channels until the counterparty accepts the channel.
756 pub force_close_spend_delay: Option<u16>,
757 /// True if the channel was initiated (and thus funded) by us.
758 pub is_outbound: bool,
759 /// True if the channel is confirmed, funding_locked messages have been exchanged, and the
760 /// channel is not currently being shut down. `funding_locked` message exchange implies the
761 /// required confirmation count has been reached (and we were connected to the peer at some
762 /// point after the funding transaction received enough confirmations). The required
763 /// confirmation count is provided in [`confirmations_required`].
765 /// [`confirmations_required`]: ChannelDetails::confirmations_required
766 pub is_funding_locked: bool,
767 /// True if the channel is (a) confirmed and funding_locked messages have been exchanged, (b)
768 /// the peer is connected, and (c) the channel is not currently negotiating a shutdown.
770 /// This is a strict superset of `is_funding_locked`.
772 /// True if this channel is (or will be) publicly-announced.
776 /// If a payment fails to send, it can be in one of several states. This enum is returned as the
777 /// Err() type describing which state the payment is in, see the description of individual enum
779 #[derive(Clone, Debug)]
780 pub enum PaymentSendFailure {
781 /// A parameter which was passed to send_payment was invalid, preventing us from attempting to
782 /// send the payment at all. No channel state has been changed or messages sent to peers, and
783 /// once you've changed the parameter at error, you can freely retry the payment in full.
784 ParameterError(APIError),
785 /// A parameter in a single path which was passed to send_payment was invalid, preventing us
786 /// from attempting to send the payment at all. No channel state has been changed or messages
787 /// sent to peers, and once you've changed the parameter at error, you can freely retry the
790 /// The results here are ordered the same as the paths in the route object which was passed to
792 PathParameterError(Vec<Result<(), APIError>>),
793 /// All paths which were attempted failed to send, with no channel state change taking place.
794 /// You can freely retry the payment in full (though you probably want to do so over different
795 /// paths than the ones selected).
796 AllFailedRetrySafe(Vec<APIError>),
797 /// Some paths which were attempted failed to send, though possibly not all. At least some
798 /// paths have irrevocably committed to the HTLC and retrying the payment in full would result
799 /// in over-/re-payment.
801 /// The results here are ordered the same as the paths in the route object which was passed to
802 /// send_payment, and any Errs which are not APIError::MonitorUpdateFailed can be safely
803 /// retried (though there is currently no API with which to do so).
805 /// Any entries which contain Err(APIError::MonitorUpdateFailed) or Ok(()) MUST NOT be retried
806 /// as they will result in over-/re-payment. These HTLCs all either successfully sent (in the
807 /// case of Ok(())) or will send once channel_monitor_updated is called on the next-hop channel
808 /// with the latest update_id.
809 PartialFailure(Vec<Result<(), APIError>>),
812 macro_rules! handle_error {
813 ($self: ident, $internal: expr, $counterparty_node_id: expr) => {
816 Err(MsgHandleErrInternal { err, shutdown_finish }) => {
817 #[cfg(debug_assertions)]
819 // In testing, ensure there are no deadlocks where the lock is already held upon
820 // entering the macro.
821 assert!($self.channel_state.try_lock().is_ok());
824 let mut msg_events = Vec::with_capacity(2);
826 if let Some((shutdown_res, update_option)) = shutdown_finish {
827 $self.finish_force_close_channel(shutdown_res);
828 if let Some(update) = update_option {
829 msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
835 log_error!($self.logger, "{}", err.err);
836 if let msgs::ErrorAction::IgnoreError = err.action {
838 msg_events.push(events::MessageSendEvent::HandleError {
839 node_id: $counterparty_node_id,
840 action: err.action.clone()
844 if !msg_events.is_empty() {
845 $self.channel_state.lock().unwrap().pending_msg_events.append(&mut msg_events);
848 // Return error in case higher-API need one
855 /// Returns (boolean indicating if we should remove the Channel object from memory, a mapped error)
856 macro_rules! convert_chan_err {
857 ($self: ident, $err: expr, $short_to_id: expr, $channel: expr, $channel_id: expr) => {
859 ChannelError::Warn(msg) => {
860 //TODO: Once warning messages are merged, we should send a `warning` message to our
862 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore(msg), $channel_id.clone()))
864 ChannelError::Ignore(msg) => {
865 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore(msg), $channel_id.clone()))
867 ChannelError::Close(msg) => {
868 log_error!($self.logger, "Closing channel {} due to close-required error: {}", log_bytes!($channel_id[..]), msg);
869 if let Some(short_id) = $channel.get_short_channel_id() {
870 $short_to_id.remove(&short_id);
872 let shutdown_res = $channel.force_shutdown(true);
873 (true, MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, shutdown_res, $self.get_channel_update_for_broadcast(&$channel).ok()))
875 ChannelError::CloseDelayBroadcast(msg) => {
876 log_error!($self.logger, "Channel {} need to be shutdown but closing transactions not broadcast due to {}", log_bytes!($channel_id[..]), msg);
877 if let Some(short_id) = $channel.get_short_channel_id() {
878 $short_to_id.remove(&short_id);
880 let shutdown_res = $channel.force_shutdown(false);
881 (true, MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, shutdown_res, $self.get_channel_update_for_broadcast(&$channel).ok()))
887 macro_rules! break_chan_entry {
888 ($self: ident, $res: expr, $channel_state: expr, $entry: expr) => {
892 let (drop, res) = convert_chan_err!($self, e, $channel_state.short_to_id, $entry.get_mut(), $entry.key());
894 $entry.remove_entry();
902 macro_rules! try_chan_entry {
903 ($self: ident, $res: expr, $channel_state: expr, $entry: expr) => {
907 let (drop, res) = convert_chan_err!($self, e, $channel_state.short_to_id, $entry.get_mut(), $entry.key());
909 $entry.remove_entry();
917 macro_rules! remove_channel {
918 ($channel_state: expr, $entry: expr) => {
920 let channel = $entry.remove_entry().1;
921 if let Some(short_id) = channel.get_short_channel_id() {
922 $channel_state.short_to_id.remove(&short_id);
929 macro_rules! handle_monitor_err {
930 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
931 handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment, Vec::new(), Vec::new())
933 ($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) => {
935 ChannelMonitorUpdateErr::PermanentFailure => {
936 log_error!($self.logger, "Closing channel {} due to monitor update ChannelMonitorUpdateErr::PermanentFailure", log_bytes!($chan_id[..]));
937 if let Some(short_id) = $chan.get_short_channel_id() {
938 $short_to_id.remove(&short_id);
940 // TODO: $failed_fails is dropped here, which will cause other channels to hit the
941 // chain in a confused state! We need to move them into the ChannelMonitor which
942 // will be responsible for failing backwards once things confirm on-chain.
943 // It's ok that we drop $failed_forwards here - at this point we'd rather they
944 // broadcast HTLC-Timeout and pay the associated fees to get their funds back than
945 // us bother trying to claim it just to forward on to another peer. If we're
946 // splitting hairs we'd prefer to claim payments that were to us, but we haven't
947 // given up the preimage yet, so might as well just wait until the payment is
948 // retried, avoiding the on-chain fees.
949 let res: Result<(), _> = Err(MsgHandleErrInternal::from_finish_shutdown("ChannelMonitor storage failure".to_owned(), *$chan_id,
950 $chan.force_shutdown(true), $self.get_channel_update_for_broadcast(&$chan).ok() ));
953 ChannelMonitorUpdateErr::TemporaryFailure => {
954 log_info!($self.logger, "Disabling channel {} due to monitor update TemporaryFailure. On restore will send {} and process {} forwards and {} fails",
955 log_bytes!($chan_id[..]),
956 if $resend_commitment && $resend_raa {
958 RAACommitmentOrder::CommitmentFirst => { "commitment then RAA" },
959 RAACommitmentOrder::RevokeAndACKFirst => { "RAA then commitment" },
961 } else if $resend_commitment { "commitment" }
962 else if $resend_raa { "RAA" }
964 (&$failed_forwards as &Vec<(PendingHTLCInfo, u64)>).len(),
965 (&$failed_fails as &Vec<(HTLCSource, PaymentHash, HTLCFailReason)>).len());
966 if !$resend_commitment {
967 debug_assert!($action_type == RAACommitmentOrder::RevokeAndACKFirst || !$resend_raa);
970 debug_assert!($action_type == RAACommitmentOrder::CommitmentFirst || !$resend_commitment);
972 $chan.monitor_update_failed($resend_raa, $resend_commitment, $failed_forwards, $failed_fails);
973 (Err(MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore("Failed to update ChannelMonitor".to_owned()), *$chan_id)), false)
977 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr, $failed_forwards: expr, $failed_fails: expr) => { {
978 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());
980 $entry.remove_entry();
986 macro_rules! return_monitor_err {
987 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
988 return handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment);
990 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr, $failed_forwards: expr, $failed_fails: expr) => {
991 return handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment, $failed_forwards, $failed_fails);
995 // Does not break in case of TemporaryFailure!
996 macro_rules! maybe_break_monitor_err {
997 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
998 match (handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment), $err) {
999 (e, ChannelMonitorUpdateErr::PermanentFailure) => {
1002 (_, ChannelMonitorUpdateErr::TemporaryFailure) => { },
1007 macro_rules! handle_chan_restoration_locked {
1008 ($self: ident, $channel_lock: expr, $channel_state: expr, $channel_entry: expr,
1009 $raa: expr, $commitment_update: expr, $order: expr, $chanmon_update: expr,
1010 $pending_forwards: expr, $funding_broadcastable: expr, $funding_locked: expr) => { {
1011 let mut htlc_forwards = None;
1012 let counterparty_node_id = $channel_entry.get().get_counterparty_node_id();
1014 let chanmon_update: Option<ChannelMonitorUpdate> = $chanmon_update; // Force type-checking to resolve
1015 let chanmon_update_is_none = chanmon_update.is_none();
1017 let forwards: Vec<(PendingHTLCInfo, u64)> = $pending_forwards; // Force type-checking to resolve
1018 if !forwards.is_empty() {
1019 htlc_forwards = Some(($channel_entry.get().get_short_channel_id().expect("We can't have pending forwards before funding confirmation"),
1020 $channel_entry.get().get_funding_txo().unwrap(), forwards));
1023 if chanmon_update.is_some() {
1024 // On reconnect, we, by definition, only resend a funding_locked if there have been
1025 // no commitment updates, so the only channel monitor update which could also be
1026 // associated with a funding_locked would be the funding_created/funding_signed
1027 // monitor update. That monitor update failing implies that we won't send
1028 // funding_locked until it's been updated, so we can't have a funding_locked and a
1029 // monitor update here (so we don't bother to handle it correctly below).
1030 assert!($funding_locked.is_none());
1031 // A channel monitor update makes no sense without either a funding_locked or a
1032 // commitment update to process after it. Since we can't have a funding_locked, we
1033 // only bother to handle the monitor-update + commitment_update case below.
1034 assert!($commitment_update.is_some());
1037 if let Some(msg) = $funding_locked {
1038 // Similar to the above, this implies that we're letting the funding_locked fly
1039 // before it should be allowed to.
1040 assert!(chanmon_update.is_none());
1041 $channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingLocked {
1042 node_id: counterparty_node_id,
1045 if let Some(announcement_sigs) = $self.get_announcement_sigs($channel_entry.get()) {
1046 $channel_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
1047 node_id: counterparty_node_id,
1048 msg: announcement_sigs,
1051 $channel_state.short_to_id.insert($channel_entry.get().get_short_channel_id().unwrap(), $channel_entry.get().channel_id());
1054 let funding_broadcastable: Option<Transaction> = $funding_broadcastable; // Force type-checking to resolve
1055 if let Some(monitor_update) = chanmon_update {
1056 // We only ever broadcast a funding transaction in response to a funding_signed
1057 // message and the resulting monitor update. Thus, on channel_reestablish
1058 // message handling we can't have a funding transaction to broadcast. When
1059 // processing a monitor update finishing resulting in a funding broadcast, we
1060 // cannot have a second monitor update, thus this case would indicate a bug.
1061 assert!(funding_broadcastable.is_none());
1062 // Given we were just reconnected or finished updating a channel monitor, the
1063 // only case where we can get a new ChannelMonitorUpdate would be if we also
1064 // have some commitment updates to send as well.
1065 assert!($commitment_update.is_some());
1066 if let Err(e) = $self.chain_monitor.update_channel($channel_entry.get().get_funding_txo().unwrap(), monitor_update) {
1067 // channel_reestablish doesn't guarantee the order it returns is sensical
1068 // for the messages it returns, but if we're setting what messages to
1069 // re-transmit on monitor update success, we need to make sure it is sane.
1070 let mut order = $order;
1072 order = RAACommitmentOrder::CommitmentFirst;
1074 break handle_monitor_err!($self, e, $channel_state, $channel_entry, order, $raa.is_some(), true);
1078 macro_rules! handle_cs { () => {
1079 if let Some(update) = $commitment_update {
1080 $channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1081 node_id: counterparty_node_id,
1086 macro_rules! handle_raa { () => {
1087 if let Some(revoke_and_ack) = $raa {
1088 $channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
1089 node_id: counterparty_node_id,
1090 msg: revoke_and_ack,
1095 RAACommitmentOrder::CommitmentFirst => {
1099 RAACommitmentOrder::RevokeAndACKFirst => {
1104 if let Some(tx) = funding_broadcastable {
1105 log_info!($self.logger, "Broadcasting funding transaction with txid {}", tx.txid());
1106 $self.tx_broadcaster.broadcast_transaction(&tx);
1111 if chanmon_update_is_none {
1112 // If there was no ChannelMonitorUpdate, we should never generate an Err in the res loop
1113 // above. Doing so would imply calling handle_err!() from channel_monitor_updated() which
1114 // should *never* end up calling back to `chain_monitor.update_channel()`.
1115 assert!(res.is_ok());
1118 (htlc_forwards, res, counterparty_node_id)
1122 macro_rules! post_handle_chan_restoration {
1123 ($self: ident, $locked_res: expr) => { {
1124 let (htlc_forwards, res, counterparty_node_id) = $locked_res;
1126 let _ = handle_error!($self, res, counterparty_node_id);
1128 if let Some(forwards) = htlc_forwards {
1129 $self.forward_htlcs(&mut [forwards][..]);
1134 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<Signer, M, T, K, F, L>
1135 where M::Target: chain::Watch<Signer>,
1136 T::Target: BroadcasterInterface,
1137 K::Target: KeysInterface<Signer = Signer>,
1138 F::Target: FeeEstimator,
1141 /// Constructs a new ChannelManager to hold several channels and route between them.
1143 /// This is the main "logic hub" for all channel-related actions, and implements
1144 /// ChannelMessageHandler.
1146 /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
1148 /// panics if channel_value_satoshis is >= `MAX_FUNDING_SATOSHIS`!
1150 /// Users need to notify the new ChannelManager when a new block is connected or
1151 /// disconnected using its `block_connected` and `block_disconnected` methods, starting
1152 /// from after `params.latest_hash`.
1153 pub fn new(fee_est: F, chain_monitor: M, tx_broadcaster: T, logger: L, keys_manager: K, config: UserConfig, params: ChainParameters) -> Self {
1154 let mut secp_ctx = Secp256k1::new();
1155 secp_ctx.seeded_randomize(&keys_manager.get_secure_random_bytes());
1158 default_configuration: config.clone(),
1159 genesis_hash: genesis_block(params.network).header.block_hash(),
1160 fee_estimator: fee_est,
1164 best_block: RwLock::new(params.best_block),
1166 channel_state: Mutex::new(ChannelHolder{
1167 by_id: HashMap::new(),
1168 short_to_id: HashMap::new(),
1169 forward_htlcs: HashMap::new(),
1170 claimable_htlcs: HashMap::new(),
1171 pending_msg_events: Vec::new(),
1173 pending_inbound_payments: Mutex::new(HashMap::new()),
1174 pending_outbound_payments: Mutex::new(HashMap::new()),
1176 our_network_key: keys_manager.get_node_secret(),
1177 our_network_pubkey: PublicKey::from_secret_key(&secp_ctx, &keys_manager.get_node_secret()),
1180 last_node_announcement_serial: AtomicUsize::new(0),
1181 highest_seen_timestamp: AtomicUsize::new(0),
1183 per_peer_state: RwLock::new(HashMap::new()),
1185 pending_events: Mutex::new(Vec::new()),
1186 pending_background_events: Mutex::new(Vec::new()),
1187 total_consistency_lock: RwLock::new(()),
1188 persistence_notifier: PersistenceNotifier::new(),
1196 /// Gets the current configuration applied to all new channels, as
1197 pub fn get_current_default_configuration(&self) -> &UserConfig {
1198 &self.default_configuration
1201 /// Creates a new outbound channel to the given remote node and with the given value.
1203 /// user_id will be provided back as user_channel_id in FundingGenerationReady events to allow
1204 /// tracking of which events correspond with which create_channel call. Note that the
1205 /// user_channel_id defaults to 0 for inbound channels, so you may wish to avoid using 0 for
1206 /// user_id here. user_id has no meaning inside of LDK, it is simply copied to events and
1207 /// otherwise ignored.
1209 /// If successful, will generate a SendOpenChannel message event, so you should probably poll
1210 /// PeerManager::process_events afterwards.
1212 /// Raises APIError::APIMisuseError when channel_value_satoshis > 2**24 or push_msat is
1213 /// greater than channel_value_satoshis * 1k or channel_value_satoshis is < 1000.
1215 /// Note that we do not check if you are currently connected to the given peer. If no
1216 /// connection is available, the outbound `open_channel` message may fail to send, resulting in
1217 /// the channel eventually being silently forgotten.
1218 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> {
1219 if channel_value_satoshis < 1000 {
1220 return Err(APIError::APIMisuseError { err: format!("Channel value must be at least 1000 satoshis. It was {}", channel_value_satoshis) });
1224 let per_peer_state = self.per_peer_state.read().unwrap();
1225 match per_peer_state.get(&their_network_key) {
1226 Some(peer_state) => {
1227 let peer_state = peer_state.lock().unwrap();
1228 let their_features = &peer_state.latest_features;
1229 let config = if override_config.is_some() { override_config.as_ref().unwrap() } else { &self.default_configuration };
1230 Channel::new_outbound(&self.fee_estimator, &self.keys_manager, their_network_key, their_features, channel_value_satoshis, push_msat, user_id, config)?
1232 None => return Err(APIError::ChannelUnavailable { err: format!("Not connected to node: {}", their_network_key) }),
1235 let res = channel.get_open_channel(self.genesis_hash.clone());
1237 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1238 // We want to make sure the lock is actually acquired by PersistenceNotifierGuard.
1239 debug_assert!(&self.total_consistency_lock.try_write().is_err());
1241 let mut channel_state = self.channel_state.lock().unwrap();
1242 match channel_state.by_id.entry(channel.channel_id()) {
1243 hash_map::Entry::Occupied(_) => {
1244 if cfg!(feature = "fuzztarget") {
1245 return Err(APIError::APIMisuseError { err: "Fuzzy bad RNG".to_owned() });
1247 panic!("RNG is bad???");
1250 hash_map::Entry::Vacant(entry) => { entry.insert(channel); }
1252 channel_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
1253 node_id: their_network_key,
1259 fn list_channels_with_filter<Fn: FnMut(&(&[u8; 32], &Channel<Signer>)) -> bool>(&self, f: Fn) -> Vec<ChannelDetails> {
1260 let mut res = Vec::new();
1262 let channel_state = self.channel_state.lock().unwrap();
1263 res.reserve(channel_state.by_id.len());
1264 for (channel_id, channel) in channel_state.by_id.iter().filter(f) {
1265 let (inbound_capacity_msat, outbound_capacity_msat) = channel.get_inbound_outbound_available_balance_msat();
1266 let (to_remote_reserve_satoshis, to_self_reserve_satoshis) =
1267 channel.get_holder_counterparty_selected_channel_reserve_satoshis();
1268 res.push(ChannelDetails {
1269 channel_id: (*channel_id).clone(),
1270 counterparty: ChannelCounterparty {
1271 node_id: channel.get_counterparty_node_id(),
1272 features: InitFeatures::empty(),
1273 unspendable_punishment_reserve: to_remote_reserve_satoshis,
1274 forwarding_info: channel.counterparty_forwarding_info(),
1276 funding_txo: channel.get_funding_txo(),
1277 short_channel_id: channel.get_short_channel_id(),
1278 channel_value_satoshis: channel.get_value_satoshis(),
1279 unspendable_punishment_reserve: to_self_reserve_satoshis,
1280 inbound_capacity_msat,
1281 outbound_capacity_msat,
1282 user_id: channel.get_user_id(),
1283 confirmations_required: channel.minimum_depth(),
1284 force_close_spend_delay: channel.get_counterparty_selected_contest_delay(),
1285 is_outbound: channel.is_outbound(),
1286 is_funding_locked: channel.is_usable(),
1287 is_usable: channel.is_live(),
1288 is_public: channel.should_announce(),
1292 let per_peer_state = self.per_peer_state.read().unwrap();
1293 for chan in res.iter_mut() {
1294 if let Some(peer_state) = per_peer_state.get(&chan.counterparty.node_id) {
1295 chan.counterparty.features = peer_state.lock().unwrap().latest_features.clone();
1301 /// Gets the list of open channels, in random order. See ChannelDetail field documentation for
1302 /// more information.
1303 pub fn list_channels(&self) -> Vec<ChannelDetails> {
1304 self.list_channels_with_filter(|_| true)
1307 /// Gets the list of usable channels, in random order. Useful as an argument to
1308 /// get_route to ensure non-announced channels are used.
1310 /// These are guaranteed to have their [`ChannelDetails::is_usable`] value set to true, see the
1311 /// documentation for [`ChannelDetails::is_usable`] for more info on exactly what the criteria
1313 pub fn list_usable_channels(&self) -> Vec<ChannelDetails> {
1314 // Note we use is_live here instead of usable which leads to somewhat confused
1315 // internal/external nomenclature, but that's ok cause that's probably what the user
1316 // really wanted anyway.
1317 self.list_channels_with_filter(|&(_, ref channel)| channel.is_live())
1320 fn close_channel_internal(&self, channel_id: &[u8; 32], target_feerate_sats_per_1000_weight: Option<u32>) -> Result<(), APIError> {
1321 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1323 let counterparty_node_id;
1324 let mut failed_htlcs: Vec<(HTLCSource, PaymentHash)>;
1325 let result: Result<(), _> = loop {
1326 let mut channel_state_lock = self.channel_state.lock().unwrap();
1327 let channel_state = &mut *channel_state_lock;
1328 match channel_state.by_id.entry(channel_id.clone()) {
1329 hash_map::Entry::Occupied(mut chan_entry) => {
1330 counterparty_node_id = chan_entry.get().get_counterparty_node_id();
1331 let per_peer_state = self.per_peer_state.read().unwrap();
1332 let (shutdown_msg, monitor_update, htlcs) = match per_peer_state.get(&counterparty_node_id) {
1333 Some(peer_state) => {
1334 let peer_state = peer_state.lock().unwrap();
1335 let their_features = &peer_state.latest_features;
1336 chan_entry.get_mut().get_shutdown(&self.keys_manager, their_features, target_feerate_sats_per_1000_weight)?
1338 None => return Err(APIError::ChannelUnavailable { err: format!("Not connected to node: {}", counterparty_node_id) }),
1340 failed_htlcs = htlcs;
1342 // Update the monitor with the shutdown script if necessary.
1343 if let Some(monitor_update) = monitor_update {
1344 if let Err(e) = self.chain_monitor.update_channel(chan_entry.get().get_funding_txo().unwrap(), monitor_update) {
1345 let (result, is_permanent) =
1346 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());
1348 remove_channel!(channel_state, chan_entry);
1354 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
1355 node_id: counterparty_node_id,
1359 if chan_entry.get().is_shutdown() {
1360 let channel = remove_channel!(channel_state, chan_entry);
1361 if let Ok(channel_update) = self.get_channel_update_for_broadcast(&channel) {
1362 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1369 hash_map::Entry::Vacant(_) => return Err(APIError::ChannelUnavailable{err: "No such channel".to_owned()})
1373 for htlc_source in failed_htlcs.drain(..) {
1374 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() });
1377 let _ = handle_error!(self, result, counterparty_node_id);
1381 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
1382 /// will be accepted on the given channel, and after additional timeout/the closing of all
1383 /// pending HTLCs, the channel will be closed on chain.
1385 /// * If we are the channel initiator, we will pay between our [`Background`] and
1386 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
1388 /// * If our counterparty is the channel initiator, we will require a channel closing
1389 /// transaction feerate of at least our [`Background`] feerate or the feerate which
1390 /// would appear on a force-closure transaction, whichever is lower. We will allow our
1391 /// counterparty to pay as much fee as they'd like, however.
1393 /// May generate a SendShutdown message event on success, which should be relayed.
1395 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
1396 /// [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
1397 /// [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
1398 pub fn close_channel(&self, channel_id: &[u8; 32]) -> Result<(), APIError> {
1399 self.close_channel_internal(channel_id, None)
1402 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
1403 /// will be accepted on the given channel, and after additional timeout/the closing of all
1404 /// pending HTLCs, the channel will be closed on chain.
1406 /// `target_feerate_sat_per_1000_weight` has different meanings depending on if we initiated
1407 /// the channel being closed or not:
1408 /// * If we are the channel initiator, we will pay at least this feerate on the closing
1409 /// transaction. The upper-bound is set by
1410 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
1411 /// estimate (or `target_feerate_sat_per_1000_weight`, if it is greater).
1412 /// * If our counterparty is the channel initiator, we will refuse to accept a channel closure
1413 /// transaction feerate below `target_feerate_sat_per_1000_weight` (or the feerate which
1414 /// will appear on a force-closure transaction, whichever is lower).
1416 /// May generate a SendShutdown message event on success, which should be relayed.
1418 /// [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
1419 /// [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
1420 /// [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
1421 pub fn close_channel_with_target_feerate(&self, channel_id: &[u8; 32], target_feerate_sats_per_1000_weight: u32) -> Result<(), APIError> {
1422 self.close_channel_internal(channel_id, Some(target_feerate_sats_per_1000_weight))
1426 fn finish_force_close_channel(&self, shutdown_res: ShutdownResult) {
1427 let (monitor_update_option, mut failed_htlcs) = shutdown_res;
1428 log_debug!(self.logger, "Finishing force-closure of channel with {} HTLCs to fail", failed_htlcs.len());
1429 for htlc_source in failed_htlcs.drain(..) {
1430 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() });
1432 if let Some((funding_txo, monitor_update)) = monitor_update_option {
1433 // There isn't anything we can do if we get an update failure - we're already
1434 // force-closing. The monitor update on the required in-memory copy should broadcast
1435 // the latest local state, which is the best we can do anyway. Thus, it is safe to
1436 // ignore the result here.
1437 let _ = self.chain_monitor.update_channel(funding_txo, monitor_update);
1441 fn force_close_channel_with_peer(&self, channel_id: &[u8; 32], peer_node_id: Option<&PublicKey>) -> Result<PublicKey, APIError> {
1443 let mut channel_state_lock = self.channel_state.lock().unwrap();
1444 let channel_state = &mut *channel_state_lock;
1445 if let hash_map::Entry::Occupied(chan) = channel_state.by_id.entry(channel_id.clone()) {
1446 if let Some(node_id) = peer_node_id {
1447 if chan.get().get_counterparty_node_id() != *node_id {
1448 return Err(APIError::ChannelUnavailable{err: "No such channel".to_owned()});
1451 if let Some(short_id) = chan.get().get_short_channel_id() {
1452 channel_state.short_to_id.remove(&short_id);
1454 chan.remove_entry().1
1456 return Err(APIError::ChannelUnavailable{err: "No such channel".to_owned()});
1459 log_error!(self.logger, "Force-closing channel {}", log_bytes!(channel_id[..]));
1460 self.finish_force_close_channel(chan.force_shutdown(true));
1461 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
1462 let mut channel_state = self.channel_state.lock().unwrap();
1463 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1468 Ok(chan.get_counterparty_node_id())
1471 /// Force closes a channel, immediately broadcasting the latest local commitment transaction to
1472 /// the chain and rejecting new HTLCs on the given channel. Fails if channel_id is unknown to the manager.
1473 pub fn force_close_channel(&self, channel_id: &[u8; 32]) -> Result<(), APIError> {
1474 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1475 match self.force_close_channel_with_peer(channel_id, None) {
1476 Ok(counterparty_node_id) => {
1477 self.channel_state.lock().unwrap().pending_msg_events.push(
1478 events::MessageSendEvent::HandleError {
1479 node_id: counterparty_node_id,
1480 action: msgs::ErrorAction::SendErrorMessage {
1481 msg: msgs::ErrorMessage { channel_id: *channel_id, data: "Channel force-closed".to_owned() }
1491 /// Force close all channels, immediately broadcasting the latest local commitment transaction
1492 /// for each to the chain and rejecting new HTLCs on each.
1493 pub fn force_close_all_channels(&self) {
1494 for chan in self.list_channels() {
1495 let _ = self.force_close_channel(&chan.channel_id);
1499 fn decode_update_add_htlc_onion(&self, msg: &msgs::UpdateAddHTLC) -> (PendingHTLCStatus, MutexGuard<ChannelHolder<Signer>>) {
1500 macro_rules! return_malformed_err {
1501 ($msg: expr, $err_code: expr) => {
1503 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
1504 return (PendingHTLCStatus::Fail(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
1505 channel_id: msg.channel_id,
1506 htlc_id: msg.htlc_id,
1507 sha256_of_onion: Sha256::hash(&msg.onion_routing_packet.hop_data).into_inner(),
1508 failure_code: $err_code,
1509 })), self.channel_state.lock().unwrap());
1514 if let Err(_) = msg.onion_routing_packet.public_key {
1515 return_malformed_err!("invalid ephemeral pubkey", 0x8000 | 0x4000 | 6);
1518 let shared_secret = {
1519 let mut arr = [0; 32];
1520 arr.copy_from_slice(&SharedSecret::new(&msg.onion_routing_packet.public_key.unwrap(), &self.our_network_key)[..]);
1523 let (rho, mu) = onion_utils::gen_rho_mu_from_shared_secret(&shared_secret);
1525 if msg.onion_routing_packet.version != 0 {
1526 //TODO: Spec doesn't indicate if we should only hash hop_data here (and in other
1527 //sha256_of_onion error data packets), or the entire onion_routing_packet. Either way,
1528 //the hash doesn't really serve any purpose - in the case of hashing all data, the
1529 //receiving node would have to brute force to figure out which version was put in the
1530 //packet by the node that send us the message, in the case of hashing the hop_data, the
1531 //node knows the HMAC matched, so they already know what is there...
1532 return_malformed_err!("Unknown onion packet version", 0x8000 | 0x4000 | 4);
1535 let mut hmac = HmacEngine::<Sha256>::new(&mu);
1536 hmac.input(&msg.onion_routing_packet.hop_data);
1537 hmac.input(&msg.payment_hash.0[..]);
1538 if !fixed_time_eq(&Hmac::from_engine(hmac).into_inner(), &msg.onion_routing_packet.hmac) {
1539 return_malformed_err!("HMAC Check failed", 0x8000 | 0x4000 | 5);
1542 let mut channel_state = None;
1543 macro_rules! return_err {
1544 ($msg: expr, $err_code: expr, $data: expr) => {
1546 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
1547 if channel_state.is_none() {
1548 channel_state = Some(self.channel_state.lock().unwrap());
1550 return (PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
1551 channel_id: msg.channel_id,
1552 htlc_id: msg.htlc_id,
1553 reason: onion_utils::build_first_hop_failure_packet(&shared_secret, $err_code, $data),
1554 })), channel_state.unwrap());
1559 let mut chacha = ChaCha20::new(&rho, &[0u8; 8]);
1560 let mut chacha_stream = ChaChaReader { chacha: &mut chacha, read: Cursor::new(&msg.onion_routing_packet.hop_data[..]) };
1561 let (next_hop_data, next_hop_hmac): (msgs::OnionHopData, _) = {
1562 match <msgs::OnionHopData as Readable>::read(&mut chacha_stream) {
1564 let error_code = match err {
1565 msgs::DecodeError::UnknownVersion => 0x4000 | 1, // unknown realm byte
1566 msgs::DecodeError::UnknownRequiredFeature|
1567 msgs::DecodeError::InvalidValue|
1568 msgs::DecodeError::ShortRead => 0x4000 | 22, // invalid_onion_payload
1569 _ => 0x2000 | 2, // Should never happen
1571 return_err!("Unable to decode our hop data", error_code, &[0;0]);
1574 let mut hmac = [0; 32];
1575 if let Err(_) = chacha_stream.read_exact(&mut hmac[..]) {
1576 return_err!("Unable to decode hop data", 0x4000 | 22, &[0;0]);
1583 let pending_forward_info = if next_hop_hmac == [0; 32] {
1586 // In tests, make sure that the initial onion pcket data is, at least, non-0.
1587 // We could do some fancy randomness test here, but, ehh, whatever.
1588 // This checks for the issue where you can calculate the path length given the
1589 // onion data as all the path entries that the originator sent will be here
1590 // as-is (and were originally 0s).
1591 // Of course reverse path calculation is still pretty easy given naive routing
1592 // algorithms, but this fixes the most-obvious case.
1593 let mut next_bytes = [0; 32];
1594 chacha_stream.read_exact(&mut next_bytes).unwrap();
1595 assert_ne!(next_bytes[..], [0; 32][..]);
1596 chacha_stream.read_exact(&mut next_bytes).unwrap();
1597 assert_ne!(next_bytes[..], [0; 32][..]);
1601 // final_expiry_too_soon
1602 // We have to have some headroom to broadcast on chain if we have the preimage, so make sure
1603 // we have at least HTLC_FAIL_BACK_BUFFER blocks to go.
1604 // Also, ensure that, in the case of an unknown preimage for the received payment hash, our
1605 // payment logic has enough time to fail the HTLC backward before our onchain logic triggers a
1606 // channel closure (see HTLC_FAIL_BACK_BUFFER rationale).
1607 if (msg.cltv_expiry as u64) <= self.best_block.read().unwrap().height() as u64 + HTLC_FAIL_BACK_BUFFER as u64 + 1 {
1608 return_err!("The final CLTV expiry is too soon to handle", 17, &[0;0]);
1610 // final_incorrect_htlc_amount
1611 if next_hop_data.amt_to_forward > msg.amount_msat {
1612 return_err!("Upstream node sent less than we were supposed to receive in payment", 19, &byte_utils::be64_to_array(msg.amount_msat));
1614 // final_incorrect_cltv_expiry
1615 if next_hop_data.outgoing_cltv_value != msg.cltv_expiry {
1616 return_err!("Upstream node set CLTV to the wrong value", 18, &byte_utils::be32_to_array(msg.cltv_expiry));
1619 let routing = match next_hop_data.format {
1620 msgs::OnionHopDataFormat::Legacy { .. } => return_err!("We require payment_secrets", 0x4000|0x2000|3, &[0;0]),
1621 msgs::OnionHopDataFormat::NonFinalNode { .. } => return_err!("Got non final data with an HMAC of 0", 0x4000 | 22, &[0;0]),
1622 msgs::OnionHopDataFormat::FinalNode { payment_data, keysend_preimage } => {
1623 if payment_data.is_some() && keysend_preimage.is_some() {
1624 return_err!("We don't support MPP keysend payments", 0x4000|22, &[0;0]);
1625 } else if let Some(data) = payment_data {
1626 PendingHTLCRouting::Receive {
1628 incoming_cltv_expiry: msg.cltv_expiry,
1630 } else if let Some(payment_preimage) = keysend_preimage {
1631 // We need to check that the sender knows the keysend preimage before processing this
1632 // payment further. Otherwise, an intermediary routing hop forwarding non-keysend-HTLC X
1633 // could discover the final destination of X, by probing the adjacent nodes on the route
1634 // with a keysend payment of identical payment hash to X and observing the processing
1635 // time discrepancies due to a hash collision with X.
1636 let hashed_preimage = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
1637 if hashed_preimage != msg.payment_hash {
1638 return_err!("Payment preimage didn't match payment hash", 0x4000|22, &[0;0]);
1641 PendingHTLCRouting::ReceiveKeysend {
1643 incoming_cltv_expiry: msg.cltv_expiry,
1646 return_err!("We require payment_secrets", 0x4000|0x2000|3, &[0;0]);
1651 // Note that we could obviously respond immediately with an update_fulfill_htlc
1652 // message, however that would leak that we are the recipient of this payment, so
1653 // instead we stay symmetric with the forwarding case, only responding (after a
1654 // delay) once they've send us a commitment_signed!
1656 PendingHTLCStatus::Forward(PendingHTLCInfo {
1658 payment_hash: msg.payment_hash.clone(),
1659 incoming_shared_secret: shared_secret,
1660 amt_to_forward: next_hop_data.amt_to_forward,
1661 outgoing_cltv_value: next_hop_data.outgoing_cltv_value,
1664 let mut new_packet_data = [0; 20*65];
1665 let read_pos = chacha_stream.read(&mut new_packet_data).unwrap();
1666 #[cfg(debug_assertions)]
1668 // Check two things:
1669 // a) that the behavior of our stream here will return Ok(0) even if the TLV
1670 // read above emptied out our buffer and the unwrap() wont needlessly panic
1671 // b) that we didn't somehow magically end up with extra data.
1673 debug_assert!(chacha_stream.read(&mut t).unwrap() == 0);
1675 // Once we've emptied the set of bytes our peer gave us, encrypt 0 bytes until we
1676 // fill the onion hop data we'll forward to our next-hop peer.
1677 chacha_stream.chacha.process_in_place(&mut new_packet_data[read_pos..]);
1679 let mut new_pubkey = msg.onion_routing_packet.public_key.unwrap();
1681 let blinding_factor = {
1682 let mut sha = Sha256::engine();
1683 sha.input(&new_pubkey.serialize()[..]);
1684 sha.input(&shared_secret);
1685 Sha256::from_engine(sha).into_inner()
1688 let public_key = if let Err(e) = new_pubkey.mul_assign(&self.secp_ctx, &blinding_factor[..]) {
1690 } else { Ok(new_pubkey) };
1692 let outgoing_packet = msgs::OnionPacket {
1695 hop_data: new_packet_data,
1696 hmac: next_hop_hmac.clone(),
1699 let short_channel_id = match next_hop_data.format {
1700 msgs::OnionHopDataFormat::Legacy { short_channel_id } => short_channel_id,
1701 msgs::OnionHopDataFormat::NonFinalNode { short_channel_id } => short_channel_id,
1702 msgs::OnionHopDataFormat::FinalNode { .. } => {
1703 return_err!("Final Node OnionHopData provided for us as an intermediary node", 0x4000 | 22, &[0;0]);
1707 PendingHTLCStatus::Forward(PendingHTLCInfo {
1708 routing: PendingHTLCRouting::Forward {
1709 onion_packet: outgoing_packet,
1712 payment_hash: msg.payment_hash.clone(),
1713 incoming_shared_secret: shared_secret,
1714 amt_to_forward: next_hop_data.amt_to_forward,
1715 outgoing_cltv_value: next_hop_data.outgoing_cltv_value,
1719 channel_state = Some(self.channel_state.lock().unwrap());
1720 if let &PendingHTLCStatus::Forward(PendingHTLCInfo { ref routing, ref amt_to_forward, ref outgoing_cltv_value, .. }) = &pending_forward_info {
1721 // If short_channel_id is 0 here, we'll reject the HTLC as there cannot be a channel
1722 // with a short_channel_id of 0. This is important as various things later assume
1723 // short_channel_id is non-0 in any ::Forward.
1724 if let &PendingHTLCRouting::Forward { ref short_channel_id, .. } = routing {
1725 let id_option = channel_state.as_ref().unwrap().short_to_id.get(&short_channel_id).cloned();
1726 if let Some((err, code, chan_update)) = loop {
1727 let forwarding_id = match id_option {
1728 None => { // unknown_next_peer
1729 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
1731 Some(id) => id.clone(),
1734 let chan = channel_state.as_mut().unwrap().by_id.get_mut(&forwarding_id).unwrap();
1736 if !chan.should_announce() && !self.default_configuration.accept_forwards_to_priv_channels {
1737 // Note that the behavior here should be identical to the above block - we
1738 // should NOT reveal the existence or non-existence of a private channel if
1739 // we don't allow forwards outbound over them.
1740 break Some(("Don't have available channel for forwarding as requested.", 0x4000 | 10, None));
1743 // Note that we could technically not return an error yet here and just hope
1744 // that the connection is reestablished or monitor updated by the time we get
1745 // around to doing the actual forward, but better to fail early if we can and
1746 // hopefully an attacker trying to path-trace payments cannot make this occur
1747 // on a small/per-node/per-channel scale.
1748 if !chan.is_live() { // channel_disabled
1749 break Some(("Forwarding channel is not in a ready state.", 0x1000 | 20, Some(self.get_channel_update_for_unicast(chan).unwrap())));
1751 if *amt_to_forward < chan.get_counterparty_htlc_minimum_msat() { // amount_below_minimum
1752 break Some(("HTLC amount was below the htlc_minimum_msat", 0x1000 | 11, Some(self.get_channel_update_for_unicast(chan).unwrap())));
1754 let fee = amt_to_forward.checked_mul(chan.get_fee_proportional_millionths() as u64)
1755 .and_then(|prop_fee| { (prop_fee / 1000000)
1756 .checked_add(chan.get_outbound_forwarding_fee_base_msat() as u64) });
1757 if fee.is_none() || msg.amount_msat < fee.unwrap() || (msg.amount_msat - fee.unwrap()) < *amt_to_forward { // fee_insufficient
1758 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())));
1760 if (msg.cltv_expiry as u64) < (*outgoing_cltv_value) as u64 + chan.get_cltv_expiry_delta() as u64 { // incorrect_cltv_expiry
1761 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())));
1763 let cur_height = self.best_block.read().unwrap().height() + 1;
1764 // Theoretically, channel counterparty shouldn't send us a HTLC expiring now, but we want to be robust wrt to counterparty
1765 // packet sanitization (see HTLC_FAIL_BACK_BUFFER rational)
1766 if msg.cltv_expiry <= cur_height + HTLC_FAIL_BACK_BUFFER as u32 { // expiry_too_soon
1767 break Some(("CLTV expiry is too close", 0x1000 | 14, Some(self.get_channel_update_for_unicast(chan).unwrap())));
1769 if msg.cltv_expiry > cur_height + CLTV_FAR_FAR_AWAY as u32 { // expiry_too_far
1770 break Some(("CLTV expiry is too far in the future", 21, None));
1772 // In theory, we would be safe against unintentional channel-closure, if we only required a margin of LATENCY_GRACE_PERIOD_BLOCKS.
1773 // But, to be safe against policy reception, we use a longer delay.
1774 if (*outgoing_cltv_value) as u64 <= (cur_height + HTLC_FAIL_BACK_BUFFER) as u64 {
1775 break Some(("Outgoing CLTV value is too soon", 0x1000 | 14, Some(self.get_channel_update_for_unicast(chan).unwrap())));
1781 let mut res = Vec::with_capacity(8 + 128);
1782 if let Some(chan_update) = chan_update {
1783 if code == 0x1000 | 11 || code == 0x1000 | 12 {
1784 res.extend_from_slice(&byte_utils::be64_to_array(msg.amount_msat));
1786 else if code == 0x1000 | 13 {
1787 res.extend_from_slice(&byte_utils::be32_to_array(msg.cltv_expiry));
1789 else if code == 0x1000 | 20 {
1790 // TODO: underspecified, follow https://github.com/lightningnetwork/lightning-rfc/issues/791
1791 res.extend_from_slice(&byte_utils::be16_to_array(0));
1793 res.extend_from_slice(&chan_update.encode_with_len()[..]);
1795 return_err!(err, code, &res[..]);
1800 (pending_forward_info, channel_state.unwrap())
1803 /// Gets the current channel_update for the given channel. This first checks if the channel is
1804 /// public, and thus should be called whenever the result is going to be passed out in a
1805 /// [`MessageSendEvent::BroadcastChannelUpdate`] event.
1807 /// May be called with channel_state already locked!
1808 fn get_channel_update_for_broadcast(&self, chan: &Channel<Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
1809 if !chan.should_announce() {
1810 return Err(LightningError {
1811 err: "Cannot broadcast a channel_update for a private channel".to_owned(),
1812 action: msgs::ErrorAction::IgnoreError
1815 log_trace!(self.logger, "Attempting to generate broadcast channel update for channel {}", log_bytes!(chan.channel_id()));
1816 self.get_channel_update_for_unicast(chan)
1819 /// Gets the current channel_update for the given channel. This does not check if the channel
1820 /// is public (only returning an Err if the channel does not yet have an assigned short_id),
1821 /// and thus MUST NOT be called unless the recipient of the resulting message has already
1822 /// provided evidence that they know about the existence of the channel.
1823 /// May be called with channel_state already locked!
1824 fn get_channel_update_for_unicast(&self, chan: &Channel<Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
1825 log_trace!(self.logger, "Attempting to generate channel update for channel {}", log_bytes!(chan.channel_id()));
1826 let short_channel_id = match chan.get_short_channel_id() {
1827 None => return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError}),
1831 let were_node_one = PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key).serialize()[..] < chan.get_counterparty_node_id().serialize()[..];
1833 let unsigned = msgs::UnsignedChannelUpdate {
1834 chain_hash: self.genesis_hash,
1836 timestamp: chan.get_update_time_counter(),
1837 flags: (!were_node_one) as u8 | ((!chan.is_live() as u8) << 1),
1838 cltv_expiry_delta: chan.get_cltv_expiry_delta(),
1839 htlc_minimum_msat: chan.get_counterparty_htlc_minimum_msat(),
1840 htlc_maximum_msat: OptionalField::Present(chan.get_announced_htlc_max_msat()),
1841 fee_base_msat: chan.get_outbound_forwarding_fee_base_msat(),
1842 fee_proportional_millionths: chan.get_fee_proportional_millionths(),
1843 excess_data: Vec::new(),
1846 let msg_hash = Sha256dHash::hash(&unsigned.encode()[..]);
1847 let sig = self.secp_ctx.sign(&hash_to_message!(&msg_hash[..]), &self.our_network_key);
1849 Ok(msgs::ChannelUpdate {
1855 // Only public for testing, this should otherwise never be called direcly
1856 pub(crate) fn send_payment_along_path(&self, path: &Vec<RouteHop>, payment_hash: &PaymentHash, payment_secret: &Option<PaymentSecret>, total_value: u64, cur_height: u32, mpp_id: MppId, keysend_preimage: &Option<PaymentPreimage>) -> Result<(), APIError> {
1857 log_trace!(self.logger, "Attempting to send payment for path with next hop {}", path.first().unwrap().short_channel_id);
1858 let prng_seed = self.keys_manager.get_secure_random_bytes();
1859 let session_priv_bytes = self.keys_manager.get_secure_random_bytes();
1860 let session_priv = SecretKey::from_slice(&session_priv_bytes[..]).expect("RNG is busted");
1862 let onion_keys = onion_utils::construct_onion_keys(&self.secp_ctx, &path, &session_priv)
1863 .map_err(|_| APIError::RouteError{err: "Pubkey along hop was maliciously selected"})?;
1864 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(path, total_value, payment_secret, cur_height, keysend_preimage)?;
1865 if onion_utils::route_size_insane(&onion_payloads) {
1866 return Err(APIError::RouteError{err: "Route size too large considering onion data"});
1868 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, prng_seed, payment_hash);
1870 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1871 let mut pending_outbounds = self.pending_outbound_payments.lock().unwrap();
1872 let sessions = pending_outbounds.entry(mpp_id).or_insert(HashSet::new());
1873 assert!(sessions.insert(session_priv_bytes));
1875 let err: Result<(), _> = loop {
1876 let mut channel_lock = self.channel_state.lock().unwrap();
1877 let id = match channel_lock.short_to_id.get(&path.first().unwrap().short_channel_id) {
1878 None => return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()}),
1879 Some(id) => id.clone(),
1882 let channel_state = &mut *channel_lock;
1883 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(id) {
1885 if chan.get().get_counterparty_node_id() != path.first().unwrap().pubkey {
1886 return Err(APIError::RouteError{err: "Node ID mismatch on first hop!"});
1888 if !chan.get().is_live() {
1889 return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected/pending monitor update!".to_owned()});
1891 break_chan_entry!(self, chan.get_mut().send_htlc_and_commit(htlc_msat, payment_hash.clone(), htlc_cltv, HTLCSource::OutboundRoute {
1893 session_priv: session_priv.clone(),
1894 first_hop_htlc_msat: htlc_msat,
1896 }, onion_packet, &self.logger), channel_state, chan)
1898 Some((update_add, commitment_signed, monitor_update)) => {
1899 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
1900 maybe_break_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, true);
1901 // Note that MonitorUpdateFailed here indicates (per function docs)
1902 // that we will resend the commitment update once monitor updating
1903 // is restored. Therefore, we must return an error indicating that
1904 // it is unsafe to retry the payment wholesale, which we do in the
1905 // send_payment check for MonitorUpdateFailed, below.
1906 return Err(APIError::MonitorUpdateFailed);
1909 log_debug!(self.logger, "Sending payment along path resulted in a commitment_signed for channel {}", log_bytes!(chan.get().channel_id()));
1910 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1911 node_id: path.first().unwrap().pubkey,
1912 updates: msgs::CommitmentUpdate {
1913 update_add_htlcs: vec![update_add],
1914 update_fulfill_htlcs: Vec::new(),
1915 update_fail_htlcs: Vec::new(),
1916 update_fail_malformed_htlcs: Vec::new(),
1924 } else { unreachable!(); }
1928 match handle_error!(self, err, path.first().unwrap().pubkey) {
1929 Ok(_) => unreachable!(),
1931 Err(APIError::ChannelUnavailable { err: e.err })
1936 /// Sends a payment along a given route.
1938 /// Value parameters are provided via the last hop in route, see documentation for RouteHop
1939 /// fields for more info.
1941 /// Note that if the payment_hash already exists elsewhere (eg you're sending a duplicative
1942 /// payment), we don't do anything to stop you! We always try to ensure that if the provided
1943 /// next hop knows the preimage to payment_hash they can claim an additional amount as
1944 /// specified in the last hop in the route! Thus, you should probably do your own
1945 /// payment_preimage tracking (which you should already be doing as they represent "proof of
1946 /// payment") and prevent double-sends yourself.
1948 /// May generate SendHTLCs message(s) event on success, which should be relayed.
1950 /// Each path may have a different return value, and PaymentSendValue may return a Vec with
1951 /// each entry matching the corresponding-index entry in the route paths, see
1952 /// PaymentSendFailure for more info.
1954 /// In general, a path may raise:
1955 /// * APIError::RouteError when an invalid route or forwarding parameter (cltv_delta, fee,
1956 /// node public key) is specified.
1957 /// * APIError::ChannelUnavailable if the next-hop channel is not available for updates
1958 /// (including due to previous monitor update failure or new permanent monitor update
1960 /// * APIError::MonitorUpdateFailed if a new monitor update failure prevented sending the
1961 /// relevant updates.
1963 /// Note that depending on the type of the PaymentSendFailure the HTLC may have been
1964 /// irrevocably committed to on our end. In such a case, do NOT retry the payment with a
1965 /// different route unless you intend to pay twice!
1967 /// payment_secret is unrelated to payment_hash (or PaymentPreimage) and exists to authenticate
1968 /// the sender to the recipient and prevent payment-probing (deanonymization) attacks. For
1969 /// newer nodes, it will be provided to you in the invoice. If you do not have one, the Route
1970 /// must not contain multiple paths as multi-path payments require a recipient-provided
1972 /// If a payment_secret *is* provided, we assume that the invoice had the payment_secret feature
1973 /// bit set (either as required or as available). If multiple paths are present in the Route,
1974 /// we assume the invoice had the basic_mpp feature set.
1975 pub fn send_payment(&self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>) -> Result<(), PaymentSendFailure> {
1976 self.send_payment_internal(route, payment_hash, payment_secret, None)
1979 fn send_payment_internal(&self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>, keysend_preimage: Option<PaymentPreimage>) -> Result<(), PaymentSendFailure> {
1980 if route.paths.len() < 1 {
1981 return Err(PaymentSendFailure::ParameterError(APIError::RouteError{err: "There must be at least one path to send over"}));
1983 if route.paths.len() > 10 {
1984 // This limit is completely arbitrary - there aren't any real fundamental path-count
1985 // limits. After we support retrying individual paths we should likely bump this, but
1986 // for now more than 10 paths likely carries too much one-path failure.
1987 return Err(PaymentSendFailure::ParameterError(APIError::RouteError{err: "Sending over more than 10 paths is not currently supported"}));
1989 if payment_secret.is_none() && route.paths.len() > 1 {
1990 return Err(PaymentSendFailure::ParameterError(APIError::APIMisuseError{err: "Payment secret is required for multi-path payments".to_string()}));
1992 let mut total_value = 0;
1993 let our_node_id = self.get_our_node_id();
1994 let mut path_errs = Vec::with_capacity(route.paths.len());
1995 let mpp_id = MppId(self.keys_manager.get_secure_random_bytes());
1996 'path_check: for path in route.paths.iter() {
1997 if path.len() < 1 || path.len() > 20 {
1998 path_errs.push(Err(APIError::RouteError{err: "Path didn't go anywhere/had bogus size"}));
1999 continue 'path_check;
2001 for (idx, hop) in path.iter().enumerate() {
2002 if idx != path.len() - 1 && hop.pubkey == our_node_id {
2003 path_errs.push(Err(APIError::RouteError{err: "Path went through us but wasn't a simple rebalance loop to us"}));
2004 continue 'path_check;
2007 total_value += path.last().unwrap().fee_msat;
2008 path_errs.push(Ok(()));
2010 if path_errs.iter().any(|e| e.is_err()) {
2011 return Err(PaymentSendFailure::PathParameterError(path_errs));
2014 let cur_height = self.best_block.read().unwrap().height() + 1;
2015 let mut results = Vec::new();
2016 for path in route.paths.iter() {
2017 results.push(self.send_payment_along_path(&path, &payment_hash, payment_secret, total_value, cur_height, mpp_id, &keysend_preimage));
2019 let mut has_ok = false;
2020 let mut has_err = false;
2021 for res in results.iter() {
2022 if res.is_ok() { has_ok = true; }
2023 if res.is_err() { has_err = true; }
2024 if let &Err(APIError::MonitorUpdateFailed) = res {
2025 // MonitorUpdateFailed is inherently unsafe to retry, so we call it a
2032 if has_err && has_ok {
2033 Err(PaymentSendFailure::PartialFailure(results))
2035 Err(PaymentSendFailure::AllFailedRetrySafe(results.drain(..).map(|r| r.unwrap_err()).collect()))
2041 /// Send a spontaneous payment, which is a payment that does not require the recipient to have
2042 /// generated an invoice. Optionally, you may specify the preimage. If you do choose to specify
2043 /// the preimage, it must be a cryptographically secure random value that no intermediate node
2044 /// would be able to guess -- otherwise, an intermediate node may claim the payment and it will
2045 /// never reach the recipient.
2047 /// See [`send_payment`] documentation for more details on the return value of this function.
2049 /// Similar to regular payments, you MUST NOT reuse a `payment_preimage` value. See
2050 /// [`send_payment`] for more information about the risks of duplicate preimage usage.
2052 /// Note that `route` must have exactly one path.
2054 /// [`send_payment`]: Self::send_payment
2055 pub fn send_spontaneous_payment(&self, route: &Route, payment_preimage: Option<PaymentPreimage>) -> Result<PaymentHash, PaymentSendFailure> {
2056 let preimage = match payment_preimage {
2058 None => PaymentPreimage(self.keys_manager.get_secure_random_bytes()),
2060 let payment_hash = PaymentHash(Sha256::hash(&preimage.0).into_inner());
2061 match self.send_payment_internal(route, payment_hash, &None, Some(preimage)) {
2062 Ok(()) => Ok(payment_hash),
2067 /// Handles the generation of a funding transaction, optionally (for tests) with a function
2068 /// which checks the correctness of the funding transaction given the associated channel.
2069 fn funding_transaction_generated_intern<FundingOutput: Fn(&Channel<Signer>, &Transaction) -> Result<OutPoint, APIError>>
2070 (&self, temporary_channel_id: &[u8; 32], funding_transaction: Transaction, find_funding_output: FundingOutput) -> Result<(), APIError> {
2072 let (res, chan) = match self.channel_state.lock().unwrap().by_id.remove(temporary_channel_id) {
2074 let funding_txo = find_funding_output(&chan, &funding_transaction)?;
2076 (chan.get_outbound_funding_created(funding_transaction, funding_txo, &self.logger)
2077 .map_err(|e| if let ChannelError::Close(msg) = e {
2078 MsgHandleErrInternal::from_finish_shutdown(msg, chan.channel_id(), chan.force_shutdown(true), None)
2079 } else { unreachable!(); })
2082 None => { return Err(APIError::ChannelUnavailable { err: "No such channel".to_owned() }) },
2084 match handle_error!(self, res, chan.get_counterparty_node_id()) {
2085 Ok(funding_msg) => {
2088 Err(_) => { return Err(APIError::ChannelUnavailable {
2089 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()
2094 let mut channel_state = self.channel_state.lock().unwrap();
2095 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
2096 node_id: chan.get_counterparty_node_id(),
2099 match channel_state.by_id.entry(chan.channel_id()) {
2100 hash_map::Entry::Occupied(_) => {
2101 panic!("Generated duplicate funding txid?");
2103 hash_map::Entry::Vacant(e) => {
2111 pub(crate) fn funding_transaction_generated_unchecked(&self, temporary_channel_id: &[u8; 32], funding_transaction: Transaction, output_index: u16) -> Result<(), APIError> {
2112 self.funding_transaction_generated_intern(temporary_channel_id, funding_transaction, |_, tx| {
2113 Ok(OutPoint { txid: tx.txid(), index: output_index })
2117 /// Call this upon creation of a funding transaction for the given channel.
2119 /// Returns an [`APIError::APIMisuseError`] if the funding_transaction spent non-SegWit outputs
2120 /// or if no output was found which matches the parameters in [`Event::FundingGenerationReady`].
2122 /// Panics if a funding transaction has already been provided for this channel.
2124 /// May panic if the output found in the funding transaction is duplicative with some other
2125 /// channel (note that this should be trivially prevented by using unique funding transaction
2126 /// keys per-channel).
2128 /// Do NOT broadcast the funding transaction yourself. When we have safely received our
2129 /// counterparty's signature the funding transaction will automatically be broadcast via the
2130 /// [`BroadcasterInterface`] provided when this `ChannelManager` was constructed.
2132 /// Note that this includes RBF or similar transaction replacement strategies - lightning does
2133 /// not currently support replacing a funding transaction on an existing channel. Instead,
2134 /// create a new channel with a conflicting funding transaction.
2136 /// [`Event::FundingGenerationReady`]: crate::util::events::Event::FundingGenerationReady
2137 pub fn funding_transaction_generated(&self, temporary_channel_id: &[u8; 32], funding_transaction: Transaction) -> Result<(), APIError> {
2138 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2140 for inp in funding_transaction.input.iter() {
2141 if inp.witness.is_empty() {
2142 return Err(APIError::APIMisuseError {
2143 err: "Funding transaction must be fully signed and spend Segwit outputs".to_owned()
2147 self.funding_transaction_generated_intern(temporary_channel_id, funding_transaction, |chan, tx| {
2148 let mut output_index = None;
2149 let expected_spk = chan.get_funding_redeemscript().to_v0_p2wsh();
2150 for (idx, outp) in tx.output.iter().enumerate() {
2151 if outp.script_pubkey == expected_spk && outp.value == chan.get_value_satoshis() {
2152 if output_index.is_some() {
2153 return Err(APIError::APIMisuseError {
2154 err: "Multiple outputs matched the expected script and value".to_owned()
2157 if idx > u16::max_value() as usize {
2158 return Err(APIError::APIMisuseError {
2159 err: "Transaction had more than 2^16 outputs, which is not supported".to_owned()
2162 output_index = Some(idx as u16);
2165 if output_index.is_none() {
2166 return Err(APIError::APIMisuseError {
2167 err: "No output matched the script_pubkey and value in the FundingGenerationReady event".to_owned()
2170 Ok(OutPoint { txid: tx.txid(), index: output_index.unwrap() })
2174 fn get_announcement_sigs(&self, chan: &Channel<Signer>) -> Option<msgs::AnnouncementSignatures> {
2175 if !chan.should_announce() {
2176 log_trace!(self.logger, "Can't send announcement_signatures for private channel {}", log_bytes!(chan.channel_id()));
2180 let (announcement, our_bitcoin_sig) = match chan.get_channel_announcement(self.get_our_node_id(), self.genesis_hash.clone()) {
2182 Err(_) => return None, // Only in case of state precondition violations eg channel is closing
2184 let msghash = hash_to_message!(&Sha256dHash::hash(&announcement.encode()[..])[..]);
2185 let our_node_sig = self.secp_ctx.sign(&msghash, &self.our_network_key);
2187 Some(msgs::AnnouncementSignatures {
2188 channel_id: chan.channel_id(),
2189 short_channel_id: chan.get_short_channel_id().unwrap(),
2190 node_signature: our_node_sig,
2191 bitcoin_signature: our_bitcoin_sig,
2196 // Messages of up to 64KB should never end up more than half full with addresses, as that would
2197 // be absurd. We ensure this by checking that at least 500 (our stated public contract on when
2198 // broadcast_node_announcement panics) of the maximum-length addresses would fit in a 64KB
2200 const HALF_MESSAGE_IS_ADDRS: u32 = ::core::u16::MAX as u32 / (NetAddress::MAX_LEN as u32 + 1) / 2;
2203 // ...by failing to compile if the number of addresses that would be half of a message is
2204 // smaller than 500:
2205 const STATIC_ASSERT: u32 = Self::HALF_MESSAGE_IS_ADDRS - 500;
2207 /// Regenerates channel_announcements and generates a signed node_announcement from the given
2208 /// arguments, providing them in corresponding events via
2209 /// [`get_and_clear_pending_msg_events`], if at least one public channel has been confirmed
2210 /// on-chain. This effectively re-broadcasts all channel announcements and sends our node
2211 /// announcement to ensure that the lightning P2P network is aware of the channels we have and
2212 /// our network addresses.
2214 /// `rgb` is a node "color" and `alias` is a printable human-readable string to describe this
2215 /// node to humans. They carry no in-protocol meaning.
2217 /// `addresses` represent the set (possibly empty) of socket addresses on which this node
2218 /// accepts incoming connections. These will be included in the node_announcement, publicly
2219 /// tying these addresses together and to this node. If you wish to preserve user privacy,
2220 /// addresses should likely contain only Tor Onion addresses.
2222 /// Panics if `addresses` is absurdly large (more than 500).
2224 /// [`get_and_clear_pending_msg_events`]: MessageSendEventsProvider::get_and_clear_pending_msg_events
2225 pub fn broadcast_node_announcement(&self, rgb: [u8; 3], alias: [u8; 32], mut addresses: Vec<NetAddress>) {
2226 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2228 if addresses.len() > 500 {
2229 panic!("More than half the message size was taken up by public addresses!");
2232 // While all existing nodes handle unsorted addresses just fine, the spec requires that
2233 // addresses be sorted for future compatibility.
2234 addresses.sort_by_key(|addr| addr.get_id());
2236 let announcement = msgs::UnsignedNodeAnnouncement {
2237 features: NodeFeatures::known(),
2238 timestamp: self.last_node_announcement_serial.fetch_add(1, Ordering::AcqRel) as u32,
2239 node_id: self.get_our_node_id(),
2240 rgb, alias, addresses,
2241 excess_address_data: Vec::new(),
2242 excess_data: Vec::new(),
2244 let msghash = hash_to_message!(&Sha256dHash::hash(&announcement.encode()[..])[..]);
2245 let node_announce_sig = self.secp_ctx.sign(&msghash, &self.our_network_key);
2247 let mut channel_state_lock = self.channel_state.lock().unwrap();
2248 let channel_state = &mut *channel_state_lock;
2250 let mut announced_chans = false;
2251 for (_, chan) in channel_state.by_id.iter() {
2252 if let Some(msg) = chan.get_signed_channel_announcement(&self.our_network_key, self.get_our_node_id(), self.genesis_hash.clone()) {
2253 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
2255 update_msg: match self.get_channel_update_for_broadcast(chan) {
2260 announced_chans = true;
2262 // If the channel is not public or has not yet reached funding_locked, check the
2263 // next channel. If we don't yet have any public channels, we'll skip the broadcast
2264 // below as peers may not accept it without channels on chain first.
2268 if announced_chans {
2269 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastNodeAnnouncement {
2270 msg: msgs::NodeAnnouncement {
2271 signature: node_announce_sig,
2272 contents: announcement
2278 /// Processes HTLCs which are pending waiting on random forward delay.
2280 /// Should only really ever be called in response to a PendingHTLCsForwardable event.
2281 /// Will likely generate further events.
2282 pub fn process_pending_htlc_forwards(&self) {
2283 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2285 let mut new_events = Vec::new();
2286 let mut failed_forwards = Vec::new();
2287 let mut handle_errors = Vec::new();
2289 let mut channel_state_lock = self.channel_state.lock().unwrap();
2290 let channel_state = &mut *channel_state_lock;
2292 for (short_chan_id, mut pending_forwards) in channel_state.forward_htlcs.drain() {
2293 if short_chan_id != 0 {
2294 let forward_chan_id = match channel_state.short_to_id.get(&short_chan_id) {
2295 Some(chan_id) => chan_id.clone(),
2297 failed_forwards.reserve(pending_forwards.len());
2298 for forward_info in pending_forwards.drain(..) {
2299 match forward_info {
2300 HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info,
2301 prev_funding_outpoint } => {
2302 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
2303 short_channel_id: prev_short_channel_id,
2304 outpoint: prev_funding_outpoint,
2305 htlc_id: prev_htlc_id,
2306 incoming_packet_shared_secret: forward_info.incoming_shared_secret,
2308 failed_forwards.push((htlc_source, forward_info.payment_hash,
2309 HTLCFailReason::Reason { failure_code: 0x4000 | 10, data: Vec::new() }
2312 HTLCForwardInfo::FailHTLC { .. } => {
2313 // Channel went away before we could fail it. This implies
2314 // the channel is now on chain and our counterparty is
2315 // trying to broadcast the HTLC-Timeout, but that's their
2316 // problem, not ours.
2323 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(forward_chan_id) {
2324 let mut add_htlc_msgs = Vec::new();
2325 let mut fail_htlc_msgs = Vec::new();
2326 for forward_info in pending_forwards.drain(..) {
2327 match forward_info {
2328 HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info: PendingHTLCInfo {
2329 routing: PendingHTLCRouting::Forward {
2331 }, incoming_shared_secret, payment_hash, amt_to_forward, outgoing_cltv_value },
2332 prev_funding_outpoint } => {
2333 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);
2334 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
2335 short_channel_id: prev_short_channel_id,
2336 outpoint: prev_funding_outpoint,
2337 htlc_id: prev_htlc_id,
2338 incoming_packet_shared_secret: incoming_shared_secret,
2340 match chan.get_mut().send_htlc(amt_to_forward, payment_hash, outgoing_cltv_value, htlc_source.clone(), onion_packet) {
2342 if let ChannelError::Ignore(msg) = e {
2343 log_trace!(self.logger, "Failed to forward HTLC with payment_hash {}: {}", log_bytes!(payment_hash.0), msg);
2345 panic!("Stated return value requirements in send_htlc() were not met");
2347 let chan_update = self.get_channel_update_for_unicast(chan.get()).unwrap();
2348 failed_forwards.push((htlc_source, payment_hash,
2349 HTLCFailReason::Reason { failure_code: 0x1000 | 7, data: chan_update.encode_with_len() }
2355 Some(msg) => { add_htlc_msgs.push(msg); },
2357 // Nothing to do here...we're waiting on a remote
2358 // revoke_and_ack before we can add anymore HTLCs. The Channel
2359 // will automatically handle building the update_add_htlc and
2360 // commitment_signed messages when we can.
2361 // TODO: Do some kind of timer to set the channel as !is_live()
2362 // as we don't really want others relying on us relaying through
2363 // this channel currently :/.
2369 HTLCForwardInfo::AddHTLC { .. } => {
2370 panic!("short_channel_id != 0 should imply any pending_forward entries are of type Forward");
2372 HTLCForwardInfo::FailHTLC { htlc_id, err_packet } => {
2373 log_trace!(self.logger, "Failing HTLC back to channel with short id {} (backward HTLC ID {}) after delay", short_chan_id, htlc_id);
2374 match chan.get_mut().get_update_fail_htlc(htlc_id, err_packet, &self.logger) {
2376 if let ChannelError::Ignore(msg) = e {
2377 log_trace!(self.logger, "Failed to fail HTLC with ID {} backwards to short_id {}: {}", htlc_id, short_chan_id, msg);
2379 panic!("Stated return value requirements in get_update_fail_htlc() were not met");
2381 // fail-backs are best-effort, we probably already have one
2382 // pending, and if not that's OK, if not, the channel is on
2383 // the chain and sending the HTLC-Timeout is their problem.
2386 Ok(Some(msg)) => { fail_htlc_msgs.push(msg); },
2388 // Nothing to do here...we're waiting on a remote
2389 // revoke_and_ack before we can update the commitment
2390 // transaction. The Channel will automatically handle
2391 // building the update_fail_htlc and commitment_signed
2392 // messages when we can.
2393 // We don't need any kind of timer here as they should fail
2394 // the channel onto the chain if they can't get our
2395 // update_fail_htlc in time, it's not our problem.
2402 if !add_htlc_msgs.is_empty() || !fail_htlc_msgs.is_empty() {
2403 let (commitment_msg, monitor_update) = match chan.get_mut().send_commitment(&self.logger) {
2406 // We surely failed send_commitment due to bad keys, in that case
2407 // close channel and then send error message to peer.
2408 let counterparty_node_id = chan.get().get_counterparty_node_id();
2409 let err: Result<(), _> = match e {
2410 ChannelError::Ignore(_) | ChannelError::Warn(_) => {
2411 panic!("Stated return value requirements in send_commitment() were not met");
2413 ChannelError::Close(msg) => {
2414 log_trace!(self.logger, "Closing channel {} due to Close-required error: {}", log_bytes!(chan.key()[..]), msg);
2415 let (channel_id, mut channel) = chan.remove_entry();
2416 if let Some(short_id) = channel.get_short_channel_id() {
2417 channel_state.short_to_id.remove(&short_id);
2419 Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, channel.force_shutdown(true), self.get_channel_update_for_broadcast(&channel).ok()))
2421 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"); }
2423 handle_errors.push((counterparty_node_id, err));
2427 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
2428 handle_errors.push((chan.get().get_counterparty_node_id(), handle_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, true)));
2431 log_debug!(self.logger, "Forwarding HTLCs resulted in a commitment update with {} HTLCs added and {} HTLCs failed for channel {}",
2432 add_htlc_msgs.len(), fail_htlc_msgs.len(), log_bytes!(chan.get().channel_id()));
2433 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2434 node_id: chan.get().get_counterparty_node_id(),
2435 updates: msgs::CommitmentUpdate {
2436 update_add_htlcs: add_htlc_msgs,
2437 update_fulfill_htlcs: Vec::new(),
2438 update_fail_htlcs: fail_htlc_msgs,
2439 update_fail_malformed_htlcs: Vec::new(),
2441 commitment_signed: commitment_msg,
2449 for forward_info in pending_forwards.drain(..) {
2450 match forward_info {
2451 HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info: PendingHTLCInfo {
2452 routing, incoming_shared_secret, payment_hash, amt_to_forward, .. },
2453 prev_funding_outpoint } => {
2454 let (cltv_expiry, onion_payload) = match routing {
2455 PendingHTLCRouting::Receive { payment_data, incoming_cltv_expiry } =>
2456 (incoming_cltv_expiry, OnionPayload::Invoice(payment_data)),
2457 PendingHTLCRouting::ReceiveKeysend { payment_preimage, incoming_cltv_expiry } =>
2458 (incoming_cltv_expiry, OnionPayload::Spontaneous(payment_preimage)),
2460 panic!("short_channel_id == 0 should imply any pending_forward entries are of type Receive");
2463 let claimable_htlc = ClaimableHTLC {
2464 prev_hop: HTLCPreviousHopData {
2465 short_channel_id: prev_short_channel_id,
2466 outpoint: prev_funding_outpoint,
2467 htlc_id: prev_htlc_id,
2468 incoming_packet_shared_secret: incoming_shared_secret,
2470 value: amt_to_forward,
2475 macro_rules! fail_htlc {
2477 let mut htlc_msat_height_data = byte_utils::be64_to_array($htlc.value).to_vec();
2478 htlc_msat_height_data.extend_from_slice(
2479 &byte_utils::be32_to_array(self.best_block.read().unwrap().height()),
2481 failed_forwards.push((HTLCSource::PreviousHopData(HTLCPreviousHopData {
2482 short_channel_id: $htlc.prev_hop.short_channel_id,
2483 outpoint: prev_funding_outpoint,
2484 htlc_id: $htlc.prev_hop.htlc_id,
2485 incoming_packet_shared_secret: $htlc.prev_hop.incoming_packet_shared_secret,
2487 HTLCFailReason::Reason { failure_code: 0x4000 | 15, data: htlc_msat_height_data }
2492 // Check that the payment hash and secret are known. Note that we
2493 // MUST take care to handle the "unknown payment hash" and
2494 // "incorrect payment secret" cases here identically or we'd expose
2495 // that we are the ultimate recipient of the given payment hash.
2496 // Further, we must not expose whether we have any other HTLCs
2497 // associated with the same payment_hash pending or not.
2498 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
2499 match payment_secrets.entry(payment_hash) {
2500 hash_map::Entry::Vacant(_) => {
2501 match claimable_htlc.onion_payload {
2502 OnionPayload::Invoice(_) => {
2503 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as we didn't have a corresponding inbound payment.", log_bytes!(payment_hash.0));
2504 fail_htlc!(claimable_htlc);
2506 OnionPayload::Spontaneous(preimage) => {
2507 match channel_state.claimable_htlcs.entry(payment_hash) {
2508 hash_map::Entry::Vacant(e) => {
2509 e.insert(vec![claimable_htlc]);
2510 new_events.push(events::Event::PaymentReceived {
2512 amt: amt_to_forward,
2513 purpose: events::PaymentPurpose::SpontaneousPayment(preimage),
2516 hash_map::Entry::Occupied(_) => {
2517 log_trace!(self.logger, "Failing new keysend HTLC with payment_hash {} for a duplicative payment hash", log_bytes!(payment_hash.0));
2518 fail_htlc!(claimable_htlc);
2524 hash_map::Entry::Occupied(inbound_payment) => {
2526 if let OnionPayload::Invoice(ref data) = claimable_htlc.onion_payload {
2529 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));
2530 fail_htlc!(claimable_htlc);
2533 if inbound_payment.get().payment_secret != payment_data.payment_secret {
2534 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our expected payment secret.", log_bytes!(payment_hash.0));
2535 fail_htlc!(claimable_htlc);
2536 } else if inbound_payment.get().min_value_msat.is_some() && payment_data.total_msat < inbound_payment.get().min_value_msat.unwrap() {
2537 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our minimum value (had {}, needed {}).",
2538 log_bytes!(payment_hash.0), payment_data.total_msat, inbound_payment.get().min_value_msat.unwrap());
2539 fail_htlc!(claimable_htlc);
2541 let mut total_value = 0;
2542 let htlcs = channel_state.claimable_htlcs.entry(payment_hash)
2543 .or_insert(Vec::new());
2544 if htlcs.len() == 1 {
2545 if let OnionPayload::Spontaneous(_) = htlcs[0].onion_payload {
2546 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));
2547 fail_htlc!(claimable_htlc);
2551 htlcs.push(claimable_htlc);
2552 for htlc in htlcs.iter() {
2553 total_value += htlc.value;
2554 match &htlc.onion_payload {
2555 OnionPayload::Invoice(htlc_payment_data) => {
2556 if htlc_payment_data.total_msat != payment_data.total_msat {
2557 log_trace!(self.logger, "Failing HTLCs with payment_hash {} as the HTLCs had inconsistent total values (eg {} and {})",
2558 log_bytes!(payment_hash.0), payment_data.total_msat, htlc_payment_data.total_msat);
2559 total_value = msgs::MAX_VALUE_MSAT;
2561 if total_value >= msgs::MAX_VALUE_MSAT { break; }
2563 _ => unreachable!(),
2566 if total_value >= msgs::MAX_VALUE_MSAT || total_value > payment_data.total_msat {
2567 log_trace!(self.logger, "Failing HTLCs with payment_hash {} as the total value {} ran over expected value {} (or HTLCs were inconsistent)",
2568 log_bytes!(payment_hash.0), total_value, payment_data.total_msat);
2569 for htlc in htlcs.iter() {
2572 } else if total_value == payment_data.total_msat {
2573 new_events.push(events::Event::PaymentReceived {
2575 purpose: events::PaymentPurpose::InvoicePayment {
2576 payment_preimage: inbound_payment.get().payment_preimage,
2577 payment_secret: payment_data.payment_secret,
2578 user_payment_id: inbound_payment.get().user_payment_id,
2582 // Only ever generate at most one PaymentReceived
2583 // per registered payment_hash, even if it isn't
2585 inbound_payment.remove_entry();
2587 // Nothing to do - we haven't reached the total
2588 // payment value yet, wait until we receive more
2595 HTLCForwardInfo::FailHTLC { .. } => {
2596 panic!("Got pending fail of our own HTLC");
2604 for (htlc_source, payment_hash, failure_reason) in failed_forwards.drain(..) {
2605 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source, &payment_hash, failure_reason);
2608 for (counterparty_node_id, err) in handle_errors.drain(..) {
2609 let _ = handle_error!(self, err, counterparty_node_id);
2612 if new_events.is_empty() { return }
2613 let mut events = self.pending_events.lock().unwrap();
2614 events.append(&mut new_events);
2617 /// Free the background events, generally called from timer_tick_occurred.
2619 /// Exposed for testing to allow us to process events quickly without generating accidental
2620 /// BroadcastChannelUpdate events in timer_tick_occurred.
2622 /// Expects the caller to have a total_consistency_lock read lock.
2623 fn process_background_events(&self) -> bool {
2624 let mut background_events = Vec::new();
2625 mem::swap(&mut *self.pending_background_events.lock().unwrap(), &mut background_events);
2626 if background_events.is_empty() {
2630 for event in background_events.drain(..) {
2632 BackgroundEvent::ClosingMonitorUpdate((funding_txo, update)) => {
2633 // The channel has already been closed, so no use bothering to care about the
2634 // monitor updating completing.
2635 let _ = self.chain_monitor.update_channel(funding_txo, update);
2642 #[cfg(any(test, feature = "_test_utils"))]
2643 /// Process background events, for functional testing
2644 pub fn test_process_background_events(&self) {
2645 self.process_background_events();
2648 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>) {
2649 if !chan.is_outbound() { return (true, NotifyOption::SkipPersist, Ok(())); }
2650 // If the feerate has decreased by less than half, don't bother
2651 if new_feerate <= chan.get_feerate() && new_feerate * 2 > chan.get_feerate() {
2652 log_trace!(self.logger, "Channel {} does not qualify for a feerate change from {} to {}.",
2653 log_bytes!(chan_id[..]), chan.get_feerate(), new_feerate);
2654 return (true, NotifyOption::SkipPersist, Ok(()));
2656 if !chan.is_live() {
2657 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).",
2658 log_bytes!(chan_id[..]), chan.get_feerate(), new_feerate);
2659 return (true, NotifyOption::SkipPersist, Ok(()));
2661 log_trace!(self.logger, "Channel {} qualifies for a feerate change from {} to {}.",
2662 log_bytes!(chan_id[..]), chan.get_feerate(), new_feerate);
2664 let mut retain_channel = true;
2665 let res = match chan.send_update_fee_and_commit(new_feerate, &self.logger) {
2668 let (drop, res) = convert_chan_err!(self, e, short_to_id, chan, chan_id);
2669 if drop { retain_channel = false; }
2673 let ret_err = match res {
2674 Ok(Some((update_fee, commitment_signed, monitor_update))) => {
2675 if let Err(e) = self.chain_monitor.update_channel(chan.get_funding_txo().unwrap(), monitor_update) {
2676 let (res, drop) = handle_monitor_err!(self, e, short_to_id, chan, RAACommitmentOrder::CommitmentFirst, false, true, Vec::new(), Vec::new(), chan_id);
2677 if drop { retain_channel = false; }
2680 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2681 node_id: chan.get_counterparty_node_id(),
2682 updates: msgs::CommitmentUpdate {
2683 update_add_htlcs: Vec::new(),
2684 update_fulfill_htlcs: Vec::new(),
2685 update_fail_htlcs: Vec::new(),
2686 update_fail_malformed_htlcs: Vec::new(),
2687 update_fee: Some(update_fee),
2697 (retain_channel, NotifyOption::DoPersist, ret_err)
2701 /// In chanmon_consistency we want to sometimes do the channel fee updates done in
2702 /// timer_tick_occurred, but we can't generate the disabled channel updates as it considers
2703 /// these a fuzz failure (as they usually indicate a channel force-close, which is exactly what
2704 /// it wants to detect). Thus, we have a variant exposed here for its benefit.
2705 pub fn maybe_update_chan_fees(&self) {
2706 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
2707 let mut should_persist = NotifyOption::SkipPersist;
2709 let new_feerate = self.fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
2711 let mut handle_errors = Vec::new();
2713 let mut channel_state_lock = self.channel_state.lock().unwrap();
2714 let channel_state = &mut *channel_state_lock;
2715 let pending_msg_events = &mut channel_state.pending_msg_events;
2716 let short_to_id = &mut channel_state.short_to_id;
2717 channel_state.by_id.retain(|chan_id, chan| {
2718 let (retain_channel, chan_needs_persist, err) = self.update_channel_fee(short_to_id, pending_msg_events, chan_id, chan, new_feerate);
2719 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
2721 handle_errors.push(err);
2731 /// Performs actions which should happen on startup and roughly once per minute thereafter.
2733 /// This currently includes:
2734 /// * Increasing or decreasing the on-chain feerate estimates for our outbound channels,
2735 /// * Broadcasting `ChannelUpdate` messages if we've been disconnected from our peer for more
2736 /// than a minute, informing the network that they should no longer attempt to route over
2739 /// Note that this may cause reentrancy through `chain::Watch::update_channel` calls or feerate
2740 /// estimate fetches.
2741 pub fn timer_tick_occurred(&self) {
2742 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
2743 let mut should_persist = NotifyOption::SkipPersist;
2744 if self.process_background_events() { should_persist = NotifyOption::DoPersist; }
2746 let new_feerate = self.fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
2748 let mut handle_errors = Vec::new();
2750 let mut channel_state_lock = self.channel_state.lock().unwrap();
2751 let channel_state = &mut *channel_state_lock;
2752 let pending_msg_events = &mut channel_state.pending_msg_events;
2753 let short_to_id = &mut channel_state.short_to_id;
2754 channel_state.by_id.retain(|chan_id, chan| {
2755 let counterparty_node_id = chan.get_counterparty_node_id();
2756 let (retain_channel, chan_needs_persist, err) = self.update_channel_fee(short_to_id, pending_msg_events, chan_id, chan, new_feerate);
2757 if chan_needs_persist == NotifyOption::DoPersist { should_persist = NotifyOption::DoPersist; }
2759 handle_errors.push((err, counterparty_node_id));
2761 if !retain_channel { return false; }
2763 if let Err(e) = chan.timer_check_closing_negotiation_progress() {
2764 let (needs_close, err) = convert_chan_err!(self, e, short_to_id, chan, chan_id);
2765 handle_errors.push((Err(err), chan.get_counterparty_node_id()));
2766 if needs_close { return false; }
2769 match chan.channel_update_status() {
2770 ChannelUpdateStatus::Enabled if !chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::DisabledStaged),
2771 ChannelUpdateStatus::Disabled if chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::EnabledStaged),
2772 ChannelUpdateStatus::DisabledStaged if chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::Enabled),
2773 ChannelUpdateStatus::EnabledStaged if !chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::Disabled),
2774 ChannelUpdateStatus::DisabledStaged if !chan.is_live() => {
2775 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
2776 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2780 should_persist = NotifyOption::DoPersist;
2781 chan.set_channel_update_status(ChannelUpdateStatus::Disabled);
2783 ChannelUpdateStatus::EnabledStaged if chan.is_live() => {
2784 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
2785 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2789 should_persist = NotifyOption::DoPersist;
2790 chan.set_channel_update_status(ChannelUpdateStatus::Enabled);
2799 for (err, counterparty_node_id) in handle_errors.drain(..) {
2800 let _ = handle_error!(self, err, counterparty_node_id);
2806 /// Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
2807 /// after a PaymentReceived event, failing the HTLC back to its origin and freeing resources
2808 /// along the path (including in our own channel on which we received it).
2809 /// Returns false if no payment was found to fail backwards, true if the process of failing the
2810 /// HTLC backwards has been started.
2811 pub fn fail_htlc_backwards(&self, payment_hash: &PaymentHash) -> bool {
2812 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2814 let mut channel_state = Some(self.channel_state.lock().unwrap());
2815 let removed_source = channel_state.as_mut().unwrap().claimable_htlcs.remove(payment_hash);
2816 if let Some(mut sources) = removed_source {
2817 for htlc in sources.drain(..) {
2818 if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
2819 let mut htlc_msat_height_data = byte_utils::be64_to_array(htlc.value).to_vec();
2820 htlc_msat_height_data.extend_from_slice(&byte_utils::be32_to_array(
2821 self.best_block.read().unwrap().height()));
2822 self.fail_htlc_backwards_internal(channel_state.take().unwrap(),
2823 HTLCSource::PreviousHopData(htlc.prev_hop), payment_hash,
2824 HTLCFailReason::Reason { failure_code: 0x4000 | 15, data: htlc_msat_height_data });
2830 // Fail a list of HTLCs that were just freed from the holding cell. The HTLCs need to be
2831 // failed backwards or, if they were one of our outgoing HTLCs, then their failure needs to
2832 // be surfaced to the user.
2833 fn fail_holding_cell_htlcs(&self, mut htlcs_to_fail: Vec<(HTLCSource, PaymentHash)>, channel_id: [u8; 32]) {
2834 for (htlc_src, payment_hash) in htlcs_to_fail.drain(..) {
2836 HTLCSource::PreviousHopData(HTLCPreviousHopData { .. }) => {
2837 let (failure_code, onion_failure_data) =
2838 match self.channel_state.lock().unwrap().by_id.entry(channel_id) {
2839 hash_map::Entry::Occupied(chan_entry) => {
2840 if let Ok(upd) = self.get_channel_update_for_unicast(&chan_entry.get()) {
2841 (0x1000|7, upd.encode_with_len())
2843 (0x4000|10, Vec::new())
2846 hash_map::Entry::Vacant(_) => (0x4000|10, Vec::new())
2848 let channel_state = self.channel_state.lock().unwrap();
2849 self.fail_htlc_backwards_internal(channel_state,
2850 htlc_src, &payment_hash, HTLCFailReason::Reason { failure_code, data: onion_failure_data});
2852 HTLCSource::OutboundRoute { session_priv, mpp_id, .. } => {
2853 let mut session_priv_bytes = [0; 32];
2854 session_priv_bytes.copy_from_slice(&session_priv[..]);
2855 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
2856 if let hash_map::Entry::Occupied(mut sessions) = outbounds.entry(mpp_id) {
2857 if sessions.get_mut().remove(&session_priv_bytes) {
2858 self.pending_events.lock().unwrap().push(
2859 events::Event::PaymentFailed {
2861 rejected_by_dest: false,
2862 network_update: None,
2863 all_paths_failed: sessions.get().len() == 0,
2870 if sessions.get().len() == 0 {
2875 log_trace!(self.logger, "Received duplicative fail for HTLC with payment_hash {}", log_bytes!(payment_hash.0));
2882 /// Fails an HTLC backwards to the sender of it to us.
2883 /// Note that while we take a channel_state lock as input, we do *not* assume consistency here.
2884 /// There are several callsites that do stupid things like loop over a list of payment_hashes
2885 /// to fail and take the channel_state lock for each iteration (as we take ownership and may
2886 /// drop it). In other words, no assumptions are made that entries in claimable_htlcs point to
2887 /// still-available channels.
2888 fn fail_htlc_backwards_internal(&self, mut channel_state_lock: MutexGuard<ChannelHolder<Signer>>, source: HTLCSource, payment_hash: &PaymentHash, onion_error: HTLCFailReason) {
2889 //TODO: There is a timing attack here where if a node fails an HTLC back to us they can
2890 //identify whether we sent it or not based on the (I presume) very different runtime
2891 //between the branches here. We should make this async and move it into the forward HTLCs
2894 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
2895 // from block_connected which may run during initialization prior to the chain_monitor
2896 // being fully configured. See the docs for `ChannelManagerReadArgs` for more.
2898 HTLCSource::OutboundRoute { ref path, session_priv, mpp_id, .. } => {
2899 let mut session_priv_bytes = [0; 32];
2900 session_priv_bytes.copy_from_slice(&session_priv[..]);
2901 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
2902 let mut all_paths_failed = false;
2903 if let hash_map::Entry::Occupied(mut sessions) = outbounds.entry(mpp_id) {
2904 if !sessions.get_mut().remove(&session_priv_bytes) {
2905 log_trace!(self.logger, "Received duplicative fail for HTLC with payment_hash {}", log_bytes!(payment_hash.0));
2908 if sessions.get().len() == 0 {
2909 all_paths_failed = true;
2913 log_trace!(self.logger, "Received duplicative fail for HTLC with payment_hash {}", log_bytes!(payment_hash.0));
2916 log_trace!(self.logger, "Failing outbound payment HTLC with payment_hash {}", log_bytes!(payment_hash.0));
2917 mem::drop(channel_state_lock);
2918 match &onion_error {
2919 &HTLCFailReason::LightningError { ref err } => {
2921 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());
2923 let (network_update, payment_retryable, _, _) = onion_utils::process_onion_failure(&self.secp_ctx, &self.logger, &source, err.data.clone());
2924 // TODO: If we decided to blame ourselves (or one of our channels) in
2925 // process_onion_failure we should close that channel as it implies our
2926 // next-hop is needlessly blaming us!
2927 self.pending_events.lock().unwrap().push(
2928 events::Event::PaymentFailed {
2929 payment_hash: payment_hash.clone(),
2930 rejected_by_dest: !payment_retryable,
2934 error_code: onion_error_code,
2936 error_data: onion_error_data
2940 &HTLCFailReason::Reason {
2946 // we get a fail_malformed_htlc from the first hop
2947 // TODO: We'd like to generate a NetworkUpdate for temporary
2948 // failures here, but that would be insufficient as get_route
2949 // generally ignores its view of our own channels as we provide them via
2951 // TODO: For non-temporary failures, we really should be closing the
2952 // channel here as we apparently can't relay through them anyway.
2953 self.pending_events.lock().unwrap().push(
2954 events::Event::PaymentFailed {
2955 payment_hash: payment_hash.clone(),
2956 rejected_by_dest: path.len() == 1,
2957 network_update: None,
2960 error_code: Some(*failure_code),
2962 error_data: Some(data.clone()),
2968 HTLCSource::PreviousHopData(HTLCPreviousHopData { short_channel_id, htlc_id, incoming_packet_shared_secret, .. }) => {
2969 let err_packet = match onion_error {
2970 HTLCFailReason::Reason { failure_code, data } => {
2971 log_trace!(self.logger, "Failing HTLC with payment_hash {} backwards from us with code {}", log_bytes!(payment_hash.0), failure_code);
2972 let packet = onion_utils::build_failure_packet(&incoming_packet_shared_secret, failure_code, &data[..]).encode();
2973 onion_utils::encrypt_failure_packet(&incoming_packet_shared_secret, &packet)
2975 HTLCFailReason::LightningError { err } => {
2976 log_trace!(self.logger, "Failing HTLC with payment_hash {} backwards with pre-built LightningError", log_bytes!(payment_hash.0));
2977 onion_utils::encrypt_failure_packet(&incoming_packet_shared_secret, &err.data)
2981 let mut forward_event = None;
2982 if channel_state_lock.forward_htlcs.is_empty() {
2983 forward_event = Some(Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS));
2985 match channel_state_lock.forward_htlcs.entry(short_channel_id) {
2986 hash_map::Entry::Occupied(mut entry) => {
2987 entry.get_mut().push(HTLCForwardInfo::FailHTLC { htlc_id, err_packet });
2989 hash_map::Entry::Vacant(entry) => {
2990 entry.insert(vec!(HTLCForwardInfo::FailHTLC { htlc_id, err_packet }));
2993 mem::drop(channel_state_lock);
2994 if let Some(time) = forward_event {
2995 let mut pending_events = self.pending_events.lock().unwrap();
2996 pending_events.push(events::Event::PendingHTLCsForwardable {
2997 time_forwardable: time
3004 /// Provides a payment preimage in response to a PaymentReceived event, returning true and
3005 /// generating message events for the net layer to claim the payment, if possible. Thus, you
3006 /// should probably kick the net layer to go send messages if this returns true!
3008 /// Note that if you did not set an `amount_msat` when calling [`create_inbound_payment`] or
3009 /// [`create_inbound_payment_for_hash`] you must check that the amount in the `PaymentReceived`
3010 /// event matches your expectation. If you fail to do so and call this method, you may provide
3011 /// the sender "proof-of-payment" when they did not fulfill the full expected payment.
3013 /// May panic if called except in response to a PaymentReceived event.
3015 /// [`create_inbound_payment`]: Self::create_inbound_payment
3016 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
3017 pub fn claim_funds(&self, payment_preimage: PaymentPreimage) -> bool {
3018 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
3020 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
3022 let mut channel_state = Some(self.channel_state.lock().unwrap());
3023 let removed_source = channel_state.as_mut().unwrap().claimable_htlcs.remove(&payment_hash);
3024 if let Some(mut sources) = removed_source {
3025 assert!(!sources.is_empty());
3027 // If we are claiming an MPP payment, we have to take special care to ensure that each
3028 // channel exists before claiming all of the payments (inside one lock).
3029 // Note that channel existance is sufficient as we should always get a monitor update
3030 // which will take care of the real HTLC claim enforcement.
3032 // If we find an HTLC which we would need to claim but for which we do not have a
3033 // channel, we will fail all parts of the MPP payment. While we could wait and see if
3034 // the sender retries the already-failed path(s), it should be a pretty rare case where
3035 // we got all the HTLCs and then a channel closed while we were waiting for the user to
3036 // provide the preimage, so worrying too much about the optimal handling isn't worth
3038 let mut valid_mpp = true;
3039 for htlc in sources.iter() {
3040 if let None = channel_state.as_ref().unwrap().short_to_id.get(&htlc.prev_hop.short_channel_id) {
3046 let mut errs = Vec::new();
3047 let mut claimed_any_htlcs = false;
3048 for htlc in sources.drain(..) {
3050 if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
3051 let mut htlc_msat_height_data = byte_utils::be64_to_array(htlc.value).to_vec();
3052 htlc_msat_height_data.extend_from_slice(&byte_utils::be32_to_array(
3053 self.best_block.read().unwrap().height()));
3054 self.fail_htlc_backwards_internal(channel_state.take().unwrap(),
3055 HTLCSource::PreviousHopData(htlc.prev_hop), &payment_hash,
3056 HTLCFailReason::Reason { failure_code: 0x4000|15, data: htlc_msat_height_data });
3058 match self.claim_funds_from_hop(channel_state.as_mut().unwrap(), htlc.prev_hop, payment_preimage) {
3059 ClaimFundsFromHop::MonitorUpdateFail(pk, err, _) => {
3060 if let msgs::ErrorAction::IgnoreError = err.err.action {
3061 // We got a temporary failure updating monitor, but will claim the
3062 // HTLC when the monitor updating is restored (or on chain).
3063 log_error!(self.logger, "Temporary failure claiming HTLC, treating as success: {}", err.err.err);
3064 claimed_any_htlcs = true;
3065 } else { errs.push((pk, err)); }
3067 ClaimFundsFromHop::PrevHopForceClosed => unreachable!("We already checked for channel existence, we can't fail here!"),
3068 ClaimFundsFromHop::DuplicateClaim => {
3069 // While we should never get here in most cases, if we do, it likely
3070 // indicates that the HTLC was timed out some time ago and is no longer
3071 // available to be claimed. Thus, it does not make sense to set
3072 // `claimed_any_htlcs`.
3074 ClaimFundsFromHop::Success(_) => claimed_any_htlcs = true,
3079 // Now that we've done the entire above loop in one lock, we can handle any errors
3080 // which were generated.
3081 channel_state.take();
3083 for (counterparty_node_id, err) in errs.drain(..) {
3084 let res: Result<(), _> = Err(err);
3085 let _ = handle_error!(self, res, counterparty_node_id);
3092 fn claim_funds_from_hop(&self, channel_state_lock: &mut MutexGuard<ChannelHolder<Signer>>, prev_hop: HTLCPreviousHopData, payment_preimage: PaymentPreimage) -> ClaimFundsFromHop {
3093 //TODO: Delay the claimed_funds relaying just like we do outbound relay!
3094 let channel_state = &mut **channel_state_lock;
3095 let chan_id = match channel_state.short_to_id.get(&prev_hop.short_channel_id) {
3096 Some(chan_id) => chan_id.clone(),
3098 return ClaimFundsFromHop::PrevHopForceClosed
3102 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(chan_id) {
3103 match chan.get_mut().get_update_fulfill_htlc_and_commit(prev_hop.htlc_id, payment_preimage, &self.logger) {
3104 Ok(msgs_monitor_option) => {
3105 if let UpdateFulfillCommitFetch::NewClaim { msgs, htlc_value_msat, monitor_update } = msgs_monitor_option {
3106 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
3107 log_given_level!(self.logger, if e == ChannelMonitorUpdateErr::PermanentFailure { Level::Error } else { Level::Debug },
3108 "Failed to update channel monitor with preimage {:?}: {:?}",
3109 payment_preimage, e);
3110 return ClaimFundsFromHop::MonitorUpdateFail(
3111 chan.get().get_counterparty_node_id(),
3112 handle_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, msgs.is_some()).unwrap_err(),
3113 Some(htlc_value_msat)
3116 if let Some((msg, commitment_signed)) = msgs {
3117 log_debug!(self.logger, "Claiming funds for HTLC with preimage {} resulted in a commitment_signed for channel {}",
3118 log_bytes!(payment_preimage.0), log_bytes!(chan.get().channel_id()));
3119 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
3120 node_id: chan.get().get_counterparty_node_id(),
3121 updates: msgs::CommitmentUpdate {
3122 update_add_htlcs: Vec::new(),
3123 update_fulfill_htlcs: vec![msg],
3124 update_fail_htlcs: Vec::new(),
3125 update_fail_malformed_htlcs: Vec::new(),
3131 return ClaimFundsFromHop::Success(htlc_value_msat);
3133 return ClaimFundsFromHop::DuplicateClaim;
3136 Err((e, monitor_update)) => {
3137 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
3138 log_given_level!(self.logger, if e == ChannelMonitorUpdateErr::PermanentFailure { Level::Error } else { Level::Info },
3139 "Failed to update channel monitor with preimage {:?} immediately prior to force-close: {:?}",
3140 payment_preimage, e);
3142 let counterparty_node_id = chan.get().get_counterparty_node_id();
3143 let (drop, res) = convert_chan_err!(self, e, channel_state.short_to_id, chan.get_mut(), &chan_id);
3145 chan.remove_entry();
3147 return ClaimFundsFromHop::MonitorUpdateFail(counterparty_node_id, res, None);
3150 } else { unreachable!(); }
3153 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) {
3155 HTLCSource::OutboundRoute { session_priv, mpp_id, .. } => {
3156 mem::drop(channel_state_lock);
3157 let mut session_priv_bytes = [0; 32];
3158 session_priv_bytes.copy_from_slice(&session_priv[..]);
3159 let mut outbounds = self.pending_outbound_payments.lock().unwrap();
3160 let found_payment = if let Some(mut sessions) = outbounds.remove(&mpp_id) {
3161 sessions.remove(&session_priv_bytes)
3164 self.pending_events.lock().unwrap().push(
3165 events::Event::PaymentSent { payment_preimage }
3168 log_trace!(self.logger, "Received duplicative fulfill for HTLC with payment_preimage {}", log_bytes!(payment_preimage.0));
3171 HTLCSource::PreviousHopData(hop_data) => {
3172 let prev_outpoint = hop_data.outpoint;
3173 let res = self.claim_funds_from_hop(&mut channel_state_lock, hop_data, payment_preimage);
3174 let claimed_htlc = if let ClaimFundsFromHop::DuplicateClaim = res { false } else { true };
3175 let htlc_claim_value_msat = match res {
3176 ClaimFundsFromHop::MonitorUpdateFail(_, _, amt_opt) => amt_opt,
3177 ClaimFundsFromHop::Success(amt) => Some(amt),
3180 if let ClaimFundsFromHop::PrevHopForceClosed = res {
3181 let preimage_update = ChannelMonitorUpdate {
3182 update_id: CLOSED_CHANNEL_UPDATE_ID,
3183 updates: vec![ChannelMonitorUpdateStep::PaymentPreimage {
3184 payment_preimage: payment_preimage.clone(),
3187 // We update the ChannelMonitor on the backward link, after
3188 // receiving an offchain preimage event from the forward link (the
3189 // event being update_fulfill_htlc).
3190 if let Err(e) = self.chain_monitor.update_channel(prev_outpoint, preimage_update) {
3191 log_error!(self.logger, "Critical error: failed to update channel monitor with preimage {:?}: {:?}",
3192 payment_preimage, e);
3194 // Note that we do *not* set `claimed_htlc` to false here. In fact, this
3195 // totally could be a duplicate claim, but we have no way of knowing
3196 // without interrogating the `ChannelMonitor` we've provided the above
3197 // update to. Instead, we simply document in `PaymentForwarded` that this
3200 mem::drop(channel_state_lock);
3201 if let ClaimFundsFromHop::MonitorUpdateFail(pk, err, _) = res {
3202 let result: Result<(), _> = Err(err);
3203 let _ = handle_error!(self, result, pk);
3207 if let Some(forwarded_htlc_value) = forwarded_htlc_value_msat {
3208 let fee_earned_msat = if let Some(claimed_htlc_value) = htlc_claim_value_msat {
3209 Some(claimed_htlc_value - forwarded_htlc_value)
3212 let mut pending_events = self.pending_events.lock().unwrap();
3213 pending_events.push(events::Event::PaymentForwarded {
3215 claim_from_onchain_tx: from_onchain,
3223 /// Gets the node_id held by this ChannelManager
3224 pub fn get_our_node_id(&self) -> PublicKey {
3225 self.our_network_pubkey.clone()
3228 /// Restores a single, given channel to normal operation after a
3229 /// ChannelMonitorUpdateErr::TemporaryFailure was returned from a channel monitor update
3232 /// All ChannelMonitor updates up to and including highest_applied_update_id must have been
3233 /// fully committed in every copy of the given channels' ChannelMonitors.
3235 /// Note that there is no effect to calling with a highest_applied_update_id other than the
3236 /// current latest ChannelMonitorUpdate and one call to this function after multiple
3237 /// ChannelMonitorUpdateErr::TemporaryFailures is fine. The highest_applied_update_id field
3238 /// exists largely only to prevent races between this and concurrent update_monitor calls.
3240 /// Thus, the anticipated use is, at a high level:
3241 /// 1) You register a chain::Watch with this ChannelManager,
3242 /// 2) it stores each update to disk, and begins updating any remote (eg watchtower) copies of
3243 /// said ChannelMonitors as it can, returning ChannelMonitorUpdateErr::TemporaryFailures
3244 /// any time it cannot do so instantly,
3245 /// 3) update(s) are applied to each remote copy of a ChannelMonitor,
3246 /// 4) once all remote copies are updated, you call this function with the update_id that
3247 /// completed, and once it is the latest the Channel will be re-enabled.
3248 pub fn channel_monitor_updated(&self, funding_txo: &OutPoint, highest_applied_update_id: u64) {
3249 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
3251 let chan_restoration_res;
3252 let mut pending_failures = {
3253 let mut channel_lock = self.channel_state.lock().unwrap();
3254 let channel_state = &mut *channel_lock;
3255 let mut channel = match channel_state.by_id.entry(funding_txo.to_channel_id()) {
3256 hash_map::Entry::Occupied(chan) => chan,
3257 hash_map::Entry::Vacant(_) => return,
3259 if !channel.get().is_awaiting_monitor_update() || channel.get().get_latest_monitor_update_id() != highest_applied_update_id {
3263 let (raa, commitment_update, order, pending_forwards, pending_failures, funding_broadcastable, funding_locked) = channel.get_mut().monitor_updating_restored(&self.logger);
3264 let channel_update = if funding_locked.is_some() && channel.get().is_usable() && !channel.get().should_announce() {
3265 // We only send a channel_update in the case where we are just now sending a
3266 // funding_locked and the channel is in a usable state. Further, we rely on the
3267 // normal announcement_signatures process to send a channel_update for public
3268 // channels, only generating a unicast channel_update if this is a private channel.
3269 Some(events::MessageSendEvent::SendChannelUpdate {
3270 node_id: channel.get().get_counterparty_node_id(),
3271 msg: self.get_channel_update_for_unicast(channel.get()).unwrap(),
3274 chan_restoration_res = handle_chan_restoration_locked!(self, channel_lock, channel_state, channel, raa, commitment_update, order, None, pending_forwards, funding_broadcastable, funding_locked);
3275 if let Some(upd) = channel_update {
3276 channel_state.pending_msg_events.push(upd);
3280 post_handle_chan_restoration!(self, chan_restoration_res);
3281 for failure in pending_failures.drain(..) {
3282 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), failure.0, &failure.1, failure.2);
3286 fn internal_open_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::OpenChannel) -> Result<(), MsgHandleErrInternal> {
3287 if msg.chain_hash != self.genesis_hash {
3288 return Err(MsgHandleErrInternal::send_err_msg_no_close("Unknown genesis block hash".to_owned(), msg.temporary_channel_id.clone()));
3291 let channel = Channel::new_from_req(&self.fee_estimator, &self.keys_manager, counterparty_node_id.clone(), &their_features, msg, 0, &self.default_configuration)
3292 .map_err(|e| MsgHandleErrInternal::from_chan_no_close(e, msg.temporary_channel_id))?;
3293 let mut channel_state_lock = self.channel_state.lock().unwrap();
3294 let channel_state = &mut *channel_state_lock;
3295 match channel_state.by_id.entry(channel.channel_id()) {
3296 hash_map::Entry::Occupied(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("temporary_channel_id collision!".to_owned(), msg.temporary_channel_id.clone())),
3297 hash_map::Entry::Vacant(entry) => {
3298 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
3299 node_id: counterparty_node_id.clone(),
3300 msg: channel.get_accept_channel(),
3302 entry.insert(channel);
3308 fn internal_accept_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::AcceptChannel) -> Result<(), MsgHandleErrInternal> {
3309 let (value, output_script, user_id) = {
3310 let mut channel_lock = self.channel_state.lock().unwrap();
3311 let channel_state = &mut *channel_lock;
3312 match channel_state.by_id.entry(msg.temporary_channel_id) {
3313 hash_map::Entry::Occupied(mut chan) => {
3314 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3315 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.temporary_channel_id));
3317 try_chan_entry!(self, chan.get_mut().accept_channel(&msg, &self.default_configuration, &their_features), channel_state, chan);
3318 (chan.get().get_value_satoshis(), chan.get().get_funding_redeemscript().to_v0_p2wsh(), chan.get().get_user_id())
3320 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.temporary_channel_id))
3323 let mut pending_events = self.pending_events.lock().unwrap();
3324 pending_events.push(events::Event::FundingGenerationReady {
3325 temporary_channel_id: msg.temporary_channel_id,
3326 channel_value_satoshis: value,
3328 user_channel_id: user_id,
3333 fn internal_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), MsgHandleErrInternal> {
3334 let ((funding_msg, monitor), mut chan) = {
3335 let best_block = *self.best_block.read().unwrap();
3336 let mut channel_lock = self.channel_state.lock().unwrap();
3337 let channel_state = &mut *channel_lock;
3338 match channel_state.by_id.entry(msg.temporary_channel_id.clone()) {
3339 hash_map::Entry::Occupied(mut chan) => {
3340 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3341 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.temporary_channel_id));
3343 (try_chan_entry!(self, chan.get_mut().funding_created(msg, best_block, &self.logger), channel_state, chan), chan.remove())
3345 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.temporary_channel_id))
3348 // Because we have exclusive ownership of the channel here we can release the channel_state
3349 // lock before watch_channel
3350 if let Err(e) = self.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor) {
3352 ChannelMonitorUpdateErr::PermanentFailure => {
3353 // Note that we reply with the new channel_id in error messages if we gave up on the
3354 // channel, not the temporary_channel_id. This is compatible with ourselves, but the
3355 // spec is somewhat ambiguous here. Not a huge deal since we'll send error messages for
3356 // any messages referencing a previously-closed channel anyway.
3357 // We do not do a force-close here as that would generate a monitor update for
3358 // a monitor that we didn't manage to store (and that we don't care about - we
3359 // don't respond with the funding_signed so the channel can never go on chain).
3360 let (_monitor_update, failed_htlcs) = chan.force_shutdown(true);
3361 assert!(failed_htlcs.is_empty());
3362 return Err(MsgHandleErrInternal::send_err_msg_no_close("ChannelMonitor storage failure".to_owned(), funding_msg.channel_id));
3364 ChannelMonitorUpdateErr::TemporaryFailure => {
3365 // There's no problem signing a counterparty's funding transaction if our monitor
3366 // hasn't persisted to disk yet - we can't lose money on a transaction that we haven't
3367 // accepted payment from yet. We do, however, need to wait to send our funding_locked
3368 // until we have persisted our monitor.
3369 chan.monitor_update_failed(false, false, Vec::new(), Vec::new());
3373 let mut channel_state_lock = self.channel_state.lock().unwrap();
3374 let channel_state = &mut *channel_state_lock;
3375 match channel_state.by_id.entry(funding_msg.channel_id) {
3376 hash_map::Entry::Occupied(_) => {
3377 return Err(MsgHandleErrInternal::send_err_msg_no_close("Already had channel with the new channel_id".to_owned(), funding_msg.channel_id))
3379 hash_map::Entry::Vacant(e) => {
3380 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
3381 node_id: counterparty_node_id.clone(),
3390 fn internal_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), MsgHandleErrInternal> {
3392 let best_block = *self.best_block.read().unwrap();
3393 let mut channel_lock = self.channel_state.lock().unwrap();
3394 let channel_state = &mut *channel_lock;
3395 match channel_state.by_id.entry(msg.channel_id) {
3396 hash_map::Entry::Occupied(mut chan) => {
3397 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3398 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3400 let (monitor, funding_tx) = match chan.get_mut().funding_signed(&msg, best_block, &self.logger) {
3401 Ok(update) => update,
3402 Err(e) => try_chan_entry!(self, Err(e), channel_state, chan),
3404 if let Err(e) = self.chain_monitor.watch_channel(chan.get().get_funding_txo().unwrap(), monitor) {
3405 return_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::RevokeAndACKFirst, false, false);
3409 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3412 log_info!(self.logger, "Broadcasting funding transaction with txid {}", funding_tx.txid());
3413 self.tx_broadcaster.broadcast_transaction(&funding_tx);
3417 fn internal_funding_locked(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingLocked) -> Result<(), MsgHandleErrInternal> {
3418 let mut channel_state_lock = self.channel_state.lock().unwrap();
3419 let channel_state = &mut *channel_state_lock;
3420 match channel_state.by_id.entry(msg.channel_id) {
3421 hash_map::Entry::Occupied(mut chan) => {
3422 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3423 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3425 try_chan_entry!(self, chan.get_mut().funding_locked(&msg, &self.logger), channel_state, chan);
3426 if let Some(announcement_sigs) = self.get_announcement_sigs(chan.get()) {
3427 log_trace!(self.logger, "Sending announcement_signatures for {} in response to funding_locked", log_bytes!(chan.get().channel_id()));
3428 // If we see locking block before receiving remote funding_locked, we broadcast our
3429 // announcement_sigs at remote funding_locked reception. If we receive remote
3430 // funding_locked before seeing locking block, we broadcast our announcement_sigs at locking
3431 // block connection. We should guanrantee to broadcast announcement_sigs to our peer whatever
3432 // the order of the events but our peer may not receive it due to disconnection. The specs
3433 // lacking an acknowledgement for announcement_sigs we may have to re-send them at peer
3434 // connection in the future if simultaneous misses by both peers due to network/hardware
3435 // failures is an issue. Note, to achieve its goal, only one of the announcement_sigs needs
3436 // to be received, from then sigs are going to be flood to the whole network.
3437 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
3438 node_id: counterparty_node_id.clone(),
3439 msg: announcement_sigs,
3441 } else if chan.get().is_usable() {
3442 channel_state.pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
3443 node_id: counterparty_node_id.clone(),
3444 msg: self.get_channel_update_for_unicast(chan.get()).unwrap(),
3449 hash_map::Entry::Vacant(_) => Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3453 fn internal_shutdown(&self, counterparty_node_id: &PublicKey, their_features: &InitFeatures, msg: &msgs::Shutdown) -> Result<(), MsgHandleErrInternal> {
3454 let mut dropped_htlcs: Vec<(HTLCSource, PaymentHash)>;
3455 let result: Result<(), _> = loop {
3456 let mut channel_state_lock = self.channel_state.lock().unwrap();
3457 let channel_state = &mut *channel_state_lock;
3459 match channel_state.by_id.entry(msg.channel_id.clone()) {
3460 hash_map::Entry::Occupied(mut chan_entry) => {
3461 if chan_entry.get().get_counterparty_node_id() != *counterparty_node_id {
3462 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3465 if !chan_entry.get().received_shutdown() {
3466 log_info!(self.logger, "Received a shutdown message from our counterparty for channel {}{}.",
3467 log_bytes!(msg.channel_id),
3468 if chan_entry.get().sent_shutdown() { " after we initiated shutdown" } else { "" });
3471 let (shutdown, monitor_update, htlcs) = try_chan_entry!(self, chan_entry.get_mut().shutdown(&self.keys_manager, &their_features, &msg), channel_state, chan_entry);
3472 dropped_htlcs = htlcs;
3474 // Update the monitor with the shutdown script if necessary.
3475 if let Some(monitor_update) = monitor_update {
3476 if let Err(e) = self.chain_monitor.update_channel(chan_entry.get().get_funding_txo().unwrap(), monitor_update) {
3477 let (result, is_permanent) =
3478 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());
3480 remove_channel!(channel_state, chan_entry);
3486 if let Some(msg) = shutdown {
3487 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
3488 node_id: *counterparty_node_id,
3495 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3498 for htlc_source in dropped_htlcs.drain(..) {
3499 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() });
3502 let _ = handle_error!(self, result, *counterparty_node_id);
3506 fn internal_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<(), MsgHandleErrInternal> {
3507 let (tx, chan_option) = {
3508 let mut channel_state_lock = self.channel_state.lock().unwrap();
3509 let channel_state = &mut *channel_state_lock;
3510 match channel_state.by_id.entry(msg.channel_id.clone()) {
3511 hash_map::Entry::Occupied(mut chan_entry) => {
3512 if chan_entry.get().get_counterparty_node_id() != *counterparty_node_id {
3513 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3515 let (closing_signed, tx) = try_chan_entry!(self, chan_entry.get_mut().closing_signed(&self.fee_estimator, &msg), channel_state, chan_entry);
3516 if let Some(msg) = closing_signed {
3517 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
3518 node_id: counterparty_node_id.clone(),
3523 // We're done with this channel, we've got a signed closing transaction and
3524 // will send the closing_signed back to the remote peer upon return. This
3525 // also implies there are no pending HTLCs left on the channel, so we can
3526 // fully delete it from tracking (the channel monitor is still around to
3527 // watch for old state broadcasts)!
3528 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
3529 channel_state.short_to_id.remove(&short_id);
3531 (tx, Some(chan_entry.remove_entry().1))
3532 } else { (tx, None) }
3534 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3537 if let Some(broadcast_tx) = tx {
3538 log_info!(self.logger, "Broadcasting {}", log_tx!(broadcast_tx));
3539 self.tx_broadcaster.broadcast_transaction(&broadcast_tx);
3541 if let Some(chan) = chan_option {
3542 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
3543 let mut channel_state = self.channel_state.lock().unwrap();
3544 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
3552 fn internal_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), MsgHandleErrInternal> {
3553 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
3554 //determine the state of the payment based on our response/if we forward anything/the time
3555 //we take to respond. We should take care to avoid allowing such an attack.
3557 //TODO: There exists a further attack where a node may garble the onion data, forward it to
3558 //us repeatedly garbled in different ways, and compare our error messages, which are
3559 //encrypted with the same key. It's not immediately obvious how to usefully exploit that,
3560 //but we should prevent it anyway.
3562 let (pending_forward_info, mut channel_state_lock) = self.decode_update_add_htlc_onion(msg);
3563 let channel_state = &mut *channel_state_lock;
3565 match channel_state.by_id.entry(msg.channel_id) {
3566 hash_map::Entry::Occupied(mut chan) => {
3567 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3568 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3571 let create_pending_htlc_status = |chan: &Channel<Signer>, pending_forward_info: PendingHTLCStatus, error_code: u16| {
3572 // If the update_add is completely bogus, the call will Err and we will close,
3573 // but if we've sent a shutdown and they haven't acknowledged it yet, we just
3574 // want to reject the new HTLC and fail it backwards instead of forwarding.
3575 match pending_forward_info {
3576 PendingHTLCStatus::Forward(PendingHTLCInfo { ref incoming_shared_secret, .. }) => {
3577 let reason = if (error_code & 0x1000) != 0 {
3578 if let Ok(upd) = self.get_channel_update_for_unicast(chan) {
3579 onion_utils::build_first_hop_failure_packet(incoming_shared_secret, error_code, &{
3580 let mut res = Vec::with_capacity(8 + 128);
3581 // TODO: underspecified, follow https://github.com/lightningnetwork/lightning-rfc/issues/791
3582 res.extend_from_slice(&byte_utils::be16_to_array(0));
3583 res.extend_from_slice(&upd.encode_with_len()[..]);
3587 // The only case where we'd be unable to
3588 // successfully get a channel update is if the
3589 // channel isn't in the fully-funded state yet,
3590 // implying our counterparty is trying to route
3591 // payments over the channel back to themselves
3592 // (because no one else should know the short_id
3593 // is a lightning channel yet). We should have
3594 // no problem just calling this
3595 // unknown_next_peer (0x4000|10).
3596 onion_utils::build_first_hop_failure_packet(incoming_shared_secret, 0x4000|10, &[])
3599 onion_utils::build_first_hop_failure_packet(incoming_shared_secret, error_code, &[])
3601 let msg = msgs::UpdateFailHTLC {
3602 channel_id: msg.channel_id,
3603 htlc_id: msg.htlc_id,
3606 PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msg))
3608 _ => pending_forward_info
3611 try_chan_entry!(self, chan.get_mut().update_add_htlc(&msg, pending_forward_info, create_pending_htlc_status, &self.logger), channel_state, chan);
3613 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3618 fn internal_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), MsgHandleErrInternal> {
3619 let mut channel_lock = self.channel_state.lock().unwrap();
3620 let (htlc_source, forwarded_htlc_value) = {
3621 let channel_state = &mut *channel_lock;
3622 match channel_state.by_id.entry(msg.channel_id) {
3623 hash_map::Entry::Occupied(mut chan) => {
3624 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3625 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3627 try_chan_entry!(self, chan.get_mut().update_fulfill_htlc(&msg), channel_state, chan)
3629 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3632 self.claim_funds_internal(channel_lock, htlc_source, msg.payment_preimage.clone(), Some(forwarded_htlc_value), false);
3636 fn internal_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), MsgHandleErrInternal> {
3637 let mut channel_lock = self.channel_state.lock().unwrap();
3638 let channel_state = &mut *channel_lock;
3639 match channel_state.by_id.entry(msg.channel_id) {
3640 hash_map::Entry::Occupied(mut chan) => {
3641 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3642 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3644 try_chan_entry!(self, chan.get_mut().update_fail_htlc(&msg, HTLCFailReason::LightningError { err: msg.reason.clone() }), channel_state, chan);
3646 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3651 fn internal_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), MsgHandleErrInternal> {
3652 let mut channel_lock = self.channel_state.lock().unwrap();
3653 let channel_state = &mut *channel_lock;
3654 match channel_state.by_id.entry(msg.channel_id) {
3655 hash_map::Entry::Occupied(mut chan) => {
3656 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3657 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3659 if (msg.failure_code & 0x8000) == 0 {
3660 let chan_err: ChannelError = ChannelError::Close("Got update_fail_malformed_htlc with BADONION not set".to_owned());
3661 try_chan_entry!(self, Err(chan_err), channel_state, chan);
3663 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);
3666 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3670 fn internal_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), MsgHandleErrInternal> {
3671 let mut channel_state_lock = self.channel_state.lock().unwrap();
3672 let channel_state = &mut *channel_state_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 let (revoke_and_ack, commitment_signed, monitor_update) =
3679 match chan.get_mut().commitment_signed(&msg, &self.logger) {
3680 Err((None, e)) => try_chan_entry!(self, Err(e), channel_state, chan),
3681 Err((Some(update), e)) => {
3682 assert!(chan.get().is_awaiting_monitor_update());
3683 let _ = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), update);
3684 try_chan_entry!(self, Err(e), channel_state, chan);
3689 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
3690 return_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::RevokeAndACKFirst, true, commitment_signed.is_some());
3692 channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
3693 node_id: counterparty_node_id.clone(),
3694 msg: revoke_and_ack,
3696 if let Some(msg) = commitment_signed {
3697 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
3698 node_id: counterparty_node_id.clone(),
3699 updates: msgs::CommitmentUpdate {
3700 update_add_htlcs: Vec::new(),
3701 update_fulfill_htlcs: Vec::new(),
3702 update_fail_htlcs: Vec::new(),
3703 update_fail_malformed_htlcs: Vec::new(),
3705 commitment_signed: msg,
3711 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3716 fn forward_htlcs(&self, per_source_pending_forwards: &mut [(u64, OutPoint, Vec<(PendingHTLCInfo, u64)>)]) {
3717 for &mut (prev_short_channel_id, prev_funding_outpoint, ref mut pending_forwards) in per_source_pending_forwards {
3718 let mut forward_event = None;
3719 if !pending_forwards.is_empty() {
3720 let mut channel_state = self.channel_state.lock().unwrap();
3721 if channel_state.forward_htlcs.is_empty() {
3722 forward_event = Some(Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS))
3724 for (forward_info, prev_htlc_id) in pending_forwards.drain(..) {
3725 match channel_state.forward_htlcs.entry(match forward_info.routing {
3726 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
3727 PendingHTLCRouting::Receive { .. } => 0,
3728 PendingHTLCRouting::ReceiveKeysend { .. } => 0,
3730 hash_map::Entry::Occupied(mut entry) => {
3731 entry.get_mut().push(HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_funding_outpoint,
3732 prev_htlc_id, forward_info });
3734 hash_map::Entry::Vacant(entry) => {
3735 entry.insert(vec!(HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_funding_outpoint,
3736 prev_htlc_id, forward_info }));
3741 match forward_event {
3743 let mut pending_events = self.pending_events.lock().unwrap();
3744 pending_events.push(events::Event::PendingHTLCsForwardable {
3745 time_forwardable: time
3753 fn internal_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), MsgHandleErrInternal> {
3754 let mut htlcs_to_fail = Vec::new();
3756 let mut channel_state_lock = self.channel_state.lock().unwrap();
3757 let channel_state = &mut *channel_state_lock;
3758 match channel_state.by_id.entry(msg.channel_id) {
3759 hash_map::Entry::Occupied(mut chan) => {
3760 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3761 break Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3763 let was_frozen_for_monitor = chan.get().is_awaiting_monitor_update();
3764 let (commitment_update, pending_forwards, pending_failures, monitor_update, htlcs_to_fail_in) =
3765 break_chan_entry!(self, chan.get_mut().revoke_and_ack(&msg, &self.logger), channel_state, chan);
3766 htlcs_to_fail = htlcs_to_fail_in;
3767 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
3768 if was_frozen_for_monitor {
3769 assert!(commitment_update.is_none() && pending_forwards.is_empty() && pending_failures.is_empty());
3770 break Err(MsgHandleErrInternal::ignore_no_close("Previous monitor update failure prevented responses to RAA".to_owned()));
3772 if let Err(e) = handle_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, commitment_update.is_some(), pending_forwards, pending_failures) {
3774 } else { unreachable!(); }
3777 if let Some(updates) = commitment_update {
3778 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
3779 node_id: counterparty_node_id.clone(),
3783 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()))
3785 hash_map::Entry::Vacant(_) => break Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3788 self.fail_holding_cell_htlcs(htlcs_to_fail, msg.channel_id);
3790 Ok((pending_forwards, mut pending_failures, short_channel_id, channel_outpoint)) => {
3791 for failure in pending_failures.drain(..) {
3792 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), failure.0, &failure.1, failure.2);
3794 self.forward_htlcs(&mut [(short_channel_id, channel_outpoint, pending_forwards)]);
3801 fn internal_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), MsgHandleErrInternal> {
3802 let mut channel_lock = self.channel_state.lock().unwrap();
3803 let channel_state = &mut *channel_lock;
3804 match channel_state.by_id.entry(msg.channel_id) {
3805 hash_map::Entry::Occupied(mut chan) => {
3806 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3807 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3809 try_chan_entry!(self, chan.get_mut().update_fee(&self.fee_estimator, &msg), channel_state, chan);
3811 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3816 fn internal_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), MsgHandleErrInternal> {
3817 let mut channel_state_lock = self.channel_state.lock().unwrap();
3818 let channel_state = &mut *channel_state_lock;
3820 match channel_state.by_id.entry(msg.channel_id) {
3821 hash_map::Entry::Occupied(mut chan) => {
3822 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3823 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3825 if !chan.get().is_usable() {
3826 return Err(MsgHandleErrInternal::from_no_close(LightningError{err: "Got an announcement_signatures before we were ready for it".to_owned(), action: msgs::ErrorAction::IgnoreError}));
3829 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
3830 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),
3831 // Note that announcement_signatures fails if the channel cannot be announced,
3832 // so get_channel_update_for_broadcast will never fail by the time we get here.
3833 update_msg: self.get_channel_update_for_broadcast(chan.get()).unwrap(),
3836 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3841 /// Returns ShouldPersist if anything changed, otherwise either SkipPersist or an Err.
3842 fn internal_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) -> Result<NotifyOption, MsgHandleErrInternal> {
3843 let mut channel_state_lock = self.channel_state.lock().unwrap();
3844 let channel_state = &mut *channel_state_lock;
3845 let chan_id = match channel_state.short_to_id.get(&msg.contents.short_channel_id) {
3846 Some(chan_id) => chan_id.clone(),
3848 // It's not a local channel
3849 return Ok(NotifyOption::SkipPersist)
3852 match channel_state.by_id.entry(chan_id) {
3853 hash_map::Entry::Occupied(mut chan) => {
3854 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3855 if chan.get().should_announce() {
3856 // If the announcement is about a channel of ours which is public, some
3857 // other peer may simply be forwarding all its gossip to us. Don't provide
3858 // a scary-looking error message and return Ok instead.
3859 return Ok(NotifyOption::SkipPersist);
3861 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));
3863 let were_node_one = self.get_our_node_id().serialize()[..] < chan.get().get_counterparty_node_id().serialize()[..];
3864 let msg_from_node_one = msg.contents.flags & 1 == 0;
3865 if were_node_one == msg_from_node_one {
3866 return Ok(NotifyOption::SkipPersist);
3868 try_chan_entry!(self, chan.get_mut().channel_update(&msg), channel_state, chan);
3871 hash_map::Entry::Vacant(_) => unreachable!()
3873 Ok(NotifyOption::DoPersist)
3876 fn internal_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<(), MsgHandleErrInternal> {
3877 let chan_restoration_res;
3878 let (htlcs_failed_forward, need_lnd_workaround) = {
3879 let mut channel_state_lock = self.channel_state.lock().unwrap();
3880 let channel_state = &mut *channel_state_lock;
3882 match channel_state.by_id.entry(msg.channel_id) {
3883 hash_map::Entry::Occupied(mut chan) => {
3884 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3885 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3887 // Currently, we expect all holding cell update_adds to be dropped on peer
3888 // disconnect, so Channel's reestablish will never hand us any holding cell
3889 // freed HTLCs to fail backwards. If in the future we no longer drop pending
3890 // add-HTLCs on disconnect, we may be handed HTLCs to fail backwards here.
3891 let (funding_locked, revoke_and_ack, commitment_update, monitor_update_opt, order, htlcs_failed_forward, shutdown) =
3892 try_chan_entry!(self, chan.get_mut().channel_reestablish(msg, &self.logger), channel_state, chan);
3893 let mut channel_update = None;
3894 if let Some(msg) = shutdown {
3895 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
3896 node_id: counterparty_node_id.clone(),
3899 } else if chan.get().is_usable() {
3900 // If the channel is in a usable state (ie the channel is not being shut
3901 // down), send a unicast channel_update to our counterparty to make sure
3902 // they have the latest channel parameters.
3903 channel_update = Some(events::MessageSendEvent::SendChannelUpdate {
3904 node_id: chan.get().get_counterparty_node_id(),
3905 msg: self.get_channel_update_for_unicast(chan.get()).unwrap(),
3908 let need_lnd_workaround = chan.get_mut().workaround_lnd_bug_4006.take();
3909 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);
3910 if let Some(upd) = channel_update {
3911 channel_state.pending_msg_events.push(upd);
3913 (htlcs_failed_forward, need_lnd_workaround)
3915 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3918 post_handle_chan_restoration!(self, chan_restoration_res);
3919 self.fail_holding_cell_htlcs(htlcs_failed_forward, msg.channel_id);
3921 if let Some(funding_locked_msg) = need_lnd_workaround {
3922 self.internal_funding_locked(counterparty_node_id, &funding_locked_msg)?;
3927 /// Process pending events from the `chain::Watch`, returning whether any events were processed.
3928 fn process_pending_monitor_events(&self) -> bool {
3929 let mut failed_channels = Vec::new();
3930 let mut pending_monitor_events = self.chain_monitor.release_pending_monitor_events();
3931 let has_pending_monitor_events = !pending_monitor_events.is_empty();
3932 for monitor_event in pending_monitor_events.drain(..) {
3933 match monitor_event {
3934 MonitorEvent::HTLCEvent(htlc_update) => {
3935 if let Some(preimage) = htlc_update.payment_preimage {
3936 log_trace!(self.logger, "Claiming HTLC with preimage {} from our monitor", log_bytes!(preimage.0));
3937 self.claim_funds_internal(self.channel_state.lock().unwrap(), htlc_update.source, preimage, htlc_update.onchain_value_satoshis.map(|v| v * 1000), true);
3939 log_trace!(self.logger, "Failing HTLC with hash {} from our monitor", log_bytes!(htlc_update.payment_hash.0));
3940 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() });
3943 MonitorEvent::CommitmentTxBroadcasted(funding_outpoint) => {
3944 let mut channel_lock = self.channel_state.lock().unwrap();
3945 let channel_state = &mut *channel_lock;
3946 let by_id = &mut channel_state.by_id;
3947 let short_to_id = &mut channel_state.short_to_id;
3948 let pending_msg_events = &mut channel_state.pending_msg_events;
3949 if let Some(mut chan) = by_id.remove(&funding_outpoint.to_channel_id()) {
3950 if let Some(short_id) = chan.get_short_channel_id() {
3951 short_to_id.remove(&short_id);
3953 failed_channels.push(chan.force_shutdown(false));
3954 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
3955 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
3959 pending_msg_events.push(events::MessageSendEvent::HandleError {
3960 node_id: chan.get_counterparty_node_id(),
3961 action: msgs::ErrorAction::SendErrorMessage {
3962 msg: msgs::ErrorMessage { channel_id: chan.channel_id(), data: "Channel force-closed".to_owned() }
3970 for failure in failed_channels.drain(..) {
3971 self.finish_force_close_channel(failure);
3974 has_pending_monitor_events
3977 /// Check the holding cell in each channel and free any pending HTLCs in them if possible.
3978 /// Returns whether there were any updates such as if pending HTLCs were freed or a monitor
3979 /// update was applied.
3981 /// This should only apply to HTLCs which were added to the holding cell because we were
3982 /// waiting on a monitor update to finish. In that case, we don't want to free the holding cell
3983 /// directly in `channel_monitor_updated` as it may introduce deadlocks calling back into user
3984 /// code to inform them of a channel monitor update.
3985 fn check_free_holding_cells(&self) -> bool {
3986 let mut has_monitor_update = false;
3987 let mut failed_htlcs = Vec::new();
3988 let mut handle_errors = Vec::new();
3990 let mut channel_state_lock = self.channel_state.lock().unwrap();
3991 let channel_state = &mut *channel_state_lock;
3992 let by_id = &mut channel_state.by_id;
3993 let short_to_id = &mut channel_state.short_to_id;
3994 let pending_msg_events = &mut channel_state.pending_msg_events;
3996 by_id.retain(|channel_id, chan| {
3997 match chan.maybe_free_holding_cell_htlcs(&self.logger) {
3998 Ok((commitment_opt, holding_cell_failed_htlcs)) => {
3999 if !holding_cell_failed_htlcs.is_empty() {
4000 failed_htlcs.push((holding_cell_failed_htlcs, *channel_id));
4002 if let Some((commitment_update, monitor_update)) = commitment_opt {
4003 if let Err(e) = self.chain_monitor.update_channel(chan.get_funding_txo().unwrap(), monitor_update) {
4004 has_monitor_update = true;
4005 let (res, close_channel) = handle_monitor_err!(self, e, short_to_id, chan, RAACommitmentOrder::CommitmentFirst, false, true, Vec::new(), Vec::new(), channel_id);
4006 handle_errors.push((chan.get_counterparty_node_id(), res));
4007 if close_channel { return false; }
4009 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
4010 node_id: chan.get_counterparty_node_id(),
4011 updates: commitment_update,
4018 let (close_channel, res) = convert_chan_err!(self, e, short_to_id, chan, channel_id);
4019 handle_errors.push((chan.get_counterparty_node_id(), Err(res)));
4026 let has_update = has_monitor_update || !failed_htlcs.is_empty() || !handle_errors.is_empty();
4027 for (failures, channel_id) in failed_htlcs.drain(..) {
4028 self.fail_holding_cell_htlcs(failures, channel_id);
4031 for (counterparty_node_id, err) in handle_errors.drain(..) {
4032 let _ = handle_error!(self, err, counterparty_node_id);
4038 /// Check whether any channels have finished removing all pending updates after a shutdown
4039 /// exchange and can now send a closing_signed.
4040 /// Returns whether any closing_signed messages were generated.
4041 fn maybe_generate_initial_closing_signed(&self) -> bool {
4042 let mut handle_errors: Vec<(PublicKey, Result<(), _>)> = Vec::new();
4043 let mut has_update = false;
4045 let mut channel_state_lock = self.channel_state.lock().unwrap();
4046 let channel_state = &mut *channel_state_lock;
4047 let by_id = &mut channel_state.by_id;
4048 let short_to_id = &mut channel_state.short_to_id;
4049 let pending_msg_events = &mut channel_state.pending_msg_events;
4051 by_id.retain(|channel_id, chan| {
4052 match chan.maybe_propose_closing_signed(&self.fee_estimator, &self.logger) {
4053 Ok((msg_opt, tx_opt)) => {
4054 if let Some(msg) = msg_opt {
4056 pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
4057 node_id: chan.get_counterparty_node_id(), msg,
4060 if let Some(tx) = tx_opt {
4061 // We're done with this channel. We got a closing_signed and sent back
4062 // a closing_signed with a closing transaction to broadcast.
4063 if let Some(short_id) = chan.get_short_channel_id() {
4064 short_to_id.remove(&short_id);
4067 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
4068 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
4073 log_info!(self.logger, "Broadcasting {}", log_tx!(tx));
4074 self.tx_broadcaster.broadcast_transaction(&tx);
4080 let (close_channel, res) = convert_chan_err!(self, e, short_to_id, chan, channel_id);
4081 handle_errors.push((chan.get_counterparty_node_id(), Err(res)));
4088 for (counterparty_node_id, err) in handle_errors.drain(..) {
4089 let _ = handle_error!(self, err, counterparty_node_id);
4095 /// Handle a list of channel failures during a block_connected or block_disconnected call,
4096 /// pushing the channel monitor update (if any) to the background events queue and removing the
4098 fn handle_init_event_channel_failures(&self, mut failed_channels: Vec<ShutdownResult>) {
4099 for mut failure in failed_channels.drain(..) {
4100 // Either a commitment transactions has been confirmed on-chain or
4101 // Channel::block_disconnected detected that the funding transaction has been
4102 // reorganized out of the main chain.
4103 // We cannot broadcast our latest local state via monitor update (as
4104 // Channel::force_shutdown tries to make us do) as we may still be in initialization,
4105 // so we track the update internally and handle it when the user next calls
4106 // timer_tick_occurred, guaranteeing we're running normally.
4107 if let Some((funding_txo, update)) = failure.0.take() {
4108 assert_eq!(update.updates.len(), 1);
4109 if let ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } = update.updates[0] {
4110 assert!(should_broadcast);
4111 } else { unreachable!(); }
4112 self.pending_background_events.lock().unwrap().push(BackgroundEvent::ClosingMonitorUpdate((funding_txo, update)));
4114 self.finish_force_close_channel(failure);
4118 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> {
4119 assert!(invoice_expiry_delta_secs <= 60*60*24*365); // Sadly bitcoin timestamps are u32s, so panic before 2106
4121 let payment_secret = PaymentSecret(self.keys_manager.get_secure_random_bytes());
4123 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4124 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
4125 match payment_secrets.entry(payment_hash) {
4126 hash_map::Entry::Vacant(e) => {
4127 e.insert(PendingInboundPayment {
4128 payment_secret, min_value_msat, user_payment_id, payment_preimage,
4129 // We assume that highest_seen_timestamp is pretty close to the current time -
4130 // its updated when we receive a new block with the maximum time we've seen in
4131 // a header. It should never be more than two hours in the future.
4132 // Thus, we add two hours here as a buffer to ensure we absolutely
4133 // never fail a payment too early.
4134 // Note that we assume that received blocks have reasonably up-to-date
4136 expiry_time: self.highest_seen_timestamp.load(Ordering::Acquire) as u64 + invoice_expiry_delta_secs as u64 + 7200,
4139 hash_map::Entry::Occupied(_) => return Err(APIError::APIMisuseError { err: "Duplicate payment hash".to_owned() }),
4144 /// Gets a payment secret and payment hash for use in an invoice given to a third party wishing
4147 /// This differs from [`create_inbound_payment_for_hash`] only in that it generates the
4148 /// [`PaymentHash`] and [`PaymentPreimage`] for you, returning the first and storing the second.
4150 /// The [`PaymentPreimage`] will ultimately be returned to you in the [`PaymentReceived`], which
4151 /// will have the [`PaymentReceived::payment_preimage`] field filled in. That should then be
4152 /// passed directly to [`claim_funds`].
4154 /// See [`create_inbound_payment_for_hash`] for detailed documentation on behavior and requirements.
4156 /// [`claim_funds`]: Self::claim_funds
4157 /// [`PaymentReceived`]: events::Event::PaymentReceived
4158 /// [`PaymentReceived::payment_preimage`]: events::Event::PaymentReceived::payment_preimage
4159 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
4160 pub fn create_inbound_payment(&self, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32, user_payment_id: u64) -> (PaymentHash, PaymentSecret) {
4161 let payment_preimage = PaymentPreimage(self.keys_manager.get_secure_random_bytes());
4162 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
4165 self.set_payment_hash_secret_map(payment_hash, Some(payment_preimage), min_value_msat, invoice_expiry_delta_secs, user_payment_id)
4166 .expect("RNG Generated Duplicate PaymentHash"))
4169 /// Gets a [`PaymentSecret`] for a given [`PaymentHash`], for which the payment preimage is
4170 /// stored external to LDK.
4172 /// A [`PaymentReceived`] event will only be generated if the [`PaymentSecret`] matches a
4173 /// payment secret fetched via this method or [`create_inbound_payment`], and which is at least
4174 /// the `min_value_msat` provided here, if one is provided.
4176 /// The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) must be globally unique. This
4177 /// method may return an Err if another payment with the same payment_hash is still pending.
4179 /// `user_payment_id` will be provided back in [`PaymentPurpose::InvoicePayment::user_payment_id`] events to
4180 /// allow tracking of which events correspond with which calls to this and
4181 /// [`create_inbound_payment`]. `user_payment_id` has no meaning inside of LDK, it is simply
4182 /// copied to events and otherwise ignored. It may be used to correlate PaymentReceived events
4183 /// with invoice metadata stored elsewhere.
4185 /// `min_value_msat` should be set if the invoice being generated contains a value. Any payment
4186 /// received for the returned [`PaymentHash`] will be required to be at least `min_value_msat`
4187 /// before a [`PaymentReceived`] event will be generated, ensuring that we do not provide the
4188 /// sender "proof-of-payment" unless they have paid the required amount.
4190 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
4191 /// in excess of the current time. This should roughly match the expiry time set in the invoice.
4192 /// After this many seconds, we will remove the inbound payment, resulting in any attempts to
4193 /// pay the invoice failing. The BOLT spec suggests 3,600 secs as a default validity time for
4194 /// invoices when no timeout is set.
4196 /// Note that we use block header time to time-out pending inbound payments (with some margin
4197 /// to compensate for the inaccuracy of block header timestamps). Thus, in practice we will
4198 /// accept a payment and generate a [`PaymentReceived`] event for some time after the expiry.
4199 /// If you need exact expiry semantics, you should enforce them upon receipt of
4200 /// [`PaymentReceived`].
4202 /// Pending inbound payments are stored in memory and in serialized versions of this
4203 /// [`ChannelManager`]. If potentially unbounded numbers of inbound payments may exist and
4204 /// space is limited, you may wish to rate-limit inbound payment creation.
4206 /// May panic if `invoice_expiry_delta_secs` is greater than one year.
4208 /// Note that invoices generated for inbound payments should have their `min_final_cltv_expiry`
4209 /// set to at least [`MIN_FINAL_CLTV_EXPIRY`].
4211 /// [`create_inbound_payment`]: Self::create_inbound_payment
4212 /// [`PaymentReceived`]: events::Event::PaymentReceived
4213 /// [`PaymentPurpose::InvoicePayment::user_payment_id`]: events::PaymentPurpose::InvoicePayment::user_payment_id
4214 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> {
4215 self.set_payment_hash_secret_map(payment_hash, None, min_value_msat, invoice_expiry_delta_secs, user_payment_id)
4218 #[cfg(any(test, feature = "fuzztarget", feature = "_test_utils"))]
4219 pub fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
4220 let events = core::cell::RefCell::new(Vec::new());
4221 let event_handler = |event: &events::Event| events.borrow_mut().push(event.clone());
4222 self.process_pending_events(&event_handler);
4227 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> MessageSendEventsProvider for ChannelManager<Signer, M, T, K, F, L>
4228 where M::Target: chain::Watch<Signer>,
4229 T::Target: BroadcasterInterface,
4230 K::Target: KeysInterface<Signer = Signer>,
4231 F::Target: FeeEstimator,
4234 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
4235 let events = RefCell::new(Vec::new());
4236 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
4237 let mut result = NotifyOption::SkipPersist;
4239 // TODO: This behavior should be documented. It's unintuitive that we query
4240 // ChannelMonitors when clearing other events.
4241 if self.process_pending_monitor_events() {
4242 result = NotifyOption::DoPersist;
4245 if self.check_free_holding_cells() {
4246 result = NotifyOption::DoPersist;
4248 if self.maybe_generate_initial_closing_signed() {
4249 result = NotifyOption::DoPersist;
4252 let mut pending_events = Vec::new();
4253 let mut channel_state = self.channel_state.lock().unwrap();
4254 mem::swap(&mut pending_events, &mut channel_state.pending_msg_events);
4256 if !pending_events.is_empty() {
4257 events.replace(pending_events);
4266 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> EventsProvider for ChannelManager<Signer, M, T, K, F, L>
4268 M::Target: chain::Watch<Signer>,
4269 T::Target: BroadcasterInterface,
4270 K::Target: KeysInterface<Signer = Signer>,
4271 F::Target: FeeEstimator,
4274 /// Processes events that must be periodically handled.
4276 /// An [`EventHandler`] may safely call back to the provider in order to handle an event.
4277 /// However, it must not call [`Writeable::write`] as doing so would result in a deadlock.
4279 /// Pending events are persisted as part of [`ChannelManager`]. While these events are cleared
4280 /// when processed, an [`EventHandler`] must be able to handle previously seen events when
4281 /// restarting from an old state.
4282 fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler {
4283 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
4284 let mut result = NotifyOption::SkipPersist;
4286 // TODO: This behavior should be documented. It's unintuitive that we query
4287 // ChannelMonitors when clearing other events.
4288 if self.process_pending_monitor_events() {
4289 result = NotifyOption::DoPersist;
4292 let mut pending_events = mem::replace(&mut *self.pending_events.lock().unwrap(), vec![]);
4293 if !pending_events.is_empty() {
4294 result = NotifyOption::DoPersist;
4297 for event in pending_events.drain(..) {
4298 handler.handle_event(&event);
4306 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> chain::Listen for ChannelManager<Signer, M, T, K, F, L>
4308 M::Target: chain::Watch<Signer>,
4309 T::Target: BroadcasterInterface,
4310 K::Target: KeysInterface<Signer = Signer>,
4311 F::Target: FeeEstimator,
4314 fn block_connected(&self, block: &Block, height: u32) {
4316 let best_block = self.best_block.read().unwrap();
4317 assert_eq!(best_block.block_hash(), block.header.prev_blockhash,
4318 "Blocks must be connected in chain-order - the connected header must build on the last connected header");
4319 assert_eq!(best_block.height(), height - 1,
4320 "Blocks must be connected in chain-order - the connected block height must be one greater than the previous height");
4323 let txdata: Vec<_> = block.txdata.iter().enumerate().collect();
4324 self.transactions_confirmed(&block.header, &txdata, height);
4325 self.best_block_updated(&block.header, height);
4328 fn block_disconnected(&self, header: &BlockHeader, height: u32) {
4329 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4330 let new_height = height - 1;
4332 let mut best_block = self.best_block.write().unwrap();
4333 assert_eq!(best_block.block_hash(), header.block_hash(),
4334 "Blocks must be disconnected in chain-order - the disconnected header must be the last connected header");
4335 assert_eq!(best_block.height(), height,
4336 "Blocks must be disconnected in chain-order - the disconnected block must have the correct height");
4337 *best_block = BestBlock::new(header.prev_blockhash, new_height)
4340 self.do_chain_event(Some(new_height), |channel| channel.best_block_updated(new_height, header.time, &self.logger));
4344 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> chain::Confirm for ChannelManager<Signer, M, T, K, F, L>
4346 M::Target: chain::Watch<Signer>,
4347 T::Target: BroadcasterInterface,
4348 K::Target: KeysInterface<Signer = Signer>,
4349 F::Target: FeeEstimator,
4352 fn transactions_confirmed(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
4353 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
4354 // during initialization prior to the chain_monitor being fully configured in some cases.
4355 // See the docs for `ChannelManagerReadArgs` for more.
4357 let block_hash = header.block_hash();
4358 log_trace!(self.logger, "{} transactions included in block {} at height {} provided", txdata.len(), block_hash, height);
4360 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4361 self.do_chain_event(Some(height), |channel| channel.transactions_confirmed(&block_hash, height, txdata, &self.logger).map(|a| (a, Vec::new())));
4364 fn best_block_updated(&self, header: &BlockHeader, height: u32) {
4365 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
4366 // during initialization prior to the chain_monitor being fully configured in some cases.
4367 // See the docs for `ChannelManagerReadArgs` for more.
4369 let block_hash = header.block_hash();
4370 log_trace!(self.logger, "New best block: {} at height {}", block_hash, height);
4372 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4374 *self.best_block.write().unwrap() = BestBlock::new(block_hash, height);
4376 self.do_chain_event(Some(height), |channel| channel.best_block_updated(height, header.time, &self.logger));
4378 macro_rules! max_time {
4379 ($timestamp: expr) => {
4381 // Update $timestamp to be the max of its current value and the block
4382 // timestamp. This should keep us close to the current time without relying on
4383 // having an explicit local time source.
4384 // Just in case we end up in a race, we loop until we either successfully
4385 // update $timestamp or decide we don't need to.
4386 let old_serial = $timestamp.load(Ordering::Acquire);
4387 if old_serial >= header.time as usize { break; }
4388 if $timestamp.compare_exchange(old_serial, header.time as usize, Ordering::AcqRel, Ordering::Relaxed).is_ok() {
4394 max_time!(self.last_node_announcement_serial);
4395 max_time!(self.highest_seen_timestamp);
4396 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
4397 payment_secrets.retain(|_, inbound_payment| {
4398 inbound_payment.expiry_time > header.time as u64
4402 fn get_relevant_txids(&self) -> Vec<Txid> {
4403 let channel_state = self.channel_state.lock().unwrap();
4404 let mut res = Vec::with_capacity(channel_state.short_to_id.len());
4405 for chan in channel_state.by_id.values() {
4406 if let Some(funding_txo) = chan.get_funding_txo() {
4407 res.push(funding_txo.txid);
4413 fn transaction_unconfirmed(&self, txid: &Txid) {
4414 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4415 self.do_chain_event(None, |channel| {
4416 if let Some(funding_txo) = channel.get_funding_txo() {
4417 if funding_txo.txid == *txid {
4418 channel.funding_transaction_unconfirmed(&self.logger).map(|_| (None, Vec::new()))
4419 } else { Ok((None, Vec::new())) }
4420 } else { Ok((None, Vec::new())) }
4425 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<Signer, M, T, K, F, L>
4427 M::Target: chain::Watch<Signer>,
4428 T::Target: BroadcasterInterface,
4429 K::Target: KeysInterface<Signer = Signer>,
4430 F::Target: FeeEstimator,
4433 /// Calls a function which handles an on-chain event (blocks dis/connected, transactions
4434 /// un/confirmed, etc) on each channel, handling any resulting errors or messages generated by
4436 fn do_chain_event<FN: Fn(&mut Channel<Signer>) -> Result<(Option<msgs::FundingLocked>, Vec<(HTLCSource, PaymentHash)>), msgs::ErrorMessage>>
4437 (&self, height_opt: Option<u32>, f: FN) {
4438 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
4439 // during initialization prior to the chain_monitor being fully configured in some cases.
4440 // See the docs for `ChannelManagerReadArgs` for more.
4442 let mut failed_channels = Vec::new();
4443 let mut timed_out_htlcs = Vec::new();
4445 let mut channel_lock = self.channel_state.lock().unwrap();
4446 let channel_state = &mut *channel_lock;
4447 let short_to_id = &mut channel_state.short_to_id;
4448 let pending_msg_events = &mut channel_state.pending_msg_events;
4449 channel_state.by_id.retain(|_, channel| {
4450 let res = f(channel);
4451 if let Ok((chan_res, mut timed_out_pending_htlcs)) = res {
4452 for (source, payment_hash) in timed_out_pending_htlcs.drain(..) {
4453 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
4454 timed_out_htlcs.push((source, payment_hash, HTLCFailReason::Reason {
4455 failure_code: 0x1000 | 14, // expiry_too_soon, or at least it is now
4459 if let Some(funding_locked) = chan_res {
4460 pending_msg_events.push(events::MessageSendEvent::SendFundingLocked {
4461 node_id: channel.get_counterparty_node_id(),
4462 msg: funding_locked,
4464 if let Some(announcement_sigs) = self.get_announcement_sigs(channel) {
4465 log_trace!(self.logger, "Sending funding_locked and announcement_signatures for {}", log_bytes!(channel.channel_id()));
4466 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
4467 node_id: channel.get_counterparty_node_id(),
4468 msg: announcement_sigs,
4470 } else if channel.is_usable() {
4471 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()));
4472 pending_msg_events.push(events::MessageSendEvent::SendChannelUpdate {
4473 node_id: channel.get_counterparty_node_id(),
4474 msg: self.get_channel_update_for_unicast(channel).unwrap(),
4477 log_trace!(self.logger, "Sending funding_locked WITHOUT announcement_signatures for {}", log_bytes!(channel.channel_id()));
4479 short_to_id.insert(channel.get_short_channel_id().unwrap(), channel.channel_id());
4481 } else if let Err(e) = res {
4482 if let Some(short_id) = channel.get_short_channel_id() {
4483 short_to_id.remove(&short_id);
4485 // It looks like our counterparty went on-chain or funding transaction was
4486 // reorged out of the main chain. Close the channel.
4487 failed_channels.push(channel.force_shutdown(true));
4488 if let Ok(update) = self.get_channel_update_for_broadcast(&channel) {
4489 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
4493 pending_msg_events.push(events::MessageSendEvent::HandleError {
4494 node_id: channel.get_counterparty_node_id(),
4495 action: msgs::ErrorAction::SendErrorMessage { msg: e },
4502 if let Some(height) = height_opt {
4503 channel_state.claimable_htlcs.retain(|payment_hash, htlcs| {
4504 htlcs.retain(|htlc| {
4505 // If height is approaching the number of blocks we think it takes us to get
4506 // our commitment transaction confirmed before the HTLC expires, plus the
4507 // number of blocks we generally consider it to take to do a commitment update,
4508 // just give up on it and fail the HTLC.
4509 if height >= htlc.cltv_expiry - HTLC_FAIL_BACK_BUFFER {
4510 let mut htlc_msat_height_data = byte_utils::be64_to_array(htlc.value).to_vec();
4511 htlc_msat_height_data.extend_from_slice(&byte_utils::be32_to_array(height));
4512 timed_out_htlcs.push((HTLCSource::PreviousHopData(htlc.prev_hop.clone()), payment_hash.clone(), HTLCFailReason::Reason {
4513 failure_code: 0x4000 | 15,
4514 data: htlc_msat_height_data
4519 !htlcs.is_empty() // Only retain this entry if htlcs has at least one entry.
4524 self.handle_init_event_channel_failures(failed_channels);
4526 for (source, payment_hash, reason) in timed_out_htlcs.drain(..) {
4527 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), source, &payment_hash, reason);
4531 /// Blocks until ChannelManager needs to be persisted or a timeout is reached. It returns a bool
4532 /// indicating whether persistence is necessary. Only one listener on
4533 /// `await_persistable_update` or `await_persistable_update_timeout` is guaranteed to be woken
4535 /// Note that the feature `allow_wallclock_use` must be enabled to use this function.
4536 #[cfg(any(test, feature = "allow_wallclock_use"))]
4537 pub fn await_persistable_update_timeout(&self, max_wait: Duration) -> bool {
4538 self.persistence_notifier.wait_timeout(max_wait)
4541 /// Blocks until ChannelManager needs to be persisted. Only one listener on
4542 /// `await_persistable_update` or `await_persistable_update_timeout` is guaranteed to be woken
4544 pub fn await_persistable_update(&self) {
4545 self.persistence_notifier.wait()
4548 #[cfg(any(test, feature = "_test_utils"))]
4549 pub fn get_persistence_condvar_value(&self) -> bool {
4550 let mutcond = &self.persistence_notifier.persistence_lock;
4551 let &(ref mtx, _) = mutcond;
4552 let guard = mtx.lock().unwrap();
4556 /// Gets the latest best block which was connected either via the [`chain::Listen`] or
4557 /// [`chain::Confirm`] interfaces.
4558 pub fn current_best_block(&self) -> BestBlock {
4559 self.best_block.read().unwrap().clone()
4563 impl<Signer: Sign, M: Deref , T: Deref , K: Deref , F: Deref , L: Deref >
4564 ChannelMessageHandler for ChannelManager<Signer, M, T, K, F, L>
4565 where M::Target: chain::Watch<Signer>,
4566 T::Target: BroadcasterInterface,
4567 K::Target: KeysInterface<Signer = Signer>,
4568 F::Target: FeeEstimator,
4571 fn handle_open_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::OpenChannel) {
4572 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4573 let _ = handle_error!(self, self.internal_open_channel(counterparty_node_id, their_features, msg), *counterparty_node_id);
4576 fn handle_accept_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::AcceptChannel) {
4577 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4578 let _ = handle_error!(self, self.internal_accept_channel(counterparty_node_id, their_features, msg), *counterparty_node_id);
4581 fn handle_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) {
4582 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4583 let _ = handle_error!(self, self.internal_funding_created(counterparty_node_id, msg), *counterparty_node_id);
4586 fn handle_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) {
4587 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4588 let _ = handle_error!(self, self.internal_funding_signed(counterparty_node_id, msg), *counterparty_node_id);
4591 fn handle_funding_locked(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingLocked) {
4592 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4593 let _ = handle_error!(self, self.internal_funding_locked(counterparty_node_id, msg), *counterparty_node_id);
4596 fn handle_shutdown(&self, counterparty_node_id: &PublicKey, their_features: &InitFeatures, msg: &msgs::Shutdown) {
4597 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4598 let _ = handle_error!(self, self.internal_shutdown(counterparty_node_id, their_features, msg), *counterparty_node_id);
4601 fn handle_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
4602 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4603 let _ = handle_error!(self, self.internal_closing_signed(counterparty_node_id, msg), *counterparty_node_id);
4606 fn handle_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
4607 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4608 let _ = handle_error!(self, self.internal_update_add_htlc(counterparty_node_id, msg), *counterparty_node_id);
4611 fn handle_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
4612 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4613 let _ = handle_error!(self, self.internal_update_fulfill_htlc(counterparty_node_id, msg), *counterparty_node_id);
4616 fn handle_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
4617 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4618 let _ = handle_error!(self, self.internal_update_fail_htlc(counterparty_node_id, msg), *counterparty_node_id);
4621 fn handle_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
4622 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4623 let _ = handle_error!(self, self.internal_update_fail_malformed_htlc(counterparty_node_id, msg), *counterparty_node_id);
4626 fn handle_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
4627 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4628 let _ = handle_error!(self, self.internal_commitment_signed(counterparty_node_id, msg), *counterparty_node_id);
4631 fn handle_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
4632 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4633 let _ = handle_error!(self, self.internal_revoke_and_ack(counterparty_node_id, msg), *counterparty_node_id);
4636 fn handle_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) {
4637 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4638 let _ = handle_error!(self, self.internal_update_fee(counterparty_node_id, msg), *counterparty_node_id);
4641 fn handle_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
4642 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4643 let _ = handle_error!(self, self.internal_announcement_signatures(counterparty_node_id, msg), *counterparty_node_id);
4646 fn handle_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) {
4647 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
4648 if let Ok(persist) = handle_error!(self, self.internal_channel_update(counterparty_node_id, msg), *counterparty_node_id) {
4651 NotifyOption::SkipPersist
4656 fn handle_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
4657 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4658 let _ = handle_error!(self, self.internal_channel_reestablish(counterparty_node_id, msg), *counterparty_node_id);
4661 fn peer_disconnected(&self, counterparty_node_id: &PublicKey, no_connection_possible: bool) {
4662 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4663 let mut failed_channels = Vec::new();
4664 let mut no_channels_remain = true;
4666 let mut channel_state_lock = self.channel_state.lock().unwrap();
4667 let channel_state = &mut *channel_state_lock;
4668 let short_to_id = &mut channel_state.short_to_id;
4669 let pending_msg_events = &mut channel_state.pending_msg_events;
4670 if no_connection_possible {
4671 log_debug!(self.logger, "Failing all channels with {} due to no_connection_possible", log_pubkey!(counterparty_node_id));
4672 channel_state.by_id.retain(|_, chan| {
4673 if chan.get_counterparty_node_id() == *counterparty_node_id {
4674 if let Some(short_id) = chan.get_short_channel_id() {
4675 short_to_id.remove(&short_id);
4677 failed_channels.push(chan.force_shutdown(true));
4678 if let Ok(update) = self.get_channel_update_for_broadcast(&chan) {
4679 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
4689 log_debug!(self.logger, "Marking channels with {} disconnected and generating channel_updates", log_pubkey!(counterparty_node_id));
4690 channel_state.by_id.retain(|_, chan| {
4691 if chan.get_counterparty_node_id() == *counterparty_node_id {
4692 chan.remove_uncommitted_htlcs_and_mark_paused(&self.logger);
4693 if chan.is_shutdown() {
4694 if let Some(short_id) = chan.get_short_channel_id() {
4695 short_to_id.remove(&short_id);
4699 no_channels_remain = false;
4705 pending_msg_events.retain(|msg| {
4707 &events::MessageSendEvent::SendAcceptChannel { ref node_id, .. } => node_id != counterparty_node_id,
4708 &events::MessageSendEvent::SendOpenChannel { ref node_id, .. } => node_id != counterparty_node_id,
4709 &events::MessageSendEvent::SendFundingCreated { ref node_id, .. } => node_id != counterparty_node_id,
4710 &events::MessageSendEvent::SendFundingSigned { ref node_id, .. } => node_id != counterparty_node_id,
4711 &events::MessageSendEvent::SendFundingLocked { ref node_id, .. } => node_id != counterparty_node_id,
4712 &events::MessageSendEvent::SendAnnouncementSignatures { ref node_id, .. } => node_id != counterparty_node_id,
4713 &events::MessageSendEvent::UpdateHTLCs { ref node_id, .. } => node_id != counterparty_node_id,
4714 &events::MessageSendEvent::SendRevokeAndACK { ref node_id, .. } => node_id != counterparty_node_id,
4715 &events::MessageSendEvent::SendClosingSigned { ref node_id, .. } => node_id != counterparty_node_id,
4716 &events::MessageSendEvent::SendShutdown { ref node_id, .. } => node_id != counterparty_node_id,
4717 &events::MessageSendEvent::SendChannelReestablish { ref node_id, .. } => node_id != counterparty_node_id,
4718 &events::MessageSendEvent::BroadcastChannelAnnouncement { .. } => true,
4719 &events::MessageSendEvent::BroadcastNodeAnnouncement { .. } => true,
4720 &events::MessageSendEvent::BroadcastChannelUpdate { .. } => true,
4721 &events::MessageSendEvent::SendChannelUpdate { ref node_id, .. } => node_id != counterparty_node_id,
4722 &events::MessageSendEvent::HandleError { ref node_id, .. } => node_id != counterparty_node_id,
4723 &events::MessageSendEvent::SendChannelRangeQuery { .. } => false,
4724 &events::MessageSendEvent::SendShortIdsQuery { .. } => false,
4725 &events::MessageSendEvent::SendReplyChannelRange { .. } => false,
4729 if no_channels_remain {
4730 self.per_peer_state.write().unwrap().remove(counterparty_node_id);
4733 for failure in failed_channels.drain(..) {
4734 self.finish_force_close_channel(failure);
4738 fn peer_connected(&self, counterparty_node_id: &PublicKey, init_msg: &msgs::Init) {
4739 log_debug!(self.logger, "Generating channel_reestablish events for {}", log_pubkey!(counterparty_node_id));
4741 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4744 let mut peer_state_lock = self.per_peer_state.write().unwrap();
4745 match peer_state_lock.entry(counterparty_node_id.clone()) {
4746 hash_map::Entry::Vacant(e) => {
4747 e.insert(Mutex::new(PeerState {
4748 latest_features: init_msg.features.clone(),
4751 hash_map::Entry::Occupied(e) => {
4752 e.get().lock().unwrap().latest_features = init_msg.features.clone();
4757 let mut channel_state_lock = self.channel_state.lock().unwrap();
4758 let channel_state = &mut *channel_state_lock;
4759 let pending_msg_events = &mut channel_state.pending_msg_events;
4760 channel_state.by_id.retain(|_, chan| {
4761 if chan.get_counterparty_node_id() == *counterparty_node_id {
4762 if !chan.have_received_message() {
4763 // If we created this (outbound) channel while we were disconnected from the
4764 // peer we probably failed to send the open_channel message, which is now
4765 // lost. We can't have had anything pending related to this channel, so we just
4769 pending_msg_events.push(events::MessageSendEvent::SendChannelReestablish {
4770 node_id: chan.get_counterparty_node_id(),
4771 msg: chan.get_channel_reestablish(&self.logger),
4777 //TODO: Also re-broadcast announcement_signatures
4780 fn handle_error(&self, counterparty_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
4781 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4783 if msg.channel_id == [0; 32] {
4784 for chan in self.list_channels() {
4785 if chan.counterparty.node_id == *counterparty_node_id {
4786 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
4787 let _ = self.force_close_channel_with_peer(&chan.channel_id, Some(counterparty_node_id));
4791 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
4792 let _ = self.force_close_channel_with_peer(&msg.channel_id, Some(counterparty_node_id));
4797 /// Used to signal to the ChannelManager persister that the manager needs to be re-persisted to
4798 /// disk/backups, through `await_persistable_update_timeout` and `await_persistable_update`.
4799 struct PersistenceNotifier {
4800 /// Users won't access the persistence_lock directly, but rather wait on its bool using
4801 /// `wait_timeout` and `wait`.
4802 persistence_lock: (Mutex<bool>, Condvar),
4805 impl PersistenceNotifier {
4808 persistence_lock: (Mutex::new(false), Condvar::new()),
4814 let &(ref mtx, ref cvar) = &self.persistence_lock;
4815 let mut guard = mtx.lock().unwrap();
4820 guard = cvar.wait(guard).unwrap();
4821 let result = *guard;
4829 #[cfg(any(test, feature = "allow_wallclock_use"))]
4830 fn wait_timeout(&self, max_wait: Duration) -> bool {
4831 let current_time = Instant::now();
4833 let &(ref mtx, ref cvar) = &self.persistence_lock;
4834 let mut guard = mtx.lock().unwrap();
4839 guard = cvar.wait_timeout(guard, max_wait).unwrap().0;
4840 // Due to spurious wakeups that can happen on `wait_timeout`, here we need to check if the
4841 // desired wait time has actually passed, and if not then restart the loop with a reduced wait
4842 // time. Note that this logic can be highly simplified through the use of
4843 // `Condvar::wait_while` and `Condvar::wait_timeout_while`, if and when our MSRV is raised to
4845 let elapsed = current_time.elapsed();
4846 let result = *guard;
4847 if result || elapsed >= max_wait {
4851 match max_wait.checked_sub(elapsed) {
4852 None => return result,
4858 // Signal to the ChannelManager persister that there are updates necessitating persisting to disk.
4860 let &(ref persist_mtx, ref cnd) = &self.persistence_lock;
4861 let mut persistence_lock = persist_mtx.lock().unwrap();
4862 *persistence_lock = true;
4863 mem::drop(persistence_lock);
4868 const SERIALIZATION_VERSION: u8 = 1;
4869 const MIN_SERIALIZATION_VERSION: u8 = 1;
4871 impl_writeable_tlv_based_enum!(PendingHTLCRouting,
4873 (0, onion_packet, required),
4874 (2, short_channel_id, required),
4877 (0, payment_data, required),
4878 (2, incoming_cltv_expiry, required),
4880 (2, ReceiveKeysend) => {
4881 (0, payment_preimage, required),
4882 (2, incoming_cltv_expiry, required),
4886 impl_writeable_tlv_based!(PendingHTLCInfo, {
4887 (0, routing, required),
4888 (2, incoming_shared_secret, required),
4889 (4, payment_hash, required),
4890 (6, amt_to_forward, required),
4891 (8, outgoing_cltv_value, required)
4894 impl_writeable_tlv_based_enum!(HTLCFailureMsg, ;
4898 impl_writeable_tlv_based_enum!(PendingHTLCStatus, ;
4903 impl_writeable_tlv_based!(HTLCPreviousHopData, {
4904 (0, short_channel_id, required),
4905 (2, outpoint, required),
4906 (4, htlc_id, required),
4907 (6, incoming_packet_shared_secret, required)
4910 impl Writeable for ClaimableHTLC {
4911 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
4912 let payment_data = match &self.onion_payload {
4913 OnionPayload::Invoice(data) => Some(data.clone()),
4916 let keysend_preimage = match self.onion_payload {
4917 OnionPayload::Invoice(_) => None,
4918 OnionPayload::Spontaneous(preimage) => Some(preimage.clone()),
4923 (0, self.prev_hop, required), (2, self.value, required),
4924 (4, payment_data, option), (6, self.cltv_expiry, required),
4925 (8, keysend_preimage, option),
4931 impl Readable for ClaimableHTLC {
4932 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
4933 let mut prev_hop = ::util::ser::OptionDeserWrapper(None);
4935 let mut payment_data: Option<msgs::FinalOnionHopData> = None;
4936 let mut cltv_expiry = 0;
4937 let mut keysend_preimage: Option<PaymentPreimage> = None;
4941 (0, prev_hop, required), (2, value, required),
4942 (4, payment_data, option), (6, cltv_expiry, required),
4943 (8, keysend_preimage, option)
4945 let onion_payload = match keysend_preimage {
4947 if payment_data.is_some() {
4948 return Err(DecodeError::InvalidValue)
4950 OnionPayload::Spontaneous(p)
4953 if payment_data.is_none() {
4954 return Err(DecodeError::InvalidValue)
4956 OnionPayload::Invoice(payment_data.unwrap())
4960 prev_hop: prev_hop.0.unwrap(),
4968 impl Readable for HTLCSource {
4969 fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError> {
4970 let id: u8 = Readable::read(reader)?;
4973 let mut session_priv: ::util::ser::OptionDeserWrapper<SecretKey> = ::util::ser::OptionDeserWrapper(None);
4974 let mut first_hop_htlc_msat: u64 = 0;
4975 let mut path = Some(Vec::new());
4976 let mut mpp_id = None;
4977 read_tlv_fields!(reader, {
4978 (0, session_priv, required),
4979 (1, mpp_id, option),
4980 (2, first_hop_htlc_msat, required),
4981 (4, path, vec_type),
4983 if mpp_id.is_none() {
4984 // For backwards compat, if there was no mpp_id written, use the session_priv bytes
4986 mpp_id = Some(MppId(*session_priv.0.unwrap().as_ref()));
4988 Ok(HTLCSource::OutboundRoute {
4989 session_priv: session_priv.0.unwrap(),
4990 first_hop_htlc_msat: first_hop_htlc_msat,
4991 path: path.unwrap(),
4992 mpp_id: mpp_id.unwrap(),
4995 1 => Ok(HTLCSource::PreviousHopData(Readable::read(reader)?)),
4996 _ => Err(DecodeError::UnknownRequiredFeature),
5001 impl Writeable for HTLCSource {
5002 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::io::Error> {
5004 HTLCSource::OutboundRoute { ref session_priv, ref first_hop_htlc_msat, ref path, mpp_id } => {
5006 let mpp_id_opt = Some(mpp_id);
5007 write_tlv_fields!(writer, {
5008 (0, session_priv, required),
5009 (1, mpp_id_opt, option),
5010 (2, first_hop_htlc_msat, required),
5011 (4, path, vec_type),
5014 HTLCSource::PreviousHopData(ref field) => {
5016 field.write(writer)?;
5023 impl_writeable_tlv_based_enum!(HTLCFailReason,
5024 (0, LightningError) => {
5028 (0, failure_code, required),
5029 (2, data, vec_type),
5033 impl_writeable_tlv_based_enum!(HTLCForwardInfo,
5035 (0, forward_info, required),
5036 (2, prev_short_channel_id, required),
5037 (4, prev_htlc_id, required),
5038 (6, prev_funding_outpoint, required),
5041 (0, htlc_id, required),
5042 (2, err_packet, required),
5046 impl_writeable_tlv_based!(PendingInboundPayment, {
5047 (0, payment_secret, required),
5048 (2, expiry_time, required),
5049 (4, user_payment_id, required),
5050 (6, payment_preimage, required),
5051 (8, min_value_msat, required),
5054 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> Writeable for ChannelManager<Signer, M, T, K, F, L>
5055 where M::Target: chain::Watch<Signer>,
5056 T::Target: BroadcasterInterface,
5057 K::Target: KeysInterface<Signer = Signer>,
5058 F::Target: FeeEstimator,
5061 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
5062 let _consistency_lock = self.total_consistency_lock.write().unwrap();
5064 write_ver_prefix!(writer, SERIALIZATION_VERSION, MIN_SERIALIZATION_VERSION);
5066 self.genesis_hash.write(writer)?;
5068 let best_block = self.best_block.read().unwrap();
5069 best_block.height().write(writer)?;
5070 best_block.block_hash().write(writer)?;
5073 let channel_state = self.channel_state.lock().unwrap();
5074 let mut unfunded_channels = 0;
5075 for (_, channel) in channel_state.by_id.iter() {
5076 if !channel.is_funding_initiated() {
5077 unfunded_channels += 1;
5080 ((channel_state.by_id.len() - unfunded_channels) as u64).write(writer)?;
5081 for (_, channel) in channel_state.by_id.iter() {
5082 if channel.is_funding_initiated() {
5083 channel.write(writer)?;
5087 (channel_state.forward_htlcs.len() as u64).write(writer)?;
5088 for (short_channel_id, pending_forwards) in channel_state.forward_htlcs.iter() {
5089 short_channel_id.write(writer)?;
5090 (pending_forwards.len() as u64).write(writer)?;
5091 for forward in pending_forwards {
5092 forward.write(writer)?;
5096 (channel_state.claimable_htlcs.len() as u64).write(writer)?;
5097 for (payment_hash, previous_hops) in channel_state.claimable_htlcs.iter() {
5098 payment_hash.write(writer)?;
5099 (previous_hops.len() as u64).write(writer)?;
5100 for htlc in previous_hops.iter() {
5101 htlc.write(writer)?;
5105 let per_peer_state = self.per_peer_state.write().unwrap();
5106 (per_peer_state.len() as u64).write(writer)?;
5107 for (peer_pubkey, peer_state_mutex) in per_peer_state.iter() {
5108 peer_pubkey.write(writer)?;
5109 let peer_state = peer_state_mutex.lock().unwrap();
5110 peer_state.latest_features.write(writer)?;
5113 let events = self.pending_events.lock().unwrap();
5114 (events.len() as u64).write(writer)?;
5115 for event in events.iter() {
5116 event.write(writer)?;
5119 let background_events = self.pending_background_events.lock().unwrap();
5120 (background_events.len() as u64).write(writer)?;
5121 for event in background_events.iter() {
5123 BackgroundEvent::ClosingMonitorUpdate((funding_txo, monitor_update)) => {
5125 funding_txo.write(writer)?;
5126 monitor_update.write(writer)?;
5131 (self.last_node_announcement_serial.load(Ordering::Acquire) as u32).write(writer)?;
5132 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
5134 let pending_inbound_payments = self.pending_inbound_payments.lock().unwrap();
5135 (pending_inbound_payments.len() as u64).write(writer)?;
5136 for (hash, pending_payment) in pending_inbound_payments.iter() {
5137 hash.write(writer)?;
5138 pending_payment.write(writer)?;
5141 let pending_outbound_payments = self.pending_outbound_payments.lock().unwrap();
5142 // For backwards compat, write the session privs and their total length.
5143 let mut num_pending_outbounds_compat: u64 = 0;
5144 for (_, outbounds) in pending_outbound_payments.iter() {
5145 num_pending_outbounds_compat += outbounds.len() as u64;
5147 num_pending_outbounds_compat.write(writer)?;
5148 for (_, outbounds) in pending_outbound_payments.iter() {
5149 for outbound in outbounds.iter() {
5150 outbound.write(writer)?;
5154 write_tlv_fields!(writer, {
5155 (1, pending_outbound_payments, required),
5162 /// Arguments for the creation of a ChannelManager that are not deserialized.
5164 /// At a high-level, the process for deserializing a ChannelManager and resuming normal operation
5166 /// 1) Deserialize all stored ChannelMonitors.
5167 /// 2) Deserialize the ChannelManager by filling in this struct and calling:
5168 /// <(BlockHash, ChannelManager)>::read(reader, args)
5169 /// This may result in closing some Channels if the ChannelMonitor is newer than the stored
5170 /// ChannelManager state to ensure no loss of funds. Thus, transactions may be broadcasted.
5171 /// 3) If you are not fetching full blocks, register all relevant ChannelMonitor outpoints the same
5172 /// way you would handle a `chain::Filter` call using ChannelMonitor::get_outputs_to_watch() and
5173 /// ChannelMonitor::get_funding_txo().
5174 /// 4) Reconnect blocks on your ChannelMonitors.
5175 /// 5) Disconnect/connect blocks on the ChannelManager.
5176 /// 6) Move the ChannelMonitors into your local chain::Watch.
5178 /// Note that the ordering of #4-6 is not of importance, however all three must occur before you
5179 /// call any other methods on the newly-deserialized ChannelManager.
5181 /// Note that because some channels may be closed during deserialization, it is critical that you
5182 /// always deserialize only the latest version of a ChannelManager and ChannelMonitors available to
5183 /// you. If you deserialize an old ChannelManager (during which force-closure transactions may be
5184 /// broadcast), and then later deserialize a newer version of the same ChannelManager (which will
5185 /// not force-close the same channels but consider them live), you may end up revoking a state for
5186 /// which you've already broadcasted the transaction.
5187 pub struct ChannelManagerReadArgs<'a, Signer: 'a + Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
5188 where M::Target: chain::Watch<Signer>,
5189 T::Target: BroadcasterInterface,
5190 K::Target: KeysInterface<Signer = Signer>,
5191 F::Target: FeeEstimator,
5194 /// The keys provider which will give us relevant keys. Some keys will be loaded during
5195 /// deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
5197 pub keys_manager: K,
5199 /// The fee_estimator for use in the ChannelManager in the future.
5201 /// No calls to the FeeEstimator will be made during deserialization.
5202 pub fee_estimator: F,
5203 /// The chain::Watch for use in the ChannelManager in the future.
5205 /// No calls to the chain::Watch will be made during deserialization. It is assumed that
5206 /// you have deserialized ChannelMonitors separately and will add them to your
5207 /// chain::Watch after deserializing this ChannelManager.
5208 pub chain_monitor: M,
5210 /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
5211 /// used to broadcast the latest local commitment transactions of channels which must be
5212 /// force-closed during deserialization.
5213 pub tx_broadcaster: T,
5214 /// The Logger for use in the ChannelManager and which may be used to log information during
5215 /// deserialization.
5217 /// Default settings used for new channels. Any existing channels will continue to use the
5218 /// runtime settings which were stored when the ChannelManager was serialized.
5219 pub default_config: UserConfig,
5221 /// A map from channel funding outpoints to ChannelMonitors for those channels (ie
5222 /// value.get_funding_txo() should be the key).
5224 /// If a monitor is inconsistent with the channel state during deserialization the channel will
5225 /// be force-closed using the data in the ChannelMonitor and the channel will be dropped. This
5226 /// is true for missing channels as well. If there is a monitor missing for which we find
5227 /// channel data Err(DecodeError::InvalidValue) will be returned.
5229 /// In such cases the latest local transactions will be sent to the tx_broadcaster included in
5232 /// (C-not exported) because we have no HashMap bindings
5233 pub channel_monitors: HashMap<OutPoint, &'a mut ChannelMonitor<Signer>>,
5236 impl<'a, Signer: 'a + Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
5237 ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>
5238 where M::Target: chain::Watch<Signer>,
5239 T::Target: BroadcasterInterface,
5240 K::Target: KeysInterface<Signer = Signer>,
5241 F::Target: FeeEstimator,
5244 /// Simple utility function to create a ChannelManagerReadArgs which creates the monitor
5245 /// HashMap for you. This is primarily useful for C bindings where it is not practical to
5246 /// populate a HashMap directly from C.
5247 pub fn new(keys_manager: K, fee_estimator: F, chain_monitor: M, tx_broadcaster: T, logger: L, default_config: UserConfig,
5248 mut channel_monitors: Vec<&'a mut ChannelMonitor<Signer>>) -> Self {
5250 keys_manager, fee_estimator, chain_monitor, tx_broadcaster, logger, default_config,
5251 channel_monitors: channel_monitors.drain(..).map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect()
5256 // Implement ReadableArgs for an Arc'd ChannelManager to make it a bit easier to work with the
5257 // SipmleArcChannelManager type:
5258 impl<'a, Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
5259 ReadableArgs<ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>> for (BlockHash, Arc<ChannelManager<Signer, M, T, K, F, L>>)
5260 where M::Target: chain::Watch<Signer>,
5261 T::Target: BroadcasterInterface,
5262 K::Target: KeysInterface<Signer = Signer>,
5263 F::Target: FeeEstimator,
5266 fn read<R: io::Read>(reader: &mut R, args: ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>) -> Result<Self, DecodeError> {
5267 let (blockhash, chan_manager) = <(BlockHash, ChannelManager<Signer, M, T, K, F, L>)>::read(reader, args)?;
5268 Ok((blockhash, Arc::new(chan_manager)))
5272 impl<'a, Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
5273 ReadableArgs<ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>> for (BlockHash, ChannelManager<Signer, M, T, K, F, L>)
5274 where M::Target: chain::Watch<Signer>,
5275 T::Target: BroadcasterInterface,
5276 K::Target: KeysInterface<Signer = Signer>,
5277 F::Target: FeeEstimator,
5280 fn read<R: io::Read>(reader: &mut R, mut args: ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>) -> Result<Self, DecodeError> {
5281 let _ver = read_ver_prefix!(reader, SERIALIZATION_VERSION);
5283 let genesis_hash: BlockHash = Readable::read(reader)?;
5284 let best_block_height: u32 = Readable::read(reader)?;
5285 let best_block_hash: BlockHash = Readable::read(reader)?;
5287 let mut failed_htlcs = Vec::new();
5289 let channel_count: u64 = Readable::read(reader)?;
5290 let mut funding_txo_set = HashSet::with_capacity(cmp::min(channel_count as usize, 128));
5291 let mut by_id = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
5292 let mut short_to_id = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
5293 for _ in 0..channel_count {
5294 let mut channel: Channel<Signer> = Channel::read(reader, &args.keys_manager)?;
5295 let funding_txo = channel.get_funding_txo().ok_or(DecodeError::InvalidValue)?;
5296 funding_txo_set.insert(funding_txo.clone());
5297 if let Some(ref mut monitor) = args.channel_monitors.get_mut(&funding_txo) {
5298 if channel.get_cur_holder_commitment_transaction_number() < monitor.get_cur_holder_commitment_number() ||
5299 channel.get_revoked_counterparty_commitment_transaction_number() < monitor.get_min_seen_secret() ||
5300 channel.get_cur_counterparty_commitment_transaction_number() < monitor.get_cur_counterparty_commitment_number() ||
5301 channel.get_latest_monitor_update_id() > monitor.get_latest_update_id() {
5302 // If the channel is ahead of the monitor, return InvalidValue:
5303 log_error!(args.logger, "A ChannelMonitor is stale compared to the current ChannelManager! This indicates a potentially-critical violation of the chain::Watch API!");
5304 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
5305 log_bytes!(channel.channel_id()), monitor.get_latest_update_id(), channel.get_latest_monitor_update_id());
5306 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
5307 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
5308 log_error!(args.logger, " Without the latest ChannelMonitor we cannot continue without risking funds.");
5309 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");
5310 return Err(DecodeError::InvalidValue);
5311 } else if channel.get_cur_holder_commitment_transaction_number() > monitor.get_cur_holder_commitment_number() ||
5312 channel.get_revoked_counterparty_commitment_transaction_number() > monitor.get_min_seen_secret() ||
5313 channel.get_cur_counterparty_commitment_transaction_number() > monitor.get_cur_counterparty_commitment_number() ||
5314 channel.get_latest_monitor_update_id() < monitor.get_latest_update_id() {
5315 // But if the channel is behind of the monitor, close the channel:
5316 log_error!(args.logger, "A ChannelManager is stale compared to the current ChannelMonitor!");
5317 log_error!(args.logger, " The channel will be force-closed and the latest commitment transaction from the ChannelMonitor broadcast.");
5318 log_error!(args.logger, " The ChannelMonitor for channel {} is at update_id {} but the ChannelManager is at update_id {}.",
5319 log_bytes!(channel.channel_id()), monitor.get_latest_update_id(), channel.get_latest_monitor_update_id());
5320 let (_, mut new_failed_htlcs) = channel.force_shutdown(true);
5321 failed_htlcs.append(&mut new_failed_htlcs);
5322 monitor.broadcast_latest_holder_commitment_txn(&args.tx_broadcaster, &args.logger);
5324 if let Some(short_channel_id) = channel.get_short_channel_id() {
5325 short_to_id.insert(short_channel_id, channel.channel_id());
5327 by_id.insert(channel.channel_id(), channel);
5330 log_error!(args.logger, "Missing ChannelMonitor for channel {} needed by ChannelManager.", log_bytes!(channel.channel_id()));
5331 log_error!(args.logger, " The chain::Watch API *requires* that monitors are persisted durably before returning,");
5332 log_error!(args.logger, " client applications must ensure that ChannelMonitor data is always available and the latest to avoid funds loss!");
5333 log_error!(args.logger, " Without the ChannelMonitor we cannot continue without risking funds.");
5334 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");
5335 return Err(DecodeError::InvalidValue);
5339 for (ref funding_txo, ref mut monitor) in args.channel_monitors.iter_mut() {
5340 if !funding_txo_set.contains(funding_txo) {
5341 monitor.broadcast_latest_holder_commitment_txn(&args.tx_broadcaster, &args.logger);
5345 const MAX_ALLOC_SIZE: usize = 1024 * 64;
5346 let forward_htlcs_count: u64 = Readable::read(reader)?;
5347 let mut forward_htlcs = HashMap::with_capacity(cmp::min(forward_htlcs_count as usize, 128));
5348 for _ in 0..forward_htlcs_count {
5349 let short_channel_id = Readable::read(reader)?;
5350 let pending_forwards_count: u64 = Readable::read(reader)?;
5351 let mut pending_forwards = Vec::with_capacity(cmp::min(pending_forwards_count as usize, MAX_ALLOC_SIZE/mem::size_of::<HTLCForwardInfo>()));
5352 for _ in 0..pending_forwards_count {
5353 pending_forwards.push(Readable::read(reader)?);
5355 forward_htlcs.insert(short_channel_id, pending_forwards);
5358 let claimable_htlcs_count: u64 = Readable::read(reader)?;
5359 let mut claimable_htlcs = HashMap::with_capacity(cmp::min(claimable_htlcs_count as usize, 128));
5360 for _ in 0..claimable_htlcs_count {
5361 let payment_hash = Readable::read(reader)?;
5362 let previous_hops_len: u64 = Readable::read(reader)?;
5363 let mut previous_hops = Vec::with_capacity(cmp::min(previous_hops_len as usize, MAX_ALLOC_SIZE/mem::size_of::<ClaimableHTLC>()));
5364 for _ in 0..previous_hops_len {
5365 previous_hops.push(Readable::read(reader)?);
5367 claimable_htlcs.insert(payment_hash, previous_hops);
5370 let peer_count: u64 = Readable::read(reader)?;
5371 let mut per_peer_state = HashMap::with_capacity(cmp::min(peer_count as usize, MAX_ALLOC_SIZE/mem::size_of::<(PublicKey, Mutex<PeerState>)>()));
5372 for _ in 0..peer_count {
5373 let peer_pubkey = Readable::read(reader)?;
5374 let peer_state = PeerState {
5375 latest_features: Readable::read(reader)?,
5377 per_peer_state.insert(peer_pubkey, Mutex::new(peer_state));
5380 let event_count: u64 = Readable::read(reader)?;
5381 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>()));
5382 for _ in 0..event_count {
5383 match MaybeReadable::read(reader)? {
5384 Some(event) => pending_events_read.push(event),
5389 let background_event_count: u64 = Readable::read(reader)?;
5390 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>()));
5391 for _ in 0..background_event_count {
5392 match <u8 as Readable>::read(reader)? {
5393 0 => pending_background_events_read.push(BackgroundEvent::ClosingMonitorUpdate((Readable::read(reader)?, Readable::read(reader)?))),
5394 _ => return Err(DecodeError::InvalidValue),
5398 let last_node_announcement_serial: u32 = Readable::read(reader)?;
5399 let highest_seen_timestamp: u32 = Readable::read(reader)?;
5401 let pending_inbound_payment_count: u64 = Readable::read(reader)?;
5402 let mut pending_inbound_payments: HashMap<PaymentHash, PendingInboundPayment> = HashMap::with_capacity(cmp::min(pending_inbound_payment_count as usize, MAX_ALLOC_SIZE/(3*32)));
5403 for _ in 0..pending_inbound_payment_count {
5404 if pending_inbound_payments.insert(Readable::read(reader)?, Readable::read(reader)?).is_some() {
5405 return Err(DecodeError::InvalidValue);
5409 let pending_outbound_payments_count_compat: u64 = Readable::read(reader)?;
5410 let mut pending_outbound_payments_compat: HashMap<MppId, HashSet<[u8; 32]>> =
5411 HashMap::with_capacity(cmp::min(pending_outbound_payments_count_compat as usize, MAX_ALLOC_SIZE/32));
5412 for _ in 0..pending_outbound_payments_count_compat {
5413 let session_priv = Readable::read(reader)?;
5414 if pending_outbound_payments_compat.insert(MppId(session_priv), [session_priv].iter().cloned().collect()).is_some() {
5415 return Err(DecodeError::InvalidValue)
5419 let mut pending_outbound_payments = None;
5420 read_tlv_fields!(reader, {
5421 (1, pending_outbound_payments, option),
5423 if pending_outbound_payments.is_none() {
5424 pending_outbound_payments = Some(pending_outbound_payments_compat);
5427 let mut secp_ctx = Secp256k1::new();
5428 secp_ctx.seeded_randomize(&args.keys_manager.get_secure_random_bytes());
5430 let channel_manager = ChannelManager {
5432 fee_estimator: args.fee_estimator,
5433 chain_monitor: args.chain_monitor,
5434 tx_broadcaster: args.tx_broadcaster,
5436 best_block: RwLock::new(BestBlock::new(best_block_hash, best_block_height)),
5438 channel_state: Mutex::new(ChannelHolder {
5443 pending_msg_events: Vec::new(),
5445 pending_inbound_payments: Mutex::new(pending_inbound_payments),
5446 pending_outbound_payments: Mutex::new(pending_outbound_payments.unwrap()),
5448 our_network_key: args.keys_manager.get_node_secret(),
5449 our_network_pubkey: PublicKey::from_secret_key(&secp_ctx, &args.keys_manager.get_node_secret()),
5452 last_node_announcement_serial: AtomicUsize::new(last_node_announcement_serial as usize),
5453 highest_seen_timestamp: AtomicUsize::new(highest_seen_timestamp as usize),
5455 per_peer_state: RwLock::new(per_peer_state),
5457 pending_events: Mutex::new(pending_events_read),
5458 pending_background_events: Mutex::new(pending_background_events_read),
5459 total_consistency_lock: RwLock::new(()),
5460 persistence_notifier: PersistenceNotifier::new(),
5462 keys_manager: args.keys_manager,
5463 logger: args.logger,
5464 default_configuration: args.default_config,
5467 for htlc_source in failed_htlcs.drain(..) {
5468 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() });
5471 //TODO: Broadcast channel update for closed channels, but only after we've made a
5472 //connection or two.
5474 Ok((best_block_hash.clone(), channel_manager))
5480 use bitcoin::hashes::Hash;
5481 use bitcoin::hashes::sha256::Hash as Sha256;
5482 use core::time::Duration;
5483 use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
5484 use ln::channelmanager::{MppId, PaymentSendFailure};
5485 use ln::features::{InitFeatures, InvoiceFeatures};
5486 use ln::functional_test_utils::*;
5488 use ln::msgs::ChannelMessageHandler;
5489 use routing::router::{get_keysend_route, get_route};
5490 use util::errors::APIError;
5491 use util::events::{Event, MessageSendEvent, MessageSendEventsProvider};
5492 use util::test_utils;
5494 #[cfg(feature = "std")]
5496 fn test_wait_timeout() {
5497 use ln::channelmanager::PersistenceNotifier;
5499 use core::sync::atomic::{AtomicBool, Ordering};
5502 let persistence_notifier = Arc::new(PersistenceNotifier::new());
5503 let thread_notifier = Arc::clone(&persistence_notifier);
5505 let exit_thread = Arc::new(AtomicBool::new(false));
5506 let exit_thread_clone = exit_thread.clone();
5507 thread::spawn(move || {
5509 let &(ref persist_mtx, ref cnd) = &thread_notifier.persistence_lock;
5510 let mut persistence_lock = persist_mtx.lock().unwrap();
5511 *persistence_lock = true;
5514 if exit_thread_clone.load(Ordering::SeqCst) {
5520 // Check that we can block indefinitely until updates are available.
5521 let _ = persistence_notifier.wait();
5523 // Check that the PersistenceNotifier will return after the given duration if updates are
5526 if persistence_notifier.wait_timeout(Duration::from_millis(100)) {
5531 exit_thread.store(true, Ordering::SeqCst);
5533 // Check that the PersistenceNotifier will return after the given duration even if no updates
5536 if !persistence_notifier.wait_timeout(Duration::from_millis(100)) {
5543 fn test_notify_limits() {
5544 // Check that a few cases which don't require the persistence of a new ChannelManager,
5545 // indeed, do not cause the persistence of a new ChannelManager.
5546 let chanmon_cfgs = create_chanmon_cfgs(3);
5547 let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5548 let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5549 let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5551 // All nodes start with a persistable update pending as `create_network` connects each node
5552 // with all other nodes to make most tests simpler.
5553 assert!(nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
5554 assert!(nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
5555 assert!(nodes[2].node.await_persistable_update_timeout(Duration::from_millis(1)));
5557 let mut chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5559 // We check that the channel info nodes have doesn't change too early, even though we try
5560 // to connect messages with new values
5561 chan.0.contents.fee_base_msat *= 2;
5562 chan.1.contents.fee_base_msat *= 2;
5563 let node_a_chan_info = nodes[0].node.list_channels()[0].clone();
5564 let node_b_chan_info = nodes[1].node.list_channels()[0].clone();
5566 // The first two nodes (which opened a channel) should now require fresh persistence
5567 assert!(nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
5568 assert!(nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
5569 // ... but the last node should not.
5570 assert!(!nodes[2].node.await_persistable_update_timeout(Duration::from_millis(1)));
5571 // After persisting the first two nodes they should no longer need fresh persistence.
5572 assert!(!nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
5573 assert!(!nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
5575 // Node 3, unrelated to the only channel, shouldn't care if it receives a channel_update
5576 // about the channel.
5577 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.0);
5578 nodes[2].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &chan.1);
5579 assert!(!nodes[2].node.await_persistable_update_timeout(Duration::from_millis(1)));
5581 // The nodes which are a party to the channel should also ignore messages from unrelated
5583 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
5584 nodes[0].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
5585 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.0);
5586 nodes[1].node.handle_channel_update(&nodes[2].node.get_our_node_id(), &chan.1);
5587 assert!(!nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
5588 assert!(!nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
5590 // At this point the channel info given by peers should still be the same.
5591 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
5592 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
5594 // An earlier version of handle_channel_update didn't check the directionality of the
5595 // update message and would always update the local fee info, even if our peer was
5596 // (spuriously) forwarding us our own channel_update.
5597 let as_node_one = nodes[0].node.get_our_node_id().serialize()[..] < nodes[1].node.get_our_node_id().serialize()[..];
5598 let as_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.0 } else { &chan.1 };
5599 let bs_update = if as_node_one == (chan.0.contents.flags & 1 == 0 /* chan.0 is from node one */) { &chan.1 } else { &chan.0 };
5601 // First deliver each peers' own message, checking that the node doesn't need to be
5602 // persisted and that its channel info remains the same.
5603 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &as_update);
5604 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &bs_update);
5605 assert!(!nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
5606 assert!(!nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
5607 assert_eq!(nodes[0].node.list_channels()[0], node_a_chan_info);
5608 assert_eq!(nodes[1].node.list_channels()[0], node_b_chan_info);
5610 // Finally, deliver the other peers' message, ensuring each node needs to be persisted and
5611 // the channel info has updated.
5612 nodes[0].node.handle_channel_update(&nodes[1].node.get_our_node_id(), &bs_update);
5613 nodes[1].node.handle_channel_update(&nodes[0].node.get_our_node_id(), &as_update);
5614 assert!(nodes[0].node.await_persistable_update_timeout(Duration::from_millis(1)));
5615 assert!(nodes[1].node.await_persistable_update_timeout(Duration::from_millis(1)));
5616 assert_ne!(nodes[0].node.list_channels()[0], node_a_chan_info);
5617 assert_ne!(nodes[1].node.list_channels()[0], node_b_chan_info);
5621 fn test_keysend_dup_hash_partial_mpp() {
5622 // Test that a keysend payment with a duplicate hash to an existing partial MPP payment fails as
5624 let chanmon_cfgs = create_chanmon_cfgs(2);
5625 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5626 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5627 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5628 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5629 let logger = test_utils::TestLogger::new();
5631 // First, send a partial MPP payment.
5632 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5633 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();
5634 let (payment_preimage, our_payment_hash, payment_secret) = get_payment_preimage_hash!(&nodes[1]);
5635 let mpp_id = MppId([42; 32]);
5636 // Use the utility function send_payment_along_path to send the payment with MPP data which
5637 // indicates there are more HTLCs coming.
5638 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.
5639 nodes[0].node.send_payment_along_path(&route.paths[0], &our_payment_hash, &Some(payment_secret), 200_000, cur_height, mpp_id, &None).unwrap();
5640 check_added_monitors!(nodes[0], 1);
5641 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5642 assert_eq!(events.len(), 1);
5643 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false, None);
5645 // Next, send a keysend payment with the same payment_hash and make sure it fails.
5646 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage)).unwrap();
5647 check_added_monitors!(nodes[0], 1);
5648 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5649 assert_eq!(events.len(), 1);
5650 let ev = events.drain(..).next().unwrap();
5651 let payment_event = SendEvent::from_event(ev);
5652 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
5653 check_added_monitors!(nodes[1], 0);
5654 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
5655 expect_pending_htlcs_forwardable!(nodes[1]);
5656 expect_pending_htlcs_forwardable!(nodes[1]);
5657 check_added_monitors!(nodes[1], 1);
5658 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5659 assert!(updates.update_add_htlcs.is_empty());
5660 assert!(updates.update_fulfill_htlcs.is_empty());
5661 assert_eq!(updates.update_fail_htlcs.len(), 1);
5662 assert!(updates.update_fail_malformed_htlcs.is_empty());
5663 assert!(updates.update_fee.is_none());
5664 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5665 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
5666 expect_payment_failed!(nodes[0], our_payment_hash, true);
5668 // Send the second half of the original MPP payment.
5669 nodes[0].node.send_payment_along_path(&route.paths[0], &our_payment_hash, &Some(payment_secret), 200_000, cur_height, mpp_id, &None).unwrap();
5670 check_added_monitors!(nodes[0], 1);
5671 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5672 assert_eq!(events.len(), 1);
5673 pass_along_path(&nodes[0], &[&nodes[1]], 200_000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), true, None);
5675 // Claim the full MPP payment. Note that we can't use a test utility like
5676 // claim_funds_along_route because the ordering of the messages causes the second half of the
5677 // payment to be put in the holding cell, which confuses the test utilities. So we exchange the
5678 // lightning messages manually.
5679 assert!(nodes[1].node.claim_funds(payment_preimage));
5680 check_added_monitors!(nodes[1], 2);
5681 let bs_first_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5682 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_first_updates.update_fulfill_htlcs[0]);
5683 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_first_updates.commitment_signed);
5684 check_added_monitors!(nodes[0], 1);
5685 let (as_first_raa, as_first_cs) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5686 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_first_raa);
5687 check_added_monitors!(nodes[1], 1);
5688 let bs_second_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5689 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_first_cs);
5690 check_added_monitors!(nodes[1], 1);
5691 let bs_first_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
5692 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_second_updates.update_fulfill_htlcs[0]);
5693 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_updates.commitment_signed);
5694 check_added_monitors!(nodes[0], 1);
5695 let as_second_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
5696 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_first_raa);
5697 let as_second_updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5698 check_added_monitors!(nodes[0], 1);
5699 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_raa);
5700 check_added_monitors!(nodes[1], 1);
5701 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_updates.commitment_signed);
5702 check_added_monitors!(nodes[1], 1);
5703 let bs_third_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
5704 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_third_raa);
5705 check_added_monitors!(nodes[0], 1);
5707 // Note that successful MPP payments will generate 1 event upon the first path's success. No
5708 // further events will be generated for subsequence path successes.
5709 let events = nodes[0].node.get_and_clear_pending_events();
5711 Event::PaymentSent { payment_preimage: ref preimage } => {
5712 assert_eq!(payment_preimage, *preimage);
5714 _ => panic!("Unexpected event"),
5719 fn test_keysend_dup_payment_hash() {
5720 // (1): Test that a keysend payment with a duplicate payment hash to an existing pending
5721 // outbound regular payment fails as expected.
5722 // (2): Test that a regular payment with a duplicate payment hash to an existing keysend payment
5723 // fails as expected.
5724 let chanmon_cfgs = create_chanmon_cfgs(2);
5725 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5726 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5727 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5728 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5729 let logger = test_utils::TestLogger::new();
5731 // To start (1), send a regular payment but don't claim it.
5732 let expected_route = [&nodes[1]];
5733 let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &expected_route, 100_000);
5735 // Next, attempt a keysend payment and make sure it fails.
5736 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();
5737 nodes[0].node.send_spontaneous_payment(&route, Some(payment_preimage)).unwrap();
5738 check_added_monitors!(nodes[0], 1);
5739 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5740 assert_eq!(events.len(), 1);
5741 let ev = events.drain(..).next().unwrap();
5742 let payment_event = SendEvent::from_event(ev);
5743 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
5744 check_added_monitors!(nodes[1], 0);
5745 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
5746 expect_pending_htlcs_forwardable!(nodes[1]);
5747 expect_pending_htlcs_forwardable!(nodes[1]);
5748 check_added_monitors!(nodes[1], 1);
5749 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5750 assert!(updates.update_add_htlcs.is_empty());
5751 assert!(updates.update_fulfill_htlcs.is_empty());
5752 assert_eq!(updates.update_fail_htlcs.len(), 1);
5753 assert!(updates.update_fail_malformed_htlcs.is_empty());
5754 assert!(updates.update_fee.is_none());
5755 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5756 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
5757 expect_payment_failed!(nodes[0], payment_hash, true);
5759 // Finally, claim the original payment.
5760 claim_payment(&nodes[0], &expected_route, payment_preimage);
5762 // To start (2), send a keysend payment but don't claim it.
5763 let payment_preimage = PaymentPreimage([42; 32]);
5764 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();
5765 let payment_hash = 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 event = events.pop().unwrap();
5770 let path = vec![&nodes[1]];
5771 pass_along_path(&nodes[0], &path, 100_000, payment_hash, None, event, true, Some(payment_preimage));
5773 // Next, attempt a regular payment and make sure it fails.
5774 let payment_secret = PaymentSecret([43; 32]);
5775 nodes[0].node.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
5776 check_added_monitors!(nodes[0], 1);
5777 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5778 assert_eq!(events.len(), 1);
5779 let ev = events.drain(..).next().unwrap();
5780 let payment_event = SendEvent::from_event(ev);
5781 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
5782 check_added_monitors!(nodes[1], 0);
5783 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
5784 expect_pending_htlcs_forwardable!(nodes[1]);
5785 expect_pending_htlcs_forwardable!(nodes[1]);
5786 check_added_monitors!(nodes[1], 1);
5787 let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5788 assert!(updates.update_add_htlcs.is_empty());
5789 assert!(updates.update_fulfill_htlcs.is_empty());
5790 assert_eq!(updates.update_fail_htlcs.len(), 1);
5791 assert!(updates.update_fail_malformed_htlcs.is_empty());
5792 assert!(updates.update_fee.is_none());
5793 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5794 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, true, true);
5795 expect_payment_failed!(nodes[0], payment_hash, true);
5797 // Finally, succeed the keysend payment.
5798 claim_payment(&nodes[0], &expected_route, payment_preimage);
5802 fn test_keysend_hash_mismatch() {
5803 // Test that if we receive a keysend `update_add_htlc` msg, we fail as expected if the keysend
5804 // preimage doesn't match the msg's payment hash.
5805 let chanmon_cfgs = create_chanmon_cfgs(2);
5806 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5807 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5808 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5810 let payer_pubkey = nodes[0].node.get_our_node_id();
5811 let payee_pubkey = nodes[1].node.get_our_node_id();
5812 nodes[0].node.peer_connected(&payee_pubkey, &msgs::Init { features: InitFeatures::known() });
5813 nodes[1].node.peer_connected(&payer_pubkey, &msgs::Init { features: InitFeatures::known() });
5815 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
5816 let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
5817 let first_hops = nodes[0].node.list_usable_channels();
5818 let route = get_keysend_route(&payer_pubkey, network_graph, &payee_pubkey,
5819 Some(&first_hops.iter().collect::<Vec<_>>()), &vec![], 10000, 40,
5820 nodes[0].logger).unwrap();
5822 let test_preimage = PaymentPreimage([42; 32]);
5823 let mismatch_payment_hash = PaymentHash([43; 32]);
5824 let _ = nodes[0].node.send_payment_internal(&route, mismatch_payment_hash, &None, Some(test_preimage)).unwrap();
5825 check_added_monitors!(nodes[0], 1);
5827 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5828 assert_eq!(updates.update_add_htlcs.len(), 1);
5829 assert!(updates.update_fulfill_htlcs.is_empty());
5830 assert!(updates.update_fail_htlcs.is_empty());
5831 assert!(updates.update_fail_malformed_htlcs.is_empty());
5832 assert!(updates.update_fee.is_none());
5833 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5835 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Payment preimage didn't match payment hash".to_string(), 1);
5839 fn test_keysend_msg_with_secret_err() {
5840 // Test that we error as expected if we receive a keysend payment that includes a payment secret.
5841 let chanmon_cfgs = create_chanmon_cfgs(2);
5842 let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5843 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5844 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5846 let payer_pubkey = nodes[0].node.get_our_node_id();
5847 let payee_pubkey = nodes[1].node.get_our_node_id();
5848 nodes[0].node.peer_connected(&payee_pubkey, &msgs::Init { features: InitFeatures::known() });
5849 nodes[1].node.peer_connected(&payer_pubkey, &msgs::Init { features: InitFeatures::known() });
5851 let _chan = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
5852 let network_graph = &nodes[0].net_graph_msg_handler.network_graph;
5853 let first_hops = nodes[0].node.list_usable_channels();
5854 let route = get_keysend_route(&payer_pubkey, network_graph, &payee_pubkey,
5855 Some(&first_hops.iter().collect::<Vec<_>>()), &vec![], 10000, 40,
5856 nodes[0].logger).unwrap();
5858 let test_preimage = PaymentPreimage([42; 32]);
5859 let test_secret = PaymentSecret([43; 32]);
5860 let payment_hash = PaymentHash(Sha256::hash(&test_preimage.0).into_inner());
5861 let _ = nodes[0].node.send_payment_internal(&route, payment_hash, &Some(test_secret), Some(test_preimage)).unwrap();
5862 check_added_monitors!(nodes[0], 1);
5864 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5865 assert_eq!(updates.update_add_htlcs.len(), 1);
5866 assert!(updates.update_fulfill_htlcs.is_empty());
5867 assert!(updates.update_fail_htlcs.is_empty());
5868 assert!(updates.update_fail_malformed_htlcs.is_empty());
5869 assert!(updates.update_fee.is_none());
5870 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5872 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "We don't support MPP keysend payments".to_string(), 1);
5876 fn test_multi_hop_missing_secret() {
5877 let chanmon_cfgs = create_chanmon_cfgs(4);
5878 let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
5879 let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
5880 let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
5882 let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
5883 let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
5884 let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
5885 let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
5886 let logger = test_utils::TestLogger::new();
5888 // Marshall an MPP route.
5889 let (_, payment_hash, _) = get_payment_preimage_hash!(&nodes[3]);
5890 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5891 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();
5892 let path = route.paths[0].clone();
5893 route.paths.push(path);
5894 route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
5895 route.paths[0][0].short_channel_id = chan_1_id;
5896 route.paths[0][1].short_channel_id = chan_3_id;
5897 route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
5898 route.paths[1][0].short_channel_id = chan_2_id;
5899 route.paths[1][1].short_channel_id = chan_4_id;
5901 match nodes[0].node.send_payment(&route, payment_hash, &None).unwrap_err() {
5902 PaymentSendFailure::ParameterError(APIError::APIMisuseError { ref err }) => {
5903 assert!(regex::Regex::new(r"Payment secret is required for multi-path payments").unwrap().is_match(err)) },
5904 _ => panic!("unexpected error")
5909 #[cfg(all(any(test, feature = "_test_utils"), feature = "unstable"))]
5912 use chain::chainmonitor::ChainMonitor;
5913 use chain::channelmonitor::Persist;
5914 use chain::keysinterface::{KeysManager, InMemorySigner};
5915 use ln::channelmanager::{BestBlock, ChainParameters, ChannelManager, PaymentHash, PaymentPreimage};
5916 use ln::features::{InitFeatures, InvoiceFeatures};
5917 use ln::functional_test_utils::*;
5918 use ln::msgs::{ChannelMessageHandler, Init};
5919 use routing::network_graph::NetworkGraph;
5920 use routing::router::get_route;
5921 use util::test_utils;
5922 use util::config::UserConfig;
5923 use util::events::{Event, MessageSendEvent, MessageSendEventsProvider, PaymentPurpose};
5925 use bitcoin::hashes::Hash;
5926 use bitcoin::hashes::sha256::Hash as Sha256;
5927 use bitcoin::{Block, BlockHeader, Transaction, TxOut};
5929 use sync::{Arc, Mutex};
5933 struct NodeHolder<'a, P: Persist<InMemorySigner>> {
5934 node: &'a ChannelManager<InMemorySigner,
5935 &'a ChainMonitor<InMemorySigner, &'a test_utils::TestChainSource,
5936 &'a test_utils::TestBroadcaster, &'a test_utils::TestFeeEstimator,
5937 &'a test_utils::TestLogger, &'a P>,
5938 &'a test_utils::TestBroadcaster, &'a KeysManager,
5939 &'a test_utils::TestFeeEstimator, &'a test_utils::TestLogger>
5944 fn bench_sends(bench: &mut Bencher) {
5945 bench_two_sends(bench, test_utils::TestPersister::new(), test_utils::TestPersister::new());
5948 pub fn bench_two_sends<P: Persist<InMemorySigner>>(bench: &mut Bencher, persister_a: P, persister_b: P) {
5949 // Do a simple benchmark of sending a payment back and forth between two nodes.
5950 // Note that this is unrealistic as each payment send will require at least two fsync
5952 let network = bitcoin::Network::Testnet;
5953 let genesis_hash = bitcoin::blockdata::constants::genesis_block(network).header.block_hash();
5955 let tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), blocks: Arc::new(Mutex::new(Vec::new()))};
5956 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
5958 let mut config: UserConfig = Default::default();
5959 config.own_channel_config.minimum_depth = 1;
5961 let logger_a = test_utils::TestLogger::with_id("node a".to_owned());
5962 let chain_monitor_a = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_a);
5963 let seed_a = [1u8; 32];
5964 let keys_manager_a = KeysManager::new(&seed_a, 42, 42);
5965 let node_a = ChannelManager::new(&fee_estimator, &chain_monitor_a, &tx_broadcaster, &logger_a, &keys_manager_a, config.clone(), ChainParameters {
5967 best_block: BestBlock::from_genesis(network),
5969 let node_a_holder = NodeHolder { node: &node_a };
5971 let logger_b = test_utils::TestLogger::with_id("node a".to_owned());
5972 let chain_monitor_b = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_b);
5973 let seed_b = [2u8; 32];
5974 let keys_manager_b = KeysManager::new(&seed_b, 42, 42);
5975 let node_b = ChannelManager::new(&fee_estimator, &chain_monitor_b, &tx_broadcaster, &logger_b, &keys_manager_b, config.clone(), ChainParameters {
5977 best_block: BestBlock::from_genesis(network),
5979 let node_b_holder = NodeHolder { node: &node_b };
5981 node_a.peer_connected(&node_b.get_our_node_id(), &Init { features: InitFeatures::known() });
5982 node_b.peer_connected(&node_a.get_our_node_id(), &Init { features: InitFeatures::known() });
5983 node_a.create_channel(node_b.get_our_node_id(), 8_000_000, 100_000_000, 42, None).unwrap();
5984 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()));
5985 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()));
5988 if let Event::FundingGenerationReady { temporary_channel_id, output_script, .. } = get_event!(node_a_holder, Event::FundingGenerationReady) {
5989 tx = Transaction { version: 2, lock_time: 0, input: Vec::new(), output: vec![TxOut {
5990 value: 8_000_000, script_pubkey: output_script,
5992 node_a.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
5993 } else { panic!(); }
5995 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()));
5996 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()));
5998 assert_eq!(&tx_broadcaster.txn_broadcasted.lock().unwrap()[..], &[tx.clone()]);
6001 header: BlockHeader { version: 0x20000000, prev_blockhash: genesis_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
6004 Listen::block_connected(&node_a, &block, 1);
6005 Listen::block_connected(&node_b, &block, 1);
6007 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()));
6008 let msg_events = node_a.get_and_clear_pending_msg_events();
6009 assert_eq!(msg_events.len(), 2);
6010 match msg_events[0] {
6011 MessageSendEvent::SendFundingLocked { ref msg, .. } => {
6012 node_b.handle_funding_locked(&node_a.get_our_node_id(), msg);
6013 get_event_msg!(node_b_holder, MessageSendEvent::SendChannelUpdate, node_a.get_our_node_id());
6017 match msg_events[1] {
6018 MessageSendEvent::SendChannelUpdate { .. } => {},
6022 let dummy_graph = NetworkGraph::new(genesis_hash);
6024 let mut payment_count: u64 = 0;
6025 macro_rules! send_payment {
6026 ($node_a: expr, $node_b: expr) => {
6027 let usable_channels = $node_a.list_usable_channels();
6028 let route = get_route(&$node_a.get_our_node_id(), &dummy_graph, &$node_b.get_our_node_id(), Some(InvoiceFeatures::known()),
6029 Some(&usable_channels.iter().map(|r| r).collect::<Vec<_>>()), &[], 10_000, TEST_FINAL_CLTV, &logger_a).unwrap();
6031 let mut payment_preimage = PaymentPreimage([0; 32]);
6032 payment_preimage.0[0..8].copy_from_slice(&payment_count.to_le_bytes());
6034 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
6035 let payment_secret = $node_b.create_inbound_payment_for_hash(payment_hash, None, 7200, 0).unwrap();
6037 $node_a.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
6038 let payment_event = SendEvent::from_event($node_a.get_and_clear_pending_msg_events().pop().unwrap());
6039 $node_b.handle_update_add_htlc(&$node_a.get_our_node_id(), &payment_event.msgs[0]);
6040 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &payment_event.commitment_msg);
6041 let (raa, cs) = get_revoke_commit_msgs!(NodeHolder { node: &$node_b }, $node_a.get_our_node_id());
6042 $node_a.handle_revoke_and_ack(&$node_b.get_our_node_id(), &raa);
6043 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &cs);
6044 $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()));
6046 expect_pending_htlcs_forwardable!(NodeHolder { node: &$node_b });
6047 expect_payment_received!(NodeHolder { node: &$node_b }, payment_hash, payment_secret, 10_000);
6048 assert!($node_b.claim_funds(payment_preimage));
6050 match $node_b.get_and_clear_pending_msg_events().pop().unwrap() {
6051 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
6052 assert_eq!(node_id, $node_a.get_our_node_id());
6053 $node_a.handle_update_fulfill_htlc(&$node_b.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
6054 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &updates.commitment_signed);
6056 _ => panic!("Failed to generate claim event"),
6059 let (raa, cs) = get_revoke_commit_msgs!(NodeHolder { node: &$node_a }, $node_b.get_our_node_id());
6060 $node_b.handle_revoke_and_ack(&$node_a.get_our_node_id(), &raa);
6061 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &cs);
6062 $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()));
6064 expect_payment_sent!(NodeHolder { node: &$node_a }, payment_preimage);
6069 send_payment!(node_a, node_b);
6070 send_payment!(node_b, node_a);