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;
41 use chain::chaininterface::{BroadcasterInterface, FeeEstimator};
42 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};
43 use chain::transaction::{OutPoint, TransactionData};
44 // Since this struct is returned in `list_channels` methods, expose it here in case users want to
45 // construct one themselves.
46 use ln::{PaymentHash, PaymentPreimage, PaymentSecret};
47 pub use ln::channel::CounterpartyForwardingInfo;
48 use ln::channel::{Channel, ChannelError, ChannelUpdateStatus};
49 use ln::features::{InitFeatures, NodeFeatures};
50 use routing::router::{Route, RouteHop};
52 use ln::msgs::NetAddress;
54 use ln::msgs::{ChannelMessageHandler, DecodeError, LightningError, OptionalField};
55 use chain::keysinterface::{Sign, KeysInterface, KeysManager, InMemorySigner};
56 use util::config::UserConfig;
57 use util::events::{EventHandler, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
58 use util::{byte_utils, events};
59 use util::ser::{Readable, ReadableArgs, MaybeReadable, Writeable, Writer};
60 use util::chacha20::{ChaCha20, ChaChaReader};
61 use util::logger::Logger;
62 use util::errors::APIError;
65 use std::cell::RefCell;
66 use std::collections::{HashMap, hash_map, HashSet};
67 use std::io::{Cursor, Read};
68 use std::sync::{Arc, Condvar, Mutex, MutexGuard, RwLock, RwLockReadGuard};
69 use core::sync::atomic::{AtomicUsize, Ordering};
70 use core::time::Duration;
71 #[cfg(any(test, feature = "allow_wallclock_use"))]
72 use std::time::Instant;
74 use bitcoin::hashes::hex::ToHex;
76 // We hold various information about HTLC relay in the HTLC objects in Channel itself:
78 // Upon receipt of an HTLC from a peer, we'll give it a PendingHTLCStatus indicating if it should
79 // forward the HTLC with information it will give back to us when it does so, or if it should Fail
80 // the HTLC with the relevant message for the Channel to handle giving to the remote peer.
82 // Once said HTLC is committed in the Channel, if the PendingHTLCStatus indicated Forward, the
83 // Channel will return the PendingHTLCInfo back to us, and we will create an HTLCForwardInfo
84 // with it to track where it came from (in case of onwards-forward error), waiting a random delay
85 // before we forward it.
87 // We will then use HTLCForwardInfo's PendingHTLCInfo to construct an outbound HTLC, with a
88 // relevant HTLCSource::PreviousHopData filled in to indicate where it came from (which we can use
89 // to either fail-backwards or fulfill the HTLC backwards along the relevant path).
90 // Alternatively, we can fill an outbound HTLC with a HTLCSource::OutboundRoute indicating this is
91 // our payment, which we can use to decode errors or inform the user that the payment was sent.
93 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
94 enum PendingHTLCRouting {
96 onion_packet: msgs::OnionPacket,
97 short_channel_id: u64, // This should be NonZero<u64> eventually when we bump MSRV
100 payment_data: msgs::FinalOnionHopData,
101 incoming_cltv_expiry: u32, // Used to track when we should expire pending HTLCs that go unclaimed
105 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
106 pub(super) struct PendingHTLCInfo {
107 routing: PendingHTLCRouting,
108 incoming_shared_secret: [u8; 32],
109 payment_hash: PaymentHash,
110 pub(super) amt_to_forward: u64,
111 pub(super) outgoing_cltv_value: u32,
114 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
115 pub(super) enum HTLCFailureMsg {
116 Relay(msgs::UpdateFailHTLC),
117 Malformed(msgs::UpdateFailMalformedHTLC),
120 /// Stores whether we can't forward an HTLC or relevant forwarding info
121 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
122 pub(super) enum PendingHTLCStatus {
123 Forward(PendingHTLCInfo),
124 Fail(HTLCFailureMsg),
127 pub(super) enum HTLCForwardInfo {
129 forward_info: PendingHTLCInfo,
131 // These fields are produced in `forward_htlcs()` and consumed in
132 // `process_pending_htlc_forwards()` for constructing the
133 // `HTLCSource::PreviousHopData` for failed and forwarded
135 prev_short_channel_id: u64,
137 prev_funding_outpoint: OutPoint,
141 err_packet: msgs::OnionErrorPacket,
145 /// Tracks the inbound corresponding to an outbound HTLC
146 #[derive(Clone, PartialEq)]
147 pub(crate) struct HTLCPreviousHopData {
148 short_channel_id: u64,
150 incoming_packet_shared_secret: [u8; 32],
152 // This field is consumed by `claim_funds_from_hop()` when updating a force-closed backwards
153 // channel with a preimage provided by the forward channel.
157 struct ClaimableHTLC {
158 prev_hop: HTLCPreviousHopData,
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 payment_data: msgs::FinalOnionHopData,
167 /// Tracks the inbound corresponding to an outbound HTLC
168 #[derive(Clone, PartialEq)]
169 pub(crate) enum HTLCSource {
170 PreviousHopData(HTLCPreviousHopData),
173 session_priv: SecretKey,
174 /// Technically we can recalculate this from the route, but we cache it here to avoid
175 /// doing a double-pass on route when we get a failure back
176 first_hop_htlc_msat: u64,
181 pub fn dummy() -> Self {
182 HTLCSource::OutboundRoute {
184 session_priv: SecretKey::from_slice(&[1; 32]).unwrap(),
185 first_hop_htlc_msat: 0,
190 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
191 pub(super) enum HTLCFailReason {
193 err: msgs::OnionErrorPacket,
201 type ShutdownResult = (Option<(OutPoint, ChannelMonitorUpdate)>, Vec<(HTLCSource, PaymentHash)>);
203 /// Error type returned across the channel_state mutex boundary. When an Err is generated for a
204 /// Channel, we generally end up with a ChannelError::Close for which we have to close the channel
205 /// immediately (ie with no further calls on it made). Thus, this step happens inside a
206 /// channel_state lock. We then return the set of things that need to be done outside the lock in
207 /// this struct and call handle_error!() on it.
209 struct MsgHandleErrInternal {
210 err: msgs::LightningError,
211 shutdown_finish: Option<(ShutdownResult, Option<msgs::ChannelUpdate>)>,
213 impl MsgHandleErrInternal {
215 fn send_err_msg_no_close(err: String, channel_id: [u8; 32]) -> Self {
217 err: LightningError {
219 action: msgs::ErrorAction::SendErrorMessage {
220 msg: msgs::ErrorMessage {
226 shutdown_finish: None,
230 fn ignore_no_close(err: String) -> Self {
232 err: LightningError {
234 action: msgs::ErrorAction::IgnoreError,
236 shutdown_finish: None,
240 fn from_no_close(err: msgs::LightningError) -> Self {
241 Self { err, shutdown_finish: None }
244 fn from_finish_shutdown(err: String, channel_id: [u8; 32], shutdown_res: ShutdownResult, channel_update: Option<msgs::ChannelUpdate>) -> Self {
246 err: LightningError {
248 action: msgs::ErrorAction::SendErrorMessage {
249 msg: msgs::ErrorMessage {
255 shutdown_finish: Some((shutdown_res, channel_update)),
259 fn from_chan_no_close(err: ChannelError, channel_id: [u8; 32]) -> Self {
262 ChannelError::Ignore(msg) => LightningError {
264 action: msgs::ErrorAction::IgnoreError,
266 ChannelError::Close(msg) => LightningError {
268 action: msgs::ErrorAction::SendErrorMessage {
269 msg: msgs::ErrorMessage {
275 ChannelError::CloseDelayBroadcast(msg) => LightningError {
277 action: msgs::ErrorAction::SendErrorMessage {
278 msg: msgs::ErrorMessage {
285 shutdown_finish: None,
290 /// We hold back HTLCs we intend to relay for a random interval greater than this (see
291 /// Event::PendingHTLCsForwardable for the API guidelines indicating how long should be waited).
292 /// This provides some limited amount of privacy. Ideally this would range from somewhere like one
293 /// second to 30 seconds, but people expect lightning to be, you know, kinda fast, sadly.
294 const MIN_HTLC_RELAY_HOLDING_CELL_MILLIS: u64 = 100;
296 /// For events which result in both a RevokeAndACK and a CommitmentUpdate, by default they should
297 /// be sent in the order they appear in the return value, however sometimes the order needs to be
298 /// variable at runtime (eg Channel::channel_reestablish needs to re-send messages in the order
299 /// they were originally sent). In those cases, this enum is also returned.
300 #[derive(Clone, PartialEq)]
301 pub(super) enum RAACommitmentOrder {
302 /// Send the CommitmentUpdate messages first
304 /// Send the RevokeAndACK message first
308 // Note this is only exposed in cfg(test):
309 pub(super) struct ChannelHolder<Signer: Sign> {
310 pub(super) by_id: HashMap<[u8; 32], Channel<Signer>>,
311 pub(super) short_to_id: HashMap<u64, [u8; 32]>,
312 /// short channel id -> forward infos. Key of 0 means payments received
313 /// Note that while this is held in the same mutex as the channels themselves, no consistency
314 /// guarantees are made about the existence of a channel with the short id here, nor the short
315 /// ids in the PendingHTLCInfo!
316 pub(super) forward_htlcs: HashMap<u64, Vec<HTLCForwardInfo>>,
317 /// Map from payment hash to any HTLCs which are to us and can be failed/claimed by the user.
318 /// Note that while this is held in the same mutex as the channels themselves, no consistency
319 /// guarantees are made about the channels given here actually existing anymore by the time you
321 claimable_htlcs: HashMap<PaymentHash, Vec<ClaimableHTLC>>,
322 /// Messages to send to peers - pushed to in the same lock that they are generated in (except
323 /// for broadcast messages, where ordering isn't as strict).
324 pub(super) pending_msg_events: Vec<MessageSendEvent>,
327 /// Events which we process internally but cannot be procsesed immediately at the generation site
328 /// for some reason. They are handled in timer_tick_occurred, so may be processed with
329 /// quite some time lag.
330 enum BackgroundEvent {
331 /// Handle a ChannelMonitorUpdate that closes a channel, broadcasting its current latest holder
332 /// commitment transaction.
333 ClosingMonitorUpdate((OutPoint, ChannelMonitorUpdate)),
336 /// State we hold per-peer. In the future we should put channels in here, but for now we only hold
337 /// the latest Init features we heard from the peer.
339 latest_features: InitFeatures,
342 /// Stores a PaymentSecret and any other data we may need to validate an inbound payment is
343 /// actually ours and not some duplicate HTLC sent to us by a node along the route.
345 /// For users who don't want to bother doing their own payment preimage storage, we also store that
347 struct PendingInboundPayment {
348 /// The payment secret that the sender must use for us to accept this payment
349 payment_secret: PaymentSecret,
350 /// Time at which this HTLC expires - blocks with a header time above this value will result in
351 /// this payment being removed.
353 /// Arbitrary identifier the user specifies (or not)
354 user_payment_id: u64,
355 // Other required attributes of the payment, optionally enforced:
356 payment_preimage: Option<PaymentPreimage>,
357 min_value_msat: Option<u64>,
360 /// SimpleArcChannelManager is useful when you need a ChannelManager with a static lifetime, e.g.
361 /// when you're using lightning-net-tokio (since tokio::spawn requires parameters with static
362 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
363 /// SimpleRefChannelManager is the more appropriate type. Defining these type aliases prevents
364 /// issues such as overly long function definitions. Note that the ChannelManager can take any
365 /// type that implements KeysInterface for its keys manager, but this type alias chooses the
366 /// concrete type of the KeysManager.
367 pub type SimpleArcChannelManager<M, T, F, L> = ChannelManager<InMemorySigner, Arc<M>, Arc<T>, Arc<KeysManager>, Arc<F>, Arc<L>>;
369 /// SimpleRefChannelManager is a type alias for a ChannelManager reference, and is the reference
370 /// counterpart to the SimpleArcChannelManager type alias. Use this type by default when you don't
371 /// need a ChannelManager with a static lifetime. You'll need a static lifetime in cases such as
372 /// usage of lightning-net-tokio (since tokio::spawn requires parameters with static lifetimes).
373 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
374 /// helps with issues such as long function definitions. Note that the ChannelManager can take any
375 /// type that implements KeysInterface for its keys manager, but this type alias chooses the
376 /// concrete type of the KeysManager.
377 pub type SimpleRefChannelManager<'a, 'b, 'c, 'd, 'e, M, T, F, L> = ChannelManager<InMemorySigner, &'a M, &'b T, &'c KeysManager, &'d F, &'e L>;
379 /// Manager which keeps track of a number of channels and sends messages to the appropriate
380 /// channel, also tracking HTLC preimages and forwarding onion packets appropriately.
382 /// Implements ChannelMessageHandler, handling the multi-channel parts and passing things through
383 /// to individual Channels.
385 /// Implements Writeable to write out all channel state to disk. Implies peer_disconnected() for
386 /// all peers during write/read (though does not modify this instance, only the instance being
387 /// serialized). This will result in any channels which have not yet exchanged funding_created (ie
388 /// called funding_transaction_generated for outbound channels).
390 /// Note that you can be a bit lazier about writing out ChannelManager than you can be with
391 /// ChannelMonitors. With ChannelMonitors you MUST write each monitor update out to disk before
392 /// returning from chain::Watch::watch_/update_channel, with ChannelManagers, writing updates
393 /// happens out-of-band (and will prevent any other ChannelManager operations from occurring during
394 /// the serialization process). If the deserialized version is out-of-date compared to the
395 /// ChannelMonitors passed by reference to read(), those channels will be force-closed based on the
396 /// ChannelMonitor state and no funds will be lost (mod on-chain transaction fees).
398 /// Note that the deserializer is only implemented for (BlockHash, ChannelManager), which
399 /// tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
400 /// the "reorg path" (ie call block_disconnected() until you get to a common block and then call
401 /// block_connected() to step towards your best block) upon deserialization before using the
404 /// Note that ChannelManager is responsible for tracking liveness of its channels and generating
405 /// ChannelUpdate messages informing peers that the channel is temporarily disabled. To avoid
406 /// spam due to quick disconnection/reconnection, updates are not sent until the channel has been
407 /// offline for a full minute. In order to track this, you must call
408 /// timer_tick_occurred roughly once per minute, though it doesn't have to be perfect.
410 /// Rather than using a plain ChannelManager, it is preferable to use either a SimpleArcChannelManager
411 /// a SimpleRefChannelManager, for conciseness. See their documentation for more details, but
412 /// essentially you should default to using a SimpleRefChannelManager, and use a
413 /// SimpleArcChannelManager when you require a ChannelManager with a static lifetime, such as when
414 /// you're using lightning-net-tokio.
415 pub struct ChannelManager<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
416 where M::Target: chain::Watch<Signer>,
417 T::Target: BroadcasterInterface,
418 K::Target: KeysInterface<Signer = Signer>,
419 F::Target: FeeEstimator,
422 default_configuration: UserConfig,
423 genesis_hash: BlockHash,
429 pub(super) best_block: RwLock<BestBlock>,
431 best_block: RwLock<BestBlock>,
432 secp_ctx: Secp256k1<secp256k1::All>,
434 #[cfg(any(test, feature = "_test_utils"))]
435 pub(super) channel_state: Mutex<ChannelHolder<Signer>>,
436 #[cfg(not(any(test, feature = "_test_utils")))]
437 channel_state: Mutex<ChannelHolder<Signer>>,
439 /// Storage for PaymentSecrets and any requirements on future inbound payments before we will
440 /// expose them to users via a PaymentReceived event. HTLCs which do not meet the requirements
441 /// here are failed when we process them as pending-forwardable-HTLCs, and entries are removed
442 /// after we generate a PaymentReceived upon receipt of all MPP parts or when they time out.
443 /// Locked *after* channel_state.
444 pending_inbound_payments: Mutex<HashMap<PaymentHash, PendingInboundPayment>>,
446 /// The session_priv bytes of outbound payments which are pending resolution.
447 /// The authoritative state of these HTLCs resides either within Channels or ChannelMonitors
448 /// (if the channel has been force-closed), however we track them here to prevent duplicative
449 /// PaymentSent/PaymentFailed events. Specifically, in the case of a duplicative
450 /// update_fulfill_htlc message after a reconnect, we may "claim" a payment twice.
451 /// Additionally, because ChannelMonitors are often not re-serialized after connecting block(s)
452 /// which may generate a claim event, we may receive similar duplicate claim/fail MonitorEvents
453 /// after reloading from disk while replaying blocks against ChannelMonitors.
455 /// Locked *after* channel_state.
456 pending_outbound_payments: Mutex<HashSet<[u8; 32]>>,
458 our_network_key: SecretKey,
459 our_network_pubkey: PublicKey,
461 /// Used to track the last value sent in a node_announcement "timestamp" field. We ensure this
462 /// value increases strictly since we don't assume access to a time source.
463 last_node_announcement_serial: AtomicUsize,
465 /// The highest block timestamp we've seen, which is usually a good guess at the current time.
466 /// Assuming most miners are generating blocks with reasonable timestamps, this shouldn't be
467 /// very far in the past, and can only ever be up to two hours in the future.
468 highest_seen_timestamp: AtomicUsize,
470 /// The bulk of our storage will eventually be here (channels and message queues and the like).
471 /// If we are connected to a peer we always at least have an entry here, even if no channels
472 /// are currently open with that peer.
473 /// Because adding or removing an entry is rare, we usually take an outer read lock and then
474 /// operate on the inner value freely. Sadly, this prevents parallel operation when opening a
476 per_peer_state: RwLock<HashMap<PublicKey, Mutex<PeerState>>>,
478 pending_events: Mutex<Vec<events::Event>>,
479 pending_background_events: Mutex<Vec<BackgroundEvent>>,
480 /// Used when we have to take a BIG lock to make sure everything is self-consistent.
481 /// Essentially just when we're serializing ourselves out.
482 /// Taken first everywhere where we are making changes before any other locks.
483 /// When acquiring this lock in read mode, rather than acquiring it directly, call
484 /// `PersistenceNotifierGuard::notify_on_drop(..)` and pass the lock to it, to ensure the
485 /// PersistenceNotifier the lock contains sends out a notification when the lock is released.
486 total_consistency_lock: RwLock<()>,
488 persistence_notifier: PersistenceNotifier,
495 /// Chain-related parameters used to construct a new `ChannelManager`.
497 /// Typically, the block-specific parameters are derived from the best block hash for the network,
498 /// as a newly constructed `ChannelManager` will not have created any channels yet. These parameters
499 /// are not needed when deserializing a previously constructed `ChannelManager`.
500 pub struct ChainParameters {
501 /// The network for determining the `chain_hash` in Lightning messages.
502 pub network: Network,
504 /// The hash and height of the latest block successfully connected.
506 /// Used to track on-chain channel funding outputs and send payments with reliable timelocks.
507 pub best_block: BestBlock,
510 /// The best known block as identified by its hash and height.
511 #[derive(Clone, Copy)]
512 pub struct BestBlock {
513 block_hash: BlockHash,
518 /// Returns the best block from the genesis of the given network.
519 pub fn from_genesis(network: Network) -> Self {
521 block_hash: genesis_block(network).header.block_hash(),
526 /// Returns the best block as identified by the given block hash and height.
527 pub fn new(block_hash: BlockHash, height: u32) -> Self {
528 BestBlock { block_hash, height }
531 /// Returns the best block hash.
532 pub fn block_hash(&self) -> BlockHash { self.block_hash }
534 /// Returns the best block height.
535 pub fn height(&self) -> u32 { self.height }
538 #[derive(Copy, Clone, PartialEq)]
544 /// Whenever we release the `ChannelManager`'s `total_consistency_lock`, from read mode, it is
545 /// desirable to notify any listeners on `await_persistable_update_timeout`/
546 /// `await_persistable_update` when new updates are available for persistence. Therefore, this
547 /// struct is responsible for locking the total consistency lock and, upon going out of scope,
548 /// sending the aforementioned notification (since the lock being released indicates that the
549 /// updates are ready for persistence).
551 /// We allow callers to either always notify by constructing with `notify_on_drop` or choose to
552 /// notify or not based on whether relevant changes have been made, providing a closure to
553 /// `optionally_notify` which returns a `NotifyOption`.
554 struct PersistenceNotifierGuard<'a, F: Fn() -> NotifyOption> {
555 persistence_notifier: &'a PersistenceNotifier,
557 // We hold onto this result so the lock doesn't get released immediately.
558 _read_guard: RwLockReadGuard<'a, ()>,
561 impl<'a> PersistenceNotifierGuard<'a, fn() -> NotifyOption> { // We don't care what the concrete F is here, it's unused
562 fn notify_on_drop(lock: &'a RwLock<()>, notifier: &'a PersistenceNotifier) -> PersistenceNotifierGuard<'a, impl Fn() -> NotifyOption> {
563 PersistenceNotifierGuard::optionally_notify(lock, notifier, || -> NotifyOption { NotifyOption::DoPersist })
566 fn optionally_notify<F: Fn() -> NotifyOption>(lock: &'a RwLock<()>, notifier: &'a PersistenceNotifier, persist_check: F) -> PersistenceNotifierGuard<'a, F> {
567 let read_guard = lock.read().unwrap();
569 PersistenceNotifierGuard {
570 persistence_notifier: notifier,
571 should_persist: persist_check,
572 _read_guard: read_guard,
577 impl<'a, F: Fn() -> NotifyOption> Drop for PersistenceNotifierGuard<'a, F> {
579 if (self.should_persist)() == NotifyOption::DoPersist {
580 self.persistence_notifier.notify();
585 /// The amount of time in blocks we require our counterparty wait to claim their money (ie time
586 /// between when we, or our watchtower, must check for them having broadcast a theft transaction).
588 /// This can be increased (but not decreased) through [`ChannelHandshakeConfig::our_to_self_delay`]
590 /// [`ChannelHandshakeConfig::our_to_self_delay`]: crate::util::config::ChannelHandshakeConfig::our_to_self_delay
591 pub const BREAKDOWN_TIMEOUT: u16 = 6 * 24;
592 /// The amount of time in blocks we're willing to wait to claim money back to us. This matches
593 /// the maximum required amount in lnd as of March 2021.
594 pub(crate) const MAX_LOCAL_BREAKDOWN_TIMEOUT: u16 = 2 * 6 * 24 * 7;
596 /// The minimum number of blocks between an inbound HTLC's CLTV and the corresponding outbound
597 /// HTLC's CLTV. The current default represents roughly seven hours of blocks at six blocks/hour.
599 /// This can be increased (but not decreased) through [`ChannelConfig::cltv_expiry_delta`]
601 /// [`ChannelConfig::cltv_expiry_delta`]: crate::util::config::ChannelConfig::cltv_expiry_delta
602 // This should always be a few blocks greater than channelmonitor::CLTV_CLAIM_BUFFER,
603 // i.e. the node we forwarded the payment on to should always have enough room to reliably time out
604 // the HTLC via a full update_fail_htlc/commitment_signed dance before we hit the
605 // CLTV_CLAIM_BUFFER point (we static assert that it's at least 3 blocks more).
606 pub const MIN_CLTV_EXPIRY_DELTA: u16 = 6*7;
607 pub(super) const CLTV_FAR_FAR_AWAY: u32 = 6 * 24 * 7; //TODO?
609 /// Minimum CLTV difference between the current block height and received inbound payments.
610 /// Invoices generated for payment to us must set their `min_final_cltv_expiry` field to at least
612 // Note that we fail if exactly HTLC_FAIL_BACK_BUFFER + 1 was used, so we need to add one for
613 // any payments to succeed. Further, we don't want payments to fail if a block was found while
614 // a payment was being routed, so we add an extra block to be safe.
615 pub const MIN_FINAL_CLTV_EXPIRY: u32 = HTLC_FAIL_BACK_BUFFER + 3;
617 // Check that our CLTV_EXPIRY is at least CLTV_CLAIM_BUFFER + ANTI_REORG_DELAY + LATENCY_GRACE_PERIOD_BLOCKS,
618 // ie that if the next-hop peer fails the HTLC within
619 // LATENCY_GRACE_PERIOD_BLOCKS then we'll still have CLTV_CLAIM_BUFFER left to timeout it onchain,
620 // then waiting ANTI_REORG_DELAY to be reorg-safe on the outbound HLTC and
621 // failing the corresponding htlc backward, and us now seeing the last block of ANTI_REORG_DELAY before
622 // LATENCY_GRACE_PERIOD_BLOCKS.
625 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;
627 // Check for ability of an attacker to make us fail on-chain by delaying an HTLC claim. See
628 // ChannelMontior::would_broadcast_at_height for a description of why this is needed.
631 const CHECK_CLTV_EXPIRY_SANITY_2: u32 = MIN_CLTV_EXPIRY_DELTA as u32 - LATENCY_GRACE_PERIOD_BLOCKS - 2*CLTV_CLAIM_BUFFER;
633 /// Details of a channel, as returned by ChannelManager::list_channels and ChannelManager::list_usable_channels
635 pub struct ChannelDetails {
636 /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
637 /// thereafter this is the txid of the funding transaction xor the funding transaction output).
638 /// Note that this means this value is *not* persistent - it can change once during the
639 /// lifetime of the channel.
640 pub channel_id: [u8; 32],
641 /// The Channel's funding transaction output, if we've negotiated the funding transaction with
642 /// our counterparty already.
644 /// Note that, if this has been set, `channel_id` will be equivalent to
645 /// `funding_txo.unwrap().to_channel_id()`.
646 pub funding_txo: Option<OutPoint>,
647 /// The position of the funding transaction in the chain. None if the funding transaction has
648 /// not yet been confirmed and the channel fully opened.
649 pub short_channel_id: Option<u64>,
650 /// The node_id of our counterparty
651 pub remote_network_id: PublicKey,
652 /// The Features the channel counterparty provided upon last connection.
653 /// Useful for routing as it is the most up-to-date copy of the counterparty's features and
654 /// many routing-relevant features are present in the init context.
655 pub counterparty_features: InitFeatures,
656 /// The value, in satoshis, of this channel as appears in the funding output
657 pub channel_value_satoshis: u64,
658 /// The user_id passed in to create_channel, or 0 if the channel was inbound.
660 /// The available outbound capacity for sending HTLCs to the remote peer. This does not include
661 /// any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
662 /// available for inclusion in new outbound HTLCs). This further does not include any pending
663 /// outgoing HTLCs which are awaiting some other resolution to be sent.
664 pub outbound_capacity_msat: u64,
665 /// The available inbound capacity for the remote peer to send HTLCs to us. This does not
666 /// include any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
667 /// available for inclusion in new inbound HTLCs).
668 /// Note that there are some corner cases not fully handled here, so the actual available
669 /// inbound capacity may be slightly higher than this.
670 pub inbound_capacity_msat: u64,
671 /// True if the channel was initiated (and thus funded) by us.
672 pub is_outbound: bool,
673 /// True if the channel is confirmed, funding_locked messages have been exchanged, and the
674 /// channel is not currently being shut down. `funding_locked` message exchange implies the
675 /// required confirmation count has been reached (and we were connected to the peer at some
676 /// point after the funding transaction received enough confirmations).
677 pub is_funding_locked: bool,
678 /// True if the channel is (a) confirmed and funding_locked messages have been exchanged, (b)
679 /// the peer is connected, (c) no monitor update failure is pending resolution, and (d) the
680 /// channel is not currently negotiating a shutdown.
682 /// This is a strict superset of `is_funding_locked`.
684 /// True if this channel is (or will be) publicly-announced.
686 /// Information on the fees and requirements that the counterparty requires when forwarding
687 /// payments to us through this channel.
688 pub counterparty_forwarding_info: Option<CounterpartyForwardingInfo>,
691 /// If a payment fails to send, it can be in one of several states. This enum is returned as the
692 /// Err() type describing which state the payment is in, see the description of individual enum
694 #[derive(Clone, Debug)]
695 pub enum PaymentSendFailure {
696 /// A parameter which was passed to send_payment was invalid, preventing us from attempting to
697 /// send the payment at all. No channel state has been changed or messages sent to peers, and
698 /// once you've changed the parameter at error, you can freely retry the payment in full.
699 ParameterError(APIError),
700 /// A parameter in a single path which was passed to send_payment was invalid, preventing us
701 /// from attempting to send the payment at all. No channel state has been changed or messages
702 /// sent to peers, and once you've changed the parameter at error, you can freely retry the
705 /// The results here are ordered the same as the paths in the route object which was passed to
707 PathParameterError(Vec<Result<(), APIError>>),
708 /// All paths which were attempted failed to send, with no channel state change taking place.
709 /// You can freely retry the payment in full (though you probably want to do so over different
710 /// paths than the ones selected).
711 AllFailedRetrySafe(Vec<APIError>),
712 /// Some paths which were attempted failed to send, though possibly not all. At least some
713 /// paths have irrevocably committed to the HTLC and retrying the payment in full would result
714 /// in over-/re-payment.
716 /// The results here are ordered the same as the paths in the route object which was passed to
717 /// send_payment, and any Errs which are not APIError::MonitorUpdateFailed can be safely
718 /// retried (though there is currently no API with which to do so).
720 /// Any entries which contain Err(APIError::MonitorUpdateFailed) or Ok(()) MUST NOT be retried
721 /// as they will result in over-/re-payment. These HTLCs all either successfully sent (in the
722 /// case of Ok(())) or will send once channel_monitor_updated is called on the next-hop channel
723 /// with the latest update_id.
724 PartialFailure(Vec<Result<(), APIError>>),
727 macro_rules! handle_error {
728 ($self: ident, $internal: expr, $counterparty_node_id: expr) => {
731 Err(MsgHandleErrInternal { err, shutdown_finish }) => {
732 #[cfg(debug_assertions)]
734 // In testing, ensure there are no deadlocks where the lock is already held upon
735 // entering the macro.
736 assert!($self.channel_state.try_lock().is_ok());
739 let mut msg_events = Vec::with_capacity(2);
741 if let Some((shutdown_res, update_option)) = shutdown_finish {
742 $self.finish_force_close_channel(shutdown_res);
743 if let Some(update) = update_option {
744 msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
750 log_error!($self.logger, "{}", err.err);
751 if let msgs::ErrorAction::IgnoreError = err.action {
753 msg_events.push(events::MessageSendEvent::HandleError {
754 node_id: $counterparty_node_id,
755 action: err.action.clone()
759 if !msg_events.is_empty() {
760 $self.channel_state.lock().unwrap().pending_msg_events.append(&mut msg_events);
763 // Return error in case higher-API need one
770 /// Returns (boolean indicating if we should remove the Channel object from memory, a mapped error)
771 macro_rules! convert_chan_err {
772 ($self: ident, $err: expr, $short_to_id: expr, $channel: expr, $channel_id: expr) => {
774 ChannelError::Ignore(msg) => {
775 (false, MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore(msg), $channel_id.clone()))
777 ChannelError::Close(msg) => {
778 log_trace!($self.logger, "Closing channel {} due to close-required error: {}", log_bytes!($channel_id[..]), msg);
779 if let Some(short_id) = $channel.get_short_channel_id() {
780 $short_to_id.remove(&short_id);
782 let shutdown_res = $channel.force_shutdown(true);
783 (true, MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, shutdown_res, $self.get_channel_update(&$channel).ok()))
785 ChannelError::CloseDelayBroadcast(msg) => {
786 log_error!($self.logger, "Channel {} need to be shutdown but closing transactions not broadcast due to {}", log_bytes!($channel_id[..]), msg);
787 if let Some(short_id) = $channel.get_short_channel_id() {
788 $short_to_id.remove(&short_id);
790 let shutdown_res = $channel.force_shutdown(false);
791 (true, MsgHandleErrInternal::from_finish_shutdown(msg, *$channel_id, shutdown_res, $self.get_channel_update(&$channel).ok()))
797 macro_rules! break_chan_entry {
798 ($self: ident, $res: expr, $channel_state: expr, $entry: expr) => {
802 let (drop, res) = convert_chan_err!($self, e, $channel_state.short_to_id, $entry.get_mut(), $entry.key());
804 $entry.remove_entry();
812 macro_rules! try_chan_entry {
813 ($self: ident, $res: expr, $channel_state: expr, $entry: expr) => {
817 let (drop, res) = convert_chan_err!($self, e, $channel_state.short_to_id, $entry.get_mut(), $entry.key());
819 $entry.remove_entry();
827 macro_rules! handle_monitor_err {
828 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
829 handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment, Vec::new(), Vec::new())
831 ($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) => {
833 ChannelMonitorUpdateErr::PermanentFailure => {
834 log_error!($self.logger, "Closing channel {} due to monitor update ChannelMonitorUpdateErr::PermanentFailure", log_bytes!($chan_id[..]));
835 if let Some(short_id) = $chan.get_short_channel_id() {
836 $short_to_id.remove(&short_id);
838 // TODO: $failed_fails is dropped here, which will cause other channels to hit the
839 // chain in a confused state! We need to move them into the ChannelMonitor which
840 // will be responsible for failing backwards once things confirm on-chain.
841 // It's ok that we drop $failed_forwards here - at this point we'd rather they
842 // broadcast HTLC-Timeout and pay the associated fees to get their funds back than
843 // us bother trying to claim it just to forward on to another peer. If we're
844 // splitting hairs we'd prefer to claim payments that were to us, but we haven't
845 // given up the preimage yet, so might as well just wait until the payment is
846 // retried, avoiding the on-chain fees.
847 let res: Result<(), _> = Err(MsgHandleErrInternal::from_finish_shutdown("ChannelMonitor storage failure".to_owned(), *$chan_id, $chan.force_shutdown(true), $self.get_channel_update(&$chan).ok()));
850 ChannelMonitorUpdateErr::TemporaryFailure => {
851 log_info!($self.logger, "Disabling channel {} due to monitor update TemporaryFailure. On restore will send {} and process {} forwards and {} fails",
852 log_bytes!($chan_id[..]),
853 if $resend_commitment && $resend_raa {
855 RAACommitmentOrder::CommitmentFirst => { "commitment then RAA" },
856 RAACommitmentOrder::RevokeAndACKFirst => { "RAA then commitment" },
858 } else if $resend_commitment { "commitment" }
859 else if $resend_raa { "RAA" }
861 (&$failed_forwards as &Vec<(PendingHTLCInfo, u64)>).len(),
862 (&$failed_fails as &Vec<(HTLCSource, PaymentHash, HTLCFailReason)>).len());
863 if !$resend_commitment {
864 debug_assert!($action_type == RAACommitmentOrder::RevokeAndACKFirst || !$resend_raa);
867 debug_assert!($action_type == RAACommitmentOrder::CommitmentFirst || !$resend_commitment);
869 $chan.monitor_update_failed($resend_raa, $resend_commitment, $failed_forwards, $failed_fails);
870 (Err(MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore("Failed to update ChannelMonitor".to_owned()), *$chan_id)), false)
874 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr, $failed_forwards: expr, $failed_fails: expr) => { {
875 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());
877 $entry.remove_entry();
883 macro_rules! return_monitor_err {
884 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
885 return handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment);
887 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr, $failed_forwards: expr, $failed_fails: expr) => {
888 return handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment, $failed_forwards, $failed_fails);
892 // Does not break in case of TemporaryFailure!
893 macro_rules! maybe_break_monitor_err {
894 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
895 match (handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment), $err) {
896 (e, ChannelMonitorUpdateErr::PermanentFailure) => {
899 (_, ChannelMonitorUpdateErr::TemporaryFailure) => { },
904 macro_rules! handle_chan_restoration_locked {
905 ($self: ident, $channel_lock: expr, $channel_state: expr, $channel_entry: expr,
906 $raa: expr, $commitment_update: expr, $order: expr, $chanmon_update: expr,
907 $pending_forwards: expr, $funding_broadcastable: expr, $funding_locked: expr) => { {
908 let mut htlc_forwards = None;
909 let counterparty_node_id = $channel_entry.get().get_counterparty_node_id();
911 let chanmon_update: Option<ChannelMonitorUpdate> = $chanmon_update; // Force type-checking to resolve
912 let chanmon_update_is_none = chanmon_update.is_none();
914 let forwards: Vec<(PendingHTLCInfo, u64)> = $pending_forwards; // Force type-checking to resolve
915 if !forwards.is_empty() {
916 htlc_forwards = Some(($channel_entry.get().get_short_channel_id().expect("We can't have pending forwards before funding confirmation"),
917 $channel_entry.get().get_funding_txo().unwrap(), forwards));
920 if chanmon_update.is_some() {
921 // On reconnect, we, by definition, only resend a funding_locked if there have been
922 // no commitment updates, so the only channel monitor update which could also be
923 // associated with a funding_locked would be the funding_created/funding_signed
924 // monitor update. That monitor update failing implies that we won't send
925 // funding_locked until it's been updated, so we can't have a funding_locked and a
926 // monitor update here (so we don't bother to handle it correctly below).
927 assert!($funding_locked.is_none());
928 // A channel monitor update makes no sense without either a funding_locked or a
929 // commitment update to process after it. Since we can't have a funding_locked, we
930 // only bother to handle the monitor-update + commitment_update case below.
931 assert!($commitment_update.is_some());
934 if let Some(msg) = $funding_locked {
935 // Similar to the above, this implies that we're letting the funding_locked fly
936 // before it should be allowed to.
937 assert!(chanmon_update.is_none());
938 $channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingLocked {
939 node_id: counterparty_node_id,
942 if let Some(announcement_sigs) = $self.get_announcement_sigs($channel_entry.get()) {
943 $channel_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
944 node_id: counterparty_node_id,
945 msg: announcement_sigs,
948 $channel_state.short_to_id.insert($channel_entry.get().get_short_channel_id().unwrap(), $channel_entry.get().channel_id());
951 let funding_broadcastable: Option<Transaction> = $funding_broadcastable; // Force type-checking to resolve
952 if let Some(monitor_update) = chanmon_update {
953 // We only ever broadcast a funding transaction in response to a funding_signed
954 // message and the resulting monitor update. Thus, on channel_reestablish
955 // message handling we can't have a funding transaction to broadcast. When
956 // processing a monitor update finishing resulting in a funding broadcast, we
957 // cannot have a second monitor update, thus this case would indicate a bug.
958 assert!(funding_broadcastable.is_none());
959 // Given we were just reconnected or finished updating a channel monitor, the
960 // only case where we can get a new ChannelMonitorUpdate would be if we also
961 // have some commitment updates to send as well.
962 assert!($commitment_update.is_some());
963 if let Err(e) = $self.chain_monitor.update_channel($channel_entry.get().get_funding_txo().unwrap(), monitor_update) {
964 // channel_reestablish doesn't guarantee the order it returns is sensical
965 // for the messages it returns, but if we're setting what messages to
966 // re-transmit on monitor update success, we need to make sure it is sane.
967 let mut order = $order;
969 order = RAACommitmentOrder::CommitmentFirst;
971 break handle_monitor_err!($self, e, $channel_state, $channel_entry, order, $raa.is_some(), true);
975 macro_rules! handle_cs { () => {
976 if let Some(update) = $commitment_update {
977 $channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
978 node_id: counterparty_node_id,
983 macro_rules! handle_raa { () => {
984 if let Some(revoke_and_ack) = $raa {
985 $channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
986 node_id: counterparty_node_id,
992 RAACommitmentOrder::CommitmentFirst => {
996 RAACommitmentOrder::RevokeAndACKFirst => {
1001 if let Some(tx) = funding_broadcastable {
1002 log_info!($self.logger, "Broadcasting funding transaction with txid {}", tx.txid());
1003 $self.tx_broadcaster.broadcast_transaction(&tx);
1008 if chanmon_update_is_none {
1009 // If there was no ChannelMonitorUpdate, we should never generate an Err in the res loop
1010 // above. Doing so would imply calling handle_err!() from channel_monitor_updated() which
1011 // should *never* end up calling back to `chain_monitor.update_channel()`.
1012 assert!(res.is_ok());
1015 (htlc_forwards, res, counterparty_node_id)
1019 macro_rules! post_handle_chan_restoration {
1020 ($self: ident, $locked_res: expr) => { {
1021 let (htlc_forwards, res, counterparty_node_id) = $locked_res;
1023 let _ = handle_error!($self, res, counterparty_node_id);
1025 if let Some(forwards) = htlc_forwards {
1026 $self.forward_htlcs(&mut [forwards][..]);
1031 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<Signer, M, T, K, F, L>
1032 where M::Target: chain::Watch<Signer>,
1033 T::Target: BroadcasterInterface,
1034 K::Target: KeysInterface<Signer = Signer>,
1035 F::Target: FeeEstimator,
1038 /// Constructs a new ChannelManager to hold several channels and route between them.
1040 /// This is the main "logic hub" for all channel-related actions, and implements
1041 /// ChannelMessageHandler.
1043 /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
1045 /// panics if channel_value_satoshis is >= `MAX_FUNDING_SATOSHIS`!
1047 /// Users need to notify the new ChannelManager when a new block is connected or
1048 /// disconnected using its `block_connected` and `block_disconnected` methods, starting
1049 /// from after `params.latest_hash`.
1050 pub fn new(fee_est: F, chain_monitor: M, tx_broadcaster: T, logger: L, keys_manager: K, config: UserConfig, params: ChainParameters) -> Self {
1051 let mut secp_ctx = Secp256k1::new();
1052 secp_ctx.seeded_randomize(&keys_manager.get_secure_random_bytes());
1055 default_configuration: config.clone(),
1056 genesis_hash: genesis_block(params.network).header.block_hash(),
1057 fee_estimator: fee_est,
1061 best_block: RwLock::new(params.best_block),
1063 channel_state: Mutex::new(ChannelHolder{
1064 by_id: HashMap::new(),
1065 short_to_id: HashMap::new(),
1066 forward_htlcs: HashMap::new(),
1067 claimable_htlcs: HashMap::new(),
1068 pending_msg_events: Vec::new(),
1070 pending_inbound_payments: Mutex::new(HashMap::new()),
1071 pending_outbound_payments: Mutex::new(HashSet::new()),
1073 our_network_key: keys_manager.get_node_secret(),
1074 our_network_pubkey: PublicKey::from_secret_key(&secp_ctx, &keys_manager.get_node_secret()),
1077 last_node_announcement_serial: AtomicUsize::new(0),
1078 highest_seen_timestamp: AtomicUsize::new(0),
1080 per_peer_state: RwLock::new(HashMap::new()),
1082 pending_events: Mutex::new(Vec::new()),
1083 pending_background_events: Mutex::new(Vec::new()),
1084 total_consistency_lock: RwLock::new(()),
1085 persistence_notifier: PersistenceNotifier::new(),
1093 /// Gets the current configuration applied to all new channels, as
1094 pub fn get_current_default_configuration(&self) -> &UserConfig {
1095 &self.default_configuration
1098 /// Creates a new outbound channel to the given remote node and with the given value.
1100 /// user_id will be provided back as user_channel_id in FundingGenerationReady events to allow
1101 /// tracking of which events correspond with which create_channel call. Note that the
1102 /// user_channel_id defaults to 0 for inbound channels, so you may wish to avoid using 0 for
1103 /// user_id here. user_id has no meaning inside of LDK, it is simply copied to events and
1104 /// otherwise ignored.
1106 /// If successful, will generate a SendOpenChannel message event, so you should probably poll
1107 /// PeerManager::process_events afterwards.
1109 /// Raises APIError::APIMisuseError when channel_value_satoshis > 2**24 or push_msat is
1110 /// greater than channel_value_satoshis * 1k or channel_value_satoshis is < 1000.
1111 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> {
1112 if channel_value_satoshis < 1000 {
1113 return Err(APIError::APIMisuseError { err: format!("Channel value must be at least 1000 satoshis. It was {}", channel_value_satoshis) });
1116 let config = if override_config.is_some() { override_config.as_ref().unwrap() } else { &self.default_configuration };
1117 let channel = Channel::new_outbound(&self.fee_estimator, &self.keys_manager, their_network_key, channel_value_satoshis, push_msat, user_id, config)?;
1118 let res = channel.get_open_channel(self.genesis_hash.clone());
1120 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1121 // We want to make sure the lock is actually acquired by PersistenceNotifierGuard.
1122 debug_assert!(&self.total_consistency_lock.try_write().is_err());
1124 let mut channel_state = self.channel_state.lock().unwrap();
1125 match channel_state.by_id.entry(channel.channel_id()) {
1126 hash_map::Entry::Occupied(_) => {
1127 if cfg!(feature = "fuzztarget") {
1128 return Err(APIError::APIMisuseError { err: "Fuzzy bad RNG".to_owned() });
1130 panic!("RNG is bad???");
1133 hash_map::Entry::Vacant(entry) => { entry.insert(channel); }
1135 channel_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
1136 node_id: their_network_key,
1142 fn list_channels_with_filter<Fn: FnMut(&(&[u8; 32], &Channel<Signer>)) -> bool>(&self, f: Fn) -> Vec<ChannelDetails> {
1143 let mut res = Vec::new();
1145 let channel_state = self.channel_state.lock().unwrap();
1146 res.reserve(channel_state.by_id.len());
1147 for (channel_id, channel) in channel_state.by_id.iter().filter(f) {
1148 let (inbound_capacity_msat, outbound_capacity_msat) = channel.get_inbound_outbound_available_balance_msat();
1149 res.push(ChannelDetails {
1150 channel_id: (*channel_id).clone(),
1151 funding_txo: channel.get_funding_txo(),
1152 short_channel_id: channel.get_short_channel_id(),
1153 remote_network_id: channel.get_counterparty_node_id(),
1154 counterparty_features: InitFeatures::empty(),
1155 channel_value_satoshis: channel.get_value_satoshis(),
1156 inbound_capacity_msat,
1157 outbound_capacity_msat,
1158 user_id: channel.get_user_id(),
1159 is_outbound: channel.is_outbound(),
1160 is_funding_locked: channel.is_usable(),
1161 is_usable: channel.is_live(),
1162 is_public: channel.should_announce(),
1163 counterparty_forwarding_info: channel.counterparty_forwarding_info(),
1167 let per_peer_state = self.per_peer_state.read().unwrap();
1168 for chan in res.iter_mut() {
1169 if let Some(peer_state) = per_peer_state.get(&chan.remote_network_id) {
1170 chan.counterparty_features = peer_state.lock().unwrap().latest_features.clone();
1176 /// Gets the list of open channels, in random order. See ChannelDetail field documentation for
1177 /// more information.
1178 pub fn list_channels(&self) -> Vec<ChannelDetails> {
1179 self.list_channels_with_filter(|_| true)
1182 /// Gets the list of usable channels, in random order. Useful as an argument to
1183 /// get_route to ensure non-announced channels are used.
1185 /// These are guaranteed to have their [`ChannelDetails::is_usable`] value set to true, see the
1186 /// documentation for [`ChannelDetails::is_usable`] for more info on exactly what the criteria
1188 pub fn list_usable_channels(&self) -> Vec<ChannelDetails> {
1189 // Note we use is_live here instead of usable which leads to somewhat confused
1190 // internal/external nomenclature, but that's ok cause that's probably what the user
1191 // really wanted anyway.
1192 self.list_channels_with_filter(|&(_, ref channel)| channel.is_live())
1195 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
1196 /// will be accepted on the given channel, and after additional timeout/the closing of all
1197 /// pending HTLCs, the channel will be closed on chain.
1199 /// May generate a SendShutdown message event on success, which should be relayed.
1200 pub fn close_channel(&self, channel_id: &[u8; 32]) -> Result<(), APIError> {
1201 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1203 let (mut failed_htlcs, chan_option) = {
1204 let mut channel_state_lock = self.channel_state.lock().unwrap();
1205 let channel_state = &mut *channel_state_lock;
1206 match channel_state.by_id.entry(channel_id.clone()) {
1207 hash_map::Entry::Occupied(mut chan_entry) => {
1208 let (shutdown_msg, failed_htlcs) = chan_entry.get_mut().get_shutdown()?;
1209 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
1210 node_id: chan_entry.get().get_counterparty_node_id(),
1213 if chan_entry.get().is_shutdown() {
1214 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
1215 channel_state.short_to_id.remove(&short_id);
1217 (failed_htlcs, Some(chan_entry.remove_entry().1))
1218 } else { (failed_htlcs, None) }
1220 hash_map::Entry::Vacant(_) => return Err(APIError::ChannelUnavailable{err: "No such channel".to_owned()})
1223 for htlc_source in failed_htlcs.drain(..) {
1224 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() });
1226 let chan_update = if let Some(chan) = chan_option {
1227 if let Ok(update) = self.get_channel_update(&chan) {
1232 if let Some(update) = chan_update {
1233 let mut channel_state = self.channel_state.lock().unwrap();
1234 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1243 fn finish_force_close_channel(&self, shutdown_res: ShutdownResult) {
1244 let (monitor_update_option, mut failed_htlcs) = shutdown_res;
1245 log_trace!(self.logger, "Finishing force-closure of channel {} HTLCs to fail", failed_htlcs.len());
1246 for htlc_source in failed_htlcs.drain(..) {
1247 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() });
1249 if let Some((funding_txo, monitor_update)) = monitor_update_option {
1250 // There isn't anything we can do if we get an update failure - we're already
1251 // force-closing. The monitor update on the required in-memory copy should broadcast
1252 // the latest local state, which is the best we can do anyway. Thus, it is safe to
1253 // ignore the result here.
1254 let _ = self.chain_monitor.update_channel(funding_txo, monitor_update);
1258 fn force_close_channel_with_peer(&self, channel_id: &[u8; 32], peer_node_id: Option<&PublicKey>) -> Result<PublicKey, APIError> {
1260 let mut channel_state_lock = self.channel_state.lock().unwrap();
1261 let channel_state = &mut *channel_state_lock;
1262 if let hash_map::Entry::Occupied(chan) = channel_state.by_id.entry(channel_id.clone()) {
1263 if let Some(node_id) = peer_node_id {
1264 if chan.get().get_counterparty_node_id() != *node_id {
1265 return Err(APIError::ChannelUnavailable{err: "No such channel".to_owned()});
1268 if let Some(short_id) = chan.get().get_short_channel_id() {
1269 channel_state.short_to_id.remove(&short_id);
1271 chan.remove_entry().1
1273 return Err(APIError::ChannelUnavailable{err: "No such channel".to_owned()});
1276 log_trace!(self.logger, "Force-closing channel {}", log_bytes!(channel_id[..]));
1277 self.finish_force_close_channel(chan.force_shutdown(true));
1278 if let Ok(update) = self.get_channel_update(&chan) {
1279 let mut channel_state = self.channel_state.lock().unwrap();
1280 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1285 Ok(chan.get_counterparty_node_id())
1288 /// Force closes a channel, immediately broadcasting the latest local commitment transaction to
1289 /// the chain and rejecting new HTLCs on the given channel. Fails if channel_id is unknown to the manager.
1290 pub fn force_close_channel(&self, channel_id: &[u8; 32]) -> Result<(), APIError> {
1291 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1292 match self.force_close_channel_with_peer(channel_id, None) {
1293 Ok(counterparty_node_id) => {
1294 self.channel_state.lock().unwrap().pending_msg_events.push(
1295 events::MessageSendEvent::HandleError {
1296 node_id: counterparty_node_id,
1297 action: msgs::ErrorAction::SendErrorMessage {
1298 msg: msgs::ErrorMessage { channel_id: *channel_id, data: "Channel force-closed".to_owned() }
1308 /// Force close all channels, immediately broadcasting the latest local commitment transaction
1309 /// for each to the chain and rejecting new HTLCs on each.
1310 pub fn force_close_all_channels(&self) {
1311 for chan in self.list_channels() {
1312 let _ = self.force_close_channel(&chan.channel_id);
1316 fn decode_update_add_htlc_onion(&self, msg: &msgs::UpdateAddHTLC) -> (PendingHTLCStatus, MutexGuard<ChannelHolder<Signer>>) {
1317 macro_rules! return_malformed_err {
1318 ($msg: expr, $err_code: expr) => {
1320 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
1321 return (PendingHTLCStatus::Fail(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
1322 channel_id: msg.channel_id,
1323 htlc_id: msg.htlc_id,
1324 sha256_of_onion: Sha256::hash(&msg.onion_routing_packet.hop_data).into_inner(),
1325 failure_code: $err_code,
1326 })), self.channel_state.lock().unwrap());
1331 if let Err(_) = msg.onion_routing_packet.public_key {
1332 return_malformed_err!("invalid ephemeral pubkey", 0x8000 | 0x4000 | 6);
1335 let shared_secret = {
1336 let mut arr = [0; 32];
1337 arr.copy_from_slice(&SharedSecret::new(&msg.onion_routing_packet.public_key.unwrap(), &self.our_network_key)[..]);
1340 let (rho, mu) = onion_utils::gen_rho_mu_from_shared_secret(&shared_secret);
1342 if msg.onion_routing_packet.version != 0 {
1343 //TODO: Spec doesn't indicate if we should only hash hop_data here (and in other
1344 //sha256_of_onion error data packets), or the entire onion_routing_packet. Either way,
1345 //the hash doesn't really serve any purpose - in the case of hashing all data, the
1346 //receiving node would have to brute force to figure out which version was put in the
1347 //packet by the node that send us the message, in the case of hashing the hop_data, the
1348 //node knows the HMAC matched, so they already know what is there...
1349 return_malformed_err!("Unknown onion packet version", 0x8000 | 0x4000 | 4);
1352 let mut hmac = HmacEngine::<Sha256>::new(&mu);
1353 hmac.input(&msg.onion_routing_packet.hop_data);
1354 hmac.input(&msg.payment_hash.0[..]);
1355 if !fixed_time_eq(&Hmac::from_engine(hmac).into_inner(), &msg.onion_routing_packet.hmac) {
1356 return_malformed_err!("HMAC Check failed", 0x8000 | 0x4000 | 5);
1359 let mut channel_state = None;
1360 macro_rules! return_err {
1361 ($msg: expr, $err_code: expr, $data: expr) => {
1363 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
1364 if channel_state.is_none() {
1365 channel_state = Some(self.channel_state.lock().unwrap());
1367 return (PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
1368 channel_id: msg.channel_id,
1369 htlc_id: msg.htlc_id,
1370 reason: onion_utils::build_first_hop_failure_packet(&shared_secret, $err_code, $data),
1371 })), channel_state.unwrap());
1376 let mut chacha = ChaCha20::new(&rho, &[0u8; 8]);
1377 let mut chacha_stream = ChaChaReader { chacha: &mut chacha, read: Cursor::new(&msg.onion_routing_packet.hop_data[..]) };
1378 let (next_hop_data, next_hop_hmac) = {
1379 match msgs::OnionHopData::read(&mut chacha_stream) {
1381 let error_code = match err {
1382 msgs::DecodeError::UnknownVersion => 0x4000 | 1, // unknown realm byte
1383 msgs::DecodeError::UnknownRequiredFeature|
1384 msgs::DecodeError::InvalidValue|
1385 msgs::DecodeError::ShortRead => 0x4000 | 22, // invalid_onion_payload
1386 _ => 0x2000 | 2, // Should never happen
1388 return_err!("Unable to decode our hop data", error_code, &[0;0]);
1391 let mut hmac = [0; 32];
1392 if let Err(_) = chacha_stream.read_exact(&mut hmac[..]) {
1393 return_err!("Unable to decode hop data", 0x4000 | 22, &[0;0]);
1400 let pending_forward_info = if next_hop_hmac == [0; 32] {
1403 // In tests, make sure that the initial onion pcket data is, at least, non-0.
1404 // We could do some fancy randomness test here, but, ehh, whatever.
1405 // This checks for the issue where you can calculate the path length given the
1406 // onion data as all the path entries that the originator sent will be here
1407 // as-is (and were originally 0s).
1408 // Of course reverse path calculation is still pretty easy given naive routing
1409 // algorithms, but this fixes the most-obvious case.
1410 let mut next_bytes = [0; 32];
1411 chacha_stream.read_exact(&mut next_bytes).unwrap();
1412 assert_ne!(next_bytes[..], [0; 32][..]);
1413 chacha_stream.read_exact(&mut next_bytes).unwrap();
1414 assert_ne!(next_bytes[..], [0; 32][..]);
1418 // final_expiry_too_soon
1419 // We have to have some headroom to broadcast on chain if we have the preimage, so make sure we have at least
1420 // HTLC_FAIL_BACK_BUFFER blocks to go.
1421 // Also, ensure that, in the case of an unknown payment hash, our payment logic has enough time to fail the HTLC backward
1422 // before our onchain logic triggers a channel closure (see HTLC_FAIL_BACK_BUFFER rational).
1423 if (msg.cltv_expiry as u64) <= self.best_block.read().unwrap().height() as u64 + HTLC_FAIL_BACK_BUFFER as u64 + 1 {
1424 return_err!("The final CLTV expiry is too soon to handle", 17, &[0;0]);
1426 // final_incorrect_htlc_amount
1427 if next_hop_data.amt_to_forward > msg.amount_msat {
1428 return_err!("Upstream node sent less than we were supposed to receive in payment", 19, &byte_utils::be64_to_array(msg.amount_msat));
1430 // final_incorrect_cltv_expiry
1431 if next_hop_data.outgoing_cltv_value != msg.cltv_expiry {
1432 return_err!("Upstream node set CLTV to the wrong value", 18, &byte_utils::be32_to_array(msg.cltv_expiry));
1435 let payment_data = match next_hop_data.format {
1436 msgs::OnionHopDataFormat::Legacy { .. } => None,
1437 msgs::OnionHopDataFormat::NonFinalNode { .. } => return_err!("Got non final data with an HMAC of 0", 0x4000 | 22, &[0;0]),
1438 msgs::OnionHopDataFormat::FinalNode { payment_data } => payment_data,
1441 if payment_data.is_none() {
1442 return_err!("We require payment_secrets", 0x4000|0x2000|3, &[0;0]);
1445 // Note that we could obviously respond immediately with an update_fulfill_htlc
1446 // message, however that would leak that we are the recipient of this payment, so
1447 // instead we stay symmetric with the forwarding case, only responding (after a
1448 // delay) once they've send us a commitment_signed!
1450 PendingHTLCStatus::Forward(PendingHTLCInfo {
1451 routing: PendingHTLCRouting::Receive {
1452 payment_data: payment_data.unwrap(),
1453 incoming_cltv_expiry: msg.cltv_expiry,
1455 payment_hash: msg.payment_hash.clone(),
1456 incoming_shared_secret: shared_secret,
1457 amt_to_forward: next_hop_data.amt_to_forward,
1458 outgoing_cltv_value: next_hop_data.outgoing_cltv_value,
1461 let mut new_packet_data = [0; 20*65];
1462 let read_pos = chacha_stream.read(&mut new_packet_data).unwrap();
1463 #[cfg(debug_assertions)]
1465 // Check two things:
1466 // a) that the behavior of our stream here will return Ok(0) even if the TLV
1467 // read above emptied out our buffer and the unwrap() wont needlessly panic
1468 // b) that we didn't somehow magically end up with extra data.
1470 debug_assert!(chacha_stream.read(&mut t).unwrap() == 0);
1472 // Once we've emptied the set of bytes our peer gave us, encrypt 0 bytes until we
1473 // fill the onion hop data we'll forward to our next-hop peer.
1474 chacha_stream.chacha.process_in_place(&mut new_packet_data[read_pos..]);
1476 let mut new_pubkey = msg.onion_routing_packet.public_key.unwrap();
1478 let blinding_factor = {
1479 let mut sha = Sha256::engine();
1480 sha.input(&new_pubkey.serialize()[..]);
1481 sha.input(&shared_secret);
1482 Sha256::from_engine(sha).into_inner()
1485 let public_key = if let Err(e) = new_pubkey.mul_assign(&self.secp_ctx, &blinding_factor[..]) {
1487 } else { Ok(new_pubkey) };
1489 let outgoing_packet = msgs::OnionPacket {
1492 hop_data: new_packet_data,
1493 hmac: next_hop_hmac.clone(),
1496 let short_channel_id = match next_hop_data.format {
1497 msgs::OnionHopDataFormat::Legacy { short_channel_id } => short_channel_id,
1498 msgs::OnionHopDataFormat::NonFinalNode { short_channel_id } => short_channel_id,
1499 msgs::OnionHopDataFormat::FinalNode { .. } => {
1500 return_err!("Final Node OnionHopData provided for us as an intermediary node", 0x4000 | 22, &[0;0]);
1504 PendingHTLCStatus::Forward(PendingHTLCInfo {
1505 routing: PendingHTLCRouting::Forward {
1506 onion_packet: outgoing_packet,
1509 payment_hash: msg.payment_hash.clone(),
1510 incoming_shared_secret: shared_secret,
1511 amt_to_forward: next_hop_data.amt_to_forward,
1512 outgoing_cltv_value: next_hop_data.outgoing_cltv_value,
1516 channel_state = Some(self.channel_state.lock().unwrap());
1517 if let &PendingHTLCStatus::Forward(PendingHTLCInfo { ref routing, ref amt_to_forward, ref outgoing_cltv_value, .. }) = &pending_forward_info {
1518 // If short_channel_id is 0 here, we'll reject the HTLC as there cannot be a channel
1519 // with a short_channel_id of 0. This is important as various things later assume
1520 // short_channel_id is non-0 in any ::Forward.
1521 if let &PendingHTLCRouting::Forward { ref short_channel_id, .. } = routing {
1522 let id_option = channel_state.as_ref().unwrap().short_to_id.get(&short_channel_id).cloned();
1523 let forwarding_id = match id_option {
1524 None => { // unknown_next_peer
1525 return_err!("Don't have available channel for forwarding as requested.", 0x4000 | 10, &[0;0]);
1527 Some(id) => id.clone(),
1529 if let Some((err, code, chan_update)) = loop {
1530 let chan = channel_state.as_mut().unwrap().by_id.get_mut(&forwarding_id).unwrap();
1532 // Note that we could technically not return an error yet here and just hope
1533 // that the connection is reestablished or monitor updated by the time we get
1534 // around to doing the actual forward, but better to fail early if we can and
1535 // hopefully an attacker trying to path-trace payments cannot make this occur
1536 // on a small/per-node/per-channel scale.
1537 if !chan.is_live() { // channel_disabled
1538 break Some(("Forwarding channel is not in a ready state.", 0x1000 | 20, Some(self.get_channel_update(chan).unwrap())));
1540 if *amt_to_forward < chan.get_counterparty_htlc_minimum_msat() { // amount_below_minimum
1541 break Some(("HTLC amount was below the htlc_minimum_msat", 0x1000 | 11, Some(self.get_channel_update(chan).unwrap())));
1543 let fee = amt_to_forward.checked_mul(chan.get_fee_proportional_millionths() as u64).and_then(|prop_fee| { (prop_fee / 1000000).checked_add(chan.get_holder_fee_base_msat(&self.fee_estimator) as u64) });
1544 if fee.is_none() || msg.amount_msat < fee.unwrap() || (msg.amount_msat - fee.unwrap()) < *amt_to_forward { // fee_insufficient
1545 break Some(("Prior hop has deviated from specified fees parameters or origin node has obsolete ones", 0x1000 | 12, Some(self.get_channel_update(chan).unwrap())));
1547 if (msg.cltv_expiry as u64) < (*outgoing_cltv_value) as u64 + chan.get_cltv_expiry_delta() as u64 { // incorrect_cltv_expiry
1548 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(chan).unwrap())));
1550 let cur_height = self.best_block.read().unwrap().height() + 1;
1551 // Theoretically, channel counterparty shouldn't send us a HTLC expiring now, but we want to be robust wrt to counterparty
1552 // packet sanitization (see HTLC_FAIL_BACK_BUFFER rational)
1553 if msg.cltv_expiry <= cur_height + HTLC_FAIL_BACK_BUFFER as u32 { // expiry_too_soon
1554 break Some(("CLTV expiry is too close", 0x1000 | 14, Some(self.get_channel_update(chan).unwrap())));
1556 if msg.cltv_expiry > cur_height + CLTV_FAR_FAR_AWAY as u32 { // expiry_too_far
1557 break Some(("CLTV expiry is too far in the future", 21, None));
1559 // In theory, we would be safe against unitentional channel-closure, if we only required a margin of LATENCY_GRACE_PERIOD_BLOCKS.
1560 // But, to be safe against policy reception, we use a longuer delay.
1561 if (*outgoing_cltv_value) as u64 <= (cur_height + HTLC_FAIL_BACK_BUFFER) as u64 {
1562 break Some(("Outgoing CLTV value is too soon", 0x1000 | 14, Some(self.get_channel_update(chan).unwrap())));
1568 let mut res = Vec::with_capacity(8 + 128);
1569 if let Some(chan_update) = chan_update {
1570 if code == 0x1000 | 11 || code == 0x1000 | 12 {
1571 res.extend_from_slice(&byte_utils::be64_to_array(msg.amount_msat));
1573 else if code == 0x1000 | 13 {
1574 res.extend_from_slice(&byte_utils::be32_to_array(msg.cltv_expiry));
1576 else if code == 0x1000 | 20 {
1577 // TODO: underspecified, follow https://github.com/lightningnetwork/lightning-rfc/issues/791
1578 res.extend_from_slice(&byte_utils::be16_to_array(0));
1580 res.extend_from_slice(&chan_update.encode_with_len()[..]);
1582 return_err!(err, code, &res[..]);
1587 (pending_forward_info, channel_state.unwrap())
1590 /// only fails if the channel does not yet have an assigned short_id
1591 /// May be called with channel_state already locked!
1592 fn get_channel_update(&self, chan: &Channel<Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
1593 let short_channel_id = match chan.get_short_channel_id() {
1594 None => return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError}),
1598 let were_node_one = PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key).serialize()[..] < chan.get_counterparty_node_id().serialize()[..];
1600 let unsigned = msgs::UnsignedChannelUpdate {
1601 chain_hash: self.genesis_hash,
1603 timestamp: chan.get_update_time_counter(),
1604 flags: (!were_node_one) as u8 | ((!chan.is_live() as u8) << 1),
1605 cltv_expiry_delta: chan.get_cltv_expiry_delta(),
1606 htlc_minimum_msat: chan.get_counterparty_htlc_minimum_msat(),
1607 htlc_maximum_msat: OptionalField::Present(chan.get_announced_htlc_max_msat()),
1608 fee_base_msat: chan.get_holder_fee_base_msat(&self.fee_estimator),
1609 fee_proportional_millionths: chan.get_fee_proportional_millionths(),
1610 excess_data: Vec::new(),
1613 let msg_hash = Sha256dHash::hash(&unsigned.encode()[..]);
1614 let sig = self.secp_ctx.sign(&hash_to_message!(&msg_hash[..]), &self.our_network_key);
1616 Ok(msgs::ChannelUpdate {
1622 // Only public for testing, this should otherwise never be called direcly
1623 pub(crate) fn send_payment_along_path(&self, path: &Vec<RouteHop>, payment_hash: &PaymentHash, payment_secret: &Option<PaymentSecret>, total_value: u64, cur_height: u32) -> Result<(), APIError> {
1624 log_trace!(self.logger, "Attempting to send payment for path with next hop {}", path.first().unwrap().short_channel_id);
1625 let prng_seed = self.keys_manager.get_secure_random_bytes();
1626 let session_priv_bytes = self.keys_manager.get_secure_random_bytes();
1627 let session_priv = SecretKey::from_slice(&session_priv_bytes[..]).expect("RNG is busted");
1629 let onion_keys = onion_utils::construct_onion_keys(&self.secp_ctx, &path, &session_priv)
1630 .map_err(|_| APIError::RouteError{err: "Pubkey along hop was maliciously selected"})?;
1631 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(path, total_value, payment_secret, cur_height)?;
1632 if onion_utils::route_size_insane(&onion_payloads) {
1633 return Err(APIError::RouteError{err: "Route size too large considering onion data"});
1635 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, prng_seed, payment_hash);
1637 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1638 assert!(self.pending_outbound_payments.lock().unwrap().insert(session_priv_bytes));
1640 let err: Result<(), _> = loop {
1641 let mut channel_lock = self.channel_state.lock().unwrap();
1642 let id = match channel_lock.short_to_id.get(&path.first().unwrap().short_channel_id) {
1643 None => return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()}),
1644 Some(id) => id.clone(),
1647 let channel_state = &mut *channel_lock;
1648 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(id) {
1650 if chan.get().get_counterparty_node_id() != path.first().unwrap().pubkey {
1651 return Err(APIError::RouteError{err: "Node ID mismatch on first hop!"});
1653 if !chan.get().is_live() {
1654 return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected/pending monitor update!".to_owned()});
1656 break_chan_entry!(self, chan.get_mut().send_htlc_and_commit(htlc_msat, payment_hash.clone(), htlc_cltv, HTLCSource::OutboundRoute {
1658 session_priv: session_priv.clone(),
1659 first_hop_htlc_msat: htlc_msat,
1660 }, onion_packet, &self.logger), channel_state, chan)
1662 Some((update_add, commitment_signed, monitor_update)) => {
1663 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
1664 maybe_break_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, true);
1665 // Note that MonitorUpdateFailed here indicates (per function docs)
1666 // that we will resend the commitment update once monitor updating
1667 // is restored. Therefore, we must return an error indicating that
1668 // it is unsafe to retry the payment wholesale, which we do in the
1669 // send_payment check for MonitorUpdateFailed, below.
1670 return Err(APIError::MonitorUpdateFailed);
1673 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1674 node_id: path.first().unwrap().pubkey,
1675 updates: msgs::CommitmentUpdate {
1676 update_add_htlcs: vec![update_add],
1677 update_fulfill_htlcs: Vec::new(),
1678 update_fail_htlcs: Vec::new(),
1679 update_fail_malformed_htlcs: Vec::new(),
1687 } else { unreachable!(); }
1691 match handle_error!(self, err, path.first().unwrap().pubkey) {
1692 Ok(_) => unreachable!(),
1694 Err(APIError::ChannelUnavailable { err: e.err })
1699 /// Sends a payment along a given route.
1701 /// Value parameters are provided via the last hop in route, see documentation for RouteHop
1702 /// fields for more info.
1704 /// Note that if the payment_hash already exists elsewhere (eg you're sending a duplicative
1705 /// payment), we don't do anything to stop you! We always try to ensure that if the provided
1706 /// next hop knows the preimage to payment_hash they can claim an additional amount as
1707 /// specified in the last hop in the route! Thus, you should probably do your own
1708 /// payment_preimage tracking (which you should already be doing as they represent "proof of
1709 /// payment") and prevent double-sends yourself.
1711 /// May generate SendHTLCs message(s) event on success, which should be relayed.
1713 /// Each path may have a different return value, and PaymentSendValue may return a Vec with
1714 /// each entry matching the corresponding-index entry in the route paths, see
1715 /// PaymentSendFailure for more info.
1717 /// In general, a path may raise:
1718 /// * APIError::RouteError when an invalid route or forwarding parameter (cltv_delta, fee,
1719 /// node public key) is specified.
1720 /// * APIError::ChannelUnavailable if the next-hop channel is not available for updates
1721 /// (including due to previous monitor update failure or new permanent monitor update
1723 /// * APIError::MonitorUpdateFailed if a new monitor update failure prevented sending the
1724 /// relevant updates.
1726 /// Note that depending on the type of the PaymentSendFailure the HTLC may have been
1727 /// irrevocably committed to on our end. In such a case, do NOT retry the payment with a
1728 /// different route unless you intend to pay twice!
1730 /// payment_secret is unrelated to payment_hash (or PaymentPreimage) and exists to authenticate
1731 /// the sender to the recipient and prevent payment-probing (deanonymization) attacks. For
1732 /// newer nodes, it will be provided to you in the invoice. If you do not have one, the Route
1733 /// must not contain multiple paths as multi-path payments require a recipient-provided
1735 /// If a payment_secret *is* provided, we assume that the invoice had the payment_secret feature
1736 /// bit set (either as required or as available). If multiple paths are present in the Route,
1737 /// we assume the invoice had the basic_mpp feature set.
1738 pub fn send_payment(&self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>) -> Result<(), PaymentSendFailure> {
1739 if route.paths.len() < 1 {
1740 return Err(PaymentSendFailure::ParameterError(APIError::RouteError{err: "There must be at least one path to send over"}));
1742 if route.paths.len() > 10 {
1743 // This limit is completely arbitrary - there aren't any real fundamental path-count
1744 // limits. After we support retrying individual paths we should likely bump this, but
1745 // for now more than 10 paths likely carries too much one-path failure.
1746 return Err(PaymentSendFailure::ParameterError(APIError::RouteError{err: "Sending over more than 10 paths is not currently supported"}));
1748 let mut total_value = 0;
1749 let our_node_id = self.get_our_node_id();
1750 let mut path_errs = Vec::with_capacity(route.paths.len());
1751 'path_check: for path in route.paths.iter() {
1752 if path.len() < 1 || path.len() > 20 {
1753 path_errs.push(Err(APIError::RouteError{err: "Path didn't go anywhere/had bogus size"}));
1754 continue 'path_check;
1756 for (idx, hop) in path.iter().enumerate() {
1757 if idx != path.len() - 1 && hop.pubkey == our_node_id {
1758 path_errs.push(Err(APIError::RouteError{err: "Path went through us but wasn't a simple rebalance loop to us"}));
1759 continue 'path_check;
1762 total_value += path.last().unwrap().fee_msat;
1763 path_errs.push(Ok(()));
1765 if path_errs.iter().any(|e| e.is_err()) {
1766 return Err(PaymentSendFailure::PathParameterError(path_errs));
1769 let cur_height = self.best_block.read().unwrap().height() + 1;
1770 let mut results = Vec::new();
1771 for path in route.paths.iter() {
1772 results.push(self.send_payment_along_path(&path, &payment_hash, payment_secret, total_value, cur_height));
1774 let mut has_ok = false;
1775 let mut has_err = false;
1776 for res in results.iter() {
1777 if res.is_ok() { has_ok = true; }
1778 if res.is_err() { has_err = true; }
1779 if let &Err(APIError::MonitorUpdateFailed) = res {
1780 // MonitorUpdateFailed is inherently unsafe to retry, so we call it a
1787 if has_err && has_ok {
1788 Err(PaymentSendFailure::PartialFailure(results))
1790 Err(PaymentSendFailure::AllFailedRetrySafe(results.drain(..).map(|r| r.unwrap_err()).collect()))
1796 /// Handles the generation of a funding transaction, optionally (for tests) with a function
1797 /// which checks the correctness of the funding transaction given the associated channel.
1798 fn funding_transaction_generated_intern<FundingOutput: Fn(&Channel<Signer>, &Transaction) -> Result<OutPoint, APIError>>
1799 (&self, temporary_channel_id: &[u8; 32], funding_transaction: Transaction, find_funding_output: FundingOutput) -> Result<(), APIError> {
1801 let (res, chan) = match self.channel_state.lock().unwrap().by_id.remove(temporary_channel_id) {
1803 let funding_txo = find_funding_output(&chan, &funding_transaction)?;
1805 (chan.get_outbound_funding_created(funding_transaction, funding_txo, &self.logger)
1806 .map_err(|e| if let ChannelError::Close(msg) = e {
1807 MsgHandleErrInternal::from_finish_shutdown(msg, chan.channel_id(), chan.force_shutdown(true), None)
1808 } else { unreachable!(); })
1811 None => { return Err(APIError::ChannelUnavailable { err: "No such channel".to_owned() }) },
1813 match handle_error!(self, res, chan.get_counterparty_node_id()) {
1814 Ok(funding_msg) => {
1817 Err(_) => { return Err(APIError::ChannelUnavailable {
1818 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()
1823 let mut channel_state = self.channel_state.lock().unwrap();
1824 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
1825 node_id: chan.get_counterparty_node_id(),
1828 match channel_state.by_id.entry(chan.channel_id()) {
1829 hash_map::Entry::Occupied(_) => {
1830 panic!("Generated duplicate funding txid?");
1832 hash_map::Entry::Vacant(e) => {
1840 pub(crate) fn funding_transaction_generated_unchecked(&self, temporary_channel_id: &[u8; 32], funding_transaction: Transaction, output_index: u16) -> Result<(), APIError> {
1841 self.funding_transaction_generated_intern(temporary_channel_id, funding_transaction, |_, tx| {
1842 Ok(OutPoint { txid: tx.txid(), index: output_index })
1846 /// Call this upon creation of a funding transaction for the given channel.
1848 /// Returns an [`APIError::APIMisuseError`] if the funding_transaction spent non-SegWit outputs
1849 /// or if no output was found which matches the parameters in [`Event::FundingGenerationReady`].
1851 /// Panics if a funding transaction has already been provided for this channel.
1853 /// May panic if the output found in the funding transaction is duplicative with some other
1854 /// channel (note that this should be trivially prevented by using unique funding transaction
1855 /// keys per-channel).
1857 /// Do NOT broadcast the funding transaction yourself. When we have safely received our
1858 /// counterparty's signature the funding transaction will automatically be broadcast via the
1859 /// [`BroadcasterInterface`] provided when this `ChannelManager` was constructed.
1861 /// Note that this includes RBF or similar transaction replacement strategies - lightning does
1862 /// not currently support replacing a funding transaction on an existing channel. Instead,
1863 /// create a new channel with a conflicting funding transaction.
1865 /// [`Event::FundingGenerationReady`]: crate::util::events::Event::FundingGenerationReady
1866 pub fn funding_transaction_generated(&self, temporary_channel_id: &[u8; 32], funding_transaction: Transaction) -> Result<(), APIError> {
1867 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1869 for inp in funding_transaction.input.iter() {
1870 if inp.witness.is_empty() {
1871 return Err(APIError::APIMisuseError {
1872 err: "Funding transaction must be fully signed and spend Segwit outputs".to_owned()
1876 self.funding_transaction_generated_intern(temporary_channel_id, funding_transaction, |chan, tx| {
1877 let mut output_index = None;
1878 let expected_spk = chan.get_funding_redeemscript().to_v0_p2wsh();
1879 for (idx, outp) in tx.output.iter().enumerate() {
1880 if outp.script_pubkey == expected_spk && outp.value == chan.get_value_satoshis() {
1881 if output_index.is_some() {
1882 return Err(APIError::APIMisuseError {
1883 err: "Multiple outputs matched the expected script and value".to_owned()
1886 if idx > u16::max_value() as usize {
1887 return Err(APIError::APIMisuseError {
1888 err: "Transaction had more than 2^16 outputs, which is not supported".to_owned()
1891 output_index = Some(idx as u16);
1894 if output_index.is_none() {
1895 return Err(APIError::APIMisuseError {
1896 err: "No output matched the script_pubkey and value in the FundingGenerationReady event".to_owned()
1899 Ok(OutPoint { txid: tx.txid(), index: output_index.unwrap() })
1903 fn get_announcement_sigs(&self, chan: &Channel<Signer>) -> Option<msgs::AnnouncementSignatures> {
1904 if !chan.should_announce() {
1905 log_trace!(self.logger, "Can't send announcement_signatures for private channel {}", log_bytes!(chan.channel_id()));
1909 let (announcement, our_bitcoin_sig) = match chan.get_channel_announcement(self.get_our_node_id(), self.genesis_hash.clone()) {
1911 Err(_) => return None, // Only in case of state precondition violations eg channel is closing
1913 let msghash = hash_to_message!(&Sha256dHash::hash(&announcement.encode()[..])[..]);
1914 let our_node_sig = self.secp_ctx.sign(&msghash, &self.our_network_key);
1916 Some(msgs::AnnouncementSignatures {
1917 channel_id: chan.channel_id(),
1918 short_channel_id: chan.get_short_channel_id().unwrap(),
1919 node_signature: our_node_sig,
1920 bitcoin_signature: our_bitcoin_sig,
1925 // Messages of up to 64KB should never end up more than half full with addresses, as that would
1926 // be absurd. We ensure this by checking that at least 500 (our stated public contract on when
1927 // broadcast_node_announcement panics) of the maximum-length addresses would fit in a 64KB
1929 const HALF_MESSAGE_IS_ADDRS: u32 = ::core::u16::MAX as u32 / (NetAddress::MAX_LEN as u32 + 1) / 2;
1932 // ...by failing to compile if the number of addresses that would be half of a message is
1933 // smaller than 500:
1934 const STATIC_ASSERT: u32 = Self::HALF_MESSAGE_IS_ADDRS - 500;
1936 /// Generates a signed node_announcement from the given arguments and creates a
1937 /// BroadcastNodeAnnouncement event. Note that such messages will be ignored unless peers have
1938 /// seen a channel_announcement from us (ie unless we have public channels open).
1940 /// RGB is a node "color" and alias is a printable human-readable string to describe this node
1941 /// to humans. They carry no in-protocol meaning.
1943 /// addresses represent the set (possibly empty) of socket addresses on which this node accepts
1944 /// incoming connections. These will be broadcast to the network, publicly tying these
1945 /// addresses together. If you wish to preserve user privacy, addresses should likely contain
1946 /// only Tor Onion addresses.
1948 /// Panics if addresses is absurdly large (more than 500).
1949 pub fn broadcast_node_announcement(&self, rgb: [u8; 3], alias: [u8; 32], mut addresses: Vec<NetAddress>) {
1950 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1952 if addresses.len() > 500 {
1953 panic!("More than half the message size was taken up by public addresses!");
1956 // While all existing nodes handle unsorted addresses just fine, the spec requires that
1957 // addresses be sorted for future compatibility.
1958 addresses.sort_by_key(|addr| addr.get_id());
1960 let announcement = msgs::UnsignedNodeAnnouncement {
1961 features: NodeFeatures::known(),
1962 timestamp: self.last_node_announcement_serial.fetch_add(1, Ordering::AcqRel) as u32,
1963 node_id: self.get_our_node_id(),
1964 rgb, alias, addresses,
1965 excess_address_data: Vec::new(),
1966 excess_data: Vec::new(),
1968 let msghash = hash_to_message!(&Sha256dHash::hash(&announcement.encode()[..])[..]);
1970 let mut channel_state = self.channel_state.lock().unwrap();
1971 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastNodeAnnouncement {
1972 msg: msgs::NodeAnnouncement {
1973 signature: self.secp_ctx.sign(&msghash, &self.our_network_key),
1974 contents: announcement
1979 /// Processes HTLCs which are pending waiting on random forward delay.
1981 /// Should only really ever be called in response to a PendingHTLCsForwardable event.
1982 /// Will likely generate further events.
1983 pub fn process_pending_htlc_forwards(&self) {
1984 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
1986 let mut new_events = Vec::new();
1987 let mut failed_forwards = Vec::new();
1988 let mut handle_errors = Vec::new();
1990 let mut channel_state_lock = self.channel_state.lock().unwrap();
1991 let channel_state = &mut *channel_state_lock;
1993 for (short_chan_id, mut pending_forwards) in channel_state.forward_htlcs.drain() {
1994 if short_chan_id != 0 {
1995 let forward_chan_id = match channel_state.short_to_id.get(&short_chan_id) {
1996 Some(chan_id) => chan_id.clone(),
1998 failed_forwards.reserve(pending_forwards.len());
1999 for forward_info in pending_forwards.drain(..) {
2000 match forward_info {
2001 HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info,
2002 prev_funding_outpoint } => {
2003 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
2004 short_channel_id: prev_short_channel_id,
2005 outpoint: prev_funding_outpoint,
2006 htlc_id: prev_htlc_id,
2007 incoming_packet_shared_secret: forward_info.incoming_shared_secret,
2009 failed_forwards.push((htlc_source, forward_info.payment_hash,
2010 HTLCFailReason::Reason { failure_code: 0x4000 | 10, data: Vec::new() }
2013 HTLCForwardInfo::FailHTLC { .. } => {
2014 // Channel went away before we could fail it. This implies
2015 // the channel is now on chain and our counterparty is
2016 // trying to broadcast the HTLC-Timeout, but that's their
2017 // problem, not ours.
2024 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(forward_chan_id) {
2025 let mut add_htlc_msgs = Vec::new();
2026 let mut fail_htlc_msgs = Vec::new();
2027 for forward_info in pending_forwards.drain(..) {
2028 match forward_info {
2029 HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info: PendingHTLCInfo {
2030 routing: PendingHTLCRouting::Forward {
2032 }, incoming_shared_secret, payment_hash, amt_to_forward, outgoing_cltv_value },
2033 prev_funding_outpoint } => {
2034 log_trace!(self.logger, "Adding HTLC from short id {} with payment_hash {} to channel with short id {} after delay", log_bytes!(payment_hash.0), prev_short_channel_id, short_chan_id);
2035 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
2036 short_channel_id: prev_short_channel_id,
2037 outpoint: prev_funding_outpoint,
2038 htlc_id: prev_htlc_id,
2039 incoming_packet_shared_secret: incoming_shared_secret,
2041 match chan.get_mut().send_htlc(amt_to_forward, payment_hash, outgoing_cltv_value, htlc_source.clone(), onion_packet) {
2043 if let ChannelError::Ignore(msg) = e {
2044 log_trace!(self.logger, "Failed to forward HTLC with payment_hash {}: {}", log_bytes!(payment_hash.0), msg);
2046 panic!("Stated return value requirements in send_htlc() were not met");
2048 let chan_update = self.get_channel_update(chan.get()).unwrap();
2049 failed_forwards.push((htlc_source, payment_hash,
2050 HTLCFailReason::Reason { failure_code: 0x1000 | 7, data: chan_update.encode_with_len() }
2056 Some(msg) => { add_htlc_msgs.push(msg); },
2058 // Nothing to do here...we're waiting on a remote
2059 // revoke_and_ack before we can add anymore HTLCs. The Channel
2060 // will automatically handle building the update_add_htlc and
2061 // commitment_signed messages when we can.
2062 // TODO: Do some kind of timer to set the channel as !is_live()
2063 // as we don't really want others relying on us relaying through
2064 // this channel currently :/.
2070 HTLCForwardInfo::AddHTLC { .. } => {
2071 panic!("short_channel_id != 0 should imply any pending_forward entries are of type Forward");
2073 HTLCForwardInfo::FailHTLC { htlc_id, err_packet } => {
2074 log_trace!(self.logger, "Failing HTLC back to channel with short id {} after delay", short_chan_id);
2075 match chan.get_mut().get_update_fail_htlc(htlc_id, err_packet, &self.logger) {
2077 if let ChannelError::Ignore(msg) = e {
2078 log_trace!(self.logger, "Failed to fail backwards to short_id {}: {}", short_chan_id, msg);
2080 panic!("Stated return value requirements in get_update_fail_htlc() were not met");
2082 // fail-backs are best-effort, we probably already have one
2083 // pending, and if not that's OK, if not, the channel is on
2084 // the chain and sending the HTLC-Timeout is their problem.
2087 Ok(Some(msg)) => { fail_htlc_msgs.push(msg); },
2089 // Nothing to do here...we're waiting on a remote
2090 // revoke_and_ack before we can update the commitment
2091 // transaction. The Channel will automatically handle
2092 // building the update_fail_htlc and commitment_signed
2093 // messages when we can.
2094 // We don't need any kind of timer here as they should fail
2095 // the channel onto the chain if they can't get our
2096 // update_fail_htlc in time, it's not our problem.
2103 if !add_htlc_msgs.is_empty() || !fail_htlc_msgs.is_empty() {
2104 let (commitment_msg, monitor_update) = match chan.get_mut().send_commitment(&self.logger) {
2107 // We surely failed send_commitment due to bad keys, in that case
2108 // close channel and then send error message to peer.
2109 let counterparty_node_id = chan.get().get_counterparty_node_id();
2110 let err: Result<(), _> = match e {
2111 ChannelError::Ignore(_) => {
2112 panic!("Stated return value requirements in send_commitment() were not met");
2114 ChannelError::Close(msg) => {
2115 log_trace!(self.logger, "Closing channel {} due to Close-required error: {}", log_bytes!(chan.key()[..]), msg);
2116 let (channel_id, mut channel) = chan.remove_entry();
2117 if let Some(short_id) = channel.get_short_channel_id() {
2118 channel_state.short_to_id.remove(&short_id);
2120 Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, channel.force_shutdown(true), self.get_channel_update(&channel).ok()))
2122 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"); }
2124 handle_errors.push((counterparty_node_id, err));
2128 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
2129 handle_errors.push((chan.get().get_counterparty_node_id(), handle_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, true)));
2132 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2133 node_id: chan.get().get_counterparty_node_id(),
2134 updates: msgs::CommitmentUpdate {
2135 update_add_htlcs: add_htlc_msgs,
2136 update_fulfill_htlcs: Vec::new(),
2137 update_fail_htlcs: fail_htlc_msgs,
2138 update_fail_malformed_htlcs: Vec::new(),
2140 commitment_signed: commitment_msg,
2148 for forward_info in pending_forwards.drain(..) {
2149 match forward_info {
2150 HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info: PendingHTLCInfo {
2151 routing: PendingHTLCRouting::Receive { payment_data, incoming_cltv_expiry },
2152 incoming_shared_secret, payment_hash, amt_to_forward, .. },
2153 prev_funding_outpoint } => {
2154 let claimable_htlc = ClaimableHTLC {
2155 prev_hop: HTLCPreviousHopData {
2156 short_channel_id: prev_short_channel_id,
2157 outpoint: prev_funding_outpoint,
2158 htlc_id: prev_htlc_id,
2159 incoming_packet_shared_secret: incoming_shared_secret,
2161 value: amt_to_forward,
2162 payment_data: payment_data.clone(),
2163 cltv_expiry: incoming_cltv_expiry,
2166 macro_rules! fail_htlc {
2168 let mut htlc_msat_height_data = byte_utils::be64_to_array($htlc.value).to_vec();
2169 htlc_msat_height_data.extend_from_slice(
2170 &byte_utils::be32_to_array(self.best_block.read().unwrap().height()),
2172 failed_forwards.push((HTLCSource::PreviousHopData(HTLCPreviousHopData {
2173 short_channel_id: $htlc.prev_hop.short_channel_id,
2174 outpoint: prev_funding_outpoint,
2175 htlc_id: $htlc.prev_hop.htlc_id,
2176 incoming_packet_shared_secret: $htlc.prev_hop.incoming_packet_shared_secret,
2178 HTLCFailReason::Reason { failure_code: 0x4000 | 15, data: htlc_msat_height_data }
2183 // Check that the payment hash and secret are known. Note that we
2184 // MUST take care to handle the "unknown payment hash" and
2185 // "incorrect payment secret" cases here identically or we'd expose
2186 // that we are the ultimate recipient of the given payment hash.
2187 // Further, we must not expose whether we have any other HTLCs
2188 // associated with the same payment_hash pending or not.
2189 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
2190 match payment_secrets.entry(payment_hash) {
2191 hash_map::Entry::Vacant(_) => {
2192 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as we didn't have a corresponding inbound payment.", log_bytes!(payment_hash.0));
2193 fail_htlc!(claimable_htlc);
2195 hash_map::Entry::Occupied(inbound_payment) => {
2196 if inbound_payment.get().payment_secret != payment_data.payment_secret {
2197 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our expected payment secret.", log_bytes!(payment_hash.0));
2198 fail_htlc!(claimable_htlc);
2199 } else if inbound_payment.get().min_value_msat.is_some() && payment_data.total_msat < inbound_payment.get().min_value_msat.unwrap() {
2200 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our minimum value (had {}, needed {}).",
2201 log_bytes!(payment_hash.0), payment_data.total_msat, inbound_payment.get().min_value_msat.unwrap());
2202 fail_htlc!(claimable_htlc);
2204 let mut total_value = 0;
2205 let htlcs = channel_state.claimable_htlcs.entry(payment_hash)
2206 .or_insert(Vec::new());
2207 htlcs.push(claimable_htlc);
2208 for htlc in htlcs.iter() {
2209 total_value += htlc.value;
2210 if htlc.payment_data.total_msat != payment_data.total_msat {
2211 log_trace!(self.logger, "Failing HTLCs with payment_hash {} as the HTLCs had inconsistent total values (eg {} and {})",
2212 log_bytes!(payment_hash.0), payment_data.total_msat, htlc.payment_data.total_msat);
2213 total_value = msgs::MAX_VALUE_MSAT;
2215 if total_value >= msgs::MAX_VALUE_MSAT { break; }
2217 if total_value >= msgs::MAX_VALUE_MSAT || total_value > payment_data.total_msat {
2218 log_trace!(self.logger, "Failing HTLCs with payment_hash {} as the total value {} ran over expected value {} (or HTLCs were inconsistent)",
2219 log_bytes!(payment_hash.0), total_value, payment_data.total_msat);
2220 for htlc in htlcs.iter() {
2223 } else if total_value == payment_data.total_msat {
2224 new_events.push(events::Event::PaymentReceived {
2226 payment_preimage: inbound_payment.get().payment_preimage,
2227 payment_secret: payment_data.payment_secret,
2229 user_payment_id: inbound_payment.get().user_payment_id,
2231 // Only ever generate at most one PaymentReceived
2232 // per registered payment_hash, even if it isn't
2234 inbound_payment.remove_entry();
2236 // Nothing to do - we haven't reached the total
2237 // payment value yet, wait until we receive more
2244 HTLCForwardInfo::AddHTLC { .. } => {
2245 panic!("short_channel_id == 0 should imply any pending_forward entries are of type Receive");
2247 HTLCForwardInfo::FailHTLC { .. } => {
2248 panic!("Got pending fail of our own HTLC");
2256 for (htlc_source, payment_hash, failure_reason) in failed_forwards.drain(..) {
2257 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source, &payment_hash, failure_reason);
2260 for (counterparty_node_id, err) in handle_errors.drain(..) {
2261 let _ = handle_error!(self, err, counterparty_node_id);
2264 if new_events.is_empty() { return }
2265 let mut events = self.pending_events.lock().unwrap();
2266 events.append(&mut new_events);
2269 /// Free the background events, generally called from timer_tick_occurred.
2271 /// Exposed for testing to allow us to process events quickly without generating accidental
2272 /// BroadcastChannelUpdate events in timer_tick_occurred.
2274 /// Expects the caller to have a total_consistency_lock read lock.
2275 fn process_background_events(&self) -> bool {
2276 let mut background_events = Vec::new();
2277 mem::swap(&mut *self.pending_background_events.lock().unwrap(), &mut background_events);
2278 if background_events.is_empty() {
2282 for event in background_events.drain(..) {
2284 BackgroundEvent::ClosingMonitorUpdate((funding_txo, update)) => {
2285 // The channel has already been closed, so no use bothering to care about the
2286 // monitor updating completing.
2287 let _ = self.chain_monitor.update_channel(funding_txo, update);
2294 #[cfg(any(test, feature = "_test_utils"))]
2295 pub(crate) fn test_process_background_events(&self) {
2296 self.process_background_events();
2299 /// If a peer is disconnected we mark any channels with that peer as 'disabled'.
2300 /// After some time, if channels are still disabled we need to broadcast a ChannelUpdate
2301 /// to inform the network about the uselessness of these channels.
2303 /// This method handles all the details, and must be called roughly once per minute.
2305 /// Note that in some rare cases this may generate a `chain::Watch::update_channel` call.
2306 pub fn timer_tick_occurred(&self) {
2307 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
2308 let mut should_persist = NotifyOption::SkipPersist;
2309 if self.process_background_events() { should_persist = NotifyOption::DoPersist; }
2311 let mut channel_state_lock = self.channel_state.lock().unwrap();
2312 let channel_state = &mut *channel_state_lock;
2313 for (_, chan) in channel_state.by_id.iter_mut() {
2314 match chan.channel_update_status() {
2315 ChannelUpdateStatus::Enabled if !chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::DisabledStaged),
2316 ChannelUpdateStatus::Disabled if chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::EnabledStaged),
2317 ChannelUpdateStatus::DisabledStaged if chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::Enabled),
2318 ChannelUpdateStatus::EnabledStaged if !chan.is_live() => chan.set_channel_update_status(ChannelUpdateStatus::Disabled),
2319 ChannelUpdateStatus::DisabledStaged if !chan.is_live() => {
2320 if let Ok(update) = self.get_channel_update(&chan) {
2321 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2325 should_persist = NotifyOption::DoPersist;
2326 chan.set_channel_update_status(ChannelUpdateStatus::Disabled);
2328 ChannelUpdateStatus::EnabledStaged if chan.is_live() => {
2329 if let Ok(update) = self.get_channel_update(&chan) {
2330 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2334 should_persist = NotifyOption::DoPersist;
2335 chan.set_channel_update_status(ChannelUpdateStatus::Enabled);
2345 /// Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
2346 /// after a PaymentReceived event, failing the HTLC back to its origin and freeing resources
2347 /// along the path (including in our own channel on which we received it).
2348 /// Returns false if no payment was found to fail backwards, true if the process of failing the
2349 /// HTLC backwards has been started.
2350 pub fn fail_htlc_backwards(&self, payment_hash: &PaymentHash) -> bool {
2351 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2353 let mut channel_state = Some(self.channel_state.lock().unwrap());
2354 let removed_source = channel_state.as_mut().unwrap().claimable_htlcs.remove(payment_hash);
2355 if let Some(mut sources) = removed_source {
2356 for htlc in sources.drain(..) {
2357 if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
2358 let mut htlc_msat_height_data = byte_utils::be64_to_array(htlc.value).to_vec();
2359 htlc_msat_height_data.extend_from_slice(&byte_utils::be32_to_array(
2360 self.best_block.read().unwrap().height()));
2361 self.fail_htlc_backwards_internal(channel_state.take().unwrap(),
2362 HTLCSource::PreviousHopData(htlc.prev_hop), payment_hash,
2363 HTLCFailReason::Reason { failure_code: 0x4000 | 15, data: htlc_msat_height_data });
2369 // Fail a list of HTLCs that were just freed from the holding cell. The HTLCs need to be
2370 // failed backwards or, if they were one of our outgoing HTLCs, then their failure needs to
2371 // be surfaced to the user.
2372 fn fail_holding_cell_htlcs(&self, mut htlcs_to_fail: Vec<(HTLCSource, PaymentHash)>, channel_id: [u8; 32]) {
2373 for (htlc_src, payment_hash) in htlcs_to_fail.drain(..) {
2375 HTLCSource::PreviousHopData(HTLCPreviousHopData { .. }) => {
2376 let (failure_code, onion_failure_data) =
2377 match self.channel_state.lock().unwrap().by_id.entry(channel_id) {
2378 hash_map::Entry::Occupied(chan_entry) => {
2379 if let Ok(upd) = self.get_channel_update(&chan_entry.get()) {
2380 (0x1000|7, upd.encode_with_len())
2382 (0x4000|10, Vec::new())
2385 hash_map::Entry::Vacant(_) => (0x4000|10, Vec::new())
2387 let channel_state = self.channel_state.lock().unwrap();
2388 self.fail_htlc_backwards_internal(channel_state,
2389 htlc_src, &payment_hash, HTLCFailReason::Reason { failure_code, data: onion_failure_data});
2391 HTLCSource::OutboundRoute { session_priv, .. } => {
2393 let mut session_priv_bytes = [0; 32];
2394 session_priv_bytes.copy_from_slice(&session_priv[..]);
2395 self.pending_outbound_payments.lock().unwrap().remove(&session_priv_bytes)
2397 self.pending_events.lock().unwrap().push(
2398 events::Event::PaymentFailed {
2400 rejected_by_dest: false,
2408 log_trace!(self.logger, "Received duplicative fail for HTLC with payment_hash {}", log_bytes!(payment_hash.0));
2415 /// Fails an HTLC backwards to the sender of it to us.
2416 /// Note that while we take a channel_state lock as input, we do *not* assume consistency here.
2417 /// There are several callsites that do stupid things like loop over a list of payment_hashes
2418 /// to fail and take the channel_state lock for each iteration (as we take ownership and may
2419 /// drop it). In other words, no assumptions are made that entries in claimable_htlcs point to
2420 /// still-available channels.
2421 fn fail_htlc_backwards_internal(&self, mut channel_state_lock: MutexGuard<ChannelHolder<Signer>>, source: HTLCSource, payment_hash: &PaymentHash, onion_error: HTLCFailReason) {
2422 //TODO: There is a timing attack here where if a node fails an HTLC back to us they can
2423 //identify whether we sent it or not based on the (I presume) very different runtime
2424 //between the branches here. We should make this async and move it into the forward HTLCs
2427 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
2428 // from block_connected which may run during initialization prior to the chain_monitor
2429 // being fully configured. See the docs for `ChannelManagerReadArgs` for more.
2431 HTLCSource::OutboundRoute { ref path, session_priv, .. } => {
2433 let mut session_priv_bytes = [0; 32];
2434 session_priv_bytes.copy_from_slice(&session_priv[..]);
2435 !self.pending_outbound_payments.lock().unwrap().remove(&session_priv_bytes)
2437 log_trace!(self.logger, "Received duplicative fail for HTLC with payment_hash {}", log_bytes!(payment_hash.0));
2440 log_trace!(self.logger, "Failing outbound payment HTLC with payment_hash {}", log_bytes!(payment_hash.0));
2441 mem::drop(channel_state_lock);
2442 match &onion_error {
2443 &HTLCFailReason::LightningError { ref err } => {
2445 let (channel_update, payment_retryable, onion_error_code, onion_error_data) = onion_utils::process_onion_failure(&self.secp_ctx, &self.logger, &source, err.data.clone());
2447 let (channel_update, payment_retryable, _, _) = onion_utils::process_onion_failure(&self.secp_ctx, &self.logger, &source, err.data.clone());
2448 // TODO: If we decided to blame ourselves (or one of our channels) in
2449 // process_onion_failure we should close that channel as it implies our
2450 // next-hop is needlessly blaming us!
2451 if let Some(update) = channel_update {
2452 self.channel_state.lock().unwrap().pending_msg_events.push(
2453 events::MessageSendEvent::PaymentFailureNetworkUpdate {
2458 self.pending_events.lock().unwrap().push(
2459 events::Event::PaymentFailed {
2460 payment_hash: payment_hash.clone(),
2461 rejected_by_dest: !payment_retryable,
2463 error_code: onion_error_code,
2465 error_data: onion_error_data
2469 &HTLCFailReason::Reason {
2475 // we get a fail_malformed_htlc from the first hop
2476 // TODO: We'd like to generate a PaymentFailureNetworkUpdate for temporary
2477 // failures here, but that would be insufficient as get_route
2478 // generally ignores its view of our own channels as we provide them via
2480 // TODO: For non-temporary failures, we really should be closing the
2481 // channel here as we apparently can't relay through them anyway.
2482 self.pending_events.lock().unwrap().push(
2483 events::Event::PaymentFailed {
2484 payment_hash: payment_hash.clone(),
2485 rejected_by_dest: path.len() == 1,
2487 error_code: Some(*failure_code),
2489 error_data: Some(data.clone()),
2495 HTLCSource::PreviousHopData(HTLCPreviousHopData { short_channel_id, htlc_id, incoming_packet_shared_secret, .. }) => {
2496 let err_packet = match onion_error {
2497 HTLCFailReason::Reason { failure_code, data } => {
2498 log_trace!(self.logger, "Failing HTLC with payment_hash {} backwards from us with code {}", log_bytes!(payment_hash.0), failure_code);
2499 let packet = onion_utils::build_failure_packet(&incoming_packet_shared_secret, failure_code, &data[..]).encode();
2500 onion_utils::encrypt_failure_packet(&incoming_packet_shared_secret, &packet)
2502 HTLCFailReason::LightningError { err } => {
2503 log_trace!(self.logger, "Failing HTLC with payment_hash {} backwards with pre-built LightningError", log_bytes!(payment_hash.0));
2504 onion_utils::encrypt_failure_packet(&incoming_packet_shared_secret, &err.data)
2508 let mut forward_event = None;
2509 if channel_state_lock.forward_htlcs.is_empty() {
2510 forward_event = Some(Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS));
2512 match channel_state_lock.forward_htlcs.entry(short_channel_id) {
2513 hash_map::Entry::Occupied(mut entry) => {
2514 entry.get_mut().push(HTLCForwardInfo::FailHTLC { htlc_id, err_packet });
2516 hash_map::Entry::Vacant(entry) => {
2517 entry.insert(vec!(HTLCForwardInfo::FailHTLC { htlc_id, err_packet }));
2520 mem::drop(channel_state_lock);
2521 if let Some(time) = forward_event {
2522 let mut pending_events = self.pending_events.lock().unwrap();
2523 pending_events.push(events::Event::PendingHTLCsForwardable {
2524 time_forwardable: time
2531 /// Provides a payment preimage in response to a PaymentReceived event, returning true and
2532 /// generating message events for the net layer to claim the payment, if possible. Thus, you
2533 /// should probably kick the net layer to go send messages if this returns true!
2535 /// Note that if you did not set an `amount_msat` when calling [`create_inbound_payment`] or
2536 /// [`create_inbound_payment_for_hash`] you must check that the amount in the `PaymentReceived`
2537 /// event matches your expectation. If you fail to do so and call this method, you may provide
2538 /// the sender "proof-of-payment" when they did not fulfill the full expected payment.
2540 /// May panic if called except in response to a PaymentReceived event.
2542 /// [`create_inbound_payment`]: Self::create_inbound_payment
2543 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
2544 pub fn claim_funds(&self, payment_preimage: PaymentPreimage) -> bool {
2545 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
2547 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2549 let mut channel_state = Some(self.channel_state.lock().unwrap());
2550 let removed_source = channel_state.as_mut().unwrap().claimable_htlcs.remove(&payment_hash);
2551 if let Some(mut sources) = removed_source {
2552 assert!(!sources.is_empty());
2554 // If we are claiming an MPP payment, we have to take special care to ensure that each
2555 // channel exists before claiming all of the payments (inside one lock).
2556 // Note that channel existance is sufficient as we should always get a monitor update
2557 // which will take care of the real HTLC claim enforcement.
2559 // If we find an HTLC which we would need to claim but for which we do not have a
2560 // channel, we will fail all parts of the MPP payment. While we could wait and see if
2561 // the sender retries the already-failed path(s), it should be a pretty rare case where
2562 // we got all the HTLCs and then a channel closed while we were waiting for the user to
2563 // provide the preimage, so worrying too much about the optimal handling isn't worth
2565 let mut valid_mpp = true;
2566 for htlc in sources.iter() {
2567 if let None = channel_state.as_ref().unwrap().short_to_id.get(&htlc.prev_hop.short_channel_id) {
2573 let mut errs = Vec::new();
2574 let mut claimed_any_htlcs = false;
2575 for htlc in sources.drain(..) {
2577 if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
2578 let mut htlc_msat_height_data = byte_utils::be64_to_array(htlc.value).to_vec();
2579 htlc_msat_height_data.extend_from_slice(&byte_utils::be32_to_array(
2580 self.best_block.read().unwrap().height()));
2581 self.fail_htlc_backwards_internal(channel_state.take().unwrap(),
2582 HTLCSource::PreviousHopData(htlc.prev_hop), &payment_hash,
2583 HTLCFailReason::Reason { failure_code: 0x4000|15, data: htlc_msat_height_data });
2585 match self.claim_funds_from_hop(channel_state.as_mut().unwrap(), htlc.prev_hop, payment_preimage) {
2587 if let msgs::ErrorAction::IgnoreError = e.1.err.action {
2588 // We got a temporary failure updating monitor, but will claim the
2589 // HTLC when the monitor updating is restored (or on chain).
2590 log_error!(self.logger, "Temporary failure claiming HTLC, treating as success: {}", e.1.err.err);
2591 claimed_any_htlcs = true;
2592 } else { errs.push(e); }
2594 Err(None) => unreachable!("We already checked for channel existence, we can't fail here!"),
2595 Ok(()) => claimed_any_htlcs = true,
2600 // Now that we've done the entire above loop in one lock, we can handle any errors
2601 // which were generated.
2602 channel_state.take();
2604 for (counterparty_node_id, err) in errs.drain(..) {
2605 let res: Result<(), _> = Err(err);
2606 let _ = handle_error!(self, res, counterparty_node_id);
2613 fn claim_funds_from_hop(&self, channel_state_lock: &mut MutexGuard<ChannelHolder<Signer>>, prev_hop: HTLCPreviousHopData, payment_preimage: PaymentPreimage) -> Result<(), Option<(PublicKey, MsgHandleErrInternal)>> {
2614 //TODO: Delay the claimed_funds relaying just like we do outbound relay!
2615 let channel_state = &mut **channel_state_lock;
2616 let chan_id = match channel_state.short_to_id.get(&prev_hop.short_channel_id) {
2617 Some(chan_id) => chan_id.clone(),
2623 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(chan_id) {
2624 let was_frozen_for_monitor = chan.get().is_awaiting_monitor_update();
2625 match chan.get_mut().get_update_fulfill_htlc_and_commit(prev_hop.htlc_id, payment_preimage, &self.logger) {
2626 Ok((msgs, monitor_option)) => {
2627 if let Some(monitor_update) = monitor_option {
2628 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
2629 if was_frozen_for_monitor {
2630 assert!(msgs.is_none());
2632 return Err(Some((chan.get().get_counterparty_node_id(), handle_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, msgs.is_some()).unwrap_err())));
2636 if let Some((msg, commitment_signed)) = msgs {
2637 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2638 node_id: chan.get().get_counterparty_node_id(),
2639 updates: msgs::CommitmentUpdate {
2640 update_add_htlcs: Vec::new(),
2641 update_fulfill_htlcs: vec![msg],
2642 update_fail_htlcs: Vec::new(),
2643 update_fail_malformed_htlcs: Vec::new(),
2652 // TODO: Do something with e?
2653 // This should only occur if we are claiming an HTLC at the same time as the
2654 // HTLC is being failed (eg because a block is being connected and this caused
2655 // an HTLC to time out). This should, of course, only occur if the user is the
2656 // one doing the claiming (as it being a part of a peer claim would imply we're
2657 // about to lose funds) and only if the lock in claim_funds was dropped as a
2658 // previous HTLC was failed (thus not for an MPP payment).
2659 debug_assert!(false, "This shouldn't be reachable except in absurdly rare cases between monitor updates and HTLC timeouts: {:?}", e);
2663 } else { unreachable!(); }
2666 fn claim_funds_internal(&self, mut channel_state_lock: MutexGuard<ChannelHolder<Signer>>, source: HTLCSource, payment_preimage: PaymentPreimage) {
2668 HTLCSource::OutboundRoute { session_priv, .. } => {
2669 mem::drop(channel_state_lock);
2671 let mut session_priv_bytes = [0; 32];
2672 session_priv_bytes.copy_from_slice(&session_priv[..]);
2673 self.pending_outbound_payments.lock().unwrap().remove(&session_priv_bytes)
2675 let mut pending_events = self.pending_events.lock().unwrap();
2676 pending_events.push(events::Event::PaymentSent {
2680 log_trace!(self.logger, "Received duplicative fulfill for HTLC with payment_preimage {}", log_bytes!(payment_preimage.0));
2683 HTLCSource::PreviousHopData(hop_data) => {
2684 let prev_outpoint = hop_data.outpoint;
2685 if let Err((counterparty_node_id, err)) = match self.claim_funds_from_hop(&mut channel_state_lock, hop_data, payment_preimage) {
2688 let preimage_update = ChannelMonitorUpdate {
2689 update_id: CLOSED_CHANNEL_UPDATE_ID,
2690 updates: vec![ChannelMonitorUpdateStep::PaymentPreimage {
2691 payment_preimage: payment_preimage.clone(),
2694 // We update the ChannelMonitor on the backward link, after
2695 // receiving an offchain preimage event from the forward link (the
2696 // event being update_fulfill_htlc).
2697 if let Err(e) = self.chain_monitor.update_channel(prev_outpoint, preimage_update) {
2698 log_error!(self.logger, "Critical error: failed to update channel monitor with preimage {:?}: {:?}",
2699 payment_preimage, e);
2703 Err(Some(res)) => Err(res),
2705 mem::drop(channel_state_lock);
2706 let res: Result<(), _> = Err(err);
2707 let _ = handle_error!(self, res, counterparty_node_id);
2713 /// Gets the node_id held by this ChannelManager
2714 pub fn get_our_node_id(&self) -> PublicKey {
2715 self.our_network_pubkey.clone()
2718 /// Restores a single, given channel to normal operation after a
2719 /// ChannelMonitorUpdateErr::TemporaryFailure was returned from a channel monitor update
2722 /// All ChannelMonitor updates up to and including highest_applied_update_id must have been
2723 /// fully committed in every copy of the given channels' ChannelMonitors.
2725 /// Note that there is no effect to calling with a highest_applied_update_id other than the
2726 /// current latest ChannelMonitorUpdate and one call to this function after multiple
2727 /// ChannelMonitorUpdateErr::TemporaryFailures is fine. The highest_applied_update_id field
2728 /// exists largely only to prevent races between this and concurrent update_monitor calls.
2730 /// Thus, the anticipated use is, at a high level:
2731 /// 1) You register a chain::Watch with this ChannelManager,
2732 /// 2) it stores each update to disk, and begins updating any remote (eg watchtower) copies of
2733 /// said ChannelMonitors as it can, returning ChannelMonitorUpdateErr::TemporaryFailures
2734 /// any time it cannot do so instantly,
2735 /// 3) update(s) are applied to each remote copy of a ChannelMonitor,
2736 /// 4) once all remote copies are updated, you call this function with the update_id that
2737 /// completed, and once it is the latest the Channel will be re-enabled.
2738 pub fn channel_monitor_updated(&self, funding_txo: &OutPoint, highest_applied_update_id: u64) {
2739 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
2741 let (mut pending_failures, chan_restoration_res) = {
2742 let mut channel_lock = self.channel_state.lock().unwrap();
2743 let channel_state = &mut *channel_lock;
2744 let mut channel = match channel_state.by_id.entry(funding_txo.to_channel_id()) {
2745 hash_map::Entry::Occupied(chan) => chan,
2746 hash_map::Entry::Vacant(_) => return,
2748 if !channel.get().is_awaiting_monitor_update() || channel.get().get_latest_monitor_update_id() != highest_applied_update_id {
2752 let (raa, commitment_update, order, pending_forwards, pending_failures, funding_broadcastable, funding_locked) = channel.get_mut().monitor_updating_restored(&self.logger);
2753 (pending_failures, handle_chan_restoration_locked!(self, channel_lock, channel_state, channel, raa, commitment_update, order, None, pending_forwards, funding_broadcastable, funding_locked))
2755 post_handle_chan_restoration!(self, chan_restoration_res);
2756 for failure in pending_failures.drain(..) {
2757 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), failure.0, &failure.1, failure.2);
2761 fn internal_open_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::OpenChannel) -> Result<(), MsgHandleErrInternal> {
2762 if msg.chain_hash != self.genesis_hash {
2763 return Err(MsgHandleErrInternal::send_err_msg_no_close("Unknown genesis block hash".to_owned(), msg.temporary_channel_id.clone()));
2766 let channel = Channel::new_from_req(&self.fee_estimator, &self.keys_manager, counterparty_node_id.clone(), their_features, msg, 0, &self.default_configuration)
2767 .map_err(|e| MsgHandleErrInternal::from_chan_no_close(e, msg.temporary_channel_id))?;
2768 let mut channel_state_lock = self.channel_state.lock().unwrap();
2769 let channel_state = &mut *channel_state_lock;
2770 match channel_state.by_id.entry(channel.channel_id()) {
2771 hash_map::Entry::Occupied(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("temporary_channel_id collision!".to_owned(), msg.temporary_channel_id.clone())),
2772 hash_map::Entry::Vacant(entry) => {
2773 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
2774 node_id: counterparty_node_id.clone(),
2775 msg: channel.get_accept_channel(),
2777 entry.insert(channel);
2783 fn internal_accept_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::AcceptChannel) -> Result<(), MsgHandleErrInternal> {
2784 let (value, output_script, user_id) = {
2785 let mut channel_lock = self.channel_state.lock().unwrap();
2786 let channel_state = &mut *channel_lock;
2787 match channel_state.by_id.entry(msg.temporary_channel_id) {
2788 hash_map::Entry::Occupied(mut chan) => {
2789 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
2790 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.temporary_channel_id));
2792 try_chan_entry!(self, chan.get_mut().accept_channel(&msg, &self.default_configuration, their_features), channel_state, chan);
2793 (chan.get().get_value_satoshis(), chan.get().get_funding_redeemscript().to_v0_p2wsh(), chan.get().get_user_id())
2795 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.temporary_channel_id))
2798 let mut pending_events = self.pending_events.lock().unwrap();
2799 pending_events.push(events::Event::FundingGenerationReady {
2800 temporary_channel_id: msg.temporary_channel_id,
2801 channel_value_satoshis: value,
2803 user_channel_id: user_id,
2808 fn internal_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), MsgHandleErrInternal> {
2809 let ((funding_msg, monitor), mut chan) = {
2810 let best_block = *self.best_block.read().unwrap();
2811 let mut channel_lock = self.channel_state.lock().unwrap();
2812 let channel_state = &mut *channel_lock;
2813 match channel_state.by_id.entry(msg.temporary_channel_id.clone()) {
2814 hash_map::Entry::Occupied(mut chan) => {
2815 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
2816 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.temporary_channel_id));
2818 (try_chan_entry!(self, chan.get_mut().funding_created(msg, best_block, &self.logger), channel_state, chan), chan.remove())
2820 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.temporary_channel_id))
2823 // Because we have exclusive ownership of the channel here we can release the channel_state
2824 // lock before watch_channel
2825 if let Err(e) = self.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor) {
2827 ChannelMonitorUpdateErr::PermanentFailure => {
2828 // Note that we reply with the new channel_id in error messages if we gave up on the
2829 // channel, not the temporary_channel_id. This is compatible with ourselves, but the
2830 // spec is somewhat ambiguous here. Not a huge deal since we'll send error messages for
2831 // any messages referencing a previously-closed channel anyway.
2832 // We do not do a force-close here as that would generate a monitor update for
2833 // a monitor that we didn't manage to store (and that we don't care about - we
2834 // don't respond with the funding_signed so the channel can never go on chain).
2835 let (_monitor_update, failed_htlcs) = chan.force_shutdown(true);
2836 assert!(failed_htlcs.is_empty());
2837 return Err(MsgHandleErrInternal::send_err_msg_no_close("ChannelMonitor storage failure".to_owned(), funding_msg.channel_id));
2839 ChannelMonitorUpdateErr::TemporaryFailure => {
2840 // There's no problem signing a counterparty's funding transaction if our monitor
2841 // hasn't persisted to disk yet - we can't lose money on a transaction that we haven't
2842 // accepted payment from yet. We do, however, need to wait to send our funding_locked
2843 // until we have persisted our monitor.
2844 chan.monitor_update_failed(false, false, Vec::new(), Vec::new());
2848 let mut channel_state_lock = self.channel_state.lock().unwrap();
2849 let channel_state = &mut *channel_state_lock;
2850 match channel_state.by_id.entry(funding_msg.channel_id) {
2851 hash_map::Entry::Occupied(_) => {
2852 return Err(MsgHandleErrInternal::send_err_msg_no_close("Already had channel with the new channel_id".to_owned(), funding_msg.channel_id))
2854 hash_map::Entry::Vacant(e) => {
2855 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
2856 node_id: counterparty_node_id.clone(),
2865 fn internal_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), MsgHandleErrInternal> {
2867 let best_block = *self.best_block.read().unwrap();
2868 let mut channel_lock = self.channel_state.lock().unwrap();
2869 let channel_state = &mut *channel_lock;
2870 match channel_state.by_id.entry(msg.channel_id) {
2871 hash_map::Entry::Occupied(mut chan) => {
2872 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
2873 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
2875 let (monitor, funding_tx) = match chan.get_mut().funding_signed(&msg, best_block, &self.logger) {
2876 Ok(update) => update,
2877 Err(e) => try_chan_entry!(self, Err(e), channel_state, chan),
2879 if let Err(e) = self.chain_monitor.watch_channel(chan.get().get_funding_txo().unwrap(), monitor) {
2880 return_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::RevokeAndACKFirst, false, false);
2884 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
2887 log_info!(self.logger, "Broadcasting funding transaction with txid {}", funding_tx.txid());
2888 self.tx_broadcaster.broadcast_transaction(&funding_tx);
2892 fn internal_funding_locked(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingLocked) -> Result<(), MsgHandleErrInternal> {
2893 let mut channel_state_lock = self.channel_state.lock().unwrap();
2894 let channel_state = &mut *channel_state_lock;
2895 match channel_state.by_id.entry(msg.channel_id) {
2896 hash_map::Entry::Occupied(mut chan) => {
2897 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
2898 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
2900 try_chan_entry!(self, chan.get_mut().funding_locked(&msg), channel_state, chan);
2901 if let Some(announcement_sigs) = self.get_announcement_sigs(chan.get()) {
2902 log_trace!(self.logger, "Sending announcement_signatures for {} in response to funding_locked", log_bytes!(chan.get().channel_id()));
2903 // If we see locking block before receiving remote funding_locked, we broadcast our
2904 // announcement_sigs at remote funding_locked reception. If we receive remote
2905 // funding_locked before seeing locking block, we broadcast our announcement_sigs at locking
2906 // block connection. We should guanrantee to broadcast announcement_sigs to our peer whatever
2907 // the order of the events but our peer may not receive it due to disconnection. The specs
2908 // lacking an acknowledgement for announcement_sigs we may have to re-send them at peer
2909 // connection in the future if simultaneous misses by both peers due to network/hardware
2910 // failures is an issue. Note, to achieve its goal, only one of the announcement_sigs needs
2911 // to be received, from then sigs are going to be flood to the whole network.
2912 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
2913 node_id: counterparty_node_id.clone(),
2914 msg: announcement_sigs,
2919 hash_map::Entry::Vacant(_) => Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
2923 fn internal_shutdown(&self, counterparty_node_id: &PublicKey, their_features: &InitFeatures, msg: &msgs::Shutdown) -> Result<(), MsgHandleErrInternal> {
2924 let (mut dropped_htlcs, chan_option) = {
2925 let mut channel_state_lock = self.channel_state.lock().unwrap();
2926 let channel_state = &mut *channel_state_lock;
2928 match channel_state.by_id.entry(msg.channel_id.clone()) {
2929 hash_map::Entry::Occupied(mut chan_entry) => {
2930 if chan_entry.get().get_counterparty_node_id() != *counterparty_node_id {
2931 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
2933 let (shutdown, closing_signed, dropped_htlcs) = try_chan_entry!(self, chan_entry.get_mut().shutdown(&self.fee_estimator, &their_features, &msg), channel_state, chan_entry);
2934 if let Some(msg) = shutdown {
2935 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
2936 node_id: counterparty_node_id.clone(),
2940 if let Some(msg) = closing_signed {
2941 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
2942 node_id: counterparty_node_id.clone(),
2946 if chan_entry.get().is_shutdown() {
2947 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
2948 channel_state.short_to_id.remove(&short_id);
2950 (dropped_htlcs, Some(chan_entry.remove_entry().1))
2951 } else { (dropped_htlcs, None) }
2953 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
2956 for htlc_source in dropped_htlcs.drain(..) {
2957 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() });
2959 if let Some(chan) = chan_option {
2960 if let Ok(update) = self.get_channel_update(&chan) {
2961 let mut channel_state = self.channel_state.lock().unwrap();
2962 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2970 fn internal_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<(), MsgHandleErrInternal> {
2971 let (tx, chan_option) = {
2972 let mut channel_state_lock = self.channel_state.lock().unwrap();
2973 let channel_state = &mut *channel_state_lock;
2974 match channel_state.by_id.entry(msg.channel_id.clone()) {
2975 hash_map::Entry::Occupied(mut chan_entry) => {
2976 if chan_entry.get().get_counterparty_node_id() != *counterparty_node_id {
2977 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
2979 let (closing_signed, tx) = try_chan_entry!(self, chan_entry.get_mut().closing_signed(&self.fee_estimator, &msg), channel_state, chan_entry);
2980 if let Some(msg) = closing_signed {
2981 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
2982 node_id: counterparty_node_id.clone(),
2987 // We're done with this channel, we've got a signed closing transaction and
2988 // will send the closing_signed back to the remote peer upon return. This
2989 // also implies there are no pending HTLCs left on the channel, so we can
2990 // fully delete it from tracking (the channel monitor is still around to
2991 // watch for old state broadcasts)!
2992 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
2993 channel_state.short_to_id.remove(&short_id);
2995 (tx, Some(chan_entry.remove_entry().1))
2996 } else { (tx, None) }
2998 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3001 if let Some(broadcast_tx) = tx {
3002 log_info!(self.logger, "Broadcasting {}", log_tx!(broadcast_tx));
3003 self.tx_broadcaster.broadcast_transaction(&broadcast_tx);
3005 if let Some(chan) = chan_option {
3006 if let Ok(update) = self.get_channel_update(&chan) {
3007 let mut channel_state = self.channel_state.lock().unwrap();
3008 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
3016 fn internal_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), MsgHandleErrInternal> {
3017 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
3018 //determine the state of the payment based on our response/if we forward anything/the time
3019 //we take to respond. We should take care to avoid allowing such an attack.
3021 //TODO: There exists a further attack where a node may garble the onion data, forward it to
3022 //us repeatedly garbled in different ways, and compare our error messages, which are
3023 //encrypted with the same key. It's not immediately obvious how to usefully exploit that,
3024 //but we should prevent it anyway.
3026 let (pending_forward_info, mut channel_state_lock) = self.decode_update_add_htlc_onion(msg);
3027 let channel_state = &mut *channel_state_lock;
3029 match channel_state.by_id.entry(msg.channel_id) {
3030 hash_map::Entry::Occupied(mut chan) => {
3031 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3032 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3035 let create_pending_htlc_status = |chan: &Channel<Signer>, pending_forward_info: PendingHTLCStatus, error_code: u16| {
3036 // Ensure error_code has the UPDATE flag set, since by default we send a
3037 // channel update along as part of failing the HTLC.
3038 assert!((error_code & 0x1000) != 0);
3039 // If the update_add is completely bogus, the call will Err and we will close,
3040 // but if we've sent a shutdown and they haven't acknowledged it yet, we just
3041 // want to reject the new HTLC and fail it backwards instead of forwarding.
3042 match pending_forward_info {
3043 PendingHTLCStatus::Forward(PendingHTLCInfo { ref incoming_shared_secret, .. }) => {
3044 let reason = if let Ok(upd) = self.get_channel_update(chan) {
3045 onion_utils::build_first_hop_failure_packet(incoming_shared_secret, error_code, &{
3046 let mut res = Vec::with_capacity(8 + 128);
3047 // TODO: underspecified, follow https://github.com/lightningnetwork/lightning-rfc/issues/791
3048 res.extend_from_slice(&byte_utils::be16_to_array(0));
3049 res.extend_from_slice(&upd.encode_with_len()[..]);
3053 // The only case where we'd be unable to
3054 // successfully get a channel update is if the
3055 // channel isn't in the fully-funded state yet,
3056 // implying our counterparty is trying to route
3057 // payments over the channel back to themselves
3058 // (cause no one else should know the short_id
3059 // is a lightning channel yet). We should have
3060 // no problem just calling this
3061 // unknown_next_peer (0x4000|10).
3062 onion_utils::build_first_hop_failure_packet(incoming_shared_secret, 0x4000|10, &[])
3064 let msg = msgs::UpdateFailHTLC {
3065 channel_id: msg.channel_id,
3066 htlc_id: msg.htlc_id,
3069 PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msg))
3071 _ => pending_forward_info
3074 try_chan_entry!(self, chan.get_mut().update_add_htlc(&msg, pending_forward_info, create_pending_htlc_status, &self.logger), channel_state, chan);
3076 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3081 fn internal_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), MsgHandleErrInternal> {
3082 let mut channel_lock = self.channel_state.lock().unwrap();
3084 let channel_state = &mut *channel_lock;
3085 match channel_state.by_id.entry(msg.channel_id) {
3086 hash_map::Entry::Occupied(mut chan) => {
3087 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3088 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3090 try_chan_entry!(self, chan.get_mut().update_fulfill_htlc(&msg), channel_state, chan)
3092 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3095 self.claim_funds_internal(channel_lock, htlc_source, msg.payment_preimage.clone());
3099 fn internal_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), MsgHandleErrInternal> {
3100 let mut channel_lock = self.channel_state.lock().unwrap();
3101 let channel_state = &mut *channel_lock;
3102 match channel_state.by_id.entry(msg.channel_id) {
3103 hash_map::Entry::Occupied(mut chan) => {
3104 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3105 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3107 try_chan_entry!(self, chan.get_mut().update_fail_htlc(&msg, HTLCFailReason::LightningError { err: msg.reason.clone() }), channel_state, chan);
3109 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3114 fn internal_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), MsgHandleErrInternal> {
3115 let mut channel_lock = self.channel_state.lock().unwrap();
3116 let channel_state = &mut *channel_lock;
3117 match channel_state.by_id.entry(msg.channel_id) {
3118 hash_map::Entry::Occupied(mut chan) => {
3119 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3120 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3122 if (msg.failure_code & 0x8000) == 0 {
3123 let chan_err: ChannelError = ChannelError::Close("Got update_fail_malformed_htlc with BADONION not set".to_owned());
3124 try_chan_entry!(self, Err(chan_err), channel_state, chan);
3126 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);
3129 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3133 fn internal_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), MsgHandleErrInternal> {
3134 let mut channel_state_lock = self.channel_state.lock().unwrap();
3135 let channel_state = &mut *channel_state_lock;
3136 match channel_state.by_id.entry(msg.channel_id) {
3137 hash_map::Entry::Occupied(mut chan) => {
3138 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3139 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3141 let (revoke_and_ack, commitment_signed, closing_signed, monitor_update) =
3142 match chan.get_mut().commitment_signed(&msg, &self.fee_estimator, &self.logger) {
3143 Err((None, e)) => try_chan_entry!(self, Err(e), channel_state, chan),
3144 Err((Some(update), e)) => {
3145 assert!(chan.get().is_awaiting_monitor_update());
3146 let _ = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), update);
3147 try_chan_entry!(self, Err(e), channel_state, chan);
3152 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
3153 return_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::RevokeAndACKFirst, true, commitment_signed.is_some());
3154 //TODO: Rebroadcast closing_signed if present on monitor update restoration
3156 channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
3157 node_id: counterparty_node_id.clone(),
3158 msg: revoke_and_ack,
3160 if let Some(msg) = commitment_signed {
3161 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
3162 node_id: counterparty_node_id.clone(),
3163 updates: msgs::CommitmentUpdate {
3164 update_add_htlcs: Vec::new(),
3165 update_fulfill_htlcs: Vec::new(),
3166 update_fail_htlcs: Vec::new(),
3167 update_fail_malformed_htlcs: Vec::new(),
3169 commitment_signed: msg,
3173 if let Some(msg) = closing_signed {
3174 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
3175 node_id: counterparty_node_id.clone(),
3181 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3186 fn forward_htlcs(&self, per_source_pending_forwards: &mut [(u64, OutPoint, Vec<(PendingHTLCInfo, u64)>)]) {
3187 for &mut (prev_short_channel_id, prev_funding_outpoint, ref mut pending_forwards) in per_source_pending_forwards {
3188 let mut forward_event = None;
3189 if !pending_forwards.is_empty() {
3190 let mut channel_state = self.channel_state.lock().unwrap();
3191 if channel_state.forward_htlcs.is_empty() {
3192 forward_event = Some(Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS))
3194 for (forward_info, prev_htlc_id) in pending_forwards.drain(..) {
3195 match channel_state.forward_htlcs.entry(match forward_info.routing {
3196 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
3197 PendingHTLCRouting::Receive { .. } => 0,
3199 hash_map::Entry::Occupied(mut entry) => {
3200 entry.get_mut().push(HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_funding_outpoint,
3201 prev_htlc_id, forward_info });
3203 hash_map::Entry::Vacant(entry) => {
3204 entry.insert(vec!(HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_funding_outpoint,
3205 prev_htlc_id, forward_info }));
3210 match forward_event {
3212 let mut pending_events = self.pending_events.lock().unwrap();
3213 pending_events.push(events::Event::PendingHTLCsForwardable {
3214 time_forwardable: time
3222 fn internal_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), MsgHandleErrInternal> {
3223 let mut htlcs_to_fail = Vec::new();
3225 let mut channel_state_lock = self.channel_state.lock().unwrap();
3226 let channel_state = &mut *channel_state_lock;
3227 match channel_state.by_id.entry(msg.channel_id) {
3228 hash_map::Entry::Occupied(mut chan) => {
3229 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3230 break Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3232 let was_frozen_for_monitor = chan.get().is_awaiting_monitor_update();
3233 let (commitment_update, pending_forwards, pending_failures, closing_signed, monitor_update, htlcs_to_fail_in) =
3234 break_chan_entry!(self, chan.get_mut().revoke_and_ack(&msg, &self.fee_estimator, &self.logger), channel_state, chan);
3235 htlcs_to_fail = htlcs_to_fail_in;
3236 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
3237 if was_frozen_for_monitor {
3238 assert!(commitment_update.is_none() && closing_signed.is_none() && pending_forwards.is_empty() && pending_failures.is_empty());
3239 break Err(MsgHandleErrInternal::ignore_no_close("Previous monitor update failure prevented responses to RAA".to_owned()));
3241 if let Err(e) = handle_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, commitment_update.is_some(), pending_forwards, pending_failures) {
3243 } else { unreachable!(); }
3246 if let Some(updates) = commitment_update {
3247 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
3248 node_id: counterparty_node_id.clone(),
3252 if let Some(msg) = closing_signed {
3253 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
3254 node_id: counterparty_node_id.clone(),
3258 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()))
3260 hash_map::Entry::Vacant(_) => break Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3263 self.fail_holding_cell_htlcs(htlcs_to_fail, msg.channel_id);
3265 Ok((pending_forwards, mut pending_failures, short_channel_id, channel_outpoint)) => {
3266 for failure in pending_failures.drain(..) {
3267 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), failure.0, &failure.1, failure.2);
3269 self.forward_htlcs(&mut [(short_channel_id, channel_outpoint, pending_forwards)]);
3276 fn internal_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), MsgHandleErrInternal> {
3277 let mut channel_lock = self.channel_state.lock().unwrap();
3278 let channel_state = &mut *channel_lock;
3279 match channel_state.by_id.entry(msg.channel_id) {
3280 hash_map::Entry::Occupied(mut chan) => {
3281 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3282 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3284 try_chan_entry!(self, chan.get_mut().update_fee(&self.fee_estimator, &msg), channel_state, chan);
3286 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3291 fn internal_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), MsgHandleErrInternal> {
3292 let mut channel_state_lock = self.channel_state.lock().unwrap();
3293 let channel_state = &mut *channel_state_lock;
3295 match channel_state.by_id.entry(msg.channel_id) {
3296 hash_map::Entry::Occupied(mut chan) => {
3297 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3298 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3300 if !chan.get().is_usable() {
3301 return Err(MsgHandleErrInternal::from_no_close(LightningError{err: "Got an announcement_signatures before we were ready for it".to_owned(), action: msgs::ErrorAction::IgnoreError}));
3304 let our_node_id = self.get_our_node_id();
3305 let (announcement, our_bitcoin_sig) =
3306 try_chan_entry!(self, chan.get_mut().get_channel_announcement(our_node_id.clone(), self.genesis_hash.clone()), channel_state, chan);
3308 let were_node_one = announcement.node_id_1 == our_node_id;
3309 let msghash = hash_to_message!(&Sha256dHash::hash(&announcement.encode()[..])[..]);
3311 let their_node_key = if were_node_one { &announcement.node_id_2 } else { &announcement.node_id_1 };
3312 let their_bitcoin_key = if were_node_one { &announcement.bitcoin_key_2 } else { &announcement.bitcoin_key_1 };
3313 match (self.secp_ctx.verify(&msghash, &msg.node_signature, their_node_key),
3314 self.secp_ctx.verify(&msghash, &msg.bitcoin_signature, their_bitcoin_key)) {
3316 let chan_err: ChannelError = ChannelError::Close(format!("Bad announcement_signatures. Failed to verify node_signature: {:?}. Maybe using different node_secret for transport and routing msg? UnsignedChannelAnnouncement used for verification is {:?}. their_node_key is {:?}", e, &announcement, their_node_key));
3317 try_chan_entry!(self, Err(chan_err), channel_state, chan);
3320 let chan_err: ChannelError = ChannelError::Close(format!("Bad announcement_signatures. Failed to verify bitcoin_signature: {:?}. UnsignedChannelAnnouncement used for verification is {:?}. their_bitcoin_key is ({:?})", e, &announcement, their_bitcoin_key));
3321 try_chan_entry!(self, Err(chan_err), channel_state, chan);
3327 let our_node_sig = self.secp_ctx.sign(&msghash, &self.our_network_key);
3329 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
3330 msg: msgs::ChannelAnnouncement {
3331 node_signature_1: if were_node_one { our_node_sig } else { msg.node_signature },
3332 node_signature_2: if were_node_one { msg.node_signature } else { our_node_sig },
3333 bitcoin_signature_1: if were_node_one { our_bitcoin_sig } else { msg.bitcoin_signature },
3334 bitcoin_signature_2: if were_node_one { msg.bitcoin_signature } else { our_bitcoin_sig },
3335 contents: announcement,
3337 update_msg: self.get_channel_update(chan.get()).unwrap(), // can only fail if we're not in a ready state
3340 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3345 fn internal_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) -> Result<(), MsgHandleErrInternal> {
3346 let mut channel_state_lock = self.channel_state.lock().unwrap();
3347 let channel_state = &mut *channel_state_lock;
3348 let chan_id = match channel_state.short_to_id.get(&msg.contents.short_channel_id) {
3349 Some(chan_id) => chan_id.clone(),
3351 // It's not a local channel
3355 match channel_state.by_id.entry(chan_id) {
3356 hash_map::Entry::Occupied(mut chan) => {
3357 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3358 // TODO: see issue #153, need a consistent behavior on obnoxious behavior from random node
3359 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), chan_id));
3361 try_chan_entry!(self, chan.get_mut().channel_update(&msg), channel_state, chan);
3363 hash_map::Entry::Vacant(_) => unreachable!()
3368 fn internal_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<(), MsgHandleErrInternal> {
3369 let (htlcs_failed_forward, chan_restoration_res) = {
3370 let mut channel_state_lock = self.channel_state.lock().unwrap();
3371 let channel_state = &mut *channel_state_lock;
3373 match channel_state.by_id.entry(msg.channel_id) {
3374 hash_map::Entry::Occupied(mut chan) => {
3375 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3376 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3378 // Currently, we expect all holding cell update_adds to be dropped on peer
3379 // disconnect, so Channel's reestablish will never hand us any holding cell
3380 // freed HTLCs to fail backwards. If in the future we no longer drop pending
3381 // add-HTLCs on disconnect, we may be handed HTLCs to fail backwards here.
3382 let (funding_locked, revoke_and_ack, commitment_update, monitor_update_opt, order, htlcs_failed_forward, shutdown) =
3383 try_chan_entry!(self, chan.get_mut().channel_reestablish(msg, &self.logger), channel_state, chan);
3384 if let Some(msg) = shutdown {
3385 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
3386 node_id: counterparty_node_id.clone(),
3390 (htlcs_failed_forward, 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))
3392 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3395 post_handle_chan_restoration!(self, chan_restoration_res);
3396 self.fail_holding_cell_htlcs(htlcs_failed_forward, msg.channel_id);
3400 /// Begin Update fee process. Allowed only on an outbound channel.
3401 /// If successful, will generate a UpdateHTLCs event, so you should probably poll
3402 /// PeerManager::process_events afterwards.
3403 /// Note: This API is likely to change!
3404 /// (C-not exported) Cause its doc(hidden) anyway
3406 pub fn update_fee(&self, channel_id: [u8;32], feerate_per_kw: u32) -> Result<(), APIError> {
3407 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
3408 let counterparty_node_id;
3409 let err: Result<(), _> = loop {
3410 let mut channel_state_lock = self.channel_state.lock().unwrap();
3411 let channel_state = &mut *channel_state_lock;
3413 match channel_state.by_id.entry(channel_id) {
3414 hash_map::Entry::Vacant(_) => return Err(APIError::APIMisuseError{err: format!("Failed to find corresponding channel for id {}", channel_id.to_hex())}),
3415 hash_map::Entry::Occupied(mut chan) => {
3416 if !chan.get().is_outbound() {
3417 return Err(APIError::APIMisuseError{err: "update_fee cannot be sent for an inbound channel".to_owned()});
3419 if chan.get().is_awaiting_monitor_update() {
3420 return Err(APIError::MonitorUpdateFailed);
3422 if !chan.get().is_live() {
3423 return Err(APIError::ChannelUnavailable{err: "Channel is either not yet fully established or peer is currently disconnected".to_owned()});
3425 counterparty_node_id = chan.get().get_counterparty_node_id();
3426 if let Some((update_fee, commitment_signed, monitor_update)) =
3427 break_chan_entry!(self, chan.get_mut().send_update_fee_and_commit(feerate_per_kw, &self.logger), channel_state, chan)
3429 if let Err(_e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
3432 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
3433 node_id: chan.get().get_counterparty_node_id(),
3434 updates: msgs::CommitmentUpdate {
3435 update_add_htlcs: Vec::new(),
3436 update_fulfill_htlcs: Vec::new(),
3437 update_fail_htlcs: Vec::new(),
3438 update_fail_malformed_htlcs: Vec::new(),
3439 update_fee: Some(update_fee),
3449 match handle_error!(self, err, counterparty_node_id) {
3450 Ok(_) => unreachable!(),
3451 Err(e) => { Err(APIError::APIMisuseError { err: e.err })}
3455 /// Process pending events from the `chain::Watch`, returning whether any events were processed.
3456 fn process_pending_monitor_events(&self) -> bool {
3457 let mut failed_channels = Vec::new();
3458 let pending_monitor_events = self.chain_monitor.release_pending_monitor_events();
3459 let has_pending_monitor_events = !pending_monitor_events.is_empty();
3460 for monitor_event in pending_monitor_events {
3461 match monitor_event {
3462 MonitorEvent::HTLCEvent(htlc_update) => {
3463 if let Some(preimage) = htlc_update.payment_preimage {
3464 log_trace!(self.logger, "Claiming HTLC with preimage {} from our monitor", log_bytes!(preimage.0));
3465 self.claim_funds_internal(self.channel_state.lock().unwrap(), htlc_update.source, preimage);
3467 log_trace!(self.logger, "Failing HTLC with hash {} from our monitor", log_bytes!(htlc_update.payment_hash.0));
3468 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() });
3471 MonitorEvent::CommitmentTxBroadcasted(funding_outpoint) => {
3472 let mut channel_lock = self.channel_state.lock().unwrap();
3473 let channel_state = &mut *channel_lock;
3474 let by_id = &mut channel_state.by_id;
3475 let short_to_id = &mut channel_state.short_to_id;
3476 let pending_msg_events = &mut channel_state.pending_msg_events;
3477 if let Some(mut chan) = by_id.remove(&funding_outpoint.to_channel_id()) {
3478 if let Some(short_id) = chan.get_short_channel_id() {
3479 short_to_id.remove(&short_id);
3481 failed_channels.push(chan.force_shutdown(false));
3482 if let Ok(update) = self.get_channel_update(&chan) {
3483 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
3487 pending_msg_events.push(events::MessageSendEvent::HandleError {
3488 node_id: chan.get_counterparty_node_id(),
3489 action: msgs::ErrorAction::SendErrorMessage {
3490 msg: msgs::ErrorMessage { channel_id: chan.channel_id(), data: "Channel force-closed".to_owned() }
3498 for failure in failed_channels.drain(..) {
3499 self.finish_force_close_channel(failure);
3502 has_pending_monitor_events
3505 /// Check the holding cell in each channel and free any pending HTLCs in them if possible.
3506 /// Returns whether there were any updates such as if pending HTLCs were freed or a monitor
3507 /// update was applied.
3509 /// This should only apply to HTLCs which were added to the holding cell because we were
3510 /// waiting on a monitor update to finish. In that case, we don't want to free the holding cell
3511 /// directly in `channel_monitor_updated` as it may introduce deadlocks calling back into user
3512 /// code to inform them of a channel monitor update.
3513 fn check_free_holding_cells(&self) -> bool {
3514 let mut has_monitor_update = false;
3515 let mut failed_htlcs = Vec::new();
3516 let mut handle_errors = Vec::new();
3518 let mut channel_state_lock = self.channel_state.lock().unwrap();
3519 let channel_state = &mut *channel_state_lock;
3520 let by_id = &mut channel_state.by_id;
3521 let short_to_id = &mut channel_state.short_to_id;
3522 let pending_msg_events = &mut channel_state.pending_msg_events;
3524 by_id.retain(|channel_id, chan| {
3525 match chan.maybe_free_holding_cell_htlcs(&self.logger) {
3526 Ok((commitment_opt, holding_cell_failed_htlcs)) => {
3527 if !holding_cell_failed_htlcs.is_empty() {
3528 failed_htlcs.push((holding_cell_failed_htlcs, *channel_id));
3530 if let Some((commitment_update, monitor_update)) = commitment_opt {
3531 if let Err(e) = self.chain_monitor.update_channel(chan.get_funding_txo().unwrap(), monitor_update) {
3532 has_monitor_update = true;
3533 let (res, close_channel) = handle_monitor_err!(self, e, short_to_id, chan, RAACommitmentOrder::CommitmentFirst, false, true, Vec::new(), Vec::new(), channel_id);
3534 handle_errors.push((chan.get_counterparty_node_id(), res));
3535 if close_channel { return false; }
3537 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
3538 node_id: chan.get_counterparty_node_id(),
3539 updates: commitment_update,
3546 let (close_channel, res) = convert_chan_err!(self, e, short_to_id, chan, channel_id);
3547 handle_errors.push((chan.get_counterparty_node_id(), Err(res)));
3554 let has_update = has_monitor_update || !failed_htlcs.is_empty();
3555 for (failures, channel_id) in failed_htlcs.drain(..) {
3556 self.fail_holding_cell_htlcs(failures, channel_id);
3559 for (counterparty_node_id, err) in handle_errors.drain(..) {
3560 let _ = handle_error!(self, err, counterparty_node_id);
3566 /// Handle a list of channel failures during a block_connected or block_disconnected call,
3567 /// pushing the channel monitor update (if any) to the background events queue and removing the
3569 fn handle_init_event_channel_failures(&self, mut failed_channels: Vec<ShutdownResult>) {
3570 for mut failure in failed_channels.drain(..) {
3571 // Either a commitment transactions has been confirmed on-chain or
3572 // Channel::block_disconnected detected that the funding transaction has been
3573 // reorganized out of the main chain.
3574 // We cannot broadcast our latest local state via monitor update (as
3575 // Channel::force_shutdown tries to make us do) as we may still be in initialization,
3576 // so we track the update internally and handle it when the user next calls
3577 // timer_tick_occurred, guaranteeing we're running normally.
3578 if let Some((funding_txo, update)) = failure.0.take() {
3579 assert_eq!(update.updates.len(), 1);
3580 if let ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } = update.updates[0] {
3581 assert!(should_broadcast);
3582 } else { unreachable!(); }
3583 self.pending_background_events.lock().unwrap().push(BackgroundEvent::ClosingMonitorUpdate((funding_txo, update)));
3585 self.finish_force_close_channel(failure);
3589 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> {
3590 assert!(invoice_expiry_delta_secs <= 60*60*24*365); // Sadly bitcoin timestamps are u32s, so panic before 2106
3592 let payment_secret = PaymentSecret(self.keys_manager.get_secure_random_bytes());
3594 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
3595 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
3596 match payment_secrets.entry(payment_hash) {
3597 hash_map::Entry::Vacant(e) => {
3598 e.insert(PendingInboundPayment {
3599 payment_secret, min_value_msat, user_payment_id, payment_preimage,
3600 // We assume that highest_seen_timestamp is pretty close to the current time -
3601 // its updated when we receive a new block with the maximum time we've seen in
3602 // a header. It should never be more than two hours in the future.
3603 // Thus, we add two hours here as a buffer to ensure we absolutely
3604 // never fail a payment too early.
3605 // Note that we assume that received blocks have reasonably up-to-date
3607 expiry_time: self.highest_seen_timestamp.load(Ordering::Acquire) as u64 + invoice_expiry_delta_secs as u64 + 7200,
3610 hash_map::Entry::Occupied(_) => return Err(APIError::APIMisuseError { err: "Duplicate payment hash".to_owned() }),
3615 /// Gets a payment secret and payment hash for use in an invoice given to a third party wishing
3618 /// This differs from [`create_inbound_payment_for_hash`] only in that it generates the
3619 /// [`PaymentHash`] and [`PaymentPreimage`] for you, returning the first and storing the second.
3621 /// The [`PaymentPreimage`] will ultimately be returned to you in the [`PaymentReceived`], which
3622 /// will have the [`PaymentReceived::payment_preimage`] field filled in. That should then be
3623 /// passed directly to [`claim_funds`].
3625 /// See [`create_inbound_payment_for_hash`] for detailed documentation on behavior and requirements.
3627 /// [`claim_funds`]: Self::claim_funds
3628 /// [`PaymentReceived`]: events::Event::PaymentReceived
3629 /// [`PaymentReceived::payment_preimage`]: events::Event::PaymentReceived::payment_preimage
3630 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
3631 pub fn create_inbound_payment(&self, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32, user_payment_id: u64) -> (PaymentHash, PaymentSecret) {
3632 let payment_preimage = PaymentPreimage(self.keys_manager.get_secure_random_bytes());
3633 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
3636 self.set_payment_hash_secret_map(payment_hash, Some(payment_preimage), min_value_msat, invoice_expiry_delta_secs, user_payment_id)
3637 .expect("RNG Generated Duplicate PaymentHash"))
3640 /// Gets a [`PaymentSecret`] for a given [`PaymentHash`], for which the payment preimage is
3641 /// stored external to LDK.
3643 /// A [`PaymentReceived`] event will only be generated if the [`PaymentSecret`] matches a
3644 /// payment secret fetched via this method or [`create_inbound_payment`], and which is at least
3645 /// the `min_value_msat` provided here, if one is provided.
3647 /// The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) must be globally unique. This
3648 /// method may return an Err if another payment with the same payment_hash is still pending.
3650 /// `user_payment_id` will be provided back in [`PaymentReceived::user_payment_id`] events to
3651 /// allow tracking of which events correspond with which calls to this and
3652 /// [`create_inbound_payment`]. `user_payment_id` has no meaning inside of LDK, it is simply
3653 /// copied to events and otherwise ignored. It may be used to correlate PaymentReceived events
3654 /// with invoice metadata stored elsewhere.
3656 /// `min_value_msat` should be set if the invoice being generated contains a value. Any payment
3657 /// received for the returned [`PaymentHash`] will be required to be at least `min_value_msat`
3658 /// before a [`PaymentReceived`] event will be generated, ensuring that we do not provide the
3659 /// sender "proof-of-payment" unless they have paid the required amount.
3661 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
3662 /// in excess of the current time. This should roughly match the expiry time set in the invoice.
3663 /// After this many seconds, we will remove the inbound payment, resulting in any attempts to
3664 /// pay the invoice failing. The BOLT spec suggests 3,600 secs as a default validity time for
3665 /// invoices when no timeout is set.
3667 /// Note that we use block header time to time-out pending inbound payments (with some margin
3668 /// to compensate for the inaccuracy of block header timestamps). Thus, in practice we will
3669 /// accept a payment and generate a [`PaymentReceived`] event for some time after the expiry.
3670 /// If you need exact expiry semantics, you should enforce them upon receipt of
3671 /// [`PaymentReceived`].
3673 /// Pending inbound payments are stored in memory and in serialized versions of this
3674 /// [`ChannelManager`]. If potentially unbounded numbers of inbound payments may exist and
3675 /// space is limited, you may wish to rate-limit inbound payment creation.
3677 /// May panic if `invoice_expiry_delta_secs` is greater than one year.
3679 /// Note that invoices generated for inbound payments should have their `min_final_cltv_expiry`
3680 /// set to at least [`MIN_FINAL_CLTV_EXPIRY`].
3682 /// [`create_inbound_payment`]: Self::create_inbound_payment
3683 /// [`PaymentReceived`]: events::Event::PaymentReceived
3684 /// [`PaymentReceived::user_payment_id`]: events::Event::PaymentReceived::user_payment_id
3685 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> {
3686 self.set_payment_hash_secret_map(payment_hash, None, min_value_msat, invoice_expiry_delta_secs, user_payment_id)
3689 #[cfg(any(test, feature = "fuzztarget", feature = "_test_utils"))]
3690 pub fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
3691 let events = std::cell::RefCell::new(Vec::new());
3692 let event_handler = |event| events.borrow_mut().push(event);
3693 self.process_pending_events(&event_handler);
3698 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> MessageSendEventsProvider for ChannelManager<Signer, M, T, K, F, L>
3699 where M::Target: chain::Watch<Signer>,
3700 T::Target: BroadcasterInterface,
3701 K::Target: KeysInterface<Signer = Signer>,
3702 F::Target: FeeEstimator,
3705 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
3706 let events = RefCell::new(Vec::new());
3707 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
3708 let mut result = NotifyOption::SkipPersist;
3710 // TODO: This behavior should be documented. It's unintuitive that we query
3711 // ChannelMonitors when clearing other events.
3712 if self.process_pending_monitor_events() {
3713 result = NotifyOption::DoPersist;
3716 if self.check_free_holding_cells() {
3717 result = NotifyOption::DoPersist;
3720 let mut pending_events = Vec::new();
3721 let mut channel_state = self.channel_state.lock().unwrap();
3722 mem::swap(&mut pending_events, &mut channel_state.pending_msg_events);
3724 if !pending_events.is_empty() {
3725 events.replace(pending_events);
3734 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> EventsProvider for ChannelManager<Signer, M, T, K, F, L>
3736 M::Target: chain::Watch<Signer>,
3737 T::Target: BroadcasterInterface,
3738 K::Target: KeysInterface<Signer = Signer>,
3739 F::Target: FeeEstimator,
3742 /// Processes events that must be periodically handled.
3744 /// An [`EventHandler`] may safely call back to the provider in order to handle an event.
3745 /// However, it must not call [`Writeable::write`] as doing so would result in a deadlock.
3747 /// Pending events are persisted as part of [`ChannelManager`]. While these events are cleared
3748 /// when processed, an [`EventHandler`] must be able to handle previously seen events when
3749 /// restarting from an old state.
3750 fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler {
3751 PersistenceNotifierGuard::optionally_notify(&self.total_consistency_lock, &self.persistence_notifier, || {
3752 let mut result = NotifyOption::SkipPersist;
3754 // TODO: This behavior should be documented. It's unintuitive that we query
3755 // ChannelMonitors when clearing other events.
3756 if self.process_pending_monitor_events() {
3757 result = NotifyOption::DoPersist;
3760 let mut pending_events = std::mem::replace(&mut *self.pending_events.lock().unwrap(), vec![]);
3761 if !pending_events.is_empty() {
3762 result = NotifyOption::DoPersist;
3765 for event in pending_events.drain(..) {
3766 handler.handle_event(event);
3774 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> chain::Listen for ChannelManager<Signer, M, T, K, F, L>
3776 M::Target: chain::Watch<Signer>,
3777 T::Target: BroadcasterInterface,
3778 K::Target: KeysInterface<Signer = Signer>,
3779 F::Target: FeeEstimator,
3782 fn block_connected(&self, block: &Block, height: u32) {
3784 let best_block = self.best_block.read().unwrap();
3785 assert_eq!(best_block.block_hash(), block.header.prev_blockhash,
3786 "Blocks must be connected in chain-order - the connected header must build on the last connected header");
3787 assert_eq!(best_block.height(), height - 1,
3788 "Blocks must be connected in chain-order - the connected block height must be one greater than the previous height");
3791 let txdata: Vec<_> = block.txdata.iter().enumerate().collect();
3792 self.transactions_confirmed(&block.header, &txdata, height);
3793 self.best_block_updated(&block.header, height);
3796 fn block_disconnected(&self, header: &BlockHeader, height: u32) {
3797 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
3798 let new_height = height - 1;
3800 let mut best_block = self.best_block.write().unwrap();
3801 assert_eq!(best_block.block_hash(), header.block_hash(),
3802 "Blocks must be disconnected in chain-order - the disconnected header must be the last connected header");
3803 assert_eq!(best_block.height(), height,
3804 "Blocks must be disconnected in chain-order - the disconnected block must have the correct height");
3805 *best_block = BestBlock::new(header.prev_blockhash, new_height)
3808 self.do_chain_event(Some(new_height), |channel| channel.best_block_updated(new_height, header.time));
3812 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> chain::Confirm for ChannelManager<Signer, M, T, K, F, L>
3814 M::Target: chain::Watch<Signer>,
3815 T::Target: BroadcasterInterface,
3816 K::Target: KeysInterface<Signer = Signer>,
3817 F::Target: FeeEstimator,
3820 fn transactions_confirmed(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
3821 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
3822 // during initialization prior to the chain_monitor being fully configured in some cases.
3823 // See the docs for `ChannelManagerReadArgs` for more.
3825 let block_hash = header.block_hash();
3826 log_trace!(self.logger, "{} transactions included in block {} at height {} provided", txdata.len(), block_hash, height);
3828 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
3829 self.do_chain_event(Some(height), |channel| channel.transactions_confirmed(&block_hash, height, txdata, &self.logger).map(|a| (a, Vec::new())));
3832 fn best_block_updated(&self, header: &BlockHeader, height: u32) {
3833 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
3834 // during initialization prior to the chain_monitor being fully configured in some cases.
3835 // See the docs for `ChannelManagerReadArgs` for more.
3837 let block_hash = header.block_hash();
3838 log_trace!(self.logger, "New best block: {} at height {}", block_hash, height);
3840 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
3842 *self.best_block.write().unwrap() = BestBlock::new(block_hash, height);
3844 self.do_chain_event(Some(height), |channel| channel.best_block_updated(height, header.time));
3846 macro_rules! max_time {
3847 ($timestamp: expr) => {
3849 // Update $timestamp to be the max of its current value and the block
3850 // timestamp. This should keep us close to the current time without relying on
3851 // having an explicit local time source.
3852 // Just in case we end up in a race, we loop until we either successfully
3853 // update $timestamp or decide we don't need to.
3854 let old_serial = $timestamp.load(Ordering::Acquire);
3855 if old_serial >= header.time as usize { break; }
3856 if $timestamp.compare_exchange(old_serial, header.time as usize, Ordering::AcqRel, Ordering::Relaxed).is_ok() {
3862 max_time!(self.last_node_announcement_serial);
3863 max_time!(self.highest_seen_timestamp);
3864 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
3865 payment_secrets.retain(|_, inbound_payment| {
3866 inbound_payment.expiry_time > header.time as u64
3870 fn get_relevant_txids(&self) -> Vec<Txid> {
3871 let channel_state = self.channel_state.lock().unwrap();
3872 let mut res = Vec::with_capacity(channel_state.short_to_id.len());
3873 for chan in channel_state.by_id.values() {
3874 if let Some(funding_txo) = chan.get_funding_txo() {
3875 res.push(funding_txo.txid);
3881 fn transaction_unconfirmed(&self, txid: &Txid) {
3882 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
3883 self.do_chain_event(None, |channel| {
3884 if let Some(funding_txo) = channel.get_funding_txo() {
3885 if funding_txo.txid == *txid {
3886 channel.funding_transaction_unconfirmed().map(|_| (None, Vec::new()))
3887 } else { Ok((None, Vec::new())) }
3888 } else { Ok((None, Vec::new())) }
3893 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<Signer, M, T, K, F, L>
3895 M::Target: chain::Watch<Signer>,
3896 T::Target: BroadcasterInterface,
3897 K::Target: KeysInterface<Signer = Signer>,
3898 F::Target: FeeEstimator,
3901 /// Calls a function which handles an on-chain event (blocks dis/connected, transactions
3902 /// un/confirmed, etc) on each channel, handling any resulting errors or messages generated by
3904 fn do_chain_event<FN: Fn(&mut Channel<Signer>) -> Result<(Option<msgs::FundingLocked>, Vec<(HTLCSource, PaymentHash)>), msgs::ErrorMessage>>
3905 (&self, height_opt: Option<u32>, f: FN) {
3906 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
3907 // during initialization prior to the chain_monitor being fully configured in some cases.
3908 // See the docs for `ChannelManagerReadArgs` for more.
3910 let mut failed_channels = Vec::new();
3911 let mut timed_out_htlcs = Vec::new();
3913 let mut channel_lock = self.channel_state.lock().unwrap();
3914 let channel_state = &mut *channel_lock;
3915 let short_to_id = &mut channel_state.short_to_id;
3916 let pending_msg_events = &mut channel_state.pending_msg_events;
3917 channel_state.by_id.retain(|_, channel| {
3918 let res = f(channel);
3919 if let Ok((chan_res, mut timed_out_pending_htlcs)) = res {
3920 for (source, payment_hash) in timed_out_pending_htlcs.drain(..) {
3921 let chan_update = self.get_channel_update(&channel).map(|u| u.encode_with_len()).unwrap(); // Cannot add/recv HTLCs before we have a short_id so unwrap is safe
3922 timed_out_htlcs.push((source, payment_hash, HTLCFailReason::Reason {
3923 failure_code: 0x1000 | 14, // expiry_too_soon, or at least it is now
3927 if let Some(funding_locked) = chan_res {
3928 pending_msg_events.push(events::MessageSendEvent::SendFundingLocked {
3929 node_id: channel.get_counterparty_node_id(),
3930 msg: funding_locked,
3932 if let Some(announcement_sigs) = self.get_announcement_sigs(channel) {
3933 log_trace!(self.logger, "Sending funding_locked and announcement_signatures for {}", log_bytes!(channel.channel_id()));
3934 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
3935 node_id: channel.get_counterparty_node_id(),
3936 msg: announcement_sigs,
3939 log_trace!(self.logger, "Sending funding_locked WITHOUT announcement_signatures for {}", log_bytes!(channel.channel_id()));
3941 short_to_id.insert(channel.get_short_channel_id().unwrap(), channel.channel_id());
3943 } else if let Err(e) = res {
3944 if let Some(short_id) = channel.get_short_channel_id() {
3945 short_to_id.remove(&short_id);
3947 // It looks like our counterparty went on-chain or funding transaction was
3948 // reorged out of the main chain. Close the channel.
3949 failed_channels.push(channel.force_shutdown(true));
3950 if let Ok(update) = self.get_channel_update(&channel) {
3951 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
3955 pending_msg_events.push(events::MessageSendEvent::HandleError {
3956 node_id: channel.get_counterparty_node_id(),
3957 action: msgs::ErrorAction::SendErrorMessage { msg: e },
3964 if let Some(height) = height_opt {
3965 channel_state.claimable_htlcs.retain(|payment_hash, htlcs| {
3966 htlcs.retain(|htlc| {
3967 // If height is approaching the number of blocks we think it takes us to get
3968 // our commitment transaction confirmed before the HTLC expires, plus the
3969 // number of blocks we generally consider it to take to do a commitment update,
3970 // just give up on it and fail the HTLC.
3971 if height >= htlc.cltv_expiry - HTLC_FAIL_BACK_BUFFER {
3972 let mut htlc_msat_height_data = byte_utils::be64_to_array(htlc.value).to_vec();
3973 htlc_msat_height_data.extend_from_slice(&byte_utils::be32_to_array(height));
3974 timed_out_htlcs.push((HTLCSource::PreviousHopData(htlc.prev_hop.clone()), payment_hash.clone(), HTLCFailReason::Reason {
3975 failure_code: 0x4000 | 15,
3976 data: htlc_msat_height_data
3981 !htlcs.is_empty() // Only retain this entry if htlcs has at least one entry.
3986 self.handle_init_event_channel_failures(failed_channels);
3988 for (source, payment_hash, reason) in timed_out_htlcs.drain(..) {
3989 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), source, &payment_hash, reason);
3993 /// Blocks until ChannelManager needs to be persisted or a timeout is reached. It returns a bool
3994 /// indicating whether persistence is necessary. Only one listener on
3995 /// `await_persistable_update` or `await_persistable_update_timeout` is guaranteed to be woken
3997 /// Note that the feature `allow_wallclock_use` must be enabled to use this function.
3998 #[cfg(any(test, feature = "allow_wallclock_use"))]
3999 pub fn await_persistable_update_timeout(&self, max_wait: Duration) -> bool {
4000 self.persistence_notifier.wait_timeout(max_wait)
4003 /// Blocks until ChannelManager needs to be persisted. Only one listener on
4004 /// `await_persistable_update` or `await_persistable_update_timeout` is guaranteed to be woken
4006 pub fn await_persistable_update(&self) {
4007 self.persistence_notifier.wait()
4010 #[cfg(any(test, feature = "_test_utils"))]
4011 pub fn get_persistence_condvar_value(&self) -> bool {
4012 let mutcond = &self.persistence_notifier.persistence_lock;
4013 let &(ref mtx, _) = mutcond;
4014 let guard = mtx.lock().unwrap();
4019 impl<Signer: Sign, M: Deref , T: Deref , K: Deref , F: Deref , L: Deref >
4020 ChannelMessageHandler for ChannelManager<Signer, M, T, K, F, L>
4021 where M::Target: chain::Watch<Signer>,
4022 T::Target: BroadcasterInterface,
4023 K::Target: KeysInterface<Signer = Signer>,
4024 F::Target: FeeEstimator,
4027 fn handle_open_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::OpenChannel) {
4028 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4029 let _ = handle_error!(self, self.internal_open_channel(counterparty_node_id, their_features, msg), *counterparty_node_id);
4032 fn handle_accept_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::AcceptChannel) {
4033 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4034 let _ = handle_error!(self, self.internal_accept_channel(counterparty_node_id, their_features, msg), *counterparty_node_id);
4037 fn handle_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) {
4038 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4039 let _ = handle_error!(self, self.internal_funding_created(counterparty_node_id, msg), *counterparty_node_id);
4042 fn handle_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) {
4043 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4044 let _ = handle_error!(self, self.internal_funding_signed(counterparty_node_id, msg), *counterparty_node_id);
4047 fn handle_funding_locked(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingLocked) {
4048 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4049 let _ = handle_error!(self, self.internal_funding_locked(counterparty_node_id, msg), *counterparty_node_id);
4052 fn handle_shutdown(&self, counterparty_node_id: &PublicKey, their_features: &InitFeatures, msg: &msgs::Shutdown) {
4053 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4054 let _ = handle_error!(self, self.internal_shutdown(counterparty_node_id, their_features, msg), *counterparty_node_id);
4057 fn handle_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
4058 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4059 let _ = handle_error!(self, self.internal_closing_signed(counterparty_node_id, msg), *counterparty_node_id);
4062 fn handle_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
4063 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4064 let _ = handle_error!(self, self.internal_update_add_htlc(counterparty_node_id, msg), *counterparty_node_id);
4067 fn handle_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
4068 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4069 let _ = handle_error!(self, self.internal_update_fulfill_htlc(counterparty_node_id, msg), *counterparty_node_id);
4072 fn handle_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
4073 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4074 let _ = handle_error!(self, self.internal_update_fail_htlc(counterparty_node_id, msg), *counterparty_node_id);
4077 fn handle_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
4078 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4079 let _ = handle_error!(self, self.internal_update_fail_malformed_htlc(counterparty_node_id, msg), *counterparty_node_id);
4082 fn handle_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
4083 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4084 let _ = handle_error!(self, self.internal_commitment_signed(counterparty_node_id, msg), *counterparty_node_id);
4087 fn handle_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
4088 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4089 let _ = handle_error!(self, self.internal_revoke_and_ack(counterparty_node_id, msg), *counterparty_node_id);
4092 fn handle_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) {
4093 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4094 let _ = handle_error!(self, self.internal_update_fee(counterparty_node_id, msg), *counterparty_node_id);
4097 fn handle_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
4098 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4099 let _ = handle_error!(self, self.internal_announcement_signatures(counterparty_node_id, msg), *counterparty_node_id);
4102 fn handle_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) {
4103 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4104 let _ = handle_error!(self, self.internal_channel_update(counterparty_node_id, msg), *counterparty_node_id);
4107 fn handle_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
4108 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4109 let _ = handle_error!(self, self.internal_channel_reestablish(counterparty_node_id, msg), *counterparty_node_id);
4112 fn peer_disconnected(&self, counterparty_node_id: &PublicKey, no_connection_possible: bool) {
4113 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4114 let mut failed_channels = Vec::new();
4115 let mut no_channels_remain = true;
4117 let mut channel_state_lock = self.channel_state.lock().unwrap();
4118 let channel_state = &mut *channel_state_lock;
4119 let short_to_id = &mut channel_state.short_to_id;
4120 let pending_msg_events = &mut channel_state.pending_msg_events;
4121 if no_connection_possible {
4122 log_debug!(self.logger, "Failing all channels with {} due to no_connection_possible", log_pubkey!(counterparty_node_id));
4123 channel_state.by_id.retain(|_, chan| {
4124 if chan.get_counterparty_node_id() == *counterparty_node_id {
4125 if let Some(short_id) = chan.get_short_channel_id() {
4126 short_to_id.remove(&short_id);
4128 failed_channels.push(chan.force_shutdown(true));
4129 if let Ok(update) = self.get_channel_update(&chan) {
4130 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
4140 log_debug!(self.logger, "Marking channels with {} disconnected and generating channel_updates", log_pubkey!(counterparty_node_id));
4141 channel_state.by_id.retain(|_, chan| {
4142 if chan.get_counterparty_node_id() == *counterparty_node_id {
4143 chan.remove_uncommitted_htlcs_and_mark_paused(&self.logger);
4144 if chan.is_shutdown() {
4145 if let Some(short_id) = chan.get_short_channel_id() {
4146 short_to_id.remove(&short_id);
4150 no_channels_remain = false;
4156 pending_msg_events.retain(|msg| {
4158 &events::MessageSendEvent::SendAcceptChannel { ref node_id, .. } => node_id != counterparty_node_id,
4159 &events::MessageSendEvent::SendOpenChannel { ref node_id, .. } => node_id != counterparty_node_id,
4160 &events::MessageSendEvent::SendFundingCreated { ref node_id, .. } => node_id != counterparty_node_id,
4161 &events::MessageSendEvent::SendFundingSigned { ref node_id, .. } => node_id != counterparty_node_id,
4162 &events::MessageSendEvent::SendFundingLocked { ref node_id, .. } => node_id != counterparty_node_id,
4163 &events::MessageSendEvent::SendAnnouncementSignatures { ref node_id, .. } => node_id != counterparty_node_id,
4164 &events::MessageSendEvent::UpdateHTLCs { ref node_id, .. } => node_id != counterparty_node_id,
4165 &events::MessageSendEvent::SendRevokeAndACK { ref node_id, .. } => node_id != counterparty_node_id,
4166 &events::MessageSendEvent::SendClosingSigned { ref node_id, .. } => node_id != counterparty_node_id,
4167 &events::MessageSendEvent::SendShutdown { ref node_id, .. } => node_id != counterparty_node_id,
4168 &events::MessageSendEvent::SendChannelReestablish { ref node_id, .. } => node_id != counterparty_node_id,
4169 &events::MessageSendEvent::BroadcastChannelAnnouncement { .. } => true,
4170 &events::MessageSendEvent::BroadcastNodeAnnouncement { .. } => true,
4171 &events::MessageSendEvent::BroadcastChannelUpdate { .. } => true,
4172 &events::MessageSendEvent::HandleError { ref node_id, .. } => node_id != counterparty_node_id,
4173 &events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => true,
4174 &events::MessageSendEvent::SendChannelRangeQuery { .. } => false,
4175 &events::MessageSendEvent::SendShortIdsQuery { .. } => false,
4176 &events::MessageSendEvent::SendReplyChannelRange { .. } => false,
4180 if no_channels_remain {
4181 self.per_peer_state.write().unwrap().remove(counterparty_node_id);
4184 for failure in failed_channels.drain(..) {
4185 self.finish_force_close_channel(failure);
4189 fn peer_connected(&self, counterparty_node_id: &PublicKey, init_msg: &msgs::Init) {
4190 log_debug!(self.logger, "Generating channel_reestablish events for {}", log_pubkey!(counterparty_node_id));
4192 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4195 let mut peer_state_lock = self.per_peer_state.write().unwrap();
4196 match peer_state_lock.entry(counterparty_node_id.clone()) {
4197 hash_map::Entry::Vacant(e) => {
4198 e.insert(Mutex::new(PeerState {
4199 latest_features: init_msg.features.clone(),
4202 hash_map::Entry::Occupied(e) => {
4203 e.get().lock().unwrap().latest_features = init_msg.features.clone();
4208 let mut channel_state_lock = self.channel_state.lock().unwrap();
4209 let channel_state = &mut *channel_state_lock;
4210 let pending_msg_events = &mut channel_state.pending_msg_events;
4211 channel_state.by_id.retain(|_, chan| {
4212 if chan.get_counterparty_node_id() == *counterparty_node_id {
4213 if !chan.have_received_message() {
4214 // If we created this (outbound) channel while we were disconnected from the
4215 // peer we probably failed to send the open_channel message, which is now
4216 // lost. We can't have had anything pending related to this channel, so we just
4220 pending_msg_events.push(events::MessageSendEvent::SendChannelReestablish {
4221 node_id: chan.get_counterparty_node_id(),
4222 msg: chan.get_channel_reestablish(&self.logger),
4228 //TODO: Also re-broadcast announcement_signatures
4231 fn handle_error(&self, counterparty_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
4232 let _persistence_guard = PersistenceNotifierGuard::notify_on_drop(&self.total_consistency_lock, &self.persistence_notifier);
4234 if msg.channel_id == [0; 32] {
4235 for chan in self.list_channels() {
4236 if chan.remote_network_id == *counterparty_node_id {
4237 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
4238 let _ = self.force_close_channel_with_peer(&chan.channel_id, Some(counterparty_node_id));
4242 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
4243 let _ = self.force_close_channel_with_peer(&msg.channel_id, Some(counterparty_node_id));
4248 /// Used to signal to the ChannelManager persister that the manager needs to be re-persisted to
4249 /// disk/backups, through `await_persistable_update_timeout` and `await_persistable_update`.
4250 struct PersistenceNotifier {
4251 /// Users won't access the persistence_lock directly, but rather wait on its bool using
4252 /// `wait_timeout` and `wait`.
4253 persistence_lock: (Mutex<bool>, Condvar),
4256 impl PersistenceNotifier {
4259 persistence_lock: (Mutex::new(false), Condvar::new()),
4265 let &(ref mtx, ref cvar) = &self.persistence_lock;
4266 let mut guard = mtx.lock().unwrap();
4271 guard = cvar.wait(guard).unwrap();
4272 let result = *guard;
4280 #[cfg(any(test, feature = "allow_wallclock_use"))]
4281 fn wait_timeout(&self, max_wait: Duration) -> bool {
4282 let current_time = Instant::now();
4284 let &(ref mtx, ref cvar) = &self.persistence_lock;
4285 let mut guard = mtx.lock().unwrap();
4290 guard = cvar.wait_timeout(guard, max_wait).unwrap().0;
4291 // Due to spurious wakeups that can happen on `wait_timeout`, here we need to check if the
4292 // desired wait time has actually passed, and if not then restart the loop with a reduced wait
4293 // time. Note that this logic can be highly simplified through the use of
4294 // `Condvar::wait_while` and `Condvar::wait_timeout_while`, if and when our MSRV is raised to
4296 let elapsed = current_time.elapsed();
4297 let result = *guard;
4298 if result || elapsed >= max_wait {
4302 match max_wait.checked_sub(elapsed) {
4303 None => return result,
4309 // Signal to the ChannelManager persister that there are updates necessitating persisting to disk.
4311 let &(ref persist_mtx, ref cnd) = &self.persistence_lock;
4312 let mut persistence_lock = persist_mtx.lock().unwrap();
4313 *persistence_lock = true;
4314 mem::drop(persistence_lock);
4319 const SERIALIZATION_VERSION: u8 = 1;
4320 const MIN_SERIALIZATION_VERSION: u8 = 1;
4322 impl Writeable for PendingHTLCInfo {
4323 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
4324 match &self.routing {
4325 &PendingHTLCRouting::Forward { ref onion_packet, ref short_channel_id } => {
4327 onion_packet.write(writer)?;
4328 short_channel_id.write(writer)?;
4330 &PendingHTLCRouting::Receive { ref payment_data, ref incoming_cltv_expiry } => {
4332 payment_data.payment_secret.write(writer)?;
4333 payment_data.total_msat.write(writer)?;
4334 incoming_cltv_expiry.write(writer)?;
4337 self.incoming_shared_secret.write(writer)?;
4338 self.payment_hash.write(writer)?;
4339 self.amt_to_forward.write(writer)?;
4340 self.outgoing_cltv_value.write(writer)?;
4345 impl Readable for PendingHTLCInfo {
4346 fn read<R: ::std::io::Read>(reader: &mut R) -> Result<PendingHTLCInfo, DecodeError> {
4347 Ok(PendingHTLCInfo {
4348 routing: match Readable::read(reader)? {
4349 0u8 => PendingHTLCRouting::Forward {
4350 onion_packet: Readable::read(reader)?,
4351 short_channel_id: Readable::read(reader)?,
4353 1u8 => PendingHTLCRouting::Receive {
4354 payment_data: msgs::FinalOnionHopData {
4355 payment_secret: Readable::read(reader)?,
4356 total_msat: Readable::read(reader)?,
4358 incoming_cltv_expiry: Readable::read(reader)?,
4360 _ => return Err(DecodeError::InvalidValue),
4362 incoming_shared_secret: Readable::read(reader)?,
4363 payment_hash: Readable::read(reader)?,
4364 amt_to_forward: Readable::read(reader)?,
4365 outgoing_cltv_value: Readable::read(reader)?,
4370 impl Writeable for HTLCFailureMsg {
4371 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
4373 &HTLCFailureMsg::Relay(ref fail_msg) => {
4375 fail_msg.write(writer)?;
4377 &HTLCFailureMsg::Malformed(ref fail_msg) => {
4379 fail_msg.write(writer)?;
4386 impl Readable for HTLCFailureMsg {
4387 fn read<R: ::std::io::Read>(reader: &mut R) -> Result<HTLCFailureMsg, DecodeError> {
4388 match <u8 as Readable>::read(reader)? {
4389 0 => Ok(HTLCFailureMsg::Relay(Readable::read(reader)?)),
4390 1 => Ok(HTLCFailureMsg::Malformed(Readable::read(reader)?)),
4391 _ => Err(DecodeError::InvalidValue),
4396 impl Writeable for PendingHTLCStatus {
4397 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
4399 &PendingHTLCStatus::Forward(ref forward_info) => {
4401 forward_info.write(writer)?;
4403 &PendingHTLCStatus::Fail(ref fail_msg) => {
4405 fail_msg.write(writer)?;
4412 impl Readable for PendingHTLCStatus {
4413 fn read<R: ::std::io::Read>(reader: &mut R) -> Result<PendingHTLCStatus, DecodeError> {
4414 match <u8 as Readable>::read(reader)? {
4415 0 => Ok(PendingHTLCStatus::Forward(Readable::read(reader)?)),
4416 1 => Ok(PendingHTLCStatus::Fail(Readable::read(reader)?)),
4417 _ => Err(DecodeError::InvalidValue),
4422 impl_writeable!(HTLCPreviousHopData, 0, {
4426 incoming_packet_shared_secret
4429 impl Writeable for ClaimableHTLC {
4430 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
4431 self.prev_hop.write(writer)?;
4432 self.value.write(writer)?;
4433 self.payment_data.payment_secret.write(writer)?;
4434 self.payment_data.total_msat.write(writer)?;
4435 self.cltv_expiry.write(writer)
4439 impl Readable for ClaimableHTLC {
4440 fn read<R: ::std::io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
4442 prev_hop: Readable::read(reader)?,
4443 value: Readable::read(reader)?,
4444 payment_data: msgs::FinalOnionHopData {
4445 payment_secret: Readable::read(reader)?,
4446 total_msat: Readable::read(reader)?,
4448 cltv_expiry: Readable::read(reader)?,
4453 impl Writeable for HTLCSource {
4454 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
4456 &HTLCSource::PreviousHopData(ref hop_data) => {
4458 hop_data.write(writer)?;
4460 &HTLCSource::OutboundRoute { ref path, ref session_priv, ref first_hop_htlc_msat } => {
4462 path.write(writer)?;
4463 session_priv.write(writer)?;
4464 first_hop_htlc_msat.write(writer)?;
4471 impl Readable for HTLCSource {
4472 fn read<R: ::std::io::Read>(reader: &mut R) -> Result<HTLCSource, DecodeError> {
4473 match <u8 as Readable>::read(reader)? {
4474 0 => Ok(HTLCSource::PreviousHopData(Readable::read(reader)?)),
4475 1 => Ok(HTLCSource::OutboundRoute {
4476 path: Readable::read(reader)?,
4477 session_priv: Readable::read(reader)?,
4478 first_hop_htlc_msat: Readable::read(reader)?,
4480 _ => Err(DecodeError::InvalidValue),
4485 impl Writeable for HTLCFailReason {
4486 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
4488 &HTLCFailReason::LightningError { ref err } => {
4492 &HTLCFailReason::Reason { ref failure_code, ref data } => {
4494 failure_code.write(writer)?;
4495 data.write(writer)?;
4502 impl Readable for HTLCFailReason {
4503 fn read<R: ::std::io::Read>(reader: &mut R) -> Result<HTLCFailReason, DecodeError> {
4504 match <u8 as Readable>::read(reader)? {
4505 0 => Ok(HTLCFailReason::LightningError { err: Readable::read(reader)? }),
4506 1 => Ok(HTLCFailReason::Reason {
4507 failure_code: Readable::read(reader)?,
4508 data: Readable::read(reader)?,
4510 _ => Err(DecodeError::InvalidValue),
4515 impl Writeable for HTLCForwardInfo {
4516 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
4518 &HTLCForwardInfo::AddHTLC { ref prev_short_channel_id, ref prev_funding_outpoint, ref prev_htlc_id, ref forward_info } => {
4520 prev_short_channel_id.write(writer)?;
4521 prev_funding_outpoint.write(writer)?;
4522 prev_htlc_id.write(writer)?;
4523 forward_info.write(writer)?;
4525 &HTLCForwardInfo::FailHTLC { ref htlc_id, ref err_packet } => {
4527 htlc_id.write(writer)?;
4528 err_packet.write(writer)?;
4535 impl Readable for HTLCForwardInfo {
4536 fn read<R: ::std::io::Read>(reader: &mut R) -> Result<HTLCForwardInfo, DecodeError> {
4537 match <u8 as Readable>::read(reader)? {
4538 0 => Ok(HTLCForwardInfo::AddHTLC {
4539 prev_short_channel_id: Readable::read(reader)?,
4540 prev_funding_outpoint: Readable::read(reader)?,
4541 prev_htlc_id: Readable::read(reader)?,
4542 forward_info: Readable::read(reader)?,
4544 1 => Ok(HTLCForwardInfo::FailHTLC {
4545 htlc_id: Readable::read(reader)?,
4546 err_packet: Readable::read(reader)?,
4548 _ => Err(DecodeError::InvalidValue),
4553 impl_writeable!(PendingInboundPayment, 0, {
4561 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> Writeable for ChannelManager<Signer, M, T, K, F, L>
4562 where M::Target: chain::Watch<Signer>,
4563 T::Target: BroadcasterInterface,
4564 K::Target: KeysInterface<Signer = Signer>,
4565 F::Target: FeeEstimator,
4568 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
4569 let _consistency_lock = self.total_consistency_lock.write().unwrap();
4571 writer.write_all(&[SERIALIZATION_VERSION; 1])?;
4572 writer.write_all(&[MIN_SERIALIZATION_VERSION; 1])?;
4574 self.genesis_hash.write(writer)?;
4576 let best_block = self.best_block.read().unwrap();
4577 best_block.height().write(writer)?;
4578 best_block.block_hash().write(writer)?;
4581 let channel_state = self.channel_state.lock().unwrap();
4582 let mut unfunded_channels = 0;
4583 for (_, channel) in channel_state.by_id.iter() {
4584 if !channel.is_funding_initiated() {
4585 unfunded_channels += 1;
4588 ((channel_state.by_id.len() - unfunded_channels) as u64).write(writer)?;
4589 for (_, channel) in channel_state.by_id.iter() {
4590 if channel.is_funding_initiated() {
4591 channel.write(writer)?;
4595 (channel_state.forward_htlcs.len() as u64).write(writer)?;
4596 for (short_channel_id, pending_forwards) in channel_state.forward_htlcs.iter() {
4597 short_channel_id.write(writer)?;
4598 (pending_forwards.len() as u64).write(writer)?;
4599 for forward in pending_forwards {
4600 forward.write(writer)?;
4604 (channel_state.claimable_htlcs.len() as u64).write(writer)?;
4605 for (payment_hash, previous_hops) in channel_state.claimable_htlcs.iter() {
4606 payment_hash.write(writer)?;
4607 (previous_hops.len() as u64).write(writer)?;
4608 for htlc in previous_hops.iter() {
4609 htlc.write(writer)?;
4613 let per_peer_state = self.per_peer_state.write().unwrap();
4614 (per_peer_state.len() as u64).write(writer)?;
4615 for (peer_pubkey, peer_state_mutex) in per_peer_state.iter() {
4616 peer_pubkey.write(writer)?;
4617 let peer_state = peer_state_mutex.lock().unwrap();
4618 peer_state.latest_features.write(writer)?;
4621 let events = self.pending_events.lock().unwrap();
4622 (events.len() as u64).write(writer)?;
4623 for event in events.iter() {
4624 event.write(writer)?;
4627 let background_events = self.pending_background_events.lock().unwrap();
4628 (background_events.len() as u64).write(writer)?;
4629 for event in background_events.iter() {
4631 BackgroundEvent::ClosingMonitorUpdate((funding_txo, monitor_update)) => {
4633 funding_txo.write(writer)?;
4634 monitor_update.write(writer)?;
4639 (self.last_node_announcement_serial.load(Ordering::Acquire) as u32).write(writer)?;
4640 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
4642 let pending_inbound_payments = self.pending_inbound_payments.lock().unwrap();
4643 (pending_inbound_payments.len() as u64).write(writer)?;
4644 for (hash, pending_payment) in pending_inbound_payments.iter() {
4645 hash.write(writer)?;
4646 pending_payment.write(writer)?;
4649 let pending_outbound_payments = self.pending_outbound_payments.lock().unwrap();
4650 (pending_outbound_payments.len() as u64).write(writer)?;
4651 for session_priv in pending_outbound_payments.iter() {
4652 session_priv.write(writer)?;
4659 /// Arguments for the creation of a ChannelManager that are not deserialized.
4661 /// At a high-level, the process for deserializing a ChannelManager and resuming normal operation
4663 /// 1) Deserialize all stored ChannelMonitors.
4664 /// 2) Deserialize the ChannelManager by filling in this struct and calling:
4665 /// <(BlockHash, ChannelManager)>::read(reader, args)
4666 /// This may result in closing some Channels if the ChannelMonitor is newer than the stored
4667 /// ChannelManager state to ensure no loss of funds. Thus, transactions may be broadcasted.
4668 /// 3) If you are not fetching full blocks, register all relevant ChannelMonitor outpoints the same
4669 /// way you would handle a `chain::Filter` call using ChannelMonitor::get_outputs_to_watch() and
4670 /// ChannelMonitor::get_funding_txo().
4671 /// 4) Reconnect blocks on your ChannelMonitors.
4672 /// 5) Disconnect/connect blocks on the ChannelManager.
4673 /// 6) Move the ChannelMonitors into your local chain::Watch.
4675 /// Note that the ordering of #4-6 is not of importance, however all three must occur before you
4676 /// call any other methods on the newly-deserialized ChannelManager.
4678 /// Note that because some channels may be closed during deserialization, it is critical that you
4679 /// always deserialize only the latest version of a ChannelManager and ChannelMonitors available to
4680 /// you. If you deserialize an old ChannelManager (during which force-closure transactions may be
4681 /// broadcast), and then later deserialize a newer version of the same ChannelManager (which will
4682 /// not force-close the same channels but consider them live), you may end up revoking a state for
4683 /// which you've already broadcasted the transaction.
4684 pub struct ChannelManagerReadArgs<'a, Signer: 'a + Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
4685 where M::Target: chain::Watch<Signer>,
4686 T::Target: BroadcasterInterface,
4687 K::Target: KeysInterface<Signer = Signer>,
4688 F::Target: FeeEstimator,
4691 /// The keys provider which will give us relevant keys. Some keys will be loaded during
4692 /// deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
4694 pub keys_manager: K,
4696 /// The fee_estimator for use in the ChannelManager in the future.
4698 /// No calls to the FeeEstimator will be made during deserialization.
4699 pub fee_estimator: F,
4700 /// The chain::Watch for use in the ChannelManager in the future.
4702 /// No calls to the chain::Watch will be made during deserialization. It is assumed that
4703 /// you have deserialized ChannelMonitors separately and will add them to your
4704 /// chain::Watch after deserializing this ChannelManager.
4705 pub chain_monitor: M,
4707 /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
4708 /// used to broadcast the latest local commitment transactions of channels which must be
4709 /// force-closed during deserialization.
4710 pub tx_broadcaster: T,
4711 /// The Logger for use in the ChannelManager and which may be used to log information during
4712 /// deserialization.
4714 /// Default settings used for new channels. Any existing channels will continue to use the
4715 /// runtime settings which were stored when the ChannelManager was serialized.
4716 pub default_config: UserConfig,
4718 /// A map from channel funding outpoints to ChannelMonitors for those channels (ie
4719 /// value.get_funding_txo() should be the key).
4721 /// If a monitor is inconsistent with the channel state during deserialization the channel will
4722 /// be force-closed using the data in the ChannelMonitor and the channel will be dropped. This
4723 /// is true for missing channels as well. If there is a monitor missing for which we find
4724 /// channel data Err(DecodeError::InvalidValue) will be returned.
4726 /// In such cases the latest local transactions will be sent to the tx_broadcaster included in
4729 /// (C-not exported) because we have no HashMap bindings
4730 pub channel_monitors: HashMap<OutPoint, &'a mut ChannelMonitor<Signer>>,
4733 impl<'a, Signer: 'a + Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
4734 ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>
4735 where M::Target: chain::Watch<Signer>,
4736 T::Target: BroadcasterInterface,
4737 K::Target: KeysInterface<Signer = Signer>,
4738 F::Target: FeeEstimator,
4741 /// Simple utility function to create a ChannelManagerReadArgs which creates the monitor
4742 /// HashMap for you. This is primarily useful for C bindings where it is not practical to
4743 /// populate a HashMap directly from C.
4744 pub fn new(keys_manager: K, fee_estimator: F, chain_monitor: M, tx_broadcaster: T, logger: L, default_config: UserConfig,
4745 mut channel_monitors: Vec<&'a mut ChannelMonitor<Signer>>) -> Self {
4747 keys_manager, fee_estimator, chain_monitor, tx_broadcaster, logger, default_config,
4748 channel_monitors: channel_monitors.drain(..).map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect()
4753 // Implement ReadableArgs for an Arc'd ChannelManager to make it a bit easier to work with the
4754 // SipmleArcChannelManager type:
4755 impl<'a, Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
4756 ReadableArgs<ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>> for (BlockHash, Arc<ChannelManager<Signer, M, T, K, F, L>>)
4757 where M::Target: chain::Watch<Signer>,
4758 T::Target: BroadcasterInterface,
4759 K::Target: KeysInterface<Signer = Signer>,
4760 F::Target: FeeEstimator,
4763 fn read<R: ::std::io::Read>(reader: &mut R, args: ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>) -> Result<Self, DecodeError> {
4764 let (blockhash, chan_manager) = <(BlockHash, ChannelManager<Signer, M, T, K, F, L>)>::read(reader, args)?;
4765 Ok((blockhash, Arc::new(chan_manager)))
4769 impl<'a, Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
4770 ReadableArgs<ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>> for (BlockHash, ChannelManager<Signer, M, T, K, F, L>)
4771 where M::Target: chain::Watch<Signer>,
4772 T::Target: BroadcasterInterface,
4773 K::Target: KeysInterface<Signer = Signer>,
4774 F::Target: FeeEstimator,
4777 fn read<R: ::std::io::Read>(reader: &mut R, mut args: ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>) -> Result<Self, DecodeError> {
4778 let _ver: u8 = Readable::read(reader)?;
4779 let min_ver: u8 = Readable::read(reader)?;
4780 if min_ver > SERIALIZATION_VERSION {
4781 return Err(DecodeError::UnknownVersion);
4784 let genesis_hash: BlockHash = Readable::read(reader)?;
4785 let best_block_height: u32 = Readable::read(reader)?;
4786 let best_block_hash: BlockHash = Readable::read(reader)?;
4788 let mut failed_htlcs = Vec::new();
4790 let channel_count: u64 = Readable::read(reader)?;
4791 let mut funding_txo_set = HashSet::with_capacity(cmp::min(channel_count as usize, 128));
4792 let mut by_id = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
4793 let mut short_to_id = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
4794 for _ in 0..channel_count {
4795 let mut channel: Channel<Signer> = Channel::read(reader, &args.keys_manager)?;
4796 let funding_txo = channel.get_funding_txo().ok_or(DecodeError::InvalidValue)?;
4797 funding_txo_set.insert(funding_txo.clone());
4798 if let Some(ref mut monitor) = args.channel_monitors.get_mut(&funding_txo) {
4799 if channel.get_cur_holder_commitment_transaction_number() < monitor.get_cur_holder_commitment_number() ||
4800 channel.get_revoked_counterparty_commitment_transaction_number() < monitor.get_min_seen_secret() ||
4801 channel.get_cur_counterparty_commitment_transaction_number() < monitor.get_cur_counterparty_commitment_number() ||
4802 channel.get_latest_monitor_update_id() > monitor.get_latest_update_id() {
4803 // If the channel is ahead of the monitor, return InvalidValue:
4804 return Err(DecodeError::InvalidValue);
4805 } else if channel.get_cur_holder_commitment_transaction_number() > monitor.get_cur_holder_commitment_number() ||
4806 channel.get_revoked_counterparty_commitment_transaction_number() > monitor.get_min_seen_secret() ||
4807 channel.get_cur_counterparty_commitment_transaction_number() > monitor.get_cur_counterparty_commitment_number() ||
4808 channel.get_latest_monitor_update_id() < monitor.get_latest_update_id() {
4809 // But if the channel is behind of the monitor, close the channel:
4810 let (_, mut new_failed_htlcs) = channel.force_shutdown(true);
4811 failed_htlcs.append(&mut new_failed_htlcs);
4812 monitor.broadcast_latest_holder_commitment_txn(&args.tx_broadcaster, &args.logger);
4814 if let Some(short_channel_id) = channel.get_short_channel_id() {
4815 short_to_id.insert(short_channel_id, channel.channel_id());
4817 by_id.insert(channel.channel_id(), channel);
4820 return Err(DecodeError::InvalidValue);
4824 for (ref funding_txo, ref mut monitor) in args.channel_monitors.iter_mut() {
4825 if !funding_txo_set.contains(funding_txo) {
4826 monitor.broadcast_latest_holder_commitment_txn(&args.tx_broadcaster, &args.logger);
4830 const MAX_ALLOC_SIZE: usize = 1024 * 64;
4831 let forward_htlcs_count: u64 = Readable::read(reader)?;
4832 let mut forward_htlcs = HashMap::with_capacity(cmp::min(forward_htlcs_count as usize, 128));
4833 for _ in 0..forward_htlcs_count {
4834 let short_channel_id = Readable::read(reader)?;
4835 let pending_forwards_count: u64 = Readable::read(reader)?;
4836 let mut pending_forwards = Vec::with_capacity(cmp::min(pending_forwards_count as usize, MAX_ALLOC_SIZE/mem::size_of::<HTLCForwardInfo>()));
4837 for _ in 0..pending_forwards_count {
4838 pending_forwards.push(Readable::read(reader)?);
4840 forward_htlcs.insert(short_channel_id, pending_forwards);
4843 let claimable_htlcs_count: u64 = Readable::read(reader)?;
4844 let mut claimable_htlcs = HashMap::with_capacity(cmp::min(claimable_htlcs_count as usize, 128));
4845 for _ in 0..claimable_htlcs_count {
4846 let payment_hash = Readable::read(reader)?;
4847 let previous_hops_len: u64 = Readable::read(reader)?;
4848 let mut previous_hops = Vec::with_capacity(cmp::min(previous_hops_len as usize, MAX_ALLOC_SIZE/mem::size_of::<ClaimableHTLC>()));
4849 for _ in 0..previous_hops_len {
4850 previous_hops.push(Readable::read(reader)?);
4852 claimable_htlcs.insert(payment_hash, previous_hops);
4855 let peer_count: u64 = Readable::read(reader)?;
4856 let mut per_peer_state = HashMap::with_capacity(cmp::min(peer_count as usize, MAX_ALLOC_SIZE/mem::size_of::<(PublicKey, Mutex<PeerState>)>()));
4857 for _ in 0..peer_count {
4858 let peer_pubkey = Readable::read(reader)?;
4859 let peer_state = PeerState {
4860 latest_features: Readable::read(reader)?,
4862 per_peer_state.insert(peer_pubkey, Mutex::new(peer_state));
4865 let event_count: u64 = Readable::read(reader)?;
4866 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>()));
4867 for _ in 0..event_count {
4868 match MaybeReadable::read(reader)? {
4869 Some(event) => pending_events_read.push(event),
4874 let background_event_count: u64 = Readable::read(reader)?;
4875 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>()));
4876 for _ in 0..background_event_count {
4877 match <u8 as Readable>::read(reader)? {
4878 0 => pending_background_events_read.push(BackgroundEvent::ClosingMonitorUpdate((Readable::read(reader)?, Readable::read(reader)?))),
4879 _ => return Err(DecodeError::InvalidValue),
4883 let last_node_announcement_serial: u32 = Readable::read(reader)?;
4884 let highest_seen_timestamp: u32 = Readable::read(reader)?;
4886 let pending_inbound_payment_count: u64 = Readable::read(reader)?;
4887 let mut pending_inbound_payments: HashMap<PaymentHash, PendingInboundPayment> = HashMap::with_capacity(cmp::min(pending_inbound_payment_count as usize, MAX_ALLOC_SIZE/(3*32)));
4888 for _ in 0..pending_inbound_payment_count {
4889 if pending_inbound_payments.insert(Readable::read(reader)?, Readable::read(reader)?).is_some() {
4890 return Err(DecodeError::InvalidValue);
4894 let pending_outbound_payments_count: u64 = Readable::read(reader)?;
4895 let mut pending_outbound_payments: HashSet<[u8; 32]> = HashSet::with_capacity(cmp::min(pending_outbound_payments_count as usize, MAX_ALLOC_SIZE/32));
4896 for _ in 0..pending_outbound_payments_count {
4897 if !pending_outbound_payments.insert(Readable::read(reader)?) {
4898 return Err(DecodeError::InvalidValue);
4902 let mut secp_ctx = Secp256k1::new();
4903 secp_ctx.seeded_randomize(&args.keys_manager.get_secure_random_bytes());
4905 let channel_manager = ChannelManager {
4907 fee_estimator: args.fee_estimator,
4908 chain_monitor: args.chain_monitor,
4909 tx_broadcaster: args.tx_broadcaster,
4911 best_block: RwLock::new(BestBlock::new(best_block_hash, best_block_height)),
4913 channel_state: Mutex::new(ChannelHolder {
4918 pending_msg_events: Vec::new(),
4920 pending_inbound_payments: Mutex::new(pending_inbound_payments),
4921 pending_outbound_payments: Mutex::new(pending_outbound_payments),
4923 our_network_key: args.keys_manager.get_node_secret(),
4924 our_network_pubkey: PublicKey::from_secret_key(&secp_ctx, &args.keys_manager.get_node_secret()),
4927 last_node_announcement_serial: AtomicUsize::new(last_node_announcement_serial as usize),
4928 highest_seen_timestamp: AtomicUsize::new(highest_seen_timestamp as usize),
4930 per_peer_state: RwLock::new(per_peer_state),
4932 pending_events: Mutex::new(pending_events_read),
4933 pending_background_events: Mutex::new(pending_background_events_read),
4934 total_consistency_lock: RwLock::new(()),
4935 persistence_notifier: PersistenceNotifier::new(),
4937 keys_manager: args.keys_manager,
4938 logger: args.logger,
4939 default_configuration: args.default_config,
4942 for htlc_source in failed_htlcs.drain(..) {
4943 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() });
4946 //TODO: Broadcast channel update for closed channels, but only after we've made a
4947 //connection or two.
4949 Ok((best_block_hash.clone(), channel_manager))
4955 use ln::channelmanager::PersistenceNotifier;
4957 use core::sync::atomic::{AtomicBool, Ordering};
4959 use core::time::Duration;
4962 fn test_wait_timeout() {
4963 let persistence_notifier = Arc::new(PersistenceNotifier::new());
4964 let thread_notifier = Arc::clone(&persistence_notifier);
4966 let exit_thread = Arc::new(AtomicBool::new(false));
4967 let exit_thread_clone = exit_thread.clone();
4968 thread::spawn(move || {
4970 let &(ref persist_mtx, ref cnd) = &thread_notifier.persistence_lock;
4971 let mut persistence_lock = persist_mtx.lock().unwrap();
4972 *persistence_lock = true;
4975 if exit_thread_clone.load(Ordering::SeqCst) {
4981 // Check that we can block indefinitely until updates are available.
4982 let _ = persistence_notifier.wait();
4984 // Check that the PersistenceNotifier will return after the given duration if updates are
4987 if persistence_notifier.wait_timeout(Duration::from_millis(100)) {
4992 exit_thread.store(true, Ordering::SeqCst);
4994 // Check that the PersistenceNotifier will return after the given duration even if no updates
4997 if !persistence_notifier.wait_timeout(Duration::from_millis(100)) {
5004 #[cfg(all(any(test, feature = "_test_utils"), feature = "unstable"))]
5007 use chain::chainmonitor::ChainMonitor;
5008 use chain::channelmonitor::Persist;
5009 use chain::keysinterface::{KeysManager, InMemorySigner};
5010 use ln::channelmanager::{BestBlock, ChainParameters, ChannelManager, PaymentHash, PaymentPreimage};
5011 use ln::features::{InitFeatures, InvoiceFeatures};
5012 use ln::functional_test_utils::*;
5013 use ln::msgs::ChannelMessageHandler;
5014 use routing::network_graph::NetworkGraph;
5015 use routing::router::get_route;
5016 use util::test_utils;
5017 use util::config::UserConfig;
5018 use util::events::{Event, MessageSendEvent, MessageSendEventsProvider};
5020 use bitcoin::hashes::Hash;
5021 use bitcoin::hashes::sha256::Hash as Sha256;
5022 use bitcoin::{Block, BlockHeader, Transaction, TxOut};
5024 use std::sync::Mutex;
5028 struct NodeHolder<'a, P: Persist<InMemorySigner>> {
5029 node: &'a ChannelManager<InMemorySigner,
5030 &'a ChainMonitor<InMemorySigner, &'a test_utils::TestChainSource,
5031 &'a test_utils::TestBroadcaster, &'a test_utils::TestFeeEstimator,
5032 &'a test_utils::TestLogger, &'a P>,
5033 &'a test_utils::TestBroadcaster, &'a KeysManager,
5034 &'a test_utils::TestFeeEstimator, &'a test_utils::TestLogger>
5039 fn bench_sends(bench: &mut Bencher) {
5040 bench_two_sends(bench, test_utils::TestPersister::new(), test_utils::TestPersister::new());
5043 pub fn bench_two_sends<P: Persist<InMemorySigner>>(bench: &mut Bencher, persister_a: P, persister_b: P) {
5044 // Do a simple benchmark of sending a payment back and forth between two nodes.
5045 // Note that this is unrealistic as each payment send will require at least two fsync
5047 let network = bitcoin::Network::Testnet;
5048 let genesis_hash = bitcoin::blockdata::constants::genesis_block(network).header.block_hash();
5050 let tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())};
5051 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
5053 let mut config: UserConfig = Default::default();
5054 config.own_channel_config.minimum_depth = 1;
5056 let logger_a = test_utils::TestLogger::with_id("node a".to_owned());
5057 let chain_monitor_a = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_a);
5058 let seed_a = [1u8; 32];
5059 let keys_manager_a = KeysManager::new(&seed_a, 42, 42);
5060 let node_a = ChannelManager::new(&fee_estimator, &chain_monitor_a, &tx_broadcaster, &logger_a, &keys_manager_a, config.clone(), ChainParameters {
5062 best_block: BestBlock::from_genesis(network),
5064 let node_a_holder = NodeHolder { node: &node_a };
5066 let logger_b = test_utils::TestLogger::with_id("node a".to_owned());
5067 let chain_monitor_b = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_b);
5068 let seed_b = [2u8; 32];
5069 let keys_manager_b = KeysManager::new(&seed_b, 42, 42);
5070 let node_b = ChannelManager::new(&fee_estimator, &chain_monitor_b, &tx_broadcaster, &logger_b, &keys_manager_b, config.clone(), ChainParameters {
5072 best_block: BestBlock::from_genesis(network),
5074 let node_b_holder = NodeHolder { node: &node_b };
5076 node_a.create_channel(node_b.get_our_node_id(), 8_000_000, 100_000_000, 42, None).unwrap();
5077 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()));
5078 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()));
5081 if let Event::FundingGenerationReady { temporary_channel_id, output_script, .. } = get_event!(node_a_holder, Event::FundingGenerationReady) {
5082 tx = Transaction { version: 2, lock_time: 0, input: Vec::new(), output: vec![TxOut {
5083 value: 8_000_000, script_pubkey: output_script,
5085 node_a.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
5086 } else { panic!(); }
5088 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()));
5089 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()));
5091 assert_eq!(&tx_broadcaster.txn_broadcasted.lock().unwrap()[..], &[tx.clone()]);
5094 header: BlockHeader { version: 0x20000000, prev_blockhash: genesis_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5097 Listen::block_connected(&node_a, &block, 1);
5098 Listen::block_connected(&node_b, &block, 1);
5100 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()));
5101 node_b.handle_funding_locked(&node_a.get_our_node_id(), &get_event_msg!(node_a_holder, MessageSendEvent::SendFundingLocked, node_b.get_our_node_id()));
5103 let dummy_graph = NetworkGraph::new(genesis_hash);
5105 let mut payment_count: u64 = 0;
5106 macro_rules! send_payment {
5107 ($node_a: expr, $node_b: expr) => {
5108 let usable_channels = $node_a.list_usable_channels();
5109 let route = get_route(&$node_a.get_our_node_id(), &dummy_graph, &$node_b.get_our_node_id(), Some(InvoiceFeatures::known()),
5110 Some(&usable_channels.iter().map(|r| r).collect::<Vec<_>>()), &[], 10_000, TEST_FINAL_CLTV, &logger_a).unwrap();
5112 let mut payment_preimage = PaymentPreimage([0; 32]);
5113 payment_preimage.0[0..8].copy_from_slice(&payment_count.to_le_bytes());
5115 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
5116 let payment_secret = $node_b.create_inbound_payment_for_hash(payment_hash, None, 7200, 0).unwrap();
5118 $node_a.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
5119 let payment_event = SendEvent::from_event($node_a.get_and_clear_pending_msg_events().pop().unwrap());
5120 $node_b.handle_update_add_htlc(&$node_a.get_our_node_id(), &payment_event.msgs[0]);
5121 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &payment_event.commitment_msg);
5122 let (raa, cs) = get_revoke_commit_msgs!(NodeHolder { node: &$node_b }, $node_a.get_our_node_id());
5123 $node_a.handle_revoke_and_ack(&$node_b.get_our_node_id(), &raa);
5124 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &cs);
5125 $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()));
5127 expect_pending_htlcs_forwardable!(NodeHolder { node: &$node_b });
5128 expect_payment_received!(NodeHolder { node: &$node_b }, payment_hash, payment_secret, 10_000);
5129 assert!($node_b.claim_funds(payment_preimage));
5131 match $node_b.get_and_clear_pending_msg_events().pop().unwrap() {
5132 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
5133 assert_eq!(node_id, $node_a.get_our_node_id());
5134 $node_a.handle_update_fulfill_htlc(&$node_b.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
5135 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &updates.commitment_signed);
5137 _ => panic!("Failed to generate claim event"),
5140 let (raa, cs) = get_revoke_commit_msgs!(NodeHolder { node: &$node_a }, $node_b.get_our_node_id());
5141 $node_b.handle_revoke_and_ack(&$node_a.get_our_node_id(), &raa);
5142 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &cs);
5143 $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()));
5145 expect_payment_sent!(NodeHolder { node: &$node_a }, payment_preimage);
5150 send_payment!(node_a, node_b);
5151 send_payment!(node_b, node_a);