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, KeysManager, InMemoryChannelKeys};
38 use util::config::UserConfig;
39 use util::{byte_utils, events};
40 use util::ser::{Readable, ReadableArgs, Writeable, Writer};
41 use util::chacha20::{ChaCha20, ChaChaReader};
42 use util::logger::Logger;
43 use util::errors::APIError;
46 use std::collections::{HashMap, hash_map, HashSet};
47 use std::io::{Cursor, Read};
48 use std::sync::{Arc, Mutex, MutexGuard, RwLock};
49 use std::sync::atomic::{AtomicUsize, Ordering};
50 use std::time::Duration;
51 use std::marker::{Sync, Send};
54 // We hold various information about HTLC relay in the HTLC objects in Channel itself:
56 // Upon receipt of an HTLC from a peer, we'll give it a PendingHTLCStatus indicating if it should
57 // forward the HTLC with information it will give back to us when it does so, or if it should Fail
58 // the HTLC with the relevant message for the Channel to handle giving to the remote peer.
60 // Once said HTLC is committed in the Channel, if the PendingHTLCStatus indicated Forward, the
61 // Channel will return the PendingHTLCInfo back to us, and we will create an HTLCForwardInfo
62 // with it to track where it came from (in case of onwards-forward error), waiting a random delay
63 // before we forward it.
65 // We will then use HTLCForwardInfo's PendingHTLCInfo to construct an outbound HTLC, with a
66 // relevant HTLCSource::PreviousHopData filled in to indicate where it came from (which we can use
67 // to either fail-backwards or fulfill the HTLC backwards along the relevant path).
68 // Alternatively, we can fill an outbound HTLC with a HTLCSource::OutboundRoute indicating this is
69 // our payment, which we can use to decode errors or inform the user that the payment was sent.
71 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
72 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. Note that the ChannelManager can take any
296 /// type that implements KeysInterface for its keys manager, but this type alias chooses the
297 /// concrete type of the KeysManager.
298 pub type SimpleArcChannelManager<M, T, F> = Arc<ChannelManager<InMemoryChannelKeys, Arc<M>, Arc<T>, Arc<KeysManager>, Arc<F>>>;
300 /// SimpleRefChannelManager is a type alias for a ChannelManager reference, and is the reference
301 /// counterpart to the SimpleArcChannelManager type alias. Use this type by default when you don't
302 /// need a ChannelManager with a static lifetime. You'll need a static lifetime in cases such as
303 /// usage of lightning-net-tokio (since tokio::spawn requires parameters with static lifetimes).
304 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
305 /// helps with issues such as long function definitions. Note that the ChannelManager can take any
306 /// type that implements KeysInterface for its keys manager, but this type alias chooses the
307 /// concrete type of the KeysManager.
308 pub type SimpleRefChannelManager<'a, 'b, 'c, 'd, M, T, F> = ChannelManager<InMemoryChannelKeys, &'a M, &'b T, &'c KeysManager, &'d F>;
310 /// Manager which keeps track of a number of channels and sends messages to the appropriate
311 /// channel, also tracking HTLC preimages and forwarding onion packets appropriately.
313 /// Implements ChannelMessageHandler, handling the multi-channel parts and passing things through
314 /// to individual Channels.
316 /// Implements Writeable to write out all channel state to disk. Implies peer_disconnected() for
317 /// all peers during write/read (though does not modify this instance, only the instance being
318 /// serialized). This will result in any channels which have not yet exchanged funding_created (ie
319 /// called funding_transaction_generated for outbound channels).
321 /// Note that you can be a bit lazier about writing out ChannelManager than you can be with
322 /// ChannelMonitors. With ChannelMonitors you MUST write each monitor update out to disk before
323 /// returning from ManyChannelMonitor::add_/update_monitor, with ChannelManagers, writing updates
324 /// happens out-of-band (and will prevent any other ChannelManager operations from occurring during
325 /// the serialization process). If the deserialized version is out-of-date compared to the
326 /// ChannelMonitors passed by reference to read(), those channels will be force-closed based on the
327 /// ChannelMonitor state and no funds will be lost (mod on-chain transaction fees).
329 /// Note that the deserializer is only implemented for (Sha256dHash, ChannelManager), which
330 /// tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
331 /// the "reorg path" (ie call block_disconnected() until you get to a common block and then call
332 /// block_connected() to step towards your best block) upon deserialization before using the
335 /// Note that ChannelManager is responsible for tracking liveness of its channels and generating
336 /// ChannelUpdate messages informing peers that the channel is temporarily disabled. To avoid
337 /// spam due to quick disconnection/reconnection, updates are not sent until the channel has been
338 /// offline for a full minute. In order to track this, you must call
339 /// timer_chan_freshness_every_min roughly once per minute, though it doesn't have to be perfect.
341 /// Rather than using a plain ChannelManager, it is preferable to use either a SimpleArcChannelManager
342 /// a SimpleRefChannelManager, for conciseness. See their documentation for more details, but
343 /// essentially you should default to using a SimpleRefChannelManager, and use a
344 /// SimpleArcChannelManager when you require a ChannelManager with a static lifetime, such as when
345 /// you're using lightning-net-tokio.
346 pub struct ChannelManager<ChanSigner: ChannelKeys, M: Deref, T: Deref, K: Deref, F: Deref>
347 where M::Target: ManyChannelMonitor<ChanSigner>,
348 T::Target: BroadcasterInterface,
349 K::Target: KeysInterface<ChanKeySigner = ChanSigner>,
350 F::Target: FeeEstimator,
352 default_configuration: UserConfig,
353 genesis_hash: Sha256dHash,
359 pub(super) latest_block_height: AtomicUsize,
361 latest_block_height: AtomicUsize,
362 last_block_hash: Mutex<Sha256dHash>,
363 secp_ctx: Secp256k1<secp256k1::All>,
366 pub(super) channel_state: Mutex<ChannelHolder<ChanSigner>>,
368 channel_state: Mutex<ChannelHolder<ChanSigner>>,
369 our_network_key: SecretKey,
371 /// The bulk of our storage will eventually be here (channels and message queues and the like).
372 /// If we are connected to a peer we always at least have an entry here, even if no channels
373 /// are currently open with that peer.
374 /// Because adding or removing an entry is rare, we usually take an outer read lock and then
375 /// operate on the inner value freely. Sadly, this prevents parallel operation when opening a
377 per_peer_state: RwLock<HashMap<PublicKey, Mutex<PeerState>>>,
379 pending_events: Mutex<Vec<events::Event>>,
380 /// Used when we have to take a BIG lock to make sure everything is self-consistent.
381 /// Essentially just when we're serializing ourselves out.
382 /// Taken first everywhere where we are making changes before any other locks.
383 total_consistency_lock: RwLock<()>,
390 /// The amount of time we require our counterparty wait to claim their money (ie time between when
391 /// we, or our watchtower, must check for them having broadcast a theft transaction).
392 pub(crate) const BREAKDOWN_TIMEOUT: u16 = 6 * 24;
393 /// The amount of time we're willing to wait to claim money back to us
394 pub(crate) const MAX_LOCAL_BREAKDOWN_TIMEOUT: u16 = 6 * 24 * 7;
396 /// The minimum number of blocks between an inbound HTLC's CLTV and the corresponding outbound
397 /// HTLC's CLTV. This should always be a few blocks greater than channelmonitor::CLTV_CLAIM_BUFFER,
398 /// ie the node we forwarded the payment on to should always have enough room to reliably time out
399 /// the HTLC via a full update_fail_htlc/commitment_signed dance before we hit the
400 /// CLTV_CLAIM_BUFFER point (we static assert that it's at least 3 blocks more).
401 const CLTV_EXPIRY_DELTA: u16 = 6 * 12; //TODO?
402 pub(super) const CLTV_FAR_FAR_AWAY: u32 = 6 * 24 * 7; //TODO?
404 // Check that our CLTV_EXPIRY is at least CLTV_CLAIM_BUFFER + ANTI_REORG_DELAY + LATENCY_GRACE_PERIOD_BLOCKS,
405 // ie that if the next-hop peer fails the HTLC within
406 // LATENCY_GRACE_PERIOD_BLOCKS then we'll still have CLTV_CLAIM_BUFFER left to timeout it onchain,
407 // then waiting ANTI_REORG_DELAY to be reorg-safe on the outbound HLTC and
408 // failing the corresponding htlc backward, and us now seeing the last block of ANTI_REORG_DELAY before
409 // LATENCY_GRACE_PERIOD_BLOCKS.
412 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;
414 // Check for ability of an attacker to make us fail on-chain by delaying inbound claim. See
415 // ChannelMontior::would_broadcast_at_height for a description of why this is needed.
418 const CHECK_CLTV_EXPIRY_SANITY_2: u32 = CLTV_EXPIRY_DELTA as u32 - LATENCY_GRACE_PERIOD_BLOCKS - 2*CLTV_CLAIM_BUFFER;
420 macro_rules! secp_call {
421 ( $res: expr, $err: expr ) => {
424 Err(_) => return Err($err),
429 /// Details of a channel, as returned by ChannelManager::list_channels and ChannelManager::list_usable_channels
430 pub struct ChannelDetails {
431 /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
432 /// thereafter this is the txid of the funding transaction xor the funding transaction output).
433 /// Note that this means this value is *not* persistent - it can change once during the
434 /// lifetime of the channel.
435 pub channel_id: [u8; 32],
436 /// The position of the funding transaction in the chain. None if the funding transaction has
437 /// not yet been confirmed and the channel fully opened.
438 pub short_channel_id: Option<u64>,
439 /// The node_id of our counterparty
440 pub remote_network_id: PublicKey,
441 /// The Features the channel counterparty provided upon last connection.
442 /// Useful for routing as it is the most up-to-date copy of the counterparty's features and
443 /// many routing-relevant features are present in the init context.
444 pub counterparty_features: InitFeatures,
445 /// The value, in satoshis, of this channel as appears in the funding output
446 pub channel_value_satoshis: u64,
447 /// The user_id passed in to create_channel, or 0 if the channel was inbound.
449 /// The available outbound capacity for sending HTLCs to the remote peer. This does not include
450 /// any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
451 /// available for inclusion in new outbound HTLCs). This further does not include any pending
452 /// outgoing HTLCs which are awaiting some other resolution to be sent.
453 pub outbound_capacity_msat: u64,
454 /// The available inbound capacity for the remote peer to send HTLCs to us. This does not
455 /// include any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
456 /// available for inclusion in new inbound HTLCs).
457 /// Note that there are some corner cases not fully handled here, so the actual available
458 /// inbound capacity may be slightly higher than this.
459 pub inbound_capacity_msat: u64,
460 /// True if the channel is (a) confirmed and funding_locked messages have been exchanged, (b)
461 /// the peer is connected, and (c) no monitor update failure is pending resolution.
465 macro_rules! handle_error {
466 ($self: ident, $internal: expr, $their_node_id: expr, $locked_channel_state: expr) => {
469 Err(MsgHandleErrInternal { err, shutdown_finish }) => {
470 if let Some((shutdown_res, update_option)) = shutdown_finish {
471 $self.finish_force_close_channel(shutdown_res);
472 if let Some(update) = update_option {
473 $locked_channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
478 log_error!($self, "{}", err.err);
479 if let msgs::ErrorAction::IgnoreError = err.action {
480 } else { $locked_channel_state.pending_msg_events.push(events::MessageSendEvent::HandleError { node_id: $their_node_id, action: err.action.clone() }); }
481 // Return error in case higher-API need one
488 macro_rules! break_chan_entry {
489 ($self: ident, $res: expr, $channel_state: expr, $entry: expr) => {
492 Err(ChannelError::Ignore(msg)) => {
493 break Err(MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore(msg), $entry.key().clone()))
495 Err(ChannelError::Close(msg)) => {
496 log_trace!($self, "Closing channel {} due to Close-required error: {}", log_bytes!($entry.key()[..]), msg);
497 let (channel_id, mut chan) = $entry.remove_entry();
498 if let Some(short_id) = chan.get_short_channel_id() {
499 $channel_state.short_to_id.remove(&short_id);
501 break Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, chan.force_shutdown(), $self.get_channel_update(&chan).ok()))
503 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"); }
508 macro_rules! try_chan_entry {
509 ($self: ident, $res: expr, $channel_state: expr, $entry: expr) => {
512 Err(ChannelError::Ignore(msg)) => {
513 return Err(MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore(msg), $entry.key().clone()))
515 Err(ChannelError::Close(msg)) => {
516 log_trace!($self, "Closing channel {} due to Close-required error: {}", log_bytes!($entry.key()[..]), msg);
517 let (channel_id, mut chan) = $entry.remove_entry();
518 if let Some(short_id) = chan.get_short_channel_id() {
519 $channel_state.short_to_id.remove(&short_id);
521 return Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, chan.force_shutdown(), $self.get_channel_update(&chan).ok()))
523 Err(ChannelError::CloseDelayBroadcast { msg, update }) => {
524 log_error!($self, "Channel {} need to be shutdown but closing transactions not broadcast due to {}", log_bytes!($entry.key()[..]), msg);
525 let (channel_id, mut chan) = $entry.remove_entry();
526 if let Some(short_id) = chan.get_short_channel_id() {
527 $channel_state.short_to_id.remove(&short_id);
529 if let Err(e) = $self.monitor.update_monitor(chan.get_funding_txo().unwrap(), update) {
531 // Upstream channel is dead, but we want at least to fail backward HTLCs to save
532 // downstream channels. In case of PermanentFailure, we are not going to be able
533 // to claim back to_remote output on remote commitment transaction. Doesn't
534 // make a difference here, we are concern about HTLCs circuit, not onchain funds.
535 ChannelMonitorUpdateErr::PermanentFailure => {},
536 ChannelMonitorUpdateErr::TemporaryFailure => {},
539 let mut shutdown_res = chan.force_shutdown();
540 if shutdown_res.0.len() >= 1 {
541 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());
543 shutdown_res.0.clear();
544 return Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, shutdown_res, $self.get_channel_update(&chan).ok()))
550 macro_rules! handle_monitor_err {
551 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
552 handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment, Vec::new(), Vec::new())
554 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr, $failed_forwards: expr, $failed_fails: expr) => {
556 ChannelMonitorUpdateErr::PermanentFailure => {
557 log_error!($self, "Closing channel {} due to monitor update PermanentFailure", log_bytes!($entry.key()[..]));
558 let (channel_id, mut chan) = $entry.remove_entry();
559 if let Some(short_id) = chan.get_short_channel_id() {
560 $channel_state.short_to_id.remove(&short_id);
562 // TODO: $failed_fails is dropped here, which will cause other channels to hit the
563 // chain in a confused state! We need to move them into the ChannelMonitor which
564 // will be responsible for failing backwards once things confirm on-chain.
565 // It's ok that we drop $failed_forwards here - at this point we'd rather they
566 // broadcast HTLC-Timeout and pay the associated fees to get their funds back than
567 // us bother trying to claim it just to forward on to another peer. If we're
568 // splitting hairs we'd prefer to claim payments that were to us, but we haven't
569 // given up the preimage yet, so might as well just wait until the payment is
570 // retried, avoiding the on-chain fees.
571 let res: Result<(), _> = Err(MsgHandleErrInternal::from_finish_shutdown("ChannelMonitor storage failure", channel_id, chan.force_shutdown(), $self.get_channel_update(&chan).ok()));
574 ChannelMonitorUpdateErr::TemporaryFailure => {
575 log_info!($self, "Disabling channel {} due to monitor update TemporaryFailure. On restore will send {} and process {} forwards and {} fails",
576 log_bytes!($entry.key()[..]),
577 if $resend_commitment && $resend_raa {
579 RAACommitmentOrder::CommitmentFirst => { "commitment then RAA" },
580 RAACommitmentOrder::RevokeAndACKFirst => { "RAA then commitment" },
582 } else if $resend_commitment { "commitment" }
583 else if $resend_raa { "RAA" }
585 (&$failed_forwards as &Vec<(PendingHTLCInfo, u64)>).len(),
586 (&$failed_fails as &Vec<(HTLCSource, PaymentHash, HTLCFailReason)>).len());
587 if !$resend_commitment {
588 debug_assert!($action_type == RAACommitmentOrder::RevokeAndACKFirst || !$resend_raa);
591 debug_assert!($action_type == RAACommitmentOrder::CommitmentFirst || !$resend_commitment);
593 $entry.get_mut().monitor_update_failed($resend_raa, $resend_commitment, $failed_forwards, $failed_fails);
594 Err(MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore("Failed to update ChannelMonitor"), *$entry.key()))
600 macro_rules! return_monitor_err {
601 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
602 return handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment);
604 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr, $failed_forwards: expr, $failed_fails: expr) => {
605 return handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment, $failed_forwards, $failed_fails);
609 // Does not break in case of TemporaryFailure!
610 macro_rules! maybe_break_monitor_err {
611 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
612 match (handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment), $err) {
613 (e, ChannelMonitorUpdateErr::PermanentFailure) => {
616 (_, ChannelMonitorUpdateErr::TemporaryFailure) => { },
621 impl<ChanSigner: ChannelKeys, M: Deref, T: Deref, K: Deref, F: Deref> ChannelManager<ChanSigner, M, T, K, F>
622 where M::Target: ManyChannelMonitor<ChanSigner>,
623 T::Target: BroadcasterInterface,
624 K::Target: KeysInterface<ChanKeySigner = ChanSigner>,
625 F::Target: FeeEstimator,
627 /// Constructs a new ChannelManager to hold several channels and route between them.
629 /// This is the main "logic hub" for all channel-related actions, and implements
630 /// ChannelMessageHandler.
632 /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
634 /// panics if channel_value_satoshis is >= `MAX_FUNDING_SATOSHIS`!
636 /// Users must provide the current blockchain height from which to track onchain channel
637 /// funding outpoints and send payments with reliable timelocks.
639 /// Users need to notify the new ChannelManager when a new block is connected or
640 /// disconnected using its `block_connected` and `block_disconnected` methods.
641 /// However, rather than calling these methods directly, the user should register
642 /// the ChannelManager as a listener to the BlockNotifier and call the BlockNotifier's
643 /// `block_(dis)connected` methods, which will notify all registered listeners in one
645 pub fn new(network: Network, fee_est: F, monitor: M, tx_broadcaster: T, logger: Arc<Logger>, keys_manager: K, config: UserConfig, current_blockchain_height: usize) -> Result<ChannelManager<ChanSigner, M, T, K, F>, secp256k1::Error> {
646 let secp_ctx = Secp256k1::new();
648 let res = ChannelManager {
649 default_configuration: config.clone(),
650 genesis_hash: genesis_block(network).header.bitcoin_hash(),
651 fee_estimator: fee_est,
655 latest_block_height: AtomicUsize::new(current_blockchain_height),
656 last_block_hash: Mutex::new(Default::default()),
659 channel_state: Mutex::new(ChannelHolder{
660 by_id: HashMap::new(),
661 short_to_id: HashMap::new(),
662 forward_htlcs: HashMap::new(),
663 claimable_htlcs: HashMap::new(),
664 pending_msg_events: Vec::new(),
666 our_network_key: keys_manager.get_node_secret(),
668 per_peer_state: RwLock::new(HashMap::new()),
670 pending_events: Mutex::new(Vec::new()),
671 total_consistency_lock: RwLock::new(()),
681 /// Creates a new outbound channel to the given remote node and with the given value.
683 /// user_id will be provided back as user_channel_id in FundingGenerationReady and
684 /// FundingBroadcastSafe events to allow tracking of which events correspond with which
685 /// create_channel call. Note that user_channel_id defaults to 0 for inbound channels, so you
686 /// may wish to avoid using 0 for user_id here.
688 /// If successful, will generate a SendOpenChannel message event, so you should probably poll
689 /// PeerManager::process_events afterwards.
691 /// Raises APIError::APIMisuseError when channel_value_satoshis > 2**24 or push_msat is
692 /// greater than channel_value_satoshis * 1k or channel_value_satoshis is < 1000.
693 pub fn create_channel(&self, their_network_key: PublicKey, channel_value_satoshis: u64, push_msat: u64, user_id: u64) -> Result<(), APIError> {
694 if channel_value_satoshis < 1000 {
695 return Err(APIError::APIMisuseError { err: "channel_value must be at least 1000 satoshis" });
698 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)?;
699 let res = channel.get_open_channel(self.genesis_hash.clone(), &self.fee_estimator);
701 let _ = self.total_consistency_lock.read().unwrap();
702 let mut channel_state = self.channel_state.lock().unwrap();
703 match channel_state.by_id.entry(channel.channel_id()) {
704 hash_map::Entry::Occupied(_) => {
705 if cfg!(feature = "fuzztarget") {
706 return Err(APIError::APIMisuseError { err: "Fuzzy bad RNG" });
708 panic!("RNG is bad???");
711 hash_map::Entry::Vacant(entry) => { entry.insert(channel); }
713 channel_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
714 node_id: their_network_key,
720 fn list_channels_with_filter<Fn: FnMut(&(&[u8; 32], &Channel<ChanSigner>)) -> bool>(&self, f: Fn) -> Vec<ChannelDetails> {
721 let mut res = Vec::new();
723 let channel_state = self.channel_state.lock().unwrap();
724 res.reserve(channel_state.by_id.len());
725 for (channel_id, channel) in channel_state.by_id.iter().filter(f) {
726 let (inbound_capacity_msat, outbound_capacity_msat) = channel.get_inbound_outbound_available_balance_msat();
727 res.push(ChannelDetails {
728 channel_id: (*channel_id).clone(),
729 short_channel_id: channel.get_short_channel_id(),
730 remote_network_id: channel.get_their_node_id(),
731 counterparty_features: InitFeatures::empty(),
732 channel_value_satoshis: channel.get_value_satoshis(),
733 inbound_capacity_msat,
734 outbound_capacity_msat,
735 user_id: channel.get_user_id(),
736 is_live: channel.is_live(),
740 let per_peer_state = self.per_peer_state.read().unwrap();
741 for chan in res.iter_mut() {
742 if let Some(peer_state) = per_peer_state.get(&chan.remote_network_id) {
743 chan.counterparty_features = peer_state.lock().unwrap().latest_features.clone();
749 /// Gets the list of open channels, in random order. See ChannelDetail field documentation for
750 /// more information.
751 pub fn list_channels(&self) -> Vec<ChannelDetails> {
752 self.list_channels_with_filter(|_| true)
755 /// Gets the list of usable channels, in random order. Useful as an argument to
756 /// Router::get_route to ensure non-announced channels are used.
758 /// These are guaranteed to have their is_live value set to true, see the documentation for
759 /// ChannelDetails::is_live for more info on exactly what the criteria are.
760 pub fn list_usable_channels(&self) -> Vec<ChannelDetails> {
761 // Note we use is_live here instead of usable which leads to somewhat confused
762 // internal/external nomenclature, but that's ok cause that's probably what the user
763 // really wanted anyway.
764 self.list_channels_with_filter(|&(_, ref channel)| channel.is_live())
767 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
768 /// will be accepted on the given channel, and after additional timeout/the closing of all
769 /// pending HTLCs, the channel will be closed on chain.
771 /// May generate a SendShutdown message event on success, which should be relayed.
772 pub fn close_channel(&self, channel_id: &[u8; 32]) -> Result<(), APIError> {
773 let _ = self.total_consistency_lock.read().unwrap();
775 let (mut failed_htlcs, chan_option) = {
776 let mut channel_state_lock = self.channel_state.lock().unwrap();
777 let channel_state = &mut *channel_state_lock;
778 match channel_state.by_id.entry(channel_id.clone()) {
779 hash_map::Entry::Occupied(mut chan_entry) => {
780 let (shutdown_msg, failed_htlcs) = chan_entry.get_mut().get_shutdown()?;
781 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
782 node_id: chan_entry.get().get_their_node_id(),
785 if chan_entry.get().is_shutdown() {
786 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
787 channel_state.short_to_id.remove(&short_id);
789 (failed_htlcs, Some(chan_entry.remove_entry().1))
790 } else { (failed_htlcs, None) }
792 hash_map::Entry::Vacant(_) => return Err(APIError::ChannelUnavailable{err: "No such channel"})
795 for htlc_source in failed_htlcs.drain(..) {
796 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() });
798 let chan_update = if let Some(chan) = chan_option {
799 if let Ok(update) = self.get_channel_update(&chan) {
804 if let Some(update) = chan_update {
805 let mut channel_state = self.channel_state.lock().unwrap();
806 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
815 fn finish_force_close_channel(&self, shutdown_res: ShutdownResult) {
816 let (local_txn, mut failed_htlcs) = shutdown_res;
817 log_trace!(self, "Finishing force-closure of channel with {} transactions to broadcast and {} HTLCs to fail", local_txn.len(), failed_htlcs.len());
818 for htlc_source in failed_htlcs.drain(..) {
819 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() });
821 for tx in local_txn {
822 log_trace!(self, "Broadcast onchain {}", log_tx!(tx));
823 self.tx_broadcaster.broadcast_transaction(&tx);
827 /// Force closes a channel, immediately broadcasting the latest local commitment transaction to
828 /// the chain and rejecting new HTLCs on the given channel.
829 pub fn force_close_channel(&self, channel_id: &[u8; 32]) {
830 let _ = self.total_consistency_lock.read().unwrap();
833 let mut channel_state_lock = self.channel_state.lock().unwrap();
834 let channel_state = &mut *channel_state_lock;
835 if let Some(chan) = channel_state.by_id.remove(channel_id) {
836 if let Some(short_id) = chan.get_short_channel_id() {
837 channel_state.short_to_id.remove(&short_id);
844 log_trace!(self, "Force-closing channel {}", log_bytes!(channel_id[..]));
845 self.finish_force_close_channel(chan.force_shutdown());
846 if let Ok(update) = self.get_channel_update(&chan) {
847 let mut channel_state = self.channel_state.lock().unwrap();
848 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
854 /// Force close all channels, immediately broadcasting the latest local commitment transaction
855 /// for each to the chain and rejecting new HTLCs on each.
856 pub fn force_close_all_channels(&self) {
857 for chan in self.list_channels() {
858 self.force_close_channel(&chan.channel_id);
862 fn decode_update_add_htlc_onion(&self, msg: &msgs::UpdateAddHTLC) -> (PendingHTLCStatus, MutexGuard<ChannelHolder<ChanSigner>>) {
863 macro_rules! return_malformed_err {
864 ($msg: expr, $err_code: expr) => {
866 log_info!(self, "Failed to accept/forward incoming HTLC: {}", $msg);
867 return (PendingHTLCStatus::Fail(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
868 channel_id: msg.channel_id,
869 htlc_id: msg.htlc_id,
870 sha256_of_onion: Sha256::hash(&msg.onion_routing_packet.hop_data).into_inner(),
871 failure_code: $err_code,
872 })), self.channel_state.lock().unwrap());
877 if let Err(_) = msg.onion_routing_packet.public_key {
878 return_malformed_err!("invalid ephemeral pubkey", 0x8000 | 0x4000 | 6);
881 let shared_secret = {
882 let mut arr = [0; 32];
883 arr.copy_from_slice(&SharedSecret::new(&msg.onion_routing_packet.public_key.unwrap(), &self.our_network_key)[..]);
886 let (rho, mu) = onion_utils::gen_rho_mu_from_shared_secret(&shared_secret);
888 if msg.onion_routing_packet.version != 0 {
889 //TODO: Spec doesn't indicate if we should only hash hop_data here (and in other
890 //sha256_of_onion error data packets), or the entire onion_routing_packet. Either way,
891 //the hash doesn't really serve any purpose - in the case of hashing all data, the
892 //receiving node would have to brute force to figure out which version was put in the
893 //packet by the node that send us the message, in the case of hashing the hop_data, the
894 //node knows the HMAC matched, so they already know what is there...
895 return_malformed_err!("Unknown onion packet version", 0x8000 | 0x4000 | 4);
898 let mut hmac = HmacEngine::<Sha256>::new(&mu);
899 hmac.input(&msg.onion_routing_packet.hop_data);
900 hmac.input(&msg.payment_hash.0[..]);
901 if !fixed_time_eq(&Hmac::from_engine(hmac).into_inner(), &msg.onion_routing_packet.hmac) {
902 return_malformed_err!("HMAC Check failed", 0x8000 | 0x4000 | 5);
905 let mut channel_state = None;
906 macro_rules! return_err {
907 ($msg: expr, $err_code: expr, $data: expr) => {
909 log_info!(self, "Failed to accept/forward incoming HTLC: {}", $msg);
910 if channel_state.is_none() {
911 channel_state = Some(self.channel_state.lock().unwrap());
913 return (PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
914 channel_id: msg.channel_id,
915 htlc_id: msg.htlc_id,
916 reason: onion_utils::build_first_hop_failure_packet(&shared_secret, $err_code, $data),
917 })), channel_state.unwrap());
922 let mut chacha = ChaCha20::new(&rho, &[0u8; 8]);
923 let mut chacha_stream = ChaChaReader { chacha: &mut chacha, read: Cursor::new(&msg.onion_routing_packet.hop_data[..]) };
924 let (next_hop_data, next_hop_hmac) = {
925 match msgs::OnionHopData::read(&mut chacha_stream) {
927 let error_code = match err {
928 msgs::DecodeError::UnknownVersion => 0x4000 | 1, // unknown realm byte
929 msgs::DecodeError::UnknownRequiredFeature|
930 msgs::DecodeError::InvalidValue|
931 msgs::DecodeError::ShortRead => 0x4000 | 22, // invalid_onion_payload
932 _ => 0x2000 | 2, // Should never happen
934 return_err!("Unable to decode our hop data", error_code, &[0;0]);
937 let mut hmac = [0; 32];
938 if let Err(_) = chacha_stream.read_exact(&mut hmac[..]) {
939 return_err!("Unable to decode hop data", 0x4000 | 22, &[0;0]);
946 let pending_forward_info = if next_hop_hmac == [0; 32] {
949 // In tests, make sure that the initial onion pcket data is, at least, non-0.
950 // We could do some fancy randomness test here, but, ehh, whatever.
951 // This checks for the issue where you can calculate the path length given the
952 // onion data as all the path entries that the originator sent will be here
953 // as-is (and were originally 0s).
954 // Of course reverse path calculation is still pretty easy given naive routing
955 // algorithms, but this fixes the most-obvious case.
956 let mut next_bytes = [0; 32];
957 chacha_stream.read_exact(&mut next_bytes).unwrap();
958 assert_ne!(next_bytes[..], [0; 32][..]);
959 chacha_stream.read_exact(&mut next_bytes).unwrap();
960 assert_ne!(next_bytes[..], [0; 32][..]);
964 // final_expiry_too_soon
965 if (msg.cltv_expiry as u64) < self.latest_block_height.load(Ordering::Acquire) as u64 + (CLTV_CLAIM_BUFFER + LATENCY_GRACE_PERIOD_BLOCKS) as u64 {
966 return_err!("The final CLTV expiry is too soon to handle", 17, &[0;0]);
968 // final_incorrect_htlc_amount
969 if next_hop_data.amt_to_forward > msg.amount_msat {
970 return_err!("Upstream node sent less than we were supposed to receive in payment", 19, &byte_utils::be64_to_array(msg.amount_msat));
972 // final_incorrect_cltv_expiry
973 if next_hop_data.outgoing_cltv_value != msg.cltv_expiry {
974 return_err!("Upstream node set CLTV to the wrong value", 18, &byte_utils::be32_to_array(msg.cltv_expiry));
977 // Note that we could obviously respond immediately with an update_fulfill_htlc
978 // message, however that would leak that we are the recipient of this payment, so
979 // instead we stay symmetric with the forwarding case, only responding (after a
980 // delay) once they've send us a commitment_signed!
982 PendingHTLCStatus::Forward(PendingHTLCInfo {
984 payment_hash: msg.payment_hash.clone(),
986 incoming_shared_secret: shared_secret,
987 amt_to_forward: next_hop_data.amt_to_forward,
988 outgoing_cltv_value: next_hop_data.outgoing_cltv_value,
991 let mut new_packet_data = [0; 20*65];
992 let read_pos = chacha_stream.read(&mut new_packet_data).unwrap();
993 #[cfg(debug_assertions)]
996 // a) that the behavior of our stream here will return Ok(0) even if the TLV
997 // read above emptied out our buffer and the unwrap() wont needlessly panic
998 // b) that we didn't somehow magically end up with extra data.
1000 debug_assert!(chacha_stream.read(&mut t).unwrap() == 0);
1002 // Once we've emptied the set of bytes our peer gave us, encrypt 0 bytes until we
1003 // fill the onion hop data we'll forward to our next-hop peer.
1004 chacha_stream.chacha.process_in_place(&mut new_packet_data[read_pos..]);
1006 let mut new_pubkey = msg.onion_routing_packet.public_key.unwrap();
1008 let blinding_factor = {
1009 let mut sha = Sha256::engine();
1010 sha.input(&new_pubkey.serialize()[..]);
1011 sha.input(&shared_secret);
1012 Sha256::from_engine(sha).into_inner()
1015 let public_key = if let Err(e) = new_pubkey.mul_assign(&self.secp_ctx, &blinding_factor[..]) {
1017 } else { Ok(new_pubkey) };
1019 let outgoing_packet = msgs::OnionPacket {
1022 hop_data: new_packet_data,
1023 hmac: next_hop_hmac.clone(),
1026 let short_channel_id = match next_hop_data.format {
1027 msgs::OnionHopDataFormat::Legacy { short_channel_id } => short_channel_id,
1028 msgs::OnionHopDataFormat::NonFinalNode { short_channel_id } => short_channel_id,
1029 msgs::OnionHopDataFormat::FinalNode => {
1030 return_err!("Final Node OnionHopData provided for us as an intermediary node", 0x4000 | 22, &[0;0]);
1034 PendingHTLCStatus::Forward(PendingHTLCInfo {
1035 onion_packet: Some(outgoing_packet),
1036 payment_hash: msg.payment_hash.clone(),
1037 short_channel_id: short_channel_id,
1038 incoming_shared_secret: shared_secret,
1039 amt_to_forward: next_hop_data.amt_to_forward,
1040 outgoing_cltv_value: next_hop_data.outgoing_cltv_value,
1044 channel_state = Some(self.channel_state.lock().unwrap());
1045 if let &PendingHTLCStatus::Forward(PendingHTLCInfo { ref onion_packet, ref short_channel_id, ref amt_to_forward, ref outgoing_cltv_value, .. }) = &pending_forward_info {
1046 if onion_packet.is_some() { // If short_channel_id is 0 here, we'll reject them in the body here
1047 let id_option = channel_state.as_ref().unwrap().short_to_id.get(&short_channel_id).cloned();
1048 let forwarding_id = match id_option {
1049 None => { // unknown_next_peer
1050 return_err!("Don't have available channel for forwarding as requested.", 0x4000 | 10, &[0;0]);
1052 Some(id) => id.clone(),
1054 if let Some((err, code, chan_update)) = loop {
1055 let chan = channel_state.as_mut().unwrap().by_id.get_mut(&forwarding_id).unwrap();
1057 // Note that we could technically not return an error yet here and just hope
1058 // that the connection is reestablished or monitor updated by the time we get
1059 // around to doing the actual forward, but better to fail early if we can and
1060 // hopefully an attacker trying to path-trace payments cannot make this occur
1061 // on a small/per-node/per-channel scale.
1062 if !chan.is_live() { // channel_disabled
1063 break Some(("Forwarding channel is not in a ready state.", 0x1000 | 20, Some(self.get_channel_update(chan).unwrap())));
1065 if *amt_to_forward < chan.get_their_htlc_minimum_msat() { // amount_below_minimum
1066 break Some(("HTLC amount was below the htlc_minimum_msat", 0x1000 | 11, Some(self.get_channel_update(chan).unwrap())));
1068 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) });
1069 if fee.is_none() || msg.amount_msat < fee.unwrap() || (msg.amount_msat - fee.unwrap()) < *amt_to_forward { // fee_insufficient
1070 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())));
1072 if (msg.cltv_expiry as u64) < (*outgoing_cltv_value) as u64 + CLTV_EXPIRY_DELTA as u64 { // incorrect_cltv_expiry
1073 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())));
1075 let cur_height = self.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1076 // We want to have at least LATENCY_GRACE_PERIOD_BLOCKS to fail prior to going on chain CLAIM_BUFFER blocks before expiration
1077 if msg.cltv_expiry <= cur_height + CLTV_CLAIM_BUFFER + LATENCY_GRACE_PERIOD_BLOCKS as u32 { // expiry_too_soon
1078 break Some(("CLTV expiry is too close", 0x1000 | 14, Some(self.get_channel_update(chan).unwrap())));
1080 if msg.cltv_expiry > cur_height + CLTV_FAR_FAR_AWAY as u32 { // expiry_too_far
1081 break Some(("CLTV expiry is too far in the future", 21, None));
1086 let mut res = Vec::with_capacity(8 + 128);
1087 if let Some(chan_update) = chan_update {
1088 if code == 0x1000 | 11 || code == 0x1000 | 12 {
1089 res.extend_from_slice(&byte_utils::be64_to_array(msg.amount_msat));
1091 else if code == 0x1000 | 13 {
1092 res.extend_from_slice(&byte_utils::be32_to_array(msg.cltv_expiry));
1094 else if code == 0x1000 | 20 {
1095 res.extend_from_slice(&byte_utils::be16_to_array(chan_update.contents.flags));
1097 res.extend_from_slice(&chan_update.encode_with_len()[..]);
1099 return_err!(err, code, &res[..]);
1104 (pending_forward_info, channel_state.unwrap())
1107 /// only fails if the channel does not yet have an assigned short_id
1108 /// May be called with channel_state already locked!
1109 fn get_channel_update(&self, chan: &Channel<ChanSigner>) -> Result<msgs::ChannelUpdate, LightningError> {
1110 let short_channel_id = match chan.get_short_channel_id() {
1111 None => return Err(LightningError{err: "Channel not yet established", action: msgs::ErrorAction::IgnoreError}),
1115 let were_node_one = PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key).serialize()[..] < chan.get_their_node_id().serialize()[..];
1117 let unsigned = msgs::UnsignedChannelUpdate {
1118 chain_hash: self.genesis_hash,
1119 short_channel_id: short_channel_id,
1120 timestamp: chan.get_channel_update_count(),
1121 flags: (!were_node_one) as u16 | ((!chan.is_live() as u16) << 1),
1122 cltv_expiry_delta: CLTV_EXPIRY_DELTA,
1123 htlc_minimum_msat: chan.get_our_htlc_minimum_msat(),
1124 fee_base_msat: chan.get_our_fee_base_msat(&self.fee_estimator),
1125 fee_proportional_millionths: chan.get_fee_proportional_millionths(),
1126 excess_data: Vec::new(),
1129 let msg_hash = Sha256dHash::hash(&unsigned.encode()[..]);
1130 let sig = self.secp_ctx.sign(&hash_to_message!(&msg_hash[..]), &self.our_network_key);
1132 Ok(msgs::ChannelUpdate {
1138 /// Sends a payment along a given route.
1140 /// Value parameters are provided via the last hop in route, see documentation for RouteHop
1141 /// fields for more info.
1143 /// Note that if the payment_hash already exists elsewhere (eg you're sending a duplicative
1144 /// payment), we don't do anything to stop you! We always try to ensure that if the provided
1145 /// next hop knows the preimage to payment_hash they can claim an additional amount as
1146 /// specified in the last hop in the route! Thus, you should probably do your own
1147 /// payment_preimage tracking (which you should already be doing as they represent "proof of
1148 /// payment") and prevent double-sends yourself.
1150 /// May generate a SendHTLCs message event on success, which should be relayed.
1152 /// Raises APIError::RoutError when invalid route or forward parameter
1153 /// (cltv_delta, fee, node public key) is specified.
1154 /// Raises APIError::ChannelUnavailable if the next-hop channel is not available for updates
1155 /// (including due to previous monitor update failure or new permanent monitor update failure).
1156 /// Raised APIError::MonitorUpdateFailed if a new monitor update failure prevented sending the
1157 /// relevant updates.
1159 /// In case of APIError::RouteError/APIError::ChannelUnavailable, the payment send has failed
1160 /// and you may wish to retry via a different route immediately.
1161 /// In case of APIError::MonitorUpdateFailed, the commitment update has been irrevocably
1162 /// committed on our end and we're just waiting for a monitor update to send it. Do NOT retry
1163 /// the payment via a different route unless you intend to pay twice!
1164 pub fn send_payment(&self, route: Route, payment_hash: PaymentHash) -> Result<(), APIError> {
1165 if route.hops.len() < 1 || route.hops.len() > 20 {
1166 return Err(APIError::RouteError{err: "Route didn't go anywhere/had bogus size"});
1168 let our_node_id = self.get_our_node_id();
1169 for (idx, hop) in route.hops.iter().enumerate() {
1170 if idx != route.hops.len() - 1 && hop.pubkey == our_node_id {
1171 return Err(APIError::RouteError{err: "Route went through us but wasn't a simple rebalance loop to us"});
1175 let (session_priv, prng_seed) = self.keys_manager.get_onion_rand();
1177 let cur_height = self.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1179 let onion_keys = secp_call!(onion_utils::construct_onion_keys(&self.secp_ctx, &route, &session_priv),
1180 APIError::RouteError{err: "Pubkey along hop was maliciously selected"});
1181 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height)?;
1182 if onion_utils::route_size_insane(&onion_payloads) {
1183 return Err(APIError::RouteError{err: "Route size too large considering onion data"});
1185 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, prng_seed, &payment_hash);
1187 let _ = self.total_consistency_lock.read().unwrap();
1189 let mut channel_lock = self.channel_state.lock().unwrap();
1190 let err: Result<(), _> = loop {
1192 let id = match channel_lock.short_to_id.get(&route.hops.first().unwrap().short_channel_id) {
1193 None => return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!"}),
1194 Some(id) => id.clone(),
1197 let channel_state = &mut *channel_lock;
1198 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(id) {
1200 if chan.get().get_their_node_id() != route.hops.first().unwrap().pubkey {
1201 return Err(APIError::RouteError{err: "Node ID mismatch on first hop!"});
1203 if !chan.get().is_live() {
1204 return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected/pending monitor update!"});
1206 break_chan_entry!(self, chan.get_mut().send_htlc_and_commit(htlc_msat, payment_hash.clone(), htlc_cltv, HTLCSource::OutboundRoute {
1207 route: route.clone(),
1208 session_priv: session_priv.clone(),
1209 first_hop_htlc_msat: htlc_msat,
1210 }, onion_packet), channel_state, chan)
1212 Some((update_add, commitment_signed, monitor_update)) => {
1213 if let Err(e) = self.monitor.update_monitor(chan.get().get_funding_txo().unwrap(), monitor_update) {
1214 maybe_break_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, true);
1215 // Note that MonitorUpdateFailed here indicates (per function docs)
1216 // that we will resent the commitment update once we unfree monitor
1217 // updating, so we have to take special care that we don't return
1218 // something else in case we will resend later!
1219 return Err(APIError::MonitorUpdateFailed);
1222 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1223 node_id: route.hops.first().unwrap().pubkey,
1224 updates: msgs::CommitmentUpdate {
1225 update_add_htlcs: vec![update_add],
1226 update_fulfill_htlcs: Vec::new(),
1227 update_fail_htlcs: Vec::new(),
1228 update_fail_malformed_htlcs: Vec::new(),
1236 } else { unreachable!(); }
1240 match handle_error!(self, err, route.hops.first().unwrap().pubkey, channel_lock) {
1241 Ok(_) => unreachable!(),
1242 Err(e) => { Err(APIError::ChannelUnavailable { err: e.err }) }
1246 /// Call this upon creation of a funding transaction for the given channel.
1248 /// Note that ALL inputs in the transaction pointed to by funding_txo MUST spend SegWit outputs
1249 /// or your counterparty can steal your funds!
1251 /// Panics if a funding transaction has already been provided for this channel.
1253 /// May panic if the funding_txo is duplicative with some other channel (note that this should
1254 /// be trivially prevented by using unique funding transaction keys per-channel).
1255 pub fn funding_transaction_generated(&self, temporary_channel_id: &[u8; 32], funding_txo: OutPoint) {
1256 let _ = self.total_consistency_lock.read().unwrap();
1258 let (mut chan, msg, chan_monitor) = {
1259 let mut channel_state = self.channel_state.lock().unwrap();
1260 let (res, chan) = match channel_state.by_id.remove(temporary_channel_id) {
1262 (chan.get_outbound_funding_created(funding_txo)
1263 .map_err(|e| if let ChannelError::Close(msg) = e {
1264 MsgHandleErrInternal::from_finish_shutdown(msg, chan.channel_id(), chan.force_shutdown(), None)
1265 } else { unreachable!(); })
1270 match handle_error!(self, res, chan.get_their_node_id(), channel_state) {
1271 Ok(funding_msg) => {
1272 (chan, funding_msg.0, funding_msg.1)
1274 Err(_) => { return; }
1277 // Because we have exclusive ownership of the channel here we can release the channel_state
1278 // lock before add_monitor
1279 if let Err(e) = self.monitor.add_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1281 ChannelMonitorUpdateErr::PermanentFailure => {
1283 let mut channel_state = self.channel_state.lock().unwrap();
1284 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) {
1285 Err(_) => { return; },
1286 Ok(()) => unreachable!(),
1290 ChannelMonitorUpdateErr::TemporaryFailure => {
1291 // Its completely fine to continue with a FundingCreated until the monitor
1292 // update is persisted, as long as we don't generate the FundingBroadcastSafe
1293 // until the monitor has been safely persisted (as funding broadcast is not,
1295 chan.monitor_update_failed(false, false, Vec::new(), Vec::new());
1300 let mut channel_state = self.channel_state.lock().unwrap();
1301 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
1302 node_id: chan.get_their_node_id(),
1305 match channel_state.by_id.entry(chan.channel_id()) {
1306 hash_map::Entry::Occupied(_) => {
1307 panic!("Generated duplicate funding txid?");
1309 hash_map::Entry::Vacant(e) => {
1315 fn get_announcement_sigs(&self, chan: &Channel<ChanSigner>) -> Option<msgs::AnnouncementSignatures> {
1316 if !chan.should_announce() {
1317 log_trace!(self, "Can't send announcement_signatures for private channel {}", log_bytes!(chan.channel_id()));
1321 let (announcement, our_bitcoin_sig) = match chan.get_channel_announcement(self.get_our_node_id(), self.genesis_hash.clone()) {
1323 Err(_) => return None, // Only in case of state precondition violations eg channel is closing
1325 let msghash = hash_to_message!(&Sha256dHash::hash(&announcement.encode()[..])[..]);
1326 let our_node_sig = self.secp_ctx.sign(&msghash, &self.our_network_key);
1328 Some(msgs::AnnouncementSignatures {
1329 channel_id: chan.channel_id(),
1330 short_channel_id: chan.get_short_channel_id().unwrap(),
1331 node_signature: our_node_sig,
1332 bitcoin_signature: our_bitcoin_sig,
1336 /// Processes HTLCs which are pending waiting on random forward delay.
1338 /// Should only really ever be called in response to a PendingHTLCsForwardable event.
1339 /// Will likely generate further events.
1340 pub fn process_pending_htlc_forwards(&self) {
1341 let _ = self.total_consistency_lock.read().unwrap();
1343 let mut new_events = Vec::new();
1344 let mut failed_forwards = Vec::new();
1345 let mut handle_errors = Vec::new();
1347 let mut channel_state_lock = self.channel_state.lock().unwrap();
1348 let channel_state = &mut *channel_state_lock;
1350 for (short_chan_id, mut pending_forwards) in channel_state.forward_htlcs.drain() {
1351 if short_chan_id != 0 {
1352 let forward_chan_id = match channel_state.short_to_id.get(&short_chan_id) {
1353 Some(chan_id) => chan_id.clone(),
1355 failed_forwards.reserve(pending_forwards.len());
1356 for forward_info in pending_forwards.drain(..) {
1357 match forward_info {
1358 HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info } => {
1359 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
1360 short_channel_id: prev_short_channel_id,
1361 htlc_id: prev_htlc_id,
1362 incoming_packet_shared_secret: forward_info.incoming_shared_secret,
1364 failed_forwards.push((htlc_source, forward_info.payment_hash, 0x4000 | 10, None));
1366 HTLCForwardInfo::FailHTLC { .. } => {
1367 // Channel went away before we could fail it. This implies
1368 // the channel is now on chain and our counterparty is
1369 // trying to broadcast the HTLC-Timeout, but that's their
1370 // problem, not ours.
1377 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(forward_chan_id) {
1378 let mut add_htlc_msgs = Vec::new();
1379 let mut fail_htlc_msgs = Vec::new();
1380 for forward_info in pending_forwards.drain(..) {
1381 match forward_info {
1382 HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info } => {
1383 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);
1384 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
1385 short_channel_id: prev_short_channel_id,
1386 htlc_id: prev_htlc_id,
1387 incoming_packet_shared_secret: forward_info.incoming_shared_secret,
1389 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()) {
1391 if let ChannelError::Ignore(msg) = e {
1392 log_trace!(self, "Failed to forward HTLC with payment_hash {}: {}", log_bytes!(forward_info.payment_hash.0), msg);
1394 panic!("Stated return value requirements in send_htlc() were not met");
1396 let chan_update = self.get_channel_update(chan.get()).unwrap();
1397 failed_forwards.push((htlc_source, forward_info.payment_hash, 0x1000 | 7, Some(chan_update)));
1402 Some(msg) => { add_htlc_msgs.push(msg); },
1404 // Nothing to do here...we're waiting on a remote
1405 // revoke_and_ack before we can add anymore HTLCs. The Channel
1406 // will automatically handle building the update_add_htlc and
1407 // commitment_signed messages when we can.
1408 // TODO: Do some kind of timer to set the channel as !is_live()
1409 // as we don't really want others relying on us relaying through
1410 // this channel currently :/.
1416 HTLCForwardInfo::FailHTLC { htlc_id, err_packet } => {
1417 log_trace!(self, "Failing HTLC back to channel with short id {} after delay", short_chan_id);
1418 match chan.get_mut().get_update_fail_htlc(htlc_id, err_packet) {
1420 if let ChannelError::Ignore(msg) = e {
1421 log_trace!(self, "Failed to fail backwards to short_id {}: {}", short_chan_id, msg);
1423 panic!("Stated return value requirements in get_update_fail_htlc() were not met");
1425 // fail-backs are best-effort, we probably already have one
1426 // pending, and if not that's OK, if not, the channel is on
1427 // the chain and sending the HTLC-Timeout is their problem.
1430 Ok(Some(msg)) => { fail_htlc_msgs.push(msg); },
1432 // Nothing to do here...we're waiting on a remote
1433 // revoke_and_ack before we can update the commitment
1434 // transaction. The Channel will automatically handle
1435 // building the update_fail_htlc and commitment_signed
1436 // messages when we can.
1437 // We don't need any kind of timer here as they should fail
1438 // the channel onto the chain if they can't get our
1439 // update_fail_htlc in time, it's not our problem.
1446 if !add_htlc_msgs.is_empty() || !fail_htlc_msgs.is_empty() {
1447 let (commitment_msg, monitor_update) = match chan.get_mut().send_commitment() {
1450 // We surely failed send_commitment due to bad keys, in that case
1451 // close channel and then send error message to peer.
1452 let their_node_id = chan.get().get_their_node_id();
1453 let err: Result<(), _> = match e {
1454 ChannelError::Ignore(_) => {
1455 panic!("Stated return value requirements in send_commitment() were not met");
1457 ChannelError::Close(msg) => {
1458 log_trace!(self, "Closing channel {} due to Close-required error: {}", log_bytes!(chan.key()[..]), msg);
1459 let (channel_id, mut channel) = chan.remove_entry();
1460 if let Some(short_id) = channel.get_short_channel_id() {
1461 channel_state.short_to_id.remove(&short_id);
1463 Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, channel.force_shutdown(), self.get_channel_update(&channel).ok()))
1465 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"); }
1467 match handle_error!(self, err, their_node_id, channel_state) {
1468 Ok(_) => unreachable!(),
1469 Err(_) => { continue; },
1473 if let Err(e) = self.monitor.update_monitor(chan.get().get_funding_txo().unwrap(), monitor_update) {
1474 handle_errors.push((chan.get().get_their_node_id(), handle_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, true)));
1477 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1478 node_id: chan.get().get_their_node_id(),
1479 updates: msgs::CommitmentUpdate {
1480 update_add_htlcs: add_htlc_msgs,
1481 update_fulfill_htlcs: Vec::new(),
1482 update_fail_htlcs: fail_htlc_msgs,
1483 update_fail_malformed_htlcs: Vec::new(),
1485 commitment_signed: commitment_msg,
1493 for forward_info in pending_forwards.drain(..) {
1494 match forward_info {
1495 HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info } => {
1496 let prev_hop_data = HTLCPreviousHopData {
1497 short_channel_id: prev_short_channel_id,
1498 htlc_id: prev_htlc_id,
1499 incoming_packet_shared_secret: forward_info.incoming_shared_secret,
1501 match channel_state.claimable_htlcs.entry(forward_info.payment_hash) {
1502 hash_map::Entry::Occupied(mut entry) => entry.get_mut().push((forward_info.amt_to_forward, prev_hop_data)),
1503 hash_map::Entry::Vacant(entry) => { entry.insert(vec![(forward_info.amt_to_forward, prev_hop_data)]); },
1505 new_events.push(events::Event::PaymentReceived {
1506 payment_hash: forward_info.payment_hash,
1507 amt: forward_info.amt_to_forward,
1510 HTLCForwardInfo::FailHTLC { .. } => {
1511 panic!("Got pending fail of our own HTLC");
1519 for (htlc_source, payment_hash, failure_code, update) in failed_forwards.drain(..) {
1521 None => self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source, &payment_hash, HTLCFailReason::Reason { failure_code, data: Vec::new() }),
1522 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() }),
1526 if handle_errors.len() > 0 {
1527 let mut channel_state_lock = self.channel_state.lock().unwrap();
1528 for (their_node_id, err) in handle_errors.drain(..) {
1529 let _ = handle_error!(self, err, their_node_id, channel_state_lock);
1533 if new_events.is_empty() { return }
1534 let mut events = self.pending_events.lock().unwrap();
1535 events.append(&mut new_events);
1538 /// If a peer is disconnected we mark any channels with that peer as 'disabled'.
1539 /// After some time, if channels are still disabled we need to broadcast a ChannelUpdate
1540 /// to inform the network about the uselessness of these channels.
1542 /// This method handles all the details, and must be called roughly once per minute.
1543 pub fn timer_chan_freshness_every_min(&self) {
1544 let _ = self.total_consistency_lock.read().unwrap();
1545 let mut channel_state_lock = self.channel_state.lock().unwrap();
1546 let channel_state = &mut *channel_state_lock;
1547 for (_, chan) in channel_state.by_id.iter_mut() {
1548 if chan.is_disabled_staged() && !chan.is_live() {
1549 if let Ok(update) = self.get_channel_update(&chan) {
1550 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1555 } else if chan.is_disabled_staged() && chan.is_live() {
1557 } else if chan.is_disabled_marked() {
1558 chan.to_disabled_staged();
1563 /// Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
1564 /// after a PaymentReceived event, failing the HTLC back to its origin and freeing resources
1565 /// along the path (including in our own channel on which we received it).
1566 /// Returns false if no payment was found to fail backwards, true if the process of failing the
1567 /// HTLC backwards has been started.
1568 pub fn fail_htlc_backwards(&self, payment_hash: &PaymentHash) -> bool {
1569 let _ = self.total_consistency_lock.read().unwrap();
1571 let mut channel_state = Some(self.channel_state.lock().unwrap());
1572 let removed_source = channel_state.as_mut().unwrap().claimable_htlcs.remove(payment_hash);
1573 if let Some(mut sources) = removed_source {
1574 for (recvd_value, htlc_with_hash) in sources.drain(..) {
1575 if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
1576 self.fail_htlc_backwards_internal(channel_state.take().unwrap(),
1577 HTLCSource::PreviousHopData(htlc_with_hash), payment_hash,
1578 HTLCFailReason::Reason { failure_code: 0x4000 | 15, data: byte_utils::be64_to_array(recvd_value).to_vec() });
1584 /// Fails an HTLC backwards to the sender of it to us.
1585 /// Note that while we take a channel_state lock as input, we do *not* assume consistency here.
1586 /// There are several callsites that do stupid things like loop over a list of payment_hashes
1587 /// to fail and take the channel_state lock for each iteration (as we take ownership and may
1588 /// drop it). In other words, no assumptions are made that entries in claimable_htlcs point to
1589 /// still-available channels.
1590 fn fail_htlc_backwards_internal(&self, mut channel_state_lock: MutexGuard<ChannelHolder<ChanSigner>>, source: HTLCSource, payment_hash: &PaymentHash, onion_error: HTLCFailReason) {
1591 //TODO: There is a timing attack here where if a node fails an HTLC back to us they can
1592 //identify whether we sent it or not based on the (I presume) very different runtime
1593 //between the branches here. We should make this async and move it into the forward HTLCs
1596 HTLCSource::OutboundRoute { ref route, .. } => {
1597 log_trace!(self, "Failing outbound payment HTLC with payment_hash {}", log_bytes!(payment_hash.0));
1598 mem::drop(channel_state_lock);
1599 match &onion_error {
1600 &HTLCFailReason::LightningError { ref err } => {
1602 let (channel_update, payment_retryable, onion_error_code) = onion_utils::process_onion_failure(&self.secp_ctx, &self.logger, &source, err.data.clone());
1604 let (channel_update, payment_retryable, _) = onion_utils::process_onion_failure(&self.secp_ctx, &self.logger, &source, err.data.clone());
1605 // TODO: If we decided to blame ourselves (or one of our channels) in
1606 // process_onion_failure we should close that channel as it implies our
1607 // next-hop is needlessly blaming us!
1608 if let Some(update) = channel_update {
1609 self.channel_state.lock().unwrap().pending_msg_events.push(
1610 events::MessageSendEvent::PaymentFailureNetworkUpdate {
1615 self.pending_events.lock().unwrap().push(
1616 events::Event::PaymentFailed {
1617 payment_hash: payment_hash.clone(),
1618 rejected_by_dest: !payment_retryable,
1620 error_code: onion_error_code
1624 &HTLCFailReason::Reason {
1628 // we get a fail_malformed_htlc from the first hop
1629 // TODO: We'd like to generate a PaymentFailureNetworkUpdate for temporary
1630 // failures here, but that would be insufficient as Router::get_route
1631 // generally ignores its view of our own channels as we provide them via
1633 // TODO: For non-temporary failures, we really should be closing the
1634 // channel here as we apparently can't relay through them anyway.
1635 self.pending_events.lock().unwrap().push(
1636 events::Event::PaymentFailed {
1637 payment_hash: payment_hash.clone(),
1638 rejected_by_dest: route.hops.len() == 1,
1640 error_code: Some(*failure_code),
1646 HTLCSource::PreviousHopData(HTLCPreviousHopData { short_channel_id, htlc_id, incoming_packet_shared_secret }) => {
1647 let err_packet = match onion_error {
1648 HTLCFailReason::Reason { failure_code, data } => {
1649 log_trace!(self, "Failing HTLC with payment_hash {} backwards from us with code {}", log_bytes!(payment_hash.0), failure_code);
1650 let packet = onion_utils::build_failure_packet(&incoming_packet_shared_secret, failure_code, &data[..]).encode();
1651 onion_utils::encrypt_failure_packet(&incoming_packet_shared_secret, &packet)
1653 HTLCFailReason::LightningError { err } => {
1654 log_trace!(self, "Failing HTLC with payment_hash {} backwards with pre-built LightningError", log_bytes!(payment_hash.0));
1655 onion_utils::encrypt_failure_packet(&incoming_packet_shared_secret, &err.data)
1659 let mut forward_event = None;
1660 if channel_state_lock.forward_htlcs.is_empty() {
1661 forward_event = Some(Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS));
1663 match channel_state_lock.forward_htlcs.entry(short_channel_id) {
1664 hash_map::Entry::Occupied(mut entry) => {
1665 entry.get_mut().push(HTLCForwardInfo::FailHTLC { htlc_id, err_packet });
1667 hash_map::Entry::Vacant(entry) => {
1668 entry.insert(vec!(HTLCForwardInfo::FailHTLC { htlc_id, err_packet }));
1671 mem::drop(channel_state_lock);
1672 if let Some(time) = forward_event {
1673 let mut pending_events = self.pending_events.lock().unwrap();
1674 pending_events.push(events::Event::PendingHTLCsForwardable {
1675 time_forwardable: time
1682 /// Provides a payment preimage in response to a PaymentReceived event, returning true and
1683 /// generating message events for the net layer to claim the payment, if possible. Thus, you
1684 /// should probably kick the net layer to go send messages if this returns true!
1686 /// You must specify the expected amounts for this HTLC, and we will only claim HTLCs
1687 /// available within a few percent of the expected amount. This is critical for several
1688 /// reasons : a) it avoids providing senders with `proof-of-payment` (in the form of the
1689 /// payment_preimage without having provided the full value and b) it avoids certain
1690 /// privacy-breaking recipient-probing attacks which may reveal payment activity to
1691 /// motivated attackers.
1693 /// May panic if called except in response to a PaymentReceived event.
1694 pub fn claim_funds(&self, payment_preimage: PaymentPreimage, expected_amount: u64) -> bool {
1695 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
1697 let _ = self.total_consistency_lock.read().unwrap();
1699 let mut channel_state = Some(self.channel_state.lock().unwrap());
1700 let removed_source = channel_state.as_mut().unwrap().claimable_htlcs.remove(&payment_hash);
1701 if let Some(mut sources) = removed_source {
1702 for (received_amount, htlc_with_hash) in sources.drain(..) {
1703 if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
1704 if received_amount < expected_amount || received_amount > expected_amount * 2 {
1705 let mut htlc_msat_data = byte_utils::be64_to_array(received_amount).to_vec();
1706 let mut height_data = byte_utils::be32_to_array(self.latest_block_height.load(Ordering::Acquire) as u32).to_vec();
1707 htlc_msat_data.append(&mut height_data);
1708 self.fail_htlc_backwards_internal(channel_state.take().unwrap(),
1709 HTLCSource::PreviousHopData(htlc_with_hash), &payment_hash,
1710 HTLCFailReason::Reason { failure_code: 0x4000|15, data: htlc_msat_data });
1712 self.claim_funds_internal(channel_state.take().unwrap(), HTLCSource::PreviousHopData(htlc_with_hash), payment_preimage);
1718 fn claim_funds_internal(&self, mut channel_state_lock: MutexGuard<ChannelHolder<ChanSigner>>, source: HTLCSource, payment_preimage: PaymentPreimage) {
1719 let (their_node_id, err) = loop {
1721 HTLCSource::OutboundRoute { .. } => {
1722 mem::drop(channel_state_lock);
1723 let mut pending_events = self.pending_events.lock().unwrap();
1724 pending_events.push(events::Event::PaymentSent {
1728 HTLCSource::PreviousHopData(HTLCPreviousHopData { short_channel_id, htlc_id, .. }) => {
1729 //TODO: Delay the claimed_funds relaying just like we do outbound relay!
1730 let channel_state = &mut *channel_state_lock;
1732 let chan_id = match channel_state.short_to_id.get(&short_channel_id) {
1733 Some(chan_id) => chan_id.clone(),
1735 // TODO: There is probably a channel manager somewhere that needs to
1736 // learn the preimage as the channel already hit the chain and that's
1737 // why it's missing.
1742 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(chan_id) {
1743 let was_frozen_for_monitor = chan.get().is_awaiting_monitor_update();
1744 match chan.get_mut().get_update_fulfill_htlc_and_commit(htlc_id, payment_preimage) {
1745 Ok((msgs, monitor_option)) => {
1746 if let Some(monitor_update) = monitor_option {
1747 if let Err(e) = self.monitor.update_monitor(chan.get().get_funding_txo().unwrap(), monitor_update) {
1748 if was_frozen_for_monitor {
1749 assert!(msgs.is_none());
1751 break (chan.get().get_their_node_id(), handle_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, msgs.is_some()));
1755 if let Some((msg, commitment_signed)) = msgs {
1756 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1757 node_id: chan.get().get_their_node_id(),
1758 updates: msgs::CommitmentUpdate {
1759 update_add_htlcs: Vec::new(),
1760 update_fulfill_htlcs: vec![msg],
1761 update_fail_htlcs: Vec::new(),
1762 update_fail_malformed_htlcs: Vec::new(),
1770 // TODO: There is probably a channel manager somewhere that needs to
1771 // learn the preimage as the channel may be about to hit the chain.
1772 //TODO: Do something with e?
1776 } else { unreachable!(); }
1782 let _ = handle_error!(self, err, their_node_id, channel_state_lock);
1785 /// Gets the node_id held by this ChannelManager
1786 pub fn get_our_node_id(&self) -> PublicKey {
1787 PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key)
1790 /// Restores a single, given channel to normal operation after a
1791 /// ChannelMonitorUpdateErr::TemporaryFailure was returned from a channel monitor update
1794 /// All ChannelMonitor updates up to and including highest_applied_update_id must have been
1795 /// fully committed in every copy of the given channels' ChannelMonitors.
1797 /// Note that there is no effect to calling with a highest_applied_update_id other than the
1798 /// current latest ChannelMonitorUpdate and one call to this function after multiple
1799 /// ChannelMonitorUpdateErr::TemporaryFailures is fine. The highest_applied_update_id field
1800 /// exists largely only to prevent races between this and concurrent update_monitor calls.
1802 /// Thus, the anticipated use is, at a high level:
1803 /// 1) You register a ManyChannelMonitor with this ChannelManager,
1804 /// 2) it stores each update to disk, and begins updating any remote (eg watchtower) copies of
1805 /// said ChannelMonitors as it can, returning ChannelMonitorUpdateErr::TemporaryFailures
1806 /// any time it cannot do so instantly,
1807 /// 3) update(s) are applied to each remote copy of a ChannelMonitor,
1808 /// 4) once all remote copies are updated, you call this function with the update_id that
1809 /// completed, and once it is the latest the Channel will be re-enabled.
1810 pub fn channel_monitor_updated(&self, funding_txo: &OutPoint, highest_applied_update_id: u64) {
1811 let _ = self.total_consistency_lock.read().unwrap();
1813 let mut close_results = Vec::new();
1814 let mut htlc_forwards = Vec::new();
1815 let mut htlc_failures = Vec::new();
1816 let mut pending_events = Vec::new();
1819 let mut channel_lock = self.channel_state.lock().unwrap();
1820 let channel_state = &mut *channel_lock;
1821 let short_to_id = &mut channel_state.short_to_id;
1822 let pending_msg_events = &mut channel_state.pending_msg_events;
1823 let channel = match channel_state.by_id.get_mut(&funding_txo.to_channel_id()) {
1827 if !channel.is_awaiting_monitor_update() || channel.get_latest_monitor_update_id() != highest_applied_update_id {
1831 let (raa, commitment_update, order, pending_forwards, mut pending_failures, needs_broadcast_safe, funding_locked) = channel.monitor_updating_restored();
1832 if !pending_forwards.is_empty() {
1833 htlc_forwards.push((channel.get_short_channel_id().expect("We can't have pending forwards before funding confirmation"), pending_forwards));
1835 htlc_failures.append(&mut pending_failures);
1837 macro_rules! handle_cs { () => {
1838 if let Some(update) = commitment_update {
1839 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1840 node_id: channel.get_their_node_id(),
1845 macro_rules! handle_raa { () => {
1846 if let Some(revoke_and_ack) = raa {
1847 pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
1848 node_id: channel.get_their_node_id(),
1849 msg: revoke_and_ack,
1854 RAACommitmentOrder::CommitmentFirst => {
1858 RAACommitmentOrder::RevokeAndACKFirst => {
1863 if needs_broadcast_safe {
1864 pending_events.push(events::Event::FundingBroadcastSafe {
1865 funding_txo: channel.get_funding_txo().unwrap(),
1866 user_channel_id: channel.get_user_id(),
1869 if let Some(msg) = funding_locked {
1870 pending_msg_events.push(events::MessageSendEvent::SendFundingLocked {
1871 node_id: channel.get_their_node_id(),
1874 if let Some(announcement_sigs) = self.get_announcement_sigs(channel) {
1875 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
1876 node_id: channel.get_their_node_id(),
1877 msg: announcement_sigs,
1880 short_to_id.insert(channel.get_short_channel_id().unwrap(), channel.channel_id());
1884 self.pending_events.lock().unwrap().append(&mut pending_events);
1886 for failure in htlc_failures.drain(..) {
1887 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), failure.0, &failure.1, failure.2);
1889 self.forward_htlcs(&mut htlc_forwards[..]);
1891 for res in close_results.drain(..) {
1892 self.finish_force_close_channel(res);
1896 fn internal_open_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::OpenChannel) -> Result<(), MsgHandleErrInternal> {
1897 if msg.chain_hash != self.genesis_hash {
1898 return Err(MsgHandleErrInternal::send_err_msg_no_close("Unknown genesis block hash", msg.temporary_channel_id.clone()));
1901 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)
1902 .map_err(|e| MsgHandleErrInternal::from_chan_no_close(e, msg.temporary_channel_id))?;
1903 let mut channel_state_lock = self.channel_state.lock().unwrap();
1904 let channel_state = &mut *channel_state_lock;
1905 match channel_state.by_id.entry(channel.channel_id()) {
1906 hash_map::Entry::Occupied(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("temporary_channel_id collision!", msg.temporary_channel_id.clone())),
1907 hash_map::Entry::Vacant(entry) => {
1908 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
1909 node_id: their_node_id.clone(),
1910 msg: channel.get_accept_channel(),
1912 entry.insert(channel);
1918 fn internal_accept_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::AcceptChannel) -> Result<(), MsgHandleErrInternal> {
1919 let (value, output_script, user_id) = {
1920 let mut channel_lock = self.channel_state.lock().unwrap();
1921 let channel_state = &mut *channel_lock;
1922 match channel_state.by_id.entry(msg.temporary_channel_id) {
1923 hash_map::Entry::Occupied(mut chan) => {
1924 if chan.get().get_their_node_id() != *their_node_id {
1925 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.temporary_channel_id));
1927 try_chan_entry!(self, chan.get_mut().accept_channel(&msg, &self.default_configuration, their_features), channel_state, chan);
1928 (chan.get().get_value_satoshis(), chan.get().get_funding_redeemscript().to_v0_p2wsh(), chan.get().get_user_id())
1930 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.temporary_channel_id))
1933 let mut pending_events = self.pending_events.lock().unwrap();
1934 pending_events.push(events::Event::FundingGenerationReady {
1935 temporary_channel_id: msg.temporary_channel_id,
1936 channel_value_satoshis: value,
1937 output_script: output_script,
1938 user_channel_id: user_id,
1943 fn internal_funding_created(&self, their_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), MsgHandleErrInternal> {
1944 let ((funding_msg, monitor_update), mut chan) = {
1945 let mut channel_lock = self.channel_state.lock().unwrap();
1946 let channel_state = &mut *channel_lock;
1947 match channel_state.by_id.entry(msg.temporary_channel_id.clone()) {
1948 hash_map::Entry::Occupied(mut chan) => {
1949 if chan.get().get_their_node_id() != *their_node_id {
1950 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.temporary_channel_id));
1952 (try_chan_entry!(self, chan.get_mut().funding_created(msg), channel_state, chan), chan.remove())
1954 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.temporary_channel_id))
1957 // Because we have exclusive ownership of the channel here we can release the channel_state
1958 // lock before add_monitor
1959 if let Err(e) = self.monitor.add_monitor(monitor_update.get_funding_txo().unwrap(), monitor_update) {
1961 ChannelMonitorUpdateErr::PermanentFailure => {
1962 // Note that we reply with the new channel_id in error messages if we gave up on the
1963 // channel, not the temporary_channel_id. This is compatible with ourselves, but the
1964 // spec is somewhat ambiguous here. Not a huge deal since we'll send error messages for
1965 // any messages referencing a previously-closed channel anyway.
1966 return Err(MsgHandleErrInternal::from_finish_shutdown("ChannelMonitor storage failure", funding_msg.channel_id, chan.force_shutdown(), None));
1968 ChannelMonitorUpdateErr::TemporaryFailure => {
1969 // There's no problem signing a counterparty's funding transaction if our monitor
1970 // hasn't persisted to disk yet - we can't lose money on a transaction that we haven't
1971 // accepted payment from yet. We do, however, need to wait to send our funding_locked
1972 // until we have persisted our monitor.
1973 chan.monitor_update_failed(false, false, Vec::new(), Vec::new());
1977 let mut channel_state_lock = self.channel_state.lock().unwrap();
1978 let channel_state = &mut *channel_state_lock;
1979 match channel_state.by_id.entry(funding_msg.channel_id) {
1980 hash_map::Entry::Occupied(_) => {
1981 return Err(MsgHandleErrInternal::send_err_msg_no_close("Already had channel with the new channel_id", funding_msg.channel_id))
1983 hash_map::Entry::Vacant(e) => {
1984 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
1985 node_id: their_node_id.clone(),
1994 fn internal_funding_signed(&self, their_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), MsgHandleErrInternal> {
1995 let (funding_txo, user_id) = {
1996 let mut channel_lock = self.channel_state.lock().unwrap();
1997 let channel_state = &mut *channel_lock;
1998 match channel_state.by_id.entry(msg.channel_id) {
1999 hash_map::Entry::Occupied(mut chan) => {
2000 if chan.get().get_their_node_id() != *their_node_id {
2001 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2003 let monitor_update = match chan.get_mut().funding_signed(&msg) {
2004 Err((None, e)) => try_chan_entry!(self, Err(e), channel_state, chan),
2005 Err((Some(monitor_update), e)) => {
2006 assert!(chan.get().is_awaiting_monitor_update());
2007 let _ = self.monitor.update_monitor(chan.get().get_funding_txo().unwrap(), monitor_update);
2008 try_chan_entry!(self, Err(e), channel_state, chan);
2011 Ok(update) => update,
2013 if let Err(e) = self.monitor.update_monitor(chan.get().get_funding_txo().unwrap(), monitor_update) {
2014 return_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::RevokeAndACKFirst, false, false);
2016 (chan.get().get_funding_txo().unwrap(), chan.get().get_user_id())
2018 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2021 let mut pending_events = self.pending_events.lock().unwrap();
2022 pending_events.push(events::Event::FundingBroadcastSafe {
2023 funding_txo: funding_txo,
2024 user_channel_id: user_id,
2029 fn internal_funding_locked(&self, their_node_id: &PublicKey, msg: &msgs::FundingLocked) -> Result<(), MsgHandleErrInternal> {
2030 let mut channel_state_lock = self.channel_state.lock().unwrap();
2031 let channel_state = &mut *channel_state_lock;
2032 match channel_state.by_id.entry(msg.channel_id) {
2033 hash_map::Entry::Occupied(mut chan) => {
2034 if chan.get().get_their_node_id() != *their_node_id {
2035 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2037 try_chan_entry!(self, chan.get_mut().funding_locked(&msg), channel_state, chan);
2038 if let Some(announcement_sigs) = self.get_announcement_sigs(chan.get()) {
2039 log_trace!(self, "Sending announcement_signatures for {} in response to funding_locked", log_bytes!(chan.get().channel_id()));
2040 // If we see locking block before receiving remote funding_locked, we broadcast our
2041 // announcement_sigs at remote funding_locked reception. If we receive remote
2042 // funding_locked before seeing locking block, we broadcast our announcement_sigs at locking
2043 // block connection. We should guanrantee to broadcast announcement_sigs to our peer whatever
2044 // the order of the events but our peer may not receive it due to disconnection. The specs
2045 // lacking an acknowledgement for announcement_sigs we may have to re-send them at peer
2046 // connection in the future if simultaneous misses by both peers due to network/hardware
2047 // failures is an issue. Note, to achieve its goal, only one of the announcement_sigs needs
2048 // to be received, from then sigs are going to be flood to the whole network.
2049 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
2050 node_id: their_node_id.clone(),
2051 msg: announcement_sigs,
2056 hash_map::Entry::Vacant(_) => Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2060 fn internal_shutdown(&self, their_node_id: &PublicKey, msg: &msgs::Shutdown) -> Result<(), MsgHandleErrInternal> {
2061 let (mut dropped_htlcs, chan_option) = {
2062 let mut channel_state_lock = self.channel_state.lock().unwrap();
2063 let channel_state = &mut *channel_state_lock;
2065 match channel_state.by_id.entry(msg.channel_id.clone()) {
2066 hash_map::Entry::Occupied(mut chan_entry) => {
2067 if chan_entry.get().get_their_node_id() != *their_node_id {
2068 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2070 let (shutdown, closing_signed, dropped_htlcs) = try_chan_entry!(self, chan_entry.get_mut().shutdown(&self.fee_estimator, &msg), channel_state, chan_entry);
2071 if let Some(msg) = shutdown {
2072 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
2073 node_id: their_node_id.clone(),
2077 if let Some(msg) = closing_signed {
2078 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
2079 node_id: their_node_id.clone(),
2083 if chan_entry.get().is_shutdown() {
2084 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
2085 channel_state.short_to_id.remove(&short_id);
2087 (dropped_htlcs, Some(chan_entry.remove_entry().1))
2088 } else { (dropped_htlcs, None) }
2090 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2093 for htlc_source in dropped_htlcs.drain(..) {
2094 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() });
2096 if let Some(chan) = chan_option {
2097 if let Ok(update) = self.get_channel_update(&chan) {
2098 let mut channel_state = self.channel_state.lock().unwrap();
2099 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2107 fn internal_closing_signed(&self, their_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<(), MsgHandleErrInternal> {
2108 let (tx, chan_option) = {
2109 let mut channel_state_lock = self.channel_state.lock().unwrap();
2110 let channel_state = &mut *channel_state_lock;
2111 match channel_state.by_id.entry(msg.channel_id.clone()) {
2112 hash_map::Entry::Occupied(mut chan_entry) => {
2113 if chan_entry.get().get_their_node_id() != *their_node_id {
2114 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2116 let (closing_signed, tx) = try_chan_entry!(self, chan_entry.get_mut().closing_signed(&self.fee_estimator, &msg), channel_state, chan_entry);
2117 if let Some(msg) = closing_signed {
2118 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
2119 node_id: their_node_id.clone(),
2124 // We're done with this channel, we've got a signed closing transaction and
2125 // will send the closing_signed back to the remote peer upon return. This
2126 // also implies there are no pending HTLCs left on the channel, so we can
2127 // fully delete it from tracking (the channel monitor is still around to
2128 // watch for old state broadcasts)!
2129 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
2130 channel_state.short_to_id.remove(&short_id);
2132 (tx, Some(chan_entry.remove_entry().1))
2133 } else { (tx, None) }
2135 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2138 if let Some(broadcast_tx) = tx {
2139 log_trace!(self, "Broadcast onchain {}", log_tx!(broadcast_tx));
2140 self.tx_broadcaster.broadcast_transaction(&broadcast_tx);
2142 if let Some(chan) = chan_option {
2143 if let Ok(update) = self.get_channel_update(&chan) {
2144 let mut channel_state = self.channel_state.lock().unwrap();
2145 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2153 fn internal_update_add_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), MsgHandleErrInternal> {
2154 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
2155 //determine the state of the payment based on our response/if we forward anything/the time
2156 //we take to respond. We should take care to avoid allowing such an attack.
2158 //TODO: There exists a further attack where a node may garble the onion data, forward it to
2159 //us repeatedly garbled in different ways, and compare our error messages, which are
2160 //encrypted with the same key. It's not immediately obvious how to usefully exploit that,
2161 //but we should prevent it anyway.
2163 let (mut pending_forward_info, mut channel_state_lock) = self.decode_update_add_htlc_onion(msg);
2164 let channel_state = &mut *channel_state_lock;
2166 match channel_state.by_id.entry(msg.channel_id) {
2167 hash_map::Entry::Occupied(mut chan) => {
2168 if chan.get().get_their_node_id() != *their_node_id {
2169 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2171 if !chan.get().is_usable() {
2172 // If the update_add is completely bogus, the call will Err and we will close,
2173 // but if we've sent a shutdown and they haven't acknowledged it yet, we just
2174 // want to reject the new HTLC and fail it backwards instead of forwarding.
2175 if let PendingHTLCStatus::Forward(PendingHTLCInfo { incoming_shared_secret, .. }) = pending_forward_info {
2176 let chan_update = self.get_channel_update(chan.get());
2177 pending_forward_info = PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
2178 channel_id: msg.channel_id,
2179 htlc_id: msg.htlc_id,
2180 reason: if let Ok(update) = chan_update {
2181 // TODO: Note that |20 is defined as "channel FROM the processing
2182 // node has been disabled" (emphasis mine), which seems to imply
2183 // that we can't return |20 for an inbound channel being disabled.
2184 // This probably needs a spec update but should definitely be
2186 onion_utils::build_first_hop_failure_packet(&incoming_shared_secret, 0x1000|20, &{
2187 let mut res = Vec::with_capacity(8 + 128);
2188 res.extend_from_slice(&byte_utils::be16_to_array(update.contents.flags));
2189 res.extend_from_slice(&update.encode_with_len()[..]);
2193 // This can only happen if the channel isn't in the fully-funded
2194 // state yet, implying our counterparty is trying to route payments
2195 // over the channel back to themselves (cause no one else should
2196 // know the short_id is a lightning channel yet). We should have no
2197 // problem just calling this unknown_next_peer
2198 onion_utils::build_first_hop_failure_packet(&incoming_shared_secret, 0x4000|10, &[])
2203 try_chan_entry!(self, chan.get_mut().update_add_htlc(&msg, pending_forward_info), channel_state, chan);
2205 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2210 fn internal_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), MsgHandleErrInternal> {
2211 let mut channel_lock = self.channel_state.lock().unwrap();
2213 let channel_state = &mut *channel_lock;
2214 match channel_state.by_id.entry(msg.channel_id) {
2215 hash_map::Entry::Occupied(mut chan) => {
2216 if chan.get().get_their_node_id() != *their_node_id {
2217 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2219 try_chan_entry!(self, chan.get_mut().update_fulfill_htlc(&msg), channel_state, chan)
2221 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2224 self.claim_funds_internal(channel_lock, htlc_source, msg.payment_preimage.clone());
2228 fn internal_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), MsgHandleErrInternal> {
2229 let mut channel_lock = self.channel_state.lock().unwrap();
2230 let channel_state = &mut *channel_lock;
2231 match channel_state.by_id.entry(msg.channel_id) {
2232 hash_map::Entry::Occupied(mut chan) => {
2233 if chan.get().get_their_node_id() != *their_node_id {
2234 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2236 try_chan_entry!(self, chan.get_mut().update_fail_htlc(&msg, HTLCFailReason::LightningError { err: msg.reason.clone() }), channel_state, chan);
2238 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2243 fn internal_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), MsgHandleErrInternal> {
2244 let mut channel_lock = self.channel_state.lock().unwrap();
2245 let channel_state = &mut *channel_lock;
2246 match channel_state.by_id.entry(msg.channel_id) {
2247 hash_map::Entry::Occupied(mut chan) => {
2248 if chan.get().get_their_node_id() != *their_node_id {
2249 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2251 if (msg.failure_code & 0x8000) == 0 {
2252 let chan_err: ChannelError = ChannelError::Close("Got update_fail_malformed_htlc with BADONION not set");
2253 try_chan_entry!(self, Err(chan_err), channel_state, chan);
2255 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);
2258 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2262 fn internal_commitment_signed(&self, their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), MsgHandleErrInternal> {
2263 let mut channel_state_lock = self.channel_state.lock().unwrap();
2264 let channel_state = &mut *channel_state_lock;
2265 match channel_state.by_id.entry(msg.channel_id) {
2266 hash_map::Entry::Occupied(mut chan) => {
2267 if chan.get().get_their_node_id() != *their_node_id {
2268 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2270 let (revoke_and_ack, commitment_signed, closing_signed, monitor_update) =
2271 match chan.get_mut().commitment_signed(&msg, &self.fee_estimator) {
2272 Err((None, e)) => try_chan_entry!(self, Err(e), channel_state, chan),
2273 Err((Some(update), e)) => {
2274 assert!(chan.get().is_awaiting_monitor_update());
2275 let _ = self.monitor.update_monitor(chan.get().get_funding_txo().unwrap(), update);
2276 try_chan_entry!(self, Err(e), channel_state, chan);
2281 if let Err(e) = self.monitor.update_monitor(chan.get().get_funding_txo().unwrap(), monitor_update) {
2282 return_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::RevokeAndACKFirst, true, commitment_signed.is_some());
2283 //TODO: Rebroadcast closing_signed if present on monitor update restoration
2285 channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
2286 node_id: their_node_id.clone(),
2287 msg: revoke_and_ack,
2289 if let Some(msg) = commitment_signed {
2290 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2291 node_id: their_node_id.clone(),
2292 updates: msgs::CommitmentUpdate {
2293 update_add_htlcs: Vec::new(),
2294 update_fulfill_htlcs: Vec::new(),
2295 update_fail_htlcs: Vec::new(),
2296 update_fail_malformed_htlcs: Vec::new(),
2298 commitment_signed: msg,
2302 if let Some(msg) = closing_signed {
2303 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
2304 node_id: their_node_id.clone(),
2310 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2315 fn forward_htlcs(&self, per_source_pending_forwards: &mut [(u64, Vec<(PendingHTLCInfo, u64)>)]) {
2316 for &mut (prev_short_channel_id, ref mut pending_forwards) in per_source_pending_forwards {
2317 let mut forward_event = None;
2318 if !pending_forwards.is_empty() {
2319 let mut channel_state = self.channel_state.lock().unwrap();
2320 if channel_state.forward_htlcs.is_empty() {
2321 forward_event = Some(Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS))
2323 for (forward_info, prev_htlc_id) in pending_forwards.drain(..) {
2324 match channel_state.forward_htlcs.entry(forward_info.short_channel_id) {
2325 hash_map::Entry::Occupied(mut entry) => {
2326 entry.get_mut().push(HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info });
2328 hash_map::Entry::Vacant(entry) => {
2329 entry.insert(vec!(HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info }));
2334 match forward_event {
2336 let mut pending_events = self.pending_events.lock().unwrap();
2337 pending_events.push(events::Event::PendingHTLCsForwardable {
2338 time_forwardable: time
2346 fn internal_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), MsgHandleErrInternal> {
2347 let (pending_forwards, mut pending_failures, short_channel_id) = {
2348 let mut channel_state_lock = self.channel_state.lock().unwrap();
2349 let channel_state = &mut *channel_state_lock;
2350 match channel_state.by_id.entry(msg.channel_id) {
2351 hash_map::Entry::Occupied(mut chan) => {
2352 if chan.get().get_their_node_id() != *their_node_id {
2353 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2355 let was_frozen_for_monitor = chan.get().is_awaiting_monitor_update();
2356 let (commitment_update, pending_forwards, pending_failures, closing_signed, monitor_update) =
2357 try_chan_entry!(self, chan.get_mut().revoke_and_ack(&msg, &self.fee_estimator), channel_state, chan);
2358 if let Err(e) = self.monitor.update_monitor(chan.get().get_funding_txo().unwrap(), monitor_update) {
2359 if was_frozen_for_monitor {
2360 assert!(commitment_update.is_none() && closing_signed.is_none() && pending_forwards.is_empty() && pending_failures.is_empty());
2361 return Err(MsgHandleErrInternal::ignore_no_close("Previous monitor update failure prevented responses to RAA"));
2363 return_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, commitment_update.is_some(), pending_forwards, pending_failures);
2366 if let Some(updates) = commitment_update {
2367 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2368 node_id: their_node_id.clone(),
2372 if let Some(msg) = closing_signed {
2373 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
2374 node_id: their_node_id.clone(),
2378 (pending_forwards, pending_failures, chan.get().get_short_channel_id().expect("RAA should only work on a short-id-available channel"))
2380 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2383 for failure in pending_failures.drain(..) {
2384 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), failure.0, &failure.1, failure.2);
2386 self.forward_htlcs(&mut [(short_channel_id, pending_forwards)]);
2391 fn internal_update_fee(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), MsgHandleErrInternal> {
2392 let mut channel_lock = self.channel_state.lock().unwrap();
2393 let channel_state = &mut *channel_lock;
2394 match channel_state.by_id.entry(msg.channel_id) {
2395 hash_map::Entry::Occupied(mut chan) => {
2396 if chan.get().get_their_node_id() != *their_node_id {
2397 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2399 try_chan_entry!(self, chan.get_mut().update_fee(&self.fee_estimator, &msg), channel_state, chan);
2401 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2406 fn internal_announcement_signatures(&self, their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), MsgHandleErrInternal> {
2407 let mut channel_state_lock = self.channel_state.lock().unwrap();
2408 let channel_state = &mut *channel_state_lock;
2410 match channel_state.by_id.entry(msg.channel_id) {
2411 hash_map::Entry::Occupied(mut chan) => {
2412 if chan.get().get_their_node_id() != *their_node_id {
2413 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2415 if !chan.get().is_usable() {
2416 return Err(MsgHandleErrInternal::from_no_close(LightningError{err: "Got an announcement_signatures before we were ready for it", action: msgs::ErrorAction::IgnoreError}));
2419 let our_node_id = self.get_our_node_id();
2420 let (announcement, our_bitcoin_sig) =
2421 try_chan_entry!(self, chan.get_mut().get_channel_announcement(our_node_id.clone(), self.genesis_hash.clone()), channel_state, chan);
2423 let were_node_one = announcement.node_id_1 == our_node_id;
2424 let msghash = hash_to_message!(&Sha256dHash::hash(&announcement.encode()[..])[..]);
2425 if self.secp_ctx.verify(&msghash, &msg.node_signature, if were_node_one { &announcement.node_id_2 } else { &announcement.node_id_1 }).is_err() ||
2426 self.secp_ctx.verify(&msghash, &msg.bitcoin_signature, if were_node_one { &announcement.bitcoin_key_2 } else { &announcement.bitcoin_key_1 }).is_err() {
2427 let chan_err: ChannelError = ChannelError::Close("Bad announcement_signatures node_signature");
2428 try_chan_entry!(self, Err(chan_err), channel_state, chan);
2431 let our_node_sig = self.secp_ctx.sign(&msghash, &self.our_network_key);
2433 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
2434 msg: msgs::ChannelAnnouncement {
2435 node_signature_1: if were_node_one { our_node_sig } else { msg.node_signature },
2436 node_signature_2: if were_node_one { msg.node_signature } else { our_node_sig },
2437 bitcoin_signature_1: if were_node_one { our_bitcoin_sig } else { msg.bitcoin_signature },
2438 bitcoin_signature_2: if were_node_one { msg.bitcoin_signature } else { our_bitcoin_sig },
2439 contents: announcement,
2441 update_msg: self.get_channel_update(chan.get()).unwrap(), // can only fail if we're not in a ready state
2444 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2449 fn internal_channel_reestablish(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<(), MsgHandleErrInternal> {
2450 let mut channel_state_lock = self.channel_state.lock().unwrap();
2451 let channel_state = &mut *channel_state_lock;
2453 match channel_state.by_id.entry(msg.channel_id) {
2454 hash_map::Entry::Occupied(mut chan) => {
2455 if chan.get().get_their_node_id() != *their_node_id {
2456 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2458 let (funding_locked, revoke_and_ack, commitment_update, monitor_update_opt, mut order, shutdown) =
2459 try_chan_entry!(self, chan.get_mut().channel_reestablish(msg), channel_state, chan);
2460 if let Some(monitor_update) = monitor_update_opt {
2461 if let Err(e) = self.monitor.update_monitor(chan.get().get_funding_txo().unwrap(), monitor_update) {
2462 // channel_reestablish doesn't guarantee the order it returns is sensical
2463 // for the messages it returns, but if we're setting what messages to
2464 // re-transmit on monitor update success, we need to make sure it is sane.
2465 if revoke_and_ack.is_none() {
2466 order = RAACommitmentOrder::CommitmentFirst;
2468 if commitment_update.is_none() {
2469 order = RAACommitmentOrder::RevokeAndACKFirst;
2471 return_monitor_err!(self, e, channel_state, chan, order, revoke_and_ack.is_some(), commitment_update.is_some());
2472 //TODO: Resend the funding_locked if needed once we get the monitor running again
2475 if let Some(msg) = funding_locked {
2476 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingLocked {
2477 node_id: their_node_id.clone(),
2481 macro_rules! send_raa { () => {
2482 if let Some(msg) = revoke_and_ack {
2483 channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
2484 node_id: their_node_id.clone(),
2489 macro_rules! send_cu { () => {
2490 if let Some(updates) = commitment_update {
2491 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2492 node_id: their_node_id.clone(),
2498 RAACommitmentOrder::RevokeAndACKFirst => {
2502 RAACommitmentOrder::CommitmentFirst => {
2507 if let Some(msg) = shutdown {
2508 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
2509 node_id: their_node_id.clone(),
2515 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2519 /// Begin Update fee process. Allowed only on an outbound channel.
2520 /// If successful, will generate a UpdateHTLCs event, so you should probably poll
2521 /// PeerManager::process_events afterwards.
2522 /// Note: This API is likely to change!
2524 pub fn update_fee(&self, channel_id: [u8;32], feerate_per_kw: u64) -> Result<(), APIError> {
2525 let _ = self.total_consistency_lock.read().unwrap();
2526 let mut channel_state_lock = self.channel_state.lock().unwrap();
2528 let err: Result<(), _> = loop {
2529 let channel_state = &mut *channel_state_lock;
2531 match channel_state.by_id.entry(channel_id) {
2532 hash_map::Entry::Vacant(_) => return Err(APIError::APIMisuseError{err: "Failed to find corresponding channel"}),
2533 hash_map::Entry::Occupied(mut chan) => {
2534 if !chan.get().is_outbound() {
2535 return Err(APIError::APIMisuseError{err: "update_fee cannot be sent for an inbound channel"});
2537 if chan.get().is_awaiting_monitor_update() {
2538 return Err(APIError::MonitorUpdateFailed);
2540 if !chan.get().is_live() {
2541 return Err(APIError::ChannelUnavailable{err: "Channel is either not yet fully established or peer is currently disconnected"});
2543 their_node_id = chan.get().get_their_node_id();
2544 if let Some((update_fee, commitment_signed, monitor_update)) =
2545 break_chan_entry!(self, chan.get_mut().send_update_fee_and_commit(feerate_per_kw), channel_state, chan)
2547 if let Err(_e) = self.monitor.update_monitor(chan.get().get_funding_txo().unwrap(), monitor_update) {
2550 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2551 node_id: chan.get().get_their_node_id(),
2552 updates: msgs::CommitmentUpdate {
2553 update_add_htlcs: Vec::new(),
2554 update_fulfill_htlcs: Vec::new(),
2555 update_fail_htlcs: Vec::new(),
2556 update_fail_malformed_htlcs: Vec::new(),
2557 update_fee: Some(update_fee),
2567 match handle_error!(self, err, their_node_id, channel_state_lock) {
2568 Ok(_) => unreachable!(),
2569 Err(e) => { Err(APIError::APIMisuseError { err: e.err })}
2574 impl<ChanSigner: ChannelKeys, M: Deref, T: Deref, K: Deref, F: Deref> events::MessageSendEventsProvider for ChannelManager<ChanSigner, M, T, K, F>
2575 where M::Target: ManyChannelMonitor<ChanSigner>,
2576 T::Target: BroadcasterInterface,
2577 K::Target: KeysInterface<ChanKeySigner = ChanSigner>,
2578 F::Target: FeeEstimator,
2580 fn get_and_clear_pending_msg_events(&self) -> Vec<events::MessageSendEvent> {
2581 // TODO: Event release to users and serialization is currently race-y: it's very easy for a
2582 // user to serialize a ChannelManager with pending events in it and lose those events on
2583 // restart. This is doubly true for the fail/fulfill-backs from monitor events!
2585 //TODO: This behavior should be documented.
2586 for htlc_update in self.monitor.get_and_clear_pending_htlcs_updated() {
2587 if let Some(preimage) = htlc_update.payment_preimage {
2588 log_trace!(self, "Claiming HTLC with preimage {} from our monitor", log_bytes!(preimage.0));
2589 self.claim_funds_internal(self.channel_state.lock().unwrap(), htlc_update.source, preimage);
2591 log_trace!(self, "Failing HTLC with hash {} from our monitor", log_bytes!(htlc_update.payment_hash.0));
2592 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() });
2597 let mut ret = Vec::new();
2598 let mut channel_state = self.channel_state.lock().unwrap();
2599 mem::swap(&mut ret, &mut channel_state.pending_msg_events);
2604 impl<ChanSigner: ChannelKeys, M: Deref, T: Deref, K: Deref, F: Deref> events::EventsProvider for ChannelManager<ChanSigner, M, T, K, F>
2605 where M::Target: ManyChannelMonitor<ChanSigner>,
2606 T::Target: BroadcasterInterface,
2607 K::Target: KeysInterface<ChanKeySigner = ChanSigner>,
2608 F::Target: FeeEstimator,
2610 fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
2611 // TODO: Event release to users and serialization is currently race-y: it's very easy for a
2612 // user to serialize a ChannelManager with pending events in it and lose those events on
2613 // restart. This is doubly true for the fail/fulfill-backs from monitor events!
2615 //TODO: This behavior should be documented.
2616 for htlc_update in self.monitor.get_and_clear_pending_htlcs_updated() {
2617 if let Some(preimage) = htlc_update.payment_preimage {
2618 log_trace!(self, "Claiming HTLC with preimage {} from our monitor", log_bytes!(preimage.0));
2619 self.claim_funds_internal(self.channel_state.lock().unwrap(), htlc_update.source, preimage);
2621 log_trace!(self, "Failing HTLC with hash {} from our monitor", log_bytes!(htlc_update.payment_hash.0));
2622 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() });
2627 let mut ret = Vec::new();
2628 let mut pending_events = self.pending_events.lock().unwrap();
2629 mem::swap(&mut ret, &mut *pending_events);
2634 impl<ChanSigner: ChannelKeys, M: Deref + Sync + Send, T: Deref + Sync + Send, K: Deref + Sync + Send, F: Deref + Sync + Send>
2635 ChainListener for ChannelManager<ChanSigner, M, T, K, F>
2636 where M::Target: ManyChannelMonitor<ChanSigner>,
2637 T::Target: BroadcasterInterface,
2638 K::Target: KeysInterface<ChanKeySigner = ChanSigner>,
2639 F::Target: FeeEstimator,
2641 fn block_connected(&self, header: &BlockHeader, height: u32, txn_matched: &[&Transaction], indexes_of_txn_matched: &[u32]) {
2642 let header_hash = header.bitcoin_hash();
2643 log_trace!(self, "Block {} at height {} connected with {} txn matched", header_hash, height, txn_matched.len());
2644 let _ = self.total_consistency_lock.read().unwrap();
2645 let mut failed_channels = Vec::new();
2647 let mut channel_lock = self.channel_state.lock().unwrap();
2648 let channel_state = &mut *channel_lock;
2649 let short_to_id = &mut channel_state.short_to_id;
2650 let pending_msg_events = &mut channel_state.pending_msg_events;
2651 channel_state.by_id.retain(|_, channel| {
2652 let chan_res = channel.block_connected(header, height, txn_matched, indexes_of_txn_matched);
2653 if let Ok(Some(funding_locked)) = chan_res {
2654 pending_msg_events.push(events::MessageSendEvent::SendFundingLocked {
2655 node_id: channel.get_their_node_id(),
2656 msg: funding_locked,
2658 if let Some(announcement_sigs) = self.get_announcement_sigs(channel) {
2659 log_trace!(self, "Sending funding_locked and announcement_signatures for {}", log_bytes!(channel.channel_id()));
2660 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
2661 node_id: channel.get_their_node_id(),
2662 msg: announcement_sigs,
2665 log_trace!(self, "Sending funding_locked WITHOUT announcement_signatures for {}", log_bytes!(channel.channel_id()));
2667 short_to_id.insert(channel.get_short_channel_id().unwrap(), channel.channel_id());
2668 } else if let Err(e) = chan_res {
2669 pending_msg_events.push(events::MessageSendEvent::HandleError {
2670 node_id: channel.get_their_node_id(),
2671 action: msgs::ErrorAction::SendErrorMessage { msg: e },
2675 if let Some(funding_txo) = channel.get_funding_txo() {
2676 for tx in txn_matched {
2677 for inp in tx.input.iter() {
2678 if inp.previous_output == funding_txo.into_bitcoin_outpoint() {
2679 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()));
2680 if let Some(short_id) = channel.get_short_channel_id() {
2681 short_to_id.remove(&short_id);
2683 // It looks like our counterparty went on-chain. We go ahead and
2684 // broadcast our latest local state as well here, just in case its
2685 // some kind of SPV attack, though we expect these to be dropped.
2686 failed_channels.push(channel.force_shutdown());
2687 if let Ok(update) = self.get_channel_update(&channel) {
2688 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2697 if channel.is_funding_initiated() && channel.channel_monitor().would_broadcast_at_height(height) {
2698 if let Some(short_id) = channel.get_short_channel_id() {
2699 short_to_id.remove(&short_id);
2701 failed_channels.push(channel.force_shutdown());
2702 // If would_broadcast_at_height() is true, the channel_monitor will broadcast
2703 // the latest local tx for us, so we should skip that here (it doesn't really
2704 // hurt anything, but does make tests a bit simpler).
2705 failed_channels.last_mut().unwrap().0 = Vec::new();
2706 if let Ok(update) = self.get_channel_update(&channel) {
2707 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2716 for failure in failed_channels.drain(..) {
2717 self.finish_force_close_channel(failure);
2719 self.latest_block_height.store(height as usize, Ordering::Release);
2720 *self.last_block_hash.try_lock().expect("block_(dis)connected must not be called in parallel") = header_hash;
2723 /// We force-close the channel without letting our counterparty participate in the shutdown
2724 fn block_disconnected(&self, header: &BlockHeader, _: u32) {
2725 let _ = self.total_consistency_lock.read().unwrap();
2726 let mut failed_channels = Vec::new();
2728 let mut channel_lock = self.channel_state.lock().unwrap();
2729 let channel_state = &mut *channel_lock;
2730 let short_to_id = &mut channel_state.short_to_id;
2731 let pending_msg_events = &mut channel_state.pending_msg_events;
2732 channel_state.by_id.retain(|_, v| {
2733 if v.block_disconnected(header) {
2734 if let Some(short_id) = v.get_short_channel_id() {
2735 short_to_id.remove(&short_id);
2737 failed_channels.push(v.force_shutdown());
2738 if let Ok(update) = self.get_channel_update(&v) {
2739 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2749 for failure in failed_channels.drain(..) {
2750 self.finish_force_close_channel(failure);
2752 self.latest_block_height.fetch_sub(1, Ordering::AcqRel);
2753 *self.last_block_hash.try_lock().expect("block_(dis)connected must not be called in parallel") = header.bitcoin_hash();
2757 impl<ChanSigner: ChannelKeys, M: Deref + Sync + Send, T: Deref + Sync + Send, K: Deref + Sync + Send, F: Deref + Sync + Send>
2758 ChannelMessageHandler for ChannelManager<ChanSigner, M, T, K, F>
2759 where M::Target: ManyChannelMonitor<ChanSigner>,
2760 T::Target: BroadcasterInterface,
2761 K::Target: KeysInterface<ChanKeySigner = ChanSigner>,
2762 F::Target: FeeEstimator,
2764 fn handle_open_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::OpenChannel) {
2765 let _ = self.total_consistency_lock.read().unwrap();
2766 let res = self.internal_open_channel(their_node_id, their_features, 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_accept_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::AcceptChannel) {
2774 let _ = self.total_consistency_lock.read().unwrap();
2775 let res = self.internal_accept_channel(their_node_id, their_features, 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_created(&self, their_node_id: &PublicKey, msg: &msgs::FundingCreated) {
2783 let _ = self.total_consistency_lock.read().unwrap();
2784 let res = self.internal_funding_created(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_funding_signed(&self, their_node_id: &PublicKey, msg: &msgs::FundingSigned) {
2792 let _ = self.total_consistency_lock.read().unwrap();
2793 let res = self.internal_funding_signed(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_funding_locked(&self, their_node_id: &PublicKey, msg: &msgs::FundingLocked) {
2801 let _ = self.total_consistency_lock.read().unwrap();
2802 let res = self.internal_funding_locked(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_shutdown(&self, their_node_id: &PublicKey, msg: &msgs::Shutdown) {
2810 let _ = self.total_consistency_lock.read().unwrap();
2811 let res = self.internal_shutdown(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_closing_signed(&self, their_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
2819 let _ = self.total_consistency_lock.read().unwrap();
2820 let res = self.internal_closing_signed(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_add_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
2828 let _ = self.total_consistency_lock.read().unwrap();
2829 let res = self.internal_update_add_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_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
2837 let _ = self.total_consistency_lock.read().unwrap();
2838 let res = self.internal_update_fulfill_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_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
2846 let _ = self.total_consistency_lock.read().unwrap();
2847 let res = self.internal_update_fail_htlc(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_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
2855 let _ = self.total_consistency_lock.read().unwrap();
2856 let res = self.internal_update_fail_malformed_htlc(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_commitment_signed(&self, their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
2864 let _ = self.total_consistency_lock.read().unwrap();
2865 let res = self.internal_commitment_signed(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_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
2873 let _ = self.total_consistency_lock.read().unwrap();
2874 let res = self.internal_revoke_and_ack(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_update_fee(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFee) {
2882 let _ = self.total_consistency_lock.read().unwrap();
2883 let res = self.internal_update_fee(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 handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
2891 let _ = self.total_consistency_lock.read().unwrap();
2892 let res = self.internal_announcement_signatures(their_node_id, msg);
2894 let mut channel_state_lock = self.channel_state.lock().unwrap();
2895 let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2899 fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
2900 let _ = self.total_consistency_lock.read().unwrap();
2901 let res = self.internal_channel_reestablish(their_node_id, msg);
2903 let mut channel_state_lock = self.channel_state.lock().unwrap();
2904 let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2908 fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool) {
2909 let _ = self.total_consistency_lock.read().unwrap();
2910 let mut failed_channels = Vec::new();
2911 let mut failed_payments = Vec::new();
2912 let mut no_channels_remain = true;
2914 let mut channel_state_lock = self.channel_state.lock().unwrap();
2915 let channel_state = &mut *channel_state_lock;
2916 let short_to_id = &mut channel_state.short_to_id;
2917 let pending_msg_events = &mut channel_state.pending_msg_events;
2918 if no_connection_possible {
2919 log_debug!(self, "Failing all channels with {} due to no_connection_possible", log_pubkey!(their_node_id));
2920 channel_state.by_id.retain(|_, chan| {
2921 if chan.get_their_node_id() == *their_node_id {
2922 if let Some(short_id) = chan.get_short_channel_id() {
2923 short_to_id.remove(&short_id);
2925 failed_channels.push(chan.force_shutdown());
2926 if let Ok(update) = self.get_channel_update(&chan) {
2927 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2937 log_debug!(self, "Marking channels with {} disconnected and generating channel_updates", log_pubkey!(their_node_id));
2938 channel_state.by_id.retain(|_, chan| {
2939 if chan.get_their_node_id() == *their_node_id {
2940 let failed_adds = chan.remove_uncommitted_htlcs_and_mark_paused();
2941 chan.to_disabled_marked();
2942 if !failed_adds.is_empty() {
2943 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
2944 failed_payments.push((chan_update, failed_adds));
2946 if chan.is_shutdown() {
2947 if let Some(short_id) = chan.get_short_channel_id() {
2948 short_to_id.remove(&short_id);
2952 no_channels_remain = false;
2958 pending_msg_events.retain(|msg| {
2960 &events::MessageSendEvent::SendAcceptChannel { ref node_id, .. } => node_id != their_node_id,
2961 &events::MessageSendEvent::SendOpenChannel { ref node_id, .. } => node_id != their_node_id,
2962 &events::MessageSendEvent::SendFundingCreated { ref node_id, .. } => node_id != their_node_id,
2963 &events::MessageSendEvent::SendFundingSigned { ref node_id, .. } => node_id != their_node_id,
2964 &events::MessageSendEvent::SendFundingLocked { ref node_id, .. } => node_id != their_node_id,
2965 &events::MessageSendEvent::SendAnnouncementSignatures { ref node_id, .. } => node_id != their_node_id,
2966 &events::MessageSendEvent::UpdateHTLCs { ref node_id, .. } => node_id != their_node_id,
2967 &events::MessageSendEvent::SendRevokeAndACK { ref node_id, .. } => node_id != their_node_id,
2968 &events::MessageSendEvent::SendClosingSigned { ref node_id, .. } => node_id != their_node_id,
2969 &events::MessageSendEvent::SendShutdown { ref node_id, .. } => node_id != their_node_id,
2970 &events::MessageSendEvent::SendChannelReestablish { ref node_id, .. } => node_id != their_node_id,
2971 &events::MessageSendEvent::BroadcastChannelAnnouncement { .. } => true,
2972 &events::MessageSendEvent::BroadcastChannelUpdate { .. } => true,
2973 &events::MessageSendEvent::HandleError { ref node_id, .. } => node_id != their_node_id,
2974 &events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => true,
2978 if no_channels_remain {
2979 self.per_peer_state.write().unwrap().remove(their_node_id);
2982 for failure in failed_channels.drain(..) {
2983 self.finish_force_close_channel(failure);
2985 for (chan_update, mut htlc_sources) in failed_payments {
2986 for (htlc_source, payment_hash) in htlc_sources.drain(..) {
2987 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source, &payment_hash, HTLCFailReason::Reason { failure_code: 0x1000 | 7, data: chan_update.clone() });
2992 fn peer_connected(&self, their_node_id: &PublicKey, init_msg: &msgs::Init) {
2993 log_debug!(self, "Generating channel_reestablish events for {}", log_pubkey!(their_node_id));
2995 let _ = self.total_consistency_lock.read().unwrap();
2998 let mut peer_state_lock = self.per_peer_state.write().unwrap();
2999 match peer_state_lock.entry(their_node_id.clone()) {
3000 hash_map::Entry::Vacant(e) => {
3001 e.insert(Mutex::new(PeerState {
3002 latest_features: init_msg.features.clone(),
3005 hash_map::Entry::Occupied(e) => {
3006 e.get().lock().unwrap().latest_features = init_msg.features.clone();
3011 let mut channel_state_lock = self.channel_state.lock().unwrap();
3012 let channel_state = &mut *channel_state_lock;
3013 let pending_msg_events = &mut channel_state.pending_msg_events;
3014 channel_state.by_id.retain(|_, chan| {
3015 if chan.get_their_node_id() == *their_node_id {
3016 if !chan.have_received_message() {
3017 // If we created this (outbound) channel while we were disconnected from the
3018 // peer we probably failed to send the open_channel message, which is now
3019 // lost. We can't have had anything pending related to this channel, so we just
3023 pending_msg_events.push(events::MessageSendEvent::SendChannelReestablish {
3024 node_id: chan.get_their_node_id(),
3025 msg: chan.get_channel_reestablish(),
3031 //TODO: Also re-broadcast announcement_signatures
3034 fn handle_error(&self, their_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
3035 let _ = self.total_consistency_lock.read().unwrap();
3037 if msg.channel_id == [0; 32] {
3038 for chan in self.list_channels() {
3039 if chan.remote_network_id == *their_node_id {
3040 self.force_close_channel(&chan.channel_id);
3044 self.force_close_channel(&msg.channel_id);
3049 const SERIALIZATION_VERSION: u8 = 1;
3050 const MIN_SERIALIZATION_VERSION: u8 = 1;
3052 impl Writeable for PendingHTLCInfo {
3053 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3054 self.onion_packet.write(writer)?;
3055 self.incoming_shared_secret.write(writer)?;
3056 self.payment_hash.write(writer)?;
3057 self.short_channel_id.write(writer)?;
3058 self.amt_to_forward.write(writer)?;
3059 self.outgoing_cltv_value.write(writer)?;
3064 impl<R: ::std::io::Read> Readable<R> for PendingHTLCInfo {
3065 fn read(reader: &mut R) -> Result<PendingHTLCInfo, DecodeError> {
3066 Ok(PendingHTLCInfo {
3067 onion_packet: Readable::read(reader)?,
3068 incoming_shared_secret: Readable::read(reader)?,
3069 payment_hash: Readable::read(reader)?,
3070 short_channel_id: Readable::read(reader)?,
3071 amt_to_forward: Readable::read(reader)?,
3072 outgoing_cltv_value: Readable::read(reader)?,
3077 impl Writeable for HTLCFailureMsg {
3078 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3080 &HTLCFailureMsg::Relay(ref fail_msg) => {
3082 fail_msg.write(writer)?;
3084 &HTLCFailureMsg::Malformed(ref fail_msg) => {
3086 fail_msg.write(writer)?;
3093 impl<R: ::std::io::Read> Readable<R> for HTLCFailureMsg {
3094 fn read(reader: &mut R) -> Result<HTLCFailureMsg, DecodeError> {
3095 match <u8 as Readable<R>>::read(reader)? {
3096 0 => Ok(HTLCFailureMsg::Relay(Readable::read(reader)?)),
3097 1 => Ok(HTLCFailureMsg::Malformed(Readable::read(reader)?)),
3098 _ => Err(DecodeError::InvalidValue),
3103 impl Writeable for PendingHTLCStatus {
3104 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3106 &PendingHTLCStatus::Forward(ref forward_info) => {
3108 forward_info.write(writer)?;
3110 &PendingHTLCStatus::Fail(ref fail_msg) => {
3112 fail_msg.write(writer)?;
3119 impl<R: ::std::io::Read> Readable<R> for PendingHTLCStatus {
3120 fn read(reader: &mut R) -> Result<PendingHTLCStatus, DecodeError> {
3121 match <u8 as Readable<R>>::read(reader)? {
3122 0 => Ok(PendingHTLCStatus::Forward(Readable::read(reader)?)),
3123 1 => Ok(PendingHTLCStatus::Fail(Readable::read(reader)?)),
3124 _ => Err(DecodeError::InvalidValue),
3129 impl_writeable!(HTLCPreviousHopData, 0, {
3132 incoming_packet_shared_secret
3135 impl Writeable for HTLCSource {
3136 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3138 &HTLCSource::PreviousHopData(ref hop_data) => {
3140 hop_data.write(writer)?;
3142 &HTLCSource::OutboundRoute { ref route, ref session_priv, ref first_hop_htlc_msat } => {
3144 route.write(writer)?;
3145 session_priv.write(writer)?;
3146 first_hop_htlc_msat.write(writer)?;
3153 impl<R: ::std::io::Read> Readable<R> for HTLCSource {
3154 fn read(reader: &mut R) -> Result<HTLCSource, DecodeError> {
3155 match <u8 as Readable<R>>::read(reader)? {
3156 0 => Ok(HTLCSource::PreviousHopData(Readable::read(reader)?)),
3157 1 => Ok(HTLCSource::OutboundRoute {
3158 route: Readable::read(reader)?,
3159 session_priv: Readable::read(reader)?,
3160 first_hop_htlc_msat: Readable::read(reader)?,
3162 _ => Err(DecodeError::InvalidValue),
3167 impl Writeable for HTLCFailReason {
3168 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3170 &HTLCFailReason::LightningError { ref err } => {
3174 &HTLCFailReason::Reason { ref failure_code, ref data } => {
3176 failure_code.write(writer)?;
3177 data.write(writer)?;
3184 impl<R: ::std::io::Read> Readable<R> for HTLCFailReason {
3185 fn read(reader: &mut R) -> Result<HTLCFailReason, DecodeError> {
3186 match <u8 as Readable<R>>::read(reader)? {
3187 0 => Ok(HTLCFailReason::LightningError { err: Readable::read(reader)? }),
3188 1 => Ok(HTLCFailReason::Reason {
3189 failure_code: Readable::read(reader)?,
3190 data: Readable::read(reader)?,
3192 _ => Err(DecodeError::InvalidValue),
3197 impl Writeable for HTLCForwardInfo {
3198 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3200 &HTLCForwardInfo::AddHTLC { ref prev_short_channel_id, ref prev_htlc_id, ref forward_info } => {
3202 prev_short_channel_id.write(writer)?;
3203 prev_htlc_id.write(writer)?;
3204 forward_info.write(writer)?;
3206 &HTLCForwardInfo::FailHTLC { ref htlc_id, ref err_packet } => {
3208 htlc_id.write(writer)?;
3209 err_packet.write(writer)?;
3216 impl<R: ::std::io::Read> Readable<R> for HTLCForwardInfo {
3217 fn read(reader: &mut R) -> Result<HTLCForwardInfo, DecodeError> {
3218 match <u8 as Readable<R>>::read(reader)? {
3219 0 => Ok(HTLCForwardInfo::AddHTLC {
3220 prev_short_channel_id: Readable::read(reader)?,
3221 prev_htlc_id: Readable::read(reader)?,
3222 forward_info: Readable::read(reader)?,
3224 1 => Ok(HTLCForwardInfo::FailHTLC {
3225 htlc_id: Readable::read(reader)?,
3226 err_packet: Readable::read(reader)?,
3228 _ => Err(DecodeError::InvalidValue),
3233 impl<ChanSigner: ChannelKeys + Writeable, M: Deref, T: Deref, K: Deref, F: Deref> Writeable for ChannelManager<ChanSigner, M, T, K, F>
3234 where M::Target: ManyChannelMonitor<ChanSigner>,
3235 T::Target: BroadcasterInterface,
3236 K::Target: KeysInterface<ChanKeySigner = ChanSigner>,
3237 F::Target: FeeEstimator,
3239 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3240 let _ = self.total_consistency_lock.write().unwrap();
3242 writer.write_all(&[SERIALIZATION_VERSION; 1])?;
3243 writer.write_all(&[MIN_SERIALIZATION_VERSION; 1])?;
3245 self.genesis_hash.write(writer)?;
3246 (self.latest_block_height.load(Ordering::Acquire) as u32).write(writer)?;
3247 self.last_block_hash.lock().unwrap().write(writer)?;
3249 let channel_state = self.channel_state.lock().unwrap();
3250 let mut unfunded_channels = 0;
3251 for (_, channel) in channel_state.by_id.iter() {
3252 if !channel.is_funding_initiated() {
3253 unfunded_channels += 1;
3256 ((channel_state.by_id.len() - unfunded_channels) as u64).write(writer)?;
3257 for (_, channel) in channel_state.by_id.iter() {
3258 if channel.is_funding_initiated() {
3259 channel.write(writer)?;
3263 (channel_state.forward_htlcs.len() as u64).write(writer)?;
3264 for (short_channel_id, pending_forwards) in channel_state.forward_htlcs.iter() {
3265 short_channel_id.write(writer)?;
3266 (pending_forwards.len() as u64).write(writer)?;
3267 for forward in pending_forwards {
3268 forward.write(writer)?;
3272 (channel_state.claimable_htlcs.len() as u64).write(writer)?;
3273 for (payment_hash, previous_hops) in channel_state.claimable_htlcs.iter() {
3274 payment_hash.write(writer)?;
3275 (previous_hops.len() as u64).write(writer)?;
3276 for &(recvd_amt, ref previous_hop) in previous_hops.iter() {
3277 recvd_amt.write(writer)?;
3278 previous_hop.write(writer)?;
3282 let per_peer_state = self.per_peer_state.write().unwrap();
3283 (per_peer_state.len() as u64).write(writer)?;
3284 for (peer_pubkey, peer_state_mutex) in per_peer_state.iter() {
3285 peer_pubkey.write(writer)?;
3286 let peer_state = peer_state_mutex.lock().unwrap();
3287 peer_state.latest_features.write(writer)?;
3294 /// Arguments for the creation of a ChannelManager that are not deserialized.
3296 /// At a high-level, the process for deserializing a ChannelManager and resuming normal operation
3298 /// 1) Deserialize all stored ChannelMonitors.
3299 /// 2) Deserialize the ChannelManager by filling in this struct and calling <(Sha256dHash,
3300 /// ChannelManager)>::read(reader, args).
3301 /// This may result in closing some Channels if the ChannelMonitor is newer than the stored
3302 /// ChannelManager state to ensure no loss of funds. Thus, transactions may be broadcasted.
3303 /// 3) Register all relevant ChannelMonitor outpoints with your chain watch mechanism using
3304 /// ChannelMonitor::get_monitored_outpoints and ChannelMonitor::get_funding_txo().
3305 /// 4) Reconnect blocks on your ChannelMonitors.
3306 /// 5) Move the ChannelMonitors into your local ManyChannelMonitor.
3307 /// 6) Disconnect/connect blocks on the ChannelManager.
3308 /// 7) Register the new ChannelManager with your ChainWatchInterface.
3309 pub struct ChannelManagerReadArgs<'a, ChanSigner: 'a + ChannelKeys, M: Deref, T: Deref, K: Deref, F: Deref>
3310 where M::Target: ManyChannelMonitor<ChanSigner>,
3311 T::Target: BroadcasterInterface,
3312 K::Target: KeysInterface<ChanKeySigner = ChanSigner>,
3313 F::Target: FeeEstimator,
3316 /// The keys provider which will give us relevant keys. Some keys will be loaded during
3317 /// deserialization.
3318 pub keys_manager: K,
3320 /// The fee_estimator for use in the ChannelManager in the future.
3322 /// No calls to the FeeEstimator will be made during deserialization.
3323 pub fee_estimator: F,
3324 /// The ManyChannelMonitor for use in the ChannelManager in the future.
3326 /// No calls to the ManyChannelMonitor will be made during deserialization. It is assumed that
3327 /// you have deserialized ChannelMonitors separately and will add them to your
3328 /// ManyChannelMonitor after deserializing this ChannelManager.
3331 /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
3332 /// used to broadcast the latest local commitment transactions of channels which must be
3333 /// force-closed during deserialization.
3334 pub tx_broadcaster: T,
3335 /// The Logger for use in the ChannelManager and which may be used to log information during
3336 /// deserialization.
3337 pub logger: Arc<Logger>,
3338 /// Default settings used for new channels. Any existing channels will continue to use the
3339 /// runtime settings which were stored when the ChannelManager was serialized.
3340 pub default_config: UserConfig,
3342 /// A map from channel funding outpoints to ChannelMonitors for those channels (ie
3343 /// value.get_funding_txo() should be the key).
3345 /// If a monitor is inconsistent with the channel state during deserialization the channel will
3346 /// be force-closed using the data in the ChannelMonitor and the channel will be dropped. This
3347 /// is true for missing channels as well. If there is a monitor missing for which we find
3348 /// channel data Err(DecodeError::InvalidValue) will be returned.
3350 /// In such cases the latest local transactions will be sent to the tx_broadcaster included in
3352 pub channel_monitors: &'a mut HashMap<OutPoint, &'a mut ChannelMonitor<ChanSigner>>,
3355 impl<'a, R : ::std::io::Read, ChanSigner: ChannelKeys + Readable<R>, M: Deref, T: Deref, K: Deref, F: Deref>
3356 ReadableArgs<R, ChannelManagerReadArgs<'a, ChanSigner, M, T, K, F>> for (Sha256dHash, ChannelManager<ChanSigner, M, T, K, F>)
3357 where M::Target: ManyChannelMonitor<ChanSigner>,
3358 T::Target: BroadcasterInterface,
3359 K::Target: KeysInterface<ChanKeySigner = ChanSigner>,
3360 F::Target: FeeEstimator,
3362 fn read(reader: &mut R, args: ChannelManagerReadArgs<'a, ChanSigner, M, T, K, F>) -> Result<Self, DecodeError> {
3363 let _ver: u8 = Readable::read(reader)?;
3364 let min_ver: u8 = Readable::read(reader)?;
3365 if min_ver > SERIALIZATION_VERSION {
3366 return Err(DecodeError::UnknownVersion);
3369 let genesis_hash: Sha256dHash = Readable::read(reader)?;
3370 let latest_block_height: u32 = Readable::read(reader)?;
3371 let last_block_hash: Sha256dHash = Readable::read(reader)?;
3373 let mut closed_channels = Vec::new();
3375 let channel_count: u64 = Readable::read(reader)?;
3376 let mut funding_txo_set = HashSet::with_capacity(cmp::min(channel_count as usize, 128));
3377 let mut by_id = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
3378 let mut short_to_id = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
3379 for _ in 0..channel_count {
3380 let mut channel: Channel<ChanSigner> = ReadableArgs::read(reader, args.logger.clone())?;
3381 if channel.last_block_connected != Default::default() && channel.last_block_connected != last_block_hash {
3382 return Err(DecodeError::InvalidValue);
3385 let funding_txo = channel.get_funding_txo().ok_or(DecodeError::InvalidValue)?;
3386 funding_txo_set.insert(funding_txo.clone());
3387 if let Some(ref mut monitor) = args.channel_monitors.get_mut(&funding_txo) {
3388 if channel.get_cur_local_commitment_transaction_number() != monitor.get_cur_local_commitment_number() ||
3389 channel.get_revoked_remote_commitment_transaction_number() != monitor.get_min_seen_secret() ||
3390 channel.get_cur_remote_commitment_transaction_number() != monitor.get_cur_remote_commitment_number() ||
3391 channel.get_latest_monitor_update_id() != monitor.get_latest_update_id() {
3392 let mut force_close_res = channel.force_shutdown();
3393 force_close_res.0 = monitor.get_latest_local_commitment_txn();
3394 closed_channels.push(force_close_res);
3396 if let Some(short_channel_id) = channel.get_short_channel_id() {
3397 short_to_id.insert(short_channel_id, channel.channel_id());
3399 by_id.insert(channel.channel_id(), channel);
3402 return Err(DecodeError::InvalidValue);
3406 for (ref funding_txo, ref mut monitor) in args.channel_monitors.iter_mut() {
3407 if !funding_txo_set.contains(funding_txo) {
3408 closed_channels.push((monitor.get_latest_local_commitment_txn(), Vec::new()));
3412 let forward_htlcs_count: u64 = Readable::read(reader)?;
3413 let mut forward_htlcs = HashMap::with_capacity(cmp::min(forward_htlcs_count as usize, 128));
3414 for _ in 0..forward_htlcs_count {
3415 let short_channel_id = Readable::read(reader)?;
3416 let pending_forwards_count: u64 = Readable::read(reader)?;
3417 let mut pending_forwards = Vec::with_capacity(cmp::min(pending_forwards_count as usize, 128));
3418 for _ in 0..pending_forwards_count {
3419 pending_forwards.push(Readable::read(reader)?);
3421 forward_htlcs.insert(short_channel_id, pending_forwards);
3424 let claimable_htlcs_count: u64 = Readable::read(reader)?;
3425 let mut claimable_htlcs = HashMap::with_capacity(cmp::min(claimable_htlcs_count as usize, 128));
3426 for _ in 0..claimable_htlcs_count {
3427 let payment_hash = Readable::read(reader)?;
3428 let previous_hops_len: u64 = Readable::read(reader)?;
3429 let mut previous_hops = Vec::with_capacity(cmp::min(previous_hops_len as usize, 2));
3430 for _ in 0..previous_hops_len {
3431 previous_hops.push((Readable::read(reader)?, Readable::read(reader)?));
3433 claimable_htlcs.insert(payment_hash, previous_hops);
3436 let peer_count: u64 = Readable::read(reader)?;
3437 let mut per_peer_state = HashMap::with_capacity(cmp::min(peer_count as usize, 128));
3438 for _ in 0..peer_count {
3439 let peer_pubkey = Readable::read(reader)?;
3440 let peer_state = PeerState {
3441 latest_features: Readable::read(reader)?,
3443 per_peer_state.insert(peer_pubkey, Mutex::new(peer_state));
3446 let channel_manager = ChannelManager {
3448 fee_estimator: args.fee_estimator,
3449 monitor: args.monitor,
3450 tx_broadcaster: args.tx_broadcaster,
3452 latest_block_height: AtomicUsize::new(latest_block_height as usize),
3453 last_block_hash: Mutex::new(last_block_hash),
3454 secp_ctx: Secp256k1::new(),
3456 channel_state: Mutex::new(ChannelHolder {
3461 pending_msg_events: Vec::new(),
3463 our_network_key: args.keys_manager.get_node_secret(),
3465 per_peer_state: RwLock::new(per_peer_state),
3467 pending_events: Mutex::new(Vec::new()),
3468 total_consistency_lock: RwLock::new(()),
3469 keys_manager: args.keys_manager,
3470 logger: args.logger,
3471 default_configuration: args.default_config,
3474 for close_res in closed_channels.drain(..) {
3475 channel_manager.finish_force_close_channel(close_res);
3476 //TODO: Broadcast channel update for closed channels, but only after we've made a
3477 //connection or two.
3480 Ok((last_block_hash.clone(), channel_manager))