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, ChannelMonitorUpdateErr, ManyChannelMonitor, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY};
32 use ln::router::Route;
33 use ln::features::InitFeatures;
36 use ln::msgs::{ChannelMessageHandler, DecodeError, LightningError};
37 use chain::keysinterface::{ChannelKeys, KeysInterface, 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 pub(super) struct PendingHTLCInfo {
73 onion_packet: Option<msgs::OnionPacket>,
74 incoming_shared_secret: [u8; 32],
75 payment_hash: PaymentHash,
76 short_channel_id: u64,
77 pub(super) amt_to_forward: u64,
78 pub(super) outgoing_cltv_value: u32,
81 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
82 pub(super) enum HTLCFailureMsg {
83 Relay(msgs::UpdateFailHTLC),
84 Malformed(msgs::UpdateFailMalformedHTLC),
87 /// Stores whether we can't forward an HTLC or relevant forwarding info
88 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
89 pub(super) enum PendingHTLCStatus {
90 Forward(PendingHTLCInfo),
94 pub(super) enum HTLCForwardInfo {
96 prev_short_channel_id: u64,
98 forward_info: PendingHTLCInfo,
102 err_packet: msgs::OnionErrorPacket,
106 /// Tracks the inbound corresponding to an outbound HTLC
107 #[derive(Clone, PartialEq)]
108 pub(super) struct HTLCPreviousHopData {
109 short_channel_id: u64,
111 incoming_packet_shared_secret: [u8; 32],
114 /// Tracks the inbound corresponding to an outbound HTLC
115 #[derive(Clone, PartialEq)]
116 pub(super) enum HTLCSource {
117 PreviousHopData(HTLCPreviousHopData),
120 session_priv: SecretKey,
121 /// Technically we can recalculate this from the route, but we cache it here to avoid
122 /// doing a double-pass on route when we get a failure back
123 first_hop_htlc_msat: u64,
128 pub fn dummy() -> Self {
129 HTLCSource::OutboundRoute {
130 route: Route { hops: Vec::new() },
131 session_priv: SecretKey::from_slice(&[1; 32]).unwrap(),
132 first_hop_htlc_msat: 0,
137 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
138 pub(super) enum HTLCFailReason {
140 err: msgs::OnionErrorPacket,
148 /// payment_hash type, use to cross-lock hop
149 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
150 pub struct PaymentHash(pub [u8;32]);
151 /// payment_preimage type, use to route payment between hop
152 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
153 pub struct PaymentPreimage(pub [u8;32]);
155 type ShutdownResult = (Vec<Transaction>, Vec<(HTLCSource, PaymentHash)>);
157 /// Error type returned across the channel_state mutex boundary. When an Err is generated for a
158 /// Channel, we generally end up with a ChannelError::Close for which we have to close the channel
159 /// immediately (ie with no further calls on it made). Thus, this step happens inside a
160 /// channel_state lock. We then return the set of things that need to be done outside the lock in
161 /// this struct and call handle_error!() on it.
163 struct MsgHandleErrInternal {
164 err: msgs::LightningError,
165 shutdown_finish: Option<(ShutdownResult, Option<msgs::ChannelUpdate>)>,
167 impl MsgHandleErrInternal {
169 fn send_err_msg_no_close(err: &'static str, channel_id: [u8; 32]) -> Self {
171 err: LightningError {
173 action: msgs::ErrorAction::SendErrorMessage {
174 msg: msgs::ErrorMessage {
176 data: err.to_string()
180 shutdown_finish: None,
184 fn ignore_no_close(err: &'static str) -> Self {
186 err: LightningError {
188 action: msgs::ErrorAction::IgnoreError,
190 shutdown_finish: None,
194 fn from_no_close(err: msgs::LightningError) -> Self {
195 Self { err, shutdown_finish: None }
198 fn from_finish_shutdown(err: &'static str, channel_id: [u8; 32], shutdown_res: ShutdownResult, channel_update: Option<msgs::ChannelUpdate>) -> Self {
200 err: LightningError {
202 action: msgs::ErrorAction::SendErrorMessage {
203 msg: msgs::ErrorMessage {
205 data: err.to_string()
209 shutdown_finish: Some((shutdown_res, channel_update)),
213 fn from_chan_no_close(err: ChannelError, channel_id: [u8; 32]) -> Self {
216 ChannelError::Ignore(msg) => LightningError {
218 action: msgs::ErrorAction::IgnoreError,
220 ChannelError::Close(msg) => LightningError {
222 action: msgs::ErrorAction::SendErrorMessage {
223 msg: msgs::ErrorMessage {
225 data: msg.to_string()
229 ChannelError::CloseDelayBroadcast { msg, .. } => LightningError {
231 action: msgs::ErrorAction::SendErrorMessage {
232 msg: msgs::ErrorMessage {
234 data: msg.to_string()
239 shutdown_finish: None,
244 /// We hold back HTLCs we intend to relay for a random interval greater than this (see
245 /// Event::PendingHTLCsForwardable for the API guidelines indicating how long should be waited).
246 /// This provides some limited amount of privacy. Ideally this would range from somewhere like one
247 /// second to 30 seconds, but people expect lightning to be, you know, kinda fast, sadly.
248 const MIN_HTLC_RELAY_HOLDING_CELL_MILLIS: u64 = 100;
250 /// For events which result in both a RevokeAndACK and a CommitmentUpdate, by default they should
251 /// be sent in the order they appear in the return value, however sometimes the order needs to be
252 /// variable at runtime (eg Channel::channel_reestablish needs to re-send messages in the order
253 /// they were originally sent). In those cases, this enum is also returned.
254 #[derive(Clone, PartialEq)]
255 pub(super) enum RAACommitmentOrder {
256 /// Send the CommitmentUpdate messages first
258 /// Send the RevokeAndACK message first
262 // Note this is only exposed in cfg(test):
263 pub(super) struct ChannelHolder<ChanSigner: ChannelKeys> {
264 pub(super) by_id: HashMap<[u8; 32], Channel<ChanSigner>>,
265 pub(super) short_to_id: HashMap<u64, [u8; 32]>,
266 /// short channel id -> forward infos. Key of 0 means payments received
267 /// Note that while this is held in the same mutex as the channels themselves, no consistency
268 /// guarantees are made about the existence of a channel with the short id here, nor the short
269 /// ids in the PendingHTLCInfo!
270 pub(super) forward_htlcs: HashMap<u64, Vec<HTLCForwardInfo>>,
271 /// payment_hash -> Vec<(amount_received, htlc_source)> for tracking things that were to us and
272 /// can be failed/claimed by the user
273 /// Note that while this is held in the same mutex as the channels themselves, no consistency
274 /// guarantees are made about the channels given here actually existing anymore by the time you
276 pub(super) claimable_htlcs: HashMap<PaymentHash, Vec<(u64, HTLCPreviousHopData)>>,
277 /// Messages to send to peers - pushed to in the same lock that they are generated in (except
278 /// for broadcast messages, where ordering isn't as strict).
279 pub(super) pending_msg_events: Vec<events::MessageSendEvent>,
282 /// State we hold per-peer. In the future we should put channels in here, but for now we only hold
283 /// the latest Init features we heard from the peer.
285 latest_features: InitFeatures,
288 #[cfg(not(any(target_pointer_width = "32", target_pointer_width = "64")))]
289 const ERR: () = "You need at least 32 bit pointers (well, usize, but we'll assume they're the same) for ChannelManager::latest_block_height";
291 /// SimpleArcChannelManager is useful when you need a ChannelManager with a static lifetime, e.g.
292 /// when you're using lightning-net-tokio (since tokio::spawn requires parameters with static
293 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
294 /// SimpleRefChannelManager is the more appropriate type. Defining these type aliases prevents
295 /// issues such as overly long function definitions.
296 pub type SimpleArcChannelManager<M, T> = Arc<ChannelManager<InMemoryChannelKeys, Arc<M>, Arc<T>>>;
298 /// SimpleRefChannelManager is a type alias for a ChannelManager reference, and is the reference
299 /// counterpart to the SimpleArcChannelManager type alias. Use this type by default when you don't
300 /// need a ChannelManager with a static lifetime. You'll need a static lifetime in cases such as
301 /// usage of lightning-net-tokio (since tokio::spawn requires parameters with static lifetimes).
302 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
303 /// helps with issues such as long function definitions.
304 pub type SimpleRefChannelManager<'a, 'b, M, T> = ChannelManager<InMemoryChannelKeys, &'a M, &'b T>;
306 /// Manager which keeps track of a number of channels and sends messages to the appropriate
307 /// channel, also tracking HTLC preimages and forwarding onion packets appropriately.
309 /// Implements ChannelMessageHandler, handling the multi-channel parts and passing things through
310 /// to individual Channels.
312 /// Implements Writeable to write out all channel state to disk. Implies peer_disconnected() for
313 /// all peers during write/read (though does not modify this instance, only the instance being
314 /// serialized). This will result in any channels which have not yet exchanged funding_created (ie
315 /// called funding_transaction_generated for outbound channels).
317 /// Note that you can be a bit lazier about writing out ChannelManager than you can be with
318 /// ChannelMonitors. With ChannelMonitors you MUST write each monitor update out to disk before
319 /// returning from ManyChannelMonitor::add_/update_monitor, with ChannelManagers, writing updates
320 /// happens out-of-band (and will prevent any other ChannelManager operations from occurring during
321 /// the serialization process). If the deserialized version is out-of-date compared to the
322 /// ChannelMonitors passed by reference to read(), those channels will be force-closed based on the
323 /// ChannelMonitor state and no funds will be lost (mod on-chain transaction fees).
325 /// Note that the deserializer is only implemented for (Sha256dHash, ChannelManager), which
326 /// tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
327 /// the "reorg path" (ie call block_disconnected() until you get to a common block and then call
328 /// block_connected() to step towards your best block) upon deserialization before using the
331 /// Note that ChannelManager is responsible for tracking liveness of its channels and generating
332 /// ChannelUpdate messages informing peers that the channel is temporarily disabled. To avoid
333 /// spam due to quick disconnection/reconnection, updates are not sent until the channel has been
334 /// offline for a full minute. In order to track this, you must call
335 /// timer_chan_freshness_every_min roughly once per minute, though it doesn't have to be perfect.
337 /// Rather than using a plain ChannelManager, it is preferable to use either a SimpleArcChannelManager
338 /// a SimpleRefChannelManager, for conciseness. See their documentation for more details, but
339 /// essentially you should default to using a SimpleRefChannelManager, and use a
340 /// SimpleArcChannelManager when you require a ChannelManager with a static lifetime, such as when
341 /// you're using lightning-net-tokio.
342 pub struct ChannelManager<ChanSigner: ChannelKeys, M: Deref, T: Deref>
343 where M::Target: ManyChannelMonitor<ChanSigner>,
344 T::Target: BroadcasterInterface,
346 default_configuration: UserConfig,
347 genesis_hash: Sha256dHash,
348 fee_estimator: Arc<FeeEstimator>,
353 pub(super) latest_block_height: AtomicUsize,
355 latest_block_height: AtomicUsize,
356 last_block_hash: Mutex<Sha256dHash>,
357 secp_ctx: Secp256k1<secp256k1::All>,
360 pub(super) channel_state: Mutex<ChannelHolder<ChanSigner>>,
362 channel_state: Mutex<ChannelHolder<ChanSigner>>,
363 our_network_key: SecretKey,
365 /// The bulk of our storage will eventually be here (channels and message queues and the like).
366 /// If we are connected to a peer we always at least have an entry here, even if no channels
367 /// are currently open with that peer.
368 /// Because adding or removing an entry is rare, we usually take an outer read lock and then
369 /// operate on the inner value freely. Sadly, this prevents parallel operation when opening a
371 per_peer_state: RwLock<HashMap<PublicKey, Mutex<PeerState>>>,
373 pending_events: Mutex<Vec<events::Event>>,
374 /// Used when we have to take a BIG lock to make sure everything is self-consistent.
375 /// Essentially just when we're serializing ourselves out.
376 /// Taken first everywhere where we are making changes before any other locks.
377 total_consistency_lock: RwLock<()>,
379 keys_manager: Arc<KeysInterface<ChanKeySigner = ChanSigner>>,
384 /// The amount of time we require our counterparty wait to claim their money (ie time between when
385 /// we, or our watchtower, must check for them having broadcast a theft transaction).
386 pub(crate) const BREAKDOWN_TIMEOUT: u16 = 6 * 24;
387 /// The amount of time we're willing to wait to claim money back to us
388 pub(crate) const MAX_LOCAL_BREAKDOWN_TIMEOUT: u16 = 6 * 24 * 7;
390 /// The minimum number of blocks between an inbound HTLC's CLTV and the corresponding outbound
391 /// HTLC's CLTV. This should always be a few blocks greater than channelmonitor::CLTV_CLAIM_BUFFER,
392 /// ie the node we forwarded the payment on to should always have enough room to reliably time out
393 /// the HTLC via a full update_fail_htlc/commitment_signed dance before we hit the
394 /// CLTV_CLAIM_BUFFER point (we static assert that it's at least 3 blocks more).
395 const CLTV_EXPIRY_DELTA: u16 = 6 * 12; //TODO?
396 pub(super) const CLTV_FAR_FAR_AWAY: u32 = 6 * 24 * 7; //TODO?
398 // Check that our CLTV_EXPIRY is at least CLTV_CLAIM_BUFFER + ANTI_REORG_DELAY + LATENCY_GRACE_PERIOD_BLOCKS,
399 // ie that if the next-hop peer fails the HTLC within
400 // LATENCY_GRACE_PERIOD_BLOCKS then we'll still have CLTV_CLAIM_BUFFER left to timeout it onchain,
401 // then waiting ANTI_REORG_DELAY to be reorg-safe on the outbound HLTC and
402 // failing the corresponding htlc backward, and us now seeing the last block of ANTI_REORG_DELAY before
403 // LATENCY_GRACE_PERIOD_BLOCKS.
406 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;
408 // Check for ability of an attacker to make us fail on-chain by delaying inbound claim. See
409 // ChannelMontior::would_broadcast_at_height for a description of why this is needed.
412 const CHECK_CLTV_EXPIRY_SANITY_2: u32 = CLTV_EXPIRY_DELTA as u32 - LATENCY_GRACE_PERIOD_BLOCKS - 2*CLTV_CLAIM_BUFFER;
414 macro_rules! secp_call {
415 ( $res: expr, $err: expr ) => {
418 Err(_) => return Err($err),
423 /// Details of a channel, as returned by ChannelManager::list_channels and ChannelManager::list_usable_channels
424 pub struct ChannelDetails {
425 /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
426 /// thereafter this is the txid of the funding transaction xor the funding transaction output).
427 /// Note that this means this value is *not* persistent - it can change once during the
428 /// lifetime of the channel.
429 pub channel_id: [u8; 32],
430 /// The position of the funding transaction in the chain. None if the funding transaction has
431 /// not yet been confirmed and the channel fully opened.
432 pub short_channel_id: Option<u64>,
433 /// The node_id of our counterparty
434 pub remote_network_id: PublicKey,
435 /// The Features the channel counterparty provided upon last connection.
436 /// Useful for routing as it is the most up-to-date copy of the counterparty's features and
437 /// many routing-relevant features are present in the init context.
438 pub counterparty_features: InitFeatures,
439 /// The value, in satoshis, of this channel as appears in the funding output
440 pub channel_value_satoshis: u64,
441 /// The user_id passed in to create_channel, or 0 if the channel was inbound.
443 /// The available outbound capacity for sending HTLCs to the remote peer. This does not include
444 /// any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
445 /// available for inclusion in new outbound HTLCs). This further does not include any pending
446 /// outgoing HTLCs which are awaiting some other resolution to be sent.
447 pub outbound_capacity_msat: u64,
448 /// The available inbound capacity for the remote peer to send HTLCs to us. This does not
449 /// include any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
450 /// available for inclusion in new inbound HTLCs).
451 /// Note that there are some corner cases not fully handled here, so the actual available
452 /// inbound capacity may be slightly higher than this.
453 pub inbound_capacity_msat: u64,
454 /// True if the channel is (a) confirmed and funding_locked messages have been exchanged, (b)
455 /// the peer is connected, and (c) no monitor update failure is pending resolution.
459 macro_rules! handle_error {
460 ($self: ident, $internal: expr, $their_node_id: expr, $locked_channel_state: expr) => {
463 Err(MsgHandleErrInternal { err, shutdown_finish }) => {
464 if let Some((shutdown_res, update_option)) = shutdown_finish {
465 $self.finish_force_close_channel(shutdown_res);
466 if let Some(update) = update_option {
467 $locked_channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
472 log_error!($self, "{}", err.err);
473 if let msgs::ErrorAction::IgnoreError = err.action {
474 } else { $locked_channel_state.pending_msg_events.push(events::MessageSendEvent::HandleError { node_id: $their_node_id, action: err.action.clone() }); }
475 // Return error in case higher-API need one
482 macro_rules! break_chan_entry {
483 ($self: ident, $res: expr, $channel_state: expr, $entry: expr) => {
486 Err(ChannelError::Ignore(msg)) => {
487 break Err(MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore(msg), $entry.key().clone()))
489 Err(ChannelError::Close(msg)) => {
490 log_trace!($self, "Closing channel {} due to Close-required error: {}", log_bytes!($entry.key()[..]), msg);
491 let (channel_id, mut chan) = $entry.remove_entry();
492 if let Some(short_id) = chan.get_short_channel_id() {
493 $channel_state.short_to_id.remove(&short_id);
495 break Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, chan.force_shutdown(), $self.get_channel_update(&chan).ok()))
497 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"); }
502 macro_rules! try_chan_entry {
503 ($self: ident, $res: expr, $channel_state: expr, $entry: expr) => {
506 Err(ChannelError::Ignore(msg)) => {
507 return Err(MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore(msg), $entry.key().clone()))
509 Err(ChannelError::Close(msg)) => {
510 log_trace!($self, "Closing channel {} due to Close-required error: {}", log_bytes!($entry.key()[..]), msg);
511 let (channel_id, mut chan) = $entry.remove_entry();
512 if let Some(short_id) = chan.get_short_channel_id() {
513 $channel_state.short_to_id.remove(&short_id);
515 return Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, chan.force_shutdown(), $self.get_channel_update(&chan).ok()))
517 Err(ChannelError::CloseDelayBroadcast { msg, update }) => {
518 log_error!($self, "Channel {} need to be shutdown but closing transactions not broadcast due to {}", log_bytes!($entry.key()[..]), msg);
519 let (channel_id, mut chan) = $entry.remove_entry();
520 if let Some(short_id) = chan.get_short_channel_id() {
521 $channel_state.short_to_id.remove(&short_id);
523 if let Err(e) = $self.monitor.update_monitor(chan.get_funding_txo().unwrap(), update) {
525 // Upstream channel is dead, but we want at least to fail backward HTLCs to save
526 // downstream channels. In case of PermanentFailure, we are not going to be able
527 // to claim back to_remote output on remote commitment transaction. Doesn't
528 // make a difference here, we are concern about HTLCs circuit, not onchain funds.
529 ChannelMonitorUpdateErr::PermanentFailure => {},
530 ChannelMonitorUpdateErr::TemporaryFailure => {},
533 let mut shutdown_res = chan.force_shutdown();
534 if shutdown_res.0.len() >= 1 {
535 log_error!($self, "You have a toxic local commitment transaction {} avaible in channel monitor, read comment in ChannelMonitor::get_latest_local_commitment_txn to be informed of manual action to take", shutdown_res.0[0].txid());
537 shutdown_res.0.clear();
538 return Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, shutdown_res, $self.get_channel_update(&chan).ok()))
544 macro_rules! handle_monitor_err {
545 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
546 handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment, Vec::new(), Vec::new())
548 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr, $failed_forwards: expr, $failed_fails: expr) => {
550 ChannelMonitorUpdateErr::PermanentFailure => {
551 log_error!($self, "Closing channel {} due to monitor update PermanentFailure", log_bytes!($entry.key()[..]));
552 let (channel_id, mut chan) = $entry.remove_entry();
553 if let Some(short_id) = chan.get_short_channel_id() {
554 $channel_state.short_to_id.remove(&short_id);
556 // TODO: $failed_fails is dropped here, which will cause other channels to hit the
557 // chain in a confused state! We need to move them into the ChannelMonitor which
558 // will be responsible for failing backwards once things confirm on-chain.
559 // It's ok that we drop $failed_forwards here - at this point we'd rather they
560 // broadcast HTLC-Timeout and pay the associated fees to get their funds back than
561 // us bother trying to claim it just to forward on to another peer. If we're
562 // splitting hairs we'd prefer to claim payments that were to us, but we haven't
563 // given up the preimage yet, so might as well just wait until the payment is
564 // retried, avoiding the on-chain fees.
565 let res: Result<(), _> = Err(MsgHandleErrInternal::from_finish_shutdown("ChannelMonitor storage failure", channel_id, chan.force_shutdown(), $self.get_channel_update(&chan).ok()));
568 ChannelMonitorUpdateErr::TemporaryFailure => {
569 log_info!($self, "Disabling channel {} due to monitor update TemporaryFailure. On restore will send {} and process {} forwards and {} fails",
570 log_bytes!($entry.key()[..]),
571 if $resend_commitment && $resend_raa {
573 RAACommitmentOrder::CommitmentFirst => { "commitment then RAA" },
574 RAACommitmentOrder::RevokeAndACKFirst => { "RAA then commitment" },
576 } else if $resend_commitment { "commitment" }
577 else if $resend_raa { "RAA" }
579 (&$failed_forwards as &Vec<(PendingHTLCInfo, u64)>).len(),
580 (&$failed_fails as &Vec<(HTLCSource, PaymentHash, HTLCFailReason)>).len());
581 if !$resend_commitment {
582 debug_assert!($action_type == RAACommitmentOrder::RevokeAndACKFirst || !$resend_raa);
585 debug_assert!($action_type == RAACommitmentOrder::CommitmentFirst || !$resend_commitment);
587 $entry.get_mut().monitor_update_failed($resend_raa, $resend_commitment, $failed_forwards, $failed_fails);
588 Err(MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore("Failed to update ChannelMonitor"), *$entry.key()))
594 macro_rules! return_monitor_err {
595 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
596 return handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment);
598 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr, $failed_forwards: expr, $failed_fails: expr) => {
599 return handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment, $failed_forwards, $failed_fails);
603 // Does not break in case of TemporaryFailure!
604 macro_rules! maybe_break_monitor_err {
605 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
606 match (handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment), $err) {
607 (e, ChannelMonitorUpdateErr::PermanentFailure) => {
610 (_, ChannelMonitorUpdateErr::TemporaryFailure) => { },
615 impl<ChanSigner: ChannelKeys, M: Deref, T: Deref> ChannelManager<ChanSigner, M, T>
616 where M::Target: ManyChannelMonitor<ChanSigner>,
617 T::Target: BroadcasterInterface,
619 /// Constructs a new ChannelManager to hold several channels and route between them.
621 /// This is the main "logic hub" for all channel-related actions, and implements
622 /// ChannelMessageHandler.
624 /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
626 /// panics if channel_value_satoshis is >= `MAX_FUNDING_SATOSHIS`!
628 /// Users must provide the current blockchain height from which to track onchain channel
629 /// funding outpoints and send payments with reliable timelocks.
631 /// Users need to notify the new ChannelManager when a new block is connected or
632 /// disconnected using its `block_connected` and `block_disconnected` methods.
633 /// However, rather than calling these methods directly, the user should register
634 /// the ChannelManager as a listener to the BlockNotifier and call the BlockNotifier's
635 /// `block_(dis)connected` methods, which will notify all registered listeners in one
637 pub fn new(network: Network, feeest: Arc<FeeEstimator>, monitor: M, tx_broadcaster: T, logger: Arc<Logger>,keys_manager: Arc<KeysInterface<ChanKeySigner = ChanSigner>>, config: UserConfig, current_blockchain_height: usize) -> Result<ChannelManager<ChanSigner, M, T>, secp256k1::Error> {
638 let secp_ctx = Secp256k1::new();
640 let res = ChannelManager {
641 default_configuration: config.clone(),
642 genesis_hash: genesis_block(network).header.bitcoin_hash(),
643 fee_estimator: feeest.clone(),
647 latest_block_height: AtomicUsize::new(current_blockchain_height),
648 last_block_hash: Mutex::new(Default::default()),
651 channel_state: Mutex::new(ChannelHolder{
652 by_id: HashMap::new(),
653 short_to_id: HashMap::new(),
654 forward_htlcs: HashMap::new(),
655 claimable_htlcs: HashMap::new(),
656 pending_msg_events: Vec::new(),
658 our_network_key: keys_manager.get_node_secret(),
660 per_peer_state: RwLock::new(HashMap::new()),
662 pending_events: Mutex::new(Vec::new()),
663 total_consistency_lock: RwLock::new(()),
673 /// Creates a new outbound channel to the given remote node and with the given value.
675 /// user_id will be provided back as user_channel_id in FundingGenerationReady and
676 /// FundingBroadcastSafe events to allow tracking of which events correspond with which
677 /// create_channel call. Note that user_channel_id defaults to 0 for inbound channels, so you
678 /// may wish to avoid using 0 for user_id here.
680 /// If successful, will generate a SendOpenChannel message event, so you should probably poll
681 /// PeerManager::process_events afterwards.
683 /// Raises APIError::APIMisuseError when channel_value_satoshis > 2**24 or push_msat is
684 /// greater than channel_value_satoshis * 1k or channel_value_satoshis is < 1000.
685 pub fn create_channel(&self, their_network_key: PublicKey, channel_value_satoshis: u64, push_msat: u64, user_id: u64) -> Result<(), APIError> {
686 if channel_value_satoshis < 1000 {
687 return Err(APIError::APIMisuseError { err: "channel_value must be at least 1000 satoshis" });
690 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), &self.default_configuration)?;
691 let res = channel.get_open_channel(self.genesis_hash.clone(), &*self.fee_estimator);
693 let _ = self.total_consistency_lock.read().unwrap();
694 let mut channel_state = self.channel_state.lock().unwrap();
695 match channel_state.by_id.entry(channel.channel_id()) {
696 hash_map::Entry::Occupied(_) => {
697 if cfg!(feature = "fuzztarget") {
698 return Err(APIError::APIMisuseError { err: "Fuzzy bad RNG" });
700 panic!("RNG is bad???");
703 hash_map::Entry::Vacant(entry) => { entry.insert(channel); }
705 channel_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
706 node_id: their_network_key,
712 fn list_channels_with_filter<F: FnMut(&(&[u8; 32], &Channel<ChanSigner>)) -> bool>(&self, f: F) -> Vec<ChannelDetails> {
713 let mut res = Vec::new();
715 let channel_state = self.channel_state.lock().unwrap();
716 res.reserve(channel_state.by_id.len());
717 for (channel_id, channel) in channel_state.by_id.iter().filter(f) {
718 let (inbound_capacity_msat, outbound_capacity_msat) = channel.get_inbound_outbound_available_balance_msat();
719 res.push(ChannelDetails {
720 channel_id: (*channel_id).clone(),
721 short_channel_id: channel.get_short_channel_id(),
722 remote_network_id: channel.get_their_node_id(),
723 counterparty_features: InitFeatures::empty(),
724 channel_value_satoshis: channel.get_value_satoshis(),
725 inbound_capacity_msat,
726 outbound_capacity_msat,
727 user_id: channel.get_user_id(),
728 is_live: channel.is_live(),
732 let per_peer_state = self.per_peer_state.read().unwrap();
733 for chan in res.iter_mut() {
734 if let Some(peer_state) = per_peer_state.get(&chan.remote_network_id) {
735 chan.counterparty_features = peer_state.lock().unwrap().latest_features.clone();
741 /// Gets the list of open channels, in random order. See ChannelDetail field documentation for
742 /// more information.
743 pub fn list_channels(&self) -> Vec<ChannelDetails> {
744 self.list_channels_with_filter(|_| true)
747 /// Gets the list of usable channels, in random order. Useful as an argument to
748 /// Router::get_route to ensure non-announced channels are used.
750 /// These are guaranteed to have their is_live value set to true, see the documentation for
751 /// ChannelDetails::is_live for more info on exactly what the criteria are.
752 pub fn list_usable_channels(&self) -> Vec<ChannelDetails> {
753 // Note we use is_live here instead of usable which leads to somewhat confused
754 // internal/external nomenclature, but that's ok cause that's probably what the user
755 // really wanted anyway.
756 self.list_channels_with_filter(|&(_, ref channel)| channel.is_live())
759 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
760 /// will be accepted on the given channel, and after additional timeout/the closing of all
761 /// pending HTLCs, the channel will be closed on chain.
763 /// May generate a SendShutdown message event on success, which should be relayed.
764 pub fn close_channel(&self, channel_id: &[u8; 32]) -> Result<(), APIError> {
765 let _ = self.total_consistency_lock.read().unwrap();
767 let (mut failed_htlcs, chan_option) = {
768 let mut channel_state_lock = self.channel_state.lock().unwrap();
769 let channel_state = &mut *channel_state_lock;
770 match channel_state.by_id.entry(channel_id.clone()) {
771 hash_map::Entry::Occupied(mut chan_entry) => {
772 let (shutdown_msg, failed_htlcs) = chan_entry.get_mut().get_shutdown()?;
773 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
774 node_id: chan_entry.get().get_their_node_id(),
777 if chan_entry.get().is_shutdown() {
778 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
779 channel_state.short_to_id.remove(&short_id);
781 (failed_htlcs, Some(chan_entry.remove_entry().1))
782 } else { (failed_htlcs, None) }
784 hash_map::Entry::Vacant(_) => return Err(APIError::ChannelUnavailable{err: "No such channel"})
787 for htlc_source in failed_htlcs.drain(..) {
788 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() });
790 let chan_update = if let Some(chan) = chan_option {
791 if let Ok(update) = self.get_channel_update(&chan) {
796 if let Some(update) = chan_update {
797 let mut channel_state = self.channel_state.lock().unwrap();
798 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
807 fn finish_force_close_channel(&self, shutdown_res: ShutdownResult) {
808 let (local_txn, mut failed_htlcs) = shutdown_res;
809 log_trace!(self, "Finishing force-closure of channel with {} transactions to broadcast and {} HTLCs to fail", local_txn.len(), failed_htlcs.len());
810 for htlc_source in failed_htlcs.drain(..) {
811 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() });
813 for tx in local_txn {
814 log_trace!(self, "Broadcast onchain {}", log_tx!(tx));
815 self.tx_broadcaster.broadcast_transaction(&tx);
819 /// Force closes a channel, immediately broadcasting the latest local commitment transaction to
820 /// the chain and rejecting new HTLCs on the given channel.
821 pub fn force_close_channel(&self, channel_id: &[u8; 32]) {
822 let _ = self.total_consistency_lock.read().unwrap();
825 let mut channel_state_lock = self.channel_state.lock().unwrap();
826 let channel_state = &mut *channel_state_lock;
827 if let Some(chan) = channel_state.by_id.remove(channel_id) {
828 if let Some(short_id) = chan.get_short_channel_id() {
829 channel_state.short_to_id.remove(&short_id);
836 log_trace!(self, "Force-closing channel {}", log_bytes!(channel_id[..]));
837 self.finish_force_close_channel(chan.force_shutdown());
838 if let Ok(update) = self.get_channel_update(&chan) {
839 let mut channel_state = self.channel_state.lock().unwrap();
840 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
846 /// Force close all channels, immediately broadcasting the latest local commitment transaction
847 /// for each to the chain and rejecting new HTLCs on each.
848 pub fn force_close_all_channels(&self) {
849 for chan in self.list_channels() {
850 self.force_close_channel(&chan.channel_id);
854 fn decode_update_add_htlc_onion(&self, msg: &msgs::UpdateAddHTLC) -> (PendingHTLCStatus, MutexGuard<ChannelHolder<ChanSigner>>) {
855 macro_rules! return_malformed_err {
856 ($msg: expr, $err_code: expr) => {
858 log_info!(self, "Failed to accept/forward incoming HTLC: {}", $msg);
859 return (PendingHTLCStatus::Fail(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
860 channel_id: msg.channel_id,
861 htlc_id: msg.htlc_id,
862 sha256_of_onion: Sha256::hash(&msg.onion_routing_packet.hop_data).into_inner(),
863 failure_code: $err_code,
864 })), self.channel_state.lock().unwrap());
869 if let Err(_) = msg.onion_routing_packet.public_key {
870 return_malformed_err!("invalid ephemeral pubkey", 0x8000 | 0x4000 | 6);
873 let shared_secret = {
874 let mut arr = [0; 32];
875 arr.copy_from_slice(&SharedSecret::new(&msg.onion_routing_packet.public_key.unwrap(), &self.our_network_key)[..]);
878 let (rho, mu) = onion_utils::gen_rho_mu_from_shared_secret(&shared_secret);
880 if msg.onion_routing_packet.version != 0 {
881 //TODO: Spec doesn't indicate if we should only hash hop_data here (and in other
882 //sha256_of_onion error data packets), or the entire onion_routing_packet. Either way,
883 //the hash doesn't really serve any purpose - in the case of hashing all data, the
884 //receiving node would have to brute force to figure out which version was put in the
885 //packet by the node that send us the message, in the case of hashing the hop_data, the
886 //node knows the HMAC matched, so they already know what is there...
887 return_malformed_err!("Unknown onion packet version", 0x8000 | 0x4000 | 4);
890 let mut hmac = HmacEngine::<Sha256>::new(&mu);
891 hmac.input(&msg.onion_routing_packet.hop_data);
892 hmac.input(&msg.payment_hash.0[..]);
893 if !fixed_time_eq(&Hmac::from_engine(hmac).into_inner(), &msg.onion_routing_packet.hmac) {
894 return_malformed_err!("HMAC Check failed", 0x8000 | 0x4000 | 5);
897 let mut channel_state = None;
898 macro_rules! return_err {
899 ($msg: expr, $err_code: expr, $data: expr) => {
901 log_info!(self, "Failed to accept/forward incoming HTLC: {}", $msg);
902 if channel_state.is_none() {
903 channel_state = Some(self.channel_state.lock().unwrap());
905 return (PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
906 channel_id: msg.channel_id,
907 htlc_id: msg.htlc_id,
908 reason: onion_utils::build_first_hop_failure_packet(&shared_secret, $err_code, $data),
909 })), channel_state.unwrap());
914 let mut chacha = ChaCha20::new(&rho, &[0u8; 8]);
915 let mut chacha_stream = ChaChaReader { chacha: &mut chacha, read: Cursor::new(&msg.onion_routing_packet.hop_data[..]) };
916 let (next_hop_data, next_hop_hmac) = {
917 match msgs::OnionHopData::read(&mut chacha_stream) {
919 let error_code = match err {
920 msgs::DecodeError::UnknownVersion => 0x4000 | 1, // unknown realm byte
921 msgs::DecodeError::UnknownRequiredFeature|
922 msgs::DecodeError::InvalidValue|
923 msgs::DecodeError::ShortRead => 0x4000 | 22, // invalid_onion_payload
924 _ => 0x2000 | 2, // Should never happen
926 return_err!("Unable to decode our hop data", error_code, &[0;0]);
929 let mut hmac = [0; 32];
930 if let Err(_) = chacha_stream.read_exact(&mut hmac[..]) {
931 return_err!("Unable to decode hop data", 0x4000 | 22, &[0;0]);
938 let pending_forward_info = if next_hop_hmac == [0; 32] {
941 // In tests, make sure that the initial onion pcket data is, at least, non-0.
942 // We could do some fancy randomness test here, but, ehh, whatever.
943 // This checks for the issue where you can calculate the path length given the
944 // onion data as all the path entries that the originator sent will be here
945 // as-is (and were originally 0s).
946 // Of course reverse path calculation is still pretty easy given naive routing
947 // algorithms, but this fixes the most-obvious case.
948 let mut next_bytes = [0; 32];
949 chacha_stream.read_exact(&mut next_bytes).unwrap();
950 assert_ne!(next_bytes[..], [0; 32][..]);
951 chacha_stream.read_exact(&mut next_bytes).unwrap();
952 assert_ne!(next_bytes[..], [0; 32][..]);
956 // final_expiry_too_soon
957 if (msg.cltv_expiry as u64) < self.latest_block_height.load(Ordering::Acquire) as u64 + (CLTV_CLAIM_BUFFER + LATENCY_GRACE_PERIOD_BLOCKS) as u64 {
958 return_err!("The final CLTV expiry is too soon to handle", 17, &[0;0]);
960 // final_incorrect_htlc_amount
961 if next_hop_data.amt_to_forward > msg.amount_msat {
962 return_err!("Upstream node sent less than we were supposed to receive in payment", 19, &byte_utils::be64_to_array(msg.amount_msat));
964 // final_incorrect_cltv_expiry
965 if next_hop_data.outgoing_cltv_value != msg.cltv_expiry {
966 return_err!("Upstream node set CLTV to the wrong value", 18, &byte_utils::be32_to_array(msg.cltv_expiry));
969 // Note that we could obviously respond immediately with an update_fulfill_htlc
970 // message, however that would leak that we are the recipient of this payment, so
971 // instead we stay symmetric with the forwarding case, only responding (after a
972 // delay) once they've send us a commitment_signed!
974 PendingHTLCStatus::Forward(PendingHTLCInfo {
976 payment_hash: msg.payment_hash.clone(),
978 incoming_shared_secret: shared_secret,
979 amt_to_forward: next_hop_data.amt_to_forward,
980 outgoing_cltv_value: next_hop_data.outgoing_cltv_value,
983 let mut new_packet_data = [0; 20*65];
984 let read_pos = chacha_stream.read(&mut new_packet_data).unwrap();
985 #[cfg(debug_assertions)]
988 // a) that the behavior of our stream here will return Ok(0) even if the TLV
989 // read above emptied out our buffer and the unwrap() wont needlessly panic
990 // b) that we didn't somehow magically end up with extra data.
992 debug_assert!(chacha_stream.read(&mut t).unwrap() == 0);
994 // Once we've emptied the set of bytes our peer gave us, encrypt 0 bytes until we
995 // fill the onion hop data we'll forward to our next-hop peer.
996 chacha_stream.chacha.process_in_place(&mut new_packet_data[read_pos..]);
998 let mut new_pubkey = msg.onion_routing_packet.public_key.unwrap();
1000 let blinding_factor = {
1001 let mut sha = Sha256::engine();
1002 sha.input(&new_pubkey.serialize()[..]);
1003 sha.input(&shared_secret);
1004 Sha256::from_engine(sha).into_inner()
1007 let public_key = if let Err(e) = new_pubkey.mul_assign(&self.secp_ctx, &blinding_factor[..]) {
1009 } else { Ok(new_pubkey) };
1011 let outgoing_packet = msgs::OnionPacket {
1014 hop_data: new_packet_data,
1015 hmac: next_hop_hmac.clone(),
1018 let short_channel_id = match next_hop_data.format {
1019 msgs::OnionHopDataFormat::Legacy { short_channel_id } => short_channel_id,
1020 msgs::OnionHopDataFormat::NonFinalNode { short_channel_id } => short_channel_id,
1021 msgs::OnionHopDataFormat::FinalNode => {
1022 return_err!("Final Node OnionHopData provided for us as an intermediary node", 0x4000 | 22, &[0;0]);
1026 PendingHTLCStatus::Forward(PendingHTLCInfo {
1027 onion_packet: Some(outgoing_packet),
1028 payment_hash: msg.payment_hash.clone(),
1029 short_channel_id: short_channel_id,
1030 incoming_shared_secret: shared_secret,
1031 amt_to_forward: next_hop_data.amt_to_forward,
1032 outgoing_cltv_value: next_hop_data.outgoing_cltv_value,
1036 channel_state = Some(self.channel_state.lock().unwrap());
1037 if let &PendingHTLCStatus::Forward(PendingHTLCInfo { ref onion_packet, ref short_channel_id, ref amt_to_forward, ref outgoing_cltv_value, .. }) = &pending_forward_info {
1038 if onion_packet.is_some() { // If short_channel_id is 0 here, we'll reject them in the body here
1039 let id_option = channel_state.as_ref().unwrap().short_to_id.get(&short_channel_id).cloned();
1040 let forwarding_id = match id_option {
1041 None => { // unknown_next_peer
1042 return_err!("Don't have available channel for forwarding as requested.", 0x4000 | 10, &[0;0]);
1044 Some(id) => id.clone(),
1046 if let Some((err, code, chan_update)) = loop {
1047 let chan = channel_state.as_mut().unwrap().by_id.get_mut(&forwarding_id).unwrap();
1049 // Note that we could technically not return an error yet here and just hope
1050 // that the connection is reestablished or monitor updated by the time we get
1051 // around to doing the actual forward, but better to fail early if we can and
1052 // hopefully an attacker trying to path-trace payments cannot make this occur
1053 // on a small/per-node/per-channel scale.
1054 if !chan.is_live() { // channel_disabled
1055 break Some(("Forwarding channel is not in a ready state.", 0x1000 | 20, Some(self.get_channel_update(chan).unwrap())));
1057 if *amt_to_forward < chan.get_their_htlc_minimum_msat() { // amount_below_minimum
1058 break Some(("HTLC amount was below the htlc_minimum_msat", 0x1000 | 11, Some(self.get_channel_update(chan).unwrap())));
1060 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) });
1061 if fee.is_none() || msg.amount_msat < fee.unwrap() || (msg.amount_msat - fee.unwrap()) < *amt_to_forward { // fee_insufficient
1062 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())));
1064 if (msg.cltv_expiry as u64) < (*outgoing_cltv_value) as u64 + CLTV_EXPIRY_DELTA as u64 { // incorrect_cltv_expiry
1065 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())));
1067 let cur_height = self.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1068 // We want to have at least LATENCY_GRACE_PERIOD_BLOCKS to fail prior to going on chain CLAIM_BUFFER blocks before expiration
1069 if msg.cltv_expiry <= cur_height + CLTV_CLAIM_BUFFER + LATENCY_GRACE_PERIOD_BLOCKS as u32 { // expiry_too_soon
1070 break Some(("CLTV expiry is too close", 0x1000 | 14, Some(self.get_channel_update(chan).unwrap())));
1072 if msg.cltv_expiry > cur_height + CLTV_FAR_FAR_AWAY as u32 { // expiry_too_far
1073 break Some(("CLTV expiry is too far in the future", 21, None));
1078 let mut res = Vec::with_capacity(8 + 128);
1079 if let Some(chan_update) = chan_update {
1080 if code == 0x1000 | 11 || code == 0x1000 | 12 {
1081 res.extend_from_slice(&byte_utils::be64_to_array(msg.amount_msat));
1083 else if code == 0x1000 | 13 {
1084 res.extend_from_slice(&byte_utils::be32_to_array(msg.cltv_expiry));
1086 else if code == 0x1000 | 20 {
1087 res.extend_from_slice(&byte_utils::be16_to_array(chan_update.contents.flags));
1089 res.extend_from_slice(&chan_update.encode_with_len()[..]);
1091 return_err!(err, code, &res[..]);
1096 (pending_forward_info, channel_state.unwrap())
1099 /// only fails if the channel does not yet have an assigned short_id
1100 /// May be called with channel_state already locked!
1101 fn get_channel_update(&self, chan: &Channel<ChanSigner>) -> Result<msgs::ChannelUpdate, LightningError> {
1102 let short_channel_id = match chan.get_short_channel_id() {
1103 None => return Err(LightningError{err: "Channel not yet established", action: msgs::ErrorAction::IgnoreError}),
1107 let were_node_one = PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key).serialize()[..] < chan.get_their_node_id().serialize()[..];
1109 let unsigned = msgs::UnsignedChannelUpdate {
1110 chain_hash: self.genesis_hash,
1111 short_channel_id: short_channel_id,
1112 timestamp: chan.get_channel_update_count(),
1113 flags: (!were_node_one) as u16 | ((!chan.is_live() as u16) << 1),
1114 cltv_expiry_delta: CLTV_EXPIRY_DELTA,
1115 htlc_minimum_msat: chan.get_our_htlc_minimum_msat(),
1116 fee_base_msat: chan.get_our_fee_base_msat(&*self.fee_estimator),
1117 fee_proportional_millionths: chan.get_fee_proportional_millionths(),
1118 excess_data: Vec::new(),
1121 let msg_hash = Sha256dHash::hash(&unsigned.encode()[..]);
1122 let sig = self.secp_ctx.sign(&hash_to_message!(&msg_hash[..]), &self.our_network_key);
1124 Ok(msgs::ChannelUpdate {
1130 /// Sends a payment along a given route.
1132 /// Value parameters are provided via the last hop in route, see documentation for RouteHop
1133 /// fields for more info.
1135 /// Note that if the payment_hash already exists elsewhere (eg you're sending a duplicative
1136 /// payment), we don't do anything to stop you! We always try to ensure that if the provided
1137 /// next hop knows the preimage to payment_hash they can claim an additional amount as
1138 /// specified in the last hop in the route! Thus, you should probably do your own
1139 /// payment_preimage tracking (which you should already be doing as they represent "proof of
1140 /// payment") and prevent double-sends yourself.
1142 /// May generate a SendHTLCs message event on success, which should be relayed.
1144 /// Raises APIError::RoutError when invalid route or forward parameter
1145 /// (cltv_delta, fee, node public key) is specified.
1146 /// Raises APIError::ChannelUnavailable if the next-hop channel is not available for updates
1147 /// (including due to previous monitor update failure or new permanent monitor update failure).
1148 /// Raised APIError::MonitorUpdateFailed if a new monitor update failure prevented sending the
1149 /// relevant updates.
1151 /// In case of APIError::RouteError/APIError::ChannelUnavailable, the payment send has failed
1152 /// and you may wish to retry via a different route immediately.
1153 /// In case of APIError::MonitorUpdateFailed, the commitment update has been irrevocably
1154 /// committed on our end and we're just waiting for a monitor update to send it. Do NOT retry
1155 /// the payment via a different route unless you intend to pay twice!
1156 pub fn send_payment(&self, route: Route, payment_hash: PaymentHash) -> Result<(), APIError> {
1157 if route.hops.len() < 1 || route.hops.len() > 20 {
1158 return Err(APIError::RouteError{err: "Route didn't go anywhere/had bogus size"});
1160 let our_node_id = self.get_our_node_id();
1161 for (idx, hop) in route.hops.iter().enumerate() {
1162 if idx != route.hops.len() - 1 && hop.pubkey == our_node_id {
1163 return Err(APIError::RouteError{err: "Route went through us but wasn't a simple rebalance loop to us"});
1167 let (session_priv, prng_seed) = self.keys_manager.get_onion_rand();
1169 let cur_height = self.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1171 let onion_keys = secp_call!(onion_utils::construct_onion_keys(&self.secp_ctx, &route, &session_priv),
1172 APIError::RouteError{err: "Pubkey along hop was maliciously selected"});
1173 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height)?;
1174 if onion_utils::route_size_insane(&onion_payloads) {
1175 return Err(APIError::RouteError{err: "Route size too large considering onion data"});
1177 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, prng_seed, &payment_hash);
1179 let _ = self.total_consistency_lock.read().unwrap();
1181 let mut channel_lock = self.channel_state.lock().unwrap();
1182 let err: Result<(), _> = loop {
1184 let id = match channel_lock.short_to_id.get(&route.hops.first().unwrap().short_channel_id) {
1185 None => return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!"}),
1186 Some(id) => id.clone(),
1189 let channel_state = &mut *channel_lock;
1190 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(id) {
1192 if chan.get().get_their_node_id() != route.hops.first().unwrap().pubkey {
1193 return Err(APIError::RouteError{err: "Node ID mismatch on first hop!"});
1195 if !chan.get().is_live() {
1196 return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected/pending monitor update!"});
1198 break_chan_entry!(self, chan.get_mut().send_htlc_and_commit(htlc_msat, payment_hash.clone(), htlc_cltv, HTLCSource::OutboundRoute {
1199 route: route.clone(),
1200 session_priv: session_priv.clone(),
1201 first_hop_htlc_msat: htlc_msat,
1202 }, onion_packet), channel_state, chan)
1204 Some((update_add, commitment_signed, monitor_update)) => {
1205 if let Err(e) = self.monitor.update_monitor(chan.get().get_funding_txo().unwrap(), monitor_update) {
1206 maybe_break_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, true);
1207 // Note that MonitorUpdateFailed here indicates (per function docs)
1208 // that we will resent the commitment update once we unfree monitor
1209 // updating, so we have to take special care that we don't return
1210 // something else in case we will resend later!
1211 return Err(APIError::MonitorUpdateFailed);
1214 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1215 node_id: route.hops.first().unwrap().pubkey,
1216 updates: msgs::CommitmentUpdate {
1217 update_add_htlcs: vec![update_add],
1218 update_fulfill_htlcs: Vec::new(),
1219 update_fail_htlcs: Vec::new(),
1220 update_fail_malformed_htlcs: Vec::new(),
1228 } else { unreachable!(); }
1232 match handle_error!(self, err, route.hops.first().unwrap().pubkey, channel_lock) {
1233 Ok(_) => unreachable!(),
1234 Err(e) => { Err(APIError::ChannelUnavailable { err: e.err }) }
1238 /// Call this upon creation of a funding transaction for the given channel.
1240 /// Note that ALL inputs in the transaction pointed to by funding_txo MUST spend SegWit outputs
1241 /// or your counterparty can steal your funds!
1243 /// Panics if a funding transaction has already been provided for this channel.
1245 /// May panic if the funding_txo is duplicative with some other channel (note that this should
1246 /// be trivially prevented by using unique funding transaction keys per-channel).
1247 pub fn funding_transaction_generated(&self, temporary_channel_id: &[u8; 32], funding_txo: OutPoint) {
1248 let _ = self.total_consistency_lock.read().unwrap();
1250 let (mut chan, msg, chan_monitor) = {
1251 let mut channel_state = self.channel_state.lock().unwrap();
1252 let (res, chan) = match channel_state.by_id.remove(temporary_channel_id) {
1254 (chan.get_outbound_funding_created(funding_txo)
1255 .map_err(|e| if let ChannelError::Close(msg) = e {
1256 MsgHandleErrInternal::from_finish_shutdown(msg, chan.channel_id(), chan.force_shutdown(), None)
1257 } else { unreachable!(); })
1262 match handle_error!(self, res, chan.get_their_node_id(), channel_state) {
1263 Ok(funding_msg) => {
1264 (chan, funding_msg.0, funding_msg.1)
1266 Err(_) => { return; }
1269 // Because we have exclusive ownership of the channel here we can release the channel_state
1270 // lock before add_monitor
1271 if let Err(e) = self.monitor.add_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1273 ChannelMonitorUpdateErr::PermanentFailure => {
1275 let mut channel_state = self.channel_state.lock().unwrap();
1276 match handle_error!(self, Err(MsgHandleErrInternal::from_finish_shutdown("ChannelMonitor storage failure", *temporary_channel_id, chan.force_shutdown(), None)), chan.get_their_node_id(), channel_state) {
1277 Err(_) => { return; },
1278 Ok(()) => unreachable!(),
1282 ChannelMonitorUpdateErr::TemporaryFailure => {
1283 // Its completely fine to continue with a FundingCreated until the monitor
1284 // update is persisted, as long as we don't generate the FundingBroadcastSafe
1285 // until the monitor has been safely persisted (as funding broadcast is not,
1287 chan.monitor_update_failed(false, false, Vec::new(), Vec::new());
1292 let mut channel_state = self.channel_state.lock().unwrap();
1293 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
1294 node_id: chan.get_their_node_id(),
1297 match channel_state.by_id.entry(chan.channel_id()) {
1298 hash_map::Entry::Occupied(_) => {
1299 panic!("Generated duplicate funding txid?");
1301 hash_map::Entry::Vacant(e) => {
1307 fn get_announcement_sigs(&self, chan: &Channel<ChanSigner>) -> Option<msgs::AnnouncementSignatures> {
1308 if !chan.should_announce() {
1309 log_trace!(self, "Can't send announcement_signatures for private channel {}", log_bytes!(chan.channel_id()));
1313 let (announcement, our_bitcoin_sig) = match chan.get_channel_announcement(self.get_our_node_id(), self.genesis_hash.clone()) {
1315 Err(_) => return None, // Only in case of state precondition violations eg channel is closing
1317 let msghash = hash_to_message!(&Sha256dHash::hash(&announcement.encode()[..])[..]);
1318 let our_node_sig = self.secp_ctx.sign(&msghash, &self.our_network_key);
1320 Some(msgs::AnnouncementSignatures {
1321 channel_id: chan.channel_id(),
1322 short_channel_id: chan.get_short_channel_id().unwrap(),
1323 node_signature: our_node_sig,
1324 bitcoin_signature: our_bitcoin_sig,
1328 /// Processes HTLCs which are pending waiting on random forward delay.
1330 /// Should only really ever be called in response to a PendingHTLCsForwardable event.
1331 /// Will likely generate further events.
1332 pub fn process_pending_htlc_forwards(&self) {
1333 let _ = self.total_consistency_lock.read().unwrap();
1335 let mut new_events = Vec::new();
1336 let mut failed_forwards = Vec::new();
1337 let mut handle_errors = Vec::new();
1339 let mut channel_state_lock = self.channel_state.lock().unwrap();
1340 let channel_state = &mut *channel_state_lock;
1342 for (short_chan_id, mut pending_forwards) in channel_state.forward_htlcs.drain() {
1343 if short_chan_id != 0 {
1344 let forward_chan_id = match channel_state.short_to_id.get(&short_chan_id) {
1345 Some(chan_id) => chan_id.clone(),
1347 failed_forwards.reserve(pending_forwards.len());
1348 for forward_info in pending_forwards.drain(..) {
1349 match forward_info {
1350 HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info } => {
1351 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
1352 short_channel_id: prev_short_channel_id,
1353 htlc_id: prev_htlc_id,
1354 incoming_packet_shared_secret: forward_info.incoming_shared_secret,
1356 failed_forwards.push((htlc_source, forward_info.payment_hash, 0x4000 | 10, None));
1358 HTLCForwardInfo::FailHTLC { .. } => {
1359 // Channel went away before we could fail it. This implies
1360 // the channel is now on chain and our counterparty is
1361 // trying to broadcast the HTLC-Timeout, but that's their
1362 // problem, not ours.
1369 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(forward_chan_id) {
1370 let mut add_htlc_msgs = Vec::new();
1371 let mut fail_htlc_msgs = Vec::new();
1372 for forward_info in pending_forwards.drain(..) {
1373 match forward_info {
1374 HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info } => {
1375 log_trace!(self, "Adding HTLC from short id {} with payment_hash {} to channel with short id {} after delay", log_bytes!(forward_info.payment_hash.0), prev_short_channel_id, short_chan_id);
1376 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
1377 short_channel_id: prev_short_channel_id,
1378 htlc_id: prev_htlc_id,
1379 incoming_packet_shared_secret: forward_info.incoming_shared_secret,
1381 match chan.get_mut().send_htlc(forward_info.amt_to_forward, forward_info.payment_hash, forward_info.outgoing_cltv_value, htlc_source.clone(), forward_info.onion_packet.unwrap()) {
1383 if let ChannelError::Ignore(msg) = e {
1384 log_trace!(self, "Failed to forward HTLC with payment_hash {}: {}", log_bytes!(forward_info.payment_hash.0), msg);
1386 panic!("Stated return value requirements in send_htlc() were not met");
1388 let chan_update = self.get_channel_update(chan.get()).unwrap();
1389 failed_forwards.push((htlc_source, forward_info.payment_hash, 0x1000 | 7, Some(chan_update)));
1394 Some(msg) => { add_htlc_msgs.push(msg); },
1396 // Nothing to do here...we're waiting on a remote
1397 // revoke_and_ack before we can add anymore HTLCs. The Channel
1398 // will automatically handle building the update_add_htlc and
1399 // commitment_signed messages when we can.
1400 // TODO: Do some kind of timer to set the channel as !is_live()
1401 // as we don't really want others relying on us relaying through
1402 // this channel currently :/.
1408 HTLCForwardInfo::FailHTLC { htlc_id, err_packet } => {
1409 log_trace!(self, "Failing HTLC back to channel with short id {} after delay", short_chan_id);
1410 match chan.get_mut().get_update_fail_htlc(htlc_id, err_packet) {
1412 if let ChannelError::Ignore(msg) = e {
1413 log_trace!(self, "Failed to fail backwards to short_id {}: {}", short_chan_id, msg);
1415 panic!("Stated return value requirements in get_update_fail_htlc() were not met");
1417 // fail-backs are best-effort, we probably already have one
1418 // pending, and if not that's OK, if not, the channel is on
1419 // the chain and sending the HTLC-Timeout is their problem.
1422 Ok(Some(msg)) => { fail_htlc_msgs.push(msg); },
1424 // Nothing to do here...we're waiting on a remote
1425 // revoke_and_ack before we can update the commitment
1426 // transaction. The Channel will automatically handle
1427 // building the update_fail_htlc and commitment_signed
1428 // messages when we can.
1429 // We don't need any kind of timer here as they should fail
1430 // the channel onto the chain if they can't get our
1431 // update_fail_htlc in time, it's not our problem.
1438 if !add_htlc_msgs.is_empty() || !fail_htlc_msgs.is_empty() {
1439 let (commitment_msg, monitor_update) = match chan.get_mut().send_commitment() {
1442 // We surely failed send_commitment due to bad keys, in that case
1443 // close channel and then send error message to peer.
1444 let their_node_id = chan.get().get_their_node_id();
1445 let err: Result<(), _> = match e {
1446 ChannelError::Ignore(_) => {
1447 panic!("Stated return value requirements in send_commitment() were not met");
1449 ChannelError::Close(msg) => {
1450 log_trace!(self, "Closing channel {} due to Close-required error: {}", log_bytes!(chan.key()[..]), msg);
1451 let (channel_id, mut channel) = chan.remove_entry();
1452 if let Some(short_id) = channel.get_short_channel_id() {
1453 channel_state.short_to_id.remove(&short_id);
1455 Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, channel.force_shutdown(), self.get_channel_update(&channel).ok()))
1457 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"); }
1459 match handle_error!(self, err, their_node_id, channel_state) {
1460 Ok(_) => unreachable!(),
1461 Err(_) => { continue; },
1465 if let Err(e) = self.monitor.update_monitor(chan.get().get_funding_txo().unwrap(), monitor_update) {
1466 handle_errors.push((chan.get().get_their_node_id(), handle_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, true)));
1469 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1470 node_id: chan.get().get_their_node_id(),
1471 updates: msgs::CommitmentUpdate {
1472 update_add_htlcs: add_htlc_msgs,
1473 update_fulfill_htlcs: Vec::new(),
1474 update_fail_htlcs: fail_htlc_msgs,
1475 update_fail_malformed_htlcs: Vec::new(),
1477 commitment_signed: commitment_msg,
1485 for forward_info in pending_forwards.drain(..) {
1486 match forward_info {
1487 HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info } => {
1488 let prev_hop_data = HTLCPreviousHopData {
1489 short_channel_id: prev_short_channel_id,
1490 htlc_id: prev_htlc_id,
1491 incoming_packet_shared_secret: forward_info.incoming_shared_secret,
1493 match channel_state.claimable_htlcs.entry(forward_info.payment_hash) {
1494 hash_map::Entry::Occupied(mut entry) => entry.get_mut().push((forward_info.amt_to_forward, prev_hop_data)),
1495 hash_map::Entry::Vacant(entry) => { entry.insert(vec![(forward_info.amt_to_forward, prev_hop_data)]); },
1497 new_events.push(events::Event::PaymentReceived {
1498 payment_hash: forward_info.payment_hash,
1499 amt: forward_info.amt_to_forward,
1502 HTLCForwardInfo::FailHTLC { .. } => {
1503 panic!("Got pending fail of our own HTLC");
1511 for (htlc_source, payment_hash, failure_code, update) in failed_forwards.drain(..) {
1513 None => self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source, &payment_hash, HTLCFailReason::Reason { failure_code, data: Vec::new() }),
1514 Some(chan_update) => self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source, &payment_hash, HTLCFailReason::Reason { failure_code, data: chan_update.encode_with_len() }),
1518 if handle_errors.len() > 0 {
1519 let mut channel_state_lock = self.channel_state.lock().unwrap();
1520 for (their_node_id, err) in handle_errors.drain(..) {
1521 let _ = handle_error!(self, err, their_node_id, channel_state_lock);
1525 if new_events.is_empty() { return }
1526 let mut events = self.pending_events.lock().unwrap();
1527 events.append(&mut new_events);
1530 /// If a peer is disconnected we mark any channels with that peer as 'disabled'.
1531 /// After some time, if channels are still disabled we need to broadcast a ChannelUpdate
1532 /// to inform the network about the uselessness of these channels.
1534 /// This method handles all the details, and must be called roughly once per minute.
1535 pub fn timer_chan_freshness_every_min(&self) {
1536 let _ = self.total_consistency_lock.read().unwrap();
1537 let mut channel_state_lock = self.channel_state.lock().unwrap();
1538 let channel_state = &mut *channel_state_lock;
1539 for (_, chan) in channel_state.by_id.iter_mut() {
1540 if chan.is_disabled_staged() && !chan.is_live() {
1541 if let Ok(update) = self.get_channel_update(&chan) {
1542 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1547 } else if chan.is_disabled_staged() && chan.is_live() {
1549 } else if chan.is_disabled_marked() {
1550 chan.to_disabled_staged();
1555 /// Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
1556 /// after a PaymentReceived event, failing the HTLC back to its origin and freeing resources
1557 /// along the path (including in our own channel on which we received it).
1558 /// Returns false if no payment was found to fail backwards, true if the process of failing the
1559 /// HTLC backwards has been started.
1560 pub fn fail_htlc_backwards(&self, payment_hash: &PaymentHash) -> bool {
1561 let _ = self.total_consistency_lock.read().unwrap();
1563 let mut channel_state = Some(self.channel_state.lock().unwrap());
1564 let removed_source = channel_state.as_mut().unwrap().claimable_htlcs.remove(payment_hash);
1565 if let Some(mut sources) = removed_source {
1566 for (recvd_value, htlc_with_hash) in sources.drain(..) {
1567 if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
1568 self.fail_htlc_backwards_internal(channel_state.take().unwrap(),
1569 HTLCSource::PreviousHopData(htlc_with_hash), payment_hash,
1570 HTLCFailReason::Reason { failure_code: 0x4000 | 15, data: byte_utils::be64_to_array(recvd_value).to_vec() });
1576 /// Fails an HTLC backwards to the sender of it to us.
1577 /// Note that while we take a channel_state lock as input, we do *not* assume consistency here.
1578 /// There are several callsites that do stupid things like loop over a list of payment_hashes
1579 /// to fail and take the channel_state lock for each iteration (as we take ownership and may
1580 /// drop it). In other words, no assumptions are made that entries in claimable_htlcs point to
1581 /// still-available channels.
1582 fn fail_htlc_backwards_internal(&self, mut channel_state_lock: MutexGuard<ChannelHolder<ChanSigner>>, source: HTLCSource, payment_hash: &PaymentHash, onion_error: HTLCFailReason) {
1583 //TODO: There is a timing attack here where if a node fails an HTLC back to us they can
1584 //identify whether we sent it or not based on the (I presume) very different runtime
1585 //between the branches here. We should make this async and move it into the forward HTLCs
1588 HTLCSource::OutboundRoute { ref route, .. } => {
1589 log_trace!(self, "Failing outbound payment HTLC with payment_hash {}", log_bytes!(payment_hash.0));
1590 mem::drop(channel_state_lock);
1591 match &onion_error {
1592 &HTLCFailReason::LightningError { ref err } => {
1594 let (channel_update, payment_retryable, onion_error_code) = onion_utils::process_onion_failure(&self.secp_ctx, &self.logger, &source, err.data.clone());
1596 let (channel_update, payment_retryable, _) = onion_utils::process_onion_failure(&self.secp_ctx, &self.logger, &source, err.data.clone());
1597 // TODO: If we decided to blame ourselves (or one of our channels) in
1598 // process_onion_failure we should close that channel as it implies our
1599 // next-hop is needlessly blaming us!
1600 if let Some(update) = channel_update {
1601 self.channel_state.lock().unwrap().pending_msg_events.push(
1602 events::MessageSendEvent::PaymentFailureNetworkUpdate {
1607 self.pending_events.lock().unwrap().push(
1608 events::Event::PaymentFailed {
1609 payment_hash: payment_hash.clone(),
1610 rejected_by_dest: !payment_retryable,
1612 error_code: onion_error_code
1616 &HTLCFailReason::Reason {
1620 // we get a fail_malformed_htlc from the first hop
1621 // TODO: We'd like to generate a PaymentFailureNetworkUpdate for temporary
1622 // failures here, but that would be insufficient as Router::get_route
1623 // generally ignores its view of our own channels as we provide them via
1625 // TODO: For non-temporary failures, we really should be closing the
1626 // channel here as we apparently can't relay through them anyway.
1627 self.pending_events.lock().unwrap().push(
1628 events::Event::PaymentFailed {
1629 payment_hash: payment_hash.clone(),
1630 rejected_by_dest: route.hops.len() == 1,
1632 error_code: Some(*failure_code),
1638 HTLCSource::PreviousHopData(HTLCPreviousHopData { short_channel_id, htlc_id, incoming_packet_shared_secret }) => {
1639 let err_packet = match onion_error {
1640 HTLCFailReason::Reason { failure_code, data } => {
1641 log_trace!(self, "Failing HTLC with payment_hash {} backwards from us with code {}", log_bytes!(payment_hash.0), failure_code);
1642 let packet = onion_utils::build_failure_packet(&incoming_packet_shared_secret, failure_code, &data[..]).encode();
1643 onion_utils::encrypt_failure_packet(&incoming_packet_shared_secret, &packet)
1645 HTLCFailReason::LightningError { err } => {
1646 log_trace!(self, "Failing HTLC with payment_hash {} backwards with pre-built LightningError", log_bytes!(payment_hash.0));
1647 onion_utils::encrypt_failure_packet(&incoming_packet_shared_secret, &err.data)
1651 let mut forward_event = None;
1652 if channel_state_lock.forward_htlcs.is_empty() {
1653 forward_event = Some(Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS));
1655 match channel_state_lock.forward_htlcs.entry(short_channel_id) {
1656 hash_map::Entry::Occupied(mut entry) => {
1657 entry.get_mut().push(HTLCForwardInfo::FailHTLC { htlc_id, err_packet });
1659 hash_map::Entry::Vacant(entry) => {
1660 entry.insert(vec!(HTLCForwardInfo::FailHTLC { htlc_id, err_packet }));
1663 mem::drop(channel_state_lock);
1664 if let Some(time) = forward_event {
1665 let mut pending_events = self.pending_events.lock().unwrap();
1666 pending_events.push(events::Event::PendingHTLCsForwardable {
1667 time_forwardable: time
1674 /// Provides a payment preimage in response to a PaymentReceived event, returning true and
1675 /// generating message events for the net layer to claim the payment, if possible. Thus, you
1676 /// should probably kick the net layer to go send messages if this returns true!
1678 /// You must specify the expected amounts for this HTLC, and we will only claim HTLCs
1679 /// available within a few percent of the expected amount. This is critical for several
1680 /// reasons : a) it avoids providing senders with `proof-of-payment` (in the form of the
1681 /// payment_preimage without having provided the full value and b) it avoids certain
1682 /// privacy-breaking recipient-probing attacks which may reveal payment activity to
1683 /// motivated attackers.
1685 /// May panic if called except in response to a PaymentReceived event.
1686 pub fn claim_funds(&self, payment_preimage: PaymentPreimage, expected_amount: u64) -> bool {
1687 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
1689 let _ = self.total_consistency_lock.read().unwrap();
1691 let mut channel_state = Some(self.channel_state.lock().unwrap());
1692 let removed_source = channel_state.as_mut().unwrap().claimable_htlcs.remove(&payment_hash);
1693 if let Some(mut sources) = removed_source {
1694 for (received_amount, htlc_with_hash) in sources.drain(..) {
1695 if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
1696 if received_amount < expected_amount || received_amount > expected_amount * 2 {
1697 let mut htlc_msat_data = byte_utils::be64_to_array(received_amount).to_vec();
1698 let mut height_data = byte_utils::be32_to_array(self.latest_block_height.load(Ordering::Acquire) as u32).to_vec();
1699 htlc_msat_data.append(&mut height_data);
1700 self.fail_htlc_backwards_internal(channel_state.take().unwrap(),
1701 HTLCSource::PreviousHopData(htlc_with_hash), &payment_hash,
1702 HTLCFailReason::Reason { failure_code: 0x4000|15, data: htlc_msat_data });
1704 self.claim_funds_internal(channel_state.take().unwrap(), HTLCSource::PreviousHopData(htlc_with_hash), payment_preimage);
1710 fn claim_funds_internal(&self, mut channel_state_lock: MutexGuard<ChannelHolder<ChanSigner>>, source: HTLCSource, payment_preimage: PaymentPreimage) {
1711 let (their_node_id, err) = loop {
1713 HTLCSource::OutboundRoute { .. } => {
1714 mem::drop(channel_state_lock);
1715 let mut pending_events = self.pending_events.lock().unwrap();
1716 pending_events.push(events::Event::PaymentSent {
1720 HTLCSource::PreviousHopData(HTLCPreviousHopData { short_channel_id, htlc_id, .. }) => {
1721 //TODO: Delay the claimed_funds relaying just like we do outbound relay!
1722 let channel_state = &mut *channel_state_lock;
1724 let chan_id = match channel_state.short_to_id.get(&short_channel_id) {
1725 Some(chan_id) => chan_id.clone(),
1727 // TODO: There is probably a channel manager somewhere that needs to
1728 // learn the preimage as the channel already hit the chain and that's
1729 // why it's missing.
1734 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(chan_id) {
1735 let was_frozen_for_monitor = chan.get().is_awaiting_monitor_update();
1736 match chan.get_mut().get_update_fulfill_htlc_and_commit(htlc_id, payment_preimage) {
1737 Ok((msgs, monitor_option)) => {
1738 if let Some(monitor_update) = monitor_option {
1739 if let Err(e) = self.monitor.update_monitor(chan.get().get_funding_txo().unwrap(), monitor_update) {
1740 if was_frozen_for_monitor {
1741 assert!(msgs.is_none());
1743 break (chan.get().get_their_node_id(), handle_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, msgs.is_some()));
1747 if let Some((msg, commitment_signed)) = msgs {
1748 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1749 node_id: chan.get().get_their_node_id(),
1750 updates: msgs::CommitmentUpdate {
1751 update_add_htlcs: Vec::new(),
1752 update_fulfill_htlcs: vec![msg],
1753 update_fail_htlcs: Vec::new(),
1754 update_fail_malformed_htlcs: Vec::new(),
1762 // TODO: There is probably a channel manager somewhere that needs to
1763 // learn the preimage as the channel may be about to hit the chain.
1764 //TODO: Do something with e?
1768 } else { unreachable!(); }
1774 let _ = handle_error!(self, err, their_node_id, channel_state_lock);
1777 /// Gets the node_id held by this ChannelManager
1778 pub fn get_our_node_id(&self) -> PublicKey {
1779 PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key)
1782 /// Restores a single, given channel to normal operation after a
1783 /// ChannelMonitorUpdateErr::TemporaryFailure was returned from a channel monitor update
1786 /// All ChannelMonitor updates up to and including highest_applied_update_id must have been
1787 /// fully committed in every copy of the given channels' ChannelMonitors.
1789 /// Note that there is no effect to calling with a highest_applied_update_id other than the
1790 /// current latest ChannelMonitorUpdate and one call to this function after multiple
1791 /// ChannelMonitorUpdateErr::TemporaryFailures is fine. The highest_applied_update_id field
1792 /// exists largely only to prevent races between this and concurrent update_monitor calls.
1794 /// Thus, the anticipated use is, at a high level:
1795 /// 1) You register a ManyChannelMonitor with this ChannelManager,
1796 /// 2) it stores each update to disk, and begins updating any remote (eg watchtower) copies of
1797 /// said ChannelMonitors as it can, returning ChannelMonitorUpdateErr::TemporaryFailures
1798 /// any time it cannot do so instantly,
1799 /// 3) update(s) are applied to each remote copy of a ChannelMonitor,
1800 /// 4) once all remote copies are updated, you call this function with the update_id that
1801 /// completed, and once it is the latest the Channel will be re-enabled.
1802 pub fn channel_monitor_updated(&self, funding_txo: &OutPoint, highest_applied_update_id: u64) {
1803 let _ = self.total_consistency_lock.read().unwrap();
1805 let mut close_results = Vec::new();
1806 let mut htlc_forwards = Vec::new();
1807 let mut htlc_failures = Vec::new();
1808 let mut pending_events = Vec::new();
1811 let mut channel_lock = self.channel_state.lock().unwrap();
1812 let channel_state = &mut *channel_lock;
1813 let short_to_id = &mut channel_state.short_to_id;
1814 let pending_msg_events = &mut channel_state.pending_msg_events;
1815 let channel = match channel_state.by_id.get_mut(&funding_txo.to_channel_id()) {
1819 if !channel.is_awaiting_monitor_update() || channel.get_latest_monitor_update_id() != highest_applied_update_id {
1823 let (raa, commitment_update, order, pending_forwards, mut pending_failures, needs_broadcast_safe, funding_locked) = channel.monitor_updating_restored();
1824 if !pending_forwards.is_empty() {
1825 htlc_forwards.push((channel.get_short_channel_id().expect("We can't have pending forwards before funding confirmation"), pending_forwards));
1827 htlc_failures.append(&mut pending_failures);
1829 macro_rules! handle_cs { () => {
1830 if let Some(update) = commitment_update {
1831 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1832 node_id: channel.get_their_node_id(),
1837 macro_rules! handle_raa { () => {
1838 if let Some(revoke_and_ack) = raa {
1839 pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
1840 node_id: channel.get_their_node_id(),
1841 msg: revoke_and_ack,
1846 RAACommitmentOrder::CommitmentFirst => {
1850 RAACommitmentOrder::RevokeAndACKFirst => {
1855 if needs_broadcast_safe {
1856 pending_events.push(events::Event::FundingBroadcastSafe {
1857 funding_txo: channel.get_funding_txo().unwrap(),
1858 user_channel_id: channel.get_user_id(),
1861 if let Some(msg) = funding_locked {
1862 pending_msg_events.push(events::MessageSendEvent::SendFundingLocked {
1863 node_id: channel.get_their_node_id(),
1866 if let Some(announcement_sigs) = self.get_announcement_sigs(channel) {
1867 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
1868 node_id: channel.get_their_node_id(),
1869 msg: announcement_sigs,
1872 short_to_id.insert(channel.get_short_channel_id().unwrap(), channel.channel_id());
1876 self.pending_events.lock().unwrap().append(&mut pending_events);
1878 for failure in htlc_failures.drain(..) {
1879 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), failure.0, &failure.1, failure.2);
1881 self.forward_htlcs(&mut htlc_forwards[..]);
1883 for res in close_results.drain(..) {
1884 self.finish_force_close_channel(res);
1888 fn internal_open_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::OpenChannel) -> Result<(), MsgHandleErrInternal> {
1889 if msg.chain_hash != self.genesis_hash {
1890 return Err(MsgHandleErrInternal::send_err_msg_no_close("Unknown genesis block hash", msg.temporary_channel_id.clone()));
1893 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)
1894 .map_err(|e| MsgHandleErrInternal::from_chan_no_close(e, msg.temporary_channel_id))?;
1895 let mut channel_state_lock = self.channel_state.lock().unwrap();
1896 let channel_state = &mut *channel_state_lock;
1897 match channel_state.by_id.entry(channel.channel_id()) {
1898 hash_map::Entry::Occupied(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("temporary_channel_id collision!", msg.temporary_channel_id.clone())),
1899 hash_map::Entry::Vacant(entry) => {
1900 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
1901 node_id: their_node_id.clone(),
1902 msg: channel.get_accept_channel(),
1904 entry.insert(channel);
1910 fn internal_accept_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::AcceptChannel) -> Result<(), MsgHandleErrInternal> {
1911 let (value, output_script, user_id) = {
1912 let mut channel_lock = self.channel_state.lock().unwrap();
1913 let channel_state = &mut *channel_lock;
1914 match channel_state.by_id.entry(msg.temporary_channel_id) {
1915 hash_map::Entry::Occupied(mut chan) => {
1916 if chan.get().get_their_node_id() != *their_node_id {
1917 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.temporary_channel_id));
1919 try_chan_entry!(self, chan.get_mut().accept_channel(&msg, &self.default_configuration, their_features), channel_state, chan);
1920 (chan.get().get_value_satoshis(), chan.get().get_funding_redeemscript().to_v0_p2wsh(), chan.get().get_user_id())
1922 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.temporary_channel_id))
1925 let mut pending_events = self.pending_events.lock().unwrap();
1926 pending_events.push(events::Event::FundingGenerationReady {
1927 temporary_channel_id: msg.temporary_channel_id,
1928 channel_value_satoshis: value,
1929 output_script: output_script,
1930 user_channel_id: user_id,
1935 fn internal_funding_created(&self, their_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), MsgHandleErrInternal> {
1936 let ((funding_msg, monitor_update), mut chan) = {
1937 let mut channel_lock = self.channel_state.lock().unwrap();
1938 let channel_state = &mut *channel_lock;
1939 match channel_state.by_id.entry(msg.temporary_channel_id.clone()) {
1940 hash_map::Entry::Occupied(mut chan) => {
1941 if chan.get().get_their_node_id() != *their_node_id {
1942 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.temporary_channel_id));
1944 (try_chan_entry!(self, chan.get_mut().funding_created(msg), channel_state, chan), chan.remove())
1946 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.temporary_channel_id))
1949 // Because we have exclusive ownership of the channel here we can release the channel_state
1950 // lock before add_monitor
1951 if let Err(e) = self.monitor.add_monitor(monitor_update.get_funding_txo().unwrap(), monitor_update) {
1953 ChannelMonitorUpdateErr::PermanentFailure => {
1954 // Note that we reply with the new channel_id in error messages if we gave up on the
1955 // channel, not the temporary_channel_id. This is compatible with ourselves, but the
1956 // spec is somewhat ambiguous here. Not a huge deal since we'll send error messages for
1957 // any messages referencing a previously-closed channel anyway.
1958 return Err(MsgHandleErrInternal::from_finish_shutdown("ChannelMonitor storage failure", funding_msg.channel_id, chan.force_shutdown(), None));
1960 ChannelMonitorUpdateErr::TemporaryFailure => {
1961 // There's no problem signing a counterparty's funding transaction if our monitor
1962 // hasn't persisted to disk yet - we can't lose money on a transaction that we haven't
1963 // accepted payment from yet. We do, however, need to wait to send our funding_locked
1964 // until we have persisted our monitor.
1965 chan.monitor_update_failed(false, false, Vec::new(), Vec::new());
1969 let mut channel_state_lock = self.channel_state.lock().unwrap();
1970 let channel_state = &mut *channel_state_lock;
1971 match channel_state.by_id.entry(funding_msg.channel_id) {
1972 hash_map::Entry::Occupied(_) => {
1973 return Err(MsgHandleErrInternal::send_err_msg_no_close("Already had channel with the new channel_id", funding_msg.channel_id))
1975 hash_map::Entry::Vacant(e) => {
1976 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
1977 node_id: their_node_id.clone(),
1986 fn internal_funding_signed(&self, their_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), MsgHandleErrInternal> {
1987 let (funding_txo, user_id) = {
1988 let mut channel_lock = self.channel_state.lock().unwrap();
1989 let channel_state = &mut *channel_lock;
1990 match channel_state.by_id.entry(msg.channel_id) {
1991 hash_map::Entry::Occupied(mut chan) => {
1992 if chan.get().get_their_node_id() != *their_node_id {
1993 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1995 let monitor_update = match chan.get_mut().funding_signed(&msg) {
1996 Err((None, e)) => try_chan_entry!(self, Err(e), channel_state, chan),
1997 Err((Some(monitor_update), e)) => {
1998 assert!(chan.get().is_awaiting_monitor_update());
1999 let _ = self.monitor.update_monitor(chan.get().get_funding_txo().unwrap(), monitor_update);
2000 try_chan_entry!(self, Err(e), channel_state, chan);
2003 Ok(update) => update,
2005 if let Err(e) = self.monitor.update_monitor(chan.get().get_funding_txo().unwrap(), monitor_update) {
2006 return_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::RevokeAndACKFirst, false, false);
2008 (chan.get().get_funding_txo().unwrap(), chan.get().get_user_id())
2010 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2013 let mut pending_events = self.pending_events.lock().unwrap();
2014 pending_events.push(events::Event::FundingBroadcastSafe {
2015 funding_txo: funding_txo,
2016 user_channel_id: user_id,
2021 fn internal_funding_locked(&self, their_node_id: &PublicKey, msg: &msgs::FundingLocked) -> Result<(), MsgHandleErrInternal> {
2022 let mut channel_state_lock = self.channel_state.lock().unwrap();
2023 let channel_state = &mut *channel_state_lock;
2024 match channel_state.by_id.entry(msg.channel_id) {
2025 hash_map::Entry::Occupied(mut chan) => {
2026 if chan.get().get_their_node_id() != *their_node_id {
2027 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2029 try_chan_entry!(self, chan.get_mut().funding_locked(&msg), channel_state, chan);
2030 if let Some(announcement_sigs) = self.get_announcement_sigs(chan.get()) {
2031 log_trace!(self, "Sending announcement_signatures for {} in response to funding_locked", log_bytes!(chan.get().channel_id()));
2032 // If we see locking block before receiving remote funding_locked, we broadcast our
2033 // announcement_sigs at remote funding_locked reception. If we receive remote
2034 // funding_locked before seeing locking block, we broadcast our announcement_sigs at locking
2035 // block connection. We should guanrantee to broadcast announcement_sigs to our peer whatever
2036 // the order of the events but our peer may not receive it due to disconnection. The specs
2037 // lacking an acknowledgement for announcement_sigs we may have to re-send them at peer
2038 // connection in the future if simultaneous misses by both peers due to network/hardware
2039 // failures is an issue. Note, to achieve its goal, only one of the announcement_sigs needs
2040 // to be received, from then sigs are going to be flood to the whole network.
2041 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
2042 node_id: their_node_id.clone(),
2043 msg: announcement_sigs,
2048 hash_map::Entry::Vacant(_) => Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2052 fn internal_shutdown(&self, their_node_id: &PublicKey, msg: &msgs::Shutdown) -> Result<(), MsgHandleErrInternal> {
2053 let (mut dropped_htlcs, chan_option) = {
2054 let mut channel_state_lock = self.channel_state.lock().unwrap();
2055 let channel_state = &mut *channel_state_lock;
2057 match channel_state.by_id.entry(msg.channel_id.clone()) {
2058 hash_map::Entry::Occupied(mut chan_entry) => {
2059 if chan_entry.get().get_their_node_id() != *their_node_id {
2060 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2062 let (shutdown, closing_signed, dropped_htlcs) = try_chan_entry!(self, chan_entry.get_mut().shutdown(&*self.fee_estimator, &msg), channel_state, chan_entry);
2063 if let Some(msg) = shutdown {
2064 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
2065 node_id: their_node_id.clone(),
2069 if let Some(msg) = closing_signed {
2070 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
2071 node_id: their_node_id.clone(),
2075 if chan_entry.get().is_shutdown() {
2076 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
2077 channel_state.short_to_id.remove(&short_id);
2079 (dropped_htlcs, Some(chan_entry.remove_entry().1))
2080 } else { (dropped_htlcs, None) }
2082 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2085 for htlc_source in dropped_htlcs.drain(..) {
2086 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() });
2088 if let Some(chan) = chan_option {
2089 if let Ok(update) = self.get_channel_update(&chan) {
2090 let mut channel_state = self.channel_state.lock().unwrap();
2091 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2099 fn internal_closing_signed(&self, their_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<(), MsgHandleErrInternal> {
2100 let (tx, chan_option) = {
2101 let mut channel_state_lock = self.channel_state.lock().unwrap();
2102 let channel_state = &mut *channel_state_lock;
2103 match channel_state.by_id.entry(msg.channel_id.clone()) {
2104 hash_map::Entry::Occupied(mut chan_entry) => {
2105 if chan_entry.get().get_their_node_id() != *their_node_id {
2106 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2108 let (closing_signed, tx) = try_chan_entry!(self, chan_entry.get_mut().closing_signed(&*self.fee_estimator, &msg), channel_state, chan_entry);
2109 if let Some(msg) = closing_signed {
2110 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
2111 node_id: their_node_id.clone(),
2116 // We're done with this channel, we've got a signed closing transaction and
2117 // will send the closing_signed back to the remote peer upon return. This
2118 // also implies there are no pending HTLCs left on the channel, so we can
2119 // fully delete it from tracking (the channel monitor is still around to
2120 // watch for old state broadcasts)!
2121 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
2122 channel_state.short_to_id.remove(&short_id);
2124 (tx, Some(chan_entry.remove_entry().1))
2125 } else { (tx, None) }
2127 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2130 if let Some(broadcast_tx) = tx {
2131 log_trace!(self, "Broadcast onchain {}", log_tx!(broadcast_tx));
2132 self.tx_broadcaster.broadcast_transaction(&broadcast_tx);
2134 if let Some(chan) = chan_option {
2135 if let Ok(update) = self.get_channel_update(&chan) {
2136 let mut channel_state = self.channel_state.lock().unwrap();
2137 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2145 fn internal_update_add_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), MsgHandleErrInternal> {
2146 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
2147 //determine the state of the payment based on our response/if we forward anything/the time
2148 //we take to respond. We should take care to avoid allowing such an attack.
2150 //TODO: There exists a further attack where a node may garble the onion data, forward it to
2151 //us repeatedly garbled in different ways, and compare our error messages, which are
2152 //encrypted with the same key. It's not immediately obvious how to usefully exploit that,
2153 //but we should prevent it anyway.
2155 let (mut pending_forward_info, mut channel_state_lock) = self.decode_update_add_htlc_onion(msg);
2156 let channel_state = &mut *channel_state_lock;
2158 match channel_state.by_id.entry(msg.channel_id) {
2159 hash_map::Entry::Occupied(mut chan) => {
2160 if chan.get().get_their_node_id() != *their_node_id {
2161 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2163 if !chan.get().is_usable() {
2164 // If the update_add is completely bogus, the call will Err and we will close,
2165 // but if we've sent a shutdown and they haven't acknowledged it yet, we just
2166 // want to reject the new HTLC and fail it backwards instead of forwarding.
2167 if let PendingHTLCStatus::Forward(PendingHTLCInfo { incoming_shared_secret, .. }) = pending_forward_info {
2168 let chan_update = self.get_channel_update(chan.get());
2169 pending_forward_info = PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
2170 channel_id: msg.channel_id,
2171 htlc_id: msg.htlc_id,
2172 reason: if let Ok(update) = chan_update {
2173 // TODO: Note that |20 is defined as "channel FROM the processing
2174 // node has been disabled" (emphasis mine), which seems to imply
2175 // that we can't return |20 for an inbound channel being disabled.
2176 // This probably needs a spec update but should definitely be
2178 onion_utils::build_first_hop_failure_packet(&incoming_shared_secret, 0x1000|20, &{
2179 let mut res = Vec::with_capacity(8 + 128);
2180 res.extend_from_slice(&byte_utils::be16_to_array(update.contents.flags));
2181 res.extend_from_slice(&update.encode_with_len()[..]);
2185 // This can only happen if the channel isn't in the fully-funded
2186 // state yet, implying our counterparty is trying to route payments
2187 // over the channel back to themselves (cause no one else should
2188 // know the short_id is a lightning channel yet). We should have no
2189 // problem just calling this unknown_next_peer
2190 onion_utils::build_first_hop_failure_packet(&incoming_shared_secret, 0x4000|10, &[])
2195 try_chan_entry!(self, chan.get_mut().update_add_htlc(&msg, pending_forward_info), channel_state, chan);
2197 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2202 fn internal_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), MsgHandleErrInternal> {
2203 let mut channel_lock = self.channel_state.lock().unwrap();
2205 let channel_state = &mut *channel_lock;
2206 match channel_state.by_id.entry(msg.channel_id) {
2207 hash_map::Entry::Occupied(mut chan) => {
2208 if chan.get().get_their_node_id() != *their_node_id {
2209 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2211 try_chan_entry!(self, chan.get_mut().update_fulfill_htlc(&msg), channel_state, chan)
2213 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2216 self.claim_funds_internal(channel_lock, htlc_source, msg.payment_preimage.clone());
2220 fn internal_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), MsgHandleErrInternal> {
2221 let mut channel_lock = self.channel_state.lock().unwrap();
2222 let channel_state = &mut *channel_lock;
2223 match channel_state.by_id.entry(msg.channel_id) {
2224 hash_map::Entry::Occupied(mut chan) => {
2225 if chan.get().get_their_node_id() != *their_node_id {
2226 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2228 try_chan_entry!(self, chan.get_mut().update_fail_htlc(&msg, HTLCFailReason::LightningError { err: msg.reason.clone() }), channel_state, chan);
2230 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2235 fn internal_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), MsgHandleErrInternal> {
2236 let mut channel_lock = self.channel_state.lock().unwrap();
2237 let channel_state = &mut *channel_lock;
2238 match channel_state.by_id.entry(msg.channel_id) {
2239 hash_map::Entry::Occupied(mut chan) => {
2240 if chan.get().get_their_node_id() != *their_node_id {
2241 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2243 if (msg.failure_code & 0x8000) == 0 {
2244 let chan_err: ChannelError = ChannelError::Close("Got update_fail_malformed_htlc with BADONION not set");
2245 try_chan_entry!(self, Err(chan_err), channel_state, chan);
2247 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);
2250 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2254 fn internal_commitment_signed(&self, their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), MsgHandleErrInternal> {
2255 let mut channel_state_lock = self.channel_state.lock().unwrap();
2256 let channel_state = &mut *channel_state_lock;
2257 match channel_state.by_id.entry(msg.channel_id) {
2258 hash_map::Entry::Occupied(mut chan) => {
2259 if chan.get().get_their_node_id() != *their_node_id {
2260 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2262 let (revoke_and_ack, commitment_signed, closing_signed, monitor_update) =
2263 match chan.get_mut().commitment_signed(&msg, &*self.fee_estimator) {
2264 Err((None, e)) => try_chan_entry!(self, Err(e), channel_state, chan),
2265 Err((Some(update), e)) => {
2266 assert!(chan.get().is_awaiting_monitor_update());
2267 let _ = self.monitor.update_monitor(chan.get().get_funding_txo().unwrap(), update);
2268 try_chan_entry!(self, Err(e), channel_state, chan);
2273 if let Err(e) = self.monitor.update_monitor(chan.get().get_funding_txo().unwrap(), monitor_update) {
2274 return_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::RevokeAndACKFirst, true, commitment_signed.is_some());
2275 //TODO: Rebroadcast closing_signed if present on monitor update restoration
2277 channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
2278 node_id: their_node_id.clone(),
2279 msg: revoke_and_ack,
2281 if let Some(msg) = commitment_signed {
2282 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2283 node_id: their_node_id.clone(),
2284 updates: msgs::CommitmentUpdate {
2285 update_add_htlcs: Vec::new(),
2286 update_fulfill_htlcs: Vec::new(),
2287 update_fail_htlcs: Vec::new(),
2288 update_fail_malformed_htlcs: Vec::new(),
2290 commitment_signed: msg,
2294 if let Some(msg) = closing_signed {
2295 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
2296 node_id: their_node_id.clone(),
2302 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2307 fn forward_htlcs(&self, per_source_pending_forwards: &mut [(u64, Vec<(PendingHTLCInfo, u64)>)]) {
2308 for &mut (prev_short_channel_id, ref mut pending_forwards) in per_source_pending_forwards {
2309 let mut forward_event = None;
2310 if !pending_forwards.is_empty() {
2311 let mut channel_state = self.channel_state.lock().unwrap();
2312 if channel_state.forward_htlcs.is_empty() {
2313 forward_event = Some(Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS))
2315 for (forward_info, prev_htlc_id) in pending_forwards.drain(..) {
2316 match channel_state.forward_htlcs.entry(forward_info.short_channel_id) {
2317 hash_map::Entry::Occupied(mut entry) => {
2318 entry.get_mut().push(HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info });
2320 hash_map::Entry::Vacant(entry) => {
2321 entry.insert(vec!(HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info }));
2326 match forward_event {
2328 let mut pending_events = self.pending_events.lock().unwrap();
2329 pending_events.push(events::Event::PendingHTLCsForwardable {
2330 time_forwardable: time
2338 fn internal_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), MsgHandleErrInternal> {
2339 let (pending_forwards, mut pending_failures, short_channel_id) = {
2340 let mut channel_state_lock = self.channel_state.lock().unwrap();
2341 let channel_state = &mut *channel_state_lock;
2342 match channel_state.by_id.entry(msg.channel_id) {
2343 hash_map::Entry::Occupied(mut chan) => {
2344 if chan.get().get_their_node_id() != *their_node_id {
2345 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2347 let was_frozen_for_monitor = chan.get().is_awaiting_monitor_update();
2348 let (commitment_update, pending_forwards, pending_failures, closing_signed, monitor_update) =
2349 try_chan_entry!(self, chan.get_mut().revoke_and_ack(&msg, &*self.fee_estimator), channel_state, chan);
2350 if let Err(e) = self.monitor.update_monitor(chan.get().get_funding_txo().unwrap(), monitor_update) {
2351 if was_frozen_for_monitor {
2352 assert!(commitment_update.is_none() && closing_signed.is_none() && pending_forwards.is_empty() && pending_failures.is_empty());
2353 return Err(MsgHandleErrInternal::ignore_no_close("Previous monitor update failure prevented responses to RAA"));
2355 return_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, commitment_update.is_some(), pending_forwards, pending_failures);
2358 if let Some(updates) = commitment_update {
2359 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2360 node_id: their_node_id.clone(),
2364 if let Some(msg) = closing_signed {
2365 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
2366 node_id: their_node_id.clone(),
2370 (pending_forwards, pending_failures, chan.get().get_short_channel_id().expect("RAA should only work on a short-id-available channel"))
2372 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2375 for failure in pending_failures.drain(..) {
2376 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), failure.0, &failure.1, failure.2);
2378 self.forward_htlcs(&mut [(short_channel_id, pending_forwards)]);
2383 fn internal_update_fee(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), MsgHandleErrInternal> {
2384 let mut channel_lock = self.channel_state.lock().unwrap();
2385 let channel_state = &mut *channel_lock;
2386 match channel_state.by_id.entry(msg.channel_id) {
2387 hash_map::Entry::Occupied(mut chan) => {
2388 if chan.get().get_their_node_id() != *their_node_id {
2389 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2391 try_chan_entry!(self, chan.get_mut().update_fee(&*self.fee_estimator, &msg), channel_state, chan);
2393 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2398 fn internal_announcement_signatures(&self, their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), MsgHandleErrInternal> {
2399 let mut channel_state_lock = self.channel_state.lock().unwrap();
2400 let channel_state = &mut *channel_state_lock;
2402 match channel_state.by_id.entry(msg.channel_id) {
2403 hash_map::Entry::Occupied(mut chan) => {
2404 if chan.get().get_their_node_id() != *their_node_id {
2405 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2407 if !chan.get().is_usable() {
2408 return Err(MsgHandleErrInternal::from_no_close(LightningError{err: "Got an announcement_signatures before we were ready for it", action: msgs::ErrorAction::IgnoreError}));
2411 let our_node_id = self.get_our_node_id();
2412 let (announcement, our_bitcoin_sig) =
2413 try_chan_entry!(self, chan.get_mut().get_channel_announcement(our_node_id.clone(), self.genesis_hash.clone()), channel_state, chan);
2415 let were_node_one = announcement.node_id_1 == our_node_id;
2416 let msghash = hash_to_message!(&Sha256dHash::hash(&announcement.encode()[..])[..]);
2417 if self.secp_ctx.verify(&msghash, &msg.node_signature, if were_node_one { &announcement.node_id_2 } else { &announcement.node_id_1 }).is_err() ||
2418 self.secp_ctx.verify(&msghash, &msg.bitcoin_signature, if were_node_one { &announcement.bitcoin_key_2 } else { &announcement.bitcoin_key_1 }).is_err() {
2419 let chan_err: ChannelError = ChannelError::Close("Bad announcement_signatures node_signature");
2420 try_chan_entry!(self, Err(chan_err), channel_state, chan);
2423 let our_node_sig = self.secp_ctx.sign(&msghash, &self.our_network_key);
2425 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
2426 msg: msgs::ChannelAnnouncement {
2427 node_signature_1: if were_node_one { our_node_sig } else { msg.node_signature },
2428 node_signature_2: if were_node_one { msg.node_signature } else { our_node_sig },
2429 bitcoin_signature_1: if were_node_one { our_bitcoin_sig } else { msg.bitcoin_signature },
2430 bitcoin_signature_2: if were_node_one { msg.bitcoin_signature } else { our_bitcoin_sig },
2431 contents: announcement,
2433 update_msg: self.get_channel_update(chan.get()).unwrap(), // can only fail if we're not in a ready state
2436 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2441 fn internal_channel_reestablish(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<(), MsgHandleErrInternal> {
2442 let mut channel_state_lock = self.channel_state.lock().unwrap();
2443 let channel_state = &mut *channel_state_lock;
2445 match channel_state.by_id.entry(msg.channel_id) {
2446 hash_map::Entry::Occupied(mut chan) => {
2447 if chan.get().get_their_node_id() != *their_node_id {
2448 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2450 let (funding_locked, revoke_and_ack, commitment_update, monitor_update_opt, mut order, shutdown) =
2451 try_chan_entry!(self, chan.get_mut().channel_reestablish(msg), channel_state, chan);
2452 if let Some(monitor_update) = monitor_update_opt {
2453 if let Err(e) = self.monitor.update_monitor(chan.get().get_funding_txo().unwrap(), monitor_update) {
2454 // channel_reestablish doesn't guarantee the order it returns is sensical
2455 // for the messages it returns, but if we're setting what messages to
2456 // re-transmit on monitor update success, we need to make sure it is sane.
2457 if revoke_and_ack.is_none() {
2458 order = RAACommitmentOrder::CommitmentFirst;
2460 if commitment_update.is_none() {
2461 order = RAACommitmentOrder::RevokeAndACKFirst;
2463 return_monitor_err!(self, e, channel_state, chan, order, revoke_and_ack.is_some(), commitment_update.is_some());
2464 //TODO: Resend the funding_locked if needed once we get the monitor running again
2467 if let Some(msg) = funding_locked {
2468 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingLocked {
2469 node_id: their_node_id.clone(),
2473 macro_rules! send_raa { () => {
2474 if let Some(msg) = revoke_and_ack {
2475 channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
2476 node_id: their_node_id.clone(),
2481 macro_rules! send_cu { () => {
2482 if let Some(updates) = commitment_update {
2483 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2484 node_id: their_node_id.clone(),
2490 RAACommitmentOrder::RevokeAndACKFirst => {
2494 RAACommitmentOrder::CommitmentFirst => {
2499 if let Some(msg) = shutdown {
2500 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
2501 node_id: their_node_id.clone(),
2507 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2511 /// Begin Update fee process. Allowed only on an outbound channel.
2512 /// If successful, will generate a UpdateHTLCs event, so you should probably poll
2513 /// PeerManager::process_events afterwards.
2514 /// Note: This API is likely to change!
2516 pub fn update_fee(&self, channel_id: [u8;32], feerate_per_kw: u64) -> Result<(), APIError> {
2517 let _ = self.total_consistency_lock.read().unwrap();
2518 let mut channel_state_lock = self.channel_state.lock().unwrap();
2520 let err: Result<(), _> = loop {
2521 let channel_state = &mut *channel_state_lock;
2523 match channel_state.by_id.entry(channel_id) {
2524 hash_map::Entry::Vacant(_) => return Err(APIError::APIMisuseError{err: "Failed to find corresponding channel"}),
2525 hash_map::Entry::Occupied(mut chan) => {
2526 if !chan.get().is_outbound() {
2527 return Err(APIError::APIMisuseError{err: "update_fee cannot be sent for an inbound channel"});
2529 if chan.get().is_awaiting_monitor_update() {
2530 return Err(APIError::MonitorUpdateFailed);
2532 if !chan.get().is_live() {
2533 return Err(APIError::ChannelUnavailable{err: "Channel is either not yet fully established or peer is currently disconnected"});
2535 their_node_id = chan.get().get_their_node_id();
2536 if let Some((update_fee, commitment_signed, monitor_update)) =
2537 break_chan_entry!(self, chan.get_mut().send_update_fee_and_commit(feerate_per_kw), channel_state, chan)
2539 if let Err(_e) = self.monitor.update_monitor(chan.get().get_funding_txo().unwrap(), monitor_update) {
2542 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2543 node_id: chan.get().get_their_node_id(),
2544 updates: msgs::CommitmentUpdate {
2545 update_add_htlcs: Vec::new(),
2546 update_fulfill_htlcs: Vec::new(),
2547 update_fail_htlcs: Vec::new(),
2548 update_fail_malformed_htlcs: Vec::new(),
2549 update_fee: Some(update_fee),
2559 match handle_error!(self, err, their_node_id, channel_state_lock) {
2560 Ok(_) => unreachable!(),
2561 Err(e) => { Err(APIError::APIMisuseError { err: e.err })}
2566 impl<ChanSigner: ChannelKeys, M: Deref, T: Deref> events::MessageSendEventsProvider for ChannelManager<ChanSigner, M, T>
2567 where M::Target: ManyChannelMonitor<ChanSigner>,
2568 T::Target: BroadcasterInterface,
2570 fn get_and_clear_pending_msg_events(&self) -> Vec<events::MessageSendEvent> {
2571 // TODO: Event release to users and serialization is currently race-y: it's very easy for a
2572 // user to serialize a ChannelManager with pending events in it and lose those events on
2573 // restart. This is doubly true for the fail/fulfill-backs from monitor events!
2575 //TODO: This behavior should be documented.
2576 for htlc_update in self.monitor.get_and_clear_pending_htlcs_updated() {
2577 if let Some(preimage) = htlc_update.payment_preimage {
2578 log_trace!(self, "Claiming HTLC with preimage {} from our monitor", log_bytes!(preimage.0));
2579 self.claim_funds_internal(self.channel_state.lock().unwrap(), htlc_update.source, preimage);
2581 log_trace!(self, "Failing HTLC with hash {} from our monitor", log_bytes!(htlc_update.payment_hash.0));
2582 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() });
2587 let mut ret = Vec::new();
2588 let mut channel_state = self.channel_state.lock().unwrap();
2589 mem::swap(&mut ret, &mut channel_state.pending_msg_events);
2594 impl<ChanSigner: ChannelKeys, M: Deref, T: Deref> events::EventsProvider for ChannelManager<ChanSigner, M, T>
2595 where M::Target: ManyChannelMonitor<ChanSigner>,
2596 T::Target: BroadcasterInterface,
2598 fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
2599 // TODO: Event release to users and serialization is currently race-y: it's very easy for a
2600 // user to serialize a ChannelManager with pending events in it and lose those events on
2601 // restart. This is doubly true for the fail/fulfill-backs from monitor events!
2603 //TODO: This behavior should be documented.
2604 for htlc_update in self.monitor.get_and_clear_pending_htlcs_updated() {
2605 if let Some(preimage) = htlc_update.payment_preimage {
2606 log_trace!(self, "Claiming HTLC with preimage {} from our monitor", log_bytes!(preimage.0));
2607 self.claim_funds_internal(self.channel_state.lock().unwrap(), htlc_update.source, preimage);
2609 log_trace!(self, "Failing HTLC with hash {} from our monitor", log_bytes!(htlc_update.payment_hash.0));
2610 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() });
2615 let mut ret = Vec::new();
2616 let mut pending_events = self.pending_events.lock().unwrap();
2617 mem::swap(&mut ret, &mut *pending_events);
2622 impl<ChanSigner: ChannelKeys, M: Deref + Sync + Send, T: Deref + Sync + Send> ChainListener for ChannelManager<ChanSigner, M, T>
2623 where M::Target: ManyChannelMonitor<ChanSigner>,
2624 T::Target: BroadcasterInterface,
2626 fn block_connected(&self, header: &BlockHeader, height: u32, txn_matched: &[&Transaction], indexes_of_txn_matched: &[u32]) {
2627 let header_hash = header.bitcoin_hash();
2628 log_trace!(self, "Block {} at height {} connected with {} txn matched", header_hash, height, txn_matched.len());
2629 let _ = self.total_consistency_lock.read().unwrap();
2630 let mut failed_channels = Vec::new();
2632 let mut channel_lock = self.channel_state.lock().unwrap();
2633 let channel_state = &mut *channel_lock;
2634 let short_to_id = &mut channel_state.short_to_id;
2635 let pending_msg_events = &mut channel_state.pending_msg_events;
2636 channel_state.by_id.retain(|_, channel| {
2637 let chan_res = channel.block_connected(header, height, txn_matched, indexes_of_txn_matched);
2638 if let Ok(Some(funding_locked)) = chan_res {
2639 pending_msg_events.push(events::MessageSendEvent::SendFundingLocked {
2640 node_id: channel.get_their_node_id(),
2641 msg: funding_locked,
2643 if let Some(announcement_sigs) = self.get_announcement_sigs(channel) {
2644 log_trace!(self, "Sending funding_locked and announcement_signatures for {}", log_bytes!(channel.channel_id()));
2645 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
2646 node_id: channel.get_their_node_id(),
2647 msg: announcement_sigs,
2650 log_trace!(self, "Sending funding_locked WITHOUT announcement_signatures for {}", log_bytes!(channel.channel_id()));
2652 short_to_id.insert(channel.get_short_channel_id().unwrap(), channel.channel_id());
2653 } else if let Err(e) = chan_res {
2654 pending_msg_events.push(events::MessageSendEvent::HandleError {
2655 node_id: channel.get_their_node_id(),
2656 action: msgs::ErrorAction::SendErrorMessage { msg: e },
2660 if let Some(funding_txo) = channel.get_funding_txo() {
2661 for tx in txn_matched {
2662 for inp in tx.input.iter() {
2663 if inp.previous_output == funding_txo.into_bitcoin_outpoint() {
2664 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()));
2665 if let Some(short_id) = channel.get_short_channel_id() {
2666 short_to_id.remove(&short_id);
2668 // It looks like our counterparty went on-chain. We go ahead and
2669 // broadcast our latest local state as well here, just in case its
2670 // some kind of SPV attack, though we expect these to be dropped.
2671 failed_channels.push(channel.force_shutdown());
2672 if let Ok(update) = self.get_channel_update(&channel) {
2673 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2682 if channel.is_funding_initiated() && channel.channel_monitor().would_broadcast_at_height(height) {
2683 if let Some(short_id) = channel.get_short_channel_id() {
2684 short_to_id.remove(&short_id);
2686 failed_channels.push(channel.force_shutdown());
2687 // If would_broadcast_at_height() is true, the channel_monitor will broadcast
2688 // the latest local tx for us, so we should skip that here (it doesn't really
2689 // hurt anything, but does make tests a bit simpler).
2690 failed_channels.last_mut().unwrap().0 = Vec::new();
2691 if let Ok(update) = self.get_channel_update(&channel) {
2692 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2701 for failure in failed_channels.drain(..) {
2702 self.finish_force_close_channel(failure);
2704 self.latest_block_height.store(height as usize, Ordering::Release);
2705 *self.last_block_hash.try_lock().expect("block_(dis)connected must not be called in parallel") = header_hash;
2708 /// We force-close the channel without letting our counterparty participate in the shutdown
2709 fn block_disconnected(&self, header: &BlockHeader, _: u32) {
2710 let _ = self.total_consistency_lock.read().unwrap();
2711 let mut failed_channels = Vec::new();
2713 let mut channel_lock = self.channel_state.lock().unwrap();
2714 let channel_state = &mut *channel_lock;
2715 let short_to_id = &mut channel_state.short_to_id;
2716 let pending_msg_events = &mut channel_state.pending_msg_events;
2717 channel_state.by_id.retain(|_, v| {
2718 if v.block_disconnected(header) {
2719 if let Some(short_id) = v.get_short_channel_id() {
2720 short_to_id.remove(&short_id);
2722 failed_channels.push(v.force_shutdown());
2723 if let Ok(update) = self.get_channel_update(&v) {
2724 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2734 for failure in failed_channels.drain(..) {
2735 self.finish_force_close_channel(failure);
2737 self.latest_block_height.fetch_sub(1, Ordering::AcqRel);
2738 *self.last_block_hash.try_lock().expect("block_(dis)connected must not be called in parallel") = header.bitcoin_hash();
2742 impl<ChanSigner: ChannelKeys, M: Deref + Sync + Send, T: Deref + Sync + Send> ChannelMessageHandler for ChannelManager<ChanSigner, M, T>
2743 where M::Target: ManyChannelMonitor<ChanSigner>,
2744 T::Target: BroadcasterInterface,
2746 fn handle_open_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::OpenChannel) {
2747 let _ = self.total_consistency_lock.read().unwrap();
2748 let res = self.internal_open_channel(their_node_id, their_features, msg);
2750 let mut channel_state_lock = self.channel_state.lock().unwrap();
2751 let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2755 fn handle_accept_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::AcceptChannel) {
2756 let _ = self.total_consistency_lock.read().unwrap();
2757 let res = self.internal_accept_channel(their_node_id, their_features, msg);
2759 let mut channel_state_lock = self.channel_state.lock().unwrap();
2760 let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2764 fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &msgs::FundingCreated) {
2765 let _ = self.total_consistency_lock.read().unwrap();
2766 let res = self.internal_funding_created(their_node_id, msg);
2768 let mut channel_state_lock = self.channel_state.lock().unwrap();
2769 let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2773 fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &msgs::FundingSigned) {
2774 let _ = self.total_consistency_lock.read().unwrap();
2775 let res = self.internal_funding_signed(their_node_id, msg);
2777 let mut channel_state_lock = self.channel_state.lock().unwrap();
2778 let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2782 fn handle_funding_locked(&self, their_node_id: &PublicKey, msg: &msgs::FundingLocked) {
2783 let _ = self.total_consistency_lock.read().unwrap();
2784 let res = self.internal_funding_locked(their_node_id, msg);
2786 let mut channel_state_lock = self.channel_state.lock().unwrap();
2787 let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2791 fn handle_shutdown(&self, their_node_id: &PublicKey, msg: &msgs::Shutdown) {
2792 let _ = self.total_consistency_lock.read().unwrap();
2793 let res = self.internal_shutdown(their_node_id, msg);
2795 let mut channel_state_lock = self.channel_state.lock().unwrap();
2796 let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2800 fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
2801 let _ = self.total_consistency_lock.read().unwrap();
2802 let res = self.internal_closing_signed(their_node_id, msg);
2804 let mut channel_state_lock = self.channel_state.lock().unwrap();
2805 let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2809 fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
2810 let _ = self.total_consistency_lock.read().unwrap();
2811 let res = self.internal_update_add_htlc(their_node_id, msg);
2813 let mut channel_state_lock = self.channel_state.lock().unwrap();
2814 let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2818 fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
2819 let _ = self.total_consistency_lock.read().unwrap();
2820 let res = self.internal_update_fulfill_htlc(their_node_id, msg);
2822 let mut channel_state_lock = self.channel_state.lock().unwrap();
2823 let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2827 fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
2828 let _ = self.total_consistency_lock.read().unwrap();
2829 let res = self.internal_update_fail_htlc(their_node_id, msg);
2831 let mut channel_state_lock = self.channel_state.lock().unwrap();
2832 let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2836 fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
2837 let _ = self.total_consistency_lock.read().unwrap();
2838 let res = self.internal_update_fail_malformed_htlc(their_node_id, msg);
2840 let mut channel_state_lock = self.channel_state.lock().unwrap();
2841 let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2845 fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
2846 let _ = self.total_consistency_lock.read().unwrap();
2847 let res = self.internal_commitment_signed(their_node_id, msg);
2849 let mut channel_state_lock = self.channel_state.lock().unwrap();
2850 let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2854 fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
2855 let _ = self.total_consistency_lock.read().unwrap();
2856 let res = self.internal_revoke_and_ack(their_node_id, msg);
2858 let mut channel_state_lock = self.channel_state.lock().unwrap();
2859 let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2863 fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFee) {
2864 let _ = self.total_consistency_lock.read().unwrap();
2865 let res = self.internal_update_fee(their_node_id, msg);
2867 let mut channel_state_lock = self.channel_state.lock().unwrap();
2868 let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2872 fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
2873 let _ = self.total_consistency_lock.read().unwrap();
2874 let res = self.internal_announcement_signatures(their_node_id, msg);
2876 let mut channel_state_lock = self.channel_state.lock().unwrap();
2877 let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2881 fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
2882 let _ = self.total_consistency_lock.read().unwrap();
2883 let res = self.internal_channel_reestablish(their_node_id, msg);
2885 let mut channel_state_lock = self.channel_state.lock().unwrap();
2886 let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2890 fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool) {
2891 let _ = self.total_consistency_lock.read().unwrap();
2892 let mut failed_channels = Vec::new();
2893 let mut failed_payments = Vec::new();
2894 let mut no_channels_remain = true;
2896 let mut channel_state_lock = self.channel_state.lock().unwrap();
2897 let channel_state = &mut *channel_state_lock;
2898 let short_to_id = &mut channel_state.short_to_id;
2899 let pending_msg_events = &mut channel_state.pending_msg_events;
2900 if no_connection_possible {
2901 log_debug!(self, "Failing all channels with {} due to no_connection_possible", log_pubkey!(their_node_id));
2902 channel_state.by_id.retain(|_, chan| {
2903 if chan.get_their_node_id() == *their_node_id {
2904 if let Some(short_id) = chan.get_short_channel_id() {
2905 short_to_id.remove(&short_id);
2907 failed_channels.push(chan.force_shutdown());
2908 if let Ok(update) = self.get_channel_update(&chan) {
2909 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2919 log_debug!(self, "Marking channels with {} disconnected and generating channel_updates", log_pubkey!(their_node_id));
2920 channel_state.by_id.retain(|_, chan| {
2921 if chan.get_their_node_id() == *their_node_id {
2922 let failed_adds = chan.remove_uncommitted_htlcs_and_mark_paused();
2923 chan.to_disabled_marked();
2924 if !failed_adds.is_empty() {
2925 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
2926 failed_payments.push((chan_update, failed_adds));
2928 if chan.is_shutdown() {
2929 if let Some(short_id) = chan.get_short_channel_id() {
2930 short_to_id.remove(&short_id);
2934 no_channels_remain = false;
2940 pending_msg_events.retain(|msg| {
2942 &events::MessageSendEvent::SendAcceptChannel { ref node_id, .. } => node_id != their_node_id,
2943 &events::MessageSendEvent::SendOpenChannel { ref node_id, .. } => node_id != their_node_id,
2944 &events::MessageSendEvent::SendFundingCreated { ref node_id, .. } => node_id != their_node_id,
2945 &events::MessageSendEvent::SendFundingSigned { ref node_id, .. } => node_id != their_node_id,
2946 &events::MessageSendEvent::SendFundingLocked { ref node_id, .. } => node_id != their_node_id,
2947 &events::MessageSendEvent::SendAnnouncementSignatures { ref node_id, .. } => node_id != their_node_id,
2948 &events::MessageSendEvent::UpdateHTLCs { ref node_id, .. } => node_id != their_node_id,
2949 &events::MessageSendEvent::SendRevokeAndACK { ref node_id, .. } => node_id != their_node_id,
2950 &events::MessageSendEvent::SendClosingSigned { ref node_id, .. } => node_id != their_node_id,
2951 &events::MessageSendEvent::SendShutdown { ref node_id, .. } => node_id != their_node_id,
2952 &events::MessageSendEvent::SendChannelReestablish { ref node_id, .. } => node_id != their_node_id,
2953 &events::MessageSendEvent::BroadcastChannelAnnouncement { .. } => true,
2954 &events::MessageSendEvent::BroadcastChannelUpdate { .. } => true,
2955 &events::MessageSendEvent::HandleError { ref node_id, .. } => node_id != their_node_id,
2956 &events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => true,
2960 if no_channels_remain {
2961 self.per_peer_state.write().unwrap().remove(their_node_id);
2964 for failure in failed_channels.drain(..) {
2965 self.finish_force_close_channel(failure);
2967 for (chan_update, mut htlc_sources) in failed_payments {
2968 for (htlc_source, payment_hash) in htlc_sources.drain(..) {
2969 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source, &payment_hash, HTLCFailReason::Reason { failure_code: 0x1000 | 7, data: chan_update.clone() });
2974 fn peer_connected(&self, their_node_id: &PublicKey, init_msg: &msgs::Init) {
2975 log_debug!(self, "Generating channel_reestablish events for {}", log_pubkey!(their_node_id));
2977 let _ = self.total_consistency_lock.read().unwrap();
2980 let mut peer_state_lock = self.per_peer_state.write().unwrap();
2981 match peer_state_lock.entry(their_node_id.clone()) {
2982 hash_map::Entry::Vacant(e) => {
2983 e.insert(Mutex::new(PeerState {
2984 latest_features: init_msg.features.clone(),
2987 hash_map::Entry::Occupied(e) => {
2988 e.get().lock().unwrap().latest_features = init_msg.features.clone();
2993 let mut channel_state_lock = self.channel_state.lock().unwrap();
2994 let channel_state = &mut *channel_state_lock;
2995 let pending_msg_events = &mut channel_state.pending_msg_events;
2996 channel_state.by_id.retain(|_, chan| {
2997 if chan.get_their_node_id() == *their_node_id {
2998 if !chan.have_received_message() {
2999 // If we created this (outbound) channel while we were disconnected from the
3000 // peer we probably failed to send the open_channel message, which is now
3001 // lost. We can't have had anything pending related to this channel, so we just
3005 pending_msg_events.push(events::MessageSendEvent::SendChannelReestablish {
3006 node_id: chan.get_their_node_id(),
3007 msg: chan.get_channel_reestablish(),
3013 //TODO: Also re-broadcast announcement_signatures
3016 fn handle_error(&self, their_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
3017 let _ = self.total_consistency_lock.read().unwrap();
3019 if msg.channel_id == [0; 32] {
3020 for chan in self.list_channels() {
3021 if chan.remote_network_id == *their_node_id {
3022 self.force_close_channel(&chan.channel_id);
3026 self.force_close_channel(&msg.channel_id);
3031 const SERIALIZATION_VERSION: u8 = 1;
3032 const MIN_SERIALIZATION_VERSION: u8 = 1;
3034 impl Writeable for PendingHTLCInfo {
3035 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3036 self.onion_packet.write(writer)?;
3037 self.incoming_shared_secret.write(writer)?;
3038 self.payment_hash.write(writer)?;
3039 self.short_channel_id.write(writer)?;
3040 self.amt_to_forward.write(writer)?;
3041 self.outgoing_cltv_value.write(writer)?;
3046 impl<R: ::std::io::Read> Readable<R> for PendingHTLCInfo {
3047 fn read(reader: &mut R) -> Result<PendingHTLCInfo, DecodeError> {
3048 Ok(PendingHTLCInfo {
3049 onion_packet: Readable::read(reader)?,
3050 incoming_shared_secret: Readable::read(reader)?,
3051 payment_hash: Readable::read(reader)?,
3052 short_channel_id: Readable::read(reader)?,
3053 amt_to_forward: Readable::read(reader)?,
3054 outgoing_cltv_value: Readable::read(reader)?,
3059 impl Writeable for HTLCFailureMsg {
3060 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3062 &HTLCFailureMsg::Relay(ref fail_msg) => {
3064 fail_msg.write(writer)?;
3066 &HTLCFailureMsg::Malformed(ref fail_msg) => {
3068 fail_msg.write(writer)?;
3075 impl<R: ::std::io::Read> Readable<R> for HTLCFailureMsg {
3076 fn read(reader: &mut R) -> Result<HTLCFailureMsg, DecodeError> {
3077 match <u8 as Readable<R>>::read(reader)? {
3078 0 => Ok(HTLCFailureMsg::Relay(Readable::read(reader)?)),
3079 1 => Ok(HTLCFailureMsg::Malformed(Readable::read(reader)?)),
3080 _ => Err(DecodeError::InvalidValue),
3085 impl Writeable for PendingHTLCStatus {
3086 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3088 &PendingHTLCStatus::Forward(ref forward_info) => {
3090 forward_info.write(writer)?;
3092 &PendingHTLCStatus::Fail(ref fail_msg) => {
3094 fail_msg.write(writer)?;
3101 impl<R: ::std::io::Read> Readable<R> for PendingHTLCStatus {
3102 fn read(reader: &mut R) -> Result<PendingHTLCStatus, DecodeError> {
3103 match <u8 as Readable<R>>::read(reader)? {
3104 0 => Ok(PendingHTLCStatus::Forward(Readable::read(reader)?)),
3105 1 => Ok(PendingHTLCStatus::Fail(Readable::read(reader)?)),
3106 _ => Err(DecodeError::InvalidValue),
3111 impl_writeable!(HTLCPreviousHopData, 0, {
3114 incoming_packet_shared_secret
3117 impl Writeable for HTLCSource {
3118 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3120 &HTLCSource::PreviousHopData(ref hop_data) => {
3122 hop_data.write(writer)?;
3124 &HTLCSource::OutboundRoute { ref route, ref session_priv, ref first_hop_htlc_msat } => {
3126 route.write(writer)?;
3127 session_priv.write(writer)?;
3128 first_hop_htlc_msat.write(writer)?;
3135 impl<R: ::std::io::Read> Readable<R> for HTLCSource {
3136 fn read(reader: &mut R) -> Result<HTLCSource, DecodeError> {
3137 match <u8 as Readable<R>>::read(reader)? {
3138 0 => Ok(HTLCSource::PreviousHopData(Readable::read(reader)?)),
3139 1 => Ok(HTLCSource::OutboundRoute {
3140 route: Readable::read(reader)?,
3141 session_priv: Readable::read(reader)?,
3142 first_hop_htlc_msat: Readable::read(reader)?,
3144 _ => Err(DecodeError::InvalidValue),
3149 impl Writeable for HTLCFailReason {
3150 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3152 &HTLCFailReason::LightningError { ref err } => {
3156 &HTLCFailReason::Reason { ref failure_code, ref data } => {
3158 failure_code.write(writer)?;
3159 data.write(writer)?;
3166 impl<R: ::std::io::Read> Readable<R> for HTLCFailReason {
3167 fn read(reader: &mut R) -> Result<HTLCFailReason, DecodeError> {
3168 match <u8 as Readable<R>>::read(reader)? {
3169 0 => Ok(HTLCFailReason::LightningError { err: Readable::read(reader)? }),
3170 1 => Ok(HTLCFailReason::Reason {
3171 failure_code: Readable::read(reader)?,
3172 data: Readable::read(reader)?,
3174 _ => Err(DecodeError::InvalidValue),
3179 impl Writeable for HTLCForwardInfo {
3180 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3182 &HTLCForwardInfo::AddHTLC { ref prev_short_channel_id, ref prev_htlc_id, ref forward_info } => {
3184 prev_short_channel_id.write(writer)?;
3185 prev_htlc_id.write(writer)?;
3186 forward_info.write(writer)?;
3188 &HTLCForwardInfo::FailHTLC { ref htlc_id, ref err_packet } => {
3190 htlc_id.write(writer)?;
3191 err_packet.write(writer)?;
3198 impl<R: ::std::io::Read> Readable<R> for HTLCForwardInfo {
3199 fn read(reader: &mut R) -> Result<HTLCForwardInfo, DecodeError> {
3200 match <u8 as Readable<R>>::read(reader)? {
3201 0 => Ok(HTLCForwardInfo::AddHTLC {
3202 prev_short_channel_id: Readable::read(reader)?,
3203 prev_htlc_id: Readable::read(reader)?,
3204 forward_info: Readable::read(reader)?,
3206 1 => Ok(HTLCForwardInfo::FailHTLC {
3207 htlc_id: Readable::read(reader)?,
3208 err_packet: Readable::read(reader)?,
3210 _ => Err(DecodeError::InvalidValue),
3215 impl<ChanSigner: ChannelKeys + Writeable, M: Deref, T: Deref> Writeable for ChannelManager<ChanSigner, M, T>
3216 where M::Target: ManyChannelMonitor<ChanSigner>,
3217 T::Target: BroadcasterInterface,
3219 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3220 let _ = self.total_consistency_lock.write().unwrap();
3222 writer.write_all(&[SERIALIZATION_VERSION; 1])?;
3223 writer.write_all(&[MIN_SERIALIZATION_VERSION; 1])?;
3225 self.genesis_hash.write(writer)?;
3226 (self.latest_block_height.load(Ordering::Acquire) as u32).write(writer)?;
3227 self.last_block_hash.lock().unwrap().write(writer)?;
3229 let channel_state = self.channel_state.lock().unwrap();
3230 let mut unfunded_channels = 0;
3231 for (_, channel) in channel_state.by_id.iter() {
3232 if !channel.is_funding_initiated() {
3233 unfunded_channels += 1;
3236 ((channel_state.by_id.len() - unfunded_channels) as u64).write(writer)?;
3237 for (_, channel) in channel_state.by_id.iter() {
3238 if channel.is_funding_initiated() {
3239 channel.write(writer)?;
3243 (channel_state.forward_htlcs.len() as u64).write(writer)?;
3244 for (short_channel_id, pending_forwards) in channel_state.forward_htlcs.iter() {
3245 short_channel_id.write(writer)?;
3246 (pending_forwards.len() as u64).write(writer)?;
3247 for forward in pending_forwards {
3248 forward.write(writer)?;
3252 (channel_state.claimable_htlcs.len() as u64).write(writer)?;
3253 for (payment_hash, previous_hops) in channel_state.claimable_htlcs.iter() {
3254 payment_hash.write(writer)?;
3255 (previous_hops.len() as u64).write(writer)?;
3256 for &(recvd_amt, ref previous_hop) in previous_hops.iter() {
3257 recvd_amt.write(writer)?;
3258 previous_hop.write(writer)?;
3262 let per_peer_state = self.per_peer_state.write().unwrap();
3263 (per_peer_state.len() as u64).write(writer)?;
3264 for (peer_pubkey, peer_state_mutex) in per_peer_state.iter() {
3265 peer_pubkey.write(writer)?;
3266 let peer_state = peer_state_mutex.lock().unwrap();
3267 peer_state.latest_features.write(writer)?;
3274 /// Arguments for the creation of a ChannelManager that are not deserialized.
3276 /// At a high-level, the process for deserializing a ChannelManager and resuming normal operation
3278 /// 1) Deserialize all stored ChannelMonitors.
3279 /// 2) Deserialize the ChannelManager by filling in this struct and calling <(Sha256dHash,
3280 /// ChannelManager)>::read(reader, args).
3281 /// This may result in closing some Channels if the ChannelMonitor is newer than the stored
3282 /// ChannelManager state to ensure no loss of funds. Thus, transactions may be broadcasted.
3283 /// 3) Register all relevant ChannelMonitor outpoints with your chain watch mechanism using
3284 /// ChannelMonitor::get_monitored_outpoints and ChannelMonitor::get_funding_txo().
3285 /// 4) Reconnect blocks on your ChannelMonitors.
3286 /// 5) Move the ChannelMonitors into your local ManyChannelMonitor.
3287 /// 6) Disconnect/connect blocks on the ChannelManager.
3288 /// 7) Register the new ChannelManager with your ChainWatchInterface.
3289 pub struct ChannelManagerReadArgs<'a, ChanSigner: 'a + ChannelKeys, M: Deref, T: Deref>
3290 where M::Target: ManyChannelMonitor<ChanSigner>,
3291 T::Target: BroadcasterInterface,
3294 /// The keys provider which will give us relevant keys. Some keys will be loaded during
3295 /// deserialization.
3296 pub keys_manager: Arc<KeysInterface<ChanKeySigner = ChanSigner>>,
3298 /// The fee_estimator for use in the ChannelManager in the future.
3300 /// No calls to the FeeEstimator will be made during deserialization.
3301 pub fee_estimator: Arc<FeeEstimator>,
3302 /// The ManyChannelMonitor for use in the ChannelManager in the future.
3304 /// No calls to the ManyChannelMonitor will be made during deserialization. It is assumed that
3305 /// you have deserialized ChannelMonitors separately and will add them to your
3306 /// ManyChannelMonitor after deserializing this ChannelManager.
3309 /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
3310 /// used to broadcast the latest local commitment transactions of channels which must be
3311 /// force-closed during deserialization.
3312 pub tx_broadcaster: T,
3313 /// The Logger for use in the ChannelManager and which may be used to log information during
3314 /// deserialization.
3315 pub logger: Arc<Logger>,
3316 /// Default settings used for new channels. Any existing channels will continue to use the
3317 /// runtime settings which were stored when the ChannelManager was serialized.
3318 pub default_config: UserConfig,
3320 /// A map from channel funding outpoints to ChannelMonitors for those channels (ie
3321 /// value.get_funding_txo() should be the key).
3323 /// If a monitor is inconsistent with the channel state during deserialization the channel will
3324 /// be force-closed using the data in the ChannelMonitor and the channel will be dropped. This
3325 /// is true for missing channels as well. If there is a monitor missing for which we find
3326 /// channel data Err(DecodeError::InvalidValue) will be returned.
3328 /// In such cases the latest local transactions will be sent to the tx_broadcaster included in
3330 pub channel_monitors: &'a mut HashMap<OutPoint, &'a mut ChannelMonitor<ChanSigner>>,
3333 impl<'a, R : ::std::io::Read, ChanSigner: ChannelKeys + Readable<R>, M: Deref, T: Deref> ReadableArgs<R, ChannelManagerReadArgs<'a, ChanSigner, M, T>> for (Sha256dHash, ChannelManager<ChanSigner, M, T>)
3334 where M::Target: ManyChannelMonitor<ChanSigner>,
3335 T::Target: BroadcasterInterface,
3337 fn read(reader: &mut R, args: ChannelManagerReadArgs<'a, ChanSigner, M, T>) -> Result<Self, DecodeError> {
3338 let _ver: u8 = Readable::read(reader)?;
3339 let min_ver: u8 = Readable::read(reader)?;
3340 if min_ver > SERIALIZATION_VERSION {
3341 return Err(DecodeError::UnknownVersion);
3344 let genesis_hash: Sha256dHash = Readable::read(reader)?;
3345 let latest_block_height: u32 = Readable::read(reader)?;
3346 let last_block_hash: Sha256dHash = Readable::read(reader)?;
3348 let mut closed_channels = Vec::new();
3350 let channel_count: u64 = Readable::read(reader)?;
3351 let mut funding_txo_set = HashSet::with_capacity(cmp::min(channel_count as usize, 128));
3352 let mut by_id = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
3353 let mut short_to_id = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
3354 for _ in 0..channel_count {
3355 let mut channel: Channel<ChanSigner> = ReadableArgs::read(reader, args.logger.clone())?;
3356 if channel.last_block_connected != Default::default() && channel.last_block_connected != last_block_hash {
3357 return Err(DecodeError::InvalidValue);
3360 let funding_txo = channel.get_funding_txo().ok_or(DecodeError::InvalidValue)?;
3361 funding_txo_set.insert(funding_txo.clone());
3362 if let Some(ref mut monitor) = args.channel_monitors.get_mut(&funding_txo) {
3363 if channel.get_cur_local_commitment_transaction_number() != monitor.get_cur_local_commitment_number() ||
3364 channel.get_revoked_remote_commitment_transaction_number() != monitor.get_min_seen_secret() ||
3365 channel.get_cur_remote_commitment_transaction_number() != monitor.get_cur_remote_commitment_number() ||
3366 channel.get_latest_monitor_update_id() != monitor.get_latest_update_id() {
3367 let mut force_close_res = channel.force_shutdown();
3368 force_close_res.0 = monitor.get_latest_local_commitment_txn();
3369 closed_channels.push(force_close_res);
3371 if let Some(short_channel_id) = channel.get_short_channel_id() {
3372 short_to_id.insert(short_channel_id, channel.channel_id());
3374 by_id.insert(channel.channel_id(), channel);
3377 return Err(DecodeError::InvalidValue);
3381 for (ref funding_txo, ref mut monitor) in args.channel_monitors.iter_mut() {
3382 if !funding_txo_set.contains(funding_txo) {
3383 closed_channels.push((monitor.get_latest_local_commitment_txn(), Vec::new()));
3387 let forward_htlcs_count: u64 = Readable::read(reader)?;
3388 let mut forward_htlcs = HashMap::with_capacity(cmp::min(forward_htlcs_count as usize, 128));
3389 for _ in 0..forward_htlcs_count {
3390 let short_channel_id = Readable::read(reader)?;
3391 let pending_forwards_count: u64 = Readable::read(reader)?;
3392 let mut pending_forwards = Vec::with_capacity(cmp::min(pending_forwards_count as usize, 128));
3393 for _ in 0..pending_forwards_count {
3394 pending_forwards.push(Readable::read(reader)?);
3396 forward_htlcs.insert(short_channel_id, pending_forwards);
3399 let claimable_htlcs_count: u64 = Readable::read(reader)?;
3400 let mut claimable_htlcs = HashMap::with_capacity(cmp::min(claimable_htlcs_count as usize, 128));
3401 for _ in 0..claimable_htlcs_count {
3402 let payment_hash = Readable::read(reader)?;
3403 let previous_hops_len: u64 = Readable::read(reader)?;
3404 let mut previous_hops = Vec::with_capacity(cmp::min(previous_hops_len as usize, 2));
3405 for _ in 0..previous_hops_len {
3406 previous_hops.push((Readable::read(reader)?, Readable::read(reader)?));
3408 claimable_htlcs.insert(payment_hash, previous_hops);
3411 let peer_count: u64 = Readable::read(reader)?;
3412 let mut per_peer_state = HashMap::with_capacity(cmp::min(peer_count as usize, 128));
3413 for _ in 0..peer_count {
3414 let peer_pubkey = Readable::read(reader)?;
3415 let peer_state = PeerState {
3416 latest_features: Readable::read(reader)?,
3418 per_peer_state.insert(peer_pubkey, Mutex::new(peer_state));
3421 let channel_manager = ChannelManager {
3423 fee_estimator: args.fee_estimator,
3424 monitor: args.monitor,
3425 tx_broadcaster: args.tx_broadcaster,
3427 latest_block_height: AtomicUsize::new(latest_block_height as usize),
3428 last_block_hash: Mutex::new(last_block_hash),
3429 secp_ctx: Secp256k1::new(),
3431 channel_state: Mutex::new(ChannelHolder {
3436 pending_msg_events: Vec::new(),
3438 our_network_key: args.keys_manager.get_node_secret(),
3440 per_peer_state: RwLock::new(per_peer_state),
3442 pending_events: Mutex::new(Vec::new()),
3443 total_consistency_lock: RwLock::new(()),
3444 keys_manager: args.keys_manager,
3445 logger: args.logger,
3446 default_configuration: args.default_config,
3449 for close_res in closed_channels.drain(..) {
3450 channel_manager.finish_force_close_channel(close_res);
3451 //TODO: Broadcast channel update for closed channels, but only after we've made a
3452 //connection or two.
3455 Ok((last_block_hash.clone(), channel_manager))