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};
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::{Event, 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::collections::{HashMap, hash_map, HashSet};
66 use std::io::{Cursor, Read};
67 use std::sync::{Arc, Condvar, Mutex, MutexGuard, RwLock, RwLockReadGuard};
68 use std::sync::atomic::{AtomicUsize, Ordering};
69 use std::time::Duration;
70 #[cfg(any(test, feature = "allow_wallclock_use"))]
71 use std::time::Instant;
73 use bitcoin::hashes::hex::ToHex;
75 // We hold various information about HTLC relay in the HTLC objects in Channel itself:
77 // Upon receipt of an HTLC from a peer, we'll give it a PendingHTLCStatus indicating if it should
78 // forward the HTLC with information it will give back to us when it does so, or if it should Fail
79 // the HTLC with the relevant message for the Channel to handle giving to the remote peer.
81 // Once said HTLC is committed in the Channel, if the PendingHTLCStatus indicated Forward, the
82 // Channel will return the PendingHTLCInfo back to us, and we will create an HTLCForwardInfo
83 // with it to track where it came from (in case of onwards-forward error), waiting a random delay
84 // before we forward it.
86 // We will then use HTLCForwardInfo's PendingHTLCInfo to construct an outbound HTLC, with a
87 // relevant HTLCSource::PreviousHopData filled in to indicate where it came from (which we can use
88 // to either fail-backwards or fulfill the HTLC backwards along the relevant path).
89 // Alternatively, we can fill an outbound HTLC with a HTLCSource::OutboundRoute indicating this is
90 // our payment, which we can use to decode errors or inform the user that the payment was sent.
92 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
93 enum PendingHTLCRouting {
95 onion_packet: msgs::OnionPacket,
96 short_channel_id: u64, // This should be NonZero<u64> eventually when we bump MSRV
99 payment_data: msgs::FinalOnionHopData,
100 incoming_cltv_expiry: u32, // Used to track when we should expire pending HTLCs that go unclaimed
104 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
105 pub(super) struct PendingHTLCInfo {
106 routing: PendingHTLCRouting,
107 incoming_shared_secret: [u8; 32],
108 payment_hash: PaymentHash,
109 pub(super) amt_to_forward: u64,
110 pub(super) outgoing_cltv_value: u32,
113 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
114 pub(super) enum HTLCFailureMsg {
115 Relay(msgs::UpdateFailHTLC),
116 Malformed(msgs::UpdateFailMalformedHTLC),
119 /// Stores whether we can't forward an HTLC or relevant forwarding info
120 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
121 pub(super) enum PendingHTLCStatus {
122 Forward(PendingHTLCInfo),
123 Fail(HTLCFailureMsg),
126 pub(super) enum HTLCForwardInfo {
128 forward_info: PendingHTLCInfo,
130 // These fields are produced in `forward_htlcs()` and consumed in
131 // `process_pending_htlc_forwards()` for constructing the
132 // `HTLCSource::PreviousHopData` for failed and forwarded
134 prev_short_channel_id: u64,
136 prev_funding_outpoint: OutPoint,
140 err_packet: msgs::OnionErrorPacket,
144 /// Tracks the inbound corresponding to an outbound HTLC
145 #[derive(Clone, PartialEq)]
146 pub(crate) struct HTLCPreviousHopData {
147 short_channel_id: u64,
149 incoming_packet_shared_secret: [u8; 32],
151 // This field is consumed by `claim_funds_from_hop()` when updating a force-closed backwards
152 // channel with a preimage provided by the forward channel.
156 struct ClaimableHTLC {
157 prev_hop: HTLCPreviousHopData,
159 /// Contains a total_msat (which may differ from value if this is a Multi-Path Payment) and a
160 /// payment_secret which prevents path-probing attacks and can associate different HTLCs which
161 /// are part of the same payment.
162 payment_data: msgs::FinalOnionHopData,
166 /// Tracks the inbound corresponding to an outbound HTLC
167 #[derive(Clone, PartialEq)]
168 pub(crate) enum HTLCSource {
169 PreviousHopData(HTLCPreviousHopData),
172 session_priv: SecretKey,
173 /// Technically we can recalculate this from the route, but we cache it here to avoid
174 /// doing a double-pass on route when we get a failure back
175 first_hop_htlc_msat: u64,
180 pub fn dummy() -> Self {
181 HTLCSource::OutboundRoute {
183 session_priv: SecretKey::from_slice(&[1; 32]).unwrap(),
184 first_hop_htlc_msat: 0,
189 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
190 pub(super) enum HTLCFailReason {
192 err: msgs::OnionErrorPacket,
200 type ShutdownResult = (Option<(OutPoint, ChannelMonitorUpdate)>, Vec<(HTLCSource, PaymentHash)>);
202 /// Error type returned across the channel_state mutex boundary. When an Err is generated for a
203 /// Channel, we generally end up with a ChannelError::Close for which we have to close the channel
204 /// immediately (ie with no further calls on it made). Thus, this step happens inside a
205 /// channel_state lock. We then return the set of things that need to be done outside the lock in
206 /// this struct and call handle_error!() on it.
208 struct MsgHandleErrInternal {
209 err: msgs::LightningError,
210 shutdown_finish: Option<(ShutdownResult, Option<msgs::ChannelUpdate>)>,
212 impl MsgHandleErrInternal {
214 fn send_err_msg_no_close(err: String, channel_id: [u8; 32]) -> Self {
216 err: LightningError {
218 action: msgs::ErrorAction::SendErrorMessage {
219 msg: msgs::ErrorMessage {
225 shutdown_finish: None,
229 fn ignore_no_close(err: String) -> Self {
231 err: LightningError {
233 action: msgs::ErrorAction::IgnoreError,
235 shutdown_finish: None,
239 fn from_no_close(err: msgs::LightningError) -> Self {
240 Self { err, shutdown_finish: None }
243 fn from_finish_shutdown(err: String, channel_id: [u8; 32], shutdown_res: ShutdownResult, channel_update: Option<msgs::ChannelUpdate>) -> Self {
245 err: LightningError {
247 action: msgs::ErrorAction::SendErrorMessage {
248 msg: msgs::ErrorMessage {
254 shutdown_finish: Some((shutdown_res, channel_update)),
258 fn from_chan_no_close(err: ChannelError, channel_id: [u8; 32]) -> Self {
261 ChannelError::Ignore(msg) => LightningError {
263 action: msgs::ErrorAction::IgnoreError,
265 ChannelError::Close(msg) => LightningError {
267 action: msgs::ErrorAction::SendErrorMessage {
268 msg: msgs::ErrorMessage {
274 ChannelError::CloseDelayBroadcast(msg) => LightningError {
276 action: msgs::ErrorAction::SendErrorMessage {
277 msg: msgs::ErrorMessage {
284 shutdown_finish: None,
289 /// We hold back HTLCs we intend to relay for a random interval greater than this (see
290 /// Event::PendingHTLCsForwardable for the API guidelines indicating how long should be waited).
291 /// This provides some limited amount of privacy. Ideally this would range from somewhere like one
292 /// second to 30 seconds, but people expect lightning to be, you know, kinda fast, sadly.
293 const MIN_HTLC_RELAY_HOLDING_CELL_MILLIS: u64 = 100;
295 /// For events which result in both a RevokeAndACK and a CommitmentUpdate, by default they should
296 /// be sent in the order they appear in the return value, however sometimes the order needs to be
297 /// variable at runtime (eg Channel::channel_reestablish needs to re-send messages in the order
298 /// they were originally sent). In those cases, this enum is also returned.
299 #[derive(Clone, PartialEq)]
300 pub(super) enum RAACommitmentOrder {
301 /// Send the CommitmentUpdate messages first
303 /// Send the RevokeAndACK message first
307 // Note this is only exposed in cfg(test):
308 pub(super) struct ChannelHolder<Signer: Sign> {
309 pub(super) by_id: HashMap<[u8; 32], Channel<Signer>>,
310 pub(super) short_to_id: HashMap<u64, [u8; 32]>,
311 /// short channel id -> forward infos. Key of 0 means payments received
312 /// Note that while this is held in the same mutex as the channels themselves, no consistency
313 /// guarantees are made about the existence of a channel with the short id here, nor the short
314 /// ids in the PendingHTLCInfo!
315 pub(super) forward_htlcs: HashMap<u64, Vec<HTLCForwardInfo>>,
316 /// Map from payment hash to any HTLCs which are to us and can be failed/claimed by the user.
317 /// Note that while this is held in the same mutex as the channels themselves, no consistency
318 /// guarantees are made about the channels given here actually existing anymore by the time you
320 claimable_htlcs: HashMap<PaymentHash, Vec<ClaimableHTLC>>,
321 /// Messages to send to peers - pushed to in the same lock that they are generated in (except
322 /// for broadcast messages, where ordering isn't as strict).
323 pub(super) pending_msg_events: Vec<MessageSendEvent>,
326 /// Events which we process internally but cannot be procsesed immediately at the generation site
327 /// for some reason. They are handled in timer_tick_occurred, so may be processed with
328 /// quite some time lag.
329 enum BackgroundEvent {
330 /// Handle a ChannelMonitorUpdate that closes a channel, broadcasting its current latest holder
331 /// commitment transaction.
332 ClosingMonitorUpdate((OutPoint, ChannelMonitorUpdate)),
335 /// State we hold per-peer. In the future we should put channels in here, but for now we only hold
336 /// the latest Init features we heard from the peer.
338 latest_features: InitFeatures,
341 /// Stores a PaymentSecret and any other data we may need to validate an inbound payment is
342 /// actually ours and not some duplicate HTLC sent to us by a node along the route.
344 /// For users who don't want to bother doing their own payment preimage storage, we also store that
346 struct PendingInboundPayment {
347 /// The payment secret that the sender must use for us to accept this payment
348 payment_secret: PaymentSecret,
349 /// Time at which this HTLC expires - blocks with a header time above this value will result in
350 /// this payment being removed.
352 /// Arbitrary identifier the user specifies (or not)
353 user_payment_id: u64,
354 // Other required attributes of the payment, optionally enforced:
355 payment_preimage: Option<PaymentPreimage>,
356 min_value_msat: Option<u64>,
359 /// SimpleArcChannelManager is useful when you need a ChannelManager with a static lifetime, e.g.
360 /// when you're using lightning-net-tokio (since tokio::spawn requires parameters with static
361 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
362 /// SimpleRefChannelManager is the more appropriate type. Defining these type aliases prevents
363 /// issues such as overly long function definitions. Note that the ChannelManager can take any
364 /// type that implements KeysInterface for its keys manager, but this type alias chooses the
365 /// concrete type of the KeysManager.
366 pub type SimpleArcChannelManager<M, T, F, L> = ChannelManager<InMemorySigner, Arc<M>, Arc<T>, Arc<KeysManager>, Arc<F>, Arc<L>>;
368 /// SimpleRefChannelManager is a type alias for a ChannelManager reference, and is the reference
369 /// counterpart to the SimpleArcChannelManager type alias. Use this type by default when you don't
370 /// need a ChannelManager with a static lifetime. You'll need a static lifetime in cases such as
371 /// usage of lightning-net-tokio (since tokio::spawn requires parameters with static lifetimes).
372 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
373 /// helps with issues such as long function definitions. Note that the ChannelManager can take any
374 /// type that implements KeysInterface for its keys manager, but this type alias chooses the
375 /// concrete type of the KeysManager.
376 pub type SimpleRefChannelManager<'a, 'b, 'c, 'd, 'e, M, T, F, L> = ChannelManager<InMemorySigner, &'a M, &'b T, &'c KeysManager, &'d F, &'e L>;
378 /// Manager which keeps track of a number of channels and sends messages to the appropriate
379 /// channel, also tracking HTLC preimages and forwarding onion packets appropriately.
381 /// Implements ChannelMessageHandler, handling the multi-channel parts and passing things through
382 /// to individual Channels.
384 /// Implements Writeable to write out all channel state to disk. Implies peer_disconnected() for
385 /// all peers during write/read (though does not modify this instance, only the instance being
386 /// serialized). This will result in any channels which have not yet exchanged funding_created (ie
387 /// called funding_transaction_generated for outbound channels).
389 /// Note that you can be a bit lazier about writing out ChannelManager than you can be with
390 /// ChannelMonitors. With ChannelMonitors you MUST write each monitor update out to disk before
391 /// returning from chain::Watch::watch_/update_channel, with ChannelManagers, writing updates
392 /// happens out-of-band (and will prevent any other ChannelManager operations from occurring during
393 /// the serialization process). If the deserialized version is out-of-date compared to the
394 /// ChannelMonitors passed by reference to read(), those channels will be force-closed based on the
395 /// ChannelMonitor state and no funds will be lost (mod on-chain transaction fees).
397 /// Note that the deserializer is only implemented for (BlockHash, ChannelManager), which
398 /// tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
399 /// the "reorg path" (ie call block_disconnected() until you get to a common block and then call
400 /// block_connected() to step towards your best block) upon deserialization before using the
403 /// Note that ChannelManager is responsible for tracking liveness of its channels and generating
404 /// ChannelUpdate messages informing peers that the channel is temporarily disabled. To avoid
405 /// spam due to quick disconnection/reconnection, updates are not sent until the channel has been
406 /// offline for a full minute. In order to track this, you must call
407 /// timer_tick_occurred roughly once per minute, though it doesn't have to be perfect.
409 /// Rather than using a plain ChannelManager, it is preferable to use either a SimpleArcChannelManager
410 /// a SimpleRefChannelManager, for conciseness. See their documentation for more details, but
411 /// essentially you should default to using a SimpleRefChannelManager, and use a
412 /// SimpleArcChannelManager when you require a ChannelManager with a static lifetime, such as when
413 /// you're using lightning-net-tokio.
414 pub struct ChannelManager<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
415 where M::Target: chain::Watch<Signer>,
416 T::Target: BroadcasterInterface,
417 K::Target: KeysInterface<Signer = Signer>,
418 F::Target: FeeEstimator,
421 default_configuration: UserConfig,
422 genesis_hash: BlockHash,
428 pub(super) best_block: RwLock<BestBlock>,
430 best_block: RwLock<BestBlock>,
431 secp_ctx: Secp256k1<secp256k1::All>,
433 #[cfg(any(test, feature = "_test_utils"))]
434 pub(super) channel_state: Mutex<ChannelHolder<Signer>>,
435 #[cfg(not(any(test, feature = "_test_utils")))]
436 channel_state: Mutex<ChannelHolder<Signer>>,
438 /// Storage for PaymentSecrets and any requirements on future inbound payments before we will
439 /// expose them to users via a PaymentReceived event. HTLCs which do not meet the requirements
440 /// here are failed when we process them as pending-forwardable-HTLCs, and entries are removed
441 /// after we generate a PaymentReceived upon receipt of all MPP parts or when they time out.
442 /// Locked *after* channel_state.
443 pending_inbound_payments: Mutex<HashMap<PaymentHash, PendingInboundPayment>>,
445 our_network_key: SecretKey,
446 our_network_pubkey: PublicKey,
448 /// Used to track the last value sent in a node_announcement "timestamp" field. We ensure this
449 /// value increases strictly since we don't assume access to a time source.
450 last_node_announcement_serial: AtomicUsize,
452 /// The highest block timestamp we've seen, which is usually a good guess at the current time.
453 /// Assuming most miners are generating blocks with reasonable timestamps, this shouldn't be
454 /// very far in the past, and can only ever be up to two hours in the future.
455 highest_seen_timestamp: AtomicUsize,
457 /// The bulk of our storage will eventually be here (channels and message queues and the like).
458 /// If we are connected to a peer we always at least have an entry here, even if no channels
459 /// are currently open with that peer.
460 /// Because adding or removing an entry is rare, we usually take an outer read lock and then
461 /// operate on the inner value freely. Sadly, this prevents parallel operation when opening a
463 per_peer_state: RwLock<HashMap<PublicKey, Mutex<PeerState>>>,
465 pending_events: Mutex<Vec<events::Event>>,
466 pending_background_events: Mutex<Vec<BackgroundEvent>>,
467 /// Used when we have to take a BIG lock to make sure everything is self-consistent.
468 /// Essentially just when we're serializing ourselves out.
469 /// Taken first everywhere where we are making changes before any other locks.
470 /// When acquiring this lock in read mode, rather than acquiring it directly, call
471 /// `PersistenceNotifierGuard::new(..)` and pass the lock to it, to ensure the PersistenceNotifier
472 /// the lock contains sends out a notification when the lock is released.
473 total_consistency_lock: RwLock<()>,
475 persistence_notifier: PersistenceNotifier,
482 /// Chain-related parameters used to construct a new `ChannelManager`.
484 /// Typically, the block-specific parameters are derived from the best block hash for the network,
485 /// as a newly constructed `ChannelManager` will not have created any channels yet. These parameters
486 /// are not needed when deserializing a previously constructed `ChannelManager`.
487 pub struct ChainParameters {
488 /// The network for determining the `chain_hash` in Lightning messages.
489 pub network: Network,
491 /// The hash and height of the latest block successfully connected.
493 /// Used to track on-chain channel funding outputs and send payments with reliable timelocks.
494 pub best_block: BestBlock,
497 /// The best known block as identified by its hash and height.
498 #[derive(Clone, Copy)]
499 pub struct BestBlock {
500 block_hash: BlockHash,
505 /// Returns the best block from the genesis of the given network.
506 pub fn from_genesis(network: Network) -> Self {
508 block_hash: genesis_block(network).header.block_hash(),
513 /// Returns the best block as identified by the given block hash and height.
514 pub fn new(block_hash: BlockHash, height: u32) -> Self {
515 BestBlock { block_hash, height }
518 /// Returns the best block hash.
519 pub fn block_hash(&self) -> BlockHash { self.block_hash }
521 /// Returns the best block height.
522 pub fn height(&self) -> u32 { self.height }
525 /// Whenever we release the `ChannelManager`'s `total_consistency_lock`, from read mode, it is
526 /// desirable to notify any listeners on `await_persistable_update_timeout`/
527 /// `await_persistable_update` that new updates are available for persistence. Therefore, this
528 /// struct is responsible for locking the total consistency lock and, upon going out of scope,
529 /// sending the aforementioned notification (since the lock being released indicates that the
530 /// updates are ready for persistence).
531 struct PersistenceNotifierGuard<'a> {
532 persistence_notifier: &'a PersistenceNotifier,
533 // We hold onto this result so the lock doesn't get released immediately.
534 _read_guard: RwLockReadGuard<'a, ()>,
537 impl<'a> PersistenceNotifierGuard<'a> {
538 fn new(lock: &'a RwLock<()>, notifier: &'a PersistenceNotifier) -> Self {
539 let read_guard = lock.read().unwrap();
542 persistence_notifier: notifier,
543 _read_guard: read_guard,
548 impl<'a> Drop for PersistenceNotifierGuard<'a> {
550 self.persistence_notifier.notify();
554 /// The amount of time in blocks we require our counterparty wait to claim their money (ie time
555 /// between when we, or our watchtower, must check for them having broadcast a theft transaction).
557 /// This can be increased (but not decreased) through [`ChannelHandshakeConfig::our_to_self_delay`]
559 /// [`ChannelHandshakeConfig::our_to_self_delay`]: crate::util::config::ChannelHandshakeConfig::our_to_self_delay
560 pub const BREAKDOWN_TIMEOUT: u16 = 6 * 24;
561 /// The amount of time in blocks we're willing to wait to claim money back to us. This matches
562 /// the maximum required amount in lnd as of March 2021.
563 pub(crate) const MAX_LOCAL_BREAKDOWN_TIMEOUT: u16 = 2 * 6 * 24 * 7;
565 /// The minimum number of blocks between an inbound HTLC's CLTV and the corresponding outbound
566 /// HTLC's CLTV. The current default represents roughly six hours of blocks at six blocks/hour.
568 /// This can be increased (but not decreased) through [`ChannelConfig::cltv_expiry_delta`]
570 /// [`ChannelConfig::cltv_expiry_delta`]: crate::util::config::ChannelConfig::cltv_expiry_delta
571 // This should always be a few blocks greater than channelmonitor::CLTV_CLAIM_BUFFER,
572 // i.e. the node we forwarded the payment on to should always have enough room to reliably time out
573 // the HTLC via a full update_fail_htlc/commitment_signed dance before we hit the
574 // CLTV_CLAIM_BUFFER point (we static assert that it's at least 3 blocks more).
575 pub const MIN_CLTV_EXPIRY_DELTA: u16 = 6 * 6;
576 pub(super) const CLTV_FAR_FAR_AWAY: u32 = 6 * 24 * 7; //TODO?
578 /// Minimum CLTV difference between the current block height and received inbound payments.
579 /// Invoices generated for payment to us must set their `min_final_cltv_expiry` field to at least
581 pub const MIN_FINAL_CLTV_EXPIRY: u32 = HTLC_FAIL_BACK_BUFFER;
583 // Check that our CLTV_EXPIRY is at least CLTV_CLAIM_BUFFER + ANTI_REORG_DELAY + LATENCY_GRACE_PERIOD_BLOCKS,
584 // ie that if the next-hop peer fails the HTLC within
585 // LATENCY_GRACE_PERIOD_BLOCKS then we'll still have CLTV_CLAIM_BUFFER left to timeout it onchain,
586 // then waiting ANTI_REORG_DELAY to be reorg-safe on the outbound HLTC and
587 // failing the corresponding htlc backward, and us now seeing the last block of ANTI_REORG_DELAY before
588 // LATENCY_GRACE_PERIOD_BLOCKS.
591 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;
593 // Check for ability of an attacker to make us fail on-chain by delaying inbound claim. See
594 // ChannelMontior::would_broadcast_at_height for a description of why this is needed.
597 const CHECK_CLTV_EXPIRY_SANITY_2: u32 = MIN_CLTV_EXPIRY_DELTA as u32 - LATENCY_GRACE_PERIOD_BLOCKS - 2*CLTV_CLAIM_BUFFER;
599 /// Details of a channel, as returned by ChannelManager::list_channels and ChannelManager::list_usable_channels
601 pub struct ChannelDetails {
602 /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
603 /// thereafter this is the txid of the funding transaction xor the funding transaction output).
604 /// Note that this means this value is *not* persistent - it can change once during the
605 /// lifetime of the channel.
606 pub channel_id: [u8; 32],
607 /// The Channel's funding transaction output, if we've negotiated the funding transaction with
608 /// our counterparty already.
610 /// Note that, if this has been set, `channel_id` will be equivalent to
611 /// `funding_txo.unwrap().to_channel_id()`.
612 pub funding_txo: Option<OutPoint>,
613 /// The position of the funding transaction in the chain. None if the funding transaction has
614 /// not yet been confirmed and the channel fully opened.
615 pub short_channel_id: Option<u64>,
616 /// The node_id of our counterparty
617 pub remote_network_id: PublicKey,
618 /// The Features the channel counterparty provided upon last connection.
619 /// Useful for routing as it is the most up-to-date copy of the counterparty's features and
620 /// many routing-relevant features are present in the init context.
621 pub counterparty_features: InitFeatures,
622 /// The value, in satoshis, of this channel as appears in the funding output
623 pub channel_value_satoshis: u64,
624 /// The user_id passed in to create_channel, or 0 if the channel was inbound.
626 /// The available outbound capacity for sending HTLCs to the remote peer. This does not include
627 /// any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
628 /// available for inclusion in new outbound HTLCs). This further does not include any pending
629 /// outgoing HTLCs which are awaiting some other resolution to be sent.
630 pub outbound_capacity_msat: u64,
631 /// The available inbound capacity for the remote peer to send HTLCs to us. This does not
632 /// include any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
633 /// available for inclusion in new inbound HTLCs).
634 /// Note that there are some corner cases not fully handled here, so the actual available
635 /// inbound capacity may be slightly higher than this.
636 pub inbound_capacity_msat: u64,
637 /// True if the channel was initiated (and thus funded) by us.
638 pub is_outbound: bool,
639 /// True if the channel is confirmed, funding_locked messages have been exchanged, and the
640 /// channel is not currently being shut down. `funding_locked` message exchange implies the
641 /// required confirmation count has been reached (and we were connected to the peer at some
642 /// point after the funding transaction received enough confirmations).
643 pub is_funding_locked: bool,
644 /// True if the channel is (a) confirmed and funding_locked messages have been exchanged, (b)
645 /// the peer is connected, (c) no monitor update failure is pending resolution, and (d) the
646 /// channel is not currently negotiating a shutdown.
648 /// This is a strict superset of `is_funding_locked`.
650 /// True if this channel is (or will be) publicly-announced.
652 /// Information on the fees and requirements that the counterparty requires when forwarding
653 /// payments to us through this channel.
654 pub counterparty_forwarding_info: Option<CounterpartyForwardingInfo>,
657 /// If a payment fails to send, it can be in one of several states. This enum is returned as the
658 /// Err() type describing which state the payment is in, see the description of individual enum
660 #[derive(Clone, Debug)]
661 pub enum PaymentSendFailure {
662 /// A parameter which was passed to send_payment was invalid, preventing us from attempting to
663 /// send the payment at all. No channel state has been changed or messages sent to peers, and
664 /// once you've changed the parameter at error, you can freely retry the payment in full.
665 ParameterError(APIError),
666 /// A parameter in a single path which was passed to send_payment was invalid, preventing us
667 /// from attempting to send the payment at all. No channel state has been changed or messages
668 /// sent to peers, and once you've changed the parameter at error, you can freely retry the
671 /// The results here are ordered the same as the paths in the route object which was passed to
673 PathParameterError(Vec<Result<(), APIError>>),
674 /// All paths which were attempted failed to send, with no channel state change taking place.
675 /// You can freely retry the payment in full (though you probably want to do so over different
676 /// paths than the ones selected).
677 AllFailedRetrySafe(Vec<APIError>),
678 /// Some paths which were attempted failed to send, though possibly not all. At least some
679 /// paths have irrevocably committed to the HTLC and retrying the payment in full would result
680 /// in over-/re-payment.
682 /// The results here are ordered the same as the paths in the route object which was passed to
683 /// send_payment, and any Errs which are not APIError::MonitorUpdateFailed can be safely
684 /// retried (though there is currently no API with which to do so).
686 /// Any entries which contain Err(APIError::MonitorUpdateFailed) or Ok(()) MUST NOT be retried
687 /// as they will result in over-/re-payment. These HTLCs all either successfully sent (in the
688 /// case of Ok(())) or will send once channel_monitor_updated is called on the next-hop channel
689 /// with the latest update_id.
690 PartialFailure(Vec<Result<(), APIError>>),
693 macro_rules! handle_error {
694 ($self: ident, $internal: expr, $counterparty_node_id: expr) => {
697 Err(MsgHandleErrInternal { err, shutdown_finish }) => {
698 #[cfg(debug_assertions)]
700 // In testing, ensure there are no deadlocks where the lock is already held upon
701 // entering the macro.
702 assert!($self.channel_state.try_lock().is_ok());
705 let mut msg_events = Vec::with_capacity(2);
707 if let Some((shutdown_res, update_option)) = shutdown_finish {
708 $self.finish_force_close_channel(shutdown_res);
709 if let Some(update) = update_option {
710 msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
716 log_error!($self.logger, "{}", err.err);
717 if let msgs::ErrorAction::IgnoreError = err.action {
719 msg_events.push(events::MessageSendEvent::HandleError {
720 node_id: $counterparty_node_id,
721 action: err.action.clone()
725 if !msg_events.is_empty() {
726 $self.channel_state.lock().unwrap().pending_msg_events.append(&mut msg_events);
729 // Return error in case higher-API need one
736 macro_rules! break_chan_entry {
737 ($self: ident, $res: expr, $channel_state: expr, $entry: expr) => {
740 Err(ChannelError::Ignore(msg)) => {
741 break Err(MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore(msg), $entry.key().clone()))
743 Err(ChannelError::Close(msg)) => {
744 log_trace!($self.logger, "Closing channel {} due to Close-required error: {}", log_bytes!($entry.key()[..]), msg);
745 let (channel_id, mut chan) = $entry.remove_entry();
746 if let Some(short_id) = chan.get_short_channel_id() {
747 $channel_state.short_to_id.remove(&short_id);
749 break Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, chan.force_shutdown(true), $self.get_channel_update(&chan).ok()))
751 Err(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"); }
756 macro_rules! try_chan_entry {
757 ($self: ident, $res: expr, $channel_state: expr, $entry: expr) => {
760 Err(ChannelError::Ignore(msg)) => {
761 return Err(MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore(msg), $entry.key().clone()))
763 Err(ChannelError::Close(msg)) => {
764 log_trace!($self.logger, "Closing channel {} due to Close-required error: {}", log_bytes!($entry.key()[..]), msg);
765 let (channel_id, mut chan) = $entry.remove_entry();
766 if let Some(short_id) = chan.get_short_channel_id() {
767 $channel_state.short_to_id.remove(&short_id);
769 return Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, chan.force_shutdown(true), $self.get_channel_update(&chan).ok()))
771 Err(ChannelError::CloseDelayBroadcast(msg)) => {
772 log_error!($self.logger, "Channel {} need to be shutdown but closing transactions not broadcast due to {}", log_bytes!($entry.key()[..]), msg);
773 let (channel_id, mut chan) = $entry.remove_entry();
774 if let Some(short_id) = chan.get_short_channel_id() {
775 $channel_state.short_to_id.remove(&short_id);
777 let shutdown_res = chan.force_shutdown(false);
778 return Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, shutdown_res, $self.get_channel_update(&chan).ok()))
784 macro_rules! handle_monitor_err {
785 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
786 handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment, Vec::new(), Vec::new())
788 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr, $failed_forwards: expr, $failed_fails: expr) => {
790 ChannelMonitorUpdateErr::PermanentFailure => {
791 log_error!($self.logger, "Closing channel {} due to monitor update PermanentFailure", log_bytes!($entry.key()[..]));
792 let (channel_id, mut chan) = $entry.remove_entry();
793 if let Some(short_id) = chan.get_short_channel_id() {
794 $channel_state.short_to_id.remove(&short_id);
796 // TODO: $failed_fails is dropped here, which will cause other channels to hit the
797 // chain in a confused state! We need to move them into the ChannelMonitor which
798 // will be responsible for failing backwards once things confirm on-chain.
799 // It's ok that we drop $failed_forwards here - at this point we'd rather they
800 // broadcast HTLC-Timeout and pay the associated fees to get their funds back than
801 // us bother trying to claim it just to forward on to another peer. If we're
802 // splitting hairs we'd prefer to claim payments that were to us, but we haven't
803 // given up the preimage yet, so might as well just wait until the payment is
804 // retried, avoiding the on-chain fees.
805 let res: Result<(), _> = Err(MsgHandleErrInternal::from_finish_shutdown("ChannelMonitor storage failure".to_owned(), channel_id, chan.force_shutdown(true), $self.get_channel_update(&chan).ok()));
808 ChannelMonitorUpdateErr::TemporaryFailure => {
809 log_info!($self.logger, "Disabling channel {} due to monitor update TemporaryFailure. On restore will send {} and process {} forwards and {} fails",
810 log_bytes!($entry.key()[..]),
811 if $resend_commitment && $resend_raa {
813 RAACommitmentOrder::CommitmentFirst => { "commitment then RAA" },
814 RAACommitmentOrder::RevokeAndACKFirst => { "RAA then commitment" },
816 } else if $resend_commitment { "commitment" }
817 else if $resend_raa { "RAA" }
819 (&$failed_forwards as &Vec<(PendingHTLCInfo, u64)>).len(),
820 (&$failed_fails as &Vec<(HTLCSource, PaymentHash, HTLCFailReason)>).len());
821 if !$resend_commitment {
822 debug_assert!($action_type == RAACommitmentOrder::RevokeAndACKFirst || !$resend_raa);
825 debug_assert!($action_type == RAACommitmentOrder::CommitmentFirst || !$resend_commitment);
827 $entry.get_mut().monitor_update_failed($resend_raa, $resend_commitment, $failed_forwards, $failed_fails);
828 Err(MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore("Failed to update ChannelMonitor".to_owned()), *$entry.key()))
834 macro_rules! return_monitor_err {
835 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
836 return handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment);
838 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr, $failed_forwards: expr, $failed_fails: expr) => {
839 return handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment, $failed_forwards, $failed_fails);
843 // Does not break in case of TemporaryFailure!
844 macro_rules! maybe_break_monitor_err {
845 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
846 match (handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment), $err) {
847 (e, ChannelMonitorUpdateErr::PermanentFailure) => {
850 (_, ChannelMonitorUpdateErr::TemporaryFailure) => { },
855 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<Signer, M, T, K, F, L>
856 where M::Target: chain::Watch<Signer>,
857 T::Target: BroadcasterInterface,
858 K::Target: KeysInterface<Signer = Signer>,
859 F::Target: FeeEstimator,
862 /// Constructs a new ChannelManager to hold several channels and route between them.
864 /// This is the main "logic hub" for all channel-related actions, and implements
865 /// ChannelMessageHandler.
867 /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
869 /// panics if channel_value_satoshis is >= `MAX_FUNDING_SATOSHIS`!
871 /// Users need to notify the new ChannelManager when a new block is connected or
872 /// disconnected using its `block_connected` and `block_disconnected` methods, starting
873 /// from after `params.latest_hash`.
874 pub fn new(fee_est: F, chain_monitor: M, tx_broadcaster: T, logger: L, keys_manager: K, config: UserConfig, params: ChainParameters) -> Self {
875 let mut secp_ctx = Secp256k1::new();
876 secp_ctx.seeded_randomize(&keys_manager.get_secure_random_bytes());
879 default_configuration: config.clone(),
880 genesis_hash: genesis_block(params.network).header.block_hash(),
881 fee_estimator: fee_est,
885 best_block: RwLock::new(params.best_block),
887 channel_state: Mutex::new(ChannelHolder{
888 by_id: HashMap::new(),
889 short_to_id: HashMap::new(),
890 forward_htlcs: HashMap::new(),
891 claimable_htlcs: HashMap::new(),
892 pending_msg_events: Vec::new(),
894 pending_inbound_payments: Mutex::new(HashMap::new()),
896 our_network_key: keys_manager.get_node_secret(),
897 our_network_pubkey: PublicKey::from_secret_key(&secp_ctx, &keys_manager.get_node_secret()),
900 last_node_announcement_serial: AtomicUsize::new(0),
901 highest_seen_timestamp: AtomicUsize::new(0),
903 per_peer_state: RwLock::new(HashMap::new()),
905 pending_events: Mutex::new(Vec::new()),
906 pending_background_events: Mutex::new(Vec::new()),
907 total_consistency_lock: RwLock::new(()),
908 persistence_notifier: PersistenceNotifier::new(),
916 /// Gets the current configuration applied to all new channels, as
917 pub fn get_current_default_configuration(&self) -> &UserConfig {
918 &self.default_configuration
921 /// Creates a new outbound channel to the given remote node and with the given value.
923 /// user_id will be provided back as user_channel_id in FundingGenerationReady events to allow
924 /// tracking of which events correspond with which create_channel call. Note that the
925 /// user_channel_id defaults to 0 for inbound channels, so you may wish to avoid using 0 for
926 /// user_id here. user_id has no meaning inside of LDK, it is simply copied to events and
927 /// otherwise ignored.
929 /// If successful, will generate a SendOpenChannel message event, so you should probably poll
930 /// PeerManager::process_events afterwards.
932 /// Raises APIError::APIMisuseError when channel_value_satoshis > 2**24 or push_msat is
933 /// greater than channel_value_satoshis * 1k or channel_value_satoshis is < 1000.
934 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> {
935 if channel_value_satoshis < 1000 {
936 return Err(APIError::APIMisuseError { err: format!("Channel value must be at least 1000 satoshis. It was {}", channel_value_satoshis) });
939 let config = if override_config.is_some() { override_config.as_ref().unwrap() } else { &self.default_configuration };
940 let channel = Channel::new_outbound(&self.fee_estimator, &self.keys_manager, their_network_key, channel_value_satoshis, push_msat, user_id, config)?;
941 let res = channel.get_open_channel(self.genesis_hash.clone());
943 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
944 // We want to make sure the lock is actually acquired by PersistenceNotifierGuard.
945 debug_assert!(&self.total_consistency_lock.try_write().is_err());
947 let mut channel_state = self.channel_state.lock().unwrap();
948 match channel_state.by_id.entry(channel.channel_id()) {
949 hash_map::Entry::Occupied(_) => {
950 if cfg!(feature = "fuzztarget") {
951 return Err(APIError::APIMisuseError { err: "Fuzzy bad RNG".to_owned() });
953 panic!("RNG is bad???");
956 hash_map::Entry::Vacant(entry) => { entry.insert(channel); }
958 channel_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
959 node_id: their_network_key,
965 fn list_channels_with_filter<Fn: FnMut(&(&[u8; 32], &Channel<Signer>)) -> bool>(&self, f: Fn) -> Vec<ChannelDetails> {
966 let mut res = Vec::new();
968 let channel_state = self.channel_state.lock().unwrap();
969 res.reserve(channel_state.by_id.len());
970 for (channel_id, channel) in channel_state.by_id.iter().filter(f) {
971 let (inbound_capacity_msat, outbound_capacity_msat) = channel.get_inbound_outbound_available_balance_msat();
972 res.push(ChannelDetails {
973 channel_id: (*channel_id).clone(),
974 funding_txo: channel.get_funding_txo(),
975 short_channel_id: channel.get_short_channel_id(),
976 remote_network_id: channel.get_counterparty_node_id(),
977 counterparty_features: InitFeatures::empty(),
978 channel_value_satoshis: channel.get_value_satoshis(),
979 inbound_capacity_msat,
980 outbound_capacity_msat,
981 user_id: channel.get_user_id(),
982 is_outbound: channel.is_outbound(),
983 is_funding_locked: channel.is_usable(),
984 is_usable: channel.is_live(),
985 is_public: channel.should_announce(),
986 counterparty_forwarding_info: channel.counterparty_forwarding_info(),
990 let per_peer_state = self.per_peer_state.read().unwrap();
991 for chan in res.iter_mut() {
992 if let Some(peer_state) = per_peer_state.get(&chan.remote_network_id) {
993 chan.counterparty_features = peer_state.lock().unwrap().latest_features.clone();
999 /// Gets the list of open channels, in random order. See ChannelDetail field documentation for
1000 /// more information.
1001 pub fn list_channels(&self) -> Vec<ChannelDetails> {
1002 self.list_channels_with_filter(|_| true)
1005 /// Gets the list of usable channels, in random order. Useful as an argument to
1006 /// get_route to ensure non-announced channels are used.
1008 /// These are guaranteed to have their [`ChannelDetails::is_usable`] value set to true, see the
1009 /// documentation for [`ChannelDetails::is_usable`] for more info on exactly what the criteria
1011 pub fn list_usable_channels(&self) -> Vec<ChannelDetails> {
1012 // Note we use is_live here instead of usable which leads to somewhat confused
1013 // internal/external nomenclature, but that's ok cause that's probably what the user
1014 // really wanted anyway.
1015 self.list_channels_with_filter(|&(_, ref channel)| channel.is_live())
1018 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
1019 /// will be accepted on the given channel, and after additional timeout/the closing of all
1020 /// pending HTLCs, the channel will be closed on chain.
1022 /// May generate a SendShutdown message event on success, which should be relayed.
1023 pub fn close_channel(&self, channel_id: &[u8; 32]) -> Result<(), APIError> {
1024 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
1026 let (mut failed_htlcs, chan_option) = {
1027 let mut channel_state_lock = self.channel_state.lock().unwrap();
1028 let channel_state = &mut *channel_state_lock;
1029 match channel_state.by_id.entry(channel_id.clone()) {
1030 hash_map::Entry::Occupied(mut chan_entry) => {
1031 let (shutdown_msg, failed_htlcs) = chan_entry.get_mut().get_shutdown()?;
1032 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
1033 node_id: chan_entry.get().get_counterparty_node_id(),
1036 if chan_entry.get().is_shutdown() {
1037 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
1038 channel_state.short_to_id.remove(&short_id);
1040 (failed_htlcs, Some(chan_entry.remove_entry().1))
1041 } else { (failed_htlcs, None) }
1043 hash_map::Entry::Vacant(_) => return Err(APIError::ChannelUnavailable{err: "No such channel".to_owned()})
1046 for htlc_source in failed_htlcs.drain(..) {
1047 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() });
1049 let chan_update = if let Some(chan) = chan_option {
1050 if let Ok(update) = self.get_channel_update(&chan) {
1055 if let Some(update) = chan_update {
1056 let mut channel_state = self.channel_state.lock().unwrap();
1057 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1066 fn finish_force_close_channel(&self, shutdown_res: ShutdownResult) {
1067 let (monitor_update_option, mut failed_htlcs) = shutdown_res;
1068 log_trace!(self.logger, "Finishing force-closure of channel {} HTLCs to fail", failed_htlcs.len());
1069 for htlc_source in failed_htlcs.drain(..) {
1070 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() });
1072 if let Some((funding_txo, monitor_update)) = monitor_update_option {
1073 // There isn't anything we can do if we get an update failure - we're already
1074 // force-closing. The monitor update on the required in-memory copy should broadcast
1075 // the latest local state, which is the best we can do anyway. Thus, it is safe to
1076 // ignore the result here.
1077 let _ = self.chain_monitor.update_channel(funding_txo, monitor_update);
1081 fn force_close_channel_with_peer(&self, channel_id: &[u8; 32], peer_node_id: Option<&PublicKey>) -> Result<PublicKey, APIError> {
1083 let mut channel_state_lock = self.channel_state.lock().unwrap();
1084 let channel_state = &mut *channel_state_lock;
1085 if let hash_map::Entry::Occupied(chan) = channel_state.by_id.entry(channel_id.clone()) {
1086 if let Some(node_id) = peer_node_id {
1087 if chan.get().get_counterparty_node_id() != *node_id {
1088 return Err(APIError::ChannelUnavailable{err: "No such channel".to_owned()});
1091 if let Some(short_id) = chan.get().get_short_channel_id() {
1092 channel_state.short_to_id.remove(&short_id);
1094 chan.remove_entry().1
1096 return Err(APIError::ChannelUnavailable{err: "No such channel".to_owned()});
1099 log_trace!(self.logger, "Force-closing channel {}", log_bytes!(channel_id[..]));
1100 self.finish_force_close_channel(chan.force_shutdown(true));
1101 if let Ok(update) = self.get_channel_update(&chan) {
1102 let mut channel_state = self.channel_state.lock().unwrap();
1103 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1108 Ok(chan.get_counterparty_node_id())
1111 /// Force closes a channel, immediately broadcasting the latest local commitment transaction to
1112 /// the chain and rejecting new HTLCs on the given channel. Fails if channel_id is unknown to the manager.
1113 pub fn force_close_channel(&self, channel_id: &[u8; 32]) -> Result<(), APIError> {
1114 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
1115 match self.force_close_channel_with_peer(channel_id, None) {
1116 Ok(counterparty_node_id) => {
1117 self.channel_state.lock().unwrap().pending_msg_events.push(
1118 events::MessageSendEvent::HandleError {
1119 node_id: counterparty_node_id,
1120 action: msgs::ErrorAction::SendErrorMessage {
1121 msg: msgs::ErrorMessage { channel_id: *channel_id, data: "Channel force-closed".to_owned() }
1131 /// Force close all channels, immediately broadcasting the latest local commitment transaction
1132 /// for each to the chain and rejecting new HTLCs on each.
1133 pub fn force_close_all_channels(&self) {
1134 for chan in self.list_channels() {
1135 let _ = self.force_close_channel(&chan.channel_id);
1139 fn decode_update_add_htlc_onion(&self, msg: &msgs::UpdateAddHTLC) -> (PendingHTLCStatus, MutexGuard<ChannelHolder<Signer>>) {
1140 macro_rules! return_malformed_err {
1141 ($msg: expr, $err_code: expr) => {
1143 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
1144 return (PendingHTLCStatus::Fail(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
1145 channel_id: msg.channel_id,
1146 htlc_id: msg.htlc_id,
1147 sha256_of_onion: Sha256::hash(&msg.onion_routing_packet.hop_data).into_inner(),
1148 failure_code: $err_code,
1149 })), self.channel_state.lock().unwrap());
1154 if let Err(_) = msg.onion_routing_packet.public_key {
1155 return_malformed_err!("invalid ephemeral pubkey", 0x8000 | 0x4000 | 6);
1158 let shared_secret = {
1159 let mut arr = [0; 32];
1160 arr.copy_from_slice(&SharedSecret::new(&msg.onion_routing_packet.public_key.unwrap(), &self.our_network_key)[..]);
1163 let (rho, mu) = onion_utils::gen_rho_mu_from_shared_secret(&shared_secret);
1165 if msg.onion_routing_packet.version != 0 {
1166 //TODO: Spec doesn't indicate if we should only hash hop_data here (and in other
1167 //sha256_of_onion error data packets), or the entire onion_routing_packet. Either way,
1168 //the hash doesn't really serve any purpose - in the case of hashing all data, the
1169 //receiving node would have to brute force to figure out which version was put in the
1170 //packet by the node that send us the message, in the case of hashing the hop_data, the
1171 //node knows the HMAC matched, so they already know what is there...
1172 return_malformed_err!("Unknown onion packet version", 0x8000 | 0x4000 | 4);
1175 let mut hmac = HmacEngine::<Sha256>::new(&mu);
1176 hmac.input(&msg.onion_routing_packet.hop_data);
1177 hmac.input(&msg.payment_hash.0[..]);
1178 if !fixed_time_eq(&Hmac::from_engine(hmac).into_inner(), &msg.onion_routing_packet.hmac) {
1179 return_malformed_err!("HMAC Check failed", 0x8000 | 0x4000 | 5);
1182 let mut channel_state = None;
1183 macro_rules! return_err {
1184 ($msg: expr, $err_code: expr, $data: expr) => {
1186 log_info!(self.logger, "Failed to accept/forward incoming HTLC: {}", $msg);
1187 if channel_state.is_none() {
1188 channel_state = Some(self.channel_state.lock().unwrap());
1190 return (PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
1191 channel_id: msg.channel_id,
1192 htlc_id: msg.htlc_id,
1193 reason: onion_utils::build_first_hop_failure_packet(&shared_secret, $err_code, $data),
1194 })), channel_state.unwrap());
1199 let mut chacha = ChaCha20::new(&rho, &[0u8; 8]);
1200 let mut chacha_stream = ChaChaReader { chacha: &mut chacha, read: Cursor::new(&msg.onion_routing_packet.hop_data[..]) };
1201 let (next_hop_data, next_hop_hmac) = {
1202 match msgs::OnionHopData::read(&mut chacha_stream) {
1204 let error_code = match err {
1205 msgs::DecodeError::UnknownVersion => 0x4000 | 1, // unknown realm byte
1206 msgs::DecodeError::UnknownRequiredFeature|
1207 msgs::DecodeError::InvalidValue|
1208 msgs::DecodeError::ShortRead => 0x4000 | 22, // invalid_onion_payload
1209 _ => 0x2000 | 2, // Should never happen
1211 return_err!("Unable to decode our hop data", error_code, &[0;0]);
1214 let mut hmac = [0; 32];
1215 if let Err(_) = chacha_stream.read_exact(&mut hmac[..]) {
1216 return_err!("Unable to decode hop data", 0x4000 | 22, &[0;0]);
1223 let pending_forward_info = if next_hop_hmac == [0; 32] {
1226 // In tests, make sure that the initial onion pcket data is, at least, non-0.
1227 // We could do some fancy randomness test here, but, ehh, whatever.
1228 // This checks for the issue where you can calculate the path length given the
1229 // onion data as all the path entries that the originator sent will be here
1230 // as-is (and were originally 0s).
1231 // Of course reverse path calculation is still pretty easy given naive routing
1232 // algorithms, but this fixes the most-obvious case.
1233 let mut next_bytes = [0; 32];
1234 chacha_stream.read_exact(&mut next_bytes).unwrap();
1235 assert_ne!(next_bytes[..], [0; 32][..]);
1236 chacha_stream.read_exact(&mut next_bytes).unwrap();
1237 assert_ne!(next_bytes[..], [0; 32][..]);
1241 // final_expiry_too_soon
1242 // We have to have some headroom to broadcast on chain if we have the preimage, so make sure we have at least
1243 // HTLC_FAIL_BACK_BUFFER blocks to go.
1244 // Also, ensure that, in the case of an unknown payment hash, our payment logic has enough time to fail the HTLC backward
1245 // before our onchain logic triggers a channel closure (see HTLC_FAIL_BACK_BUFFER rational).
1246 if (msg.cltv_expiry as u64) <= self.best_block.read().unwrap().height() as u64 + HTLC_FAIL_BACK_BUFFER as u64 + 1 {
1247 return_err!("The final CLTV expiry is too soon to handle", 17, &[0;0]);
1249 // final_incorrect_htlc_amount
1250 if next_hop_data.amt_to_forward > msg.amount_msat {
1251 return_err!("Upstream node sent less than we were supposed to receive in payment", 19, &byte_utils::be64_to_array(msg.amount_msat));
1253 // final_incorrect_cltv_expiry
1254 if next_hop_data.outgoing_cltv_value != msg.cltv_expiry {
1255 return_err!("Upstream node set CLTV to the wrong value", 18, &byte_utils::be32_to_array(msg.cltv_expiry));
1258 let payment_data = match next_hop_data.format {
1259 msgs::OnionHopDataFormat::Legacy { .. } => None,
1260 msgs::OnionHopDataFormat::NonFinalNode { .. } => return_err!("Got non final data with an HMAC of 0", 0x4000 | 22, &[0;0]),
1261 msgs::OnionHopDataFormat::FinalNode { payment_data } => payment_data,
1264 if payment_data.is_none() {
1265 return_err!("We require payment_secrets", 0x4000|0x2000|3, &[0;0]);
1268 // Note that we could obviously respond immediately with an update_fulfill_htlc
1269 // message, however that would leak that we are the recipient of this payment, so
1270 // instead we stay symmetric with the forwarding case, only responding (after a
1271 // delay) once they've send us a commitment_signed!
1273 PendingHTLCStatus::Forward(PendingHTLCInfo {
1274 routing: PendingHTLCRouting::Receive {
1275 payment_data: payment_data.unwrap(),
1276 incoming_cltv_expiry: msg.cltv_expiry,
1278 payment_hash: msg.payment_hash.clone(),
1279 incoming_shared_secret: shared_secret,
1280 amt_to_forward: next_hop_data.amt_to_forward,
1281 outgoing_cltv_value: next_hop_data.outgoing_cltv_value,
1284 let mut new_packet_data = [0; 20*65];
1285 let read_pos = chacha_stream.read(&mut new_packet_data).unwrap();
1286 #[cfg(debug_assertions)]
1288 // Check two things:
1289 // a) that the behavior of our stream here will return Ok(0) even if the TLV
1290 // read above emptied out our buffer and the unwrap() wont needlessly panic
1291 // b) that we didn't somehow magically end up with extra data.
1293 debug_assert!(chacha_stream.read(&mut t).unwrap() == 0);
1295 // Once we've emptied the set of bytes our peer gave us, encrypt 0 bytes until we
1296 // fill the onion hop data we'll forward to our next-hop peer.
1297 chacha_stream.chacha.process_in_place(&mut new_packet_data[read_pos..]);
1299 let mut new_pubkey = msg.onion_routing_packet.public_key.unwrap();
1301 let blinding_factor = {
1302 let mut sha = Sha256::engine();
1303 sha.input(&new_pubkey.serialize()[..]);
1304 sha.input(&shared_secret);
1305 Sha256::from_engine(sha).into_inner()
1308 let public_key = if let Err(e) = new_pubkey.mul_assign(&self.secp_ctx, &blinding_factor[..]) {
1310 } else { Ok(new_pubkey) };
1312 let outgoing_packet = msgs::OnionPacket {
1315 hop_data: new_packet_data,
1316 hmac: next_hop_hmac.clone(),
1319 let short_channel_id = match next_hop_data.format {
1320 msgs::OnionHopDataFormat::Legacy { short_channel_id } => short_channel_id,
1321 msgs::OnionHopDataFormat::NonFinalNode { short_channel_id } => short_channel_id,
1322 msgs::OnionHopDataFormat::FinalNode { .. } => {
1323 return_err!("Final Node OnionHopData provided for us as an intermediary node", 0x4000 | 22, &[0;0]);
1327 PendingHTLCStatus::Forward(PendingHTLCInfo {
1328 routing: PendingHTLCRouting::Forward {
1329 onion_packet: outgoing_packet,
1332 payment_hash: msg.payment_hash.clone(),
1333 incoming_shared_secret: shared_secret,
1334 amt_to_forward: next_hop_data.amt_to_forward,
1335 outgoing_cltv_value: next_hop_data.outgoing_cltv_value,
1339 channel_state = Some(self.channel_state.lock().unwrap());
1340 if let &PendingHTLCStatus::Forward(PendingHTLCInfo { ref routing, ref amt_to_forward, ref outgoing_cltv_value, .. }) = &pending_forward_info {
1341 // If short_channel_id is 0 here, we'll reject the HTLC as there cannot be a channel
1342 // with a short_channel_id of 0. This is important as various things later assume
1343 // short_channel_id is non-0 in any ::Forward.
1344 if let &PendingHTLCRouting::Forward { ref short_channel_id, .. } = routing {
1345 let id_option = channel_state.as_ref().unwrap().short_to_id.get(&short_channel_id).cloned();
1346 let forwarding_id = match id_option {
1347 None => { // unknown_next_peer
1348 return_err!("Don't have available channel for forwarding as requested.", 0x4000 | 10, &[0;0]);
1350 Some(id) => id.clone(),
1352 if let Some((err, code, chan_update)) = loop {
1353 let chan = channel_state.as_mut().unwrap().by_id.get_mut(&forwarding_id).unwrap();
1355 // Note that we could technically not return an error yet here and just hope
1356 // that the connection is reestablished or monitor updated by the time we get
1357 // around to doing the actual forward, but better to fail early if we can and
1358 // hopefully an attacker trying to path-trace payments cannot make this occur
1359 // on a small/per-node/per-channel scale.
1360 if !chan.is_live() { // channel_disabled
1361 break Some(("Forwarding channel is not in a ready state.", 0x1000 | 20, Some(self.get_channel_update(chan).unwrap())));
1363 if *amt_to_forward < chan.get_counterparty_htlc_minimum_msat() { // amount_below_minimum
1364 break Some(("HTLC amount was below the htlc_minimum_msat", 0x1000 | 11, Some(self.get_channel_update(chan).unwrap())));
1366 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) });
1367 if fee.is_none() || msg.amount_msat < fee.unwrap() || (msg.amount_msat - fee.unwrap()) < *amt_to_forward { // fee_insufficient
1368 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())));
1370 if (msg.cltv_expiry as u64) < (*outgoing_cltv_value) as u64 + chan.get_cltv_expiry_delta() as u64 { // incorrect_cltv_expiry
1371 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())));
1373 let cur_height = self.best_block.read().unwrap().height() + 1;
1374 // Theoretically, channel counterparty shouldn't send us a HTLC expiring now, but we want to be robust wrt to counterparty
1375 // packet sanitization (see HTLC_FAIL_BACK_BUFFER rational)
1376 if msg.cltv_expiry <= cur_height + HTLC_FAIL_BACK_BUFFER as u32 { // expiry_too_soon
1377 break Some(("CLTV expiry is too close", 0x1000 | 14, Some(self.get_channel_update(chan).unwrap())));
1379 if msg.cltv_expiry > cur_height + CLTV_FAR_FAR_AWAY as u32 { // expiry_too_far
1380 break Some(("CLTV expiry is too far in the future", 21, None));
1382 // In theory, we would be safe against unitentional channel-closure, if we only required a margin of LATENCY_GRACE_PERIOD_BLOCKS.
1383 // But, to be safe against policy reception, we use a longuer delay.
1384 if (*outgoing_cltv_value) as u64 <= (cur_height + HTLC_FAIL_BACK_BUFFER) as u64 {
1385 break Some(("Outgoing CLTV value is too soon", 0x1000 | 14, Some(self.get_channel_update(chan).unwrap())));
1391 let mut res = Vec::with_capacity(8 + 128);
1392 if let Some(chan_update) = chan_update {
1393 if code == 0x1000 | 11 || code == 0x1000 | 12 {
1394 res.extend_from_slice(&byte_utils::be64_to_array(msg.amount_msat));
1396 else if code == 0x1000 | 13 {
1397 res.extend_from_slice(&byte_utils::be32_to_array(msg.cltv_expiry));
1399 else if code == 0x1000 | 20 {
1400 // TODO: underspecified, follow https://github.com/lightningnetwork/lightning-rfc/issues/791
1401 res.extend_from_slice(&byte_utils::be16_to_array(0));
1403 res.extend_from_slice(&chan_update.encode_with_len()[..]);
1405 return_err!(err, code, &res[..]);
1410 (pending_forward_info, channel_state.unwrap())
1413 /// only fails if the channel does not yet have an assigned short_id
1414 /// May be called with channel_state already locked!
1415 fn get_channel_update(&self, chan: &Channel<Signer>) -> Result<msgs::ChannelUpdate, LightningError> {
1416 let short_channel_id = match chan.get_short_channel_id() {
1417 None => return Err(LightningError{err: "Channel not yet established".to_owned(), action: msgs::ErrorAction::IgnoreError}),
1421 let were_node_one = PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key).serialize()[..] < chan.get_counterparty_node_id().serialize()[..];
1423 let unsigned = msgs::UnsignedChannelUpdate {
1424 chain_hash: self.genesis_hash,
1426 timestamp: chan.get_update_time_counter(),
1427 flags: (!were_node_one) as u8 | ((!chan.is_live() as u8) << 1),
1428 cltv_expiry_delta: chan.get_cltv_expiry_delta(),
1429 htlc_minimum_msat: chan.get_counterparty_htlc_minimum_msat(),
1430 htlc_maximum_msat: OptionalField::Present(chan.get_announced_htlc_max_msat()),
1431 fee_base_msat: chan.get_holder_fee_base_msat(&self.fee_estimator),
1432 fee_proportional_millionths: chan.get_fee_proportional_millionths(),
1433 excess_data: Vec::new(),
1436 let msg_hash = Sha256dHash::hash(&unsigned.encode()[..]);
1437 let sig = self.secp_ctx.sign(&hash_to_message!(&msg_hash[..]), &self.our_network_key);
1439 Ok(msgs::ChannelUpdate {
1445 // Only public for testing, this should otherwise never be called direcly
1446 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> {
1447 log_trace!(self.logger, "Attempting to send payment for path with next hop {}", path.first().unwrap().short_channel_id);
1448 let prng_seed = self.keys_manager.get_secure_random_bytes();
1449 let session_priv = SecretKey::from_slice(&self.keys_manager.get_secure_random_bytes()[..]).expect("RNG is busted");
1451 let onion_keys = onion_utils::construct_onion_keys(&self.secp_ctx, &path, &session_priv)
1452 .map_err(|_| APIError::RouteError{err: "Pubkey along hop was maliciously selected"})?;
1453 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(path, total_value, payment_secret, cur_height)?;
1454 if onion_utils::route_size_insane(&onion_payloads) {
1455 return Err(APIError::RouteError{err: "Route size too large considering onion data"});
1457 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, prng_seed, payment_hash);
1459 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
1461 let err: Result<(), _> = loop {
1462 let mut channel_lock = self.channel_state.lock().unwrap();
1463 let id = match channel_lock.short_to_id.get(&path.first().unwrap().short_channel_id) {
1464 None => return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!".to_owned()}),
1465 Some(id) => id.clone(),
1468 let channel_state = &mut *channel_lock;
1469 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(id) {
1471 if chan.get().get_counterparty_node_id() != path.first().unwrap().pubkey {
1472 return Err(APIError::RouteError{err: "Node ID mismatch on first hop!"});
1474 if !chan.get().is_live() {
1475 return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected/pending monitor update!".to_owned()});
1477 break_chan_entry!(self, chan.get_mut().send_htlc_and_commit(htlc_msat, payment_hash.clone(), htlc_cltv, HTLCSource::OutboundRoute {
1479 session_priv: session_priv.clone(),
1480 first_hop_htlc_msat: htlc_msat,
1481 }, onion_packet, &self.logger), channel_state, chan)
1483 Some((update_add, commitment_signed, monitor_update)) => {
1484 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
1485 maybe_break_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, true);
1486 // Note that MonitorUpdateFailed here indicates (per function docs)
1487 // that we will resend the commitment update once monitor updating
1488 // is restored. Therefore, we must return an error indicating that
1489 // it is unsafe to retry the payment wholesale, which we do in the
1490 // send_payment check for MonitorUpdateFailed, below.
1491 return Err(APIError::MonitorUpdateFailed);
1494 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1495 node_id: path.first().unwrap().pubkey,
1496 updates: msgs::CommitmentUpdate {
1497 update_add_htlcs: vec![update_add],
1498 update_fulfill_htlcs: Vec::new(),
1499 update_fail_htlcs: Vec::new(),
1500 update_fail_malformed_htlcs: Vec::new(),
1508 } else { unreachable!(); }
1512 match handle_error!(self, err, path.first().unwrap().pubkey) {
1513 Ok(_) => unreachable!(),
1515 Err(APIError::ChannelUnavailable { err: e.err })
1520 /// Sends a payment along a given route.
1522 /// Value parameters are provided via the last hop in route, see documentation for RouteHop
1523 /// fields for more info.
1525 /// Note that if the payment_hash already exists elsewhere (eg you're sending a duplicative
1526 /// payment), we don't do anything to stop you! We always try to ensure that if the provided
1527 /// next hop knows the preimage to payment_hash they can claim an additional amount as
1528 /// specified in the last hop in the route! Thus, you should probably do your own
1529 /// payment_preimage tracking (which you should already be doing as they represent "proof of
1530 /// payment") and prevent double-sends yourself.
1532 /// May generate SendHTLCs message(s) event on success, which should be relayed.
1534 /// Each path may have a different return value, and PaymentSendValue may return a Vec with
1535 /// each entry matching the corresponding-index entry in the route paths, see
1536 /// PaymentSendFailure for more info.
1538 /// In general, a path may raise:
1539 /// * APIError::RouteError when an invalid route or forwarding parameter (cltv_delta, fee,
1540 /// node public key) is specified.
1541 /// * APIError::ChannelUnavailable if the next-hop channel is not available for updates
1542 /// (including due to previous monitor update failure or new permanent monitor update
1544 /// * APIError::MonitorUpdateFailed if a new monitor update failure prevented sending the
1545 /// relevant updates.
1547 /// Note that depending on the type of the PaymentSendFailure the HTLC may have been
1548 /// irrevocably committed to on our end. In such a case, do NOT retry the payment with a
1549 /// different route unless you intend to pay twice!
1551 /// payment_secret is unrelated to payment_hash (or PaymentPreimage) and exists to authenticate
1552 /// the sender to the recipient and prevent payment-probing (deanonymization) attacks. For
1553 /// newer nodes, it will be provided to you in the invoice. If you do not have one, the Route
1554 /// must not contain multiple paths as multi-path payments require a recipient-provided
1556 /// If a payment_secret *is* provided, we assume that the invoice had the payment_secret feature
1557 /// bit set (either as required or as available). If multiple paths are present in the Route,
1558 /// we assume the invoice had the basic_mpp feature set.
1559 pub fn send_payment(&self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>) -> Result<(), PaymentSendFailure> {
1560 if route.paths.len() < 1 {
1561 return Err(PaymentSendFailure::ParameterError(APIError::RouteError{err: "There must be at least one path to send over"}));
1563 if route.paths.len() > 10 {
1564 // This limit is completely arbitrary - there aren't any real fundamental path-count
1565 // limits. After we support retrying individual paths we should likely bump this, but
1566 // for now more than 10 paths likely carries too much one-path failure.
1567 return Err(PaymentSendFailure::ParameterError(APIError::RouteError{err: "Sending over more than 10 paths is not currently supported"}));
1569 let mut total_value = 0;
1570 let our_node_id = self.get_our_node_id();
1571 let mut path_errs = Vec::with_capacity(route.paths.len());
1572 'path_check: for path in route.paths.iter() {
1573 if path.len() < 1 || path.len() > 20 {
1574 path_errs.push(Err(APIError::RouteError{err: "Path didn't go anywhere/had bogus size"}));
1575 continue 'path_check;
1577 for (idx, hop) in path.iter().enumerate() {
1578 if idx != path.len() - 1 && hop.pubkey == our_node_id {
1579 path_errs.push(Err(APIError::RouteError{err: "Path went through us but wasn't a simple rebalance loop to us"}));
1580 continue 'path_check;
1583 total_value += path.last().unwrap().fee_msat;
1584 path_errs.push(Ok(()));
1586 if path_errs.iter().any(|e| e.is_err()) {
1587 return Err(PaymentSendFailure::PathParameterError(path_errs));
1590 let cur_height = self.best_block.read().unwrap().height() + 1;
1591 let mut results = Vec::new();
1592 for path in route.paths.iter() {
1593 results.push(self.send_payment_along_path(&path, &payment_hash, payment_secret, total_value, cur_height));
1595 let mut has_ok = false;
1596 let mut has_err = false;
1597 for res in results.iter() {
1598 if res.is_ok() { has_ok = true; }
1599 if res.is_err() { has_err = true; }
1600 if let &Err(APIError::MonitorUpdateFailed) = res {
1601 // MonitorUpdateFailed is inherently unsafe to retry, so we call it a
1608 if has_err && has_ok {
1609 Err(PaymentSendFailure::PartialFailure(results))
1611 Err(PaymentSendFailure::AllFailedRetrySafe(results.drain(..).map(|r| r.unwrap_err()).collect()))
1617 /// Handles the generation of a funding transaction, optionally (for tests) with a function
1618 /// which checks the correctness of the funding transaction given the associated channel.
1619 fn funding_transaction_generated_intern<FundingOutput: Fn(&Channel<Signer>, &Transaction) -> Result<OutPoint, APIError>>
1620 (&self, temporary_channel_id: &[u8; 32], funding_transaction: Transaction, find_funding_output: FundingOutput) -> Result<(), APIError> {
1622 let (res, chan) = match self.channel_state.lock().unwrap().by_id.remove(temporary_channel_id) {
1624 let funding_txo = find_funding_output(&chan, &funding_transaction)?;
1626 (chan.get_outbound_funding_created(funding_transaction, funding_txo, &self.logger)
1627 .map_err(|e| if let ChannelError::Close(msg) = e {
1628 MsgHandleErrInternal::from_finish_shutdown(msg, chan.channel_id(), chan.force_shutdown(true), None)
1629 } else { unreachable!(); })
1632 None => { return Err(APIError::ChannelUnavailable { err: "No such channel".to_owned() }) },
1634 match handle_error!(self, res, chan.get_counterparty_node_id()) {
1635 Ok(funding_msg) => {
1638 Err(_) => { return Err(APIError::ChannelUnavailable {
1639 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()
1644 let mut channel_state = self.channel_state.lock().unwrap();
1645 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
1646 node_id: chan.get_counterparty_node_id(),
1649 match channel_state.by_id.entry(chan.channel_id()) {
1650 hash_map::Entry::Occupied(_) => {
1651 panic!("Generated duplicate funding txid?");
1653 hash_map::Entry::Vacant(e) => {
1661 pub(crate) fn funding_transaction_generated_unchecked(&self, temporary_channel_id: &[u8; 32], funding_transaction: Transaction, output_index: u16) -> Result<(), APIError> {
1662 self.funding_transaction_generated_intern(temporary_channel_id, funding_transaction, |_, tx| {
1663 Ok(OutPoint { txid: tx.txid(), index: output_index })
1667 /// Call this upon creation of a funding transaction for the given channel.
1669 /// Returns an [`APIError::APIMisuseError`] if the funding_transaction spent non-SegWit outputs
1670 /// or if no output was found which matches the parameters in [`Event::FundingGenerationReady`].
1672 /// Panics if a funding transaction has already been provided for this channel.
1674 /// May panic if the output found in the funding transaction is duplicative with some other
1675 /// channel (note that this should be trivially prevented by using unique funding transaction
1676 /// keys per-channel).
1678 /// Do NOT broadcast the funding transaction yourself. When we have safely received our
1679 /// counterparty's signature the funding transaction will automatically be broadcast via the
1680 /// [`BroadcasterInterface`] provided when this `ChannelManager` was constructed.
1682 /// Note that this includes RBF or similar transaction replacement strategies - lightning does
1683 /// not currently support replacing a funding transaction on an existing channel. Instead,
1684 /// create a new channel with a conflicting funding transaction.
1685 pub fn funding_transaction_generated(&self, temporary_channel_id: &[u8; 32], funding_transaction: Transaction) -> Result<(), APIError> {
1686 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
1688 for inp in funding_transaction.input.iter() {
1689 if inp.witness.is_empty() {
1690 return Err(APIError::APIMisuseError {
1691 err: "Funding transaction must be fully signed and spend Segwit outputs".to_owned()
1695 self.funding_transaction_generated_intern(temporary_channel_id, funding_transaction, |chan, tx| {
1696 let mut output_index = None;
1697 let expected_spk = chan.get_funding_redeemscript().to_v0_p2wsh();
1698 for (idx, outp) in tx.output.iter().enumerate() {
1699 if outp.script_pubkey == expected_spk && outp.value == chan.get_value_satoshis() {
1700 if output_index.is_some() {
1701 return Err(APIError::APIMisuseError {
1702 err: "Multiple outputs matched the expected script and value".to_owned()
1705 if idx > u16::max_value() as usize {
1706 return Err(APIError::APIMisuseError {
1707 err: "Transaction had more than 2^16 outputs, which is not supported".to_owned()
1710 output_index = Some(idx as u16);
1713 if output_index.is_none() {
1714 return Err(APIError::APIMisuseError {
1715 err: "No output matched the script_pubkey and value in the FundingGenerationReady event".to_owned()
1718 Ok(OutPoint { txid: tx.txid(), index: output_index.unwrap() })
1722 fn get_announcement_sigs(&self, chan: &Channel<Signer>) -> Option<msgs::AnnouncementSignatures> {
1723 if !chan.should_announce() {
1724 log_trace!(self.logger, "Can't send announcement_signatures for private channel {}", log_bytes!(chan.channel_id()));
1728 let (announcement, our_bitcoin_sig) = match chan.get_channel_announcement(self.get_our_node_id(), self.genesis_hash.clone()) {
1730 Err(_) => return None, // Only in case of state precondition violations eg channel is closing
1732 let msghash = hash_to_message!(&Sha256dHash::hash(&announcement.encode()[..])[..]);
1733 let our_node_sig = self.secp_ctx.sign(&msghash, &self.our_network_key);
1735 Some(msgs::AnnouncementSignatures {
1736 channel_id: chan.channel_id(),
1737 short_channel_id: chan.get_short_channel_id().unwrap(),
1738 node_signature: our_node_sig,
1739 bitcoin_signature: our_bitcoin_sig,
1744 // Messages of up to 64KB should never end up more than half full with addresses, as that would
1745 // be absurd. We ensure this by checking that at least 500 (our stated public contract on when
1746 // broadcast_node_announcement panics) of the maximum-length addresses would fit in a 64KB
1748 const HALF_MESSAGE_IS_ADDRS: u32 = ::std::u16::MAX as u32 / (NetAddress::MAX_LEN as u32 + 1) / 2;
1751 // ...by failing to compile if the number of addresses that would be half of a message is
1752 // smaller than 500:
1753 const STATIC_ASSERT: u32 = Self::HALF_MESSAGE_IS_ADDRS - 500;
1755 /// Generates a signed node_announcement from the given arguments and creates a
1756 /// BroadcastNodeAnnouncement event. Note that such messages will be ignored unless peers have
1757 /// seen a channel_announcement from us (ie unless we have public channels open).
1759 /// RGB is a node "color" and alias is a printable human-readable string to describe this node
1760 /// to humans. They carry no in-protocol meaning.
1762 /// addresses represent the set (possibly empty) of socket addresses on which this node accepts
1763 /// incoming connections. These will be broadcast to the network, publicly tying these
1764 /// addresses together. If you wish to preserve user privacy, addresses should likely contain
1765 /// only Tor Onion addresses.
1767 /// Panics if addresses is absurdly large (more than 500).
1768 pub fn broadcast_node_announcement(&self, rgb: [u8; 3], alias: [u8; 32], addresses: Vec<NetAddress>) {
1769 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
1771 if addresses.len() > 500 {
1772 panic!("More than half the message size was taken up by public addresses!");
1775 let announcement = msgs::UnsignedNodeAnnouncement {
1776 features: NodeFeatures::known(),
1777 timestamp: self.last_node_announcement_serial.fetch_add(1, Ordering::AcqRel) as u32,
1778 node_id: self.get_our_node_id(),
1779 rgb, alias, addresses,
1780 excess_address_data: Vec::new(),
1781 excess_data: Vec::new(),
1783 let msghash = hash_to_message!(&Sha256dHash::hash(&announcement.encode()[..])[..]);
1785 let mut channel_state = self.channel_state.lock().unwrap();
1786 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastNodeAnnouncement {
1787 msg: msgs::NodeAnnouncement {
1788 signature: self.secp_ctx.sign(&msghash, &self.our_network_key),
1789 contents: announcement
1794 /// Processes HTLCs which are pending waiting on random forward delay.
1796 /// Should only really ever be called in response to a PendingHTLCsForwardable event.
1797 /// Will likely generate further events.
1798 pub fn process_pending_htlc_forwards(&self) {
1799 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
1801 let mut new_events = Vec::new();
1802 let mut failed_forwards = Vec::new();
1803 let mut handle_errors = Vec::new();
1805 let mut channel_state_lock = self.channel_state.lock().unwrap();
1806 let channel_state = &mut *channel_state_lock;
1808 for (short_chan_id, mut pending_forwards) in channel_state.forward_htlcs.drain() {
1809 if short_chan_id != 0 {
1810 let forward_chan_id = match channel_state.short_to_id.get(&short_chan_id) {
1811 Some(chan_id) => chan_id.clone(),
1813 failed_forwards.reserve(pending_forwards.len());
1814 for forward_info in pending_forwards.drain(..) {
1815 match forward_info {
1816 HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info,
1817 prev_funding_outpoint } => {
1818 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
1819 short_channel_id: prev_short_channel_id,
1820 outpoint: prev_funding_outpoint,
1821 htlc_id: prev_htlc_id,
1822 incoming_packet_shared_secret: forward_info.incoming_shared_secret,
1824 failed_forwards.push((htlc_source, forward_info.payment_hash,
1825 HTLCFailReason::Reason { failure_code: 0x4000 | 10, data: Vec::new() }
1828 HTLCForwardInfo::FailHTLC { .. } => {
1829 // Channel went away before we could fail it. This implies
1830 // the channel is now on chain and our counterparty is
1831 // trying to broadcast the HTLC-Timeout, but that's their
1832 // problem, not ours.
1839 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(forward_chan_id) {
1840 let mut add_htlc_msgs = Vec::new();
1841 let mut fail_htlc_msgs = Vec::new();
1842 for forward_info in pending_forwards.drain(..) {
1843 match forward_info {
1844 HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info: PendingHTLCInfo {
1845 routing: PendingHTLCRouting::Forward {
1847 }, incoming_shared_secret, payment_hash, amt_to_forward, outgoing_cltv_value },
1848 prev_funding_outpoint } => {
1849 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);
1850 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
1851 short_channel_id: prev_short_channel_id,
1852 outpoint: prev_funding_outpoint,
1853 htlc_id: prev_htlc_id,
1854 incoming_packet_shared_secret: incoming_shared_secret,
1856 match chan.get_mut().send_htlc(amt_to_forward, payment_hash, outgoing_cltv_value, htlc_source.clone(), onion_packet) {
1858 if let ChannelError::Ignore(msg) = e {
1859 log_trace!(self.logger, "Failed to forward HTLC with payment_hash {}: {}", log_bytes!(payment_hash.0), msg);
1861 panic!("Stated return value requirements in send_htlc() were not met");
1863 let chan_update = self.get_channel_update(chan.get()).unwrap();
1864 failed_forwards.push((htlc_source, payment_hash,
1865 HTLCFailReason::Reason { failure_code: 0x1000 | 7, data: chan_update.encode_with_len() }
1871 Some(msg) => { add_htlc_msgs.push(msg); },
1873 // Nothing to do here...we're waiting on a remote
1874 // revoke_and_ack before we can add anymore HTLCs. The Channel
1875 // will automatically handle building the update_add_htlc and
1876 // commitment_signed messages when we can.
1877 // TODO: Do some kind of timer to set the channel as !is_live()
1878 // as we don't really want others relying on us relaying through
1879 // this channel currently :/.
1885 HTLCForwardInfo::AddHTLC { .. } => {
1886 panic!("short_channel_id != 0 should imply any pending_forward entries are of type Forward");
1888 HTLCForwardInfo::FailHTLC { htlc_id, err_packet } => {
1889 log_trace!(self.logger, "Failing HTLC back to channel with short id {} after delay", short_chan_id);
1890 match chan.get_mut().get_update_fail_htlc(htlc_id, err_packet) {
1892 if let ChannelError::Ignore(msg) = e {
1893 log_trace!(self.logger, "Failed to fail backwards to short_id {}: {}", short_chan_id, msg);
1895 panic!("Stated return value requirements in get_update_fail_htlc() were not met");
1897 // fail-backs are best-effort, we probably already have one
1898 // pending, and if not that's OK, if not, the channel is on
1899 // the chain and sending the HTLC-Timeout is their problem.
1902 Ok(Some(msg)) => { fail_htlc_msgs.push(msg); },
1904 // Nothing to do here...we're waiting on a remote
1905 // revoke_and_ack before we can update the commitment
1906 // transaction. The Channel will automatically handle
1907 // building the update_fail_htlc and commitment_signed
1908 // messages when we can.
1909 // We don't need any kind of timer here as they should fail
1910 // the channel onto the chain if they can't get our
1911 // update_fail_htlc in time, it's not our problem.
1918 if !add_htlc_msgs.is_empty() || !fail_htlc_msgs.is_empty() {
1919 let (commitment_msg, monitor_update) = match chan.get_mut().send_commitment(&self.logger) {
1922 // We surely failed send_commitment due to bad keys, in that case
1923 // close channel and then send error message to peer.
1924 let counterparty_node_id = chan.get().get_counterparty_node_id();
1925 let err: Result<(), _> = match e {
1926 ChannelError::Ignore(_) => {
1927 panic!("Stated return value requirements in send_commitment() were not met");
1929 ChannelError::Close(msg) => {
1930 log_trace!(self.logger, "Closing channel {} due to Close-required error: {}", log_bytes!(chan.key()[..]), msg);
1931 let (channel_id, mut channel) = chan.remove_entry();
1932 if let Some(short_id) = channel.get_short_channel_id() {
1933 channel_state.short_to_id.remove(&short_id);
1935 Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, channel.force_shutdown(true), self.get_channel_update(&channel).ok()))
1937 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"); }
1939 handle_errors.push((counterparty_node_id, err));
1943 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
1944 handle_errors.push((chan.get().get_counterparty_node_id(), handle_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, true)));
1947 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1948 node_id: chan.get().get_counterparty_node_id(),
1949 updates: msgs::CommitmentUpdate {
1950 update_add_htlcs: add_htlc_msgs,
1951 update_fulfill_htlcs: Vec::new(),
1952 update_fail_htlcs: fail_htlc_msgs,
1953 update_fail_malformed_htlcs: Vec::new(),
1955 commitment_signed: commitment_msg,
1963 for forward_info in pending_forwards.drain(..) {
1964 match forward_info {
1965 HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info: PendingHTLCInfo {
1966 routing: PendingHTLCRouting::Receive { payment_data, incoming_cltv_expiry },
1967 incoming_shared_secret, payment_hash, amt_to_forward, .. },
1968 prev_funding_outpoint } => {
1969 let claimable_htlc = ClaimableHTLC {
1970 prev_hop: HTLCPreviousHopData {
1971 short_channel_id: prev_short_channel_id,
1972 outpoint: prev_funding_outpoint,
1973 htlc_id: prev_htlc_id,
1974 incoming_packet_shared_secret: incoming_shared_secret,
1976 value: amt_to_forward,
1977 payment_data: payment_data.clone(),
1978 cltv_expiry: incoming_cltv_expiry,
1981 macro_rules! fail_htlc {
1983 let mut htlc_msat_height_data = byte_utils::be64_to_array($htlc.value).to_vec();
1984 htlc_msat_height_data.extend_from_slice(
1985 &byte_utils::be32_to_array(self.best_block.read().unwrap().height()),
1987 failed_forwards.push((HTLCSource::PreviousHopData(HTLCPreviousHopData {
1988 short_channel_id: $htlc.prev_hop.short_channel_id,
1989 outpoint: prev_funding_outpoint,
1990 htlc_id: $htlc.prev_hop.htlc_id,
1991 incoming_packet_shared_secret: $htlc.prev_hop.incoming_packet_shared_secret,
1993 HTLCFailReason::Reason { failure_code: 0x4000 | 15, data: htlc_msat_height_data }
1998 // Check that the payment hash and secret are known. Note that we
1999 // MUST take care to handle the "unknown payment hash" and
2000 // "incorrect payment secret" cases here identically or we'd expose
2001 // that we are the ultimate recipient of the given payment hash.
2002 // Further, we must not expose whether we have any other HTLCs
2003 // associated with the same payment_hash pending or not.
2004 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
2005 match payment_secrets.entry(payment_hash) {
2006 hash_map::Entry::Vacant(_) => {
2007 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as we didn't have a corresponding inbound payment.", log_bytes!(payment_hash.0));
2008 fail_htlc!(claimable_htlc);
2010 hash_map::Entry::Occupied(inbound_payment) => {
2011 if inbound_payment.get().payment_secret != payment_data.payment_secret {
2012 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our expected payment secret.", log_bytes!(payment_hash.0));
2013 fail_htlc!(claimable_htlc);
2014 } else if inbound_payment.get().min_value_msat.is_some() && payment_data.total_msat < inbound_payment.get().min_value_msat.unwrap() {
2015 log_trace!(self.logger, "Failing new HTLC with payment_hash {} as it didn't match our minimum value (had {}, needed {}).",
2016 log_bytes!(payment_hash.0), payment_data.total_msat, inbound_payment.get().min_value_msat.unwrap());
2017 fail_htlc!(claimable_htlc);
2019 let mut total_value = 0;
2020 let htlcs = channel_state.claimable_htlcs.entry(payment_hash)
2021 .or_insert(Vec::new());
2022 htlcs.push(claimable_htlc);
2023 for htlc in htlcs.iter() {
2024 total_value += htlc.value;
2025 if htlc.payment_data.total_msat != payment_data.total_msat {
2026 log_trace!(self.logger, "Failing HTLCs with payment_hash {} as the HTLCs had inconsistent total values (eg {} and {})",
2027 log_bytes!(payment_hash.0), payment_data.total_msat, htlc.payment_data.total_msat);
2028 total_value = msgs::MAX_VALUE_MSAT;
2030 if total_value >= msgs::MAX_VALUE_MSAT { break; }
2032 if total_value >= msgs::MAX_VALUE_MSAT || total_value > payment_data.total_msat {
2033 log_trace!(self.logger, "Failing HTLCs with payment_hash {} as the total value {} ran over expected value {} (or HTLCs were inconsistent)",
2034 log_bytes!(payment_hash.0), total_value, payment_data.total_msat);
2035 for htlc in htlcs.iter() {
2038 } else if total_value == payment_data.total_msat {
2039 new_events.push(events::Event::PaymentReceived {
2041 payment_preimage: inbound_payment.get().payment_preimage,
2042 payment_secret: payment_data.payment_secret,
2044 user_payment_id: inbound_payment.get().user_payment_id,
2046 // Only ever generate at most one PaymentReceived
2047 // per registered payment_hash, even if it isn't
2049 inbound_payment.remove_entry();
2051 // Nothing to do - we haven't reached the total
2052 // payment value yet, wait until we receive more
2059 HTLCForwardInfo::AddHTLC { .. } => {
2060 panic!("short_channel_id == 0 should imply any pending_forward entries are of type Receive");
2062 HTLCForwardInfo::FailHTLC { .. } => {
2063 panic!("Got pending fail of our own HTLC");
2071 for (htlc_source, payment_hash, failure_reason) in failed_forwards.drain(..) {
2072 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source, &payment_hash, failure_reason);
2075 for (counterparty_node_id, err) in handle_errors.drain(..) {
2076 let _ = handle_error!(self, err, counterparty_node_id);
2079 if new_events.is_empty() { return }
2080 let mut events = self.pending_events.lock().unwrap();
2081 events.append(&mut new_events);
2084 /// Free the background events, generally called from timer_tick_occurred.
2086 /// Exposed for testing to allow us to process events quickly without generating accidental
2087 /// BroadcastChannelUpdate events in timer_tick_occurred.
2089 /// Expects the caller to have a total_consistency_lock read lock.
2090 fn process_background_events(&self) {
2091 let mut background_events = Vec::new();
2092 mem::swap(&mut *self.pending_background_events.lock().unwrap(), &mut background_events);
2093 for event in background_events.drain(..) {
2095 BackgroundEvent::ClosingMonitorUpdate((funding_txo, update)) => {
2096 // The channel has already been closed, so no use bothering to care about the
2097 // monitor updating completing.
2098 let _ = self.chain_monitor.update_channel(funding_txo, update);
2104 #[cfg(any(test, feature = "_test_utils"))]
2105 pub(crate) fn test_process_background_events(&self) {
2106 self.process_background_events();
2109 /// If a peer is disconnected we mark any channels with that peer as 'disabled'.
2110 /// After some time, if channels are still disabled we need to broadcast a ChannelUpdate
2111 /// to inform the network about the uselessness of these channels.
2113 /// This method handles all the details, and must be called roughly once per minute.
2115 /// Note that in some rare cases this may generate a `chain::Watch::update_channel` call.
2116 pub fn timer_tick_occurred(&self) {
2117 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
2118 self.process_background_events();
2120 let mut channel_state_lock = self.channel_state.lock().unwrap();
2121 let channel_state = &mut *channel_state_lock;
2122 for (_, chan) in channel_state.by_id.iter_mut() {
2123 if chan.is_disabled_staged() && !chan.is_live() {
2124 if let Ok(update) = self.get_channel_update(&chan) {
2125 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2130 } else if chan.is_disabled_staged() && chan.is_live() {
2132 } else if chan.is_disabled_marked() {
2133 chan.to_disabled_staged();
2138 /// Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
2139 /// after a PaymentReceived event, failing the HTLC back to its origin and freeing resources
2140 /// along the path (including in our own channel on which we received it).
2141 /// Returns false if no payment was found to fail backwards, true if the process of failing the
2142 /// HTLC backwards has been started.
2143 pub fn fail_htlc_backwards(&self, payment_hash: &PaymentHash) -> bool {
2144 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
2146 let mut channel_state = Some(self.channel_state.lock().unwrap());
2147 let removed_source = channel_state.as_mut().unwrap().claimable_htlcs.remove(payment_hash);
2148 if let Some(mut sources) = removed_source {
2149 for htlc in sources.drain(..) {
2150 if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
2151 let mut htlc_msat_height_data = byte_utils::be64_to_array(htlc.value).to_vec();
2152 htlc_msat_height_data.extend_from_slice(&byte_utils::be32_to_array(
2153 self.best_block.read().unwrap().height()));
2154 self.fail_htlc_backwards_internal(channel_state.take().unwrap(),
2155 HTLCSource::PreviousHopData(htlc.prev_hop), payment_hash,
2156 HTLCFailReason::Reason { failure_code: 0x4000 | 15, data: htlc_msat_height_data });
2162 // Fail a list of HTLCs that were just freed from the holding cell. The HTLCs need to be
2163 // failed backwards or, if they were one of our outgoing HTLCs, then their failure needs to
2164 // be surfaced to the user.
2165 fn fail_holding_cell_htlcs(&self, mut htlcs_to_fail: Vec<(HTLCSource, PaymentHash)>, channel_id: [u8; 32]) {
2166 for (htlc_src, payment_hash) in htlcs_to_fail.drain(..) {
2168 HTLCSource::PreviousHopData(HTLCPreviousHopData { .. }) => {
2169 let (failure_code, onion_failure_data) =
2170 match self.channel_state.lock().unwrap().by_id.entry(channel_id) {
2171 hash_map::Entry::Occupied(chan_entry) => {
2172 if let Ok(upd) = self.get_channel_update(&chan_entry.get()) {
2173 (0x1000|7, upd.encode_with_len())
2175 (0x4000|10, Vec::new())
2178 hash_map::Entry::Vacant(_) => (0x4000|10, Vec::new())
2180 let channel_state = self.channel_state.lock().unwrap();
2181 self.fail_htlc_backwards_internal(channel_state,
2182 htlc_src, &payment_hash, HTLCFailReason::Reason { failure_code, data: onion_failure_data});
2184 HTLCSource::OutboundRoute { .. } => {
2185 self.pending_events.lock().unwrap().push(
2186 events::Event::PaymentFailed {
2188 rejected_by_dest: false,
2200 /// Fails an HTLC backwards to the sender of it to us.
2201 /// Note that while we take a channel_state lock as input, we do *not* assume consistency here.
2202 /// There are several callsites that do stupid things like loop over a list of payment_hashes
2203 /// to fail and take the channel_state lock for each iteration (as we take ownership and may
2204 /// drop it). In other words, no assumptions are made that entries in claimable_htlcs point to
2205 /// still-available channels.
2206 fn fail_htlc_backwards_internal(&self, mut channel_state_lock: MutexGuard<ChannelHolder<Signer>>, source: HTLCSource, payment_hash: &PaymentHash, onion_error: HTLCFailReason) {
2207 //TODO: There is a timing attack here where if a node fails an HTLC back to us they can
2208 //identify whether we sent it or not based on the (I presume) very different runtime
2209 //between the branches here. We should make this async and move it into the forward HTLCs
2212 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
2213 // from block_connected which may run during initialization prior to the chain_monitor
2214 // being fully configured. See the docs for `ChannelManagerReadArgs` for more.
2216 HTLCSource::OutboundRoute { ref path, .. } => {
2217 log_trace!(self.logger, "Failing outbound payment HTLC with payment_hash {}", log_bytes!(payment_hash.0));
2218 mem::drop(channel_state_lock);
2219 match &onion_error {
2220 &HTLCFailReason::LightningError { ref err } => {
2222 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());
2224 let (channel_update, payment_retryable, _, _) = onion_utils::process_onion_failure(&self.secp_ctx, &self.logger, &source, err.data.clone());
2225 // TODO: If we decided to blame ourselves (or one of our channels) in
2226 // process_onion_failure we should close that channel as it implies our
2227 // next-hop is needlessly blaming us!
2228 if let Some(update) = channel_update {
2229 self.channel_state.lock().unwrap().pending_msg_events.push(
2230 events::MessageSendEvent::PaymentFailureNetworkUpdate {
2235 self.pending_events.lock().unwrap().push(
2236 events::Event::PaymentFailed {
2237 payment_hash: payment_hash.clone(),
2238 rejected_by_dest: !payment_retryable,
2240 error_code: onion_error_code,
2242 error_data: onion_error_data
2246 &HTLCFailReason::Reason {
2252 // we get a fail_malformed_htlc from the first hop
2253 // TODO: We'd like to generate a PaymentFailureNetworkUpdate for temporary
2254 // failures here, but that would be insufficient as get_route
2255 // generally ignores its view of our own channels as we provide them via
2257 // TODO: For non-temporary failures, we really should be closing the
2258 // channel here as we apparently can't relay through them anyway.
2259 self.pending_events.lock().unwrap().push(
2260 events::Event::PaymentFailed {
2261 payment_hash: payment_hash.clone(),
2262 rejected_by_dest: path.len() == 1,
2264 error_code: Some(*failure_code),
2266 error_data: Some(data.clone()),
2272 HTLCSource::PreviousHopData(HTLCPreviousHopData { short_channel_id, htlc_id, incoming_packet_shared_secret, .. }) => {
2273 let err_packet = match onion_error {
2274 HTLCFailReason::Reason { failure_code, data } => {
2275 log_trace!(self.logger, "Failing HTLC with payment_hash {} backwards from us with code {}", log_bytes!(payment_hash.0), failure_code);
2276 let packet = onion_utils::build_failure_packet(&incoming_packet_shared_secret, failure_code, &data[..]).encode();
2277 onion_utils::encrypt_failure_packet(&incoming_packet_shared_secret, &packet)
2279 HTLCFailReason::LightningError { err } => {
2280 log_trace!(self.logger, "Failing HTLC with payment_hash {} backwards with pre-built LightningError", log_bytes!(payment_hash.0));
2281 onion_utils::encrypt_failure_packet(&incoming_packet_shared_secret, &err.data)
2285 let mut forward_event = None;
2286 if channel_state_lock.forward_htlcs.is_empty() {
2287 forward_event = Some(Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS));
2289 match channel_state_lock.forward_htlcs.entry(short_channel_id) {
2290 hash_map::Entry::Occupied(mut entry) => {
2291 entry.get_mut().push(HTLCForwardInfo::FailHTLC { htlc_id, err_packet });
2293 hash_map::Entry::Vacant(entry) => {
2294 entry.insert(vec!(HTLCForwardInfo::FailHTLC { htlc_id, err_packet }));
2297 mem::drop(channel_state_lock);
2298 if let Some(time) = forward_event {
2299 let mut pending_events = self.pending_events.lock().unwrap();
2300 pending_events.push(events::Event::PendingHTLCsForwardable {
2301 time_forwardable: time
2308 /// Provides a payment preimage in response to a PaymentReceived event, returning true and
2309 /// generating message events for the net layer to claim the payment, if possible. Thus, you
2310 /// should probably kick the net layer to go send messages if this returns true!
2312 /// Note that if you did not set an `amount_msat` when calling [`create_inbound_payment`] or
2313 /// [`create_inbound_payment_for_hash`] you must check that the amount in the `PaymentReceived`
2314 /// event matches your expectation. If you fail to do so and call this method, you may provide
2315 /// the sender "proof-of-payment" when they did not fulfill the full expected payment.
2317 /// May panic if called except in response to a PaymentReceived event.
2319 /// [`create_inbound_payment`]: Self::create_inbound_payment
2320 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
2321 pub fn claim_funds(&self, payment_preimage: PaymentPreimage) -> bool {
2322 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
2324 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
2326 let mut channel_state = Some(self.channel_state.lock().unwrap());
2327 let removed_source = channel_state.as_mut().unwrap().claimable_htlcs.remove(&payment_hash);
2328 if let Some(mut sources) = removed_source {
2329 assert!(!sources.is_empty());
2331 // If we are claiming an MPP payment, we have to take special care to ensure that each
2332 // channel exists before claiming all of the payments (inside one lock).
2333 // Note that channel existance is sufficient as we should always get a monitor update
2334 // which will take care of the real HTLC claim enforcement.
2336 // If we find an HTLC which we would need to claim but for which we do not have a
2337 // channel, we will fail all parts of the MPP payment. While we could wait and see if
2338 // the sender retries the already-failed path(s), it should be a pretty rare case where
2339 // we got all the HTLCs and then a channel closed while we were waiting for the user to
2340 // provide the preimage, so worrying too much about the optimal handling isn't worth
2342 let mut valid_mpp = true;
2343 for htlc in sources.iter() {
2344 if let None = channel_state.as_ref().unwrap().short_to_id.get(&htlc.prev_hop.short_channel_id) {
2350 let mut errs = Vec::new();
2351 let mut claimed_any_htlcs = false;
2352 for htlc in sources.drain(..) {
2354 if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
2355 let mut htlc_msat_height_data = byte_utils::be64_to_array(htlc.value).to_vec();
2356 htlc_msat_height_data.extend_from_slice(&byte_utils::be32_to_array(
2357 self.best_block.read().unwrap().height()));
2358 self.fail_htlc_backwards_internal(channel_state.take().unwrap(),
2359 HTLCSource::PreviousHopData(htlc.prev_hop), &payment_hash,
2360 HTLCFailReason::Reason { failure_code: 0x4000|15, data: htlc_msat_height_data });
2362 match self.claim_funds_from_hop(channel_state.as_mut().unwrap(), htlc.prev_hop, payment_preimage) {
2364 if let msgs::ErrorAction::IgnoreError = e.1.err.action {
2365 // We got a temporary failure updating monitor, but will claim the
2366 // HTLC when the monitor updating is restored (or on chain).
2367 log_error!(self.logger, "Temporary failure claiming HTLC, treating as success: {}", e.1.err.err);
2368 claimed_any_htlcs = true;
2369 } else { errs.push(e); }
2371 Err(None) => unreachable!("We already checked for channel existence, we can't fail here!"),
2372 Ok(()) => claimed_any_htlcs = true,
2377 // Now that we've done the entire above loop in one lock, we can handle any errors
2378 // which were generated.
2379 channel_state.take();
2381 for (counterparty_node_id, err) in errs.drain(..) {
2382 let res: Result<(), _> = Err(err);
2383 let _ = handle_error!(self, res, counterparty_node_id);
2390 fn claim_funds_from_hop(&self, channel_state_lock: &mut MutexGuard<ChannelHolder<Signer>>, prev_hop: HTLCPreviousHopData, payment_preimage: PaymentPreimage) -> Result<(), Option<(PublicKey, MsgHandleErrInternal)>> {
2391 //TODO: Delay the claimed_funds relaying just like we do outbound relay!
2392 let channel_state = &mut **channel_state_lock;
2393 let chan_id = match channel_state.short_to_id.get(&prev_hop.short_channel_id) {
2394 Some(chan_id) => chan_id.clone(),
2400 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(chan_id) {
2401 let was_frozen_for_monitor = chan.get().is_awaiting_monitor_update();
2402 match chan.get_mut().get_update_fulfill_htlc_and_commit(prev_hop.htlc_id, payment_preimage, &self.logger) {
2403 Ok((msgs, monitor_option)) => {
2404 if let Some(monitor_update) = monitor_option {
2405 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
2406 if was_frozen_for_monitor {
2407 assert!(msgs.is_none());
2409 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())));
2413 if let Some((msg, commitment_signed)) = msgs {
2414 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2415 node_id: chan.get().get_counterparty_node_id(),
2416 updates: msgs::CommitmentUpdate {
2417 update_add_htlcs: Vec::new(),
2418 update_fulfill_htlcs: vec![msg],
2419 update_fail_htlcs: Vec::new(),
2420 update_fail_malformed_htlcs: Vec::new(),
2429 // TODO: Do something with e?
2430 // This should only occur if we are claiming an HTLC at the same time as the
2431 // HTLC is being failed (eg because a block is being connected and this caused
2432 // an HTLC to time out). This should, of course, only occur if the user is the
2433 // one doing the claiming (as it being a part of a peer claim would imply we're
2434 // about to lose funds) and only if the lock in claim_funds was dropped as a
2435 // previous HTLC was failed (thus not for an MPP payment).
2436 debug_assert!(false, "This shouldn't be reachable except in absurdly rare cases between monitor updates and HTLC timeouts: {:?}", e);
2440 } else { unreachable!(); }
2443 fn claim_funds_internal(&self, mut channel_state_lock: MutexGuard<ChannelHolder<Signer>>, source: HTLCSource, payment_preimage: PaymentPreimage) {
2445 HTLCSource::OutboundRoute { .. } => {
2446 mem::drop(channel_state_lock);
2447 let mut pending_events = self.pending_events.lock().unwrap();
2448 pending_events.push(events::Event::PaymentSent {
2452 HTLCSource::PreviousHopData(hop_data) => {
2453 let prev_outpoint = hop_data.outpoint;
2454 if let Err((counterparty_node_id, err)) = match self.claim_funds_from_hop(&mut channel_state_lock, hop_data, payment_preimage) {
2457 let preimage_update = ChannelMonitorUpdate {
2458 update_id: CLOSED_CHANNEL_UPDATE_ID,
2459 updates: vec![ChannelMonitorUpdateStep::PaymentPreimage {
2460 payment_preimage: payment_preimage.clone(),
2463 // We update the ChannelMonitor on the backward link, after
2464 // receiving an offchain preimage event from the forward link (the
2465 // event being update_fulfill_htlc).
2466 if let Err(e) = self.chain_monitor.update_channel(prev_outpoint, preimage_update) {
2467 log_error!(self.logger, "Critical error: failed to update channel monitor with preimage {:?}: {:?}",
2468 payment_preimage, e);
2472 Err(Some(res)) => Err(res),
2474 mem::drop(channel_state_lock);
2475 let res: Result<(), _> = Err(err);
2476 let _ = handle_error!(self, res, counterparty_node_id);
2482 /// Gets the node_id held by this ChannelManager
2483 pub fn get_our_node_id(&self) -> PublicKey {
2484 self.our_network_pubkey.clone()
2487 /// Restores a single, given channel to normal operation after a
2488 /// ChannelMonitorUpdateErr::TemporaryFailure was returned from a channel monitor update
2491 /// All ChannelMonitor updates up to and including highest_applied_update_id must have been
2492 /// fully committed in every copy of the given channels' ChannelMonitors.
2494 /// Note that there is no effect to calling with a highest_applied_update_id other than the
2495 /// current latest ChannelMonitorUpdate and one call to this function after multiple
2496 /// ChannelMonitorUpdateErr::TemporaryFailures is fine. The highest_applied_update_id field
2497 /// exists largely only to prevent races between this and concurrent update_monitor calls.
2499 /// Thus, the anticipated use is, at a high level:
2500 /// 1) You register a chain::Watch with this ChannelManager,
2501 /// 2) it stores each update to disk, and begins updating any remote (eg watchtower) copies of
2502 /// said ChannelMonitors as it can, returning ChannelMonitorUpdateErr::TemporaryFailures
2503 /// any time it cannot do so instantly,
2504 /// 3) update(s) are applied to each remote copy of a ChannelMonitor,
2505 /// 4) once all remote copies are updated, you call this function with the update_id that
2506 /// completed, and once it is the latest the Channel will be re-enabled.
2507 pub fn channel_monitor_updated(&self, funding_txo: &OutPoint, highest_applied_update_id: u64) {
2508 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
2510 let mut close_results = Vec::new();
2511 let mut htlc_forwards = Vec::new();
2512 let mut htlc_failures = Vec::new();
2513 let mut pending_events = Vec::new();
2516 let mut channel_lock = self.channel_state.lock().unwrap();
2517 let channel_state = &mut *channel_lock;
2518 let short_to_id = &mut channel_state.short_to_id;
2519 let pending_msg_events = &mut channel_state.pending_msg_events;
2520 let channel = match channel_state.by_id.get_mut(&funding_txo.to_channel_id()) {
2524 if !channel.is_awaiting_monitor_update() || channel.get_latest_monitor_update_id() != highest_applied_update_id {
2528 let (raa, commitment_update, order, pending_forwards, mut pending_failures, funding_broadcastable, funding_locked) = channel.monitor_updating_restored(&self.logger);
2529 if !pending_forwards.is_empty() {
2530 htlc_forwards.push((channel.get_short_channel_id().expect("We can't have pending forwards before funding confirmation"), funding_txo.clone(), pending_forwards));
2532 htlc_failures.append(&mut pending_failures);
2534 macro_rules! handle_cs { () => {
2535 if let Some(update) = commitment_update {
2536 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2537 node_id: channel.get_counterparty_node_id(),
2542 macro_rules! handle_raa { () => {
2543 if let Some(revoke_and_ack) = raa {
2544 pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
2545 node_id: channel.get_counterparty_node_id(),
2546 msg: revoke_and_ack,
2551 RAACommitmentOrder::CommitmentFirst => {
2555 RAACommitmentOrder::RevokeAndACKFirst => {
2560 if let Some(tx) = funding_broadcastable {
2561 self.tx_broadcaster.broadcast_transaction(&tx);
2563 if let Some(msg) = funding_locked {
2564 pending_msg_events.push(events::MessageSendEvent::SendFundingLocked {
2565 node_id: channel.get_counterparty_node_id(),
2568 if let Some(announcement_sigs) = self.get_announcement_sigs(channel) {
2569 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
2570 node_id: channel.get_counterparty_node_id(),
2571 msg: announcement_sigs,
2574 short_to_id.insert(channel.get_short_channel_id().unwrap(), channel.channel_id());
2578 self.pending_events.lock().unwrap().append(&mut pending_events);
2580 for failure in htlc_failures.drain(..) {
2581 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), failure.0, &failure.1, failure.2);
2583 self.forward_htlcs(&mut htlc_forwards[..]);
2585 for res in close_results.drain(..) {
2586 self.finish_force_close_channel(res);
2590 fn internal_open_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::OpenChannel) -> Result<(), MsgHandleErrInternal> {
2591 if msg.chain_hash != self.genesis_hash {
2592 return Err(MsgHandleErrInternal::send_err_msg_no_close("Unknown genesis block hash".to_owned(), msg.temporary_channel_id.clone()));
2595 let channel = Channel::new_from_req(&self.fee_estimator, &self.keys_manager, counterparty_node_id.clone(), their_features, msg, 0, &self.default_configuration)
2596 .map_err(|e| MsgHandleErrInternal::from_chan_no_close(e, msg.temporary_channel_id))?;
2597 let mut channel_state_lock = self.channel_state.lock().unwrap();
2598 let channel_state = &mut *channel_state_lock;
2599 match channel_state.by_id.entry(channel.channel_id()) {
2600 hash_map::Entry::Occupied(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("temporary_channel_id collision!".to_owned(), msg.temporary_channel_id.clone())),
2601 hash_map::Entry::Vacant(entry) => {
2602 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
2603 node_id: counterparty_node_id.clone(),
2604 msg: channel.get_accept_channel(),
2606 entry.insert(channel);
2612 fn internal_accept_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::AcceptChannel) -> Result<(), MsgHandleErrInternal> {
2613 let (value, output_script, user_id) = {
2614 let mut channel_lock = self.channel_state.lock().unwrap();
2615 let channel_state = &mut *channel_lock;
2616 match channel_state.by_id.entry(msg.temporary_channel_id) {
2617 hash_map::Entry::Occupied(mut chan) => {
2618 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
2619 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.temporary_channel_id));
2621 try_chan_entry!(self, chan.get_mut().accept_channel(&msg, &self.default_configuration, their_features), channel_state, chan);
2622 (chan.get().get_value_satoshis(), chan.get().get_funding_redeemscript().to_v0_p2wsh(), chan.get().get_user_id())
2624 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.temporary_channel_id))
2627 let mut pending_events = self.pending_events.lock().unwrap();
2628 pending_events.push(events::Event::FundingGenerationReady {
2629 temporary_channel_id: msg.temporary_channel_id,
2630 channel_value_satoshis: value,
2632 user_channel_id: user_id,
2637 fn internal_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), MsgHandleErrInternal> {
2638 let ((funding_msg, monitor), mut chan) = {
2639 let best_block = *self.best_block.read().unwrap();
2640 let mut channel_lock = self.channel_state.lock().unwrap();
2641 let channel_state = &mut *channel_lock;
2642 match channel_state.by_id.entry(msg.temporary_channel_id.clone()) {
2643 hash_map::Entry::Occupied(mut chan) => {
2644 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
2645 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.temporary_channel_id));
2647 (try_chan_entry!(self, chan.get_mut().funding_created(msg, best_block, &self.logger), channel_state, chan), chan.remove())
2649 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.temporary_channel_id))
2652 // Because we have exclusive ownership of the channel here we can release the channel_state
2653 // lock before watch_channel
2654 if let Err(e) = self.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor) {
2656 ChannelMonitorUpdateErr::PermanentFailure => {
2657 // Note that we reply with the new channel_id in error messages if we gave up on the
2658 // channel, not the temporary_channel_id. This is compatible with ourselves, but the
2659 // spec is somewhat ambiguous here. Not a huge deal since we'll send error messages for
2660 // any messages referencing a previously-closed channel anyway.
2661 // We do not do a force-close here as that would generate a monitor update for
2662 // a monitor that we didn't manage to store (and that we don't care about - we
2663 // don't respond with the funding_signed so the channel can never go on chain).
2664 let (_monitor_update, failed_htlcs) = chan.force_shutdown(true);
2665 assert!(failed_htlcs.is_empty());
2666 return Err(MsgHandleErrInternal::send_err_msg_no_close("ChannelMonitor storage failure".to_owned(), funding_msg.channel_id));
2668 ChannelMonitorUpdateErr::TemporaryFailure => {
2669 // There's no problem signing a counterparty's funding transaction if our monitor
2670 // hasn't persisted to disk yet - we can't lose money on a transaction that we haven't
2671 // accepted payment from yet. We do, however, need to wait to send our funding_locked
2672 // until we have persisted our monitor.
2673 chan.monitor_update_failed(false, false, Vec::new(), Vec::new());
2677 let mut channel_state_lock = self.channel_state.lock().unwrap();
2678 let channel_state = &mut *channel_state_lock;
2679 match channel_state.by_id.entry(funding_msg.channel_id) {
2680 hash_map::Entry::Occupied(_) => {
2681 return Err(MsgHandleErrInternal::send_err_msg_no_close("Already had channel with the new channel_id".to_owned(), funding_msg.channel_id))
2683 hash_map::Entry::Vacant(e) => {
2684 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
2685 node_id: counterparty_node_id.clone(),
2694 fn internal_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), MsgHandleErrInternal> {
2696 let best_block = *self.best_block.read().unwrap();
2697 let mut channel_lock = self.channel_state.lock().unwrap();
2698 let channel_state = &mut *channel_lock;
2699 match channel_state.by_id.entry(msg.channel_id) {
2700 hash_map::Entry::Occupied(mut chan) => {
2701 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
2702 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
2704 let (monitor, funding_tx) = match chan.get_mut().funding_signed(&msg, best_block, &self.logger) {
2705 Ok(update) => update,
2706 Err(e) => try_chan_entry!(self, Err(e), channel_state, chan),
2708 if let Err(e) = self.chain_monitor.watch_channel(chan.get().get_funding_txo().unwrap(), monitor) {
2709 return_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::RevokeAndACKFirst, false, false);
2713 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
2716 self.tx_broadcaster.broadcast_transaction(&funding_tx);
2720 fn internal_funding_locked(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingLocked) -> Result<(), MsgHandleErrInternal> {
2721 let mut channel_state_lock = self.channel_state.lock().unwrap();
2722 let channel_state = &mut *channel_state_lock;
2723 match channel_state.by_id.entry(msg.channel_id) {
2724 hash_map::Entry::Occupied(mut chan) => {
2725 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
2726 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
2728 try_chan_entry!(self, chan.get_mut().funding_locked(&msg), channel_state, chan);
2729 if let Some(announcement_sigs) = self.get_announcement_sigs(chan.get()) {
2730 log_trace!(self.logger, "Sending announcement_signatures for {} in response to funding_locked", log_bytes!(chan.get().channel_id()));
2731 // If we see locking block before receiving remote funding_locked, we broadcast our
2732 // announcement_sigs at remote funding_locked reception. If we receive remote
2733 // funding_locked before seeing locking block, we broadcast our announcement_sigs at locking
2734 // block connection. We should guanrantee to broadcast announcement_sigs to our peer whatever
2735 // the order of the events but our peer may not receive it due to disconnection. The specs
2736 // lacking an acknowledgement for announcement_sigs we may have to re-send them at peer
2737 // connection in the future if simultaneous misses by both peers due to network/hardware
2738 // failures is an issue. Note, to achieve its goal, only one of the announcement_sigs needs
2739 // to be received, from then sigs are going to be flood to the whole network.
2740 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
2741 node_id: counterparty_node_id.clone(),
2742 msg: announcement_sigs,
2747 hash_map::Entry::Vacant(_) => Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
2751 fn internal_shutdown(&self, counterparty_node_id: &PublicKey, their_features: &InitFeatures, msg: &msgs::Shutdown) -> Result<(), MsgHandleErrInternal> {
2752 let (mut dropped_htlcs, chan_option) = {
2753 let mut channel_state_lock = self.channel_state.lock().unwrap();
2754 let channel_state = &mut *channel_state_lock;
2756 match channel_state.by_id.entry(msg.channel_id.clone()) {
2757 hash_map::Entry::Occupied(mut chan_entry) => {
2758 if chan_entry.get().get_counterparty_node_id() != *counterparty_node_id {
2759 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
2761 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);
2762 if let Some(msg) = shutdown {
2763 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
2764 node_id: counterparty_node_id.clone(),
2768 if let Some(msg) = closing_signed {
2769 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
2770 node_id: counterparty_node_id.clone(),
2774 if chan_entry.get().is_shutdown() {
2775 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
2776 channel_state.short_to_id.remove(&short_id);
2778 (dropped_htlcs, Some(chan_entry.remove_entry().1))
2779 } else { (dropped_htlcs, None) }
2781 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
2784 for htlc_source in dropped_htlcs.drain(..) {
2785 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() });
2787 if let Some(chan) = chan_option {
2788 if let Ok(update) = self.get_channel_update(&chan) {
2789 let mut channel_state = self.channel_state.lock().unwrap();
2790 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2798 fn internal_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<(), MsgHandleErrInternal> {
2799 let (tx, chan_option) = {
2800 let mut channel_state_lock = self.channel_state.lock().unwrap();
2801 let channel_state = &mut *channel_state_lock;
2802 match channel_state.by_id.entry(msg.channel_id.clone()) {
2803 hash_map::Entry::Occupied(mut chan_entry) => {
2804 if chan_entry.get().get_counterparty_node_id() != *counterparty_node_id {
2805 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
2807 let (closing_signed, tx) = try_chan_entry!(self, chan_entry.get_mut().closing_signed(&self.fee_estimator, &msg), channel_state, chan_entry);
2808 if let Some(msg) = closing_signed {
2809 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
2810 node_id: counterparty_node_id.clone(),
2815 // We're done with this channel, we've got a signed closing transaction and
2816 // will send the closing_signed back to the remote peer upon return. This
2817 // also implies there are no pending HTLCs left on the channel, so we can
2818 // fully delete it from tracking (the channel monitor is still around to
2819 // watch for old state broadcasts)!
2820 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
2821 channel_state.short_to_id.remove(&short_id);
2823 (tx, Some(chan_entry.remove_entry().1))
2824 } else { (tx, None) }
2826 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
2829 if let Some(broadcast_tx) = tx {
2830 log_trace!(self.logger, "Broadcast onchain {}", log_tx!(broadcast_tx));
2831 self.tx_broadcaster.broadcast_transaction(&broadcast_tx);
2833 if let Some(chan) = chan_option {
2834 if let Ok(update) = self.get_channel_update(&chan) {
2835 let mut channel_state = self.channel_state.lock().unwrap();
2836 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2844 fn internal_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), MsgHandleErrInternal> {
2845 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
2846 //determine the state of the payment based on our response/if we forward anything/the time
2847 //we take to respond. We should take care to avoid allowing such an attack.
2849 //TODO: There exists a further attack where a node may garble the onion data, forward it to
2850 //us repeatedly garbled in different ways, and compare our error messages, which are
2851 //encrypted with the same key. It's not immediately obvious how to usefully exploit that,
2852 //but we should prevent it anyway.
2854 let (pending_forward_info, mut channel_state_lock) = self.decode_update_add_htlc_onion(msg);
2855 let channel_state = &mut *channel_state_lock;
2857 match channel_state.by_id.entry(msg.channel_id) {
2858 hash_map::Entry::Occupied(mut chan) => {
2859 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
2860 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
2863 let create_pending_htlc_status = |chan: &Channel<Signer>, pending_forward_info: PendingHTLCStatus, error_code: u16| {
2864 // Ensure error_code has the UPDATE flag set, since by default we send a
2865 // channel update along as part of failing the HTLC.
2866 assert!((error_code & 0x1000) != 0);
2867 // If the update_add is completely bogus, the call will Err and we will close,
2868 // but if we've sent a shutdown and they haven't acknowledged it yet, we just
2869 // want to reject the new HTLC and fail it backwards instead of forwarding.
2870 match pending_forward_info {
2871 PendingHTLCStatus::Forward(PendingHTLCInfo { ref incoming_shared_secret, .. }) => {
2872 let reason = if let Ok(upd) = self.get_channel_update(chan) {
2873 onion_utils::build_first_hop_failure_packet(incoming_shared_secret, error_code, &{
2874 let mut res = Vec::with_capacity(8 + 128);
2875 // TODO: underspecified, follow https://github.com/lightningnetwork/lightning-rfc/issues/791
2876 res.extend_from_slice(&byte_utils::be16_to_array(0));
2877 res.extend_from_slice(&upd.encode_with_len()[..]);
2881 // The only case where we'd be unable to
2882 // successfully get a channel update is if the
2883 // channel isn't in the fully-funded state yet,
2884 // implying our counterparty is trying to route
2885 // payments over the channel back to themselves
2886 // (cause no one else should know the short_id
2887 // is a lightning channel yet). We should have
2888 // no problem just calling this
2889 // unknown_next_peer (0x4000|10).
2890 onion_utils::build_first_hop_failure_packet(incoming_shared_secret, 0x4000|10, &[])
2892 let msg = msgs::UpdateFailHTLC {
2893 channel_id: msg.channel_id,
2894 htlc_id: msg.htlc_id,
2897 PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msg))
2899 _ => pending_forward_info
2902 try_chan_entry!(self, chan.get_mut().update_add_htlc(&msg, pending_forward_info, create_pending_htlc_status, &self.logger), channel_state, chan);
2904 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
2909 fn internal_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), MsgHandleErrInternal> {
2910 let mut channel_lock = self.channel_state.lock().unwrap();
2912 let channel_state = &mut *channel_lock;
2913 match channel_state.by_id.entry(msg.channel_id) {
2914 hash_map::Entry::Occupied(mut chan) => {
2915 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
2916 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
2918 try_chan_entry!(self, chan.get_mut().update_fulfill_htlc(&msg), channel_state, chan)
2920 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
2923 self.claim_funds_internal(channel_lock, htlc_source, msg.payment_preimage.clone());
2927 fn internal_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), MsgHandleErrInternal> {
2928 let mut channel_lock = self.channel_state.lock().unwrap();
2929 let channel_state = &mut *channel_lock;
2930 match channel_state.by_id.entry(msg.channel_id) {
2931 hash_map::Entry::Occupied(mut chan) => {
2932 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
2933 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
2935 try_chan_entry!(self, chan.get_mut().update_fail_htlc(&msg, HTLCFailReason::LightningError { err: msg.reason.clone() }), channel_state, chan);
2937 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
2942 fn internal_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), MsgHandleErrInternal> {
2943 let mut channel_lock = self.channel_state.lock().unwrap();
2944 let channel_state = &mut *channel_lock;
2945 match channel_state.by_id.entry(msg.channel_id) {
2946 hash_map::Entry::Occupied(mut chan) => {
2947 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
2948 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
2950 if (msg.failure_code & 0x8000) == 0 {
2951 let chan_err: ChannelError = ChannelError::Close("Got update_fail_malformed_htlc with BADONION not set".to_owned());
2952 try_chan_entry!(self, Err(chan_err), channel_state, chan);
2954 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);
2957 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
2961 fn internal_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), MsgHandleErrInternal> {
2962 let mut channel_state_lock = self.channel_state.lock().unwrap();
2963 let channel_state = &mut *channel_state_lock;
2964 match channel_state.by_id.entry(msg.channel_id) {
2965 hash_map::Entry::Occupied(mut chan) => {
2966 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
2967 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
2969 let (revoke_and_ack, commitment_signed, closing_signed, monitor_update) =
2970 match chan.get_mut().commitment_signed(&msg, &self.fee_estimator, &self.logger) {
2971 Err((None, e)) => try_chan_entry!(self, Err(e), channel_state, chan),
2972 Err((Some(update), e)) => {
2973 assert!(chan.get().is_awaiting_monitor_update());
2974 let _ = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), update);
2975 try_chan_entry!(self, Err(e), channel_state, chan);
2980 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
2981 return_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::RevokeAndACKFirst, true, commitment_signed.is_some());
2982 //TODO: Rebroadcast closing_signed if present on monitor update restoration
2984 channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
2985 node_id: counterparty_node_id.clone(),
2986 msg: revoke_and_ack,
2988 if let Some(msg) = commitment_signed {
2989 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2990 node_id: counterparty_node_id.clone(),
2991 updates: msgs::CommitmentUpdate {
2992 update_add_htlcs: Vec::new(),
2993 update_fulfill_htlcs: Vec::new(),
2994 update_fail_htlcs: Vec::new(),
2995 update_fail_malformed_htlcs: Vec::new(),
2997 commitment_signed: msg,
3001 if let Some(msg) = closing_signed {
3002 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
3003 node_id: counterparty_node_id.clone(),
3009 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3014 fn forward_htlcs(&self, per_source_pending_forwards: &mut [(u64, OutPoint, Vec<(PendingHTLCInfo, u64)>)]) {
3015 for &mut (prev_short_channel_id, prev_funding_outpoint, ref mut pending_forwards) in per_source_pending_forwards {
3016 let mut forward_event = None;
3017 if !pending_forwards.is_empty() {
3018 let mut channel_state = self.channel_state.lock().unwrap();
3019 if channel_state.forward_htlcs.is_empty() {
3020 forward_event = Some(Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS))
3022 for (forward_info, prev_htlc_id) in pending_forwards.drain(..) {
3023 match channel_state.forward_htlcs.entry(match forward_info.routing {
3024 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
3025 PendingHTLCRouting::Receive { .. } => 0,
3027 hash_map::Entry::Occupied(mut entry) => {
3028 entry.get_mut().push(HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_funding_outpoint,
3029 prev_htlc_id, forward_info });
3031 hash_map::Entry::Vacant(entry) => {
3032 entry.insert(vec!(HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_funding_outpoint,
3033 prev_htlc_id, forward_info }));
3038 match forward_event {
3040 let mut pending_events = self.pending_events.lock().unwrap();
3041 pending_events.push(events::Event::PendingHTLCsForwardable {
3042 time_forwardable: time
3050 fn internal_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), MsgHandleErrInternal> {
3051 let mut htlcs_to_fail = Vec::new();
3053 let mut channel_state_lock = self.channel_state.lock().unwrap();
3054 let channel_state = &mut *channel_state_lock;
3055 match channel_state.by_id.entry(msg.channel_id) {
3056 hash_map::Entry::Occupied(mut chan) => {
3057 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3058 break Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3060 let was_frozen_for_monitor = chan.get().is_awaiting_monitor_update();
3061 let (commitment_update, pending_forwards, pending_failures, closing_signed, monitor_update, htlcs_to_fail_in) =
3062 break_chan_entry!(self, chan.get_mut().revoke_and_ack(&msg, &self.fee_estimator, &self.logger), channel_state, chan);
3063 htlcs_to_fail = htlcs_to_fail_in;
3064 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
3065 if was_frozen_for_monitor {
3066 assert!(commitment_update.is_none() && closing_signed.is_none() && pending_forwards.is_empty() && pending_failures.is_empty());
3067 break Err(MsgHandleErrInternal::ignore_no_close("Previous monitor update failure prevented responses to RAA".to_owned()));
3069 if let Err(e) = handle_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, commitment_update.is_some(), pending_forwards, pending_failures) {
3071 } else { unreachable!(); }
3074 if let Some(updates) = commitment_update {
3075 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
3076 node_id: counterparty_node_id.clone(),
3080 if let Some(msg) = closing_signed {
3081 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
3082 node_id: counterparty_node_id.clone(),
3086 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()))
3088 hash_map::Entry::Vacant(_) => break Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3091 self.fail_holding_cell_htlcs(htlcs_to_fail, msg.channel_id);
3093 Ok((pending_forwards, mut pending_failures, short_channel_id, channel_outpoint)) => {
3094 for failure in pending_failures.drain(..) {
3095 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), failure.0, &failure.1, failure.2);
3097 self.forward_htlcs(&mut [(short_channel_id, channel_outpoint, pending_forwards)]);
3104 fn internal_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), MsgHandleErrInternal> {
3105 let mut channel_lock = self.channel_state.lock().unwrap();
3106 let channel_state = &mut *channel_lock;
3107 match channel_state.by_id.entry(msg.channel_id) {
3108 hash_map::Entry::Occupied(mut chan) => {
3109 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3110 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3112 try_chan_entry!(self, chan.get_mut().update_fee(&self.fee_estimator, &msg), channel_state, chan);
3114 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3119 fn internal_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), MsgHandleErrInternal> {
3120 let mut channel_state_lock = self.channel_state.lock().unwrap();
3121 let channel_state = &mut *channel_state_lock;
3123 match channel_state.by_id.entry(msg.channel_id) {
3124 hash_map::Entry::Occupied(mut chan) => {
3125 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3126 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3128 if !chan.get().is_usable() {
3129 return Err(MsgHandleErrInternal::from_no_close(LightningError{err: "Got an announcement_signatures before we were ready for it".to_owned(), action: msgs::ErrorAction::IgnoreError}));
3132 let our_node_id = self.get_our_node_id();
3133 let (announcement, our_bitcoin_sig) =
3134 try_chan_entry!(self, chan.get_mut().get_channel_announcement(our_node_id.clone(), self.genesis_hash.clone()), channel_state, chan);
3136 let were_node_one = announcement.node_id_1 == our_node_id;
3137 let msghash = hash_to_message!(&Sha256dHash::hash(&announcement.encode()[..])[..]);
3139 let their_node_key = if were_node_one { &announcement.node_id_2 } else { &announcement.node_id_1 };
3140 let their_bitcoin_key = if were_node_one { &announcement.bitcoin_key_2 } else { &announcement.bitcoin_key_1 };
3141 match (self.secp_ctx.verify(&msghash, &msg.node_signature, their_node_key),
3142 self.secp_ctx.verify(&msghash, &msg.bitcoin_signature, their_bitcoin_key)) {
3144 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));
3145 try_chan_entry!(self, Err(chan_err), channel_state, chan);
3148 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));
3149 try_chan_entry!(self, Err(chan_err), channel_state, chan);
3155 let our_node_sig = self.secp_ctx.sign(&msghash, &self.our_network_key);
3157 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
3158 msg: msgs::ChannelAnnouncement {
3159 node_signature_1: if were_node_one { our_node_sig } else { msg.node_signature },
3160 node_signature_2: if were_node_one { msg.node_signature } else { our_node_sig },
3161 bitcoin_signature_1: if were_node_one { our_bitcoin_sig } else { msg.bitcoin_signature },
3162 bitcoin_signature_2: if were_node_one { msg.bitcoin_signature } else { our_bitcoin_sig },
3163 contents: announcement,
3165 update_msg: self.get_channel_update(chan.get()).unwrap(), // can only fail if we're not in a ready state
3168 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3173 fn internal_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) -> Result<(), MsgHandleErrInternal> {
3174 let mut channel_state_lock = self.channel_state.lock().unwrap();
3175 let channel_state = &mut *channel_state_lock;
3176 let chan_id = match channel_state.short_to_id.get(&msg.contents.short_channel_id) {
3177 Some(chan_id) => chan_id.clone(),
3179 // It's not a local channel
3183 match channel_state.by_id.entry(chan_id) {
3184 hash_map::Entry::Occupied(mut chan) => {
3185 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3186 // TODO: see issue #153, need a consistent behavior on obnoxious behavior from random node
3187 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), chan_id));
3189 try_chan_entry!(self, chan.get_mut().channel_update(&msg), channel_state, chan);
3191 hash_map::Entry::Vacant(_) => unreachable!()
3196 fn internal_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<(), MsgHandleErrInternal> {
3197 let mut channel_state_lock = self.channel_state.lock().unwrap();
3198 let channel_state = &mut *channel_state_lock;
3200 match channel_state.by_id.entry(msg.channel_id) {
3201 hash_map::Entry::Occupied(mut chan) => {
3202 if chan.get().get_counterparty_node_id() != *counterparty_node_id {
3203 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!".to_owned(), msg.channel_id));
3205 // Currently, we expect all holding cell update_adds to be dropped on peer
3206 // disconnect, so Channel's reestablish will never hand us any holding cell
3207 // freed HTLCs to fail backwards. If in the future we no longer drop pending
3208 // add-HTLCs on disconnect, we may be handed HTLCs to fail backwards here.
3209 let (funding_locked, revoke_and_ack, commitment_update, monitor_update_opt, mut order, shutdown) =
3210 try_chan_entry!(self, chan.get_mut().channel_reestablish(msg, &self.logger), channel_state, chan);
3211 if let Some(monitor_update) = monitor_update_opt {
3212 if let Err(e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
3213 // channel_reestablish doesn't guarantee the order it returns is sensical
3214 // for the messages it returns, but if we're setting what messages to
3215 // re-transmit on monitor update success, we need to make sure it is sane.
3216 if revoke_and_ack.is_none() {
3217 order = RAACommitmentOrder::CommitmentFirst;
3219 if commitment_update.is_none() {
3220 order = RAACommitmentOrder::RevokeAndACKFirst;
3222 return_monitor_err!(self, e, channel_state, chan, order, revoke_and_ack.is_some(), commitment_update.is_some());
3223 //TODO: Resend the funding_locked if needed once we get the monitor running again
3226 if let Some(msg) = funding_locked {
3227 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingLocked {
3228 node_id: counterparty_node_id.clone(),
3232 macro_rules! send_raa { () => {
3233 if let Some(msg) = revoke_and_ack {
3234 channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
3235 node_id: counterparty_node_id.clone(),
3240 macro_rules! send_cu { () => {
3241 if let Some(updates) = commitment_update {
3242 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
3243 node_id: counterparty_node_id.clone(),
3249 RAACommitmentOrder::RevokeAndACKFirst => {
3253 RAACommitmentOrder::CommitmentFirst => {
3258 if let Some(msg) = shutdown {
3259 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
3260 node_id: counterparty_node_id.clone(),
3266 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel".to_owned(), msg.channel_id))
3270 /// Begin Update fee process. Allowed only on an outbound channel.
3271 /// If successful, will generate a UpdateHTLCs event, so you should probably poll
3272 /// PeerManager::process_events afterwards.
3273 /// Note: This API is likely to change!
3274 /// (C-not exported) Cause its doc(hidden) anyway
3276 pub fn update_fee(&self, channel_id: [u8;32], feerate_per_kw: u32) -> Result<(), APIError> {
3277 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3278 let counterparty_node_id;
3279 let err: Result<(), _> = loop {
3280 let mut channel_state_lock = self.channel_state.lock().unwrap();
3281 let channel_state = &mut *channel_state_lock;
3283 match channel_state.by_id.entry(channel_id) {
3284 hash_map::Entry::Vacant(_) => return Err(APIError::APIMisuseError{err: format!("Failed to find corresponding channel for id {}", channel_id.to_hex())}),
3285 hash_map::Entry::Occupied(mut chan) => {
3286 if !chan.get().is_outbound() {
3287 return Err(APIError::APIMisuseError{err: "update_fee cannot be sent for an inbound channel".to_owned()});
3289 if chan.get().is_awaiting_monitor_update() {
3290 return Err(APIError::MonitorUpdateFailed);
3292 if !chan.get().is_live() {
3293 return Err(APIError::ChannelUnavailable{err: "Channel is either not yet fully established or peer is currently disconnected".to_owned()});
3295 counterparty_node_id = chan.get().get_counterparty_node_id();
3296 if let Some((update_fee, commitment_signed, monitor_update)) =
3297 break_chan_entry!(self, chan.get_mut().send_update_fee_and_commit(feerate_per_kw, &self.logger), channel_state, chan)
3299 if let Err(_e) = self.chain_monitor.update_channel(chan.get().get_funding_txo().unwrap(), monitor_update) {
3302 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
3303 node_id: chan.get().get_counterparty_node_id(),
3304 updates: msgs::CommitmentUpdate {
3305 update_add_htlcs: Vec::new(),
3306 update_fulfill_htlcs: Vec::new(),
3307 update_fail_htlcs: Vec::new(),
3308 update_fail_malformed_htlcs: Vec::new(),
3309 update_fee: Some(update_fee),
3319 match handle_error!(self, err, counterparty_node_id) {
3320 Ok(_) => unreachable!(),
3321 Err(e) => { Err(APIError::APIMisuseError { err: e.err })}
3325 /// Process pending events from the `chain::Watch`.
3326 fn process_pending_monitor_events(&self) {
3327 let mut failed_channels = Vec::new();
3329 for monitor_event in self.chain_monitor.release_pending_monitor_events() {
3330 match monitor_event {
3331 MonitorEvent::HTLCEvent(htlc_update) => {
3332 if let Some(preimage) = htlc_update.payment_preimage {
3333 log_trace!(self.logger, "Claiming HTLC with preimage {} from our monitor", log_bytes!(preimage.0));
3334 self.claim_funds_internal(self.channel_state.lock().unwrap(), htlc_update.source, preimage);
3336 log_trace!(self.logger, "Failing HTLC with hash {} from our monitor", log_bytes!(htlc_update.payment_hash.0));
3337 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() });
3340 MonitorEvent::CommitmentTxBroadcasted(funding_outpoint) => {
3341 let mut channel_lock = self.channel_state.lock().unwrap();
3342 let channel_state = &mut *channel_lock;
3343 let by_id = &mut channel_state.by_id;
3344 let short_to_id = &mut channel_state.short_to_id;
3345 let pending_msg_events = &mut channel_state.pending_msg_events;
3346 if let Some(mut chan) = by_id.remove(&funding_outpoint.to_channel_id()) {
3347 if let Some(short_id) = chan.get_short_channel_id() {
3348 short_to_id.remove(&short_id);
3350 failed_channels.push(chan.force_shutdown(false));
3351 if let Ok(update) = self.get_channel_update(&chan) {
3352 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
3356 pending_msg_events.push(events::MessageSendEvent::HandleError {
3357 node_id: chan.get_counterparty_node_id(),
3358 action: msgs::ErrorAction::SendErrorMessage {
3359 msg: msgs::ErrorMessage { channel_id: chan.channel_id(), data: "Channel force-closed".to_owned() }
3368 for failure in failed_channels.drain(..) {
3369 self.finish_force_close_channel(failure);
3373 /// Handle a list of channel failures during a block_connected or block_disconnected call,
3374 /// pushing the channel monitor update (if any) to the background events queue and removing the
3376 fn handle_init_event_channel_failures(&self, mut failed_channels: Vec<ShutdownResult>) {
3377 for mut failure in failed_channels.drain(..) {
3378 // Either a commitment transactions has been confirmed on-chain or
3379 // Channel::block_disconnected detected that the funding transaction has been
3380 // reorganized out of the main chain.
3381 // We cannot broadcast our latest local state via monitor update (as
3382 // Channel::force_shutdown tries to make us do) as we may still be in initialization,
3383 // so we track the update internally and handle it when the user next calls
3384 // timer_tick_occurred, guaranteeing we're running normally.
3385 if let Some((funding_txo, update)) = failure.0.take() {
3386 assert_eq!(update.updates.len(), 1);
3387 if let ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } = update.updates[0] {
3388 assert!(should_broadcast);
3389 } else { unreachable!(); }
3390 self.pending_background_events.lock().unwrap().push(BackgroundEvent::ClosingMonitorUpdate((funding_txo, update)));
3392 self.finish_force_close_channel(failure);
3396 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> {
3397 assert!(invoice_expiry_delta_secs <= 60*60*24*365); // Sadly bitcoin timestamps are u32s, so panic before 2106
3399 let payment_secret = PaymentSecret(self.keys_manager.get_secure_random_bytes());
3401 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3402 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
3403 match payment_secrets.entry(payment_hash) {
3404 hash_map::Entry::Vacant(e) => {
3405 e.insert(PendingInboundPayment {
3406 payment_secret, min_value_msat, user_payment_id, payment_preimage,
3407 // We assume that highest_seen_timestamp is pretty close to the current time -
3408 // its updated when we receive a new block with the maximum time we've seen in
3409 // a header. It should never be more than two hours in the future.
3410 // Thus, we add two hours here as a buffer to ensure we absolutely
3411 // never fail a payment too early.
3412 // Note that we assume that received blocks have reasonably up-to-date
3414 expiry_time: self.highest_seen_timestamp.load(Ordering::Acquire) as u64 + invoice_expiry_delta_secs as u64 + 7200,
3417 hash_map::Entry::Occupied(_) => return Err(APIError::APIMisuseError { err: "Duplicate payment hash".to_owned() }),
3422 /// Gets a payment secret and payment hash for use in an invoice given to a third party wishing
3425 /// This differs from [`create_inbound_payment_for_hash`] only in that it generates the
3426 /// [`PaymentHash`] and [`PaymentPreimage`] for you, returning the first and storing the second.
3428 /// The [`PaymentPreimage`] will ultimately be returned to you in the [`PaymentReceived`], which
3429 /// will have the [`PaymentReceived::payment_preimage`] field filled in. That should then be
3430 /// passed directly to [`claim_funds`].
3432 /// See [`create_inbound_payment_for_hash`] for detailed documentation on behavior and requirements.
3434 /// [`claim_funds`]: Self::claim_funds
3435 /// [`PaymentReceived`]: events::Event::PaymentReceived
3436 /// [`PaymentReceived::payment_preimage`]: events::Event::PaymentReceived::payment_preimage
3437 /// [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
3438 pub fn create_inbound_payment(&self, min_value_msat: Option<u64>, invoice_expiry_delta_secs: u32, user_payment_id: u64) -> (PaymentHash, PaymentSecret) {
3439 let payment_preimage = PaymentPreimage(self.keys_manager.get_secure_random_bytes());
3440 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
3443 self.set_payment_hash_secret_map(payment_hash, Some(payment_preimage), min_value_msat, invoice_expiry_delta_secs, user_payment_id)
3444 .expect("RNG Generated Duplicate PaymentHash"))
3447 /// Gets a [`PaymentSecret`] for a given [`PaymentHash`], for which the payment preimage is
3448 /// stored external to LDK.
3450 /// A [`PaymentReceived`] event will only be generated if the [`PaymentSecret`] matches a
3451 /// payment secret fetched via this method or [`create_inbound_payment`], and which is at least
3452 /// the `min_value_msat` provided here, if one is provided.
3454 /// The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) must be globally unique. This
3455 /// method may return an Err if another payment with the same payment_hash is still pending.
3457 /// `user_payment_id` will be provided back in [`PaymentReceived::user_payment_id`] events to
3458 /// allow tracking of which events correspond with which calls to this and
3459 /// [`create_inbound_payment`]. `user_payment_id` has no meaning inside of LDK, it is simply
3460 /// copied to events and otherwise ignored. It may be used to correlate PaymentReceived events
3461 /// with invoice metadata stored elsewhere.
3463 /// `min_value_msat` should be set if the invoice being generated contains a value. Any payment
3464 /// received for the returned [`PaymentHash`] will be required to be at least `min_value_msat`
3465 /// before a [`PaymentReceived`] event will be generated, ensuring that we do not provide the
3466 /// sender "proof-of-payment" unless they have paid the required amount.
3468 /// `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
3469 /// in excess of the current time. This should roughly match the expiry time set in the invoice.
3470 /// After this many seconds, we will remove the inbound payment, resulting in any attempts to
3471 /// pay the invoice failing. The BOLT spec suggests 7,200 secs as a default validity time for
3472 /// invoices when no timeout is set.
3474 /// Note that we use block header time to time-out pending inbound payments (with some margin
3475 /// to compensate for the inaccuracy of block header timestamps). Thus, in practice we will
3476 /// accept a payment and generate a [`PaymentReceived`] event for some time after the expiry.
3477 /// If you need exact expiry semantics, you should enforce them upon receipt of
3478 /// [`PaymentReceived`].
3480 /// Pending inbound payments are stored in memory and in serialized versions of this
3481 /// [`ChannelManager`]. If potentially unbounded numbers of inbound payments may exist and
3482 /// space is limited, you may wish to rate-limit inbound payment creation.
3484 /// May panic if `invoice_expiry_delta_secs` is greater than one year.
3486 /// Note that invoices generated for inbound payments should have their `min_final_cltv_expiry`
3487 /// set to at least [`MIN_FINAL_CLTV_EXPIRY`].
3489 /// [`create_inbound_payment`]: Self::create_inbound_payment
3490 /// [`PaymentReceived`]: events::Event::PaymentReceived
3491 /// [`PaymentReceived::user_payment_id`]: events::Event::PaymentReceived::user_payment_id
3492 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> {
3493 self.set_payment_hash_secret_map(payment_hash, None, min_value_msat, invoice_expiry_delta_secs, user_payment_id)
3497 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> MessageSendEventsProvider for ChannelManager<Signer, M, T, K, F, L>
3498 where M::Target: chain::Watch<Signer>,
3499 T::Target: BroadcasterInterface,
3500 K::Target: KeysInterface<Signer = Signer>,
3501 F::Target: FeeEstimator,
3504 fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent> {
3505 //TODO: This behavior should be documented. It's non-intuitive that we query
3506 // ChannelMonitors when clearing other events.
3507 self.process_pending_monitor_events();
3509 let mut ret = Vec::new();
3510 let mut channel_state = self.channel_state.lock().unwrap();
3511 mem::swap(&mut ret, &mut channel_state.pending_msg_events);
3516 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> EventsProvider for ChannelManager<Signer, M, T, K, F, L>
3517 where M::Target: chain::Watch<Signer>,
3518 T::Target: BroadcasterInterface,
3519 K::Target: KeysInterface<Signer = Signer>,
3520 F::Target: FeeEstimator,
3523 fn get_and_clear_pending_events(&self) -> Vec<Event> {
3524 //TODO: This behavior should be documented. It's non-intuitive that we query
3525 // ChannelMonitors when clearing other events.
3526 self.process_pending_monitor_events();
3528 let mut ret = Vec::new();
3529 let mut pending_events = self.pending_events.lock().unwrap();
3530 mem::swap(&mut ret, &mut *pending_events);
3535 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> chain::Listen for ChannelManager<Signer, M, T, K, F, L>
3537 M::Target: chain::Watch<Signer>,
3538 T::Target: BroadcasterInterface,
3539 K::Target: KeysInterface<Signer = Signer>,
3540 F::Target: FeeEstimator,
3543 fn block_connected(&self, block: &Block, height: u32) {
3545 let best_block = self.best_block.read().unwrap();
3546 assert_eq!(best_block.block_hash(), block.header.prev_blockhash,
3547 "Blocks must be connected in chain-order - the connected header must build on the last connected header");
3548 assert_eq!(best_block.height(), height - 1,
3549 "Blocks must be connected in chain-order - the connected block height must be one greater than the previous height");
3552 let txdata: Vec<_> = block.txdata.iter().enumerate().collect();
3553 self.transactions_confirmed(&block.header, &txdata, height);
3554 self.best_block_updated(&block.header, height);
3557 fn block_disconnected(&self, header: &BlockHeader, height: u32) {
3558 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3559 let new_height = height - 1;
3561 let mut best_block = self.best_block.write().unwrap();
3562 assert_eq!(best_block.block_hash(), header.block_hash(),
3563 "Blocks must be disconnected in chain-order - the disconnected header must be the last connected header");
3564 assert_eq!(best_block.height(), height,
3565 "Blocks must be disconnected in chain-order - the disconnected block must have the correct height");
3566 *best_block = BestBlock::new(header.prev_blockhash, new_height)
3569 self.do_chain_event(Some(new_height), |channel| channel.best_block_updated(new_height, header.time));
3573 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> chain::Confirm for ChannelManager<Signer, M, T, K, F, L>
3575 M::Target: chain::Watch<Signer>,
3576 T::Target: BroadcasterInterface,
3577 K::Target: KeysInterface<Signer = Signer>,
3578 F::Target: FeeEstimator,
3581 fn transactions_confirmed(&self, header: &BlockHeader, txdata: &TransactionData, height: u32) {
3582 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
3583 // during initialization prior to the chain_monitor being fully configured in some cases.
3584 // See the docs for `ChannelManagerReadArgs` for more.
3586 let block_hash = header.block_hash();
3587 log_trace!(self.logger, "{} transactions included in block {} at height {} provided", txdata.len(), block_hash, height);
3589 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3590 self.do_chain_event(Some(height), |channel| channel.transactions_confirmed(&block_hash, height, txdata, &self.logger).map(|a| (a, Vec::new())));
3593 fn best_block_updated(&self, header: &BlockHeader, height: u32) {
3594 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
3595 // during initialization prior to the chain_monitor being fully configured in some cases.
3596 // See the docs for `ChannelManagerReadArgs` for more.
3598 let block_hash = header.block_hash();
3599 log_trace!(self.logger, "New best block: {} at height {}", block_hash, height);
3601 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3603 *self.best_block.write().unwrap() = BestBlock::new(block_hash, height);
3605 self.do_chain_event(Some(height), |channel| channel.best_block_updated(height, header.time));
3607 macro_rules! max_time {
3608 ($timestamp: expr) => {
3610 // Update $timestamp to be the max of its current value and the block
3611 // timestamp. This should keep us close to the current time without relying on
3612 // having an explicit local time source.
3613 // Just in case we end up in a race, we loop until we either successfully
3614 // update $timestamp or decide we don't need to.
3615 let old_serial = $timestamp.load(Ordering::Acquire);
3616 if old_serial >= header.time as usize { break; }
3617 if $timestamp.compare_exchange(old_serial, header.time as usize, Ordering::AcqRel, Ordering::Relaxed).is_ok() {
3623 max_time!(self.last_node_announcement_serial);
3624 max_time!(self.highest_seen_timestamp);
3625 let mut payment_secrets = self.pending_inbound_payments.lock().unwrap();
3626 payment_secrets.retain(|_, inbound_payment| {
3627 inbound_payment.expiry_time > header.time as u64
3631 fn get_relevant_txids(&self) -> Vec<Txid> {
3632 let channel_state = self.channel_state.lock().unwrap();
3633 let mut res = Vec::with_capacity(channel_state.short_to_id.len());
3634 for chan in channel_state.by_id.values() {
3635 if let Some(funding_txo) = chan.get_funding_txo() {
3636 res.push(funding_txo.txid);
3642 fn transaction_unconfirmed(&self, txid: &Txid) {
3643 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3644 self.do_chain_event(None, |channel| {
3645 if let Some(funding_txo) = channel.get_funding_txo() {
3646 if funding_txo.txid == *txid {
3647 channel.funding_transaction_unconfirmed().map(|_| (None, Vec::new()))
3648 } else { Ok((None, Vec::new())) }
3649 } else { Ok((None, Vec::new())) }
3654 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> ChannelManager<Signer, M, T, K, F, L>
3656 M::Target: chain::Watch<Signer>,
3657 T::Target: BroadcasterInterface,
3658 K::Target: KeysInterface<Signer = Signer>,
3659 F::Target: FeeEstimator,
3662 /// Calls a function which handles an on-chain event (blocks dis/connected, transactions
3663 /// un/confirmed, etc) on each channel, handling any resulting errors or messages generated by
3665 fn do_chain_event<FN: Fn(&mut Channel<Signer>) -> Result<(Option<msgs::FundingLocked>, Vec<(HTLCSource, PaymentHash)>), msgs::ErrorMessage>>
3666 (&self, height_opt: Option<u32>, f: FN) {
3667 // Note that we MUST NOT end up calling methods on self.chain_monitor here - we're called
3668 // during initialization prior to the chain_monitor being fully configured in some cases.
3669 // See the docs for `ChannelManagerReadArgs` for more.
3671 let mut failed_channels = Vec::new();
3672 let mut timed_out_htlcs = Vec::new();
3674 let mut channel_lock = self.channel_state.lock().unwrap();
3675 let channel_state = &mut *channel_lock;
3676 let short_to_id = &mut channel_state.short_to_id;
3677 let pending_msg_events = &mut channel_state.pending_msg_events;
3678 channel_state.by_id.retain(|_, channel| {
3679 let res = f(channel);
3680 if let Ok((chan_res, mut timed_out_pending_htlcs)) = res {
3681 for (source, payment_hash) in timed_out_pending_htlcs.drain(..) {
3682 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
3683 timed_out_htlcs.push((source, payment_hash, HTLCFailReason::Reason {
3684 failure_code: 0x1000 | 14, // expiry_too_soon, or at least it is now
3688 if let Some(funding_locked) = chan_res {
3689 pending_msg_events.push(events::MessageSendEvent::SendFundingLocked {
3690 node_id: channel.get_counterparty_node_id(),
3691 msg: funding_locked,
3693 if let Some(announcement_sigs) = self.get_announcement_sigs(channel) {
3694 log_trace!(self.logger, "Sending funding_locked and announcement_signatures for {}", log_bytes!(channel.channel_id()));
3695 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
3696 node_id: channel.get_counterparty_node_id(),
3697 msg: announcement_sigs,
3700 log_trace!(self.logger, "Sending funding_locked WITHOUT announcement_signatures for {}", log_bytes!(channel.channel_id()));
3702 short_to_id.insert(channel.get_short_channel_id().unwrap(), channel.channel_id());
3704 } else if let Err(e) = res {
3705 if let Some(short_id) = channel.get_short_channel_id() {
3706 short_to_id.remove(&short_id);
3708 // It looks like our counterparty went on-chain or funding transaction was
3709 // reorged out of the main chain. Close the channel.
3710 failed_channels.push(channel.force_shutdown(true));
3711 if let Ok(update) = self.get_channel_update(&channel) {
3712 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
3716 pending_msg_events.push(events::MessageSendEvent::HandleError {
3717 node_id: channel.get_counterparty_node_id(),
3718 action: msgs::ErrorAction::SendErrorMessage { msg: e },
3725 if let Some(height) = height_opt {
3726 channel_state.claimable_htlcs.retain(|payment_hash, htlcs| {
3727 htlcs.retain(|htlc| {
3728 // If height is approaching the number of blocks we think it takes us to get
3729 // our commitment transaction confirmed before the HTLC expires, plus the
3730 // number of blocks we generally consider it to take to do a commitment update,
3731 // just give up on it and fail the HTLC.
3732 if height >= htlc.cltv_expiry - HTLC_FAIL_BACK_BUFFER {
3733 let mut htlc_msat_height_data = byte_utils::be64_to_array(htlc.value).to_vec();
3734 htlc_msat_height_data.extend_from_slice(&byte_utils::be32_to_array(height));
3735 timed_out_htlcs.push((HTLCSource::PreviousHopData(htlc.prev_hop.clone()), payment_hash.clone(), HTLCFailReason::Reason {
3736 failure_code: 0x4000 | 15,
3737 data: htlc_msat_height_data
3742 !htlcs.is_empty() // Only retain this entry if htlcs has at least one entry.
3747 self.handle_init_event_channel_failures(failed_channels);
3749 for (source, payment_hash, reason) in timed_out_htlcs.drain(..) {
3750 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), source, &payment_hash, reason);
3754 /// Blocks until ChannelManager needs to be persisted or a timeout is reached. It returns a bool
3755 /// indicating whether persistence is necessary. Only one listener on
3756 /// `await_persistable_update` or `await_persistable_update_timeout` is guaranteed to be woken
3758 /// Note that the feature `allow_wallclock_use` must be enabled to use this function.
3759 #[cfg(any(test, feature = "allow_wallclock_use"))]
3760 pub fn await_persistable_update_timeout(&self, max_wait: Duration) -> bool {
3761 self.persistence_notifier.wait_timeout(max_wait)
3764 /// Blocks until ChannelManager needs to be persisted. Only one listener on
3765 /// `await_persistable_update` or `await_persistable_update_timeout` is guaranteed to be woken
3767 pub fn await_persistable_update(&self) {
3768 self.persistence_notifier.wait()
3771 #[cfg(any(test, feature = "_test_utils"))]
3772 pub fn get_persistence_condvar_value(&self) -> bool {
3773 let mutcond = &self.persistence_notifier.persistence_lock;
3774 let &(ref mtx, _) = mutcond;
3775 let guard = mtx.lock().unwrap();
3780 impl<Signer: Sign, M: Deref , T: Deref , K: Deref , F: Deref , L: Deref >
3781 ChannelMessageHandler for ChannelManager<Signer, M, T, K, F, L>
3782 where M::Target: chain::Watch<Signer>,
3783 T::Target: BroadcasterInterface,
3784 K::Target: KeysInterface<Signer = Signer>,
3785 F::Target: FeeEstimator,
3788 fn handle_open_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::OpenChannel) {
3789 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3790 let _ = handle_error!(self, self.internal_open_channel(counterparty_node_id, their_features, msg), *counterparty_node_id);
3793 fn handle_accept_channel(&self, counterparty_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::AcceptChannel) {
3794 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3795 let _ = handle_error!(self, self.internal_accept_channel(counterparty_node_id, their_features, msg), *counterparty_node_id);
3798 fn handle_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) {
3799 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3800 let _ = handle_error!(self, self.internal_funding_created(counterparty_node_id, msg), *counterparty_node_id);
3803 fn handle_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) {
3804 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3805 let _ = handle_error!(self, self.internal_funding_signed(counterparty_node_id, msg), *counterparty_node_id);
3808 fn handle_funding_locked(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingLocked) {
3809 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3810 let _ = handle_error!(self, self.internal_funding_locked(counterparty_node_id, msg), *counterparty_node_id);
3813 fn handle_shutdown(&self, counterparty_node_id: &PublicKey, their_features: &InitFeatures, msg: &msgs::Shutdown) {
3814 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3815 let _ = handle_error!(self, self.internal_shutdown(counterparty_node_id, their_features, msg), *counterparty_node_id);
3818 fn handle_closing_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
3819 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3820 let _ = handle_error!(self, self.internal_closing_signed(counterparty_node_id, msg), *counterparty_node_id);
3823 fn handle_update_add_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
3824 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3825 let _ = handle_error!(self, self.internal_update_add_htlc(counterparty_node_id, msg), *counterparty_node_id);
3828 fn handle_update_fulfill_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
3829 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3830 let _ = handle_error!(self, self.internal_update_fulfill_htlc(counterparty_node_id, msg), *counterparty_node_id);
3833 fn handle_update_fail_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
3834 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3835 let _ = handle_error!(self, self.internal_update_fail_htlc(counterparty_node_id, msg), *counterparty_node_id);
3838 fn handle_update_fail_malformed_htlc(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
3839 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3840 let _ = handle_error!(self, self.internal_update_fail_malformed_htlc(counterparty_node_id, msg), *counterparty_node_id);
3843 fn handle_commitment_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
3844 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3845 let _ = handle_error!(self, self.internal_commitment_signed(counterparty_node_id, msg), *counterparty_node_id);
3848 fn handle_revoke_and_ack(&self, counterparty_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
3849 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3850 let _ = handle_error!(self, self.internal_revoke_and_ack(counterparty_node_id, msg), *counterparty_node_id);
3853 fn handle_update_fee(&self, counterparty_node_id: &PublicKey, msg: &msgs::UpdateFee) {
3854 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3855 let _ = handle_error!(self, self.internal_update_fee(counterparty_node_id, msg), *counterparty_node_id);
3858 fn handle_announcement_signatures(&self, counterparty_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
3859 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3860 let _ = handle_error!(self, self.internal_announcement_signatures(counterparty_node_id, msg), *counterparty_node_id);
3863 fn handle_channel_update(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelUpdate) {
3864 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3865 let _ = handle_error!(self, self.internal_channel_update(counterparty_node_id, msg), *counterparty_node_id);
3868 fn handle_channel_reestablish(&self, counterparty_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
3869 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3870 let _ = handle_error!(self, self.internal_channel_reestablish(counterparty_node_id, msg), *counterparty_node_id);
3873 fn peer_disconnected(&self, counterparty_node_id: &PublicKey, no_connection_possible: bool) {
3874 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3875 let mut failed_channels = Vec::new();
3876 let mut failed_payments = Vec::new();
3877 let mut no_channels_remain = true;
3879 let mut channel_state_lock = self.channel_state.lock().unwrap();
3880 let channel_state = &mut *channel_state_lock;
3881 let short_to_id = &mut channel_state.short_to_id;
3882 let pending_msg_events = &mut channel_state.pending_msg_events;
3883 if no_connection_possible {
3884 log_debug!(self.logger, "Failing all channels with {} due to no_connection_possible", log_pubkey!(counterparty_node_id));
3885 channel_state.by_id.retain(|_, chan| {
3886 if chan.get_counterparty_node_id() == *counterparty_node_id {
3887 if let Some(short_id) = chan.get_short_channel_id() {
3888 short_to_id.remove(&short_id);
3890 failed_channels.push(chan.force_shutdown(true));
3891 if let Ok(update) = self.get_channel_update(&chan) {
3892 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
3902 log_debug!(self.logger, "Marking channels with {} disconnected and generating channel_updates", log_pubkey!(counterparty_node_id));
3903 channel_state.by_id.retain(|_, chan| {
3904 if chan.get_counterparty_node_id() == *counterparty_node_id {
3905 // Note that currently on channel reestablish we assert that there are no
3906 // holding cell add-HTLCs, so if in the future we stop removing uncommitted HTLCs
3907 // on peer disconnect here, there will need to be corresponding changes in
3908 // reestablish logic.
3909 let failed_adds = chan.remove_uncommitted_htlcs_and_mark_paused(&self.logger);
3910 chan.to_disabled_marked();
3911 if !failed_adds.is_empty() {
3912 let chan_update = self.get_channel_update(&chan).map(|u| u.encode_with_len()).unwrap(); // Cannot add/recv HTLCs before we have a short_id so unwrap is safe
3913 failed_payments.push((chan_update, failed_adds));
3915 if chan.is_shutdown() {
3916 if let Some(short_id) = chan.get_short_channel_id() {
3917 short_to_id.remove(&short_id);
3921 no_channels_remain = false;
3927 pending_msg_events.retain(|msg| {
3929 &events::MessageSendEvent::SendAcceptChannel { ref node_id, .. } => node_id != counterparty_node_id,
3930 &events::MessageSendEvent::SendOpenChannel { ref node_id, .. } => node_id != counterparty_node_id,
3931 &events::MessageSendEvent::SendFundingCreated { ref node_id, .. } => node_id != counterparty_node_id,
3932 &events::MessageSendEvent::SendFundingSigned { ref node_id, .. } => node_id != counterparty_node_id,
3933 &events::MessageSendEvent::SendFundingLocked { ref node_id, .. } => node_id != counterparty_node_id,
3934 &events::MessageSendEvent::SendAnnouncementSignatures { ref node_id, .. } => node_id != counterparty_node_id,
3935 &events::MessageSendEvent::UpdateHTLCs { ref node_id, .. } => node_id != counterparty_node_id,
3936 &events::MessageSendEvent::SendRevokeAndACK { ref node_id, .. } => node_id != counterparty_node_id,
3937 &events::MessageSendEvent::SendClosingSigned { ref node_id, .. } => node_id != counterparty_node_id,
3938 &events::MessageSendEvent::SendShutdown { ref node_id, .. } => node_id != counterparty_node_id,
3939 &events::MessageSendEvent::SendChannelReestablish { ref node_id, .. } => node_id != counterparty_node_id,
3940 &events::MessageSendEvent::BroadcastChannelAnnouncement { .. } => true,
3941 &events::MessageSendEvent::BroadcastNodeAnnouncement { .. } => true,
3942 &events::MessageSendEvent::BroadcastChannelUpdate { .. } => true,
3943 &events::MessageSendEvent::HandleError { ref node_id, .. } => node_id != counterparty_node_id,
3944 &events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => true,
3945 &events::MessageSendEvent::SendChannelRangeQuery { .. } => false,
3946 &events::MessageSendEvent::SendShortIdsQuery { .. } => false,
3947 &events::MessageSendEvent::SendReplyChannelRange { .. } => false,
3951 if no_channels_remain {
3952 self.per_peer_state.write().unwrap().remove(counterparty_node_id);
3955 for failure in failed_channels.drain(..) {
3956 self.finish_force_close_channel(failure);
3958 for (chan_update, mut htlc_sources) in failed_payments {
3959 for (htlc_source, payment_hash) in htlc_sources.drain(..) {
3960 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source, &payment_hash, HTLCFailReason::Reason { failure_code: 0x1000 | 7, data: chan_update.clone() });
3965 fn peer_connected(&self, counterparty_node_id: &PublicKey, init_msg: &msgs::Init) {
3966 log_debug!(self.logger, "Generating channel_reestablish events for {}", log_pubkey!(counterparty_node_id));
3968 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
3971 let mut peer_state_lock = self.per_peer_state.write().unwrap();
3972 match peer_state_lock.entry(counterparty_node_id.clone()) {
3973 hash_map::Entry::Vacant(e) => {
3974 e.insert(Mutex::new(PeerState {
3975 latest_features: init_msg.features.clone(),
3978 hash_map::Entry::Occupied(e) => {
3979 e.get().lock().unwrap().latest_features = init_msg.features.clone();
3984 let mut channel_state_lock = self.channel_state.lock().unwrap();
3985 let channel_state = &mut *channel_state_lock;
3986 let pending_msg_events = &mut channel_state.pending_msg_events;
3987 channel_state.by_id.retain(|_, chan| {
3988 if chan.get_counterparty_node_id() == *counterparty_node_id {
3989 if !chan.have_received_message() {
3990 // If we created this (outbound) channel while we were disconnected from the
3991 // peer we probably failed to send the open_channel message, which is now
3992 // lost. We can't have had anything pending related to this channel, so we just
3996 pending_msg_events.push(events::MessageSendEvent::SendChannelReestablish {
3997 node_id: chan.get_counterparty_node_id(),
3998 msg: chan.get_channel_reestablish(&self.logger),
4004 //TODO: Also re-broadcast announcement_signatures
4007 fn handle_error(&self, counterparty_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
4008 let _persistence_guard = PersistenceNotifierGuard::new(&self.total_consistency_lock, &self.persistence_notifier);
4010 if msg.channel_id == [0; 32] {
4011 for chan in self.list_channels() {
4012 if chan.remote_network_id == *counterparty_node_id {
4013 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
4014 let _ = self.force_close_channel_with_peer(&chan.channel_id, Some(counterparty_node_id));
4018 // Untrusted messages from peer, we throw away the error if id points to a non-existent channel
4019 let _ = self.force_close_channel_with_peer(&msg.channel_id, Some(counterparty_node_id));
4024 /// Used to signal to the ChannelManager persister that the manager needs to be re-persisted to
4025 /// disk/backups, through `await_persistable_update_timeout` and `await_persistable_update`.
4026 struct PersistenceNotifier {
4027 /// Users won't access the persistence_lock directly, but rather wait on its bool using
4028 /// `wait_timeout` and `wait`.
4029 persistence_lock: (Mutex<bool>, Condvar),
4032 impl PersistenceNotifier {
4035 persistence_lock: (Mutex::new(false), Condvar::new()),
4041 let &(ref mtx, ref cvar) = &self.persistence_lock;
4042 let mut guard = mtx.lock().unwrap();
4043 guard = cvar.wait(guard).unwrap();
4044 let result = *guard;
4052 #[cfg(any(test, feature = "allow_wallclock_use"))]
4053 fn wait_timeout(&self, max_wait: Duration) -> bool {
4054 let current_time = Instant::now();
4056 let &(ref mtx, ref cvar) = &self.persistence_lock;
4057 let mut guard = mtx.lock().unwrap();
4058 guard = cvar.wait_timeout(guard, max_wait).unwrap().0;
4059 // Due to spurious wakeups that can happen on `wait_timeout`, here we need to check if the
4060 // desired wait time has actually passed, and if not then restart the loop with a reduced wait
4061 // time. Note that this logic can be highly simplified through the use of
4062 // `Condvar::wait_while` and `Condvar::wait_timeout_while`, if and when our MSRV is raised to
4064 let elapsed = current_time.elapsed();
4065 let result = *guard;
4066 if result || elapsed >= max_wait {
4070 match max_wait.checked_sub(elapsed) {
4071 None => return result,
4077 // Signal to the ChannelManager persister that there are updates necessitating persisting to disk.
4079 let &(ref persist_mtx, ref cnd) = &self.persistence_lock;
4080 let mut persistence_lock = persist_mtx.lock().unwrap();
4081 *persistence_lock = true;
4082 mem::drop(persistence_lock);
4087 const SERIALIZATION_VERSION: u8 = 1;
4088 const MIN_SERIALIZATION_VERSION: u8 = 1;
4090 impl Writeable for PendingHTLCInfo {
4091 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
4092 match &self.routing {
4093 &PendingHTLCRouting::Forward { ref onion_packet, ref short_channel_id } => {
4095 onion_packet.write(writer)?;
4096 short_channel_id.write(writer)?;
4098 &PendingHTLCRouting::Receive { ref payment_data, ref incoming_cltv_expiry } => {
4100 payment_data.payment_secret.write(writer)?;
4101 payment_data.total_msat.write(writer)?;
4102 incoming_cltv_expiry.write(writer)?;
4105 self.incoming_shared_secret.write(writer)?;
4106 self.payment_hash.write(writer)?;
4107 self.amt_to_forward.write(writer)?;
4108 self.outgoing_cltv_value.write(writer)?;
4113 impl Readable for PendingHTLCInfo {
4114 fn read<R: ::std::io::Read>(reader: &mut R) -> Result<PendingHTLCInfo, DecodeError> {
4115 Ok(PendingHTLCInfo {
4116 routing: match Readable::read(reader)? {
4117 0u8 => PendingHTLCRouting::Forward {
4118 onion_packet: Readable::read(reader)?,
4119 short_channel_id: Readable::read(reader)?,
4121 1u8 => PendingHTLCRouting::Receive {
4122 payment_data: msgs::FinalOnionHopData {
4123 payment_secret: Readable::read(reader)?,
4124 total_msat: Readable::read(reader)?,
4126 incoming_cltv_expiry: Readable::read(reader)?,
4128 _ => return Err(DecodeError::InvalidValue),
4130 incoming_shared_secret: Readable::read(reader)?,
4131 payment_hash: Readable::read(reader)?,
4132 amt_to_forward: Readable::read(reader)?,
4133 outgoing_cltv_value: Readable::read(reader)?,
4138 impl Writeable for HTLCFailureMsg {
4139 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
4141 &HTLCFailureMsg::Relay(ref fail_msg) => {
4143 fail_msg.write(writer)?;
4145 &HTLCFailureMsg::Malformed(ref fail_msg) => {
4147 fail_msg.write(writer)?;
4154 impl Readable for HTLCFailureMsg {
4155 fn read<R: ::std::io::Read>(reader: &mut R) -> Result<HTLCFailureMsg, DecodeError> {
4156 match <u8 as Readable>::read(reader)? {
4157 0 => Ok(HTLCFailureMsg::Relay(Readable::read(reader)?)),
4158 1 => Ok(HTLCFailureMsg::Malformed(Readable::read(reader)?)),
4159 _ => Err(DecodeError::InvalidValue),
4164 impl Writeable for PendingHTLCStatus {
4165 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
4167 &PendingHTLCStatus::Forward(ref forward_info) => {
4169 forward_info.write(writer)?;
4171 &PendingHTLCStatus::Fail(ref fail_msg) => {
4173 fail_msg.write(writer)?;
4180 impl Readable for PendingHTLCStatus {
4181 fn read<R: ::std::io::Read>(reader: &mut R) -> Result<PendingHTLCStatus, DecodeError> {
4182 match <u8 as Readable>::read(reader)? {
4183 0 => Ok(PendingHTLCStatus::Forward(Readable::read(reader)?)),
4184 1 => Ok(PendingHTLCStatus::Fail(Readable::read(reader)?)),
4185 _ => Err(DecodeError::InvalidValue),
4190 impl_writeable!(HTLCPreviousHopData, 0, {
4194 incoming_packet_shared_secret
4197 impl Writeable for ClaimableHTLC {
4198 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
4199 self.prev_hop.write(writer)?;
4200 self.value.write(writer)?;
4201 self.payment_data.payment_secret.write(writer)?;
4202 self.payment_data.total_msat.write(writer)?;
4203 self.cltv_expiry.write(writer)
4207 impl Readable for ClaimableHTLC {
4208 fn read<R: ::std::io::Read>(reader: &mut R) -> Result<Self, DecodeError> {
4210 prev_hop: Readable::read(reader)?,
4211 value: Readable::read(reader)?,
4212 payment_data: msgs::FinalOnionHopData {
4213 payment_secret: Readable::read(reader)?,
4214 total_msat: Readable::read(reader)?,
4216 cltv_expiry: Readable::read(reader)?,
4221 impl Writeable for HTLCSource {
4222 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
4224 &HTLCSource::PreviousHopData(ref hop_data) => {
4226 hop_data.write(writer)?;
4228 &HTLCSource::OutboundRoute { ref path, ref session_priv, ref first_hop_htlc_msat } => {
4230 path.write(writer)?;
4231 session_priv.write(writer)?;
4232 first_hop_htlc_msat.write(writer)?;
4239 impl Readable for HTLCSource {
4240 fn read<R: ::std::io::Read>(reader: &mut R) -> Result<HTLCSource, DecodeError> {
4241 match <u8 as Readable>::read(reader)? {
4242 0 => Ok(HTLCSource::PreviousHopData(Readable::read(reader)?)),
4243 1 => Ok(HTLCSource::OutboundRoute {
4244 path: Readable::read(reader)?,
4245 session_priv: Readable::read(reader)?,
4246 first_hop_htlc_msat: Readable::read(reader)?,
4248 _ => Err(DecodeError::InvalidValue),
4253 impl Writeable for HTLCFailReason {
4254 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
4256 &HTLCFailReason::LightningError { ref err } => {
4260 &HTLCFailReason::Reason { ref failure_code, ref data } => {
4262 failure_code.write(writer)?;
4263 data.write(writer)?;
4270 impl Readable for HTLCFailReason {
4271 fn read<R: ::std::io::Read>(reader: &mut R) -> Result<HTLCFailReason, DecodeError> {
4272 match <u8 as Readable>::read(reader)? {
4273 0 => Ok(HTLCFailReason::LightningError { err: Readable::read(reader)? }),
4274 1 => Ok(HTLCFailReason::Reason {
4275 failure_code: Readable::read(reader)?,
4276 data: Readable::read(reader)?,
4278 _ => Err(DecodeError::InvalidValue),
4283 impl Writeable for HTLCForwardInfo {
4284 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
4286 &HTLCForwardInfo::AddHTLC { ref prev_short_channel_id, ref prev_funding_outpoint, ref prev_htlc_id, ref forward_info } => {
4288 prev_short_channel_id.write(writer)?;
4289 prev_funding_outpoint.write(writer)?;
4290 prev_htlc_id.write(writer)?;
4291 forward_info.write(writer)?;
4293 &HTLCForwardInfo::FailHTLC { ref htlc_id, ref err_packet } => {
4295 htlc_id.write(writer)?;
4296 err_packet.write(writer)?;
4303 impl Readable for HTLCForwardInfo {
4304 fn read<R: ::std::io::Read>(reader: &mut R) -> Result<HTLCForwardInfo, DecodeError> {
4305 match <u8 as Readable>::read(reader)? {
4306 0 => Ok(HTLCForwardInfo::AddHTLC {
4307 prev_short_channel_id: Readable::read(reader)?,
4308 prev_funding_outpoint: Readable::read(reader)?,
4309 prev_htlc_id: Readable::read(reader)?,
4310 forward_info: Readable::read(reader)?,
4312 1 => Ok(HTLCForwardInfo::FailHTLC {
4313 htlc_id: Readable::read(reader)?,
4314 err_packet: Readable::read(reader)?,
4316 _ => Err(DecodeError::InvalidValue),
4321 impl_writeable!(PendingInboundPayment, 0, {
4329 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref> Writeable for ChannelManager<Signer, M, T, K, F, L>
4330 where M::Target: chain::Watch<Signer>,
4331 T::Target: BroadcasterInterface,
4332 K::Target: KeysInterface<Signer = Signer>,
4333 F::Target: FeeEstimator,
4336 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
4337 let _consistency_lock = self.total_consistency_lock.write().unwrap();
4339 writer.write_all(&[SERIALIZATION_VERSION; 1])?;
4340 writer.write_all(&[MIN_SERIALIZATION_VERSION; 1])?;
4342 self.genesis_hash.write(writer)?;
4344 let best_block = self.best_block.read().unwrap();
4345 best_block.height().write(writer)?;
4346 best_block.block_hash().write(writer)?;
4349 let channel_state = self.channel_state.lock().unwrap();
4350 let mut unfunded_channels = 0;
4351 for (_, channel) in channel_state.by_id.iter() {
4352 if !channel.is_funding_initiated() {
4353 unfunded_channels += 1;
4356 ((channel_state.by_id.len() - unfunded_channels) as u64).write(writer)?;
4357 for (_, channel) in channel_state.by_id.iter() {
4358 if channel.is_funding_initiated() {
4359 channel.write(writer)?;
4363 (channel_state.forward_htlcs.len() as u64).write(writer)?;
4364 for (short_channel_id, pending_forwards) in channel_state.forward_htlcs.iter() {
4365 short_channel_id.write(writer)?;
4366 (pending_forwards.len() as u64).write(writer)?;
4367 for forward in pending_forwards {
4368 forward.write(writer)?;
4372 (channel_state.claimable_htlcs.len() as u64).write(writer)?;
4373 for (payment_hash, previous_hops) in channel_state.claimable_htlcs.iter() {
4374 payment_hash.write(writer)?;
4375 (previous_hops.len() as u64).write(writer)?;
4376 for htlc in previous_hops.iter() {
4377 htlc.write(writer)?;
4381 let per_peer_state = self.per_peer_state.write().unwrap();
4382 (per_peer_state.len() as u64).write(writer)?;
4383 for (peer_pubkey, peer_state_mutex) in per_peer_state.iter() {
4384 peer_pubkey.write(writer)?;
4385 let peer_state = peer_state_mutex.lock().unwrap();
4386 peer_state.latest_features.write(writer)?;
4389 let events = self.pending_events.lock().unwrap();
4390 (events.len() as u64).write(writer)?;
4391 for event in events.iter() {
4392 event.write(writer)?;
4395 let background_events = self.pending_background_events.lock().unwrap();
4396 (background_events.len() as u64).write(writer)?;
4397 for event in background_events.iter() {
4399 BackgroundEvent::ClosingMonitorUpdate((funding_txo, monitor_update)) => {
4401 funding_txo.write(writer)?;
4402 monitor_update.write(writer)?;
4407 (self.last_node_announcement_serial.load(Ordering::Acquire) as u32).write(writer)?;
4408 (self.highest_seen_timestamp.load(Ordering::Acquire) as u32).write(writer)?;
4410 let pending_inbound_payments = self.pending_inbound_payments.lock().unwrap();
4411 (pending_inbound_payments.len() as u64).write(writer)?;
4412 for (hash, pending_payment) in pending_inbound_payments.iter() {
4413 hash.write(writer)?;
4414 pending_payment.write(writer)?;
4421 /// Arguments for the creation of a ChannelManager that are not deserialized.
4423 /// At a high-level, the process for deserializing a ChannelManager and resuming normal operation
4425 /// 1) Deserialize all stored ChannelMonitors.
4426 /// 2) Deserialize the ChannelManager by filling in this struct and calling:
4427 /// <(BlockHash, ChannelManager)>::read(reader, args)
4428 /// This may result in closing some Channels if the ChannelMonitor is newer than the stored
4429 /// ChannelManager state to ensure no loss of funds. Thus, transactions may be broadcasted.
4430 /// 3) If you are not fetching full blocks, register all relevant ChannelMonitor outpoints the same
4431 /// way you would handle a `chain::Filter` call using ChannelMonitor::get_outputs_to_watch() and
4432 /// ChannelMonitor::get_funding_txo().
4433 /// 4) Reconnect blocks on your ChannelMonitors.
4434 /// 5) Disconnect/connect blocks on the ChannelManager.
4435 /// 6) Move the ChannelMonitors into your local chain::Watch.
4437 /// Note that the ordering of #4-6 is not of importance, however all three must occur before you
4438 /// call any other methods on the newly-deserialized ChannelManager.
4440 /// Note that because some channels may be closed during deserialization, it is critical that you
4441 /// always deserialize only the latest version of a ChannelManager and ChannelMonitors available to
4442 /// you. If you deserialize an old ChannelManager (during which force-closure transactions may be
4443 /// broadcast), and then later deserialize a newer version of the same ChannelManager (which will
4444 /// not force-close the same channels but consider them live), you may end up revoking a state for
4445 /// which you've already broadcasted the transaction.
4446 pub struct ChannelManagerReadArgs<'a, Signer: 'a + Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
4447 where M::Target: chain::Watch<Signer>,
4448 T::Target: BroadcasterInterface,
4449 K::Target: KeysInterface<Signer = Signer>,
4450 F::Target: FeeEstimator,
4453 /// The keys provider which will give us relevant keys. Some keys will be loaded during
4454 /// deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
4456 pub keys_manager: K,
4458 /// The fee_estimator for use in the ChannelManager in the future.
4460 /// No calls to the FeeEstimator will be made during deserialization.
4461 pub fee_estimator: F,
4462 /// The chain::Watch for use in the ChannelManager in the future.
4464 /// No calls to the chain::Watch will be made during deserialization. It is assumed that
4465 /// you have deserialized ChannelMonitors separately and will add them to your
4466 /// chain::Watch after deserializing this ChannelManager.
4467 pub chain_monitor: M,
4469 /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
4470 /// used to broadcast the latest local commitment transactions of channels which must be
4471 /// force-closed during deserialization.
4472 pub tx_broadcaster: T,
4473 /// The Logger for use in the ChannelManager and which may be used to log information during
4474 /// deserialization.
4476 /// Default settings used for new channels. Any existing channels will continue to use the
4477 /// runtime settings which were stored when the ChannelManager was serialized.
4478 pub default_config: UserConfig,
4480 /// A map from channel funding outpoints to ChannelMonitors for those channels (ie
4481 /// value.get_funding_txo() should be the key).
4483 /// If a monitor is inconsistent with the channel state during deserialization the channel will
4484 /// be force-closed using the data in the ChannelMonitor and the channel will be dropped. This
4485 /// is true for missing channels as well. If there is a monitor missing for which we find
4486 /// channel data Err(DecodeError::InvalidValue) will be returned.
4488 /// In such cases the latest local transactions will be sent to the tx_broadcaster included in
4491 /// (C-not exported) because we have no HashMap bindings
4492 pub channel_monitors: HashMap<OutPoint, &'a mut ChannelMonitor<Signer>>,
4495 impl<'a, Signer: 'a + Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
4496 ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>
4497 where M::Target: chain::Watch<Signer>,
4498 T::Target: BroadcasterInterface,
4499 K::Target: KeysInterface<Signer = Signer>,
4500 F::Target: FeeEstimator,
4503 /// Simple utility function to create a ChannelManagerReadArgs which creates the monitor
4504 /// HashMap for you. This is primarily useful for C bindings where it is not practical to
4505 /// populate a HashMap directly from C.
4506 pub fn new(keys_manager: K, fee_estimator: F, chain_monitor: M, tx_broadcaster: T, logger: L, default_config: UserConfig,
4507 mut channel_monitors: Vec<&'a mut ChannelMonitor<Signer>>) -> Self {
4509 keys_manager, fee_estimator, chain_monitor, tx_broadcaster, logger, default_config,
4510 channel_monitors: channel_monitors.drain(..).map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect()
4515 // Implement ReadableArgs for an Arc'd ChannelManager to make it a bit easier to work with the
4516 // SipmleArcChannelManager type:
4517 impl<'a, Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
4518 ReadableArgs<ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>> for (BlockHash, Arc<ChannelManager<Signer, M, T, K, F, L>>)
4519 where M::Target: chain::Watch<Signer>,
4520 T::Target: BroadcasterInterface,
4521 K::Target: KeysInterface<Signer = Signer>,
4522 F::Target: FeeEstimator,
4525 fn read<R: ::std::io::Read>(reader: &mut R, args: ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>) -> Result<Self, DecodeError> {
4526 let (blockhash, chan_manager) = <(BlockHash, ChannelManager<Signer, M, T, K, F, L>)>::read(reader, args)?;
4527 Ok((blockhash, Arc::new(chan_manager)))
4531 impl<'a, Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
4532 ReadableArgs<ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>> for (BlockHash, ChannelManager<Signer, M, T, K, F, L>)
4533 where M::Target: chain::Watch<Signer>,
4534 T::Target: BroadcasterInterface,
4535 K::Target: KeysInterface<Signer = Signer>,
4536 F::Target: FeeEstimator,
4539 fn read<R: ::std::io::Read>(reader: &mut R, mut args: ChannelManagerReadArgs<'a, Signer, M, T, K, F, L>) -> Result<Self, DecodeError> {
4540 let _ver: u8 = Readable::read(reader)?;
4541 let min_ver: u8 = Readable::read(reader)?;
4542 if min_ver > SERIALIZATION_VERSION {
4543 return Err(DecodeError::UnknownVersion);
4546 let genesis_hash: BlockHash = Readable::read(reader)?;
4547 let best_block_height: u32 = Readable::read(reader)?;
4548 let best_block_hash: BlockHash = Readable::read(reader)?;
4550 let mut failed_htlcs = Vec::new();
4552 let channel_count: u64 = Readable::read(reader)?;
4553 let mut funding_txo_set = HashSet::with_capacity(cmp::min(channel_count as usize, 128));
4554 let mut by_id = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
4555 let mut short_to_id = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
4556 for _ in 0..channel_count {
4557 let mut channel: Channel<Signer> = Channel::read(reader, &args.keys_manager)?;
4558 let funding_txo = channel.get_funding_txo().ok_or(DecodeError::InvalidValue)?;
4559 funding_txo_set.insert(funding_txo.clone());
4560 if let Some(ref mut monitor) = args.channel_monitors.get_mut(&funding_txo) {
4561 if channel.get_cur_holder_commitment_transaction_number() < monitor.get_cur_holder_commitment_number() ||
4562 channel.get_revoked_counterparty_commitment_transaction_number() < monitor.get_min_seen_secret() ||
4563 channel.get_cur_counterparty_commitment_transaction_number() < monitor.get_cur_counterparty_commitment_number() ||
4564 channel.get_latest_monitor_update_id() > monitor.get_latest_update_id() {
4565 // If the channel is ahead of the monitor, return InvalidValue:
4566 return Err(DecodeError::InvalidValue);
4567 } else if channel.get_cur_holder_commitment_transaction_number() > monitor.get_cur_holder_commitment_number() ||
4568 channel.get_revoked_counterparty_commitment_transaction_number() > monitor.get_min_seen_secret() ||
4569 channel.get_cur_counterparty_commitment_transaction_number() > monitor.get_cur_counterparty_commitment_number() ||
4570 channel.get_latest_monitor_update_id() < monitor.get_latest_update_id() {
4571 // But if the channel is behind of the monitor, close the channel:
4572 let (_, mut new_failed_htlcs) = channel.force_shutdown(true);
4573 failed_htlcs.append(&mut new_failed_htlcs);
4574 monitor.broadcast_latest_holder_commitment_txn(&args.tx_broadcaster, &args.logger);
4576 if let Some(short_channel_id) = channel.get_short_channel_id() {
4577 short_to_id.insert(short_channel_id, channel.channel_id());
4579 by_id.insert(channel.channel_id(), channel);
4582 return Err(DecodeError::InvalidValue);
4586 for (ref funding_txo, ref mut monitor) in args.channel_monitors.iter_mut() {
4587 if !funding_txo_set.contains(funding_txo) {
4588 monitor.broadcast_latest_holder_commitment_txn(&args.tx_broadcaster, &args.logger);
4592 const MAX_ALLOC_SIZE: usize = 1024 * 64;
4593 let forward_htlcs_count: u64 = Readable::read(reader)?;
4594 let mut forward_htlcs = HashMap::with_capacity(cmp::min(forward_htlcs_count as usize, 128));
4595 for _ in 0..forward_htlcs_count {
4596 let short_channel_id = Readable::read(reader)?;
4597 let pending_forwards_count: u64 = Readable::read(reader)?;
4598 let mut pending_forwards = Vec::with_capacity(cmp::min(pending_forwards_count as usize, MAX_ALLOC_SIZE/mem::size_of::<HTLCForwardInfo>()));
4599 for _ in 0..pending_forwards_count {
4600 pending_forwards.push(Readable::read(reader)?);
4602 forward_htlcs.insert(short_channel_id, pending_forwards);
4605 let claimable_htlcs_count: u64 = Readable::read(reader)?;
4606 let mut claimable_htlcs = HashMap::with_capacity(cmp::min(claimable_htlcs_count as usize, 128));
4607 for _ in 0..claimable_htlcs_count {
4608 let payment_hash = Readable::read(reader)?;
4609 let previous_hops_len: u64 = Readable::read(reader)?;
4610 let mut previous_hops = Vec::with_capacity(cmp::min(previous_hops_len as usize, MAX_ALLOC_SIZE/mem::size_of::<ClaimableHTLC>()));
4611 for _ in 0..previous_hops_len {
4612 previous_hops.push(Readable::read(reader)?);
4614 claimable_htlcs.insert(payment_hash, previous_hops);
4617 let peer_count: u64 = Readable::read(reader)?;
4618 let mut per_peer_state = HashMap::with_capacity(cmp::min(peer_count as usize, MAX_ALLOC_SIZE/mem::size_of::<(PublicKey, Mutex<PeerState>)>()));
4619 for _ in 0..peer_count {
4620 let peer_pubkey = Readable::read(reader)?;
4621 let peer_state = PeerState {
4622 latest_features: Readable::read(reader)?,
4624 per_peer_state.insert(peer_pubkey, Mutex::new(peer_state));
4627 let event_count: u64 = Readable::read(reader)?;
4628 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>()));
4629 for _ in 0..event_count {
4630 match MaybeReadable::read(reader)? {
4631 Some(event) => pending_events_read.push(event),
4636 let background_event_count: u64 = Readable::read(reader)?;
4637 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>()));
4638 for _ in 0..background_event_count {
4639 match <u8 as Readable>::read(reader)? {
4640 0 => pending_background_events_read.push(BackgroundEvent::ClosingMonitorUpdate((Readable::read(reader)?, Readable::read(reader)?))),
4641 _ => return Err(DecodeError::InvalidValue),
4645 let last_node_announcement_serial: u32 = Readable::read(reader)?;
4646 let highest_seen_timestamp: u32 = Readable::read(reader)?;
4648 let pending_inbound_payment_count: u64 = Readable::read(reader)?;
4649 let mut pending_inbound_payments: HashMap<PaymentHash, PendingInboundPayment> = HashMap::with_capacity(cmp::min(pending_inbound_payment_count as usize, MAX_ALLOC_SIZE/(3*32)));
4650 for _ in 0..pending_inbound_payment_count {
4651 if pending_inbound_payments.insert(Readable::read(reader)?, Readable::read(reader)?).is_some() {
4652 return Err(DecodeError::InvalidValue);
4656 let mut secp_ctx = Secp256k1::new();
4657 secp_ctx.seeded_randomize(&args.keys_manager.get_secure_random_bytes());
4659 let channel_manager = ChannelManager {
4661 fee_estimator: args.fee_estimator,
4662 chain_monitor: args.chain_monitor,
4663 tx_broadcaster: args.tx_broadcaster,
4665 best_block: RwLock::new(BestBlock::new(best_block_hash, best_block_height)),
4667 channel_state: Mutex::new(ChannelHolder {
4672 pending_msg_events: Vec::new(),
4674 pending_inbound_payments: Mutex::new(pending_inbound_payments),
4676 our_network_key: args.keys_manager.get_node_secret(),
4677 our_network_pubkey: PublicKey::from_secret_key(&secp_ctx, &args.keys_manager.get_node_secret()),
4680 last_node_announcement_serial: AtomicUsize::new(last_node_announcement_serial as usize),
4681 highest_seen_timestamp: AtomicUsize::new(highest_seen_timestamp as usize),
4683 per_peer_state: RwLock::new(per_peer_state),
4685 pending_events: Mutex::new(pending_events_read),
4686 pending_background_events: Mutex::new(pending_background_events_read),
4687 total_consistency_lock: RwLock::new(()),
4688 persistence_notifier: PersistenceNotifier::new(),
4690 keys_manager: args.keys_manager,
4691 logger: args.logger,
4692 default_configuration: args.default_config,
4695 for htlc_source in failed_htlcs.drain(..) {
4696 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() });
4699 //TODO: Broadcast channel update for closed channels, but only after we've made a
4700 //connection or two.
4702 Ok((best_block_hash.clone(), channel_manager))
4708 use ln::channelmanager::PersistenceNotifier;
4710 use std::sync::atomic::{AtomicBool, Ordering};
4712 use std::time::Duration;
4715 fn test_wait_timeout() {
4716 let persistence_notifier = Arc::new(PersistenceNotifier::new());
4717 let thread_notifier = Arc::clone(&persistence_notifier);
4719 let exit_thread = Arc::new(AtomicBool::new(false));
4720 let exit_thread_clone = exit_thread.clone();
4721 thread::spawn(move || {
4723 let &(ref persist_mtx, ref cnd) = &thread_notifier.persistence_lock;
4724 let mut persistence_lock = persist_mtx.lock().unwrap();
4725 *persistence_lock = true;
4728 if exit_thread_clone.load(Ordering::SeqCst) {
4734 // Check that we can block indefinitely until updates are available.
4735 let _ = persistence_notifier.wait();
4737 // Check that the PersistenceNotifier will return after the given duration if updates are
4740 if persistence_notifier.wait_timeout(Duration::from_millis(100)) {
4745 exit_thread.store(true, Ordering::SeqCst);
4747 // Check that the PersistenceNotifier will return after the given duration even if no updates
4750 if !persistence_notifier.wait_timeout(Duration::from_millis(100)) {
4757 #[cfg(all(any(test, feature = "_test_utils"), feature = "unstable"))]
4760 use chain::chainmonitor::ChainMonitor;
4761 use chain::channelmonitor::Persist;
4762 use chain::keysinterface::{KeysManager, InMemorySigner};
4763 use ln::channelmanager::{BestBlock, ChainParameters, ChannelManager, PaymentHash, PaymentPreimage};
4764 use ln::features::{InitFeatures, InvoiceFeatures};
4765 use ln::functional_test_utils::*;
4766 use ln::msgs::ChannelMessageHandler;
4767 use routing::network_graph::NetworkGraph;
4768 use routing::router::get_route;
4769 use util::test_utils;
4770 use util::config::UserConfig;
4771 use util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
4773 use bitcoin::hashes::Hash;
4774 use bitcoin::hashes::sha256::Hash as Sha256;
4775 use bitcoin::{Block, BlockHeader, Transaction, TxOut};
4777 use std::sync::Mutex;
4781 struct NodeHolder<'a, P: Persist<InMemorySigner>> {
4782 node: &'a ChannelManager<InMemorySigner,
4783 &'a ChainMonitor<InMemorySigner, &'a test_utils::TestChainSource,
4784 &'a test_utils::TestBroadcaster, &'a test_utils::TestFeeEstimator,
4785 &'a test_utils::TestLogger, &'a P>,
4786 &'a test_utils::TestBroadcaster, &'a KeysManager,
4787 &'a test_utils::TestFeeEstimator, &'a test_utils::TestLogger>
4792 fn bench_sends(bench: &mut Bencher) {
4793 bench_two_sends(bench, test_utils::TestPersister::new(), test_utils::TestPersister::new());
4796 pub fn bench_two_sends<P: Persist<InMemorySigner>>(bench: &mut Bencher, persister_a: P, persister_b: P) {
4797 // Do a simple benchmark of sending a payment back and forth between two nodes.
4798 // Note that this is unrealistic as each payment send will require at least two fsync
4800 let network = bitcoin::Network::Testnet;
4801 let genesis_hash = bitcoin::blockdata::constants::genesis_block(network).header.block_hash();
4803 let tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())};
4804 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4806 let mut config: UserConfig = Default::default();
4807 config.own_channel_config.minimum_depth = 1;
4809 let logger_a = test_utils::TestLogger::with_id("node a".to_owned());
4810 let chain_monitor_a = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_a);
4811 let seed_a = [1u8; 32];
4812 let keys_manager_a = KeysManager::new(&seed_a, 42, 42);
4813 let node_a = ChannelManager::new(&fee_estimator, &chain_monitor_a, &tx_broadcaster, &logger_a, &keys_manager_a, config.clone(), ChainParameters {
4815 best_block: BestBlock::from_genesis(network),
4817 let node_a_holder = NodeHolder { node: &node_a };
4819 let logger_b = test_utils::TestLogger::with_id("node a".to_owned());
4820 let chain_monitor_b = ChainMonitor::new(None, &tx_broadcaster, &logger_a, &fee_estimator, &persister_b);
4821 let seed_b = [2u8; 32];
4822 let keys_manager_b = KeysManager::new(&seed_b, 42, 42);
4823 let node_b = ChannelManager::new(&fee_estimator, &chain_monitor_b, &tx_broadcaster, &logger_b, &keys_manager_b, config.clone(), ChainParameters {
4825 best_block: BestBlock::from_genesis(network),
4827 let node_b_holder = NodeHolder { node: &node_b };
4829 node_a.create_channel(node_b.get_our_node_id(), 8_000_000, 100_000_000, 42, None).unwrap();
4830 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()));
4831 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()));
4834 if let Event::FundingGenerationReady { temporary_channel_id, output_script, .. } = get_event!(node_a_holder, Event::FundingGenerationReady) {
4835 tx = Transaction { version: 2, lock_time: 0, input: Vec::new(), output: vec![TxOut {
4836 value: 8_000_000, script_pubkey: output_script,
4838 node_a.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
4839 } else { panic!(); }
4841 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()));
4842 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()));
4844 assert_eq!(&tx_broadcaster.txn_broadcasted.lock().unwrap()[..], &[tx.clone()]);
4847 header: BlockHeader { version: 0x20000000, prev_blockhash: genesis_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
4850 Listen::block_connected(&node_a, &block, 1);
4851 Listen::block_connected(&node_b, &block, 1);
4853 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()));
4854 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()));
4856 let dummy_graph = NetworkGraph::new(genesis_hash);
4858 let mut payment_count: u64 = 0;
4859 macro_rules! send_payment {
4860 ($node_a: expr, $node_b: expr) => {
4861 let usable_channels = $node_a.list_usable_channels();
4862 let route = get_route(&$node_a.get_our_node_id(), &dummy_graph, &$node_b.get_our_node_id(), Some(InvoiceFeatures::known()),
4863 Some(&usable_channels.iter().map(|r| r).collect::<Vec<_>>()), &[], 10_000, TEST_FINAL_CLTV, &logger_a).unwrap();
4865 let mut payment_preimage = PaymentPreimage([0; 32]);
4866 payment_preimage.0[0..8].copy_from_slice(&payment_count.to_le_bytes());
4868 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
4869 let payment_secret = $node_b.create_inbound_payment_for_hash(payment_hash, None, 7200, 0).unwrap();
4871 $node_a.send_payment(&route, payment_hash, &Some(payment_secret)).unwrap();
4872 let payment_event = SendEvent::from_event($node_a.get_and_clear_pending_msg_events().pop().unwrap());
4873 $node_b.handle_update_add_htlc(&$node_a.get_our_node_id(), &payment_event.msgs[0]);
4874 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &payment_event.commitment_msg);
4875 let (raa, cs) = get_revoke_commit_msgs!(NodeHolder { node: &$node_b }, $node_a.get_our_node_id());
4876 $node_a.handle_revoke_and_ack(&$node_b.get_our_node_id(), &raa);
4877 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &cs);
4878 $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()));
4880 expect_pending_htlcs_forwardable!(NodeHolder { node: &$node_b });
4881 expect_payment_received!(NodeHolder { node: &$node_b }, payment_hash, payment_secret, 10_000);
4882 assert!($node_b.claim_funds(payment_preimage));
4884 match $node_b.get_and_clear_pending_msg_events().pop().unwrap() {
4885 MessageSendEvent::UpdateHTLCs { node_id, updates } => {
4886 assert_eq!(node_id, $node_a.get_our_node_id());
4887 $node_a.handle_update_fulfill_htlc(&$node_b.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
4888 $node_a.handle_commitment_signed(&$node_b.get_our_node_id(), &updates.commitment_signed);
4890 _ => panic!("Failed to generate claim event"),
4893 let (raa, cs) = get_revoke_commit_msgs!(NodeHolder { node: &$node_a }, $node_b.get_our_node_id());
4894 $node_b.handle_revoke_and_ack(&$node_a.get_our_node_id(), &raa);
4895 $node_b.handle_commitment_signed(&$node_a.get_our_node_id(), &cs);
4896 $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()));
4898 expect_payment_sent!(NodeHolder { node: &$node_a }, payment_preimage);
4903 send_payment!(node_a, node_b);
4904 send_payment!(node_b, node_a);