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;
34 use ln::msgs::LocalFeatures;
36 use ln::msgs::{ChannelMessageHandler, DecodeError, LightningError};
37 use chain::keysinterface::KeysInterface;
38 use util::config::UserConfig;
39 use util::{byte_utils, events};
40 use util::ser::{Readable, ReadableArgs, Writeable, Writer};
41 use util::chacha20::ChaCha20;
42 use util::logger::Logger;
43 use util::errors::APIError;
46 use std::collections::{HashMap, hash_map, HashSet};
48 use std::sync::{Arc, Mutex, MutexGuard, RwLock};
49 use std::sync::atomic::{AtomicUsize, Ordering};
50 use std::time::Duration;
52 // We hold various information about HTLC relay in the HTLC objects in Channel itself:
54 // Upon receipt of an HTLC from a peer, we'll give it a PendingHTLCStatus indicating if it should
55 // forward the HTLC with information it will give back to us when it does so, or if it should Fail
56 // the HTLC with the relevant message for the Channel to handle giving to the remote peer.
58 // When a Channel forwards an HTLC to its peer, it will give us back the PendingForwardHTLCInfo
59 // which we will use to construct an outbound HTLC, with a relevant HTLCSource::PreviousHopData
60 // filled in to indicate where it came from (which we can use to either fail-backwards or fulfill
61 // the HTLC backwards along the relevant path).
62 // Alternatively, we can fill an outbound HTLC with a HTLCSource::OutboundRoute indicating this is
63 // our payment, which we can use to decode errors or inform the user that the payment was sent.
64 /// Stores the info we will need to send when we want to forward an HTLC onwards
65 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
66 pub(super) struct PendingForwardHTLCInfo {
67 onion_packet: Option<msgs::OnionPacket>,
68 incoming_shared_secret: [u8; 32],
69 payment_hash: PaymentHash,
70 short_channel_id: u64,
71 pub(super) amt_to_forward: u64,
72 pub(super) outgoing_cltv_value: u32,
75 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
76 pub(super) enum HTLCFailureMsg {
77 Relay(msgs::UpdateFailHTLC),
78 Malformed(msgs::UpdateFailMalformedHTLC),
81 /// Stores whether we can't forward an HTLC or relevant forwarding info
82 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
83 pub(super) enum PendingHTLCStatus {
84 Forward(PendingForwardHTLCInfo),
88 /// Tracks the inbound corresponding to an outbound HTLC
89 #[derive(Clone, PartialEq)]
90 pub(super) struct HTLCPreviousHopData {
91 short_channel_id: u64,
93 incoming_packet_shared_secret: [u8; 32],
96 /// Tracks the inbound corresponding to an outbound HTLC
97 #[derive(Clone, PartialEq)]
98 pub(super) enum HTLCSource {
99 PreviousHopData(HTLCPreviousHopData),
102 session_priv: SecretKey,
103 /// Technically we can recalculate this from the route, but we cache it here to avoid
104 /// doing a double-pass on route when we get a failure back
105 first_hop_htlc_msat: u64,
110 pub fn dummy() -> Self {
111 HTLCSource::OutboundRoute {
112 route: Route { hops: Vec::new() },
113 session_priv: SecretKey::from_slice(&[1; 32]).unwrap(),
114 first_hop_htlc_msat: 0,
119 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
120 pub(super) enum HTLCFailReason {
122 err: msgs::OnionErrorPacket,
130 /// payment_hash type, use to cross-lock hop
131 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
132 pub struct PaymentHash(pub [u8;32]);
133 /// payment_preimage type, use to route payment between hop
134 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
135 pub struct PaymentPreimage(pub [u8;32]);
137 type ShutdownResult = (Vec<Transaction>, Vec<(HTLCSource, PaymentHash)>);
139 /// Error type returned across the channel_state mutex boundary. When an Err is generated for a
140 /// Channel, we generally end up with a ChannelError::Close for which we have to close the channel
141 /// immediately (ie with no further calls on it made). Thus, this step happens inside a
142 /// channel_state lock. We then return the set of things that need to be done outside the lock in
143 /// this struct and call handle_error!() on it.
145 struct MsgHandleErrInternal {
146 err: msgs::LightningError,
147 shutdown_finish: Option<(ShutdownResult, Option<msgs::ChannelUpdate>)>,
149 impl MsgHandleErrInternal {
151 fn send_err_msg_no_close(err: &'static str, channel_id: [u8; 32]) -> Self {
153 err: LightningError {
155 action: msgs::ErrorAction::SendErrorMessage {
156 msg: msgs::ErrorMessage {
158 data: err.to_string()
162 shutdown_finish: None,
166 fn ignore_no_close(err: &'static str) -> Self {
168 err: LightningError {
170 action: msgs::ErrorAction::IgnoreError,
172 shutdown_finish: None,
176 fn from_no_close(err: msgs::LightningError) -> Self {
177 Self { err, shutdown_finish: None }
180 fn from_finish_shutdown(err: &'static str, channel_id: [u8; 32], shutdown_res: ShutdownResult, channel_update: Option<msgs::ChannelUpdate>) -> Self {
182 err: LightningError {
184 action: msgs::ErrorAction::SendErrorMessage {
185 msg: msgs::ErrorMessage {
187 data: err.to_string()
191 shutdown_finish: Some((shutdown_res, channel_update)),
195 fn from_chan_no_close(err: ChannelError, channel_id: [u8; 32]) -> Self {
198 ChannelError::Ignore(msg) => LightningError {
200 action: msgs::ErrorAction::IgnoreError,
202 ChannelError::Close(msg) => LightningError {
204 action: msgs::ErrorAction::SendErrorMessage {
205 msg: msgs::ErrorMessage {
207 data: msg.to_string()
211 ChannelError::CloseDelayBroadcast { msg, .. } => LightningError {
213 action: msgs::ErrorAction::SendErrorMessage {
214 msg: msgs::ErrorMessage {
216 data: msg.to_string()
221 shutdown_finish: None,
226 /// We hold back HTLCs we intend to relay for a random interval greater than this (see
227 /// Event::PendingHTLCsForwardable for the API guidelines indicating how long should be waited).
228 /// This provides some limited amount of privacy. Ideally this would range from somewhere like one
229 /// second to 30 seconds, but people expect lightning to be, you know, kinda fast, sadly.
230 const MIN_HTLC_RELAY_HOLDING_CELL_MILLIS: u64 = 100;
232 pub(super) enum HTLCForwardInfo {
234 prev_short_channel_id: u64,
236 forward_info: PendingForwardHTLCInfo,
240 err_packet: msgs::OnionErrorPacket,
244 /// For events which result in both a RevokeAndACK and a CommitmentUpdate, by default they should
245 /// be sent in the order they appear in the return value, however sometimes the order needs to be
246 /// variable at runtime (eg Channel::channel_reestablish needs to re-send messages in the order
247 /// they were originally sent). In those cases, this enum is also returned.
248 #[derive(Clone, PartialEq)]
249 pub(super) enum RAACommitmentOrder {
250 /// Send the CommitmentUpdate messages first
252 /// Send the RevokeAndACK message first
256 // Note this is only exposed in cfg(test):
257 pub(super) struct ChannelHolder {
258 pub(super) by_id: HashMap<[u8; 32], Channel>,
259 pub(super) short_to_id: HashMap<u64, [u8; 32]>,
260 /// short channel id -> forward infos. Key of 0 means payments received
261 /// Note that while this is held in the same mutex as the channels themselves, no consistency
262 /// guarantees are made about the existence of a channel with the short id here, nor the short
263 /// ids in the PendingForwardHTLCInfo!
264 pub(super) forward_htlcs: HashMap<u64, Vec<HTLCForwardInfo>>,
265 /// payment_hash -> Vec<(amount_received, htlc_source)> for tracking things that were to us and
266 /// can be failed/claimed by the user
267 /// Note that while this is held in the same mutex as the channels themselves, no consistency
268 /// guarantees are made about the channels given here actually existing anymore by the time you
270 pub(super) claimable_htlcs: HashMap<PaymentHash, Vec<(u64, HTLCPreviousHopData)>>,
271 /// Messages to send to peers - pushed to in the same lock that they are generated in (except
272 /// for broadcast messages, where ordering isn't as strict).
273 pub(super) pending_msg_events: Vec<events::MessageSendEvent>,
275 pub(super) struct MutChannelHolder<'a> {
276 pub(super) by_id: &'a mut HashMap<[u8; 32], Channel>,
277 pub(super) short_to_id: &'a mut HashMap<u64, [u8; 32]>,
278 pub(super) forward_htlcs: &'a mut HashMap<u64, Vec<HTLCForwardInfo>>,
279 pub(super) claimable_htlcs: &'a mut HashMap<PaymentHash, Vec<(u64, HTLCPreviousHopData)>>,
280 pub(super) pending_msg_events: &'a mut Vec<events::MessageSendEvent>,
283 pub(super) fn borrow_parts(&mut self) -> MutChannelHolder {
285 by_id: &mut self.by_id,
286 short_to_id: &mut self.short_to_id,
287 forward_htlcs: &mut self.forward_htlcs,
288 claimable_htlcs: &mut self.claimable_htlcs,
289 pending_msg_events: &mut self.pending_msg_events,
294 #[cfg(not(any(target_pointer_width = "32", target_pointer_width = "64")))]
295 const ERR: () = "You need at least 32 bit pointers (well, usize, but we'll assume they're the same) for ChannelManager::latest_block_height";
297 /// Manager which keeps track of a number of channels and sends messages to the appropriate
298 /// channel, also tracking HTLC preimages and forwarding onion packets appropriately.
300 /// Implements ChannelMessageHandler, handling the multi-channel parts and passing things through
301 /// to individual Channels.
303 /// Implements Writeable to write out all channel state to disk. Implies peer_disconnected() for
304 /// all peers during write/read (though does not modify this instance, only the instance being
305 /// serialized). This will result in any channels which have not yet exchanged funding_created (ie
306 /// called funding_transaction_generated for outbound channels).
308 /// Note that you can be a bit lazier about writing out ChannelManager than you can be with
309 /// ChannelMonitors. With ChannelMonitors you MUST write each monitor update out to disk before
310 /// returning from ManyChannelMonitor::add_update_monitor, with ChannelManagers, writing updates
311 /// happens out-of-band (and will prevent any other ChannelManager operations from occurring during
312 /// the serialization process). If the deserialized version is out-of-date compared to the
313 /// ChannelMonitors passed by reference to read(), those channels will be force-closed based on the
314 /// ChannelMonitor state and no funds will be lost (mod on-chain transaction fees).
316 /// Note that the deserializer is only implemented for (Sha256dHash, ChannelManager), which
317 /// tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
318 /// the "reorg path" (ie call block_disconnected() until you get to a common block and then call
319 /// block_connected() to step towards your best block) upon deserialization before using the
322 /// Note that ChannelManager is responsible for tracking liveness of its channels and generating
323 /// ChannelUpdate messages informing peers that the channel is temporarily disabled. To avoid
324 /// spam due to quick disconnection/reconnection, updates are not sent until the channel has been
325 /// offline for a full minute. In order to track this, you must call
326 /// timer_chan_freshness_every_min roughly once per minute, though it doesn't have to be perfec.
327 pub struct ChannelManager<'a> {
328 default_configuration: UserConfig,
329 genesis_hash: Sha256dHash,
330 fee_estimator: Arc<FeeEstimator>,
331 monitor: Arc<ManyChannelMonitor + 'a>,
332 tx_broadcaster: Arc<BroadcasterInterface>,
335 pub(super) latest_block_height: AtomicUsize,
337 latest_block_height: AtomicUsize,
338 last_block_hash: Mutex<Sha256dHash>,
339 secp_ctx: Secp256k1<secp256k1::All>,
342 pub(super) channel_state: Mutex<ChannelHolder>,
344 channel_state: Mutex<ChannelHolder>,
345 our_network_key: SecretKey,
347 pending_events: Mutex<Vec<events::Event>>,
348 /// Used when we have to take a BIG lock to make sure everything is self-consistent.
349 /// Essentially just when we're serializing ourselves out.
350 /// Taken first everywhere where we are making changes before any other locks.
351 total_consistency_lock: RwLock<()>,
353 keys_manager: Arc<KeysInterface>,
358 /// The amount of time we require our counterparty wait to claim their money (ie time between when
359 /// we, or our watchtower, must check for them having broadcast a theft transaction).
360 pub(crate) const BREAKDOWN_TIMEOUT: u16 = 6 * 24;
361 /// The amount of time we're willing to wait to claim money back to us
362 pub(crate) const MAX_LOCAL_BREAKDOWN_TIMEOUT: u16 = 6 * 24 * 7;
364 /// The minimum number of blocks between an inbound HTLC's CLTV and the corresponding outbound
365 /// HTLC's CLTV. This should always be a few blocks greater than channelmonitor::CLTV_CLAIM_BUFFER,
366 /// ie the node we forwarded the payment on to should always have enough room to reliably time out
367 /// the HTLC via a full update_fail_htlc/commitment_signed dance before we hit the
368 /// CLTV_CLAIM_BUFFER point (we static assert that it's at least 3 blocks more).
369 const CLTV_EXPIRY_DELTA: u16 = 6 * 12; //TODO?
370 pub(super) const CLTV_FAR_FAR_AWAY: u32 = 6 * 24 * 7; //TODO?
372 // Check that our CLTV_EXPIRY is at least CLTV_CLAIM_BUFFER + ANTI_REORG_DELAY + LATENCY_GRACE_PERIOD_BLOCKS,
373 // ie that if the next-hop peer fails the HTLC within
374 // LATENCY_GRACE_PERIOD_BLOCKS then we'll still have CLTV_CLAIM_BUFFER left to timeout it onchain,
375 // then waiting ANTI_REORG_DELAY to be reorg-safe on the outbound HLTC and
376 // failing the corresponding htlc backward, and us now seeing the last block of ANTI_REORG_DELAY before
377 // LATENCY_GRACE_PERIOD_BLOCKS.
380 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;
382 // Check for ability of an attacker to make us fail on-chain by delaying inbound claim. See
383 // ChannelMontior::would_broadcast_at_height for a description of why this is needed.
386 const CHECK_CLTV_EXPIRY_SANITY_2: u32 = CLTV_EXPIRY_DELTA as u32 - LATENCY_GRACE_PERIOD_BLOCKS - 2*CLTV_CLAIM_BUFFER;
388 macro_rules! secp_call {
389 ( $res: expr, $err: expr ) => {
392 Err(_) => return Err($err),
397 /// Details of a channel, as returned by ChannelManager::list_channels and ChannelManager::list_usable_channels
398 pub struct ChannelDetails {
399 /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
400 /// thereafter this is the txid of the funding transaction xor the funding transaction output).
401 /// Note that this means this value is *not* persistent - it can change once during the
402 /// lifetime of the channel.
403 pub channel_id: [u8; 32],
404 /// The position of the funding transaction in the chain. None if the funding transaction has
405 /// not yet been confirmed and the channel fully opened.
406 pub short_channel_id: Option<u64>,
407 /// The node_id of our counterparty
408 pub remote_network_id: PublicKey,
409 /// The value, in satoshis, of this channel as appears in the funding output
410 pub channel_value_satoshis: u64,
411 /// The user_id passed in to create_channel, or 0 if the channel was inbound.
413 /// The available outbound capacity for sending HTLCs to the remote peer. This does not include
414 /// any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
415 /// available for inclusion in new outbound HTLCs). This further does not include any pending
416 /// outgoing HTLCs which are awaiting some other resolution to be sent.
417 pub outbound_capacity_msat: u64,
418 /// The available inbound capacity for the remote peer to send HTLCs to us. This does not
419 /// include any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
420 /// available for inclusion in new inbound HTLCs).
421 /// Note that there are some corner cases not fully handled here, so the actual available
422 /// inbound capacity may be slightly higher than this.
423 pub inbound_capacity_msat: u64,
424 /// True if the channel is (a) confirmed and funding_locked messages have been exchanged, (b)
425 /// the peer is connected, and (c) no monitor update failure is pending resolution.
429 macro_rules! handle_error {
430 ($self: ident, $internal: expr) => {
433 Err(MsgHandleErrInternal { err, shutdown_finish }) => {
434 if let Some((shutdown_res, update_option)) = shutdown_finish {
435 $self.finish_force_close_channel(shutdown_res);
436 if let Some(update) = update_option {
437 let mut channel_state = $self.channel_state.lock().unwrap();
438 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
449 macro_rules! break_chan_entry {
450 ($self: ident, $res: expr, $channel_state: expr, $entry: expr) => {
453 Err(ChannelError::Ignore(msg)) => {
454 break Err(MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore(msg), $entry.key().clone()))
456 Err(ChannelError::Close(msg)) => {
457 log_trace!($self, "Closing channel {} due to Close-required error: {}", log_bytes!($entry.key()[..]), msg);
458 let (channel_id, mut chan) = $entry.remove_entry();
459 if let Some(short_id) = chan.get_short_channel_id() {
460 $channel_state.short_to_id.remove(&short_id);
462 break Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, chan.force_shutdown(), $self.get_channel_update(&chan).ok()))
464 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"); }
469 macro_rules! try_chan_entry {
470 ($self: ident, $res: expr, $channel_state: expr, $entry: expr) => {
473 Err(ChannelError::Ignore(msg)) => {
474 return Err(MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore(msg), $entry.key().clone()))
476 Err(ChannelError::Close(msg)) => {
477 log_trace!($self, "Closing channel {} due to Close-required error: {}", log_bytes!($entry.key()[..]), msg);
478 let (channel_id, mut chan) = $entry.remove_entry();
479 if let Some(short_id) = chan.get_short_channel_id() {
480 $channel_state.short_to_id.remove(&short_id);
482 return Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, chan.force_shutdown(), $self.get_channel_update(&chan).ok()))
484 Err(ChannelError::CloseDelayBroadcast { msg, update }) => {
485 log_error!($self, "Channel {} need to be shutdown but closing transactions not broadcast due to {}", log_bytes!($entry.key()[..]), msg);
486 let (channel_id, mut chan) = $entry.remove_entry();
487 if let Some(short_id) = chan.get_short_channel_id() {
488 $channel_state.short_to_id.remove(&short_id);
490 if let Some(update) = update {
491 if let Err(e) = $self.monitor.add_update_monitor(update.get_funding_txo().unwrap(), update) {
493 // Upstream channel is dead, but we want at least to fail backward HTLCs to save
494 // downstream channels. In case of PermanentFailure, we are not going to be able
495 // to claim back to_remote output on remote commitment transaction. Doesn't
496 // make a difference here, we are concern about HTLCs circuit, not onchain funds.
497 ChannelMonitorUpdateErr::PermanentFailure => {},
498 ChannelMonitorUpdateErr::TemporaryFailure => {},
502 let mut shutdown_res = chan.force_shutdown();
503 if shutdown_res.0.len() >= 1 {
504 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());
506 shutdown_res.0.clear();
507 return Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, shutdown_res, $self.get_channel_update(&chan).ok()))
513 macro_rules! handle_monitor_err {
514 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
515 handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment, Vec::new(), Vec::new())
517 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr, $failed_forwards: expr, $failed_fails: expr) => {
519 ChannelMonitorUpdateErr::PermanentFailure => {
520 log_error!($self, "Closing channel {} due to monitor update PermanentFailure", log_bytes!($entry.key()[..]));
521 let (channel_id, mut chan) = $entry.remove_entry();
522 if let Some(short_id) = chan.get_short_channel_id() {
523 $channel_state.short_to_id.remove(&short_id);
525 // TODO: $failed_fails is dropped here, which will cause other channels to hit the
526 // chain in a confused state! We need to move them into the ChannelMonitor which
527 // will be responsible for failing backwards once things confirm on-chain.
528 // It's ok that we drop $failed_forwards here - at this point we'd rather they
529 // broadcast HTLC-Timeout and pay the associated fees to get their funds back than
530 // us bother trying to claim it just to forward on to another peer. If we're
531 // splitting hairs we'd prefer to claim payments that were to us, but we haven't
532 // given up the preimage yet, so might as well just wait until the payment is
533 // retried, avoiding the on-chain fees.
534 let res: Result<(), _> = Err(MsgHandleErrInternal::from_finish_shutdown("ChannelMonitor storage failure", channel_id, chan.force_shutdown(), $self.get_channel_update(&chan).ok()));
537 ChannelMonitorUpdateErr::TemporaryFailure => {
538 log_info!($self, "Disabling channel {} due to monitor update TemporaryFailure. On restore will send {} and process {} forwards and {} fails",
539 log_bytes!($entry.key()[..]),
540 if $resend_commitment && $resend_raa {
542 RAACommitmentOrder::CommitmentFirst => { "commitment then RAA" },
543 RAACommitmentOrder::RevokeAndACKFirst => { "RAA then commitment" },
545 } else if $resend_commitment { "commitment" }
546 else if $resend_raa { "RAA" }
548 (&$failed_forwards as &Vec<(PendingForwardHTLCInfo, u64)>).len(),
549 (&$failed_fails as &Vec<(HTLCSource, PaymentHash, HTLCFailReason)>).len());
550 if !$resend_commitment {
551 debug_assert!($action_type == RAACommitmentOrder::RevokeAndACKFirst || !$resend_raa);
554 debug_assert!($action_type == RAACommitmentOrder::CommitmentFirst || !$resend_commitment);
556 $entry.get_mut().monitor_update_failed($resend_raa, $resend_commitment, $failed_forwards, $failed_fails);
557 Err(MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore("Failed to update ChannelMonitor"), *$entry.key()))
563 macro_rules! return_monitor_err {
564 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
565 return handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment);
567 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr, $failed_forwards: expr, $failed_fails: expr) => {
568 return handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment, $failed_forwards, $failed_fails);
572 // Does not break in case of TemporaryFailure!
573 macro_rules! maybe_break_monitor_err {
574 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
575 match (handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment), $err) {
576 (e, ChannelMonitorUpdateErr::PermanentFailure) => {
579 (_, ChannelMonitorUpdateErr::TemporaryFailure) => { },
584 impl<'a> ChannelManager<'a> {
585 /// Constructs a new ChannelManager to hold several channels and route between them.
587 /// This is the main "logic hub" for all channel-related actions, and implements
588 /// ChannelMessageHandler.
590 /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
592 /// panics if channel_value_satoshis is >= `MAX_FUNDING_SATOSHIS`!
594 /// Users must provide the current blockchain height from which to track onchain channel
595 /// funding outpoints and send payments with reliable timelocks.
597 /// Users need to notify the new ChannelManager when a new block is connected or
598 /// disconnected using its `block_connected` and `block_disconnected` methods.
599 /// However, rather than calling these methods directly, the user should register
600 /// the ChannelManager as a listener to the BlockNotifier and call the BlockNotifier's
601 /// `block_(dis)connected` methods, which will notify all registered listeners in one
603 pub fn new(network: Network, feeest: Arc<FeeEstimator>, monitor: Arc<ManyChannelMonitor + 'a>, tx_broadcaster: Arc<BroadcasterInterface>, logger: Arc<Logger>,keys_manager: Arc<KeysInterface>, config: UserConfig, current_blockchain_height: usize) -> Result<Arc<ChannelManager<'a>>, secp256k1::Error> {
604 let secp_ctx = Secp256k1::new();
606 let res = Arc::new(ChannelManager {
607 default_configuration: config.clone(),
608 genesis_hash: genesis_block(network).header.bitcoin_hash(),
609 fee_estimator: feeest.clone(),
610 monitor: monitor.clone(),
613 latest_block_height: AtomicUsize::new(current_blockchain_height),
614 last_block_hash: Mutex::new(Default::default()),
617 channel_state: Mutex::new(ChannelHolder{
618 by_id: HashMap::new(),
619 short_to_id: HashMap::new(),
620 forward_htlcs: HashMap::new(),
621 claimable_htlcs: HashMap::new(),
622 pending_msg_events: Vec::new(),
624 our_network_key: keys_manager.get_node_secret(),
626 pending_events: Mutex::new(Vec::new()),
627 total_consistency_lock: RwLock::new(()),
637 /// Creates a new outbound channel to the given remote node and with the given value.
639 /// user_id will be provided back as user_channel_id in FundingGenerationReady and
640 /// FundingBroadcastSafe events to allow tracking of which events correspond with which
641 /// create_channel call. Note that user_channel_id defaults to 0 for inbound channels, so you
642 /// may wish to avoid using 0 for user_id here.
644 /// If successful, will generate a SendOpenChannel message event, so you should probably poll
645 /// PeerManager::process_events afterwards.
647 /// Raises APIError::APIMisuseError when channel_value_satoshis > 2**24 or push_msat is
648 /// greater than channel_value_satoshis * 1k or channel_value_satoshis is < 1000.
649 pub fn create_channel(&self, their_network_key: PublicKey, channel_value_satoshis: u64, push_msat: u64, user_id: u64) -> Result<(), APIError> {
650 if channel_value_satoshis < 1000 {
651 return Err(APIError::APIMisuseError { err: "channel_value must be at least 1000 satoshis" });
654 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)?;
655 let res = channel.get_open_channel(self.genesis_hash.clone(), &*self.fee_estimator);
657 let _ = self.total_consistency_lock.read().unwrap();
658 let mut channel_state = self.channel_state.lock().unwrap();
659 match channel_state.by_id.entry(channel.channel_id()) {
660 hash_map::Entry::Occupied(_) => {
661 if cfg!(feature = "fuzztarget") {
662 return Err(APIError::APIMisuseError { err: "Fuzzy bad RNG" });
664 panic!("RNG is bad???");
667 hash_map::Entry::Vacant(entry) => { entry.insert(channel); }
669 channel_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
670 node_id: their_network_key,
676 /// Gets the list of open channels, in random order. See ChannelDetail field documentation for
677 /// more information.
678 pub fn list_channels(&self) -> Vec<ChannelDetails> {
679 let channel_state = self.channel_state.lock().unwrap();
680 let mut res = Vec::with_capacity(channel_state.by_id.len());
681 for (channel_id, channel) in channel_state.by_id.iter() {
682 let (inbound_capacity_msat, outbound_capacity_msat) = channel.get_inbound_outbound_available_balance_msat();
683 res.push(ChannelDetails {
684 channel_id: (*channel_id).clone(),
685 short_channel_id: channel.get_short_channel_id(),
686 remote_network_id: channel.get_their_node_id(),
687 channel_value_satoshis: channel.get_value_satoshis(),
688 inbound_capacity_msat,
689 outbound_capacity_msat,
690 user_id: channel.get_user_id(),
691 is_live: channel.is_live(),
697 /// Gets the list of usable channels, in random order. Useful as an argument to
698 /// Router::get_route to ensure non-announced channels are used.
700 /// These are guaranteed to have their is_live value set to true, see the documentation for
701 /// ChannelDetails::is_live for more info on exactly what the criteria are.
702 pub fn list_usable_channels(&self) -> Vec<ChannelDetails> {
703 let channel_state = self.channel_state.lock().unwrap();
704 let mut res = Vec::with_capacity(channel_state.by_id.len());
705 for (channel_id, channel) in channel_state.by_id.iter() {
706 // Note we use is_live here instead of usable which leads to somewhat confused
707 // internal/external nomenclature, but that's ok cause that's probably what the user
708 // really wanted anyway.
709 if channel.is_live() {
710 let (inbound_capacity_msat, outbound_capacity_msat) = channel.get_inbound_outbound_available_balance_msat();
711 res.push(ChannelDetails {
712 channel_id: (*channel_id).clone(),
713 short_channel_id: channel.get_short_channel_id(),
714 remote_network_id: channel.get_their_node_id(),
715 channel_value_satoshis: channel.get_value_satoshis(),
716 inbound_capacity_msat,
717 outbound_capacity_msat,
718 user_id: channel.get_user_id(),
726 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
727 /// will be accepted on the given channel, and after additional timeout/the closing of all
728 /// pending HTLCs, the channel will be closed on chain.
730 /// May generate a SendShutdown message event on success, which should be relayed.
731 pub fn close_channel(&self, channel_id: &[u8; 32]) -> Result<(), APIError> {
732 let _ = self.total_consistency_lock.read().unwrap();
734 let (mut failed_htlcs, chan_option) = {
735 let mut channel_state_lock = self.channel_state.lock().unwrap();
736 let channel_state = channel_state_lock.borrow_parts();
737 match channel_state.by_id.entry(channel_id.clone()) {
738 hash_map::Entry::Occupied(mut chan_entry) => {
739 let (shutdown_msg, failed_htlcs) = chan_entry.get_mut().get_shutdown()?;
740 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
741 node_id: chan_entry.get().get_their_node_id(),
744 if chan_entry.get().is_shutdown() {
745 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
746 channel_state.short_to_id.remove(&short_id);
748 (failed_htlcs, Some(chan_entry.remove_entry().1))
749 } else { (failed_htlcs, None) }
751 hash_map::Entry::Vacant(_) => return Err(APIError::ChannelUnavailable{err: "No such channel"})
754 for htlc_source in failed_htlcs.drain(..) {
755 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() });
757 let chan_update = if let Some(chan) = chan_option {
758 if let Ok(update) = self.get_channel_update(&chan) {
763 if let Some(update) = chan_update {
764 let mut channel_state = self.channel_state.lock().unwrap();
765 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
774 fn finish_force_close_channel(&self, shutdown_res: ShutdownResult) {
775 let (local_txn, mut failed_htlcs) = shutdown_res;
776 log_trace!(self, "Finishing force-closure of channel with {} transactions to broadcast and {} HTLCs to fail", local_txn.len(), failed_htlcs.len());
777 for htlc_source in failed_htlcs.drain(..) {
778 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() });
780 for tx in local_txn {
781 log_trace!(self, "Broadcast onchain {}", log_tx!(tx));
782 self.tx_broadcaster.broadcast_transaction(&tx);
786 /// Force closes a channel, immediately broadcasting the latest local commitment transaction to
787 /// the chain and rejecting new HTLCs on the given channel.
788 pub fn force_close_channel(&self, channel_id: &[u8; 32]) {
789 let _ = self.total_consistency_lock.read().unwrap();
792 let mut channel_state_lock = self.channel_state.lock().unwrap();
793 let channel_state = channel_state_lock.borrow_parts();
794 if let Some(chan) = channel_state.by_id.remove(channel_id) {
795 if let Some(short_id) = chan.get_short_channel_id() {
796 channel_state.short_to_id.remove(&short_id);
803 log_trace!(self, "Force-closing channel {}", log_bytes!(channel_id[..]));
804 self.finish_force_close_channel(chan.force_shutdown());
805 if let Ok(update) = self.get_channel_update(&chan) {
806 let mut channel_state = self.channel_state.lock().unwrap();
807 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
813 /// Force close all channels, immediately broadcasting the latest local commitment transaction
814 /// for each to the chain and rejecting new HTLCs on each.
815 pub fn force_close_all_channels(&self) {
816 for chan in self.list_channels() {
817 self.force_close_channel(&chan.channel_id);
821 const ZERO:[u8; 65] = [0; 65];
822 fn decode_update_add_htlc_onion(&self, msg: &msgs::UpdateAddHTLC) -> (PendingHTLCStatus, MutexGuard<ChannelHolder>) {
823 macro_rules! return_malformed_err {
824 ($msg: expr, $err_code: expr) => {
826 log_info!(self, "Failed to accept/forward incoming HTLC: {}", $msg);
827 return (PendingHTLCStatus::Fail(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
828 channel_id: msg.channel_id,
829 htlc_id: msg.htlc_id,
830 sha256_of_onion: Sha256::hash(&msg.onion_routing_packet.hop_data).into_inner(),
831 failure_code: $err_code,
832 })), self.channel_state.lock().unwrap());
837 if let Err(_) = msg.onion_routing_packet.public_key {
838 return_malformed_err!("invalid ephemeral pubkey", 0x8000 | 0x4000 | 6);
841 let shared_secret = {
842 let mut arr = [0; 32];
843 arr.copy_from_slice(&SharedSecret::new(&msg.onion_routing_packet.public_key.unwrap(), &self.our_network_key)[..]);
846 let (rho, mu) = onion_utils::gen_rho_mu_from_shared_secret(&shared_secret);
848 if msg.onion_routing_packet.version != 0 {
849 //TODO: Spec doesn't indicate if we should only hash hop_data here (and in other
850 //sha256_of_onion error data packets), or the entire onion_routing_packet. Either way,
851 //the hash doesn't really serve any purpose - in the case of hashing all data, the
852 //receiving node would have to brute force to figure out which version was put in the
853 //packet by the node that send us the message, in the case of hashing the hop_data, the
854 //node knows the HMAC matched, so they already know what is there...
855 return_malformed_err!("Unknown onion packet version", 0x8000 | 0x4000 | 4);
858 let mut hmac = HmacEngine::<Sha256>::new(&mu);
859 hmac.input(&msg.onion_routing_packet.hop_data);
860 hmac.input(&msg.payment_hash.0[..]);
861 if !fixed_time_eq(&Hmac::from_engine(hmac).into_inner(), &msg.onion_routing_packet.hmac) {
862 return_malformed_err!("HMAC Check failed", 0x8000 | 0x4000 | 5);
865 let mut channel_state = None;
866 macro_rules! return_err {
867 ($msg: expr, $err_code: expr, $data: expr) => {
869 log_info!(self, "Failed to accept/forward incoming HTLC: {}", $msg);
870 if channel_state.is_none() {
871 channel_state = Some(self.channel_state.lock().unwrap());
873 return (PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
874 channel_id: msg.channel_id,
875 htlc_id: msg.htlc_id,
876 reason: onion_utils::build_first_hop_failure_packet(&shared_secret, $err_code, $data),
877 })), channel_state.unwrap());
882 let mut chacha = ChaCha20::new(&rho, &[0u8; 8]);
883 let next_hop_data = {
884 let mut decoded = [0; 65];
885 chacha.process(&msg.onion_routing_packet.hop_data[0..65], &mut decoded);
886 match msgs::OnionHopData::read(&mut Cursor::new(&decoded[..])) {
888 let error_code = match err {
889 msgs::DecodeError::UnknownVersion => 0x4000 | 1, // unknown realm byte
890 _ => 0x2000 | 2, // Should never happen
892 return_err!("Unable to decode our hop data", error_code, &[0;0]);
898 let pending_forward_info = if next_hop_data.hmac == [0; 32] {
901 // In tests, make sure that the initial onion pcket data is, at least, non-0.
902 // We could do some fancy randomness test here, but, ehh, whatever.
903 // This checks for the issue where you can calculate the path length given the
904 // onion data as all the path entries that the originator sent will be here
905 // as-is (and were originally 0s).
906 // Of course reverse path calculation is still pretty easy given naive routing
907 // algorithms, but this fixes the most-obvious case.
908 let mut new_packet_data = [0; 19*65];
909 chacha.process(&msg.onion_routing_packet.hop_data[65..], &mut new_packet_data[0..19*65]);
910 assert_ne!(new_packet_data[0..65], [0; 65][..]);
911 assert_ne!(new_packet_data[..], [0; 19*65][..]);
915 // final_expiry_too_soon
916 if (msg.cltv_expiry as u64) < self.latest_block_height.load(Ordering::Acquire) as u64 + (CLTV_CLAIM_BUFFER + LATENCY_GRACE_PERIOD_BLOCKS) as u64 {
917 return_err!("The final CLTV expiry is too soon to handle", 17, &[0;0]);
919 // final_incorrect_htlc_amount
920 if next_hop_data.data.amt_to_forward > msg.amount_msat {
921 return_err!("Upstream node sent less than we were supposed to receive in payment", 19, &byte_utils::be64_to_array(msg.amount_msat));
923 // final_incorrect_cltv_expiry
924 if next_hop_data.data.outgoing_cltv_value != msg.cltv_expiry {
925 return_err!("Upstream node set CLTV to the wrong value", 18, &byte_utils::be32_to_array(msg.cltv_expiry));
928 // Note that we could obviously respond immediately with an update_fulfill_htlc
929 // message, however that would leak that we are the recipient of this payment, so
930 // instead we stay symmetric with the forwarding case, only responding (after a
931 // delay) once they've send us a commitment_signed!
933 PendingHTLCStatus::Forward(PendingForwardHTLCInfo {
935 payment_hash: msg.payment_hash.clone(),
937 incoming_shared_secret: shared_secret,
938 amt_to_forward: next_hop_data.data.amt_to_forward,
939 outgoing_cltv_value: next_hop_data.data.outgoing_cltv_value,
942 let mut new_packet_data = [0; 20*65];
943 chacha.process(&msg.onion_routing_packet.hop_data[65..], &mut new_packet_data[0..19*65]);
944 chacha.process(&ChannelManager::ZERO[..], &mut new_packet_data[19*65..]);
946 let mut new_pubkey = msg.onion_routing_packet.public_key.unwrap();
948 let blinding_factor = {
949 let mut sha = Sha256::engine();
950 sha.input(&new_pubkey.serialize()[..]);
951 sha.input(&shared_secret);
952 Sha256::from_engine(sha).into_inner()
955 let public_key = if let Err(e) = new_pubkey.mul_assign(&self.secp_ctx, &blinding_factor[..]) {
957 } else { Ok(new_pubkey) };
959 let outgoing_packet = msgs::OnionPacket {
962 hop_data: new_packet_data,
963 hmac: next_hop_data.hmac.clone(),
966 PendingHTLCStatus::Forward(PendingForwardHTLCInfo {
967 onion_packet: Some(outgoing_packet),
968 payment_hash: msg.payment_hash.clone(),
969 short_channel_id: next_hop_data.data.short_channel_id,
970 incoming_shared_secret: shared_secret,
971 amt_to_forward: next_hop_data.data.amt_to_forward,
972 outgoing_cltv_value: next_hop_data.data.outgoing_cltv_value,
976 channel_state = Some(self.channel_state.lock().unwrap());
977 if let &PendingHTLCStatus::Forward(PendingForwardHTLCInfo { ref onion_packet, ref short_channel_id, ref amt_to_forward, ref outgoing_cltv_value, .. }) = &pending_forward_info {
978 if onion_packet.is_some() { // If short_channel_id is 0 here, we'll reject them in the body here
979 let id_option = channel_state.as_ref().unwrap().short_to_id.get(&short_channel_id).cloned();
980 let forwarding_id = match id_option {
981 None => { // unknown_next_peer
982 return_err!("Don't have available channel for forwarding as requested.", 0x4000 | 10, &[0;0]);
984 Some(id) => id.clone(),
986 if let Some((err, code, chan_update)) = loop {
987 let chan = channel_state.as_mut().unwrap().by_id.get_mut(&forwarding_id).unwrap();
989 // Note that we could technically not return an error yet here and just hope
990 // that the connection is reestablished or monitor updated by the time we get
991 // around to doing the actual forward, but better to fail early if we can and
992 // hopefully an attacker trying to path-trace payments cannot make this occur
993 // on a small/per-node/per-channel scale.
994 if !chan.is_live() { // channel_disabled
995 break Some(("Forwarding channel is not in a ready state.", 0x1000 | 20, Some(self.get_channel_update(chan).unwrap())));
997 if *amt_to_forward < chan.get_their_htlc_minimum_msat() { // amount_below_minimum
998 break Some(("HTLC amount was below the htlc_minimum_msat", 0x1000 | 11, Some(self.get_channel_update(chan).unwrap())));
1000 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) });
1001 if fee.is_none() || msg.amount_msat < fee.unwrap() || (msg.amount_msat - fee.unwrap()) < *amt_to_forward { // fee_insufficient
1002 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())));
1004 if (msg.cltv_expiry as u64) < (*outgoing_cltv_value) as u64 + CLTV_EXPIRY_DELTA as u64 { // incorrect_cltv_expiry
1005 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())));
1007 let cur_height = self.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1008 // We want to have at least LATENCY_GRACE_PERIOD_BLOCKS to fail prior to going on chain CLAIM_BUFFER blocks before expiration
1009 if msg.cltv_expiry <= cur_height + CLTV_CLAIM_BUFFER + LATENCY_GRACE_PERIOD_BLOCKS as u32 { // expiry_too_soon
1010 break Some(("CLTV expiry is too close", 0x1000 | 14, Some(self.get_channel_update(chan).unwrap())));
1012 if msg.cltv_expiry > cur_height + CLTV_FAR_FAR_AWAY as u32 { // expiry_too_far
1013 break Some(("CLTV expiry is too far in the future", 21, None));
1018 let mut res = Vec::with_capacity(8 + 128);
1019 if let Some(chan_update) = chan_update {
1020 if code == 0x1000 | 11 || code == 0x1000 | 12 {
1021 res.extend_from_slice(&byte_utils::be64_to_array(msg.amount_msat));
1023 else if code == 0x1000 | 13 {
1024 res.extend_from_slice(&byte_utils::be32_to_array(msg.cltv_expiry));
1026 else if code == 0x1000 | 20 {
1027 res.extend_from_slice(&byte_utils::be16_to_array(chan_update.contents.flags));
1029 res.extend_from_slice(&chan_update.encode_with_len()[..]);
1031 return_err!(err, code, &res[..]);
1036 (pending_forward_info, channel_state.unwrap())
1039 /// only fails if the channel does not yet have an assigned short_id
1040 /// May be called with channel_state already locked!
1041 fn get_channel_update(&self, chan: &Channel) -> Result<msgs::ChannelUpdate, LightningError> {
1042 let short_channel_id = match chan.get_short_channel_id() {
1043 None => return Err(LightningError{err: "Channel not yet established", action: msgs::ErrorAction::IgnoreError}),
1047 let were_node_one = PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key).serialize()[..] < chan.get_their_node_id().serialize()[..];
1049 let unsigned = msgs::UnsignedChannelUpdate {
1050 chain_hash: self.genesis_hash,
1051 short_channel_id: short_channel_id,
1052 timestamp: chan.get_channel_update_count(),
1053 flags: (!were_node_one) as u16 | ((!chan.is_live() as u16) << 1),
1054 cltv_expiry_delta: CLTV_EXPIRY_DELTA,
1055 htlc_minimum_msat: chan.get_our_htlc_minimum_msat(),
1056 fee_base_msat: chan.get_our_fee_base_msat(&*self.fee_estimator),
1057 fee_proportional_millionths: chan.get_fee_proportional_millionths(),
1058 excess_data: Vec::new(),
1061 let msg_hash = Sha256dHash::hash(&unsigned.encode()[..]);
1062 let sig = self.secp_ctx.sign(&hash_to_message!(&msg_hash[..]), &self.our_network_key);
1064 Ok(msgs::ChannelUpdate {
1070 /// Sends a payment along a given route.
1072 /// Value parameters are provided via the last hop in route, see documentation for RouteHop
1073 /// fields for more info.
1075 /// Note that if the payment_hash already exists elsewhere (eg you're sending a duplicative
1076 /// payment), we don't do anything to stop you! We always try to ensure that if the provided
1077 /// next hop knows the preimage to payment_hash they can claim an additional amount as
1078 /// specified in the last hop in the route! Thus, you should probably do your own
1079 /// payment_preimage tracking (which you should already be doing as they represent "proof of
1080 /// payment") and prevent double-sends yourself.
1082 /// May generate a SendHTLCs message event on success, which should be relayed.
1084 /// Raises APIError::RoutError when invalid route or forward parameter
1085 /// (cltv_delta, fee, node public key) is specified.
1086 /// Raises APIError::ChannelUnavailable if the next-hop channel is not available for updates
1087 /// (including due to previous monitor update failure or new permanent monitor update failure).
1088 /// Raised APIError::MonitorUpdateFailed if a new monitor update failure prevented sending the
1089 /// relevant updates.
1091 /// In case of APIError::RouteError/APIError::ChannelUnavailable, the payment send has failed
1092 /// and you may wish to retry via a different route immediately.
1093 /// In case of APIError::MonitorUpdateFailed, the commitment update has been irrevocably
1094 /// committed on our end and we're just waiting for a monitor update to send it. Do NOT retry
1095 /// the payment via a different route unless you intend to pay twice!
1096 pub fn send_payment(&self, route: Route, payment_hash: PaymentHash) -> Result<(), APIError> {
1097 if route.hops.len() < 1 || route.hops.len() > 20 {
1098 return Err(APIError::RouteError{err: "Route didn't go anywhere/had bogus size"});
1100 let our_node_id = self.get_our_node_id();
1101 for (idx, hop) in route.hops.iter().enumerate() {
1102 if idx != route.hops.len() - 1 && hop.pubkey == our_node_id {
1103 return Err(APIError::RouteError{err: "Route went through us but wasn't a simple rebalance loop to us"});
1107 let (session_priv, prng_seed) = self.keys_manager.get_onion_rand();
1109 let cur_height = self.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1111 let onion_keys = secp_call!(onion_utils::construct_onion_keys(&self.secp_ctx, &route, &session_priv),
1112 APIError::RouteError{err: "Pubkey along hop was maliciously selected"});
1113 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height)?;
1114 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, prng_seed, &payment_hash);
1116 let _ = self.total_consistency_lock.read().unwrap();
1118 let err: Result<(), _> = loop {
1119 let mut channel_lock = self.channel_state.lock().unwrap();
1121 let id = match channel_lock.short_to_id.get(&route.hops.first().unwrap().short_channel_id) {
1122 None => return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!"}),
1123 Some(id) => id.clone(),
1126 let channel_state = channel_lock.borrow_parts();
1127 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(id) {
1129 if chan.get().get_their_node_id() != route.hops.first().unwrap().pubkey {
1130 return Err(APIError::RouteError{err: "Node ID mismatch on first hop!"});
1132 if !chan.get().is_live() {
1133 return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected/pending monitor update!"});
1135 break_chan_entry!(self, chan.get_mut().send_htlc_and_commit(htlc_msat, payment_hash.clone(), htlc_cltv, HTLCSource::OutboundRoute {
1136 route: route.clone(),
1137 session_priv: session_priv.clone(),
1138 first_hop_htlc_msat: htlc_msat,
1139 }, onion_packet), channel_state, chan)
1141 Some((update_add, commitment_signed, chan_monitor)) => {
1142 if let Err(e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1143 maybe_break_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, true);
1144 // Note that MonitorUpdateFailed here indicates (per function docs)
1145 // that we will resent the commitment update once we unfree monitor
1146 // updating, so we have to take special care that we don't return
1147 // something else in case we will resend later!
1148 return Err(APIError::MonitorUpdateFailed);
1151 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1152 node_id: route.hops.first().unwrap().pubkey,
1153 updates: msgs::CommitmentUpdate {
1154 update_add_htlcs: vec![update_add],
1155 update_fulfill_htlcs: Vec::new(),
1156 update_fail_htlcs: Vec::new(),
1157 update_fail_malformed_htlcs: Vec::new(),
1165 } else { unreachable!(); }
1169 match handle_error!(self, err) {
1170 Ok(_) => unreachable!(),
1172 if let msgs::ErrorAction::IgnoreError = e.action {
1174 log_error!(self, "Got bad keys: {}!", e.err);
1175 let mut channel_state = self.channel_state.lock().unwrap();
1176 channel_state.pending_msg_events.push(events::MessageSendEvent::HandleError {
1177 node_id: route.hops.first().unwrap().pubkey,
1181 Err(APIError::ChannelUnavailable { err: e.err })
1186 /// Call this upon creation of a funding transaction for the given channel.
1188 /// Note that ALL inputs in the transaction pointed to by funding_txo MUST spend SegWit outputs
1189 /// or your counterparty can steal your funds!
1191 /// Panics if a funding transaction has already been provided for this channel.
1193 /// May panic if the funding_txo is duplicative with some other channel (note that this should
1194 /// be trivially prevented by using unique funding transaction keys per-channel).
1195 pub fn funding_transaction_generated(&self, temporary_channel_id: &[u8; 32], funding_txo: OutPoint) {
1196 let _ = self.total_consistency_lock.read().unwrap();
1198 let (mut chan, msg, chan_monitor) = {
1200 let mut channel_state = self.channel_state.lock().unwrap();
1201 match channel_state.by_id.remove(temporary_channel_id) {
1203 (chan.get_outbound_funding_created(funding_txo)
1204 .map_err(|e| if let ChannelError::Close(msg) = e {
1205 MsgHandleErrInternal::from_finish_shutdown(msg, chan.channel_id(), chan.force_shutdown(), None)
1206 } else { unreachable!(); })
1212 match handle_error!(self, res) {
1213 Ok(funding_msg) => {
1214 (chan, funding_msg.0, funding_msg.1)
1217 log_error!(self, "Got bad signatures: {}!", e.err);
1218 let mut channel_state = self.channel_state.lock().unwrap();
1219 channel_state.pending_msg_events.push(events::MessageSendEvent::HandleError {
1220 node_id: chan.get_their_node_id(),
1227 // Because we have exclusive ownership of the channel here we can release the channel_state
1228 // lock before add_update_monitor
1229 if let Err(e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1231 ChannelMonitorUpdateErr::PermanentFailure => {
1232 match handle_error!(self, Err(MsgHandleErrInternal::from_finish_shutdown("ChannelMonitor storage failure", *temporary_channel_id, chan.force_shutdown(), None))) {
1234 log_error!(self, "Failed to store ChannelMonitor update for funding tx generation");
1235 let mut channel_state = self.channel_state.lock().unwrap();
1236 channel_state.pending_msg_events.push(events::MessageSendEvent::HandleError {
1237 node_id: chan.get_their_node_id(),
1242 Ok(()) => unreachable!(),
1245 ChannelMonitorUpdateErr::TemporaryFailure => {
1246 // Its completely fine to continue with a FundingCreated until the monitor
1247 // update is persisted, as long as we don't generate the FundingBroadcastSafe
1248 // until the monitor has been safely persisted (as funding broadcast is not,
1250 chan.monitor_update_failed(false, false, Vec::new(), Vec::new());
1255 let mut channel_state = self.channel_state.lock().unwrap();
1256 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
1257 node_id: chan.get_their_node_id(),
1260 match channel_state.by_id.entry(chan.channel_id()) {
1261 hash_map::Entry::Occupied(_) => {
1262 panic!("Generated duplicate funding txid?");
1264 hash_map::Entry::Vacant(e) => {
1270 fn get_announcement_sigs(&self, chan: &Channel) -> Option<msgs::AnnouncementSignatures> {
1271 if !chan.should_announce() { return None }
1273 let (announcement, our_bitcoin_sig) = match chan.get_channel_announcement(self.get_our_node_id(), self.genesis_hash.clone()) {
1275 Err(_) => return None, // Only in case of state precondition violations eg channel is closing
1277 let msghash = hash_to_message!(&Sha256dHash::hash(&announcement.encode()[..])[..]);
1278 let our_node_sig = self.secp_ctx.sign(&msghash, &self.our_network_key);
1280 Some(msgs::AnnouncementSignatures {
1281 channel_id: chan.channel_id(),
1282 short_channel_id: chan.get_short_channel_id().unwrap(),
1283 node_signature: our_node_sig,
1284 bitcoin_signature: our_bitcoin_sig,
1288 /// Processes HTLCs which are pending waiting on random forward delay.
1290 /// Should only really ever be called in response to a PendingHTLCsForwardable event.
1291 /// Will likely generate further events.
1292 pub fn process_pending_htlc_forwards(&self) {
1293 let _ = self.total_consistency_lock.read().unwrap();
1295 let mut new_events = Vec::new();
1296 let mut failed_forwards = Vec::new();
1297 let mut handle_errors = Vec::new();
1299 let mut channel_state_lock = self.channel_state.lock().unwrap();
1300 let channel_state = channel_state_lock.borrow_parts();
1302 for (short_chan_id, mut pending_forwards) in channel_state.forward_htlcs.drain() {
1303 if short_chan_id != 0 {
1304 let forward_chan_id = match channel_state.short_to_id.get(&short_chan_id) {
1305 Some(chan_id) => chan_id.clone(),
1307 failed_forwards.reserve(pending_forwards.len());
1308 for forward_info in pending_forwards.drain(..) {
1309 match forward_info {
1310 HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info } => {
1311 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
1312 short_channel_id: prev_short_channel_id,
1313 htlc_id: prev_htlc_id,
1314 incoming_packet_shared_secret: forward_info.incoming_shared_secret,
1316 failed_forwards.push((htlc_source, forward_info.payment_hash, 0x4000 | 10, None));
1318 HTLCForwardInfo::FailHTLC { .. } => {
1319 // Channel went away before we could fail it. This implies
1320 // the channel is now on chain and our counterparty is
1321 // trying to broadcast the HTLC-Timeout, but that's their
1322 // problem, not ours.
1329 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(forward_chan_id) {
1330 let mut add_htlc_msgs = Vec::new();
1331 let mut fail_htlc_msgs = Vec::new();
1332 for forward_info in pending_forwards.drain(..) {
1333 match forward_info {
1334 HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info } => {
1335 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);
1336 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
1337 short_channel_id: prev_short_channel_id,
1338 htlc_id: prev_htlc_id,
1339 incoming_packet_shared_secret: forward_info.incoming_shared_secret,
1341 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()) {
1343 if let ChannelError::Ignore(msg) = e {
1344 log_trace!(self, "Failed to forward HTLC with payment_hash {}: {}", log_bytes!(forward_info.payment_hash.0), msg);
1346 panic!("Stated return value requirements in send_htlc() were not met");
1348 let chan_update = self.get_channel_update(chan.get()).unwrap();
1349 failed_forwards.push((htlc_source, forward_info.payment_hash, 0x1000 | 7, Some(chan_update)));
1354 Some(msg) => { add_htlc_msgs.push(msg); },
1356 // Nothing to do here...we're waiting on a remote
1357 // revoke_and_ack before we can add anymore HTLCs. The Channel
1358 // will automatically handle building the update_add_htlc and
1359 // commitment_signed messages when we can.
1360 // TODO: Do some kind of timer to set the channel as !is_live()
1361 // as we don't really want others relying on us relaying through
1362 // this channel currently :/.
1368 HTLCForwardInfo::FailHTLC { htlc_id, err_packet } => {
1369 log_trace!(self, "Failing HTLC back to channel with short id {} after delay", short_chan_id);
1370 match chan.get_mut().get_update_fail_htlc(htlc_id, err_packet) {
1372 if let ChannelError::Ignore(msg) = e {
1373 log_trace!(self, "Failed to fail backwards to short_id {}: {}", short_chan_id, msg);
1375 panic!("Stated return value requirements in get_update_fail_htlc() were not met");
1377 // fail-backs are best-effort, we probably already have one
1378 // pending, and if not that's OK, if not, the channel is on
1379 // the chain and sending the HTLC-Timeout is their problem.
1382 Ok(Some(msg)) => { fail_htlc_msgs.push(msg); },
1384 // Nothing to do here...we're waiting on a remote
1385 // revoke_and_ack before we can update the commitment
1386 // transaction. The Channel will automatically handle
1387 // building the update_fail_htlc and commitment_signed
1388 // messages when we can.
1389 // We don't need any kind of timer here as they should fail
1390 // the channel onto the chain if they can't get our
1391 // update_fail_htlc in time, it's not our problem.
1398 if !add_htlc_msgs.is_empty() || !fail_htlc_msgs.is_empty() {
1399 let (commitment_msg, monitor) = match chan.get_mut().send_commitment() {
1402 // We surely failed send_commitment due to bad keys, in that case
1403 // close channel and then send error message to peer.
1404 let their_node_id = chan.get().get_their_node_id();
1405 let err: Result<(), _> = match e {
1406 ChannelError::Ignore(_) => {
1407 panic!("Stated return value requirements in send_commitment() were not met");
1409 ChannelError::Close(msg) => {
1410 log_trace!(self, "Closing channel {} due to Close-required error: {}", log_bytes!(chan.key()[..]), msg);
1411 let (channel_id, mut channel) = chan.remove_entry();
1412 if let Some(short_id) = channel.get_short_channel_id() {
1413 channel_state.short_to_id.remove(&short_id);
1415 Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, channel.force_shutdown(), self.get_channel_update(&channel).ok()))
1417 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"); }
1419 match handle_error!(self, err) {
1420 Ok(_) => unreachable!(),
1423 msgs::ErrorAction::IgnoreError => {},
1425 log_error!(self, "Got bad keys: {}!", e.err);
1426 let mut channel_state = self.channel_state.lock().unwrap();
1427 channel_state.pending_msg_events.push(events::MessageSendEvent::HandleError {
1428 node_id: their_node_id,
1438 if let Err(e) = self.monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor) {
1439 handle_errors.push((chan.get().get_their_node_id(), handle_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, true)));
1442 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1443 node_id: chan.get().get_their_node_id(),
1444 updates: msgs::CommitmentUpdate {
1445 update_add_htlcs: add_htlc_msgs,
1446 update_fulfill_htlcs: Vec::new(),
1447 update_fail_htlcs: fail_htlc_msgs,
1448 update_fail_malformed_htlcs: Vec::new(),
1450 commitment_signed: commitment_msg,
1458 for forward_info in pending_forwards.drain(..) {
1459 match forward_info {
1460 HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info } => {
1461 let prev_hop_data = HTLCPreviousHopData {
1462 short_channel_id: prev_short_channel_id,
1463 htlc_id: prev_htlc_id,
1464 incoming_packet_shared_secret: forward_info.incoming_shared_secret,
1466 match channel_state.claimable_htlcs.entry(forward_info.payment_hash) {
1467 hash_map::Entry::Occupied(mut entry) => entry.get_mut().push((forward_info.amt_to_forward, prev_hop_data)),
1468 hash_map::Entry::Vacant(entry) => { entry.insert(vec![(forward_info.amt_to_forward, prev_hop_data)]); },
1470 new_events.push(events::Event::PaymentReceived {
1471 payment_hash: forward_info.payment_hash,
1472 amt: forward_info.amt_to_forward,
1475 HTLCForwardInfo::FailHTLC { .. } => {
1476 panic!("Got pending fail of our own HTLC");
1484 for (htlc_source, payment_hash, failure_code, update) in failed_forwards.drain(..) {
1486 None => self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source, &payment_hash, HTLCFailReason::Reason { failure_code, data: Vec::new() }),
1487 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() }),
1491 for (their_node_id, err) in handle_errors.drain(..) {
1492 match handle_error!(self, err) {
1495 if let msgs::ErrorAction::IgnoreError = e.action {
1497 let mut channel_state = self.channel_state.lock().unwrap();
1498 channel_state.pending_msg_events.push(events::MessageSendEvent::HandleError {
1499 node_id: their_node_id,
1507 if new_events.is_empty() { return }
1508 let mut events = self.pending_events.lock().unwrap();
1509 events.append(&mut new_events);
1512 /// If a peer is disconnected we mark any channels with that peer as 'disabled'.
1513 /// After some time, if channels are still disabled we need to broadcast a ChannelUpdate
1514 /// to inform the network about the uselessness of these channels.
1516 /// This method handles all the details, and must be called roughly once per minute.
1517 pub fn timer_chan_freshness_every_min(&self) {
1518 let _ = self.total_consistency_lock.read().unwrap();
1519 let mut channel_state_lock = self.channel_state.lock().unwrap();
1520 let channel_state = channel_state_lock.borrow_parts();
1521 for (_, chan) in channel_state.by_id {
1522 if chan.is_disabled_staged() && !chan.is_live() {
1523 if let Ok(update) = self.get_channel_update(&chan) {
1524 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1529 } else if chan.is_disabled_staged() && chan.is_live() {
1531 } else if chan.is_disabled_marked() {
1532 chan.to_disabled_staged();
1537 /// Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
1538 /// after a PaymentReceived event, failing the HTLC back to its origin and freeing resources
1539 /// along the path (including in our own channel on which we received it).
1540 /// Returns false if no payment was found to fail backwards, true if the process of failing the
1541 /// HTLC backwards has been started.
1542 pub fn fail_htlc_backwards(&self, payment_hash: &PaymentHash) -> bool {
1543 let _ = self.total_consistency_lock.read().unwrap();
1545 let mut channel_state = Some(self.channel_state.lock().unwrap());
1546 let removed_source = channel_state.as_mut().unwrap().claimable_htlcs.remove(payment_hash);
1547 if let Some(mut sources) = removed_source {
1548 for (recvd_value, htlc_with_hash) in sources.drain(..) {
1549 if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
1550 self.fail_htlc_backwards_internal(channel_state.take().unwrap(),
1551 HTLCSource::PreviousHopData(htlc_with_hash), payment_hash,
1552 HTLCFailReason::Reason { failure_code: 0x4000 | 15, data: byte_utils::be64_to_array(recvd_value).to_vec() });
1558 /// Fails an HTLC backwards to the sender of it to us.
1559 /// Note that while we take a channel_state lock as input, we do *not* assume consistency here.
1560 /// There are several callsites that do stupid things like loop over a list of payment_hashes
1561 /// to fail and take the channel_state lock for each iteration (as we take ownership and may
1562 /// drop it). In other words, no assumptions are made that entries in claimable_htlcs point to
1563 /// still-available channels.
1564 fn fail_htlc_backwards_internal(&self, mut channel_state_lock: MutexGuard<ChannelHolder>, source: HTLCSource, payment_hash: &PaymentHash, onion_error: HTLCFailReason) {
1565 //TODO: There is a timing attack here where if a node fails an HTLC back to us they can
1566 //identify whether we sent it or not based on the (I presume) very different runtime
1567 //between the branches here. We should make this async and move it into the forward HTLCs
1570 HTLCSource::OutboundRoute { ref route, .. } => {
1571 log_trace!(self, "Failing outbound payment HTLC with payment_hash {}", log_bytes!(payment_hash.0));
1572 mem::drop(channel_state_lock);
1573 match &onion_error {
1574 &HTLCFailReason::LightningError { ref err } => {
1576 let (channel_update, payment_retryable, onion_error_code) = onion_utils::process_onion_failure(&self.secp_ctx, &self.logger, &source, err.data.clone());
1578 let (channel_update, payment_retryable, _) = onion_utils::process_onion_failure(&self.secp_ctx, &self.logger, &source, err.data.clone());
1579 // TODO: If we decided to blame ourselves (or one of our channels) in
1580 // process_onion_failure we should close that channel as it implies our
1581 // next-hop is needlessly blaming us!
1582 if let Some(update) = channel_update {
1583 self.channel_state.lock().unwrap().pending_msg_events.push(
1584 events::MessageSendEvent::PaymentFailureNetworkUpdate {
1589 self.pending_events.lock().unwrap().push(
1590 events::Event::PaymentFailed {
1591 payment_hash: payment_hash.clone(),
1592 rejected_by_dest: !payment_retryable,
1594 error_code: onion_error_code
1598 &HTLCFailReason::Reason {
1602 // we get a fail_malformed_htlc from the first hop
1603 // TODO: We'd like to generate a PaymentFailureNetworkUpdate for temporary
1604 // failures here, but that would be insufficient as Router::get_route
1605 // generally ignores its view of our own channels as we provide them via
1607 // TODO: For non-temporary failures, we really should be closing the
1608 // channel here as we apparently can't relay through them anyway.
1609 self.pending_events.lock().unwrap().push(
1610 events::Event::PaymentFailed {
1611 payment_hash: payment_hash.clone(),
1612 rejected_by_dest: route.hops.len() == 1,
1614 error_code: Some(*failure_code),
1620 HTLCSource::PreviousHopData(HTLCPreviousHopData { short_channel_id, htlc_id, incoming_packet_shared_secret }) => {
1621 let err_packet = match onion_error {
1622 HTLCFailReason::Reason { failure_code, data } => {
1623 log_trace!(self, "Failing HTLC with payment_hash {} backwards from us with code {}", log_bytes!(payment_hash.0), failure_code);
1624 let packet = onion_utils::build_failure_packet(&incoming_packet_shared_secret, failure_code, &data[..]).encode();
1625 onion_utils::encrypt_failure_packet(&incoming_packet_shared_secret, &packet)
1627 HTLCFailReason::LightningError { err } => {
1628 log_trace!(self, "Failing HTLC with payment_hash {} backwards with pre-built LightningError", log_bytes!(payment_hash.0));
1629 onion_utils::encrypt_failure_packet(&incoming_packet_shared_secret, &err.data)
1633 let mut forward_event = None;
1634 if channel_state_lock.forward_htlcs.is_empty() {
1635 forward_event = Some(Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS));
1637 match channel_state_lock.forward_htlcs.entry(short_channel_id) {
1638 hash_map::Entry::Occupied(mut entry) => {
1639 entry.get_mut().push(HTLCForwardInfo::FailHTLC { htlc_id, err_packet });
1641 hash_map::Entry::Vacant(entry) => {
1642 entry.insert(vec!(HTLCForwardInfo::FailHTLC { htlc_id, err_packet }));
1645 mem::drop(channel_state_lock);
1646 if let Some(time) = forward_event {
1647 let mut pending_events = self.pending_events.lock().unwrap();
1648 pending_events.push(events::Event::PendingHTLCsForwardable {
1649 time_forwardable: time
1656 /// Provides a payment preimage in response to a PaymentReceived event, returning true and
1657 /// generating message events for the net layer to claim the payment, if possible. Thus, you
1658 /// should probably kick the net layer to go send messages if this returns true!
1660 /// You must specify the expected amounts for this HTLC, and we will only claim HTLCs
1661 /// available within a few percent of the expected amount. This is critical for several
1662 /// reasons : a) it avoids providing senders with `proof-of-payment` (in the form of the
1663 /// payment_preimage without having provided the full value and b) it avoids certain
1664 /// privacy-breaking recipient-probing attacks which may reveal payment activity to
1665 /// motivated attackers.
1667 /// May panic if called except in response to a PaymentReceived event.
1668 pub fn claim_funds(&self, payment_preimage: PaymentPreimage, expected_amount: u64) -> bool {
1669 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
1671 let _ = self.total_consistency_lock.read().unwrap();
1673 let mut channel_state = Some(self.channel_state.lock().unwrap());
1674 let removed_source = channel_state.as_mut().unwrap().claimable_htlcs.remove(&payment_hash);
1675 if let Some(mut sources) = removed_source {
1676 for (received_amount, htlc_with_hash) in sources.drain(..) {
1677 if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
1678 if received_amount < expected_amount || received_amount > expected_amount * 2 {
1679 let mut htlc_msat_data = byte_utils::be64_to_array(received_amount).to_vec();
1680 let mut height_data = byte_utils::be32_to_array(self.latest_block_height.load(Ordering::Acquire) as u32).to_vec();
1681 htlc_msat_data.append(&mut height_data);
1682 self.fail_htlc_backwards_internal(channel_state.take().unwrap(),
1683 HTLCSource::PreviousHopData(htlc_with_hash), &payment_hash,
1684 HTLCFailReason::Reason { failure_code: 0x4000|15, data: htlc_msat_data });
1686 self.claim_funds_internal(channel_state.take().unwrap(), HTLCSource::PreviousHopData(htlc_with_hash), payment_preimage);
1692 fn claim_funds_internal(&self, mut channel_state_lock: MutexGuard<ChannelHolder>, source: HTLCSource, payment_preimage: PaymentPreimage) {
1693 let (their_node_id, err) = loop {
1695 HTLCSource::OutboundRoute { .. } => {
1696 mem::drop(channel_state_lock);
1697 let mut pending_events = self.pending_events.lock().unwrap();
1698 pending_events.push(events::Event::PaymentSent {
1702 HTLCSource::PreviousHopData(HTLCPreviousHopData { short_channel_id, htlc_id, .. }) => {
1703 //TODO: Delay the claimed_funds relaying just like we do outbound relay!
1704 let channel_state = channel_state_lock.borrow_parts();
1706 let chan_id = match channel_state.short_to_id.get(&short_channel_id) {
1707 Some(chan_id) => chan_id.clone(),
1709 // TODO: There is probably a channel manager somewhere that needs to
1710 // learn the preimage as the channel already hit the chain and that's
1711 // why it's missing.
1716 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(chan_id) {
1717 let was_frozen_for_monitor = chan.get().is_awaiting_monitor_update();
1718 match chan.get_mut().get_update_fulfill_htlc_and_commit(htlc_id, payment_preimage) {
1719 Ok((msgs, monitor_option)) => {
1720 if let Some(chan_monitor) = monitor_option {
1721 if let Err(e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1722 if was_frozen_for_monitor {
1723 assert!(msgs.is_none());
1725 break (chan.get().get_their_node_id(), handle_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, msgs.is_some()));
1729 if let Some((msg, commitment_signed)) = msgs {
1730 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1731 node_id: chan.get().get_their_node_id(),
1732 updates: msgs::CommitmentUpdate {
1733 update_add_htlcs: Vec::new(),
1734 update_fulfill_htlcs: vec![msg],
1735 update_fail_htlcs: Vec::new(),
1736 update_fail_malformed_htlcs: Vec::new(),
1744 // TODO: There is probably a channel manager somewhere that needs to
1745 // learn the preimage as the channel may be about to hit the chain.
1746 //TODO: Do something with e?
1750 } else { unreachable!(); }
1756 match handle_error!(self, err) {
1759 if let msgs::ErrorAction::IgnoreError = e.action {
1761 let mut channel_state = self.channel_state.lock().unwrap();
1762 channel_state.pending_msg_events.push(events::MessageSendEvent::HandleError {
1763 node_id: their_node_id,
1771 /// Gets the node_id held by this ChannelManager
1772 pub fn get_our_node_id(&self) -> PublicKey {
1773 PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key)
1776 /// Used to restore channels to normal operation after a
1777 /// ChannelMonitorUpdateErr::TemporaryFailure was returned from a channel monitor update
1779 pub fn test_restore_channel_monitor(&self) {
1780 let mut close_results = Vec::new();
1781 let mut htlc_forwards = Vec::new();
1782 let mut htlc_failures = Vec::new();
1783 let mut pending_events = Vec::new();
1784 let _ = self.total_consistency_lock.read().unwrap();
1787 let mut channel_lock = self.channel_state.lock().unwrap();
1788 let channel_state = channel_lock.borrow_parts();
1789 let short_to_id = channel_state.short_to_id;
1790 let pending_msg_events = channel_state.pending_msg_events;
1791 channel_state.by_id.retain(|_, channel| {
1792 if channel.is_awaiting_monitor_update() {
1793 let chan_monitor = channel.channel_monitor();
1794 if let Err(e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1796 ChannelMonitorUpdateErr::PermanentFailure => {
1797 // TODO: There may be some pending HTLCs that we intended to fail
1798 // backwards when a monitor update failed. We should make sure
1799 // knowledge of those gets moved into the appropriate in-memory
1800 // ChannelMonitor and they get failed backwards once we get
1801 // on-chain confirmations.
1802 // Note I think #198 addresses this, so once it's merged a test
1803 // should be written.
1804 if let Some(short_id) = channel.get_short_channel_id() {
1805 short_to_id.remove(&short_id);
1807 close_results.push(channel.force_shutdown());
1808 if let Ok(update) = self.get_channel_update(&channel) {
1809 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1815 ChannelMonitorUpdateErr::TemporaryFailure => true,
1818 let (raa, commitment_update, order, pending_forwards, mut pending_failures, needs_broadcast_safe, funding_locked) = channel.monitor_updating_restored();
1819 if !pending_forwards.is_empty() {
1820 htlc_forwards.push((channel.get_short_channel_id().expect("We can't have pending forwards before funding confirmation"), pending_forwards));
1822 htlc_failures.append(&mut pending_failures);
1824 macro_rules! handle_cs { () => {
1825 if let Some(update) = commitment_update {
1826 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1827 node_id: channel.get_their_node_id(),
1832 macro_rules! handle_raa { () => {
1833 if let Some(revoke_and_ack) = raa {
1834 pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
1835 node_id: channel.get_their_node_id(),
1836 msg: revoke_and_ack,
1841 RAACommitmentOrder::CommitmentFirst => {
1845 RAACommitmentOrder::RevokeAndACKFirst => {
1850 if needs_broadcast_safe {
1851 pending_events.push(events::Event::FundingBroadcastSafe {
1852 funding_txo: channel.get_funding_txo().unwrap(),
1853 user_channel_id: channel.get_user_id(),
1856 if let Some(msg) = funding_locked {
1857 pending_msg_events.push(events::MessageSendEvent::SendFundingLocked {
1858 node_id: channel.get_their_node_id(),
1861 if let Some(announcement_sigs) = self.get_announcement_sigs(channel) {
1862 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
1863 node_id: channel.get_their_node_id(),
1864 msg: announcement_sigs,
1867 short_to_id.insert(channel.get_short_channel_id().unwrap(), channel.channel_id());
1875 self.pending_events.lock().unwrap().append(&mut pending_events);
1877 for failure in htlc_failures.drain(..) {
1878 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), failure.0, &failure.1, failure.2);
1880 self.forward_htlcs(&mut htlc_forwards[..]);
1882 for res in close_results.drain(..) {
1883 self.finish_force_close_channel(res);
1887 fn internal_open_channel(&self, their_node_id: &PublicKey, their_local_features: LocalFeatures, msg: &msgs::OpenChannel) -> Result<(), MsgHandleErrInternal> {
1888 if msg.chain_hash != self.genesis_hash {
1889 return Err(MsgHandleErrInternal::send_err_msg_no_close("Unknown genesis block hash", msg.temporary_channel_id.clone()));
1892 let channel = Channel::new_from_req(&*self.fee_estimator, &self.keys_manager, their_node_id.clone(), their_local_features, msg, 0, Arc::clone(&self.logger), &self.default_configuration)
1893 .map_err(|e| MsgHandleErrInternal::from_chan_no_close(e, msg.temporary_channel_id))?;
1894 let mut channel_state_lock = self.channel_state.lock().unwrap();
1895 let channel_state = channel_state_lock.borrow_parts();
1896 match channel_state.by_id.entry(channel.channel_id()) {
1897 hash_map::Entry::Occupied(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("temporary_channel_id collision!", msg.temporary_channel_id.clone())),
1898 hash_map::Entry::Vacant(entry) => {
1899 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
1900 node_id: their_node_id.clone(),
1901 msg: channel.get_accept_channel(),
1903 entry.insert(channel);
1909 fn internal_accept_channel(&self, their_node_id: &PublicKey, their_local_features: LocalFeatures, msg: &msgs::AcceptChannel) -> Result<(), MsgHandleErrInternal> {
1910 let (value, output_script, user_id) = {
1911 let mut channel_lock = self.channel_state.lock().unwrap();
1912 let channel_state = channel_lock.borrow_parts();
1913 match channel_state.by_id.entry(msg.temporary_channel_id) {
1914 hash_map::Entry::Occupied(mut chan) => {
1915 if chan.get().get_their_node_id() != *their_node_id {
1916 //TODO: see issue #153, need a consistent behavior on obnoxious behavior from random node
1917 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.temporary_channel_id));
1919 try_chan_entry!(self, chan.get_mut().accept_channel(&msg, &self.default_configuration, their_local_features), channel_state, chan);
1920 (chan.get().get_value_satoshis(), chan.get().get_funding_redeemscript().to_v0_p2wsh(), chan.get().get_user_id())
1922 //TODO: same as above
1923 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.temporary_channel_id))
1926 let mut pending_events = self.pending_events.lock().unwrap();
1927 pending_events.push(events::Event::FundingGenerationReady {
1928 temporary_channel_id: msg.temporary_channel_id,
1929 channel_value_satoshis: value,
1930 output_script: output_script,
1931 user_channel_id: user_id,
1936 fn internal_funding_created(&self, their_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), MsgHandleErrInternal> {
1937 let ((funding_msg, monitor_update), mut chan) = {
1938 let mut channel_lock = self.channel_state.lock().unwrap();
1939 let channel_state = channel_lock.borrow_parts();
1940 match channel_state.by_id.entry(msg.temporary_channel_id.clone()) {
1941 hash_map::Entry::Occupied(mut chan) => {
1942 if chan.get().get_their_node_id() != *their_node_id {
1943 //TODO: here and below MsgHandleErrInternal, #153 case
1944 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.temporary_channel_id));
1946 (try_chan_entry!(self, chan.get_mut().funding_created(msg), channel_state, chan), chan.remove())
1948 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.temporary_channel_id))
1951 // Because we have exclusive ownership of the channel here we can release the channel_state
1952 // lock before add_update_monitor
1953 if let Err(e) = self.monitor.add_update_monitor(monitor_update.get_funding_txo().unwrap(), monitor_update) {
1955 ChannelMonitorUpdateErr::PermanentFailure => {
1956 // Note that we reply with the new channel_id in error messages if we gave up on the
1957 // channel, not the temporary_channel_id. This is compatible with ourselves, but the
1958 // spec is somewhat ambiguous here. Not a huge deal since we'll send error messages for
1959 // any messages referencing a previously-closed channel anyway.
1960 return Err(MsgHandleErrInternal::from_finish_shutdown("ChannelMonitor storage failure", funding_msg.channel_id, chan.force_shutdown(), None));
1962 ChannelMonitorUpdateErr::TemporaryFailure => {
1963 // There's no problem signing a counterparty's funding transaction if our monitor
1964 // hasn't persisted to disk yet - we can't lose money on a transaction that we haven't
1965 // accepted payment from yet. We do, however, need to wait to send our funding_locked
1966 // until we have persisted our monitor.
1967 chan.monitor_update_failed(false, false, Vec::new(), Vec::new());
1971 let mut channel_state_lock = self.channel_state.lock().unwrap();
1972 let channel_state = channel_state_lock.borrow_parts();
1973 match channel_state.by_id.entry(funding_msg.channel_id) {
1974 hash_map::Entry::Occupied(_) => {
1975 return Err(MsgHandleErrInternal::send_err_msg_no_close("Already had channel with the new channel_id", funding_msg.channel_id))
1977 hash_map::Entry::Vacant(e) => {
1978 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
1979 node_id: their_node_id.clone(),
1988 fn internal_funding_signed(&self, their_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), MsgHandleErrInternal> {
1989 let (funding_txo, user_id) = {
1990 let mut channel_lock = self.channel_state.lock().unwrap();
1991 let channel_state = channel_lock.borrow_parts();
1992 match channel_state.by_id.entry(msg.channel_id) {
1993 hash_map::Entry::Occupied(mut chan) => {
1994 if chan.get().get_their_node_id() != *their_node_id {
1995 //TODO: here and below MsgHandleErrInternal, #153 case
1996 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1998 let chan_monitor = try_chan_entry!(self, chan.get_mut().funding_signed(&msg), channel_state, chan);
1999 if let Err(e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
2000 return_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::RevokeAndACKFirst, false, false);
2002 (chan.get().get_funding_txo().unwrap(), chan.get().get_user_id())
2004 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2007 let mut pending_events = self.pending_events.lock().unwrap();
2008 pending_events.push(events::Event::FundingBroadcastSafe {
2009 funding_txo: funding_txo,
2010 user_channel_id: user_id,
2015 fn internal_funding_locked(&self, their_node_id: &PublicKey, msg: &msgs::FundingLocked) -> Result<(), MsgHandleErrInternal> {
2016 let mut channel_state_lock = self.channel_state.lock().unwrap();
2017 let channel_state = channel_state_lock.borrow_parts();
2018 match channel_state.by_id.entry(msg.channel_id) {
2019 hash_map::Entry::Occupied(mut chan) => {
2020 if chan.get().get_their_node_id() != *their_node_id {
2021 //TODO: here and below MsgHandleErrInternal, #153 case
2022 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2024 try_chan_entry!(self, chan.get_mut().funding_locked(&msg), channel_state, chan);
2025 if let Some(announcement_sigs) = self.get_announcement_sigs(chan.get()) {
2026 // If we see locking block before receiving remote funding_locked, we broadcast our
2027 // announcement_sigs at remote funding_locked reception. If we receive remote
2028 // funding_locked before seeing locking block, we broadcast our announcement_sigs at locking
2029 // block connection. We should guanrantee to broadcast announcement_sigs to our peer whatever
2030 // the order of the events but our peer may not receive it due to disconnection. The specs
2031 // lacking an acknowledgement for announcement_sigs we may have to re-send them at peer
2032 // connection in the future if simultaneous misses by both peers due to network/hardware
2033 // failures is an issue. Note, to achieve its goal, only one of the announcement_sigs needs
2034 // to be received, from then sigs are going to be flood to the whole network.
2035 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
2036 node_id: their_node_id.clone(),
2037 msg: announcement_sigs,
2042 hash_map::Entry::Vacant(_) => Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2046 fn internal_shutdown(&self, their_node_id: &PublicKey, msg: &msgs::Shutdown) -> Result<(), MsgHandleErrInternal> {
2047 let (mut dropped_htlcs, chan_option) = {
2048 let mut channel_state_lock = self.channel_state.lock().unwrap();
2049 let channel_state = channel_state_lock.borrow_parts();
2051 match channel_state.by_id.entry(msg.channel_id.clone()) {
2052 hash_map::Entry::Occupied(mut chan_entry) => {
2053 if chan_entry.get().get_their_node_id() != *their_node_id {
2054 //TODO: here and below MsgHandleErrInternal, #153 case
2055 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2057 let (shutdown, closing_signed, dropped_htlcs) = try_chan_entry!(self, chan_entry.get_mut().shutdown(&*self.fee_estimator, &msg), channel_state, chan_entry);
2058 if let Some(msg) = shutdown {
2059 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
2060 node_id: their_node_id.clone(),
2064 if let Some(msg) = closing_signed {
2065 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
2066 node_id: their_node_id.clone(),
2070 if chan_entry.get().is_shutdown() {
2071 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
2072 channel_state.short_to_id.remove(&short_id);
2074 (dropped_htlcs, Some(chan_entry.remove_entry().1))
2075 } else { (dropped_htlcs, None) }
2077 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2080 for htlc_source in dropped_htlcs.drain(..) {
2081 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() });
2083 if let Some(chan) = chan_option {
2084 if let Ok(update) = self.get_channel_update(&chan) {
2085 let mut channel_state = self.channel_state.lock().unwrap();
2086 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2094 fn internal_closing_signed(&self, their_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<(), MsgHandleErrInternal> {
2095 let (tx, chan_option) = {
2096 let mut channel_state_lock = self.channel_state.lock().unwrap();
2097 let channel_state = channel_state_lock.borrow_parts();
2098 match channel_state.by_id.entry(msg.channel_id.clone()) {
2099 hash_map::Entry::Occupied(mut chan_entry) => {
2100 if chan_entry.get().get_their_node_id() != *their_node_id {
2101 //TODO: here and below MsgHandleErrInternal, #153 case
2102 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2104 let (closing_signed, tx) = try_chan_entry!(self, chan_entry.get_mut().closing_signed(&*self.fee_estimator, &msg), channel_state, chan_entry);
2105 if let Some(msg) = closing_signed {
2106 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
2107 node_id: their_node_id.clone(),
2112 // We're done with this channel, we've got a signed closing transaction and
2113 // will send the closing_signed back to the remote peer upon return. This
2114 // also implies there are no pending HTLCs left on the channel, so we can
2115 // fully delete it from tracking (the channel monitor is still around to
2116 // watch for old state broadcasts)!
2117 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
2118 channel_state.short_to_id.remove(&short_id);
2120 (tx, Some(chan_entry.remove_entry().1))
2121 } else { (tx, None) }
2123 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2126 if let Some(broadcast_tx) = tx {
2127 log_trace!(self, "Broadcast onchain {}", log_tx!(broadcast_tx));
2128 self.tx_broadcaster.broadcast_transaction(&broadcast_tx);
2130 if let Some(chan) = chan_option {
2131 if let Ok(update) = self.get_channel_update(&chan) {
2132 let mut channel_state = self.channel_state.lock().unwrap();
2133 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2141 fn internal_update_add_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), MsgHandleErrInternal> {
2142 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
2143 //determine the state of the payment based on our response/if we forward anything/the time
2144 //we take to respond. We should take care to avoid allowing such an attack.
2146 //TODO: There exists a further attack where a node may garble the onion data, forward it to
2147 //us repeatedly garbled in different ways, and compare our error messages, which are
2148 //encrypted with the same key. It's not immediately obvious how to usefully exploit that,
2149 //but we should prevent it anyway.
2151 let (mut pending_forward_info, mut channel_state_lock) = self.decode_update_add_htlc_onion(msg);
2152 let channel_state = channel_state_lock.borrow_parts();
2154 match channel_state.by_id.entry(msg.channel_id) {
2155 hash_map::Entry::Occupied(mut chan) => {
2156 if chan.get().get_their_node_id() != *their_node_id {
2157 //TODO: here MsgHandleErrInternal, #153 case
2158 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2160 if !chan.get().is_usable() {
2161 // If the update_add is completely bogus, the call will Err and we will close,
2162 // but if we've sent a shutdown and they haven't acknowledged it yet, we just
2163 // want to reject the new HTLC and fail it backwards instead of forwarding.
2164 if let PendingHTLCStatus::Forward(PendingForwardHTLCInfo { incoming_shared_secret, .. }) = pending_forward_info {
2165 let chan_update = self.get_channel_update(chan.get());
2166 pending_forward_info = PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
2167 channel_id: msg.channel_id,
2168 htlc_id: msg.htlc_id,
2169 reason: if let Ok(update) = chan_update {
2170 // TODO: Note that |20 is defined as "channel FROM the processing
2171 // node has been disabled" (emphasis mine), which seems to imply
2172 // that we can't return |20 for an inbound channel being disabled.
2173 // This probably needs a spec update but should definitely be
2175 onion_utils::build_first_hop_failure_packet(&incoming_shared_secret, 0x1000|20, &{
2176 let mut res = Vec::with_capacity(8 + 128);
2177 res.extend_from_slice(&byte_utils::be16_to_array(update.contents.flags));
2178 res.extend_from_slice(&update.encode_with_len()[..]);
2182 // This can only happen if the channel isn't in the fully-funded
2183 // state yet, implying our counterparty is trying to route payments
2184 // over the channel back to themselves (cause no one else should
2185 // know the short_id is a lightning channel yet). We should have no
2186 // problem just calling this unknown_next_peer
2187 onion_utils::build_first_hop_failure_packet(&incoming_shared_secret, 0x4000|10, &[])
2192 try_chan_entry!(self, chan.get_mut().update_add_htlc(&msg, pending_forward_info), channel_state, chan);
2194 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2199 fn internal_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), MsgHandleErrInternal> {
2200 let mut channel_lock = self.channel_state.lock().unwrap();
2202 let channel_state = channel_lock.borrow_parts();
2203 match channel_state.by_id.entry(msg.channel_id) {
2204 hash_map::Entry::Occupied(mut chan) => {
2205 if chan.get().get_their_node_id() != *their_node_id {
2206 //TODO: here and below MsgHandleErrInternal, #153 case
2207 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2209 try_chan_entry!(self, chan.get_mut().update_fulfill_htlc(&msg), channel_state, chan)
2211 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2214 self.claim_funds_internal(channel_lock, htlc_source, msg.payment_preimage.clone());
2218 fn internal_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), MsgHandleErrInternal> {
2219 let mut channel_lock = self.channel_state.lock().unwrap();
2220 let channel_state = channel_lock.borrow_parts();
2221 match channel_state.by_id.entry(msg.channel_id) {
2222 hash_map::Entry::Occupied(mut chan) => {
2223 if chan.get().get_their_node_id() != *their_node_id {
2224 //TODO: here and below MsgHandleErrInternal, #153 case
2225 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2227 try_chan_entry!(self, chan.get_mut().update_fail_htlc(&msg, HTLCFailReason::LightningError { err: msg.reason.clone() }), channel_state, chan);
2229 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2234 fn internal_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), MsgHandleErrInternal> {
2235 let mut channel_lock = self.channel_state.lock().unwrap();
2236 let channel_state = channel_lock.borrow_parts();
2237 match channel_state.by_id.entry(msg.channel_id) {
2238 hash_map::Entry::Occupied(mut chan) => {
2239 if chan.get().get_their_node_id() != *their_node_id {
2240 //TODO: here and below MsgHandleErrInternal, #153 case
2241 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2243 if (msg.failure_code & 0x8000) == 0 {
2244 try_chan_entry!(self, Err(ChannelError::Close("Got update_fail_malformed_htlc with BADONION not set")), channel_state, chan);
2246 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);
2249 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2253 fn internal_commitment_signed(&self, their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), MsgHandleErrInternal> {
2254 let mut channel_state_lock = self.channel_state.lock().unwrap();
2255 let channel_state = channel_state_lock.borrow_parts();
2256 match channel_state.by_id.entry(msg.channel_id) {
2257 hash_map::Entry::Occupied(mut chan) => {
2258 if chan.get().get_their_node_id() != *their_node_id {
2259 //TODO: here and below MsgHandleErrInternal, #153 case
2260 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2262 let (revoke_and_ack, commitment_signed, closing_signed, chan_monitor) =
2263 try_chan_entry!(self, chan.get_mut().commitment_signed(&msg, &*self.fee_estimator), channel_state, chan);
2264 if let Err(e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
2265 return_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::RevokeAndACKFirst, true, commitment_signed.is_some());
2266 //TODO: Rebroadcast closing_signed if present on monitor update restoration
2268 channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
2269 node_id: their_node_id.clone(),
2270 msg: revoke_and_ack,
2272 if let Some(msg) = commitment_signed {
2273 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2274 node_id: their_node_id.clone(),
2275 updates: msgs::CommitmentUpdate {
2276 update_add_htlcs: Vec::new(),
2277 update_fulfill_htlcs: Vec::new(),
2278 update_fail_htlcs: Vec::new(),
2279 update_fail_malformed_htlcs: Vec::new(),
2281 commitment_signed: msg,
2285 if let Some(msg) = closing_signed {
2286 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
2287 node_id: their_node_id.clone(),
2293 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2298 fn forward_htlcs(&self, per_source_pending_forwards: &mut [(u64, Vec<(PendingForwardHTLCInfo, u64)>)]) {
2299 for &mut (prev_short_channel_id, ref mut pending_forwards) in per_source_pending_forwards {
2300 let mut forward_event = None;
2301 if !pending_forwards.is_empty() {
2302 let mut channel_state = self.channel_state.lock().unwrap();
2303 if channel_state.forward_htlcs.is_empty() {
2304 forward_event = Some(Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS))
2306 for (forward_info, prev_htlc_id) in pending_forwards.drain(..) {
2307 match channel_state.forward_htlcs.entry(forward_info.short_channel_id) {
2308 hash_map::Entry::Occupied(mut entry) => {
2309 entry.get_mut().push(HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info });
2311 hash_map::Entry::Vacant(entry) => {
2312 entry.insert(vec!(HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info }));
2317 match forward_event {
2319 let mut pending_events = self.pending_events.lock().unwrap();
2320 pending_events.push(events::Event::PendingHTLCsForwardable {
2321 time_forwardable: time
2329 fn internal_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), MsgHandleErrInternal> {
2330 let (pending_forwards, mut pending_failures, short_channel_id) = {
2331 let mut channel_state_lock = self.channel_state.lock().unwrap();
2332 let channel_state = channel_state_lock.borrow_parts();
2333 match channel_state.by_id.entry(msg.channel_id) {
2334 hash_map::Entry::Occupied(mut chan) => {
2335 if chan.get().get_their_node_id() != *their_node_id {
2336 //TODO: here and below MsgHandleErrInternal, #153 case
2337 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2339 let was_frozen_for_monitor = chan.get().is_awaiting_monitor_update();
2340 let (commitment_update, pending_forwards, pending_failures, closing_signed, chan_monitor) =
2341 try_chan_entry!(self, chan.get_mut().revoke_and_ack(&msg, &*self.fee_estimator), channel_state, chan);
2342 if let Err(e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
2343 if was_frozen_for_monitor {
2344 assert!(commitment_update.is_none() && closing_signed.is_none() && pending_forwards.is_empty() && pending_failures.is_empty());
2345 return Err(MsgHandleErrInternal::ignore_no_close("Previous monitor update failure prevented responses to RAA"));
2347 return_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, commitment_update.is_some(), pending_forwards, pending_failures);
2350 if let Some(updates) = commitment_update {
2351 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2352 node_id: their_node_id.clone(),
2356 if let Some(msg) = closing_signed {
2357 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
2358 node_id: their_node_id.clone(),
2362 (pending_forwards, pending_failures, chan.get().get_short_channel_id().expect("RAA should only work on a short-id-available channel"))
2364 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2367 for failure in pending_failures.drain(..) {
2368 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), failure.0, &failure.1, failure.2);
2370 self.forward_htlcs(&mut [(short_channel_id, pending_forwards)]);
2375 fn internal_update_fee(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), MsgHandleErrInternal> {
2376 let mut channel_lock = self.channel_state.lock().unwrap();
2377 let channel_state = channel_lock.borrow_parts();
2378 match channel_state.by_id.entry(msg.channel_id) {
2379 hash_map::Entry::Occupied(mut chan) => {
2380 if chan.get().get_their_node_id() != *their_node_id {
2381 //TODO: here and below MsgHandleErrInternal, #153 case
2382 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2384 try_chan_entry!(self, chan.get_mut().update_fee(&*self.fee_estimator, &msg), channel_state, chan);
2386 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2391 fn internal_announcement_signatures(&self, their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), MsgHandleErrInternal> {
2392 let mut channel_state_lock = self.channel_state.lock().unwrap();
2393 let channel_state = channel_state_lock.borrow_parts();
2395 match channel_state.by_id.entry(msg.channel_id) {
2396 hash_map::Entry::Occupied(mut chan) => {
2397 if chan.get().get_their_node_id() != *their_node_id {
2398 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2400 if !chan.get().is_usable() {
2401 return Err(MsgHandleErrInternal::from_no_close(LightningError{err: "Got an announcement_signatures before we were ready for it", action: msgs::ErrorAction::IgnoreError}));
2404 let our_node_id = self.get_our_node_id();
2405 let (announcement, our_bitcoin_sig) =
2406 try_chan_entry!(self, chan.get_mut().get_channel_announcement(our_node_id.clone(), self.genesis_hash.clone()), channel_state, chan);
2408 let were_node_one = announcement.node_id_1 == our_node_id;
2409 let msghash = hash_to_message!(&Sha256dHash::hash(&announcement.encode()[..])[..]);
2410 if self.secp_ctx.verify(&msghash, &msg.node_signature, if were_node_one { &announcement.node_id_2 } else { &announcement.node_id_1 }).is_err() ||
2411 self.secp_ctx.verify(&msghash, &msg.bitcoin_signature, if were_node_one { &announcement.bitcoin_key_2 } else { &announcement.bitcoin_key_1 }).is_err() {
2412 try_chan_entry!(self, Err(ChannelError::Close("Bad announcement_signatures node_signature")), channel_state, chan);
2415 let our_node_sig = self.secp_ctx.sign(&msghash, &self.our_network_key);
2417 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
2418 msg: msgs::ChannelAnnouncement {
2419 node_signature_1: if were_node_one { our_node_sig } else { msg.node_signature },
2420 node_signature_2: if were_node_one { msg.node_signature } else { our_node_sig },
2421 bitcoin_signature_1: if were_node_one { our_bitcoin_sig } else { msg.bitcoin_signature },
2422 bitcoin_signature_2: if were_node_one { msg.bitcoin_signature } else { our_bitcoin_sig },
2423 contents: announcement,
2425 update_msg: self.get_channel_update(chan.get()).unwrap(), // can only fail if we're not in a ready state
2428 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2433 fn internal_channel_reestablish(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<(), MsgHandleErrInternal> {
2434 let mut channel_state_lock = self.channel_state.lock().unwrap();
2435 let channel_state = channel_state_lock.borrow_parts();
2437 match channel_state.by_id.entry(msg.channel_id) {
2438 hash_map::Entry::Occupied(mut chan) => {
2439 if chan.get().get_their_node_id() != *their_node_id {
2440 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2442 let (funding_locked, revoke_and_ack, commitment_update, channel_monitor, mut order, shutdown) =
2443 try_chan_entry!(self, chan.get_mut().channel_reestablish(msg), channel_state, chan);
2444 if let Some(monitor) = channel_monitor {
2445 if let Err(e) = self.monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor) {
2446 // channel_reestablish doesn't guarantee the order it returns is sensical
2447 // for the messages it returns, but if we're setting what messages to
2448 // re-transmit on monitor update success, we need to make sure it is sane.
2449 if revoke_and_ack.is_none() {
2450 order = RAACommitmentOrder::CommitmentFirst;
2452 if commitment_update.is_none() {
2453 order = RAACommitmentOrder::RevokeAndACKFirst;
2455 return_monitor_err!(self, e, channel_state, chan, order, revoke_and_ack.is_some(), commitment_update.is_some());
2456 //TODO: Resend the funding_locked if needed once we get the monitor running again
2459 if let Some(msg) = funding_locked {
2460 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingLocked {
2461 node_id: their_node_id.clone(),
2465 macro_rules! send_raa { () => {
2466 if let Some(msg) = revoke_and_ack {
2467 channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
2468 node_id: their_node_id.clone(),
2473 macro_rules! send_cu { () => {
2474 if let Some(updates) = commitment_update {
2475 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2476 node_id: their_node_id.clone(),
2482 RAACommitmentOrder::RevokeAndACKFirst => {
2486 RAACommitmentOrder::CommitmentFirst => {
2491 if let Some(msg) = shutdown {
2492 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
2493 node_id: their_node_id.clone(),
2499 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2503 /// Begin Update fee process. Allowed only on an outbound channel.
2504 /// If successful, will generate a UpdateHTLCs event, so you should probably poll
2505 /// PeerManager::process_events afterwards.
2506 /// Note: This API is likely to change!
2508 pub fn update_fee(&self, channel_id: [u8;32], feerate_per_kw: u64) -> Result<(), APIError> {
2509 let _ = self.total_consistency_lock.read().unwrap();
2511 let err: Result<(), _> = loop {
2512 let mut channel_state_lock = self.channel_state.lock().unwrap();
2513 let channel_state = channel_state_lock.borrow_parts();
2515 match channel_state.by_id.entry(channel_id) {
2516 hash_map::Entry::Vacant(_) => return Err(APIError::APIMisuseError{err: "Failed to find corresponding channel"}),
2517 hash_map::Entry::Occupied(mut chan) => {
2518 if !chan.get().is_outbound() {
2519 return Err(APIError::APIMisuseError{err: "update_fee cannot be sent for an inbound channel"});
2521 if chan.get().is_awaiting_monitor_update() {
2522 return Err(APIError::MonitorUpdateFailed);
2524 if !chan.get().is_live() {
2525 return Err(APIError::ChannelUnavailable{err: "Channel is either not yet fully established or peer is currently disconnected"});
2527 their_node_id = chan.get().get_their_node_id();
2528 if let Some((update_fee, commitment_signed, chan_monitor)) =
2529 break_chan_entry!(self, chan.get_mut().send_update_fee_and_commit(feerate_per_kw), channel_state, chan)
2531 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
2534 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2535 node_id: chan.get().get_their_node_id(),
2536 updates: msgs::CommitmentUpdate {
2537 update_add_htlcs: Vec::new(),
2538 update_fulfill_htlcs: Vec::new(),
2539 update_fail_htlcs: Vec::new(),
2540 update_fail_malformed_htlcs: Vec::new(),
2541 update_fee: Some(update_fee),
2551 match handle_error!(self, err) {
2552 Ok(_) => unreachable!(),
2554 if let msgs::ErrorAction::IgnoreError = e.action {
2556 log_error!(self, "Got bad keys: {}!", e.err);
2557 let mut channel_state = self.channel_state.lock().unwrap();
2558 channel_state.pending_msg_events.push(events::MessageSendEvent::HandleError {
2559 node_id: their_node_id,
2563 Err(APIError::APIMisuseError { err: e.err })
2569 impl<'a> events::MessageSendEventsProvider for ChannelManager<'a> {
2570 fn get_and_clear_pending_msg_events(&self) -> Vec<events::MessageSendEvent> {
2571 // TODO: Event release to users and serialization is currently race-y: it's very easy for a
2572 // user to serialize a ChannelManager with pending events in it and lose those events on
2573 // restart. This is doubly true for the fail/fulfill-backs from monitor events!
2575 //TODO: This behavior should be documented.
2576 for htlc_update in self.monitor.fetch_pending_htlc_updated() {
2577 if let Some(preimage) = htlc_update.payment_preimage {
2578 log_trace!(self, "Claiming HTLC with preimage {} from our monitor", log_bytes!(preimage.0));
2579 self.claim_funds_internal(self.channel_state.lock().unwrap(), htlc_update.source, preimage);
2581 log_trace!(self, "Failing HTLC with hash {} from our monitor", log_bytes!(htlc_update.payment_hash.0));
2582 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_update.source, &htlc_update.payment_hash, HTLCFailReason::Reason { failure_code: 0x4000 | 8, data: Vec::new() });
2587 let mut ret = Vec::new();
2588 let mut channel_state = self.channel_state.lock().unwrap();
2589 mem::swap(&mut ret, &mut channel_state.pending_msg_events);
2594 impl<'a> events::EventsProvider for ChannelManager<'a> {
2595 fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
2596 // TODO: Event release to users and serialization is currently race-y: it's very easy for a
2597 // user to serialize a ChannelManager with pending events in it and lose those events on
2598 // restart. This is doubly true for the fail/fulfill-backs from monitor events!
2600 //TODO: This behavior should be documented.
2601 for htlc_update in self.monitor.fetch_pending_htlc_updated() {
2602 if let Some(preimage) = htlc_update.payment_preimage {
2603 log_trace!(self, "Claiming HTLC with preimage {} from our monitor", log_bytes!(preimage.0));
2604 self.claim_funds_internal(self.channel_state.lock().unwrap(), htlc_update.source, preimage);
2606 log_trace!(self, "Failing HTLC with hash {} from our monitor", log_bytes!(htlc_update.payment_hash.0));
2607 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() });
2612 let mut ret = Vec::new();
2613 let mut pending_events = self.pending_events.lock().unwrap();
2614 mem::swap(&mut ret, &mut *pending_events);
2619 impl<'a> ChainListener for ChannelManager<'a> {
2620 fn block_connected(&self, header: &BlockHeader, height: u32, txn_matched: &[&Transaction], indexes_of_txn_matched: &[u32]) {
2621 let header_hash = header.bitcoin_hash();
2622 log_trace!(self, "Block {} at height {} connected with {} txn matched", header_hash, height, txn_matched.len());
2623 let _ = self.total_consistency_lock.read().unwrap();
2624 let mut failed_channels = Vec::new();
2626 let mut channel_lock = self.channel_state.lock().unwrap();
2627 let channel_state = channel_lock.borrow_parts();
2628 let short_to_id = channel_state.short_to_id;
2629 let pending_msg_events = channel_state.pending_msg_events;
2630 channel_state.by_id.retain(|_, channel| {
2631 let chan_res = channel.block_connected(header, height, txn_matched, indexes_of_txn_matched);
2632 if let Ok(Some(funding_locked)) = chan_res {
2633 pending_msg_events.push(events::MessageSendEvent::SendFundingLocked {
2634 node_id: channel.get_their_node_id(),
2635 msg: funding_locked,
2637 if let Some(announcement_sigs) = self.get_announcement_sigs(channel) {
2638 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
2639 node_id: channel.get_their_node_id(),
2640 msg: announcement_sigs,
2643 short_to_id.insert(channel.get_short_channel_id().unwrap(), channel.channel_id());
2644 } else if let Err(e) = chan_res {
2645 pending_msg_events.push(events::MessageSendEvent::HandleError {
2646 node_id: channel.get_their_node_id(),
2647 action: msgs::ErrorAction::SendErrorMessage { msg: e },
2651 if let Some(funding_txo) = channel.get_funding_txo() {
2652 for tx in txn_matched {
2653 for inp in tx.input.iter() {
2654 if inp.previous_output == funding_txo.into_bitcoin_outpoint() {
2655 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()));
2656 if let Some(short_id) = channel.get_short_channel_id() {
2657 short_to_id.remove(&short_id);
2659 // It looks like our counterparty went on-chain. We go ahead and
2660 // broadcast our latest local state as well here, just in case its
2661 // some kind of SPV attack, though we expect these to be dropped.
2662 failed_channels.push(channel.force_shutdown());
2663 if let Ok(update) = self.get_channel_update(&channel) {
2664 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2673 if channel.is_funding_initiated() && channel.channel_monitor().would_broadcast_at_height(height) {
2674 if let Some(short_id) = channel.get_short_channel_id() {
2675 short_to_id.remove(&short_id);
2677 failed_channels.push(channel.force_shutdown());
2678 // If would_broadcast_at_height() is true, the channel_monitor will broadcast
2679 // the latest local tx for us, so we should skip that here (it doesn't really
2680 // hurt anything, but does make tests a bit simpler).
2681 failed_channels.last_mut().unwrap().0 = Vec::new();
2682 if let Ok(update) = self.get_channel_update(&channel) {
2683 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2692 for failure in failed_channels.drain(..) {
2693 self.finish_force_close_channel(failure);
2695 self.latest_block_height.store(height as usize, Ordering::Release);
2696 *self.last_block_hash.try_lock().expect("block_(dis)connected must not be called in parallel") = header_hash;
2699 /// We force-close the channel without letting our counterparty participate in the shutdown
2700 fn block_disconnected(&self, header: &BlockHeader, _: u32) {
2701 let _ = self.total_consistency_lock.read().unwrap();
2702 let mut failed_channels = Vec::new();
2704 let mut channel_lock = self.channel_state.lock().unwrap();
2705 let channel_state = channel_lock.borrow_parts();
2706 let short_to_id = channel_state.short_to_id;
2707 let pending_msg_events = channel_state.pending_msg_events;
2708 channel_state.by_id.retain(|_, v| {
2709 if v.block_disconnected(header) {
2710 if let Some(short_id) = v.get_short_channel_id() {
2711 short_to_id.remove(&short_id);
2713 failed_channels.push(v.force_shutdown());
2714 if let Ok(update) = self.get_channel_update(&v) {
2715 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2725 for failure in failed_channels.drain(..) {
2726 self.finish_force_close_channel(failure);
2728 self.latest_block_height.fetch_sub(1, Ordering::AcqRel);
2729 *self.last_block_hash.try_lock().expect("block_(dis)connected must not be called in parallel") = header.bitcoin_hash();
2733 impl<'a> ChannelMessageHandler for ChannelManager<'a> {
2734 //TODO: Handle errors and close channel (or so)
2735 fn handle_open_channel(&self, their_node_id: &PublicKey, their_local_features: LocalFeatures, msg: &msgs::OpenChannel) -> Result<(), LightningError> {
2736 let _ = self.total_consistency_lock.read().unwrap();
2737 handle_error!(self, self.internal_open_channel(their_node_id, their_local_features, msg))
2740 fn handle_accept_channel(&self, their_node_id: &PublicKey, their_local_features: LocalFeatures, msg: &msgs::AcceptChannel) -> Result<(), LightningError> {
2741 let _ = self.total_consistency_lock.read().unwrap();
2742 handle_error!(self, self.internal_accept_channel(their_node_id, their_local_features, msg))
2745 fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), LightningError> {
2746 let _ = self.total_consistency_lock.read().unwrap();
2747 handle_error!(self, self.internal_funding_created(their_node_id, msg))
2750 fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), LightningError> {
2751 let _ = self.total_consistency_lock.read().unwrap();
2752 handle_error!(self, self.internal_funding_signed(their_node_id, msg))
2755 fn handle_funding_locked(&self, their_node_id: &PublicKey, msg: &msgs::FundingLocked) -> Result<(), LightningError> {
2756 let _ = self.total_consistency_lock.read().unwrap();
2757 handle_error!(self, self.internal_funding_locked(their_node_id, msg))
2760 fn handle_shutdown(&self, their_node_id: &PublicKey, msg: &msgs::Shutdown) -> Result<(), LightningError> {
2761 let _ = self.total_consistency_lock.read().unwrap();
2762 handle_error!(self, self.internal_shutdown(their_node_id, msg))
2765 fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<(), LightningError> {
2766 let _ = self.total_consistency_lock.read().unwrap();
2767 handle_error!(self, self.internal_closing_signed(their_node_id, msg))
2770 fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), LightningError> {
2771 let _ = self.total_consistency_lock.read().unwrap();
2772 handle_error!(self, self.internal_update_add_htlc(their_node_id, msg))
2775 fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), LightningError> {
2776 let _ = self.total_consistency_lock.read().unwrap();
2777 handle_error!(self, self.internal_update_fulfill_htlc(their_node_id, msg))
2780 fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), LightningError> {
2781 let _ = self.total_consistency_lock.read().unwrap();
2782 handle_error!(self, self.internal_update_fail_htlc(their_node_id, msg))
2785 fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), LightningError> {
2786 let _ = self.total_consistency_lock.read().unwrap();
2787 handle_error!(self, self.internal_update_fail_malformed_htlc(their_node_id, msg))
2790 fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), LightningError> {
2791 let _ = self.total_consistency_lock.read().unwrap();
2792 handle_error!(self, self.internal_commitment_signed(their_node_id, msg))
2795 fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), LightningError> {
2796 let _ = self.total_consistency_lock.read().unwrap();
2797 handle_error!(self, self.internal_revoke_and_ack(their_node_id, msg))
2800 fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), LightningError> {
2801 let _ = self.total_consistency_lock.read().unwrap();
2802 handle_error!(self, self.internal_update_fee(their_node_id, msg))
2805 fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), LightningError> {
2806 let _ = self.total_consistency_lock.read().unwrap();
2807 handle_error!(self, self.internal_announcement_signatures(their_node_id, msg))
2810 fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<(), LightningError> {
2811 let _ = self.total_consistency_lock.read().unwrap();
2812 handle_error!(self, self.internal_channel_reestablish(their_node_id, msg))
2815 fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool) {
2816 let _ = self.total_consistency_lock.read().unwrap();
2817 let mut failed_channels = Vec::new();
2818 let mut failed_payments = Vec::new();
2820 let mut channel_state_lock = self.channel_state.lock().unwrap();
2821 let channel_state = channel_state_lock.borrow_parts();
2822 let short_to_id = channel_state.short_to_id;
2823 let pending_msg_events = channel_state.pending_msg_events;
2824 if no_connection_possible {
2825 log_debug!(self, "Failing all channels with {} due to no_connection_possible", log_pubkey!(their_node_id));
2826 channel_state.by_id.retain(|_, chan| {
2827 if chan.get_their_node_id() == *their_node_id {
2828 if let Some(short_id) = chan.get_short_channel_id() {
2829 short_to_id.remove(&short_id);
2831 failed_channels.push(chan.force_shutdown());
2832 if let Ok(update) = self.get_channel_update(&chan) {
2833 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2843 log_debug!(self, "Marking channels with {} disconnected and generating channel_updates", log_pubkey!(their_node_id));
2844 channel_state.by_id.retain(|_, chan| {
2845 if chan.get_their_node_id() == *their_node_id {
2846 let failed_adds = chan.remove_uncommitted_htlcs_and_mark_paused();
2847 chan.to_disabled_marked();
2848 if !failed_adds.is_empty() {
2849 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
2850 failed_payments.push((chan_update, failed_adds));
2852 if chan.is_shutdown() {
2853 if let Some(short_id) = chan.get_short_channel_id() {
2854 short_to_id.remove(&short_id);
2862 pending_msg_events.retain(|msg| {
2864 &events::MessageSendEvent::SendAcceptChannel { ref node_id, .. } => node_id != their_node_id,
2865 &events::MessageSendEvent::SendOpenChannel { ref node_id, .. } => node_id != their_node_id,
2866 &events::MessageSendEvent::SendFundingCreated { ref node_id, .. } => node_id != their_node_id,
2867 &events::MessageSendEvent::SendFundingSigned { ref node_id, .. } => node_id != their_node_id,
2868 &events::MessageSendEvent::SendFundingLocked { ref node_id, .. } => node_id != their_node_id,
2869 &events::MessageSendEvent::SendAnnouncementSignatures { ref node_id, .. } => node_id != their_node_id,
2870 &events::MessageSendEvent::UpdateHTLCs { ref node_id, .. } => node_id != their_node_id,
2871 &events::MessageSendEvent::SendRevokeAndACK { ref node_id, .. } => node_id != their_node_id,
2872 &events::MessageSendEvent::SendClosingSigned { ref node_id, .. } => node_id != their_node_id,
2873 &events::MessageSendEvent::SendShutdown { ref node_id, .. } => node_id != their_node_id,
2874 &events::MessageSendEvent::SendChannelReestablish { ref node_id, .. } => node_id != their_node_id,
2875 &events::MessageSendEvent::BroadcastChannelAnnouncement { .. } => true,
2876 &events::MessageSendEvent::BroadcastChannelUpdate { .. } => true,
2877 &events::MessageSendEvent::HandleError { ref node_id, .. } => node_id != their_node_id,
2878 &events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => true,
2882 for failure in failed_channels.drain(..) {
2883 self.finish_force_close_channel(failure);
2885 for (chan_update, mut htlc_sources) in failed_payments {
2886 for (htlc_source, payment_hash) in htlc_sources.drain(..) {
2887 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source, &payment_hash, HTLCFailReason::Reason { failure_code: 0x1000 | 7, data: chan_update.clone() });
2892 fn peer_connected(&self, their_node_id: &PublicKey) {
2893 log_debug!(self, "Generating channel_reestablish events for {}", log_pubkey!(their_node_id));
2895 let _ = self.total_consistency_lock.read().unwrap();
2896 let mut channel_state_lock = self.channel_state.lock().unwrap();
2897 let channel_state = channel_state_lock.borrow_parts();
2898 let pending_msg_events = channel_state.pending_msg_events;
2899 channel_state.by_id.retain(|_, chan| {
2900 if chan.get_their_node_id() == *their_node_id {
2901 if !chan.have_received_message() {
2902 // If we created this (outbound) channel while we were disconnected from the
2903 // peer we probably failed to send the open_channel message, which is now
2904 // lost. We can't have had anything pending related to this channel, so we just
2908 pending_msg_events.push(events::MessageSendEvent::SendChannelReestablish {
2909 node_id: chan.get_their_node_id(),
2910 msg: chan.get_channel_reestablish(),
2916 //TODO: Also re-broadcast announcement_signatures
2919 fn handle_error(&self, their_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
2920 let _ = self.total_consistency_lock.read().unwrap();
2922 if msg.channel_id == [0; 32] {
2923 for chan in self.list_channels() {
2924 if chan.remote_network_id == *their_node_id {
2925 self.force_close_channel(&chan.channel_id);
2929 self.force_close_channel(&msg.channel_id);
2934 const SERIALIZATION_VERSION: u8 = 1;
2935 const MIN_SERIALIZATION_VERSION: u8 = 1;
2937 impl Writeable for PendingForwardHTLCInfo {
2938 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
2939 self.onion_packet.write(writer)?;
2940 self.incoming_shared_secret.write(writer)?;
2941 self.payment_hash.write(writer)?;
2942 self.short_channel_id.write(writer)?;
2943 self.amt_to_forward.write(writer)?;
2944 self.outgoing_cltv_value.write(writer)?;
2949 impl<R: ::std::io::Read> Readable<R> for PendingForwardHTLCInfo {
2950 fn read(reader: &mut R) -> Result<PendingForwardHTLCInfo, DecodeError> {
2951 Ok(PendingForwardHTLCInfo {
2952 onion_packet: Readable::read(reader)?,
2953 incoming_shared_secret: Readable::read(reader)?,
2954 payment_hash: Readable::read(reader)?,
2955 short_channel_id: Readable::read(reader)?,
2956 amt_to_forward: Readable::read(reader)?,
2957 outgoing_cltv_value: Readable::read(reader)?,
2962 impl Writeable for HTLCFailureMsg {
2963 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
2965 &HTLCFailureMsg::Relay(ref fail_msg) => {
2967 fail_msg.write(writer)?;
2969 &HTLCFailureMsg::Malformed(ref fail_msg) => {
2971 fail_msg.write(writer)?;
2978 impl<R: ::std::io::Read> Readable<R> for HTLCFailureMsg {
2979 fn read(reader: &mut R) -> Result<HTLCFailureMsg, DecodeError> {
2980 match <u8 as Readable<R>>::read(reader)? {
2981 0 => Ok(HTLCFailureMsg::Relay(Readable::read(reader)?)),
2982 1 => Ok(HTLCFailureMsg::Malformed(Readable::read(reader)?)),
2983 _ => Err(DecodeError::InvalidValue),
2988 impl Writeable for PendingHTLCStatus {
2989 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
2991 &PendingHTLCStatus::Forward(ref forward_info) => {
2993 forward_info.write(writer)?;
2995 &PendingHTLCStatus::Fail(ref fail_msg) => {
2997 fail_msg.write(writer)?;
3004 impl<R: ::std::io::Read> Readable<R> for PendingHTLCStatus {
3005 fn read(reader: &mut R) -> Result<PendingHTLCStatus, DecodeError> {
3006 match <u8 as Readable<R>>::read(reader)? {
3007 0 => Ok(PendingHTLCStatus::Forward(Readable::read(reader)?)),
3008 1 => Ok(PendingHTLCStatus::Fail(Readable::read(reader)?)),
3009 _ => Err(DecodeError::InvalidValue),
3014 impl_writeable!(HTLCPreviousHopData, 0, {
3017 incoming_packet_shared_secret
3020 impl Writeable for HTLCSource {
3021 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3023 &HTLCSource::PreviousHopData(ref hop_data) => {
3025 hop_data.write(writer)?;
3027 &HTLCSource::OutboundRoute { ref route, ref session_priv, ref first_hop_htlc_msat } => {
3029 route.write(writer)?;
3030 session_priv.write(writer)?;
3031 first_hop_htlc_msat.write(writer)?;
3038 impl<R: ::std::io::Read> Readable<R> for HTLCSource {
3039 fn read(reader: &mut R) -> Result<HTLCSource, DecodeError> {
3040 match <u8 as Readable<R>>::read(reader)? {
3041 0 => Ok(HTLCSource::PreviousHopData(Readable::read(reader)?)),
3042 1 => Ok(HTLCSource::OutboundRoute {
3043 route: Readable::read(reader)?,
3044 session_priv: Readable::read(reader)?,
3045 first_hop_htlc_msat: Readable::read(reader)?,
3047 _ => Err(DecodeError::InvalidValue),
3052 impl Writeable for HTLCFailReason {
3053 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3055 &HTLCFailReason::LightningError { ref err } => {
3059 &HTLCFailReason::Reason { ref failure_code, ref data } => {
3061 failure_code.write(writer)?;
3062 data.write(writer)?;
3069 impl<R: ::std::io::Read> Readable<R> for HTLCFailReason {
3070 fn read(reader: &mut R) -> Result<HTLCFailReason, DecodeError> {
3071 match <u8 as Readable<R>>::read(reader)? {
3072 0 => Ok(HTLCFailReason::LightningError { err: Readable::read(reader)? }),
3073 1 => Ok(HTLCFailReason::Reason {
3074 failure_code: Readable::read(reader)?,
3075 data: Readable::read(reader)?,
3077 _ => Err(DecodeError::InvalidValue),
3082 impl Writeable for HTLCForwardInfo {
3083 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3085 &HTLCForwardInfo::AddHTLC { ref prev_short_channel_id, ref prev_htlc_id, ref forward_info } => {
3087 prev_short_channel_id.write(writer)?;
3088 prev_htlc_id.write(writer)?;
3089 forward_info.write(writer)?;
3091 &HTLCForwardInfo::FailHTLC { ref htlc_id, ref err_packet } => {
3093 htlc_id.write(writer)?;
3094 err_packet.write(writer)?;
3101 impl<R: ::std::io::Read> Readable<R> for HTLCForwardInfo {
3102 fn read(reader: &mut R) -> Result<HTLCForwardInfo, DecodeError> {
3103 match <u8 as Readable<R>>::read(reader)? {
3104 0 => Ok(HTLCForwardInfo::AddHTLC {
3105 prev_short_channel_id: Readable::read(reader)?,
3106 prev_htlc_id: Readable::read(reader)?,
3107 forward_info: Readable::read(reader)?,
3109 1 => Ok(HTLCForwardInfo::FailHTLC {
3110 htlc_id: Readable::read(reader)?,
3111 err_packet: Readable::read(reader)?,
3113 _ => Err(DecodeError::InvalidValue),
3118 impl<'a> Writeable for ChannelManager<'a> {
3119 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3120 let _ = self.total_consistency_lock.write().unwrap();
3122 writer.write_all(&[SERIALIZATION_VERSION; 1])?;
3123 writer.write_all(&[MIN_SERIALIZATION_VERSION; 1])?;
3125 self.genesis_hash.write(writer)?;
3126 (self.latest_block_height.load(Ordering::Acquire) as u32).write(writer)?;
3127 self.last_block_hash.lock().unwrap().write(writer)?;
3129 let channel_state = self.channel_state.lock().unwrap();
3130 let mut unfunded_channels = 0;
3131 for (_, channel) in channel_state.by_id.iter() {
3132 if !channel.is_funding_initiated() {
3133 unfunded_channels += 1;
3136 ((channel_state.by_id.len() - unfunded_channels) as u64).write(writer)?;
3137 for (_, channel) in channel_state.by_id.iter() {
3138 if channel.is_funding_initiated() {
3139 channel.write(writer)?;
3143 (channel_state.forward_htlcs.len() as u64).write(writer)?;
3144 for (short_channel_id, pending_forwards) in channel_state.forward_htlcs.iter() {
3145 short_channel_id.write(writer)?;
3146 (pending_forwards.len() as u64).write(writer)?;
3147 for forward in pending_forwards {
3148 forward.write(writer)?;
3152 (channel_state.claimable_htlcs.len() as u64).write(writer)?;
3153 for (payment_hash, previous_hops) in channel_state.claimable_htlcs.iter() {
3154 payment_hash.write(writer)?;
3155 (previous_hops.len() as u64).write(writer)?;
3156 for &(recvd_amt, ref previous_hop) in previous_hops.iter() {
3157 recvd_amt.write(writer)?;
3158 previous_hop.write(writer)?;
3166 /// Arguments for the creation of a ChannelManager that are not deserialized.
3168 /// At a high-level, the process for deserializing a ChannelManager and resuming normal operation
3170 /// 1) Deserialize all stored ChannelMonitors.
3171 /// 2) Deserialize the ChannelManager by filling in this struct and calling <(Sha256dHash,
3172 /// ChannelManager)>::read(reader, args).
3173 /// This may result in closing some Channels if the ChannelMonitor is newer than the stored
3174 /// ChannelManager state to ensure no loss of funds. Thus, transactions may be broadcasted.
3175 /// 3) Register all relevant ChannelMonitor outpoints with your chain watch mechanism using
3176 /// ChannelMonitor::get_monitored_outpoints and ChannelMonitor::get_funding_txo().
3177 /// 4) Reconnect blocks on your ChannelMonitors.
3178 /// 5) Move the ChannelMonitors into your local ManyChannelMonitor.
3179 /// 6) Disconnect/connect blocks on the ChannelManager.
3180 /// 7) Register the new ChannelManager with your ChainWatchInterface.
3181 pub struct ChannelManagerReadArgs<'a, 'b> {
3182 /// The keys provider which will give us relevant keys. Some keys will be loaded during
3183 /// deserialization.
3184 pub keys_manager: Arc<KeysInterface>,
3186 /// The fee_estimator for use in the ChannelManager in the future.
3188 /// No calls to the FeeEstimator will be made during deserialization.
3189 pub fee_estimator: Arc<FeeEstimator>,
3190 /// The ManyChannelMonitor for use in the ChannelManager in the future.
3192 /// No calls to the ManyChannelMonitor will be made during deserialization. It is assumed that
3193 /// you have deserialized ChannelMonitors separately and will add them to your
3194 /// ManyChannelMonitor after deserializing this ChannelManager.
3195 pub monitor: Arc<ManyChannelMonitor + 'b>,
3197 /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
3198 /// used to broadcast the latest local commitment transactions of channels which must be
3199 /// force-closed during deserialization.
3200 pub tx_broadcaster: Arc<BroadcasterInterface>,
3201 /// The Logger for use in the ChannelManager and which may be used to log information during
3202 /// deserialization.
3203 pub logger: Arc<Logger>,
3204 /// Default settings used for new channels. Any existing channels will continue to use the
3205 /// runtime settings which were stored when the ChannelManager was serialized.
3206 pub default_config: UserConfig,
3208 /// A map from channel funding outpoints to ChannelMonitors for those channels (ie
3209 /// value.get_funding_txo() should be the key).
3211 /// If a monitor is inconsistent with the channel state during deserialization the channel will
3212 /// be force-closed using the data in the ChannelMonitor and the channel will be dropped. This
3213 /// is true for missing channels as well. If there is a monitor missing for which we find
3214 /// channel data Err(DecodeError::InvalidValue) will be returned.
3216 /// In such cases the latest local transactions will be sent to the tx_broadcaster included in
3218 pub channel_monitors: &'a HashMap<OutPoint, &'a ChannelMonitor>,
3221 impl<'a, 'b, R : ::std::io::Read> ReadableArgs<R, ChannelManagerReadArgs<'a, 'b>> for (Sha256dHash, ChannelManager<'b>) {
3222 fn read(reader: &mut R, args: ChannelManagerReadArgs<'a, 'b>) -> Result<Self, DecodeError> {
3223 let _ver: u8 = Readable::read(reader)?;
3224 let min_ver: u8 = Readable::read(reader)?;
3225 if min_ver > SERIALIZATION_VERSION {
3226 return Err(DecodeError::UnknownVersion);
3229 let genesis_hash: Sha256dHash = Readable::read(reader)?;
3230 let latest_block_height: u32 = Readable::read(reader)?;
3231 let last_block_hash: Sha256dHash = Readable::read(reader)?;
3233 let mut closed_channels = Vec::new();
3235 let channel_count: u64 = Readable::read(reader)?;
3236 let mut funding_txo_set = HashSet::with_capacity(cmp::min(channel_count as usize, 128));
3237 let mut by_id = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
3238 let mut short_to_id = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
3239 for _ in 0..channel_count {
3240 let mut channel: Channel = ReadableArgs::read(reader, args.logger.clone())?;
3241 if channel.last_block_connected != last_block_hash {
3242 return Err(DecodeError::InvalidValue);
3245 let funding_txo = channel.channel_monitor().get_funding_txo().ok_or(DecodeError::InvalidValue)?;
3246 funding_txo_set.insert(funding_txo.clone());
3247 if let Some(monitor) = args.channel_monitors.get(&funding_txo) {
3248 if channel.get_cur_local_commitment_transaction_number() != monitor.get_cur_local_commitment_number() ||
3249 channel.get_revoked_remote_commitment_transaction_number() != monitor.get_min_seen_secret() ||
3250 channel.get_cur_remote_commitment_transaction_number() != monitor.get_cur_remote_commitment_number() {
3251 let mut force_close_res = channel.force_shutdown();
3252 force_close_res.0 = monitor.get_latest_local_commitment_txn();
3253 closed_channels.push(force_close_res);
3255 if let Some(short_channel_id) = channel.get_short_channel_id() {
3256 short_to_id.insert(short_channel_id, channel.channel_id());
3258 by_id.insert(channel.channel_id(), channel);
3261 return Err(DecodeError::InvalidValue);
3265 for (ref funding_txo, ref monitor) in args.channel_monitors.iter() {
3266 if !funding_txo_set.contains(funding_txo) {
3267 closed_channels.push((monitor.get_latest_local_commitment_txn(), Vec::new()));
3271 let forward_htlcs_count: u64 = Readable::read(reader)?;
3272 let mut forward_htlcs = HashMap::with_capacity(cmp::min(forward_htlcs_count as usize, 128));
3273 for _ in 0..forward_htlcs_count {
3274 let short_channel_id = Readable::read(reader)?;
3275 let pending_forwards_count: u64 = Readable::read(reader)?;
3276 let mut pending_forwards = Vec::with_capacity(cmp::min(pending_forwards_count as usize, 128));
3277 for _ in 0..pending_forwards_count {
3278 pending_forwards.push(Readable::read(reader)?);
3280 forward_htlcs.insert(short_channel_id, pending_forwards);
3283 let claimable_htlcs_count: u64 = Readable::read(reader)?;
3284 let mut claimable_htlcs = HashMap::with_capacity(cmp::min(claimable_htlcs_count as usize, 128));
3285 for _ in 0..claimable_htlcs_count {
3286 let payment_hash = Readable::read(reader)?;
3287 let previous_hops_len: u64 = Readable::read(reader)?;
3288 let mut previous_hops = Vec::with_capacity(cmp::min(previous_hops_len as usize, 2));
3289 for _ in 0..previous_hops_len {
3290 previous_hops.push((Readable::read(reader)?, Readable::read(reader)?));
3292 claimable_htlcs.insert(payment_hash, previous_hops);
3295 let channel_manager = ChannelManager {
3297 fee_estimator: args.fee_estimator,
3298 monitor: args.monitor,
3299 tx_broadcaster: args.tx_broadcaster,
3301 latest_block_height: AtomicUsize::new(latest_block_height as usize),
3302 last_block_hash: Mutex::new(last_block_hash),
3303 secp_ctx: Secp256k1::new(),
3305 channel_state: Mutex::new(ChannelHolder {
3310 pending_msg_events: Vec::new(),
3312 our_network_key: args.keys_manager.get_node_secret(),
3314 pending_events: Mutex::new(Vec::new()),
3315 total_consistency_lock: RwLock::new(()),
3316 keys_manager: args.keys_manager,
3317 logger: args.logger,
3318 default_configuration: args.default_config,
3321 for close_res in closed_channels.drain(..) {
3322 channel_manager.finish_force_close_channel(close_res);
3323 //TODO: Broadcast channel update for closed channels, but only after we've made a
3324 //connection or two.
3327 Ok((last_block_hash.clone(), channel_manager))