1 //! The top-level channel management and payment tracking stuff lives here.
3 //! The ChannelManager is the main chunk of logic implementing the lightning protocol and is
4 //! responsible for tracking which channels are open, HTLCs are in flight and reestablishing those
5 //! upon reconnect to the relevant peer(s).
7 //! It does not manage routing logic (see ln::router for that) nor does it manage constructing
8 //! on-chain transactions (it only monitors the chain to watch for any force-closes that might
9 //! imply it needs to fail HTLCs/payments/channels it manages).
11 use bitcoin::blockdata::block::BlockHeader;
12 use bitcoin::blockdata::transaction::Transaction;
13 use bitcoin::blockdata::constants::genesis_block;
14 use bitcoin::network::constants::Network;
15 use bitcoin::util::hash::BitcoinHash;
17 use bitcoin_hashes::{Hash, HashEngine};
18 use bitcoin_hashes::hmac::{Hmac, HmacEngine};
19 use bitcoin_hashes::sha256::Hash as Sha256;
20 use bitcoin_hashes::sha256d::Hash as Sha256dHash;
21 use bitcoin_hashes::cmp::fixed_time_eq;
23 use secp256k1::key::{SecretKey,PublicKey};
24 use secp256k1::Secp256k1;
25 use secp256k1::ecdh::SharedSecret;
28 use chain::chaininterface::{BroadcasterInterface,ChainListener,FeeEstimator};
29 use chain::transaction::OutPoint;
30 use ln::channel::{Channel, ChannelError};
31 use ln::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, ChannelMonitorUpdateErr, ManyChannelMonitor, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY, HTLC_FAIL_BACK_BUFFER};
32 use ln::features::{InitFeatures, NodeFeatures};
33 use ln::router::{Route, RouteHop};
36 use ln::msgs::{ChannelMessageHandler, DecodeError, LightningError};
37 use chain::keysinterface::{ChannelKeys, KeysInterface, KeysManager, InMemoryChannelKeys};
38 use util::config::UserConfig;
39 use util::{byte_utils, events};
40 use util::ser::{Readable, ReadableArgs, Writeable, Writer};
41 use util::chacha20::{ChaCha20, ChaChaReader};
42 use util::logger::Logger;
43 use util::errors::APIError;
46 use std::collections::{HashMap, hash_map, HashSet};
47 use std::io::{Cursor, Read};
48 use std::sync::{Arc, Mutex, MutexGuard, RwLock};
49 use std::sync::atomic::{AtomicUsize, Ordering};
50 use std::time::Duration;
51 use std::marker::{Sync, Send};
54 // We hold various information about HTLC relay in the HTLC objects in Channel itself:
56 // Upon receipt of an HTLC from a peer, we'll give it a PendingHTLCStatus indicating if it should
57 // forward the HTLC with information it will give back to us when it does so, or if it should Fail
58 // the HTLC with the relevant message for the Channel to handle giving to the remote peer.
60 // Once said HTLC is committed in the Channel, if the PendingHTLCStatus indicated Forward, the
61 // Channel will return the PendingHTLCInfo back to us, and we will create an HTLCForwardInfo
62 // with it to track where it came from (in case of onwards-forward error), waiting a random delay
63 // before we forward it.
65 // We will then use HTLCForwardInfo's PendingHTLCInfo to construct an outbound HTLC, with a
66 // relevant HTLCSource::PreviousHopData filled in to indicate where it came from (which we can use
67 // to either fail-backwards or fulfill the HTLC backwards along the relevant path).
68 // Alternatively, we can fill an outbound HTLC with a HTLCSource::OutboundRoute indicating this is
69 // our payment, which we can use to decode errors or inform the user that the payment was sent.
71 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
72 enum PendingHTLCRouting {
74 onion_packet: msgs::OnionPacket,
75 short_channel_id: u64, // This should be NonZero<u64> eventually when we bump MSRV
78 payment_data: Option<msgs::FinalOnionHopData>,
79 incoming_cltv_expiry: u32, // Used to track when we should expire pending HTLCs that go unclaimed
83 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
84 pub(super) struct PendingHTLCInfo {
85 routing: PendingHTLCRouting,
86 incoming_shared_secret: [u8; 32],
87 payment_hash: PaymentHash,
88 pub(super) amt_to_forward: u64,
89 pub(super) outgoing_cltv_value: u32,
92 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
93 pub(super) enum HTLCFailureMsg {
94 Relay(msgs::UpdateFailHTLC),
95 Malformed(msgs::UpdateFailMalformedHTLC),
98 /// Stores whether we can't forward an HTLC or relevant forwarding info
99 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
100 pub(super) enum PendingHTLCStatus {
101 Forward(PendingHTLCInfo),
102 Fail(HTLCFailureMsg),
105 pub(super) enum HTLCForwardInfo {
107 prev_short_channel_id: u64,
109 forward_info: PendingHTLCInfo,
113 err_packet: msgs::OnionErrorPacket,
117 /// Tracks the inbound corresponding to an outbound HTLC
118 #[derive(Clone, PartialEq)]
119 pub(super) struct HTLCPreviousHopData {
120 short_channel_id: u64,
122 incoming_packet_shared_secret: [u8; 32],
125 struct ClaimableHTLC {
126 prev_hop: HTLCPreviousHopData,
128 /// Filled in when the HTLC was received with a payment_secret packet, which contains a
129 /// total_msat (which may differ from value if this is a Multi-Path Payment) and a
130 /// payment_secret which prevents path-probing attacks and can associate different HTLCs which
131 /// are part of the same payment.
132 payment_data: Option<msgs::FinalOnionHopData>,
136 /// Tracks the inbound corresponding to an outbound HTLC
137 #[derive(Clone, PartialEq)]
138 pub(super) enum HTLCSource {
139 PreviousHopData(HTLCPreviousHopData),
142 session_priv: SecretKey,
143 /// Technically we can recalculate this from the route, but we cache it here to avoid
144 /// doing a double-pass on route when we get a failure back
145 first_hop_htlc_msat: u64,
150 pub fn dummy() -> Self {
151 HTLCSource::OutboundRoute {
153 session_priv: SecretKey::from_slice(&[1; 32]).unwrap(),
154 first_hop_htlc_msat: 0,
159 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
160 pub(super) enum HTLCFailReason {
162 err: msgs::OnionErrorPacket,
170 /// payment_hash type, use to cross-lock hop
171 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
172 pub struct PaymentHash(pub [u8;32]);
173 /// payment_preimage type, use to route payment between hop
174 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
175 pub struct PaymentPreimage(pub [u8;32]);
176 /// payment_secret type, use to authenticate sender to the receiver and tie MPP HTLCs together
177 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
178 pub struct PaymentSecret(pub [u8;32]);
180 type ShutdownResult = (Option<OutPoint>, ChannelMonitorUpdate, Vec<(HTLCSource, PaymentHash)>);
182 /// Error type returned across the channel_state mutex boundary. When an Err is generated for a
183 /// Channel, we generally end up with a ChannelError::Close for which we have to close the channel
184 /// immediately (ie with no further calls on it made). Thus, this step happens inside a
185 /// channel_state lock. We then return the set of things that need to be done outside the lock in
186 /// this struct and call handle_error!() on it.
188 struct MsgHandleErrInternal {
189 err: msgs::LightningError,
190 shutdown_finish: Option<(ShutdownResult, Option<msgs::ChannelUpdate>)>,
192 impl MsgHandleErrInternal {
194 fn send_err_msg_no_close(err: &'static str, channel_id: [u8; 32]) -> Self {
196 err: LightningError {
198 action: msgs::ErrorAction::SendErrorMessage {
199 msg: msgs::ErrorMessage {
201 data: err.to_string()
205 shutdown_finish: None,
209 fn ignore_no_close(err: &'static str) -> Self {
211 err: LightningError {
213 action: msgs::ErrorAction::IgnoreError,
215 shutdown_finish: None,
219 fn from_no_close(err: msgs::LightningError) -> Self {
220 Self { err, shutdown_finish: None }
223 fn from_finish_shutdown(err: &'static str, channel_id: [u8; 32], shutdown_res: ShutdownResult, channel_update: Option<msgs::ChannelUpdate>) -> Self {
225 err: LightningError {
227 action: msgs::ErrorAction::SendErrorMessage {
228 msg: msgs::ErrorMessage {
230 data: err.to_string()
234 shutdown_finish: Some((shutdown_res, channel_update)),
238 fn from_chan_no_close(err: ChannelError, channel_id: [u8; 32]) -> Self {
241 ChannelError::Ignore(msg) => LightningError {
243 action: msgs::ErrorAction::IgnoreError,
245 ChannelError::Close(msg) => LightningError {
247 action: msgs::ErrorAction::SendErrorMessage {
248 msg: msgs::ErrorMessage {
250 data: msg.to_string()
254 ChannelError::CloseDelayBroadcast { msg, .. } => LightningError {
256 action: msgs::ErrorAction::SendErrorMessage {
257 msg: msgs::ErrorMessage {
259 data: msg.to_string()
264 shutdown_finish: None,
269 /// We hold back HTLCs we intend to relay for a random interval greater than this (see
270 /// Event::PendingHTLCsForwardable for the API guidelines indicating how long should be waited).
271 /// This provides some limited amount of privacy. Ideally this would range from somewhere like one
272 /// second to 30 seconds, but people expect lightning to be, you know, kinda fast, sadly.
273 const MIN_HTLC_RELAY_HOLDING_CELL_MILLIS: u64 = 100;
275 /// For events which result in both a RevokeAndACK and a CommitmentUpdate, by default they should
276 /// be sent in the order they appear in the return value, however sometimes the order needs to be
277 /// variable at runtime (eg Channel::channel_reestablish needs to re-send messages in the order
278 /// they were originally sent). In those cases, this enum is also returned.
279 #[derive(Clone, PartialEq)]
280 pub(super) enum RAACommitmentOrder {
281 /// Send the CommitmentUpdate messages first
283 /// Send the RevokeAndACK message first
287 // Note this is only exposed in cfg(test):
288 pub(super) struct ChannelHolder<ChanSigner: ChannelKeys> {
289 pub(super) by_id: HashMap<[u8; 32], Channel<ChanSigner>>,
290 pub(super) short_to_id: HashMap<u64, [u8; 32]>,
291 /// short channel id -> forward infos. Key of 0 means payments received
292 /// Note that while this is held in the same mutex as the channels themselves, no consistency
293 /// guarantees are made about the existence of a channel with the short id here, nor the short
294 /// ids in the PendingHTLCInfo!
295 pub(super) forward_htlcs: HashMap<u64, Vec<HTLCForwardInfo>>,
296 /// (payment_hash, payment_secret) -> Vec<HTLCs> for tracking HTLCs that
297 /// were to us and can be failed/claimed by the user
298 /// Note that while this is held in the same mutex as the channels themselves, no consistency
299 /// guarantees are made about the channels given here actually existing anymore by the time you
301 claimable_htlcs: HashMap<(PaymentHash, Option<PaymentSecret>), Vec<ClaimableHTLC>>,
302 /// Messages to send to peers - pushed to in the same lock that they are generated in (except
303 /// for broadcast messages, where ordering isn't as strict).
304 pub(super) pending_msg_events: Vec<events::MessageSendEvent>,
307 /// State we hold per-peer. In the future we should put channels in here, but for now we only hold
308 /// the latest Init features we heard from the peer.
310 latest_features: InitFeatures,
313 #[cfg(not(any(target_pointer_width = "32", target_pointer_width = "64")))]
314 const ERR: () = "You need at least 32 bit pointers (well, usize, but we'll assume they're the same) for ChannelManager::latest_block_height";
316 /// SimpleArcChannelManager is useful when you need a ChannelManager with a static lifetime, e.g.
317 /// when you're using lightning-net-tokio (since tokio::spawn requires parameters with static
318 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
319 /// SimpleRefChannelManager is the more appropriate type. Defining these type aliases prevents
320 /// issues such as overly long function definitions. Note that the ChannelManager can take any
321 /// type that implements KeysInterface for its keys manager, but this type alias chooses the
322 /// concrete type of the KeysManager.
323 pub type SimpleArcChannelManager<M, T, F> = Arc<ChannelManager<InMemoryChannelKeys, Arc<M>, Arc<T>, Arc<KeysManager>, Arc<F>>>;
325 /// SimpleRefChannelManager is a type alias for a ChannelManager reference, and is the reference
326 /// counterpart to the SimpleArcChannelManager type alias. Use this type by default when you don't
327 /// need a ChannelManager with a static lifetime. You'll need a static lifetime in cases such as
328 /// usage of lightning-net-tokio (since tokio::spawn requires parameters with static lifetimes).
329 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
330 /// helps with issues such as long function definitions. Note that the ChannelManager can take any
331 /// type that implements KeysInterface for its keys manager, but this type alias chooses the
332 /// concrete type of the KeysManager.
333 pub type SimpleRefChannelManager<'a, 'b, 'c, 'd, M, T, F> = ChannelManager<InMemoryChannelKeys, &'a M, &'b T, &'c KeysManager, &'d F>;
335 /// Manager which keeps track of a number of channels and sends messages to the appropriate
336 /// channel, also tracking HTLC preimages and forwarding onion packets appropriately.
338 /// Implements ChannelMessageHandler, handling the multi-channel parts and passing things through
339 /// to individual Channels.
341 /// Implements Writeable to write out all channel state to disk. Implies peer_disconnected() for
342 /// all peers during write/read (though does not modify this instance, only the instance being
343 /// serialized). This will result in any channels which have not yet exchanged funding_created (ie
344 /// called funding_transaction_generated for outbound channels).
346 /// Note that you can be a bit lazier about writing out ChannelManager than you can be with
347 /// ChannelMonitors. With ChannelMonitors you MUST write each monitor update out to disk before
348 /// returning from ManyChannelMonitor::add_/update_monitor, with ChannelManagers, writing updates
349 /// happens out-of-band (and will prevent any other ChannelManager operations from occurring during
350 /// the serialization process). If the deserialized version is out-of-date compared to the
351 /// ChannelMonitors passed by reference to read(), those channels will be force-closed based on the
352 /// ChannelMonitor state and no funds will be lost (mod on-chain transaction fees).
354 /// Note that the deserializer is only implemented for (Sha256dHash, ChannelManager), which
355 /// tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
356 /// the "reorg path" (ie call block_disconnected() until you get to a common block and then call
357 /// block_connected() to step towards your best block) upon deserialization before using the
360 /// Note that ChannelManager is responsible for tracking liveness of its channels and generating
361 /// ChannelUpdate messages informing peers that the channel is temporarily disabled. To avoid
362 /// spam due to quick disconnection/reconnection, updates are not sent until the channel has been
363 /// offline for a full minute. In order to track this, you must call
364 /// timer_chan_freshness_every_min roughly once per minute, though it doesn't have to be perfect.
366 /// Rather than using a plain ChannelManager, it is preferable to use either a SimpleArcChannelManager
367 /// a SimpleRefChannelManager, for conciseness. See their documentation for more details, but
368 /// essentially you should default to using a SimpleRefChannelManager, and use a
369 /// SimpleArcChannelManager when you require a ChannelManager with a static lifetime, such as when
370 /// you're using lightning-net-tokio.
371 pub struct ChannelManager<ChanSigner: ChannelKeys, M: Deref, T: Deref, K: Deref, F: Deref>
372 where M::Target: ManyChannelMonitor<ChanSigner>,
373 T::Target: BroadcasterInterface,
374 K::Target: KeysInterface<ChanKeySigner = ChanSigner>,
375 F::Target: FeeEstimator,
377 default_configuration: UserConfig,
378 genesis_hash: Sha256dHash,
384 pub(super) latest_block_height: AtomicUsize,
386 latest_block_height: AtomicUsize,
387 last_block_hash: Mutex<Sha256dHash>,
388 secp_ctx: Secp256k1<secp256k1::All>,
391 pub(super) channel_state: Mutex<ChannelHolder<ChanSigner>>,
393 channel_state: Mutex<ChannelHolder<ChanSigner>>,
394 our_network_key: SecretKey,
396 /// Used to track the last value sent in a node_announcement "timestamp" field. We ensure this
397 /// value increases strictly since we don't assume access to a time source.
398 last_node_announcement_serial: AtomicUsize,
400 /// The bulk of our storage will eventually be here (channels and message queues and the like).
401 /// If we are connected to a peer we always at least have an entry here, even if no channels
402 /// are currently open with that peer.
403 /// Because adding or removing an entry is rare, we usually take an outer read lock and then
404 /// operate on the inner value freely. Sadly, this prevents parallel operation when opening a
406 per_peer_state: RwLock<HashMap<PublicKey, Mutex<PeerState>>>,
408 pending_events: Mutex<Vec<events::Event>>,
409 /// Used when we have to take a BIG lock to make sure everything is self-consistent.
410 /// Essentially just when we're serializing ourselves out.
411 /// Taken first everywhere where we are making changes before any other locks.
412 total_consistency_lock: RwLock<()>,
419 /// The amount of time we require our counterparty wait to claim their money (ie time between when
420 /// we, or our watchtower, must check for them having broadcast a theft transaction).
421 pub(crate) const BREAKDOWN_TIMEOUT: u16 = 6 * 24;
422 /// The amount of time we're willing to wait to claim money back to us
423 pub(crate) const MAX_LOCAL_BREAKDOWN_TIMEOUT: u16 = 6 * 24 * 7;
425 /// The minimum number of blocks between an inbound HTLC's CLTV and the corresponding outbound
426 /// HTLC's CLTV. This should always be a few blocks greater than channelmonitor::CLTV_CLAIM_BUFFER,
427 /// ie the node we forwarded the payment on to should always have enough room to reliably time out
428 /// the HTLC via a full update_fail_htlc/commitment_signed dance before we hit the
429 /// CLTV_CLAIM_BUFFER point (we static assert that it's at least 3 blocks more).
430 const CLTV_EXPIRY_DELTA: u16 = 6 * 12; //TODO?
431 pub(super) const CLTV_FAR_FAR_AWAY: u32 = 6 * 24 * 7; //TODO?
433 // Check that our CLTV_EXPIRY is at least CLTV_CLAIM_BUFFER + ANTI_REORG_DELAY + LATENCY_GRACE_PERIOD_BLOCKS,
434 // ie that if the next-hop peer fails the HTLC within
435 // LATENCY_GRACE_PERIOD_BLOCKS then we'll still have CLTV_CLAIM_BUFFER left to timeout it onchain,
436 // then waiting ANTI_REORG_DELAY to be reorg-safe on the outbound HLTC and
437 // failing the corresponding htlc backward, and us now seeing the last block of ANTI_REORG_DELAY before
438 // LATENCY_GRACE_PERIOD_BLOCKS.
441 const CHECK_CLTV_EXPIRY_SANITY: u32 = CLTV_EXPIRY_DELTA as u32 - LATENCY_GRACE_PERIOD_BLOCKS - CLTV_CLAIM_BUFFER - ANTI_REORG_DELAY - LATENCY_GRACE_PERIOD_BLOCKS;
443 // Check for ability of an attacker to make us fail on-chain by delaying inbound claim. See
444 // ChannelMontior::would_broadcast_at_height for a description of why this is needed.
447 const CHECK_CLTV_EXPIRY_SANITY_2: u32 = CLTV_EXPIRY_DELTA as u32 - LATENCY_GRACE_PERIOD_BLOCKS - 2*CLTV_CLAIM_BUFFER;
449 /// Details of a channel, as returned by ChannelManager::list_channels and ChannelManager::list_usable_channels
450 pub struct ChannelDetails {
451 /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
452 /// thereafter this is the txid of the funding transaction xor the funding transaction output).
453 /// Note that this means this value is *not* persistent - it can change once during the
454 /// lifetime of the channel.
455 pub channel_id: [u8; 32],
456 /// The position of the funding transaction in the chain. None if the funding transaction has
457 /// not yet been confirmed and the channel fully opened.
458 pub short_channel_id: Option<u64>,
459 /// The node_id of our counterparty
460 pub remote_network_id: PublicKey,
461 /// The Features the channel counterparty provided upon last connection.
462 /// Useful for routing as it is the most up-to-date copy of the counterparty's features and
463 /// many routing-relevant features are present in the init context.
464 pub counterparty_features: InitFeatures,
465 /// The value, in satoshis, of this channel as appears in the funding output
466 pub channel_value_satoshis: u64,
467 /// The user_id passed in to create_channel, or 0 if the channel was inbound.
469 /// The available outbound capacity for sending HTLCs to the remote peer. This does not include
470 /// any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
471 /// available for inclusion in new outbound HTLCs). This further does not include any pending
472 /// outgoing HTLCs which are awaiting some other resolution to be sent.
473 pub outbound_capacity_msat: u64,
474 /// The available inbound capacity for the remote peer to send HTLCs to us. This does not
475 /// include any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
476 /// available for inclusion in new inbound HTLCs).
477 /// Note that there are some corner cases not fully handled here, so the actual available
478 /// inbound capacity may be slightly higher than this.
479 pub inbound_capacity_msat: u64,
480 /// True if the channel is (a) confirmed and funding_locked messages have been exchanged, (b)
481 /// the peer is connected, and (c) no monitor update failure is pending resolution.
485 /// If a payment fails to send, it can be in one of several states. This enum is returned as the
486 /// Err() type describing which state the payment is in, see the description of individual enum
489 pub enum PaymentSendFailure {
490 /// A parameter which was passed to send_payment was invalid, preventing us from attempting to
491 /// send the payment at all. No channel state has been changed or messages sent to peers, and
492 /// once you've changed the parameter at error, you can freely retry the payment in full.
493 ParameterError(APIError),
494 /// A parameter in a single path which was passed to send_payment was invalid, preventing us
495 /// from attempting to send the payment at all. No channel state has been changed or messages
496 /// sent to peers, and once you've changed the parameter at error, you can freely retry the
499 /// The results here are ordered the same as the paths in the route object which was passed to
501 PathParameterError(Vec<Result<(), APIError>>),
502 /// All paths which were attempted failed to send, with no channel state change taking place.
503 /// You can freely retry the payment in full (though you probably want to do so over different
504 /// paths than the ones selected).
505 AllFailedRetrySafe(Vec<APIError>),
506 /// Some paths which were attempted failed to send, though possibly not all. At least some
507 /// paths have irrevocably committed to the HTLC and retrying the payment in full would result
508 /// in over-/re-payment.
510 /// The results here are ordered the same as the paths in the route object which was passed to
511 /// send_payment, and any Errs which are not APIError::MonitorUpdateFailed can be safely
512 /// retried (though there is currently no API with which to do so).
514 /// Any entries which contain Err(APIError::MonitorUpdateFailed) or Ok(()) MUST NOT be retried
515 /// as they will result in over-/re-payment. These HTLCs all either successfully sent (in the
516 /// case of Ok(())) or will send once channel_monitor_updated is called on the next-hop channel
517 /// with the latest update_id.
518 PartialFailure(Vec<Result<(), APIError>>),
521 macro_rules! handle_error {
522 ($self: ident, $internal: expr, $their_node_id: expr) => {
525 Err(MsgHandleErrInternal { err, shutdown_finish }) => {
526 #[cfg(debug_assertions)]
528 // In testing, ensure there are no deadlocks where the lock is already held upon
529 // entering the macro.
530 assert!($self.channel_state.try_lock().is_ok());
533 let mut msg_events = Vec::with_capacity(2);
535 if let Some((shutdown_res, update_option)) = shutdown_finish {
536 $self.finish_force_close_channel(shutdown_res);
537 if let Some(update) = update_option {
538 msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
544 log_error!($self, "{}", err.err);
545 if let msgs::ErrorAction::IgnoreError = err.action {
547 msg_events.push(events::MessageSendEvent::HandleError {
548 node_id: $their_node_id,
549 action: err.action.clone()
553 if !msg_events.is_empty() {
554 $self.channel_state.lock().unwrap().pending_msg_events.append(&mut msg_events);
557 // Return error in case higher-API need one
564 macro_rules! break_chan_entry {
565 ($self: ident, $res: expr, $channel_state: expr, $entry: expr) => {
568 Err(ChannelError::Ignore(msg)) => {
569 break Err(MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore(msg), $entry.key().clone()))
571 Err(ChannelError::Close(msg)) => {
572 log_trace!($self, "Closing channel {} due to Close-required error: {}", log_bytes!($entry.key()[..]), msg);
573 let (channel_id, mut chan) = $entry.remove_entry();
574 if let Some(short_id) = chan.get_short_channel_id() {
575 $channel_state.short_to_id.remove(&short_id);
577 break Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, chan.force_shutdown(true), $self.get_channel_update(&chan).ok())) },
578 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"); }
583 macro_rules! try_chan_entry {
584 ($self: ident, $res: expr, $channel_state: expr, $entry: expr) => {
587 Err(ChannelError::Ignore(msg)) => {
588 return Err(MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore(msg), $entry.key().clone()))
590 Err(ChannelError::Close(msg)) => {
591 log_trace!($self, "Closing channel {} due to Close-required error: {}", log_bytes!($entry.key()[..]), msg);
592 let (channel_id, mut chan) = $entry.remove_entry();
593 if let Some(short_id) = chan.get_short_channel_id() {
594 $channel_state.short_to_id.remove(&short_id);
596 return Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, chan.force_shutdown(true), $self.get_channel_update(&chan).ok()))
598 Err(ChannelError::CloseDelayBroadcast { msg, update }) => {
599 log_error!($self, "Channel {} need to be shutdown but closing transactions not broadcast due to {}", log_bytes!($entry.key()[..]), msg);
600 let (channel_id, mut chan) = $entry.remove_entry();
601 if let Some(short_id) = chan.get_short_channel_id() {
602 $channel_state.short_to_id.remove(&short_id);
604 if let Err(e) = $self.monitor.update_monitor(chan.get_funding_txo().unwrap(), update) {
606 // Upstream channel is dead, but we want at least to fail backward HTLCs to save
607 // downstream channels. In case of PermanentFailure, we are not going to be able
608 // to claim back to_remote output on remote commitment transaction. Doesn't
609 // make a difference here, we are concern about HTLCs circuit, not onchain funds.
610 ChannelMonitorUpdateErr::PermanentFailure => {},
611 ChannelMonitorUpdateErr::TemporaryFailure => {},
614 let shutdown_res = chan.force_shutdown(false);
615 return Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, shutdown_res, $self.get_channel_update(&chan).ok()))
621 macro_rules! handle_monitor_err {
622 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
623 handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment, Vec::new(), Vec::new())
625 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr, $failed_forwards: expr, $failed_fails: expr) => {
627 ChannelMonitorUpdateErr::PermanentFailure => {
628 log_error!($self, "Closing channel {} due to monitor update PermanentFailure", log_bytes!($entry.key()[..]));
629 let (channel_id, mut chan) = $entry.remove_entry();
630 if let Some(short_id) = chan.get_short_channel_id() {
631 $channel_state.short_to_id.remove(&short_id);
633 // TODO: $failed_fails is dropped here, which will cause other channels to hit the
634 // chain in a confused state! We need to move them into the ChannelMonitor which
635 // will be responsible for failing backwards once things confirm on-chain.
636 // It's ok that we drop $failed_forwards here - at this point we'd rather they
637 // broadcast HTLC-Timeout and pay the associated fees to get their funds back than
638 // us bother trying to claim it just to forward on to another peer. If we're
639 // splitting hairs we'd prefer to claim payments that were to us, but we haven't
640 // given up the preimage yet, so might as well just wait until the payment is
641 // retried, avoiding the on-chain fees.
642 let res: Result<(), _> = Err(MsgHandleErrInternal::from_finish_shutdown("ChannelMonitor storage failure", channel_id, chan.force_shutdown(true), $self.get_channel_update(&chan).ok()));
645 ChannelMonitorUpdateErr::TemporaryFailure => {
646 log_info!($self, "Disabling channel {} due to monitor update TemporaryFailure. On restore will send {} and process {} forwards and {} fails",
647 log_bytes!($entry.key()[..]),
648 if $resend_commitment && $resend_raa {
650 RAACommitmentOrder::CommitmentFirst => { "commitment then RAA" },
651 RAACommitmentOrder::RevokeAndACKFirst => { "RAA then commitment" },
653 } else if $resend_commitment { "commitment" }
654 else if $resend_raa { "RAA" }
656 (&$failed_forwards as &Vec<(PendingHTLCInfo, u64)>).len(),
657 (&$failed_fails as &Vec<(HTLCSource, PaymentHash, HTLCFailReason)>).len());
658 if !$resend_commitment {
659 debug_assert!($action_type == RAACommitmentOrder::RevokeAndACKFirst || !$resend_raa);
662 debug_assert!($action_type == RAACommitmentOrder::CommitmentFirst || !$resend_commitment);
664 $entry.get_mut().monitor_update_failed($resend_raa, $resend_commitment, $failed_forwards, $failed_fails);
665 Err(MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore("Failed to update ChannelMonitor"), *$entry.key()))
671 macro_rules! return_monitor_err {
672 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
673 return handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment);
675 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr, $failed_forwards: expr, $failed_fails: expr) => {
676 return handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment, $failed_forwards, $failed_fails);
680 // Does not break in case of TemporaryFailure!
681 macro_rules! maybe_break_monitor_err {
682 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
683 match (handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment), $err) {
684 (e, ChannelMonitorUpdateErr::PermanentFailure) => {
687 (_, ChannelMonitorUpdateErr::TemporaryFailure) => { },
692 impl<ChanSigner: ChannelKeys, M: Deref, T: Deref, K: Deref, F: Deref> ChannelManager<ChanSigner, M, T, K, F>
693 where M::Target: ManyChannelMonitor<ChanSigner>,
694 T::Target: BroadcasterInterface,
695 K::Target: KeysInterface<ChanKeySigner = ChanSigner>,
696 F::Target: FeeEstimator,
698 /// Constructs a new ChannelManager to hold several channels and route between them.
700 /// This is the main "logic hub" for all channel-related actions, and implements
701 /// ChannelMessageHandler.
703 /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
705 /// panics if channel_value_satoshis is >= `MAX_FUNDING_SATOSHIS`!
707 /// Users must provide the current blockchain height from which to track onchain channel
708 /// funding outpoints and send payments with reliable timelocks.
710 /// Users need to notify the new ChannelManager when a new block is connected or
711 /// disconnected using its `block_connected` and `block_disconnected` methods.
712 /// However, rather than calling these methods directly, the user should register
713 /// the ChannelManager as a listener to the BlockNotifier and call the BlockNotifier's
714 /// `block_(dis)connected` methods, which will notify all registered listeners in one
716 pub fn new(network: Network, fee_est: F, monitor: M, tx_broadcaster: T, logger: Arc<Logger>, keys_manager: K, config: UserConfig, current_blockchain_height: usize) -> Result<ChannelManager<ChanSigner, M, T, K, F>, secp256k1::Error> {
717 let secp_ctx = Secp256k1::new();
719 let res = ChannelManager {
720 default_configuration: config.clone(),
721 genesis_hash: genesis_block(network).header.bitcoin_hash(),
722 fee_estimator: fee_est,
726 latest_block_height: AtomicUsize::new(current_blockchain_height),
727 last_block_hash: Mutex::new(Default::default()),
730 channel_state: Mutex::new(ChannelHolder{
731 by_id: HashMap::new(),
732 short_to_id: HashMap::new(),
733 forward_htlcs: HashMap::new(),
734 claimable_htlcs: HashMap::new(),
735 pending_msg_events: Vec::new(),
737 our_network_key: keys_manager.get_node_secret(),
739 last_node_announcement_serial: AtomicUsize::new(0),
741 per_peer_state: RwLock::new(HashMap::new()),
743 pending_events: Mutex::new(Vec::new()),
744 total_consistency_lock: RwLock::new(()),
754 /// Creates a new outbound channel to the given remote node and with the given value.
756 /// user_id will be provided back as user_channel_id in FundingGenerationReady and
757 /// FundingBroadcastSafe events to allow tracking of which events correspond with which
758 /// create_channel call. Note that user_channel_id defaults to 0 for inbound channels, so you
759 /// may wish to avoid using 0 for user_id here.
761 /// If successful, will generate a SendOpenChannel message event, so you should probably poll
762 /// PeerManager::process_events afterwards.
764 /// Raises APIError::APIMisuseError when channel_value_satoshis > 2**24 or push_msat is
765 /// greater than channel_value_satoshis * 1k or channel_value_satoshis is < 1000.
766 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> {
767 if channel_value_satoshis < 1000 {
768 return Err(APIError::APIMisuseError { err: "channel_value must be at least 1000 satoshis" });
771 let config = if override_config.is_some() { override_config.as_ref().unwrap() } else { &self.default_configuration };
772 let channel = Channel::new_outbound(&self.fee_estimator, &self.keys_manager, their_network_key, channel_value_satoshis, push_msat, user_id, Arc::clone(&self.logger), config)?;
773 let res = channel.get_open_channel(self.genesis_hash.clone(), &self.fee_estimator);
775 let _ = self.total_consistency_lock.read().unwrap();
776 let mut channel_state = self.channel_state.lock().unwrap();
777 match channel_state.by_id.entry(channel.channel_id()) {
778 hash_map::Entry::Occupied(_) => {
779 if cfg!(feature = "fuzztarget") {
780 return Err(APIError::APIMisuseError { err: "Fuzzy bad RNG" });
782 panic!("RNG is bad???");
785 hash_map::Entry::Vacant(entry) => { entry.insert(channel); }
787 channel_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
788 node_id: their_network_key,
794 fn list_channels_with_filter<Fn: FnMut(&(&[u8; 32], &Channel<ChanSigner>)) -> bool>(&self, f: Fn) -> Vec<ChannelDetails> {
795 let mut res = Vec::new();
797 let channel_state = self.channel_state.lock().unwrap();
798 res.reserve(channel_state.by_id.len());
799 for (channel_id, channel) in channel_state.by_id.iter().filter(f) {
800 let (inbound_capacity_msat, outbound_capacity_msat) = channel.get_inbound_outbound_available_balance_msat();
801 res.push(ChannelDetails {
802 channel_id: (*channel_id).clone(),
803 short_channel_id: channel.get_short_channel_id(),
804 remote_network_id: channel.get_their_node_id(),
805 counterparty_features: InitFeatures::empty(),
806 channel_value_satoshis: channel.get_value_satoshis(),
807 inbound_capacity_msat,
808 outbound_capacity_msat,
809 user_id: channel.get_user_id(),
810 is_live: channel.is_live(),
814 let per_peer_state = self.per_peer_state.read().unwrap();
815 for chan in res.iter_mut() {
816 if let Some(peer_state) = per_peer_state.get(&chan.remote_network_id) {
817 chan.counterparty_features = peer_state.lock().unwrap().latest_features.clone();
823 /// Gets the list of open channels, in random order. See ChannelDetail field documentation for
824 /// more information.
825 pub fn list_channels(&self) -> Vec<ChannelDetails> {
826 self.list_channels_with_filter(|_| true)
829 /// Gets the list of usable channels, in random order. Useful as an argument to
830 /// Router::get_route to ensure non-announced channels are used.
832 /// These are guaranteed to have their is_live value set to true, see the documentation for
833 /// ChannelDetails::is_live for more info on exactly what the criteria are.
834 pub fn list_usable_channels(&self) -> Vec<ChannelDetails> {
835 // Note we use is_live here instead of usable which leads to somewhat confused
836 // internal/external nomenclature, but that's ok cause that's probably what the user
837 // really wanted anyway.
838 self.list_channels_with_filter(|&(_, ref channel)| channel.is_live())
841 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
842 /// will be accepted on the given channel, and after additional timeout/the closing of all
843 /// pending HTLCs, the channel will be closed on chain.
845 /// May generate a SendShutdown message event on success, which should be relayed.
846 pub fn close_channel(&self, channel_id: &[u8; 32]) -> Result<(), APIError> {
847 let _ = self.total_consistency_lock.read().unwrap();
849 let (mut failed_htlcs, chan_option) = {
850 let mut channel_state_lock = self.channel_state.lock().unwrap();
851 let channel_state = &mut *channel_state_lock;
852 match channel_state.by_id.entry(channel_id.clone()) {
853 hash_map::Entry::Occupied(mut chan_entry) => {
854 let (shutdown_msg, failed_htlcs) = chan_entry.get_mut().get_shutdown()?;
855 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
856 node_id: chan_entry.get().get_their_node_id(),
859 if chan_entry.get().is_shutdown() {
860 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
861 channel_state.short_to_id.remove(&short_id);
863 (failed_htlcs, Some(chan_entry.remove_entry().1))
864 } else { (failed_htlcs, None) }
866 hash_map::Entry::Vacant(_) => return Err(APIError::ChannelUnavailable{err: "No such channel"})
869 for htlc_source in failed_htlcs.drain(..) {
870 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() });
872 let chan_update = if let Some(chan) = chan_option {
873 if let Ok(update) = self.get_channel_update(&chan) {
878 if let Some(update) = chan_update {
879 let mut channel_state = self.channel_state.lock().unwrap();
880 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
889 fn finish_force_close_channel(&self, shutdown_res: ShutdownResult) {
890 let (funding_txo_option, monitor_update, mut failed_htlcs) = shutdown_res;
891 log_trace!(self, "Finishing force-closure of channel {} HTLCs to fail", failed_htlcs.len());
892 for htlc_source in failed_htlcs.drain(..) {
893 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() });
895 if let Some(funding_txo) = funding_txo_option {
896 // There isn't anything we can do if we get an update failure - we're already
897 // force-closing. The monitor update on the required in-memory copy should broadcast
898 // the latest local state, which is the best we can do anyway. Thus, it is safe to
899 // ignore the result here.
900 let _ = self.monitor.update_monitor(funding_txo, monitor_update);
904 /// Force closes a channel, immediately broadcasting the latest local commitment transaction to
905 /// the chain and rejecting new HTLCs on the given channel.
906 pub fn force_close_channel(&self, channel_id: &[u8; 32]) {
907 let _ = self.total_consistency_lock.read().unwrap();
910 let mut channel_state_lock = self.channel_state.lock().unwrap();
911 let channel_state = &mut *channel_state_lock;
912 if let Some(chan) = channel_state.by_id.remove(channel_id) {
913 if let Some(short_id) = chan.get_short_channel_id() {
914 channel_state.short_to_id.remove(&short_id);
921 log_trace!(self, "Force-closing channel {}", log_bytes!(channel_id[..]));
922 self.finish_force_close_channel(chan.force_shutdown(true));
923 if let Ok(update) = self.get_channel_update(&chan) {
924 let mut channel_state = self.channel_state.lock().unwrap();
925 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
931 /// Force close all channels, immediately broadcasting the latest local commitment transaction
932 /// for each to the chain and rejecting new HTLCs on each.
933 pub fn force_close_all_channels(&self) {
934 for chan in self.list_channels() {
935 self.force_close_channel(&chan.channel_id);
939 fn decode_update_add_htlc_onion(&self, msg: &msgs::UpdateAddHTLC) -> (PendingHTLCStatus, MutexGuard<ChannelHolder<ChanSigner>>) {
940 macro_rules! return_malformed_err {
941 ($msg: expr, $err_code: expr) => {
943 log_info!(self, "Failed to accept/forward incoming HTLC: {}", $msg);
944 return (PendingHTLCStatus::Fail(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
945 channel_id: msg.channel_id,
946 htlc_id: msg.htlc_id,
947 sha256_of_onion: Sha256::hash(&msg.onion_routing_packet.hop_data).into_inner(),
948 failure_code: $err_code,
949 })), self.channel_state.lock().unwrap());
954 if let Err(_) = msg.onion_routing_packet.public_key {
955 return_malformed_err!("invalid ephemeral pubkey", 0x8000 | 0x4000 | 6);
958 let shared_secret = {
959 let mut arr = [0; 32];
960 arr.copy_from_slice(&SharedSecret::new(&msg.onion_routing_packet.public_key.unwrap(), &self.our_network_key)[..]);
963 let (rho, mu) = onion_utils::gen_rho_mu_from_shared_secret(&shared_secret);
965 if msg.onion_routing_packet.version != 0 {
966 //TODO: Spec doesn't indicate if we should only hash hop_data here (and in other
967 //sha256_of_onion error data packets), or the entire onion_routing_packet. Either way,
968 //the hash doesn't really serve any purpose - in the case of hashing all data, the
969 //receiving node would have to brute force to figure out which version was put in the
970 //packet by the node that send us the message, in the case of hashing the hop_data, the
971 //node knows the HMAC matched, so they already know what is there...
972 return_malformed_err!("Unknown onion packet version", 0x8000 | 0x4000 | 4);
975 let mut hmac = HmacEngine::<Sha256>::new(&mu);
976 hmac.input(&msg.onion_routing_packet.hop_data);
977 hmac.input(&msg.payment_hash.0[..]);
978 if !fixed_time_eq(&Hmac::from_engine(hmac).into_inner(), &msg.onion_routing_packet.hmac) {
979 return_malformed_err!("HMAC Check failed", 0x8000 | 0x4000 | 5);
982 let mut channel_state = None;
983 macro_rules! return_err {
984 ($msg: expr, $err_code: expr, $data: expr) => {
986 log_info!(self, "Failed to accept/forward incoming HTLC: {}", $msg);
987 if channel_state.is_none() {
988 channel_state = Some(self.channel_state.lock().unwrap());
990 return (PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
991 channel_id: msg.channel_id,
992 htlc_id: msg.htlc_id,
993 reason: onion_utils::build_first_hop_failure_packet(&shared_secret, $err_code, $data),
994 })), channel_state.unwrap());
999 let mut chacha = ChaCha20::new(&rho, &[0u8; 8]);
1000 let mut chacha_stream = ChaChaReader { chacha: &mut chacha, read: Cursor::new(&msg.onion_routing_packet.hop_data[..]) };
1001 let (next_hop_data, next_hop_hmac) = {
1002 match msgs::OnionHopData::read(&mut chacha_stream) {
1004 let error_code = match err {
1005 msgs::DecodeError::UnknownVersion => 0x4000 | 1, // unknown realm byte
1006 msgs::DecodeError::UnknownRequiredFeature|
1007 msgs::DecodeError::InvalidValue|
1008 msgs::DecodeError::ShortRead => 0x4000 | 22, // invalid_onion_payload
1009 _ => 0x2000 | 2, // Should never happen
1011 return_err!("Unable to decode our hop data", error_code, &[0;0]);
1014 let mut hmac = [0; 32];
1015 if let Err(_) = chacha_stream.read_exact(&mut hmac[..]) {
1016 return_err!("Unable to decode hop data", 0x4000 | 22, &[0;0]);
1023 let pending_forward_info = if next_hop_hmac == [0; 32] {
1026 // In tests, make sure that the initial onion pcket data is, at least, non-0.
1027 // We could do some fancy randomness test here, but, ehh, whatever.
1028 // This checks for the issue where you can calculate the path length given the
1029 // onion data as all the path entries that the originator sent will be here
1030 // as-is (and were originally 0s).
1031 // Of course reverse path calculation is still pretty easy given naive routing
1032 // algorithms, but this fixes the most-obvious case.
1033 let mut next_bytes = [0; 32];
1034 chacha_stream.read_exact(&mut next_bytes).unwrap();
1035 assert_ne!(next_bytes[..], [0; 32][..]);
1036 chacha_stream.read_exact(&mut next_bytes).unwrap();
1037 assert_ne!(next_bytes[..], [0; 32][..]);
1041 // final_expiry_too_soon
1042 if (msg.cltv_expiry as u64) < self.latest_block_height.load(Ordering::Acquire) as u64 + (CLTV_CLAIM_BUFFER + LATENCY_GRACE_PERIOD_BLOCKS) as u64 {
1043 return_err!("The final CLTV expiry is too soon to handle", 17, &[0;0]);
1045 // final_incorrect_htlc_amount
1046 if next_hop_data.amt_to_forward > msg.amount_msat {
1047 return_err!("Upstream node sent less than we were supposed to receive in payment", 19, &byte_utils::be64_to_array(msg.amount_msat));
1049 // final_incorrect_cltv_expiry
1050 if next_hop_data.outgoing_cltv_value != msg.cltv_expiry {
1051 return_err!("Upstream node set CLTV to the wrong value", 18, &byte_utils::be32_to_array(msg.cltv_expiry));
1054 let payment_data = match next_hop_data.format {
1055 msgs::OnionHopDataFormat::Legacy { .. } => None,
1056 msgs::OnionHopDataFormat::NonFinalNode { .. } => return_err!("Got non final data with an HMAC of 0", 0x4000 | 22, &[0;0]),
1057 msgs::OnionHopDataFormat::FinalNode { payment_data } => payment_data,
1060 // Note that we could obviously respond immediately with an update_fulfill_htlc
1061 // message, however that would leak that we are the recipient of this payment, so
1062 // instead we stay symmetric with the forwarding case, only responding (after a
1063 // delay) once they've send us a commitment_signed!
1065 PendingHTLCStatus::Forward(PendingHTLCInfo {
1066 routing: PendingHTLCRouting::Receive {
1068 incoming_cltv_expiry: msg.cltv_expiry,
1070 payment_hash: msg.payment_hash.clone(),
1071 incoming_shared_secret: shared_secret,
1072 amt_to_forward: next_hop_data.amt_to_forward,
1073 outgoing_cltv_value: next_hop_data.outgoing_cltv_value,
1076 let mut new_packet_data = [0; 20*65];
1077 let read_pos = chacha_stream.read(&mut new_packet_data).unwrap();
1078 #[cfg(debug_assertions)]
1080 // Check two things:
1081 // a) that the behavior of our stream here will return Ok(0) even if the TLV
1082 // read above emptied out our buffer and the unwrap() wont needlessly panic
1083 // b) that we didn't somehow magically end up with extra data.
1085 debug_assert!(chacha_stream.read(&mut t).unwrap() == 0);
1087 // Once we've emptied the set of bytes our peer gave us, encrypt 0 bytes until we
1088 // fill the onion hop data we'll forward to our next-hop peer.
1089 chacha_stream.chacha.process_in_place(&mut new_packet_data[read_pos..]);
1091 let mut new_pubkey = msg.onion_routing_packet.public_key.unwrap();
1093 let blinding_factor = {
1094 let mut sha = Sha256::engine();
1095 sha.input(&new_pubkey.serialize()[..]);
1096 sha.input(&shared_secret);
1097 Sha256::from_engine(sha).into_inner()
1100 let public_key = if let Err(e) = new_pubkey.mul_assign(&self.secp_ctx, &blinding_factor[..]) {
1102 } else { Ok(new_pubkey) };
1104 let outgoing_packet = msgs::OnionPacket {
1107 hop_data: new_packet_data,
1108 hmac: next_hop_hmac.clone(),
1111 let short_channel_id = match next_hop_data.format {
1112 msgs::OnionHopDataFormat::Legacy { short_channel_id } => short_channel_id,
1113 msgs::OnionHopDataFormat::NonFinalNode { short_channel_id } => short_channel_id,
1114 msgs::OnionHopDataFormat::FinalNode { .. } => {
1115 return_err!("Final Node OnionHopData provided for us as an intermediary node", 0x4000 | 22, &[0;0]);
1119 PendingHTLCStatus::Forward(PendingHTLCInfo {
1120 routing: PendingHTLCRouting::Forward {
1121 onion_packet: outgoing_packet,
1122 short_channel_id: short_channel_id,
1124 payment_hash: msg.payment_hash.clone(),
1125 incoming_shared_secret: shared_secret,
1126 amt_to_forward: next_hop_data.amt_to_forward,
1127 outgoing_cltv_value: next_hop_data.outgoing_cltv_value,
1131 channel_state = Some(self.channel_state.lock().unwrap());
1132 if let &PendingHTLCStatus::Forward(PendingHTLCInfo { ref routing, ref amt_to_forward, ref outgoing_cltv_value, .. }) = &pending_forward_info {
1133 // If short_channel_id is 0 here, we'll reject the HTLC as there cannot be a channel
1134 // with a short_channel_id of 0. This is important as various things later assume
1135 // short_channel_id is non-0 in any ::Forward.
1136 if let &PendingHTLCRouting::Forward { ref short_channel_id, .. } = routing {
1137 let id_option = channel_state.as_ref().unwrap().short_to_id.get(&short_channel_id).cloned();
1138 let forwarding_id = match id_option {
1139 None => { // unknown_next_peer
1140 return_err!("Don't have available channel for forwarding as requested.", 0x4000 | 10, &[0;0]);
1142 Some(id) => id.clone(),
1144 if let Some((err, code, chan_update)) = loop {
1145 let chan = channel_state.as_mut().unwrap().by_id.get_mut(&forwarding_id).unwrap();
1147 // Note that we could technically not return an error yet here and just hope
1148 // that the connection is reestablished or monitor updated by the time we get
1149 // around to doing the actual forward, but better to fail early if we can and
1150 // hopefully an attacker trying to path-trace payments cannot make this occur
1151 // on a small/per-node/per-channel scale.
1152 if !chan.is_live() { // channel_disabled
1153 break Some(("Forwarding channel is not in a ready state.", 0x1000 | 20, Some(self.get_channel_update(chan).unwrap())));
1155 if *amt_to_forward < chan.get_their_htlc_minimum_msat() { // amount_below_minimum
1156 break Some(("HTLC amount was below the htlc_minimum_msat", 0x1000 | 11, Some(self.get_channel_update(chan).unwrap())));
1158 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_our_fee_base_msat(&self.fee_estimator) as u64) });
1159 if fee.is_none() || msg.amount_msat < fee.unwrap() || (msg.amount_msat - fee.unwrap()) < *amt_to_forward { // fee_insufficient
1160 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())));
1162 if (msg.cltv_expiry as u64) < (*outgoing_cltv_value) as u64 + CLTV_EXPIRY_DELTA as u64 { // incorrect_cltv_expiry
1163 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())));
1165 let cur_height = self.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1166 // We want to have at least LATENCY_GRACE_PERIOD_BLOCKS to fail prior to going on chain CLAIM_BUFFER blocks before expiration
1167 if msg.cltv_expiry <= cur_height + CLTV_CLAIM_BUFFER + LATENCY_GRACE_PERIOD_BLOCKS as u32 { // expiry_too_soon
1168 break Some(("CLTV expiry is too close", 0x1000 | 14, Some(self.get_channel_update(chan).unwrap())));
1170 if msg.cltv_expiry > cur_height + CLTV_FAR_FAR_AWAY as u32 { // expiry_too_far
1171 break Some(("CLTV expiry is too far in the future", 21, None));
1176 let mut res = Vec::with_capacity(8 + 128);
1177 if let Some(chan_update) = chan_update {
1178 if code == 0x1000 | 11 || code == 0x1000 | 12 {
1179 res.extend_from_slice(&byte_utils::be64_to_array(msg.amount_msat));
1181 else if code == 0x1000 | 13 {
1182 res.extend_from_slice(&byte_utils::be32_to_array(msg.cltv_expiry));
1184 else if code == 0x1000 | 20 {
1185 res.extend_from_slice(&byte_utils::be16_to_array(chan_update.contents.flags));
1187 res.extend_from_slice(&chan_update.encode_with_len()[..]);
1189 return_err!(err, code, &res[..]);
1194 (pending_forward_info, channel_state.unwrap())
1197 /// only fails if the channel does not yet have an assigned short_id
1198 /// May be called with channel_state already locked!
1199 fn get_channel_update(&self, chan: &Channel<ChanSigner>) -> Result<msgs::ChannelUpdate, LightningError> {
1200 let short_channel_id = match chan.get_short_channel_id() {
1201 None => return Err(LightningError{err: "Channel not yet established", action: msgs::ErrorAction::IgnoreError}),
1205 let were_node_one = PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key).serialize()[..] < chan.get_their_node_id().serialize()[..];
1207 let unsigned = msgs::UnsignedChannelUpdate {
1208 chain_hash: self.genesis_hash,
1209 short_channel_id: short_channel_id,
1210 timestamp: chan.get_update_time_counter(),
1211 flags: (!were_node_one) as u16 | ((!chan.is_live() as u16) << 1),
1212 cltv_expiry_delta: CLTV_EXPIRY_DELTA,
1213 htlc_minimum_msat: chan.get_our_htlc_minimum_msat(),
1214 fee_base_msat: chan.get_our_fee_base_msat(&self.fee_estimator),
1215 fee_proportional_millionths: chan.get_fee_proportional_millionths(),
1216 excess_data: Vec::new(),
1219 let msg_hash = Sha256dHash::hash(&unsigned.encode()[..]);
1220 let sig = self.secp_ctx.sign(&hash_to_message!(&msg_hash[..]), &self.our_network_key);
1222 Ok(msgs::ChannelUpdate {
1228 // Only public for testing, this should otherwise never be called direcly
1229 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> {
1230 log_trace!(self, "Attempting to send payment for path with next hop {}", path.first().unwrap().short_channel_id);
1231 let (session_priv, prng_seed) = self.keys_manager.get_onion_rand();
1233 let onion_keys = onion_utils::construct_onion_keys(&self.secp_ctx, &path, &session_priv)
1234 .map_err(|_| APIError::RouteError{err: "Pubkey along hop was maliciously selected"})?;
1235 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(path, total_value, payment_secret, cur_height)?;
1236 if onion_utils::route_size_insane(&onion_payloads) {
1237 return Err(APIError::RouteError{err: "Route size too large considering onion data"});
1239 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, prng_seed, payment_hash);
1241 let _ = self.total_consistency_lock.read().unwrap();
1243 let err: Result<(), _> = loop {
1244 let mut channel_lock = self.channel_state.lock().unwrap();
1245 let id = match channel_lock.short_to_id.get(&path.first().unwrap().short_channel_id) {
1246 None => return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!"}),
1247 Some(id) => id.clone(),
1250 let channel_state = &mut *channel_lock;
1251 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(id) {
1253 if chan.get().get_their_node_id() != path.first().unwrap().pubkey {
1254 return Err(APIError::RouteError{err: "Node ID mismatch on first hop!"});
1256 if !chan.get().is_live() {
1257 return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected/pending monitor update!"});
1259 break_chan_entry!(self, chan.get_mut().send_htlc_and_commit(htlc_msat, payment_hash.clone(), htlc_cltv, HTLCSource::OutboundRoute {
1261 session_priv: session_priv.clone(),
1262 first_hop_htlc_msat: htlc_msat,
1263 }, onion_packet), channel_state, chan)
1265 Some((update_add, commitment_signed, monitor_update)) => {
1266 if let Err(e) = self.monitor.update_monitor(chan.get().get_funding_txo().unwrap(), monitor_update) {
1267 maybe_break_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, true);
1268 // Note that MonitorUpdateFailed here indicates (per function docs)
1269 // that we will resend the commitment update once monitor updating
1270 // is restored. Therefore, we must return an error indicating that
1271 // it is unsafe to retry the payment wholesale, which we do in the
1272 // send_payment check for MonitorUpdateFailed, below.
1273 return Err(APIError::MonitorUpdateFailed);
1276 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1277 node_id: path.first().unwrap().pubkey,
1278 updates: msgs::CommitmentUpdate {
1279 update_add_htlcs: vec![update_add],
1280 update_fulfill_htlcs: Vec::new(),
1281 update_fail_htlcs: Vec::new(),
1282 update_fail_malformed_htlcs: Vec::new(),
1290 } else { unreachable!(); }
1294 match handle_error!(self, err, path.first().unwrap().pubkey) {
1295 Ok(_) => unreachable!(),
1297 Err(APIError::ChannelUnavailable { err: e.err })
1302 /// Sends a payment along a given route.
1304 /// Value parameters are provided via the last hop in route, see documentation for RouteHop
1305 /// fields for more info.
1307 /// Note that if the payment_hash already exists elsewhere (eg you're sending a duplicative
1308 /// payment), we don't do anything to stop you! We always try to ensure that if the provided
1309 /// next hop knows the preimage to payment_hash they can claim an additional amount as
1310 /// specified in the last hop in the route! Thus, you should probably do your own
1311 /// payment_preimage tracking (which you should already be doing as they represent "proof of
1312 /// payment") and prevent double-sends yourself.
1314 /// May generate SendHTLCs message(s) event on success, which should be relayed.
1316 /// Each path may have a different return value, and PaymentSendValue may return a Vec with
1317 /// each entry matching the corresponding-index entry in the route paths, see
1318 /// PaymentSendFailure for more info.
1320 /// In general, a path may raise:
1321 /// * APIError::RouteError when an invalid route or forwarding parameter (cltv_delta, fee,
1322 /// node public key) is specified.
1323 /// * APIError::ChannelUnavailable if the next-hop channel is not available for updates
1324 /// (including due to previous monitor update failure or new permanent monitor update
1326 /// * APIError::MonitorUpdateFailed if a new monitor update failure prevented sending the
1327 /// relevant updates.
1329 /// Note that depending on the type of the PaymentSendFailure the HTLC may have been
1330 /// irrevocably committed to on our end. In such a case, do NOT retry the payment with a
1331 /// different route unless you intend to pay twice!
1333 /// payment_secret is unrelated to payment_hash (or PaymentPreimage) and exists to authenticate
1334 /// the sender to the recipient and prevent payment-probing (deanonymization) attacks. For
1335 /// newer nodes, it will be provided to you in the invoice. If you do not have one, the Route
1336 /// must not contain multiple paths as multi-path payments require a recipient-provided
1338 /// If a payment_secret *is* provided, we assume that the invoice had the payment_secret feature
1339 /// bit set (either as required or as available). If multiple paths are present in the Route,
1340 /// we assume the invoice had the basic_mpp feature set.
1341 pub fn send_payment(&self, route: &Route, payment_hash: PaymentHash, payment_secret: &Option<PaymentSecret>) -> Result<(), PaymentSendFailure> {
1342 if route.paths.len() < 1 {
1343 return Err(PaymentSendFailure::ParameterError(APIError::RouteError{err: "There must be at least one path to send over"}));
1345 if route.paths.len() > 10 {
1346 // This limit is completely arbitrary - there aren't any real fundamental path-count
1347 // limits. After we support retrying individual paths we should likely bump this, but
1348 // for now more than 10 paths likely carries too much one-path failure.
1349 return Err(PaymentSendFailure::ParameterError(APIError::RouteError{err: "Sending over more than 10 paths is not currently supported"}));
1351 let mut total_value = 0;
1352 let our_node_id = self.get_our_node_id();
1353 let mut path_errs = Vec::with_capacity(route.paths.len());
1354 'path_check: for path in route.paths.iter() {
1355 if path.len() < 1 || path.len() > 20 {
1356 path_errs.push(Err(APIError::RouteError{err: "Path didn't go anywhere/had bogus size"}));
1357 continue 'path_check;
1359 for (idx, hop) in path.iter().enumerate() {
1360 if idx != path.len() - 1 && hop.pubkey == our_node_id {
1361 path_errs.push(Err(APIError::RouteError{err: "Path went through us but wasn't a simple rebalance loop to us"}));
1362 continue 'path_check;
1365 total_value += path.last().unwrap().fee_msat;
1366 path_errs.push(Ok(()));
1368 if path_errs.iter().any(|e| e.is_err()) {
1369 return Err(PaymentSendFailure::PathParameterError(path_errs));
1372 let cur_height = self.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1373 let mut results = Vec::new();
1374 for path in route.paths.iter() {
1375 results.push(self.send_payment_along_path(&path, &payment_hash, payment_secret, total_value, cur_height));
1377 let mut has_ok = false;
1378 let mut has_err = false;
1379 for res in results.iter() {
1380 if res.is_ok() { has_ok = true; }
1381 if res.is_err() { has_err = true; }
1382 if let &Err(APIError::MonitorUpdateFailed) = res {
1383 // MonitorUpdateFailed is inherently unsafe to retry, so we call it a
1390 if has_err && has_ok {
1391 Err(PaymentSendFailure::PartialFailure(results))
1393 Err(PaymentSendFailure::AllFailedRetrySafe(results.drain(..).map(|r| r.unwrap_err()).collect()))
1399 /// Call this upon creation of a funding transaction for the given channel.
1401 /// Note that ALL inputs in the transaction pointed to by funding_txo MUST spend SegWit outputs
1402 /// or your counterparty can steal your funds!
1404 /// Panics if a funding transaction has already been provided for this channel.
1406 /// May panic if the funding_txo is duplicative with some other channel (note that this should
1407 /// be trivially prevented by using unique funding transaction keys per-channel).
1408 pub fn funding_transaction_generated(&self, temporary_channel_id: &[u8; 32], funding_txo: OutPoint) {
1409 let _ = self.total_consistency_lock.read().unwrap();
1412 let (res, chan) = match self.channel_state.lock().unwrap().by_id.remove(temporary_channel_id) {
1414 (chan.get_outbound_funding_created(funding_txo)
1415 .map_err(|e| if let ChannelError::Close(msg) = e {
1416 MsgHandleErrInternal::from_finish_shutdown(msg, chan.channel_id(), chan.force_shutdown(true), None)
1417 } else { unreachable!(); })
1422 match handle_error!(self, res, chan.get_their_node_id()) {
1423 Ok(funding_msg) => {
1426 Err(_) => { return; }
1430 let mut channel_state = self.channel_state.lock().unwrap();
1431 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
1432 node_id: chan.get_their_node_id(),
1435 match channel_state.by_id.entry(chan.channel_id()) {
1436 hash_map::Entry::Occupied(_) => {
1437 panic!("Generated duplicate funding txid?");
1439 hash_map::Entry::Vacant(e) => {
1445 fn get_announcement_sigs(&self, chan: &Channel<ChanSigner>) -> Option<msgs::AnnouncementSignatures> {
1446 if !chan.should_announce() {
1447 log_trace!(self, "Can't send announcement_signatures for private channel {}", log_bytes!(chan.channel_id()));
1451 let (announcement, our_bitcoin_sig) = match chan.get_channel_announcement(self.get_our_node_id(), self.genesis_hash.clone()) {
1453 Err(_) => return None, // Only in case of state precondition violations eg channel is closing
1455 let msghash = hash_to_message!(&Sha256dHash::hash(&announcement.encode()[..])[..]);
1456 let our_node_sig = self.secp_ctx.sign(&msghash, &self.our_network_key);
1458 Some(msgs::AnnouncementSignatures {
1459 channel_id: chan.channel_id(),
1460 short_channel_id: chan.get_short_channel_id().unwrap(),
1461 node_signature: our_node_sig,
1462 bitcoin_signature: our_bitcoin_sig,
1467 // Messages of up to 64KB should never end up more than half full with addresses, as that would
1468 // be absurd. We ensure this by checking that at least 500 (our stated public contract on when
1469 // broadcast_node_announcement panics) of the maximum-length addresses would fit in a 64KB
1471 const HALF_MESSAGE_IS_ADDRS: u32 = ::std::u16::MAX as u32 / (msgs::NetAddress::MAX_LEN as u32 + 1) / 2;
1474 // ...by failing to compile if the number of addresses that would be half of a message is
1475 // smaller than 500:
1476 const STATIC_ASSERT: u32 = Self::HALF_MESSAGE_IS_ADDRS - 500;
1478 /// Generates a signed node_announcement from the given arguments and creates a
1479 /// BroadcastNodeAnnouncement event. Note that such messages will be ignored unless peers have
1480 /// seen a channel_announcement from us (ie unless we have public channels open).
1482 /// RGB is a node "color" and alias is a printable human-readable string to describe this node
1483 /// to humans. They carry no in-protocol meaning.
1485 /// addresses represent the set (possibly empty) of socket addresses on which this node accepts
1486 /// incoming connections. These will be broadcast to the network, publicly tying these
1487 /// addresses together. If you wish to preserve user privacy, addresses should likely contain
1488 /// only Tor Onion addresses.
1490 /// Panics if addresses is absurdly large (more than 500).
1491 pub fn broadcast_node_announcement(&self, rgb: [u8; 3], alias: [u8; 32], addresses: Vec<msgs::NetAddress>) {
1492 let _ = self.total_consistency_lock.read().unwrap();
1494 if addresses.len() > 500 {
1495 panic!("More than half the message size was taken up by public addresses!");
1498 let announcement = msgs::UnsignedNodeAnnouncement {
1499 features: NodeFeatures::supported(),
1500 timestamp: self.last_node_announcement_serial.fetch_add(1, Ordering::AcqRel) as u32,
1501 node_id: self.get_our_node_id(),
1502 rgb, alias, addresses,
1503 excess_address_data: Vec::new(),
1504 excess_data: Vec::new(),
1506 let msghash = hash_to_message!(&Sha256dHash::hash(&announcement.encode()[..])[..]);
1508 let mut channel_state = self.channel_state.lock().unwrap();
1509 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastNodeAnnouncement {
1510 msg: msgs::NodeAnnouncement {
1511 signature: self.secp_ctx.sign(&msghash, &self.our_network_key),
1512 contents: announcement
1517 /// Processes HTLCs which are pending waiting on random forward delay.
1519 /// Should only really ever be called in response to a PendingHTLCsForwardable event.
1520 /// Will likely generate further events.
1521 pub fn process_pending_htlc_forwards(&self) {
1522 let _ = self.total_consistency_lock.read().unwrap();
1524 let mut new_events = Vec::new();
1525 let mut failed_forwards = Vec::new();
1526 let mut handle_errors = Vec::new();
1528 let mut channel_state_lock = self.channel_state.lock().unwrap();
1529 let channel_state = &mut *channel_state_lock;
1531 for (short_chan_id, mut pending_forwards) in channel_state.forward_htlcs.drain() {
1532 if short_chan_id != 0 {
1533 let forward_chan_id = match channel_state.short_to_id.get(&short_chan_id) {
1534 Some(chan_id) => chan_id.clone(),
1536 failed_forwards.reserve(pending_forwards.len());
1537 for forward_info in pending_forwards.drain(..) {
1538 match forward_info {
1539 HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info } => {
1540 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
1541 short_channel_id: prev_short_channel_id,
1542 htlc_id: prev_htlc_id,
1543 incoming_packet_shared_secret: forward_info.incoming_shared_secret,
1545 failed_forwards.push((htlc_source, forward_info.payment_hash,
1546 HTLCFailReason::Reason { failure_code: 0x4000 | 10, data: Vec::new() }
1549 HTLCForwardInfo::FailHTLC { .. } => {
1550 // Channel went away before we could fail it. This implies
1551 // the channel is now on chain and our counterparty is
1552 // trying to broadcast the HTLC-Timeout, but that's their
1553 // problem, not ours.
1560 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(forward_chan_id) {
1561 let mut add_htlc_msgs = Vec::new();
1562 let mut fail_htlc_msgs = Vec::new();
1563 for forward_info in pending_forwards.drain(..) {
1564 match forward_info {
1565 HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info: PendingHTLCInfo {
1566 routing: PendingHTLCRouting::Forward {
1568 }, incoming_shared_secret, payment_hash, amt_to_forward, outgoing_cltv_value }, } => {
1569 log_trace!(self, "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);
1570 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
1571 short_channel_id: prev_short_channel_id,
1572 htlc_id: prev_htlc_id,
1573 incoming_packet_shared_secret: incoming_shared_secret,
1575 match chan.get_mut().send_htlc(amt_to_forward, payment_hash, outgoing_cltv_value, htlc_source.clone(), onion_packet) {
1577 if let ChannelError::Ignore(msg) = e {
1578 log_trace!(self, "Failed to forward HTLC with payment_hash {}: {}", log_bytes!(payment_hash.0), msg);
1580 panic!("Stated return value requirements in send_htlc() were not met");
1582 let chan_update = self.get_channel_update(chan.get()).unwrap();
1583 failed_forwards.push((htlc_source, payment_hash,
1584 HTLCFailReason::Reason { failure_code: 0x1000 | 7, data: chan_update.encode_with_len() }
1590 Some(msg) => { add_htlc_msgs.push(msg); },
1592 // Nothing to do here...we're waiting on a remote
1593 // revoke_and_ack before we can add anymore HTLCs. The Channel
1594 // will automatically handle building the update_add_htlc and
1595 // commitment_signed messages when we can.
1596 // TODO: Do some kind of timer to set the channel as !is_live()
1597 // as we don't really want others relying on us relaying through
1598 // this channel currently :/.
1604 HTLCForwardInfo::AddHTLC { .. } => {
1605 panic!("short_channel_id != 0 should imply any pending_forward entries are of type Forward");
1607 HTLCForwardInfo::FailHTLC { htlc_id, err_packet } => {
1608 log_trace!(self, "Failing HTLC back to channel with short id {} after delay", short_chan_id);
1609 match chan.get_mut().get_update_fail_htlc(htlc_id, err_packet) {
1611 if let ChannelError::Ignore(msg) = e {
1612 log_trace!(self, "Failed to fail backwards to short_id {}: {}", short_chan_id, msg);
1614 panic!("Stated return value requirements in get_update_fail_htlc() were not met");
1616 // fail-backs are best-effort, we probably already have one
1617 // pending, and if not that's OK, if not, the channel is on
1618 // the chain and sending the HTLC-Timeout is their problem.
1621 Ok(Some(msg)) => { fail_htlc_msgs.push(msg); },
1623 // Nothing to do here...we're waiting on a remote
1624 // revoke_and_ack before we can update the commitment
1625 // transaction. The Channel will automatically handle
1626 // building the update_fail_htlc and commitment_signed
1627 // messages when we can.
1628 // We don't need any kind of timer here as they should fail
1629 // the channel onto the chain if they can't get our
1630 // update_fail_htlc in time, it's not our problem.
1637 if !add_htlc_msgs.is_empty() || !fail_htlc_msgs.is_empty() {
1638 let (commitment_msg, monitor_update) = match chan.get_mut().send_commitment() {
1641 // We surely failed send_commitment due to bad keys, in that case
1642 // close channel and then send error message to peer.
1643 let their_node_id = chan.get().get_their_node_id();
1644 let err: Result<(), _> = match e {
1645 ChannelError::Ignore(_) => {
1646 panic!("Stated return value requirements in send_commitment() were not met");
1648 ChannelError::Close(msg) => {
1649 log_trace!(self, "Closing channel {} due to Close-required error: {}", log_bytes!(chan.key()[..]), msg);
1650 let (channel_id, mut channel) = chan.remove_entry();
1651 if let Some(short_id) = channel.get_short_channel_id() {
1652 channel_state.short_to_id.remove(&short_id);
1654 Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, channel.force_shutdown(true), self.get_channel_update(&channel).ok()))
1656 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"); }
1658 handle_errors.push((their_node_id, err));
1662 if let Err(e) = self.monitor.update_monitor(chan.get().get_funding_txo().unwrap(), monitor_update) {
1663 handle_errors.push((chan.get().get_their_node_id(), handle_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, true)));
1666 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1667 node_id: chan.get().get_their_node_id(),
1668 updates: msgs::CommitmentUpdate {
1669 update_add_htlcs: add_htlc_msgs,
1670 update_fulfill_htlcs: Vec::new(),
1671 update_fail_htlcs: fail_htlc_msgs,
1672 update_fail_malformed_htlcs: Vec::new(),
1674 commitment_signed: commitment_msg,
1682 for forward_info in pending_forwards.drain(..) {
1683 match forward_info {
1684 HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info: PendingHTLCInfo {
1685 routing: PendingHTLCRouting::Receive { payment_data, incoming_cltv_expiry },
1686 incoming_shared_secret, payment_hash, amt_to_forward, .. }, } => {
1687 let prev_hop = HTLCPreviousHopData {
1688 short_channel_id: prev_short_channel_id,
1689 htlc_id: prev_htlc_id,
1690 incoming_packet_shared_secret: incoming_shared_secret,
1693 let mut total_value = 0;
1694 let payment_secret_opt =
1695 if let &Some(ref data) = &payment_data { Some(data.payment_secret.clone()) } else { None };
1696 let htlcs = channel_state.claimable_htlcs.entry((payment_hash, payment_secret_opt))
1697 .or_insert(Vec::new());
1698 htlcs.push(ClaimableHTLC {
1700 value: amt_to_forward,
1701 payment_data: payment_data.clone(),
1702 cltv_expiry: incoming_cltv_expiry,
1704 if let &Some(ref data) = &payment_data {
1705 for htlc in htlcs.iter() {
1706 total_value += htlc.value;
1707 if htlc.payment_data.as_ref().unwrap().total_msat != data.total_msat {
1708 total_value = msgs::MAX_VALUE_MSAT;
1710 if total_value >= msgs::MAX_VALUE_MSAT { break; }
1712 if total_value >= msgs::MAX_VALUE_MSAT || total_value > data.total_msat {
1713 for htlc in htlcs.iter() {
1714 let mut htlc_msat_height_data = byte_utils::be64_to_array(htlc.value).to_vec();
1715 htlc_msat_height_data.extend_from_slice(
1716 &byte_utils::be32_to_array(
1717 self.latest_block_height.load(Ordering::Acquire)
1721 failed_forwards.push((HTLCSource::PreviousHopData(HTLCPreviousHopData {
1722 short_channel_id: htlc.prev_hop.short_channel_id,
1723 htlc_id: htlc.prev_hop.htlc_id,
1724 incoming_packet_shared_secret: htlc.prev_hop.incoming_packet_shared_secret,
1726 HTLCFailReason::Reason { failure_code: 0x4000 | 15, data: htlc_msat_height_data }
1729 } else if total_value == data.total_msat {
1730 new_events.push(events::Event::PaymentReceived {
1731 payment_hash: payment_hash,
1732 payment_secret: Some(data.payment_secret),
1737 new_events.push(events::Event::PaymentReceived {
1738 payment_hash: payment_hash,
1739 payment_secret: None,
1740 amt: amt_to_forward,
1744 HTLCForwardInfo::AddHTLC { .. } => {
1745 panic!("short_channel_id == 0 should imply any pending_forward entries are of type Receive");
1747 HTLCForwardInfo::FailHTLC { .. } => {
1748 panic!("Got pending fail of our own HTLC");
1756 for (htlc_source, payment_hash, failure_reason) in failed_forwards.drain(..) {
1757 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source, &payment_hash, failure_reason);
1760 for (their_node_id, err) in handle_errors.drain(..) {
1761 let _ = handle_error!(self, err, their_node_id);
1764 if new_events.is_empty() { return }
1765 let mut events = self.pending_events.lock().unwrap();
1766 events.append(&mut new_events);
1769 /// If a peer is disconnected we mark any channels with that peer as 'disabled'.
1770 /// After some time, if channels are still disabled we need to broadcast a ChannelUpdate
1771 /// to inform the network about the uselessness of these channels.
1773 /// This method handles all the details, and must be called roughly once per minute.
1774 pub fn timer_chan_freshness_every_min(&self) {
1775 let _ = self.total_consistency_lock.read().unwrap();
1776 let mut channel_state_lock = self.channel_state.lock().unwrap();
1777 let channel_state = &mut *channel_state_lock;
1778 for (_, chan) in channel_state.by_id.iter_mut() {
1779 if chan.is_disabled_staged() && !chan.is_live() {
1780 if let Ok(update) = self.get_channel_update(&chan) {
1781 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1786 } else if chan.is_disabled_staged() && chan.is_live() {
1788 } else if chan.is_disabled_marked() {
1789 chan.to_disabled_staged();
1794 /// Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
1795 /// after a PaymentReceived event, failing the HTLC back to its origin and freeing resources
1796 /// along the path (including in our own channel on which we received it).
1797 /// Returns false if no payment was found to fail backwards, true if the process of failing the
1798 /// HTLC backwards has been started.
1799 pub fn fail_htlc_backwards(&self, payment_hash: &PaymentHash, payment_secret: &Option<PaymentSecret>) -> bool {
1800 let _ = self.total_consistency_lock.read().unwrap();
1802 let mut channel_state = Some(self.channel_state.lock().unwrap());
1803 let removed_source = channel_state.as_mut().unwrap().claimable_htlcs.remove(&(*payment_hash, *payment_secret));
1804 if let Some(mut sources) = removed_source {
1805 for htlc in sources.drain(..) {
1806 if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
1807 let mut htlc_msat_height_data = byte_utils::be64_to_array(htlc.value).to_vec();
1808 htlc_msat_height_data.extend_from_slice(&byte_utils::be32_to_array(
1809 self.latest_block_height.load(Ordering::Acquire) as u32,
1811 self.fail_htlc_backwards_internal(channel_state.take().unwrap(),
1812 HTLCSource::PreviousHopData(htlc.prev_hop), payment_hash,
1813 HTLCFailReason::Reason { failure_code: 0x4000 | 15, data: htlc_msat_height_data });
1819 /// Fails an HTLC backwards to the sender of it to us.
1820 /// Note that while we take a channel_state lock as input, we do *not* assume consistency here.
1821 /// There are several callsites that do stupid things like loop over a list of payment_hashes
1822 /// to fail and take the channel_state lock for each iteration (as we take ownership and may
1823 /// drop it). In other words, no assumptions are made that entries in claimable_htlcs point to
1824 /// still-available channels.
1825 fn fail_htlc_backwards_internal(&self, mut channel_state_lock: MutexGuard<ChannelHolder<ChanSigner>>, source: HTLCSource, payment_hash: &PaymentHash, onion_error: HTLCFailReason) {
1826 //TODO: There is a timing attack here where if a node fails an HTLC back to us they can
1827 //identify whether we sent it or not based on the (I presume) very different runtime
1828 //between the branches here. We should make this async and move it into the forward HTLCs
1831 HTLCSource::OutboundRoute { ref path, .. } => {
1832 log_trace!(self, "Failing outbound payment HTLC with payment_hash {}", log_bytes!(payment_hash.0));
1833 mem::drop(channel_state_lock);
1834 match &onion_error {
1835 &HTLCFailReason::LightningError { ref err } => {
1837 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());
1839 let (channel_update, payment_retryable, _, _) = onion_utils::process_onion_failure(&self.secp_ctx, &self.logger, &source, err.data.clone());
1840 // TODO: If we decided to blame ourselves (or one of our channels) in
1841 // process_onion_failure we should close that channel as it implies our
1842 // next-hop is needlessly blaming us!
1843 if let Some(update) = channel_update {
1844 self.channel_state.lock().unwrap().pending_msg_events.push(
1845 events::MessageSendEvent::PaymentFailureNetworkUpdate {
1850 self.pending_events.lock().unwrap().push(
1851 events::Event::PaymentFailed {
1852 payment_hash: payment_hash.clone(),
1853 rejected_by_dest: !payment_retryable,
1855 error_code: onion_error_code,
1857 error_data: onion_error_data
1861 &HTLCFailReason::Reason {
1867 // we get a fail_malformed_htlc from the first hop
1868 // TODO: We'd like to generate a PaymentFailureNetworkUpdate for temporary
1869 // failures here, but that would be insufficient as Router::get_route
1870 // generally ignores its view of our own channels as we provide them via
1872 // TODO: For non-temporary failures, we really should be closing the
1873 // channel here as we apparently can't relay through them anyway.
1874 self.pending_events.lock().unwrap().push(
1875 events::Event::PaymentFailed {
1876 payment_hash: payment_hash.clone(),
1877 rejected_by_dest: path.len() == 1,
1879 error_code: Some(*failure_code),
1881 error_data: Some(data.clone()),
1887 HTLCSource::PreviousHopData(HTLCPreviousHopData { short_channel_id, htlc_id, incoming_packet_shared_secret }) => {
1888 let err_packet = match onion_error {
1889 HTLCFailReason::Reason { failure_code, data } => {
1890 log_trace!(self, "Failing HTLC with payment_hash {} backwards from us with code {}", log_bytes!(payment_hash.0), failure_code);
1891 let packet = onion_utils::build_failure_packet(&incoming_packet_shared_secret, failure_code, &data[..]).encode();
1892 onion_utils::encrypt_failure_packet(&incoming_packet_shared_secret, &packet)
1894 HTLCFailReason::LightningError { err } => {
1895 log_trace!(self, "Failing HTLC with payment_hash {} backwards with pre-built LightningError", log_bytes!(payment_hash.0));
1896 onion_utils::encrypt_failure_packet(&incoming_packet_shared_secret, &err.data)
1900 let mut forward_event = None;
1901 if channel_state_lock.forward_htlcs.is_empty() {
1902 forward_event = Some(Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS));
1904 match channel_state_lock.forward_htlcs.entry(short_channel_id) {
1905 hash_map::Entry::Occupied(mut entry) => {
1906 entry.get_mut().push(HTLCForwardInfo::FailHTLC { htlc_id, err_packet });
1908 hash_map::Entry::Vacant(entry) => {
1909 entry.insert(vec!(HTLCForwardInfo::FailHTLC { htlc_id, err_packet }));
1912 mem::drop(channel_state_lock);
1913 if let Some(time) = forward_event {
1914 let mut pending_events = self.pending_events.lock().unwrap();
1915 pending_events.push(events::Event::PendingHTLCsForwardable {
1916 time_forwardable: time
1923 /// Provides a payment preimage in response to a PaymentReceived event, returning true and
1924 /// generating message events for the net layer to claim the payment, if possible. Thus, you
1925 /// should probably kick the net layer to go send messages if this returns true!
1927 /// You must specify the expected amounts for this HTLC, and we will only claim HTLCs
1928 /// available within a few percent of the expected amount. This is critical for several
1929 /// reasons : a) it avoids providing senders with `proof-of-payment` (in the form of the
1930 /// payment_preimage without having provided the full value and b) it avoids certain
1931 /// privacy-breaking recipient-probing attacks which may reveal payment activity to
1932 /// motivated attackers.
1934 /// Note that the privacy concerns in (b) are not relevant in payments with a payment_secret
1935 /// set. Thus, for such payments we will claim any payments which do not under-pay.
1937 /// May panic if called except in response to a PaymentReceived event.
1938 pub fn claim_funds(&self, payment_preimage: PaymentPreimage, payment_secret: &Option<PaymentSecret>, expected_amount: u64) -> bool {
1939 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
1941 let _ = self.total_consistency_lock.read().unwrap();
1943 let mut channel_state = Some(self.channel_state.lock().unwrap());
1944 let removed_source = channel_state.as_mut().unwrap().claimable_htlcs.remove(&(payment_hash, *payment_secret));
1945 if let Some(mut sources) = removed_source {
1946 assert!(!sources.is_empty());
1948 // If we are claiming an MPP payment, we have to take special care to ensure that each
1949 // channel exists before claiming all of the payments (inside one lock).
1950 // Note that channel existance is sufficient as we should always get a monitor update
1951 // which will take care of the real HTLC claim enforcement.
1953 // If we find an HTLC which we would need to claim but for which we do not have a
1954 // channel, we will fail all parts of the MPP payment. While we could wait and see if
1955 // the sender retries the already-failed path(s), it should be a pretty rare case where
1956 // we got all the HTLCs and then a channel closed while we were waiting for the user to
1957 // provide the preimage, so worrying too much about the optimal handling isn't worth
1960 let (is_mpp, mut valid_mpp) = if let &Some(ref data) = &sources[0].payment_data {
1961 assert!(payment_secret.is_some());
1962 (true, data.total_msat >= expected_amount)
1964 assert!(payment_secret.is_none());
1968 for htlc in sources.iter() {
1969 if !is_mpp || !valid_mpp { break; }
1970 if let None = channel_state.as_ref().unwrap().short_to_id.get(&htlc.prev_hop.short_channel_id) {
1975 let mut errs = Vec::new();
1976 let mut claimed_any_htlcs = false;
1977 for htlc in sources.drain(..) {
1978 if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
1979 if (is_mpp && !valid_mpp) || (!is_mpp && (htlc.value < expected_amount || htlc.value > expected_amount * 2)) {
1980 let mut htlc_msat_height_data = byte_utils::be64_to_array(htlc.value).to_vec();
1981 htlc_msat_height_data.extend_from_slice(&byte_utils::be32_to_array(
1982 self.latest_block_height.load(Ordering::Acquire) as u32,
1984 self.fail_htlc_backwards_internal(channel_state.take().unwrap(),
1985 HTLCSource::PreviousHopData(htlc.prev_hop), &payment_hash,
1986 HTLCFailReason::Reason { failure_code: 0x4000|15, data: htlc_msat_height_data });
1988 match self.claim_funds_from_hop(channel_state.as_mut().unwrap(), htlc.prev_hop, payment_preimage) {
1990 if let msgs::ErrorAction::IgnoreError = e.1.err.action {
1991 // We got a temporary failure updating monitor, but will claim the
1992 // HTLC when the monitor updating is restored (or on chain).
1993 log_error!(self, "Temporary failure claiming HTLC, treating as success: {}", e.1.err.err);
1994 claimed_any_htlcs = true;
1995 } else { errs.push(e); }
1997 Err(None) if is_mpp => unreachable!("We already checked for channel existence, we can't fail here!"),
1999 log_warn!(self, "Channel we expected to claim an HTLC from was closed.");
2001 Ok(()) => claimed_any_htlcs = true,
2006 // Now that we've done the entire above loop in one lock, we can handle any errors
2007 // which were generated.
2008 channel_state.take();
2010 for (their_node_id, err) in errs.drain(..) {
2011 let res: Result<(), _> = Err(err);
2012 let _ = handle_error!(self, res, their_node_id);
2019 fn claim_funds_from_hop(&self, channel_state_lock: &mut MutexGuard<ChannelHolder<ChanSigner>>, prev_hop: HTLCPreviousHopData, payment_preimage: PaymentPreimage) -> Result<(), Option<(PublicKey, MsgHandleErrInternal)>> {
2020 //TODO: Delay the claimed_funds relaying just like we do outbound relay!
2021 let channel_state = &mut **channel_state_lock;
2022 let chan_id = match channel_state.short_to_id.get(&prev_hop.short_channel_id) {
2023 Some(chan_id) => chan_id.clone(),
2029 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(chan_id) {
2030 let was_frozen_for_monitor = chan.get().is_awaiting_monitor_update();
2031 match chan.get_mut().get_update_fulfill_htlc_and_commit(prev_hop.htlc_id, payment_preimage) {
2032 Ok((msgs, monitor_option)) => {
2033 if let Some(monitor_update) = monitor_option {
2034 if let Err(e) = self.monitor.update_monitor(chan.get().get_funding_txo().unwrap(), monitor_update) {
2035 if was_frozen_for_monitor {
2036 assert!(msgs.is_none());
2038 return Err(Some((chan.get().get_their_node_id(), handle_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, msgs.is_some()).unwrap_err())));
2042 if let Some((msg, commitment_signed)) = msgs {
2043 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2044 node_id: chan.get().get_their_node_id(),
2045 updates: msgs::CommitmentUpdate {
2046 update_add_htlcs: Vec::new(),
2047 update_fulfill_htlcs: vec![msg],
2048 update_fail_htlcs: Vec::new(),
2049 update_fail_malformed_htlcs: Vec::new(),
2058 // TODO: Do something with e?
2059 // This should only occur if we are claiming an HTLC at the same time as the
2060 // HTLC is being failed (eg because a block is being connected and this caused
2061 // an HTLC to time out). This should, of course, only occur if the user is the
2062 // one doing the claiming (as it being a part of a peer claim would imply we're
2063 // about to lose funds) and only if the lock in claim_funds was dropped as a
2064 // previous HTLC was failed (thus not for an MPP payment).
2065 debug_assert!(false, "This shouldn't be reachable except in absurdly rare cases between monitor updates and HTLC timeouts: {:?}", e);
2069 } else { unreachable!(); }
2072 fn claim_funds_internal(&self, mut channel_state_lock: MutexGuard<ChannelHolder<ChanSigner>>, source: HTLCSource, payment_preimage: PaymentPreimage) {
2074 HTLCSource::OutboundRoute { .. } => {
2075 mem::drop(channel_state_lock);
2076 let mut pending_events = self.pending_events.lock().unwrap();
2077 pending_events.push(events::Event::PaymentSent {
2081 HTLCSource::PreviousHopData(hop_data) => {
2082 if let Err((their_node_id, err)) = match self.claim_funds_from_hop(&mut channel_state_lock, hop_data, payment_preimage) {
2085 // TODO: There is probably a channel monitor somewhere that needs to
2086 // learn the preimage as the channel already hit the chain and that's
2087 // why it's missing.
2090 Err(Some(res)) => Err(res),
2092 mem::drop(channel_state_lock);
2093 let res: Result<(), _> = Err(err);
2094 let _ = handle_error!(self, res, their_node_id);
2100 /// Gets the node_id held by this ChannelManager
2101 pub fn get_our_node_id(&self) -> PublicKey {
2102 PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key)
2105 /// Restores a single, given channel to normal operation after a
2106 /// ChannelMonitorUpdateErr::TemporaryFailure was returned from a channel monitor update
2109 /// All ChannelMonitor updates up to and including highest_applied_update_id must have been
2110 /// fully committed in every copy of the given channels' ChannelMonitors.
2112 /// Note that there is no effect to calling with a highest_applied_update_id other than the
2113 /// current latest ChannelMonitorUpdate and one call to this function after multiple
2114 /// ChannelMonitorUpdateErr::TemporaryFailures is fine. The highest_applied_update_id field
2115 /// exists largely only to prevent races between this and concurrent update_monitor calls.
2117 /// Thus, the anticipated use is, at a high level:
2118 /// 1) You register a ManyChannelMonitor with this ChannelManager,
2119 /// 2) it stores each update to disk, and begins updating any remote (eg watchtower) copies of
2120 /// said ChannelMonitors as it can, returning ChannelMonitorUpdateErr::TemporaryFailures
2121 /// any time it cannot do so instantly,
2122 /// 3) update(s) are applied to each remote copy of a ChannelMonitor,
2123 /// 4) once all remote copies are updated, you call this function with the update_id that
2124 /// completed, and once it is the latest the Channel will be re-enabled.
2125 pub fn channel_monitor_updated(&self, funding_txo: &OutPoint, highest_applied_update_id: u64) {
2126 let _ = self.total_consistency_lock.read().unwrap();
2128 let mut close_results = Vec::new();
2129 let mut htlc_forwards = Vec::new();
2130 let mut htlc_failures = Vec::new();
2131 let mut pending_events = Vec::new();
2134 let mut channel_lock = self.channel_state.lock().unwrap();
2135 let channel_state = &mut *channel_lock;
2136 let short_to_id = &mut channel_state.short_to_id;
2137 let pending_msg_events = &mut channel_state.pending_msg_events;
2138 let channel = match channel_state.by_id.get_mut(&funding_txo.to_channel_id()) {
2142 if !channel.is_awaiting_monitor_update() || channel.get_latest_monitor_update_id() != highest_applied_update_id {
2146 let (raa, commitment_update, order, pending_forwards, mut pending_failures, needs_broadcast_safe, funding_locked) = channel.monitor_updating_restored();
2147 if !pending_forwards.is_empty() {
2148 htlc_forwards.push((channel.get_short_channel_id().expect("We can't have pending forwards before funding confirmation"), pending_forwards));
2150 htlc_failures.append(&mut pending_failures);
2152 macro_rules! handle_cs { () => {
2153 if let Some(update) = commitment_update {
2154 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2155 node_id: channel.get_their_node_id(),
2160 macro_rules! handle_raa { () => {
2161 if let Some(revoke_and_ack) = raa {
2162 pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
2163 node_id: channel.get_their_node_id(),
2164 msg: revoke_and_ack,
2169 RAACommitmentOrder::CommitmentFirst => {
2173 RAACommitmentOrder::RevokeAndACKFirst => {
2178 if needs_broadcast_safe {
2179 pending_events.push(events::Event::FundingBroadcastSafe {
2180 funding_txo: channel.get_funding_txo().unwrap(),
2181 user_channel_id: channel.get_user_id(),
2184 if let Some(msg) = funding_locked {
2185 pending_msg_events.push(events::MessageSendEvent::SendFundingLocked {
2186 node_id: channel.get_their_node_id(),
2189 if let Some(announcement_sigs) = self.get_announcement_sigs(channel) {
2190 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
2191 node_id: channel.get_their_node_id(),
2192 msg: announcement_sigs,
2195 short_to_id.insert(channel.get_short_channel_id().unwrap(), channel.channel_id());
2199 self.pending_events.lock().unwrap().append(&mut pending_events);
2201 for failure in htlc_failures.drain(..) {
2202 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), failure.0, &failure.1, failure.2);
2204 self.forward_htlcs(&mut htlc_forwards[..]);
2206 for res in close_results.drain(..) {
2207 self.finish_force_close_channel(res);
2211 fn internal_open_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::OpenChannel) -> Result<(), MsgHandleErrInternal> {
2212 if msg.chain_hash != self.genesis_hash {
2213 return Err(MsgHandleErrInternal::send_err_msg_no_close("Unknown genesis block hash", msg.temporary_channel_id.clone()));
2216 let channel = Channel::new_from_req(&self.fee_estimator, &self.keys_manager, their_node_id.clone(), their_features, msg, 0, Arc::clone(&self.logger), &self.default_configuration)
2217 .map_err(|e| MsgHandleErrInternal::from_chan_no_close(e, msg.temporary_channel_id))?;
2218 let mut channel_state_lock = self.channel_state.lock().unwrap();
2219 let channel_state = &mut *channel_state_lock;
2220 match channel_state.by_id.entry(channel.channel_id()) {
2221 hash_map::Entry::Occupied(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("temporary_channel_id collision!", msg.temporary_channel_id.clone())),
2222 hash_map::Entry::Vacant(entry) => {
2223 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
2224 node_id: their_node_id.clone(),
2225 msg: channel.get_accept_channel(),
2227 entry.insert(channel);
2233 fn internal_accept_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::AcceptChannel) -> Result<(), MsgHandleErrInternal> {
2234 let (value, output_script, user_id) = {
2235 let mut channel_lock = self.channel_state.lock().unwrap();
2236 let channel_state = &mut *channel_lock;
2237 match channel_state.by_id.entry(msg.temporary_channel_id) {
2238 hash_map::Entry::Occupied(mut chan) => {
2239 if chan.get().get_their_node_id() != *their_node_id {
2240 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.temporary_channel_id));
2242 try_chan_entry!(self, chan.get_mut().accept_channel(&msg, &self.default_configuration, their_features), channel_state, chan);
2243 (chan.get().get_value_satoshis(), chan.get().get_funding_redeemscript().to_v0_p2wsh(), chan.get().get_user_id())
2245 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.temporary_channel_id))
2248 let mut pending_events = self.pending_events.lock().unwrap();
2249 pending_events.push(events::Event::FundingGenerationReady {
2250 temporary_channel_id: msg.temporary_channel_id,
2251 channel_value_satoshis: value,
2252 output_script: output_script,
2253 user_channel_id: user_id,
2258 fn internal_funding_created(&self, their_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), MsgHandleErrInternal> {
2259 let ((funding_msg, monitor_update), mut chan) = {
2260 let mut channel_lock = self.channel_state.lock().unwrap();
2261 let channel_state = &mut *channel_lock;
2262 match channel_state.by_id.entry(msg.temporary_channel_id.clone()) {
2263 hash_map::Entry::Occupied(mut chan) => {
2264 if chan.get().get_their_node_id() != *their_node_id {
2265 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.temporary_channel_id));
2267 (try_chan_entry!(self, chan.get_mut().funding_created(msg), channel_state, chan), chan.remove())
2269 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.temporary_channel_id))
2272 // Because we have exclusive ownership of the channel here we can release the channel_state
2273 // lock before add_monitor
2274 if let Err(e) = self.monitor.add_monitor(monitor_update.get_funding_txo(), monitor_update) {
2276 ChannelMonitorUpdateErr::PermanentFailure => {
2277 // Note that we reply with the new channel_id in error messages if we gave up on the
2278 // channel, not the temporary_channel_id. This is compatible with ourselves, but the
2279 // spec is somewhat ambiguous here. Not a huge deal since we'll send error messages for
2280 // any messages referencing a previously-closed channel anyway.
2281 return Err(MsgHandleErrInternal::from_finish_shutdown("ChannelMonitor storage failure", funding_msg.channel_id, chan.force_shutdown(true), None));
2283 ChannelMonitorUpdateErr::TemporaryFailure => {
2284 // There's no problem signing a counterparty's funding transaction if our monitor
2285 // hasn't persisted to disk yet - we can't lose money on a transaction that we haven't
2286 // accepted payment from yet. We do, however, need to wait to send our funding_locked
2287 // until we have persisted our monitor.
2288 chan.monitor_update_failed(false, false, Vec::new(), Vec::new());
2292 let mut channel_state_lock = self.channel_state.lock().unwrap();
2293 let channel_state = &mut *channel_state_lock;
2294 match channel_state.by_id.entry(funding_msg.channel_id) {
2295 hash_map::Entry::Occupied(_) => {
2296 return Err(MsgHandleErrInternal::send_err_msg_no_close("Already had channel with the new channel_id", funding_msg.channel_id))
2298 hash_map::Entry::Vacant(e) => {
2299 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
2300 node_id: their_node_id.clone(),
2309 fn internal_funding_signed(&self, their_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), MsgHandleErrInternal> {
2310 let (funding_txo, user_id) = {
2311 let mut channel_lock = self.channel_state.lock().unwrap();
2312 let channel_state = &mut *channel_lock;
2313 match channel_state.by_id.entry(msg.channel_id) {
2314 hash_map::Entry::Occupied(mut chan) => {
2315 if chan.get().get_their_node_id() != *their_node_id {
2316 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2318 let monitor = match chan.get_mut().funding_signed(&msg) {
2319 Ok(update) => update,
2320 Err(e) => try_chan_entry!(self, Err(e), channel_state, chan),
2322 if let Err(e) = self.monitor.add_monitor(chan.get().get_funding_txo().unwrap(), monitor) {
2323 return_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::RevokeAndACKFirst, false, false);
2325 (chan.get().get_funding_txo().unwrap(), chan.get().get_user_id())
2327 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2330 let mut pending_events = self.pending_events.lock().unwrap();
2331 pending_events.push(events::Event::FundingBroadcastSafe {
2332 funding_txo: funding_txo,
2333 user_channel_id: user_id,
2338 fn internal_funding_locked(&self, their_node_id: &PublicKey, msg: &msgs::FundingLocked) -> Result<(), MsgHandleErrInternal> {
2339 let mut channel_state_lock = self.channel_state.lock().unwrap();
2340 let channel_state = &mut *channel_state_lock;
2341 match channel_state.by_id.entry(msg.channel_id) {
2342 hash_map::Entry::Occupied(mut chan) => {
2343 if chan.get().get_their_node_id() != *their_node_id {
2344 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2346 try_chan_entry!(self, chan.get_mut().funding_locked(&msg), channel_state, chan);
2347 if let Some(announcement_sigs) = self.get_announcement_sigs(chan.get()) {
2348 log_trace!(self, "Sending announcement_signatures for {} in response to funding_locked", log_bytes!(chan.get().channel_id()));
2349 // If we see locking block before receiving remote funding_locked, we broadcast our
2350 // announcement_sigs at remote funding_locked reception. If we receive remote
2351 // funding_locked before seeing locking block, we broadcast our announcement_sigs at locking
2352 // block connection. We should guanrantee to broadcast announcement_sigs to our peer whatever
2353 // the order of the events but our peer may not receive it due to disconnection. The specs
2354 // lacking an acknowledgement for announcement_sigs we may have to re-send them at peer
2355 // connection in the future if simultaneous misses by both peers due to network/hardware
2356 // failures is an issue. Note, to achieve its goal, only one of the announcement_sigs needs
2357 // to be received, from then sigs are going to be flood to the whole network.
2358 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
2359 node_id: their_node_id.clone(),
2360 msg: announcement_sigs,
2365 hash_map::Entry::Vacant(_) => Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2369 fn internal_shutdown(&self, their_node_id: &PublicKey, msg: &msgs::Shutdown) -> Result<(), MsgHandleErrInternal> {
2370 let (mut dropped_htlcs, chan_option) = {
2371 let mut channel_state_lock = self.channel_state.lock().unwrap();
2372 let channel_state = &mut *channel_state_lock;
2374 match channel_state.by_id.entry(msg.channel_id.clone()) {
2375 hash_map::Entry::Occupied(mut chan_entry) => {
2376 if chan_entry.get().get_their_node_id() != *their_node_id {
2377 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2379 let (shutdown, closing_signed, dropped_htlcs) = try_chan_entry!(self, chan_entry.get_mut().shutdown(&self.fee_estimator, &msg), channel_state, chan_entry);
2380 if let Some(msg) = shutdown {
2381 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
2382 node_id: their_node_id.clone(),
2386 if let Some(msg) = closing_signed {
2387 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
2388 node_id: their_node_id.clone(),
2392 if chan_entry.get().is_shutdown() {
2393 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
2394 channel_state.short_to_id.remove(&short_id);
2396 (dropped_htlcs, Some(chan_entry.remove_entry().1))
2397 } else { (dropped_htlcs, None) }
2399 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2402 for htlc_source in dropped_htlcs.drain(..) {
2403 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() });
2405 if let Some(chan) = chan_option {
2406 if let Ok(update) = self.get_channel_update(&chan) {
2407 let mut channel_state = self.channel_state.lock().unwrap();
2408 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2416 fn internal_closing_signed(&self, their_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<(), MsgHandleErrInternal> {
2417 let (tx, chan_option) = {
2418 let mut channel_state_lock = self.channel_state.lock().unwrap();
2419 let channel_state = &mut *channel_state_lock;
2420 match channel_state.by_id.entry(msg.channel_id.clone()) {
2421 hash_map::Entry::Occupied(mut chan_entry) => {
2422 if chan_entry.get().get_their_node_id() != *their_node_id {
2423 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2425 let (closing_signed, tx) = try_chan_entry!(self, chan_entry.get_mut().closing_signed(&self.fee_estimator, &msg), channel_state, chan_entry);
2426 if let Some(msg) = closing_signed {
2427 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
2428 node_id: their_node_id.clone(),
2433 // We're done with this channel, we've got a signed closing transaction and
2434 // will send the closing_signed back to the remote peer upon return. This
2435 // also implies there are no pending HTLCs left on the channel, so we can
2436 // fully delete it from tracking (the channel monitor is still around to
2437 // watch for old state broadcasts)!
2438 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
2439 channel_state.short_to_id.remove(&short_id);
2441 (tx, Some(chan_entry.remove_entry().1))
2442 } else { (tx, None) }
2444 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2447 if let Some(broadcast_tx) = tx {
2448 log_trace!(self, "Broadcast onchain {}", log_tx!(broadcast_tx));
2449 self.tx_broadcaster.broadcast_transaction(&broadcast_tx);
2451 if let Some(chan) = chan_option {
2452 if let Ok(update) = self.get_channel_update(&chan) {
2453 let mut channel_state = self.channel_state.lock().unwrap();
2454 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2462 fn internal_update_add_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), MsgHandleErrInternal> {
2463 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
2464 //determine the state of the payment based on our response/if we forward anything/the time
2465 //we take to respond. We should take care to avoid allowing such an attack.
2467 //TODO: There exists a further attack where a node may garble the onion data, forward it to
2468 //us repeatedly garbled in different ways, and compare our error messages, which are
2469 //encrypted with the same key. It's not immediately obvious how to usefully exploit that,
2470 //but we should prevent it anyway.
2472 let (mut pending_forward_info, mut channel_state_lock) = self.decode_update_add_htlc_onion(msg);
2473 let channel_state = &mut *channel_state_lock;
2475 match channel_state.by_id.entry(msg.channel_id) {
2476 hash_map::Entry::Occupied(mut chan) => {
2477 if chan.get().get_their_node_id() != *their_node_id {
2478 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2480 if !chan.get().is_usable() {
2481 // If the update_add is completely bogus, the call will Err and we will close,
2482 // but if we've sent a shutdown and they haven't acknowledged it yet, we just
2483 // want to reject the new HTLC and fail it backwards instead of forwarding.
2484 if let PendingHTLCStatus::Forward(PendingHTLCInfo { incoming_shared_secret, .. }) = pending_forward_info {
2485 let chan_update = self.get_channel_update(chan.get());
2486 pending_forward_info = PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
2487 channel_id: msg.channel_id,
2488 htlc_id: msg.htlc_id,
2489 reason: if let Ok(update) = chan_update {
2490 // TODO: Note that |20 is defined as "channel FROM the processing
2491 // node has been disabled" (emphasis mine), which seems to imply
2492 // that we can't return |20 for an inbound channel being disabled.
2493 // This probably needs a spec update but should definitely be
2495 onion_utils::build_first_hop_failure_packet(&incoming_shared_secret, 0x1000|20, &{
2496 let mut res = Vec::with_capacity(8 + 128);
2497 res.extend_from_slice(&byte_utils::be16_to_array(update.contents.flags));
2498 res.extend_from_slice(&update.encode_with_len()[..]);
2502 // This can only happen if the channel isn't in the fully-funded
2503 // state yet, implying our counterparty is trying to route payments
2504 // over the channel back to themselves (cause no one else should
2505 // know the short_id is a lightning channel yet). We should have no
2506 // problem just calling this unknown_next_peer
2507 onion_utils::build_first_hop_failure_packet(&incoming_shared_secret, 0x4000|10, &[])
2512 try_chan_entry!(self, chan.get_mut().update_add_htlc(&msg, pending_forward_info), channel_state, chan);
2514 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2519 fn internal_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), MsgHandleErrInternal> {
2520 let mut channel_lock = self.channel_state.lock().unwrap();
2522 let channel_state = &mut *channel_lock;
2523 match channel_state.by_id.entry(msg.channel_id) {
2524 hash_map::Entry::Occupied(mut chan) => {
2525 if chan.get().get_their_node_id() != *their_node_id {
2526 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2528 try_chan_entry!(self, chan.get_mut().update_fulfill_htlc(&msg), channel_state, chan)
2530 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2533 self.claim_funds_internal(channel_lock, htlc_source, msg.payment_preimage.clone());
2537 fn internal_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), MsgHandleErrInternal> {
2538 let mut channel_lock = self.channel_state.lock().unwrap();
2539 let channel_state = &mut *channel_lock;
2540 match channel_state.by_id.entry(msg.channel_id) {
2541 hash_map::Entry::Occupied(mut chan) => {
2542 if chan.get().get_their_node_id() != *their_node_id {
2543 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2545 try_chan_entry!(self, chan.get_mut().update_fail_htlc(&msg, HTLCFailReason::LightningError { err: msg.reason.clone() }), channel_state, chan);
2547 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2552 fn internal_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), MsgHandleErrInternal> {
2553 let mut channel_lock = self.channel_state.lock().unwrap();
2554 let channel_state = &mut *channel_lock;
2555 match channel_state.by_id.entry(msg.channel_id) {
2556 hash_map::Entry::Occupied(mut chan) => {
2557 if chan.get().get_their_node_id() != *their_node_id {
2558 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2560 if (msg.failure_code & 0x8000) == 0 {
2561 let chan_err: ChannelError = ChannelError::Close("Got update_fail_malformed_htlc with BADONION not set");
2562 try_chan_entry!(self, Err(chan_err), channel_state, chan);
2564 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);
2567 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2571 fn internal_commitment_signed(&self, their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), MsgHandleErrInternal> {
2572 let mut channel_state_lock = self.channel_state.lock().unwrap();
2573 let channel_state = &mut *channel_state_lock;
2574 match channel_state.by_id.entry(msg.channel_id) {
2575 hash_map::Entry::Occupied(mut chan) => {
2576 if chan.get().get_their_node_id() != *their_node_id {
2577 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2579 let (revoke_and_ack, commitment_signed, closing_signed, monitor_update) =
2580 match chan.get_mut().commitment_signed(&msg, &self.fee_estimator) {
2581 Err((None, e)) => try_chan_entry!(self, Err(e), channel_state, chan),
2582 Err((Some(update), e)) => {
2583 assert!(chan.get().is_awaiting_monitor_update());
2584 let _ = self.monitor.update_monitor(chan.get().get_funding_txo().unwrap(), update);
2585 try_chan_entry!(self, Err(e), channel_state, chan);
2590 if let Err(e) = self.monitor.update_monitor(chan.get().get_funding_txo().unwrap(), monitor_update) {
2591 return_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::RevokeAndACKFirst, true, commitment_signed.is_some());
2592 //TODO: Rebroadcast closing_signed if present on monitor update restoration
2594 channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
2595 node_id: their_node_id.clone(),
2596 msg: revoke_and_ack,
2598 if let Some(msg) = commitment_signed {
2599 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2600 node_id: their_node_id.clone(),
2601 updates: msgs::CommitmentUpdate {
2602 update_add_htlcs: Vec::new(),
2603 update_fulfill_htlcs: Vec::new(),
2604 update_fail_htlcs: Vec::new(),
2605 update_fail_malformed_htlcs: Vec::new(),
2607 commitment_signed: msg,
2611 if let Some(msg) = closing_signed {
2612 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
2613 node_id: their_node_id.clone(),
2619 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2624 fn forward_htlcs(&self, per_source_pending_forwards: &mut [(u64, Vec<(PendingHTLCInfo, u64)>)]) {
2625 for &mut (prev_short_channel_id, ref mut pending_forwards) in per_source_pending_forwards {
2626 let mut forward_event = None;
2627 if !pending_forwards.is_empty() {
2628 let mut channel_state = self.channel_state.lock().unwrap();
2629 if channel_state.forward_htlcs.is_empty() {
2630 forward_event = Some(Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS))
2632 for (forward_info, prev_htlc_id) in pending_forwards.drain(..) {
2633 match channel_state.forward_htlcs.entry(match forward_info.routing {
2634 PendingHTLCRouting::Forward { short_channel_id, .. } => short_channel_id,
2635 PendingHTLCRouting::Receive { .. } => 0,
2637 hash_map::Entry::Occupied(mut entry) => {
2638 entry.get_mut().push(HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info });
2640 hash_map::Entry::Vacant(entry) => {
2641 entry.insert(vec!(HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info }));
2646 match forward_event {
2648 let mut pending_events = self.pending_events.lock().unwrap();
2649 pending_events.push(events::Event::PendingHTLCsForwardable {
2650 time_forwardable: time
2658 fn internal_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), MsgHandleErrInternal> {
2659 let (pending_forwards, mut pending_failures, short_channel_id) = {
2660 let mut channel_state_lock = self.channel_state.lock().unwrap();
2661 let channel_state = &mut *channel_state_lock;
2662 match channel_state.by_id.entry(msg.channel_id) {
2663 hash_map::Entry::Occupied(mut chan) => {
2664 if chan.get().get_their_node_id() != *their_node_id {
2665 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2667 let was_frozen_for_monitor = chan.get().is_awaiting_monitor_update();
2668 let (commitment_update, pending_forwards, pending_failures, closing_signed, monitor_update) =
2669 try_chan_entry!(self, chan.get_mut().revoke_and_ack(&msg, &self.fee_estimator), channel_state, chan);
2670 if let Err(e) = self.monitor.update_monitor(chan.get().get_funding_txo().unwrap(), monitor_update) {
2671 if was_frozen_for_monitor {
2672 assert!(commitment_update.is_none() && closing_signed.is_none() && pending_forwards.is_empty() && pending_failures.is_empty());
2673 return Err(MsgHandleErrInternal::ignore_no_close("Previous monitor update failure prevented responses to RAA"));
2675 return_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, commitment_update.is_some(), pending_forwards, pending_failures);
2678 if let Some(updates) = commitment_update {
2679 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2680 node_id: their_node_id.clone(),
2684 if let Some(msg) = closing_signed {
2685 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
2686 node_id: their_node_id.clone(),
2690 (pending_forwards, pending_failures, chan.get().get_short_channel_id().expect("RAA should only work on a short-id-available channel"))
2692 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2695 for failure in pending_failures.drain(..) {
2696 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), failure.0, &failure.1, failure.2);
2698 self.forward_htlcs(&mut [(short_channel_id, pending_forwards)]);
2703 fn internal_update_fee(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), MsgHandleErrInternal> {
2704 let mut channel_lock = self.channel_state.lock().unwrap();
2705 let channel_state = &mut *channel_lock;
2706 match channel_state.by_id.entry(msg.channel_id) {
2707 hash_map::Entry::Occupied(mut chan) => {
2708 if chan.get().get_their_node_id() != *their_node_id {
2709 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2711 try_chan_entry!(self, chan.get_mut().update_fee(&self.fee_estimator, &msg), channel_state, chan);
2713 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2718 fn internal_announcement_signatures(&self, their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), MsgHandleErrInternal> {
2719 let mut channel_state_lock = self.channel_state.lock().unwrap();
2720 let channel_state = &mut *channel_state_lock;
2722 match channel_state.by_id.entry(msg.channel_id) {
2723 hash_map::Entry::Occupied(mut chan) => {
2724 if chan.get().get_their_node_id() != *their_node_id {
2725 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2727 if !chan.get().is_usable() {
2728 return Err(MsgHandleErrInternal::from_no_close(LightningError{err: "Got an announcement_signatures before we were ready for it", action: msgs::ErrorAction::IgnoreError}));
2731 let our_node_id = self.get_our_node_id();
2732 let (announcement, our_bitcoin_sig) =
2733 try_chan_entry!(self, chan.get_mut().get_channel_announcement(our_node_id.clone(), self.genesis_hash.clone()), channel_state, chan);
2735 let were_node_one = announcement.node_id_1 == our_node_id;
2736 let msghash = hash_to_message!(&Sha256dHash::hash(&announcement.encode()[..])[..]);
2737 if self.secp_ctx.verify(&msghash, &msg.node_signature, if were_node_one { &announcement.node_id_2 } else { &announcement.node_id_1 }).is_err() ||
2738 self.secp_ctx.verify(&msghash, &msg.bitcoin_signature, if were_node_one { &announcement.bitcoin_key_2 } else { &announcement.bitcoin_key_1 }).is_err() {
2739 let chan_err: ChannelError = ChannelError::Close("Bad announcement_signatures node_signature");
2740 try_chan_entry!(self, Err(chan_err), channel_state, chan);
2743 let our_node_sig = self.secp_ctx.sign(&msghash, &self.our_network_key);
2745 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
2746 msg: msgs::ChannelAnnouncement {
2747 node_signature_1: if were_node_one { our_node_sig } else { msg.node_signature },
2748 node_signature_2: if were_node_one { msg.node_signature } else { our_node_sig },
2749 bitcoin_signature_1: if were_node_one { our_bitcoin_sig } else { msg.bitcoin_signature },
2750 bitcoin_signature_2: if were_node_one { msg.bitcoin_signature } else { our_bitcoin_sig },
2751 contents: announcement,
2753 update_msg: self.get_channel_update(chan.get()).unwrap(), // can only fail if we're not in a ready state
2756 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2761 fn internal_channel_reestablish(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<(), MsgHandleErrInternal> {
2762 let mut channel_state_lock = self.channel_state.lock().unwrap();
2763 let channel_state = &mut *channel_state_lock;
2765 match channel_state.by_id.entry(msg.channel_id) {
2766 hash_map::Entry::Occupied(mut chan) => {
2767 if chan.get().get_their_node_id() != *their_node_id {
2768 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2770 let (funding_locked, revoke_and_ack, commitment_update, monitor_update_opt, mut order, shutdown) =
2771 try_chan_entry!(self, chan.get_mut().channel_reestablish(msg), channel_state, chan);
2772 if let Some(monitor_update) = monitor_update_opt {
2773 if let Err(e) = self.monitor.update_monitor(chan.get().get_funding_txo().unwrap(), monitor_update) {
2774 // channel_reestablish doesn't guarantee the order it returns is sensical
2775 // for the messages it returns, but if we're setting what messages to
2776 // re-transmit on monitor update success, we need to make sure it is sane.
2777 if revoke_and_ack.is_none() {
2778 order = RAACommitmentOrder::CommitmentFirst;
2780 if commitment_update.is_none() {
2781 order = RAACommitmentOrder::RevokeAndACKFirst;
2783 return_monitor_err!(self, e, channel_state, chan, order, revoke_and_ack.is_some(), commitment_update.is_some());
2784 //TODO: Resend the funding_locked if needed once we get the monitor running again
2787 if let Some(msg) = funding_locked {
2788 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingLocked {
2789 node_id: their_node_id.clone(),
2793 macro_rules! send_raa { () => {
2794 if let Some(msg) = revoke_and_ack {
2795 channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
2796 node_id: their_node_id.clone(),
2801 macro_rules! send_cu { () => {
2802 if let Some(updates) = commitment_update {
2803 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2804 node_id: their_node_id.clone(),
2810 RAACommitmentOrder::RevokeAndACKFirst => {
2814 RAACommitmentOrder::CommitmentFirst => {
2819 if let Some(msg) = shutdown {
2820 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
2821 node_id: their_node_id.clone(),
2827 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2831 /// Begin Update fee process. Allowed only on an outbound channel.
2832 /// If successful, will generate a UpdateHTLCs event, so you should probably poll
2833 /// PeerManager::process_events afterwards.
2834 /// Note: This API is likely to change!
2836 pub fn update_fee(&self, channel_id: [u8;32], feerate_per_kw: u64) -> Result<(), APIError> {
2837 let _ = self.total_consistency_lock.read().unwrap();
2839 let err: Result<(), _> = loop {
2840 let mut channel_state_lock = self.channel_state.lock().unwrap();
2841 let channel_state = &mut *channel_state_lock;
2843 match channel_state.by_id.entry(channel_id) {
2844 hash_map::Entry::Vacant(_) => return Err(APIError::APIMisuseError{err: "Failed to find corresponding channel"}),
2845 hash_map::Entry::Occupied(mut chan) => {
2846 if !chan.get().is_outbound() {
2847 return Err(APIError::APIMisuseError{err: "update_fee cannot be sent for an inbound channel"});
2849 if chan.get().is_awaiting_monitor_update() {
2850 return Err(APIError::MonitorUpdateFailed);
2852 if !chan.get().is_live() {
2853 return Err(APIError::ChannelUnavailable{err: "Channel is either not yet fully established or peer is currently disconnected"});
2855 their_node_id = chan.get().get_their_node_id();
2856 if let Some((update_fee, commitment_signed, monitor_update)) =
2857 break_chan_entry!(self, chan.get_mut().send_update_fee_and_commit(feerate_per_kw), channel_state, chan)
2859 if let Err(_e) = self.monitor.update_monitor(chan.get().get_funding_txo().unwrap(), monitor_update) {
2862 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2863 node_id: chan.get().get_their_node_id(),
2864 updates: msgs::CommitmentUpdate {
2865 update_add_htlcs: Vec::new(),
2866 update_fulfill_htlcs: Vec::new(),
2867 update_fail_htlcs: Vec::new(),
2868 update_fail_malformed_htlcs: Vec::new(),
2869 update_fee: Some(update_fee),
2879 match handle_error!(self, err, their_node_id) {
2880 Ok(_) => unreachable!(),
2881 Err(e) => { Err(APIError::APIMisuseError { err: e.err })}
2886 impl<ChanSigner: ChannelKeys, M: Deref, T: Deref, K: Deref, F: Deref> events::MessageSendEventsProvider for ChannelManager<ChanSigner, M, T, K, F>
2887 where M::Target: ManyChannelMonitor<ChanSigner>,
2888 T::Target: BroadcasterInterface,
2889 K::Target: KeysInterface<ChanKeySigner = ChanSigner>,
2890 F::Target: FeeEstimator,
2892 fn get_and_clear_pending_msg_events(&self) -> Vec<events::MessageSendEvent> {
2893 // TODO: Event release to users and serialization is currently race-y: it's very easy for a
2894 // user to serialize a ChannelManager with pending events in it and lose those events on
2895 // restart. This is doubly true for the fail/fulfill-backs from monitor events!
2897 //TODO: This behavior should be documented.
2898 for htlc_update in self.monitor.get_and_clear_pending_htlcs_updated() {
2899 if let Some(preimage) = htlc_update.payment_preimage {
2900 log_trace!(self, "Claiming HTLC with preimage {} from our monitor", log_bytes!(preimage.0));
2901 self.claim_funds_internal(self.channel_state.lock().unwrap(), htlc_update.source, preimage);
2903 log_trace!(self, "Failing HTLC with hash {} from our monitor", log_bytes!(htlc_update.payment_hash.0));
2904 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() });
2909 let mut ret = Vec::new();
2910 let mut channel_state = self.channel_state.lock().unwrap();
2911 mem::swap(&mut ret, &mut channel_state.pending_msg_events);
2916 impl<ChanSigner: ChannelKeys, M: Deref, T: Deref, K: Deref, F: Deref> events::EventsProvider for ChannelManager<ChanSigner, M, T, K, F>
2917 where M::Target: ManyChannelMonitor<ChanSigner>,
2918 T::Target: BroadcasterInterface,
2919 K::Target: KeysInterface<ChanKeySigner = ChanSigner>,
2920 F::Target: FeeEstimator,
2922 fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
2923 // TODO: Event release to users and serialization is currently race-y: it's very easy for a
2924 // user to serialize a ChannelManager with pending events in it and lose those events on
2925 // restart. This is doubly true for the fail/fulfill-backs from monitor events!
2927 //TODO: This behavior should be documented.
2928 for htlc_update in self.monitor.get_and_clear_pending_htlcs_updated() {
2929 if let Some(preimage) = htlc_update.payment_preimage {
2930 log_trace!(self, "Claiming HTLC with preimage {} from our monitor", log_bytes!(preimage.0));
2931 self.claim_funds_internal(self.channel_state.lock().unwrap(), htlc_update.source, preimage);
2933 log_trace!(self, "Failing HTLC with hash {} from our monitor", log_bytes!(htlc_update.payment_hash.0));
2934 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() });
2939 let mut ret = Vec::new();
2940 let mut pending_events = self.pending_events.lock().unwrap();
2941 mem::swap(&mut ret, &mut *pending_events);
2946 impl<ChanSigner: ChannelKeys, M: Deref + Sync + Send, T: Deref + Sync + Send, K: Deref + Sync + Send, F: Deref + Sync + Send>
2947 ChainListener for ChannelManager<ChanSigner, M, T, K, F>
2948 where M::Target: ManyChannelMonitor<ChanSigner>,
2949 T::Target: BroadcasterInterface,
2950 K::Target: KeysInterface<ChanKeySigner = ChanSigner>,
2951 F::Target: FeeEstimator,
2953 fn block_connected(&self, header: &BlockHeader, height: u32, txn_matched: &[&Transaction], indexes_of_txn_matched: &[u32]) {
2954 let header_hash = header.bitcoin_hash();
2955 log_trace!(self, "Block {} at height {} connected with {} txn matched", header_hash, height, txn_matched.len());
2956 let _ = self.total_consistency_lock.read().unwrap();
2957 let mut failed_channels = Vec::new();
2958 let mut timed_out_htlcs = Vec::new();
2960 let mut channel_lock = self.channel_state.lock().unwrap();
2961 let channel_state = &mut *channel_lock;
2962 let short_to_id = &mut channel_state.short_to_id;
2963 let pending_msg_events = &mut channel_state.pending_msg_events;
2964 channel_state.by_id.retain(|_, channel| {
2965 let chan_res = channel.block_connected(header, height, txn_matched, indexes_of_txn_matched);
2966 if let Ok(Some(funding_locked)) = chan_res {
2967 pending_msg_events.push(events::MessageSendEvent::SendFundingLocked {
2968 node_id: channel.get_their_node_id(),
2969 msg: funding_locked,
2971 if let Some(announcement_sigs) = self.get_announcement_sigs(channel) {
2972 log_trace!(self, "Sending funding_locked and announcement_signatures for {}", log_bytes!(channel.channel_id()));
2973 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
2974 node_id: channel.get_their_node_id(),
2975 msg: announcement_sigs,
2978 log_trace!(self, "Sending funding_locked WITHOUT announcement_signatures for {}", log_bytes!(channel.channel_id()));
2980 short_to_id.insert(channel.get_short_channel_id().unwrap(), channel.channel_id());
2981 } else if let Err(e) = chan_res {
2982 pending_msg_events.push(events::MessageSendEvent::HandleError {
2983 node_id: channel.get_their_node_id(),
2984 action: msgs::ErrorAction::SendErrorMessage { msg: e },
2988 if let Some(funding_txo) = channel.get_funding_txo() {
2989 for tx in txn_matched {
2990 for inp in tx.input.iter() {
2991 if inp.previous_output == funding_txo.into_bitcoin_outpoint() {
2992 log_trace!(self, "Detected channel-closing tx {} spending {}:{}, closing channel {}", tx.txid(), inp.previous_output.txid, inp.previous_output.vout, log_bytes!(channel.channel_id()));
2993 if let Some(short_id) = channel.get_short_channel_id() {
2994 short_to_id.remove(&short_id);
2996 // It looks like our counterparty went on-chain. We go ahead and
2997 // broadcast our latest local state as well here, just in case its
2998 // some kind of SPV attack, though we expect these to be dropped.
2999 failed_channels.push(channel.force_shutdown(true));
3000 if let Ok(update) = self.get_channel_update(&channel) {
3001 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
3010 if channel.is_funding_initiated() && channel.channel_monitor().would_broadcast_at_height(height) {
3011 if let Some(short_id) = channel.get_short_channel_id() {
3012 short_to_id.remove(&short_id);
3014 // If would_broadcast_at_height() is true, the channel_monitor will broadcast
3015 // the latest local tx for us, so we should skip that here (it doesn't really
3016 // hurt anything, but does make tests a bit simpler).
3017 failed_channels.push(channel.force_shutdown(false));
3018 if let Ok(update) = self.get_channel_update(&channel) {
3019 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
3028 channel_state.claimable_htlcs.retain(|&(ref payment_hash, _), htlcs| {
3029 htlcs.retain(|htlc| {
3030 // If height is approaching the number of blocks we think it takes us to get
3031 // our commitment transaction confirmed before the HTLC expires, plus the
3032 // number of blocks we generally consider it to take to do a commitment update,
3033 // just give up on it and fail the HTLC.
3034 if height >= htlc.cltv_expiry - HTLC_FAIL_BACK_BUFFER {
3035 let mut htlc_msat_height_data = byte_utils::be64_to_array(htlc.value).to_vec();
3036 htlc_msat_height_data.extend_from_slice(&byte_utils::be32_to_array(height));
3037 timed_out_htlcs.push((HTLCSource::PreviousHopData(htlc.prev_hop.clone()), payment_hash.clone(), HTLCFailReason::Reason {
3038 failure_code: 0x4000 | 15,
3039 data: htlc_msat_height_data
3044 !htlcs.is_empty() // Only retain this entry if htlcs has at least one entry.
3047 for failure in failed_channels.drain(..) {
3048 self.finish_force_close_channel(failure);
3051 for (source, payment_hash, reason) in timed_out_htlcs.drain(..) {
3052 // Call it incorrect_or_unknown_payment_details as the issue, ultimately, is that the
3053 // user failed to provide us a preimage within the cltv_expiry time window.
3054 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), source, &payment_hash, reason);
3056 self.latest_block_height.store(height as usize, Ordering::Release);
3057 *self.last_block_hash.try_lock().expect("block_(dis)connected must not be called in parallel") = header_hash;
3059 // Update last_node_announcement_serial to be the max of its current value and the
3060 // block timestamp. This should keep us close to the current time without relying on
3061 // having an explicit local time source.
3062 // Just in case we end up in a race, we loop until we either successfully update
3063 // last_node_announcement_serial or decide we don't need to.
3064 let old_serial = self.last_node_announcement_serial.load(Ordering::Acquire);
3065 if old_serial >= header.time as usize { break; }
3066 if self.last_node_announcement_serial.compare_exchange(old_serial, header.time as usize, Ordering::AcqRel, Ordering::Relaxed).is_ok() {
3072 /// We force-close the channel without letting our counterparty participate in the shutdown
3073 fn block_disconnected(&self, header: &BlockHeader, _: u32) {
3074 let _ = self.total_consistency_lock.read().unwrap();
3075 let mut failed_channels = Vec::new();
3077 let mut channel_lock = self.channel_state.lock().unwrap();
3078 let channel_state = &mut *channel_lock;
3079 let short_to_id = &mut channel_state.short_to_id;
3080 let pending_msg_events = &mut channel_state.pending_msg_events;
3081 channel_state.by_id.retain(|_, v| {
3082 if v.block_disconnected(header) {
3083 if let Some(short_id) = v.get_short_channel_id() {
3084 short_to_id.remove(&short_id);
3086 failed_channels.push(v.force_shutdown(true));
3087 if let Ok(update) = self.get_channel_update(&v) {
3088 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
3098 for failure in failed_channels.drain(..) {
3099 self.finish_force_close_channel(failure);
3101 self.latest_block_height.fetch_sub(1, Ordering::AcqRel);
3102 *self.last_block_hash.try_lock().expect("block_(dis)connected must not be called in parallel") = header.bitcoin_hash();
3106 impl<ChanSigner: ChannelKeys, M: Deref + Sync + Send, T: Deref + Sync + Send, K: Deref + Sync + Send, F: Deref + Sync + Send>
3107 ChannelMessageHandler for ChannelManager<ChanSigner, M, T, K, F>
3108 where M::Target: ManyChannelMonitor<ChanSigner>,
3109 T::Target: BroadcasterInterface,
3110 K::Target: KeysInterface<ChanKeySigner = ChanSigner>,
3111 F::Target: FeeEstimator,
3113 fn handle_open_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::OpenChannel) {
3114 let _ = self.total_consistency_lock.read().unwrap();
3115 let _ = handle_error!(self, self.internal_open_channel(their_node_id, their_features, msg), *their_node_id);
3118 fn handle_accept_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::AcceptChannel) {
3119 let _ = self.total_consistency_lock.read().unwrap();
3120 let _ = handle_error!(self, self.internal_accept_channel(their_node_id, their_features, msg), *their_node_id);
3123 fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &msgs::FundingCreated) {
3124 let _ = self.total_consistency_lock.read().unwrap();
3125 let _ = handle_error!(self, self.internal_funding_created(their_node_id, msg), *their_node_id);
3128 fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &msgs::FundingSigned) {
3129 let _ = self.total_consistency_lock.read().unwrap();
3130 let _ = handle_error!(self, self.internal_funding_signed(their_node_id, msg), *their_node_id);
3133 fn handle_funding_locked(&self, their_node_id: &PublicKey, msg: &msgs::FundingLocked) {
3134 let _ = self.total_consistency_lock.read().unwrap();
3135 let _ = handle_error!(self, self.internal_funding_locked(their_node_id, msg), *their_node_id);
3138 fn handle_shutdown(&self, their_node_id: &PublicKey, msg: &msgs::Shutdown) {
3139 let _ = self.total_consistency_lock.read().unwrap();
3140 let _ = handle_error!(self, self.internal_shutdown(their_node_id, msg), *their_node_id);
3143 fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
3144 let _ = self.total_consistency_lock.read().unwrap();
3145 let _ = handle_error!(self, self.internal_closing_signed(their_node_id, msg), *their_node_id);
3148 fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
3149 let _ = self.total_consistency_lock.read().unwrap();
3150 let _ = handle_error!(self, self.internal_update_add_htlc(their_node_id, msg), *their_node_id);
3153 fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
3154 let _ = self.total_consistency_lock.read().unwrap();
3155 let _ = handle_error!(self, self.internal_update_fulfill_htlc(their_node_id, msg), *their_node_id);
3158 fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
3159 let _ = self.total_consistency_lock.read().unwrap();
3160 let _ = handle_error!(self, self.internal_update_fail_htlc(their_node_id, msg), *their_node_id);
3163 fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
3164 let _ = self.total_consistency_lock.read().unwrap();
3165 let _ = handle_error!(self, self.internal_update_fail_malformed_htlc(their_node_id, msg), *their_node_id);
3168 fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
3169 let _ = self.total_consistency_lock.read().unwrap();
3170 let _ = handle_error!(self, self.internal_commitment_signed(their_node_id, msg), *their_node_id);
3173 fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
3174 let _ = self.total_consistency_lock.read().unwrap();
3175 let _ = handle_error!(self, self.internal_revoke_and_ack(their_node_id, msg), *their_node_id);
3178 fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFee) {
3179 let _ = self.total_consistency_lock.read().unwrap();
3180 let _ = handle_error!(self, self.internal_update_fee(their_node_id, msg), *their_node_id);
3183 fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
3184 let _ = self.total_consistency_lock.read().unwrap();
3185 let _ = handle_error!(self, self.internal_announcement_signatures(their_node_id, msg), *their_node_id);
3188 fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
3189 let _ = self.total_consistency_lock.read().unwrap();
3190 let _ = handle_error!(self, self.internal_channel_reestablish(their_node_id, msg), *their_node_id);
3193 fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool) {
3194 let _ = self.total_consistency_lock.read().unwrap();
3195 let mut failed_channels = Vec::new();
3196 let mut failed_payments = Vec::new();
3197 let mut no_channels_remain = true;
3199 let mut channel_state_lock = self.channel_state.lock().unwrap();
3200 let channel_state = &mut *channel_state_lock;
3201 let short_to_id = &mut channel_state.short_to_id;
3202 let pending_msg_events = &mut channel_state.pending_msg_events;
3203 if no_connection_possible {
3204 log_debug!(self, "Failing all channels with {} due to no_connection_possible", log_pubkey!(their_node_id));
3205 channel_state.by_id.retain(|_, chan| {
3206 if chan.get_their_node_id() == *their_node_id {
3207 if let Some(short_id) = chan.get_short_channel_id() {
3208 short_to_id.remove(&short_id);
3210 failed_channels.push(chan.force_shutdown(true));
3211 if let Ok(update) = self.get_channel_update(&chan) {
3212 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
3222 log_debug!(self, "Marking channels with {} disconnected and generating channel_updates", log_pubkey!(their_node_id));
3223 channel_state.by_id.retain(|_, chan| {
3224 if chan.get_their_node_id() == *their_node_id {
3225 let failed_adds = chan.remove_uncommitted_htlcs_and_mark_paused();
3226 chan.to_disabled_marked();
3227 if !failed_adds.is_empty() {
3228 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
3229 failed_payments.push((chan_update, failed_adds));
3231 if chan.is_shutdown() {
3232 if let Some(short_id) = chan.get_short_channel_id() {
3233 short_to_id.remove(&short_id);
3237 no_channels_remain = false;
3243 pending_msg_events.retain(|msg| {
3245 &events::MessageSendEvent::SendAcceptChannel { ref node_id, .. } => node_id != their_node_id,
3246 &events::MessageSendEvent::SendOpenChannel { ref node_id, .. } => node_id != their_node_id,
3247 &events::MessageSendEvent::SendFundingCreated { ref node_id, .. } => node_id != their_node_id,
3248 &events::MessageSendEvent::SendFundingSigned { ref node_id, .. } => node_id != their_node_id,
3249 &events::MessageSendEvent::SendFundingLocked { ref node_id, .. } => node_id != their_node_id,
3250 &events::MessageSendEvent::SendAnnouncementSignatures { ref node_id, .. } => node_id != their_node_id,
3251 &events::MessageSendEvent::UpdateHTLCs { ref node_id, .. } => node_id != their_node_id,
3252 &events::MessageSendEvent::SendRevokeAndACK { ref node_id, .. } => node_id != their_node_id,
3253 &events::MessageSendEvent::SendClosingSigned { ref node_id, .. } => node_id != their_node_id,
3254 &events::MessageSendEvent::SendShutdown { ref node_id, .. } => node_id != their_node_id,
3255 &events::MessageSendEvent::SendChannelReestablish { ref node_id, .. } => node_id != their_node_id,
3256 &events::MessageSendEvent::BroadcastChannelAnnouncement { .. } => true,
3257 &events::MessageSendEvent::BroadcastNodeAnnouncement { .. } => true,
3258 &events::MessageSendEvent::BroadcastChannelUpdate { .. } => true,
3259 &events::MessageSendEvent::HandleError { ref node_id, .. } => node_id != their_node_id,
3260 &events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => true,
3264 if no_channels_remain {
3265 self.per_peer_state.write().unwrap().remove(their_node_id);
3268 for failure in failed_channels.drain(..) {
3269 self.finish_force_close_channel(failure);
3271 for (chan_update, mut htlc_sources) in failed_payments {
3272 for (htlc_source, payment_hash) in htlc_sources.drain(..) {
3273 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source, &payment_hash, HTLCFailReason::Reason { failure_code: 0x1000 | 7, data: chan_update.clone() });
3278 fn peer_connected(&self, their_node_id: &PublicKey, init_msg: &msgs::Init) {
3279 log_debug!(self, "Generating channel_reestablish events for {}", log_pubkey!(their_node_id));
3281 let _ = self.total_consistency_lock.read().unwrap();
3284 let mut peer_state_lock = self.per_peer_state.write().unwrap();
3285 match peer_state_lock.entry(their_node_id.clone()) {
3286 hash_map::Entry::Vacant(e) => {
3287 e.insert(Mutex::new(PeerState {
3288 latest_features: init_msg.features.clone(),
3291 hash_map::Entry::Occupied(e) => {
3292 e.get().lock().unwrap().latest_features = init_msg.features.clone();
3297 let mut channel_state_lock = self.channel_state.lock().unwrap();
3298 let channel_state = &mut *channel_state_lock;
3299 let pending_msg_events = &mut channel_state.pending_msg_events;
3300 channel_state.by_id.retain(|_, chan| {
3301 if chan.get_their_node_id() == *their_node_id {
3302 if !chan.have_received_message() {
3303 // If we created this (outbound) channel while we were disconnected from the
3304 // peer we probably failed to send the open_channel message, which is now
3305 // lost. We can't have had anything pending related to this channel, so we just
3309 pending_msg_events.push(events::MessageSendEvent::SendChannelReestablish {
3310 node_id: chan.get_their_node_id(),
3311 msg: chan.get_channel_reestablish(),
3317 //TODO: Also re-broadcast announcement_signatures
3320 fn handle_error(&self, their_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
3321 let _ = self.total_consistency_lock.read().unwrap();
3323 if msg.channel_id == [0; 32] {
3324 for chan in self.list_channels() {
3325 if chan.remote_network_id == *their_node_id {
3326 self.force_close_channel(&chan.channel_id);
3330 self.force_close_channel(&msg.channel_id);
3335 const SERIALIZATION_VERSION: u8 = 1;
3336 const MIN_SERIALIZATION_VERSION: u8 = 1;
3338 impl Writeable for PendingHTLCInfo {
3339 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3340 match &self.routing {
3341 &PendingHTLCRouting::Forward { ref onion_packet, ref short_channel_id } => {
3343 onion_packet.write(writer)?;
3344 short_channel_id.write(writer)?;
3346 &PendingHTLCRouting::Receive { ref payment_data, ref incoming_cltv_expiry } => {
3348 payment_data.write(writer)?;
3349 incoming_cltv_expiry.write(writer)?;
3352 self.incoming_shared_secret.write(writer)?;
3353 self.payment_hash.write(writer)?;
3354 self.amt_to_forward.write(writer)?;
3355 self.outgoing_cltv_value.write(writer)?;
3360 impl Readable for PendingHTLCInfo {
3361 fn read<R: ::std::io::Read>(reader: &mut R) -> Result<PendingHTLCInfo, DecodeError> {
3362 Ok(PendingHTLCInfo {
3363 routing: match Readable::read(reader)? {
3364 0u8 => PendingHTLCRouting::Forward {
3365 onion_packet: Readable::read(reader)?,
3366 short_channel_id: Readable::read(reader)?,
3368 1u8 => PendingHTLCRouting::Receive {
3369 payment_data: Readable::read(reader)?,
3370 incoming_cltv_expiry: Readable::read(reader)?,
3372 _ => return Err(DecodeError::InvalidValue),
3374 incoming_shared_secret: Readable::read(reader)?,
3375 payment_hash: Readable::read(reader)?,
3376 amt_to_forward: Readable::read(reader)?,
3377 outgoing_cltv_value: Readable::read(reader)?,
3382 impl Writeable for HTLCFailureMsg {
3383 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3385 &HTLCFailureMsg::Relay(ref fail_msg) => {
3387 fail_msg.write(writer)?;
3389 &HTLCFailureMsg::Malformed(ref fail_msg) => {
3391 fail_msg.write(writer)?;
3398 impl Readable for HTLCFailureMsg {
3399 fn read<R: ::std::io::Read>(reader: &mut R) -> Result<HTLCFailureMsg, DecodeError> {
3400 match <u8 as Readable>::read(reader)? {
3401 0 => Ok(HTLCFailureMsg::Relay(Readable::read(reader)?)),
3402 1 => Ok(HTLCFailureMsg::Malformed(Readable::read(reader)?)),
3403 _ => Err(DecodeError::InvalidValue),
3408 impl Writeable for PendingHTLCStatus {
3409 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3411 &PendingHTLCStatus::Forward(ref forward_info) => {
3413 forward_info.write(writer)?;
3415 &PendingHTLCStatus::Fail(ref fail_msg) => {
3417 fail_msg.write(writer)?;
3424 impl Readable for PendingHTLCStatus {
3425 fn read<R: ::std::io::Read>(reader: &mut R) -> Result<PendingHTLCStatus, DecodeError> {
3426 match <u8 as Readable>::read(reader)? {
3427 0 => Ok(PendingHTLCStatus::Forward(Readable::read(reader)?)),
3428 1 => Ok(PendingHTLCStatus::Fail(Readable::read(reader)?)),
3429 _ => Err(DecodeError::InvalidValue),
3434 impl_writeable!(HTLCPreviousHopData, 0, {
3437 incoming_packet_shared_secret
3440 impl_writeable!(ClaimableHTLC, 0, {
3447 impl Writeable for HTLCSource {
3448 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3450 &HTLCSource::PreviousHopData(ref hop_data) => {
3452 hop_data.write(writer)?;
3454 &HTLCSource::OutboundRoute { ref path, ref session_priv, ref first_hop_htlc_msat } => {
3456 path.write(writer)?;
3457 session_priv.write(writer)?;
3458 first_hop_htlc_msat.write(writer)?;
3465 impl Readable for HTLCSource {
3466 fn read<R: ::std::io::Read>(reader: &mut R) -> Result<HTLCSource, DecodeError> {
3467 match <u8 as Readable>::read(reader)? {
3468 0 => Ok(HTLCSource::PreviousHopData(Readable::read(reader)?)),
3469 1 => Ok(HTLCSource::OutboundRoute {
3470 path: Readable::read(reader)?,
3471 session_priv: Readable::read(reader)?,
3472 first_hop_htlc_msat: Readable::read(reader)?,
3474 _ => Err(DecodeError::InvalidValue),
3479 impl Writeable for HTLCFailReason {
3480 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3482 &HTLCFailReason::LightningError { ref err } => {
3486 &HTLCFailReason::Reason { ref failure_code, ref data } => {
3488 failure_code.write(writer)?;
3489 data.write(writer)?;
3496 impl Readable for HTLCFailReason {
3497 fn read<R: ::std::io::Read>(reader: &mut R) -> Result<HTLCFailReason, DecodeError> {
3498 match <u8 as Readable>::read(reader)? {
3499 0 => Ok(HTLCFailReason::LightningError { err: Readable::read(reader)? }),
3500 1 => Ok(HTLCFailReason::Reason {
3501 failure_code: Readable::read(reader)?,
3502 data: Readable::read(reader)?,
3504 _ => Err(DecodeError::InvalidValue),
3509 impl Writeable for HTLCForwardInfo {
3510 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3512 &HTLCForwardInfo::AddHTLC { ref prev_short_channel_id, ref prev_htlc_id, ref forward_info } => {
3514 prev_short_channel_id.write(writer)?;
3515 prev_htlc_id.write(writer)?;
3516 forward_info.write(writer)?;
3518 &HTLCForwardInfo::FailHTLC { ref htlc_id, ref err_packet } => {
3520 htlc_id.write(writer)?;
3521 err_packet.write(writer)?;
3528 impl Readable for HTLCForwardInfo {
3529 fn read<R: ::std::io::Read>(reader: &mut R) -> Result<HTLCForwardInfo, DecodeError> {
3530 match <u8 as Readable>::read(reader)? {
3531 0 => Ok(HTLCForwardInfo::AddHTLC {
3532 prev_short_channel_id: Readable::read(reader)?,
3533 prev_htlc_id: Readable::read(reader)?,
3534 forward_info: Readable::read(reader)?,
3536 1 => Ok(HTLCForwardInfo::FailHTLC {
3537 htlc_id: Readable::read(reader)?,
3538 err_packet: Readable::read(reader)?,
3540 _ => Err(DecodeError::InvalidValue),
3545 impl<ChanSigner: ChannelKeys + Writeable, M: Deref, T: Deref, K: Deref, F: Deref> Writeable for ChannelManager<ChanSigner, M, T, K, F>
3546 where M::Target: ManyChannelMonitor<ChanSigner>,
3547 T::Target: BroadcasterInterface,
3548 K::Target: KeysInterface<ChanKeySigner = ChanSigner>,
3549 F::Target: FeeEstimator,
3551 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3552 let _ = self.total_consistency_lock.write().unwrap();
3554 writer.write_all(&[SERIALIZATION_VERSION; 1])?;
3555 writer.write_all(&[MIN_SERIALIZATION_VERSION; 1])?;
3557 self.genesis_hash.write(writer)?;
3558 (self.latest_block_height.load(Ordering::Acquire) as u32).write(writer)?;
3559 self.last_block_hash.lock().unwrap().write(writer)?;
3561 let channel_state = self.channel_state.lock().unwrap();
3562 let mut unfunded_channels = 0;
3563 for (_, channel) in channel_state.by_id.iter() {
3564 if !channel.is_funding_initiated() {
3565 unfunded_channels += 1;
3568 ((channel_state.by_id.len() - unfunded_channels) as u64).write(writer)?;
3569 for (_, channel) in channel_state.by_id.iter() {
3570 if channel.is_funding_initiated() {
3571 channel.write(writer)?;
3575 (channel_state.forward_htlcs.len() as u64).write(writer)?;
3576 for (short_channel_id, pending_forwards) in channel_state.forward_htlcs.iter() {
3577 short_channel_id.write(writer)?;
3578 (pending_forwards.len() as u64).write(writer)?;
3579 for forward in pending_forwards {
3580 forward.write(writer)?;
3584 (channel_state.claimable_htlcs.len() as u64).write(writer)?;
3585 for (payment_hash, previous_hops) in channel_state.claimable_htlcs.iter() {
3586 payment_hash.write(writer)?;
3587 (previous_hops.len() as u64).write(writer)?;
3588 for htlc in previous_hops.iter() {
3589 htlc.write(writer)?;
3593 let per_peer_state = self.per_peer_state.write().unwrap();
3594 (per_peer_state.len() as u64).write(writer)?;
3595 for (peer_pubkey, peer_state_mutex) in per_peer_state.iter() {
3596 peer_pubkey.write(writer)?;
3597 let peer_state = peer_state_mutex.lock().unwrap();
3598 peer_state.latest_features.write(writer)?;
3601 (self.last_node_announcement_serial.load(Ordering::Acquire) as u32).write(writer)?;
3607 /// Arguments for the creation of a ChannelManager that are not deserialized.
3609 /// At a high-level, the process for deserializing a ChannelManager and resuming normal operation
3611 /// 1) Deserialize all stored ChannelMonitors.
3612 /// 2) Deserialize the ChannelManager by filling in this struct and calling <(Sha256dHash,
3613 /// ChannelManager)>::read(reader, args).
3614 /// This may result in closing some Channels if the ChannelMonitor is newer than the stored
3615 /// ChannelManager state to ensure no loss of funds. Thus, transactions may be broadcasted.
3616 /// 3) Register all relevant ChannelMonitor outpoints with your chain watch mechanism using
3617 /// ChannelMonitor::get_monitored_outpoints and ChannelMonitor::get_funding_txo().
3618 /// 4) Reconnect blocks on your ChannelMonitors.
3619 /// 5) Move the ChannelMonitors into your local ManyChannelMonitor.
3620 /// 6) Disconnect/connect blocks on the ChannelManager.
3621 /// 7) Register the new ChannelManager with your ChainWatchInterface.
3622 pub struct ChannelManagerReadArgs<'a, ChanSigner: 'a + ChannelKeys, M: Deref, T: Deref, K: Deref, F: Deref>
3623 where M::Target: ManyChannelMonitor<ChanSigner>,
3624 T::Target: BroadcasterInterface,
3625 K::Target: KeysInterface<ChanKeySigner = ChanSigner>,
3626 F::Target: FeeEstimator,
3629 /// The keys provider which will give us relevant keys. Some keys will be loaded during
3630 /// deserialization.
3631 pub keys_manager: K,
3633 /// The fee_estimator for use in the ChannelManager in the future.
3635 /// No calls to the FeeEstimator will be made during deserialization.
3636 pub fee_estimator: F,
3637 /// The ManyChannelMonitor for use in the ChannelManager in the future.
3639 /// No calls to the ManyChannelMonitor will be made during deserialization. It is assumed that
3640 /// you have deserialized ChannelMonitors separately and will add them to your
3641 /// ManyChannelMonitor after deserializing this ChannelManager.
3644 /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
3645 /// used to broadcast the latest local commitment transactions of channels which must be
3646 /// force-closed during deserialization.
3647 pub tx_broadcaster: T,
3648 /// The Logger for use in the ChannelManager and which may be used to log information during
3649 /// deserialization.
3650 pub logger: Arc<Logger>,
3651 /// Default settings used for new channels. Any existing channels will continue to use the
3652 /// runtime settings which were stored when the ChannelManager was serialized.
3653 pub default_config: UserConfig,
3655 /// A map from channel funding outpoints to ChannelMonitors for those channels (ie
3656 /// value.get_funding_txo() should be the key).
3658 /// If a monitor is inconsistent with the channel state during deserialization the channel will
3659 /// be force-closed using the data in the ChannelMonitor and the channel will be dropped. This
3660 /// is true for missing channels as well. If there is a monitor missing for which we find
3661 /// channel data Err(DecodeError::InvalidValue) will be returned.
3663 /// In such cases the latest local transactions will be sent to the tx_broadcaster included in
3665 pub channel_monitors: &'a mut HashMap<OutPoint, &'a mut ChannelMonitor<ChanSigner>>,
3668 // Implement ReadableArgs for an Arc'd ChannelManager to make it a bit easier to work with the
3669 // SipmleArcChannelManager type:
3670 impl<'a, ChanSigner: ChannelKeys + Readable, M: Deref, T: Deref, K: Deref, F: Deref>
3671 ReadableArgs<ChannelManagerReadArgs<'a, ChanSigner, M, T, K, F>> for (Sha256dHash, Arc<ChannelManager<ChanSigner, M, T, K, F>>)
3672 where M::Target: ManyChannelMonitor<ChanSigner>,
3673 T::Target: BroadcasterInterface,
3674 K::Target: KeysInterface<ChanKeySigner = ChanSigner>,
3675 F::Target: FeeEstimator,
3677 fn read<R: ::std::io::Read>(reader: &mut R, args: ChannelManagerReadArgs<'a, ChanSigner, M, T, K, F>) -> Result<Self, DecodeError> {
3678 let (blockhash, chan_manager) = <(Sha256dHash, ChannelManager<ChanSigner, M, T, K, F>)>::read(reader, args)?;
3679 Ok((blockhash, Arc::new(chan_manager)))
3683 impl<'a, ChanSigner: ChannelKeys + Readable, M: Deref, T: Deref, K: Deref, F: Deref>
3684 ReadableArgs<ChannelManagerReadArgs<'a, ChanSigner, M, T, K, F>> for (Sha256dHash, ChannelManager<ChanSigner, M, T, K, F>)
3685 where M::Target: ManyChannelMonitor<ChanSigner>,
3686 T::Target: BroadcasterInterface,
3687 K::Target: KeysInterface<ChanKeySigner = ChanSigner>,
3688 F::Target: FeeEstimator,
3690 fn read<R: ::std::io::Read>(reader: &mut R, args: ChannelManagerReadArgs<'a, ChanSigner, M, T, K, F>) -> Result<Self, DecodeError> {
3691 let _ver: u8 = Readable::read(reader)?;
3692 let min_ver: u8 = Readable::read(reader)?;
3693 if min_ver > SERIALIZATION_VERSION {
3694 return Err(DecodeError::UnknownVersion);
3697 let genesis_hash: Sha256dHash = Readable::read(reader)?;
3698 let latest_block_height: u32 = Readable::read(reader)?;
3699 let last_block_hash: Sha256dHash = Readable::read(reader)?;
3701 let mut failed_htlcs = Vec::new();
3703 let channel_count: u64 = Readable::read(reader)?;
3704 let mut funding_txo_set = HashSet::with_capacity(cmp::min(channel_count as usize, 128));
3705 let mut by_id = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
3706 let mut short_to_id = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
3707 for _ in 0..channel_count {
3708 let mut channel: Channel<ChanSigner> = ReadableArgs::read(reader, args.logger.clone())?;
3709 if channel.last_block_connected != Default::default() && channel.last_block_connected != last_block_hash {
3710 return Err(DecodeError::InvalidValue);
3713 let funding_txo = channel.get_funding_txo().ok_or(DecodeError::InvalidValue)?;
3714 funding_txo_set.insert(funding_txo.clone());
3715 if let Some(ref mut monitor) = args.channel_monitors.get_mut(&funding_txo) {
3716 if channel.get_cur_local_commitment_transaction_number() < monitor.get_cur_local_commitment_number() ||
3717 channel.get_revoked_remote_commitment_transaction_number() < monitor.get_min_seen_secret() ||
3718 channel.get_cur_remote_commitment_transaction_number() < monitor.get_cur_remote_commitment_number() ||
3719 channel.get_latest_monitor_update_id() > monitor.get_latest_update_id() {
3720 // If the channel is ahead of the monitor, return InvalidValue:
3721 return Err(DecodeError::InvalidValue);
3722 } else if channel.get_cur_local_commitment_transaction_number() > monitor.get_cur_local_commitment_number() ||
3723 channel.get_revoked_remote_commitment_transaction_number() > monitor.get_min_seen_secret() ||
3724 channel.get_cur_remote_commitment_transaction_number() > monitor.get_cur_remote_commitment_number() ||
3725 channel.get_latest_monitor_update_id() < monitor.get_latest_update_id() {
3726 // But if the channel is behind of the monitor, close the channel:
3727 let (_, _, mut new_failed_htlcs) = channel.force_shutdown(true);
3728 failed_htlcs.append(&mut new_failed_htlcs);
3729 monitor.broadcast_latest_local_commitment_txn(&args.tx_broadcaster);
3731 if let Some(short_channel_id) = channel.get_short_channel_id() {
3732 short_to_id.insert(short_channel_id, channel.channel_id());
3734 by_id.insert(channel.channel_id(), channel);
3737 return Err(DecodeError::InvalidValue);
3741 for (ref funding_txo, ref mut monitor) in args.channel_monitors.iter_mut() {
3742 if !funding_txo_set.contains(funding_txo) {
3743 monitor.broadcast_latest_local_commitment_txn(&args.tx_broadcaster);
3747 let forward_htlcs_count: u64 = Readable::read(reader)?;
3748 let mut forward_htlcs = HashMap::with_capacity(cmp::min(forward_htlcs_count as usize, 128));
3749 for _ in 0..forward_htlcs_count {
3750 let short_channel_id = Readable::read(reader)?;
3751 let pending_forwards_count: u64 = Readable::read(reader)?;
3752 let mut pending_forwards = Vec::with_capacity(cmp::min(pending_forwards_count as usize, 128));
3753 for _ in 0..pending_forwards_count {
3754 pending_forwards.push(Readable::read(reader)?);
3756 forward_htlcs.insert(short_channel_id, pending_forwards);
3759 let claimable_htlcs_count: u64 = Readable::read(reader)?;
3760 let mut claimable_htlcs = HashMap::with_capacity(cmp::min(claimable_htlcs_count as usize, 128));
3761 for _ in 0..claimable_htlcs_count {
3762 let payment_hash = Readable::read(reader)?;
3763 let previous_hops_len: u64 = Readable::read(reader)?;
3764 let mut previous_hops = Vec::with_capacity(cmp::min(previous_hops_len as usize, 2));
3765 for _ in 0..previous_hops_len {
3766 previous_hops.push(Readable::read(reader)?);
3768 claimable_htlcs.insert(payment_hash, previous_hops);
3771 let peer_count: u64 = Readable::read(reader)?;
3772 let mut per_peer_state = HashMap::with_capacity(cmp::min(peer_count as usize, 128));
3773 for _ in 0..peer_count {
3774 let peer_pubkey = Readable::read(reader)?;
3775 let peer_state = PeerState {
3776 latest_features: Readable::read(reader)?,
3778 per_peer_state.insert(peer_pubkey, Mutex::new(peer_state));
3781 let last_node_announcement_serial: u32 = Readable::read(reader)?;
3783 let channel_manager = ChannelManager {
3785 fee_estimator: args.fee_estimator,
3786 monitor: args.monitor,
3787 tx_broadcaster: args.tx_broadcaster,
3789 latest_block_height: AtomicUsize::new(latest_block_height as usize),
3790 last_block_hash: Mutex::new(last_block_hash),
3791 secp_ctx: Secp256k1::new(),
3793 channel_state: Mutex::new(ChannelHolder {
3798 pending_msg_events: Vec::new(),
3800 our_network_key: args.keys_manager.get_node_secret(),
3802 last_node_announcement_serial: AtomicUsize::new(last_node_announcement_serial as usize),
3804 per_peer_state: RwLock::new(per_peer_state),
3806 pending_events: Mutex::new(Vec::new()),
3807 total_consistency_lock: RwLock::new(()),
3808 keys_manager: args.keys_manager,
3809 logger: args.logger,
3810 default_configuration: args.default_config,
3813 for htlc_source in failed_htlcs.drain(..) {
3814 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() });
3817 //TODO: Broadcast channel update for closed channels, but only after we've made a
3818 //connection or two.
3820 Ok((last_block_hash.clone(), channel_manager))