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,ChainWatchInterface,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, HandleError};
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::HandleError,
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 {
155 action: Some(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 {
170 action: Some(msgs::ErrorAction::IgnoreError),
172 shutdown_finish: None,
176 fn from_no_close(err: msgs::HandleError) -> 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 {
184 action: Some(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) => HandleError {
200 action: Some(msgs::ErrorAction::IgnoreError),
202 ChannelError::Close(msg) => HandleError {
204 action: Some(msgs::ErrorAction::SendErrorMessage {
205 msg: msgs::ErrorMessage {
207 data: msg.to_string()
211 ChannelError::CloseDelayBroadcast { msg, .. } => HandleError {
213 action: Some(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
321 pub struct ChannelManager {
322 default_configuration: UserConfig,
323 genesis_hash: Sha256dHash,
324 fee_estimator: Arc<FeeEstimator>,
325 monitor: Arc<ManyChannelMonitor>,
326 chain_monitor: Arc<ChainWatchInterface>,
327 tx_broadcaster: Arc<BroadcasterInterface>,
330 pub(super) latest_block_height: AtomicUsize,
332 latest_block_height: AtomicUsize,
333 last_block_hash: Mutex<Sha256dHash>,
334 secp_ctx: Secp256k1<secp256k1::All>,
337 pub(super) channel_state: Mutex<ChannelHolder>,
339 channel_state: Mutex<ChannelHolder>,
340 our_network_key: SecretKey,
342 pending_events: Mutex<Vec<events::Event>>,
343 /// Used when we have to take a BIG lock to make sure everything is self-consistent.
344 /// Essentially just when we're serializing ourselves out.
345 /// Taken first everywhere where we are making changes before any other locks.
346 total_consistency_lock: RwLock<()>,
348 keys_manager: Arc<KeysInterface>,
353 /// The amount of time we require our counterparty wait to claim their money (ie time between when
354 /// we, or our watchtower, must check for them having broadcast a theft transaction).
355 pub(crate) const BREAKDOWN_TIMEOUT: u16 = 6 * 24;
356 /// The amount of time we're willing to wait to claim money back to us
357 pub(crate) const MAX_LOCAL_BREAKDOWN_TIMEOUT: u16 = 6 * 24 * 7;
359 /// The minimum number of blocks between an inbound HTLC's CLTV and the corresponding outbound
360 /// HTLC's CLTV. This should always be a few blocks greater than channelmonitor::CLTV_CLAIM_BUFFER,
361 /// ie the node we forwarded the payment on to should always have enough room to reliably time out
362 /// the HTLC via a full update_fail_htlc/commitment_signed dance before we hit the
363 /// CLTV_CLAIM_BUFFER point (we static assert that it's at least 3 blocks more).
364 const CLTV_EXPIRY_DELTA: u16 = 6 * 12; //TODO?
365 pub(super) const CLTV_FAR_FAR_AWAY: u32 = 6 * 24 * 7; //TODO?
367 // Check that our CLTV_EXPIRY is at least CLTV_CLAIM_BUFFER + ANTI_REORG_DELAY + LATENCY_GRACE_PERIOD_BLOCKS,
368 // ie that if the next-hop peer fails the HTLC within
369 // LATENCY_GRACE_PERIOD_BLOCKS then we'll still have CLTV_CLAIM_BUFFER left to timeout it onchain,
370 // then waiting ANTI_REORG_DELAY to be reorg-safe on the outbound HLTC and
371 // failing the corresponding htlc backward, and us now seeing the last block of ANTI_REORG_DELAY before
372 // LATENCY_GRACE_PERIOD_BLOCKS.
375 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;
377 // Check for ability of an attacker to make us fail on-chain by delaying inbound claim. See
378 // ChannelMontior::would_broadcast_at_height for a description of why this is needed.
381 const CHECK_CLTV_EXPIRY_SANITY_2: u32 = CLTV_EXPIRY_DELTA as u32 - LATENCY_GRACE_PERIOD_BLOCKS - 2*CLTV_CLAIM_BUFFER;
383 macro_rules! secp_call {
384 ( $res: expr, $err: expr ) => {
387 Err(_) => return Err($err),
392 /// Details of a channel, as returned by ChannelManager::list_channels and ChannelManager::list_usable_channels
393 pub struct ChannelDetails {
394 /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
395 /// thereafter this is the txid of the funding transaction xor the funding transaction output).
396 /// Note that this means this value is *not* persistent - it can change once during the
397 /// lifetime of the channel.
398 pub channel_id: [u8; 32],
399 /// The position of the funding transaction in the chain. None if the funding transaction has
400 /// not yet been confirmed and the channel fully opened.
401 pub short_channel_id: Option<u64>,
402 /// The node_id of our counterparty
403 pub remote_network_id: PublicKey,
404 /// The value, in satoshis, of this channel as appears in the funding output
405 pub channel_value_satoshis: u64,
406 /// The user_id passed in to create_channel, or 0 if the channel was inbound.
408 /// The available outbound capacity for sending HTLCs to the remote peer. This does not include
409 /// any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
410 /// available for inclusion in new outbound HTLCs). This further does not include any pending
411 /// outgoing HTLCs which are awaiting some other resolution to be sent.
412 pub outbound_capacity_msat: u64,
413 /// The available inbound capacity for the remote peer to send HTLCs to us. This does not
414 /// include any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
415 /// available for inclusion in new inbound HTLCs).
416 /// Note that there are some corner cases not fully handled here, so the actual available
417 /// inbound capacity may be slightly higher than this.
418 pub inbound_capacity_msat: u64,
419 /// True if the channel is (a) confirmed and funding_locked messages have been exchanged, (b)
420 /// the peer is connected, and (c) no monitor update failure is pending resolution.
424 macro_rules! handle_error {
425 ($self: ident, $internal: expr) => {
428 Err(MsgHandleErrInternal { err, shutdown_finish }) => {
429 if let Some((shutdown_res, update_option)) = shutdown_finish {
430 $self.finish_force_close_channel(shutdown_res);
431 if let Some(update) = update_option {
432 let mut channel_state = $self.channel_state.lock().unwrap();
433 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
444 macro_rules! break_chan_entry {
445 ($self: ident, $res: expr, $channel_state: expr, $entry: expr) => {
448 Err(ChannelError::Ignore(msg)) => {
449 break Err(MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore(msg), $entry.key().clone()))
451 Err(ChannelError::Close(msg)) => {
452 log_trace!($self, "Closing channel {} due to Close-required error: {}", log_bytes!($entry.key()[..]), msg);
453 let (channel_id, mut chan) = $entry.remove_entry();
454 if let Some(short_id) = chan.get_short_channel_id() {
455 $channel_state.short_to_id.remove(&short_id);
457 break Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, chan.force_shutdown(), $self.get_channel_update(&chan).ok()))
459 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"); }
464 macro_rules! try_chan_entry {
465 ($self: ident, $res: expr, $channel_state: expr, $entry: expr) => {
468 Err(ChannelError::Ignore(msg)) => {
469 return Err(MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore(msg), $entry.key().clone()))
471 Err(ChannelError::Close(msg)) => {
472 log_trace!($self, "Closing channel {} due to Close-required error: {}", log_bytes!($entry.key()[..]), msg);
473 let (channel_id, mut chan) = $entry.remove_entry();
474 if let Some(short_id) = chan.get_short_channel_id() {
475 $channel_state.short_to_id.remove(&short_id);
477 return Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, chan.force_shutdown(), $self.get_channel_update(&chan).ok()))
479 Err(ChannelError::CloseDelayBroadcast { msg, update }) => {
480 log_error!($self, "Channel {} need to be shutdown but closing transactions not broadcast due to {}", log_bytes!($entry.key()[..]), msg);
481 let (channel_id, mut chan) = $entry.remove_entry();
482 if let Some(short_id) = chan.get_short_channel_id() {
483 $channel_state.short_to_id.remove(&short_id);
485 if let Some(update) = update {
486 if let Err(e) = $self.monitor.add_update_monitor(update.get_funding_txo().unwrap(), update) {
488 // Upstream channel is dead, but we want at least to fail backward HTLCs to save
489 // downstream channels. In case of PermanentFailure, we are not going to be able
490 // to claim back to_remote output on remote commitment transaction. Doesn't
491 // make a difference here, we are concern about HTLCs circuit, not onchain funds.
492 ChannelMonitorUpdateErr::PermanentFailure => {},
493 ChannelMonitorUpdateErr::TemporaryFailure => {},
497 let mut shutdown_res = chan.force_shutdown(); // We drop closing transactions as they are toxic datas and MUST NOT be broadcast
498 shutdown_res.0.clear();
499 return Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, shutdown_res, $self.get_channel_update(&chan).ok()))
505 macro_rules! handle_monitor_err {
506 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
507 handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment, Vec::new(), Vec::new())
509 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr, $failed_forwards: expr, $failed_fails: expr) => {
511 ChannelMonitorUpdateErr::PermanentFailure => {
512 log_error!($self, "Closing channel {} due to monitor update PermanentFailure", log_bytes!($entry.key()[..]));
513 let (channel_id, mut chan) = $entry.remove_entry();
514 if let Some(short_id) = chan.get_short_channel_id() {
515 $channel_state.short_to_id.remove(&short_id);
517 // TODO: $failed_fails is dropped here, which will cause other channels to hit the
518 // chain in a confused state! We need to move them into the ChannelMonitor which
519 // will be responsible for failing backwards once things confirm on-chain.
520 // It's ok that we drop $failed_forwards here - at this point we'd rather they
521 // broadcast HTLC-Timeout and pay the associated fees to get their funds back than
522 // us bother trying to claim it just to forward on to another peer. If we're
523 // splitting hairs we'd prefer to claim payments that were to us, but we haven't
524 // given up the preimage yet, so might as well just wait until the payment is
525 // retried, avoiding the on-chain fees.
526 let res: Result<(), _> = Err(MsgHandleErrInternal::from_finish_shutdown("ChannelMonitor storage failure", channel_id, chan.force_shutdown(), $self.get_channel_update(&chan).ok()));
529 ChannelMonitorUpdateErr::TemporaryFailure => {
530 log_info!($self, "Disabling channel {} due to monitor update TemporaryFailure. On restore will send {} and process {} forwards and {} fails",
531 log_bytes!($entry.key()[..]),
532 if $resend_commitment && $resend_raa {
534 RAACommitmentOrder::CommitmentFirst => { "commitment then RAA" },
535 RAACommitmentOrder::RevokeAndACKFirst => { "RAA then commitment" },
537 } else if $resend_commitment { "commitment" }
538 else if $resend_raa { "RAA" }
540 (&$failed_forwards as &Vec<(PendingForwardHTLCInfo, u64)>).len(),
541 (&$failed_fails as &Vec<(HTLCSource, PaymentHash, HTLCFailReason)>).len());
542 if !$resend_commitment {
543 debug_assert!($action_type == RAACommitmentOrder::RevokeAndACKFirst || !$resend_raa);
546 debug_assert!($action_type == RAACommitmentOrder::CommitmentFirst || !$resend_commitment);
548 $entry.get_mut().monitor_update_failed($resend_raa, $resend_commitment, $failed_forwards, $failed_fails);
549 Err(MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore("Failed to update ChannelMonitor"), *$entry.key()))
555 macro_rules! return_monitor_err {
556 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
557 return handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment);
559 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr, $failed_forwards: expr, $failed_fails: expr) => {
560 return handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment, $failed_forwards, $failed_fails);
564 // Does not break in case of TemporaryFailure!
565 macro_rules! maybe_break_monitor_err {
566 ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
567 match (handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment), $err) {
568 (e, ChannelMonitorUpdateErr::PermanentFailure) => {
571 (_, ChannelMonitorUpdateErr::TemporaryFailure) => { },
576 impl ChannelManager {
577 /// Constructs a new ChannelManager to hold several channels and route between them.
579 /// This is the main "logic hub" for all channel-related actions, and implements
580 /// ChannelMessageHandler.
582 /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
584 /// panics if channel_value_satoshis is >= `MAX_FUNDING_SATOSHIS`!
585 pub fn new(network: Network, feeest: Arc<FeeEstimator>, monitor: Arc<ManyChannelMonitor>, chain_monitor: Arc<ChainWatchInterface>, tx_broadcaster: Arc<BroadcasterInterface>, logger: Arc<Logger>,keys_manager: Arc<KeysInterface>, config: UserConfig) -> Result<Arc<ChannelManager>, secp256k1::Error> {
586 let secp_ctx = Secp256k1::new();
588 let res = Arc::new(ChannelManager {
589 default_configuration: config.clone(),
590 genesis_hash: genesis_block(network).header.bitcoin_hash(),
591 fee_estimator: feeest.clone(),
592 monitor: monitor.clone(),
596 latest_block_height: AtomicUsize::new(0), //TODO: Get an init value
597 last_block_hash: Mutex::new(Default::default()),
600 channel_state: Mutex::new(ChannelHolder{
601 by_id: HashMap::new(),
602 short_to_id: HashMap::new(),
603 forward_htlcs: HashMap::new(),
604 claimable_htlcs: HashMap::new(),
605 pending_msg_events: Vec::new(),
607 our_network_key: keys_manager.get_node_secret(),
609 pending_events: Mutex::new(Vec::new()),
610 total_consistency_lock: RwLock::new(()),
616 let weak_res = Arc::downgrade(&res);
617 res.chain_monitor.register_listener(weak_res);
621 /// Creates a new outbound channel to the given remote node and with the given value.
623 /// user_id will be provided back as user_channel_id in FundingGenerationReady and
624 /// FundingBroadcastSafe events to allow tracking of which events correspond with which
625 /// create_channel call. Note that user_channel_id defaults to 0 for inbound channels, so you
626 /// may wish to avoid using 0 for user_id here.
628 /// If successful, will generate a SendOpenChannel message event, so you should probably poll
629 /// PeerManager::process_events afterwards.
631 /// Raises APIError::APIMisuseError when channel_value_satoshis > 2**24 or push_msat is
632 /// greater than channel_value_satoshis * 1k or channel_value_satoshis is < 1000.
633 pub fn create_channel(&self, their_network_key: PublicKey, channel_value_satoshis: u64, push_msat: u64, user_id: u64) -> Result<(), APIError> {
634 if channel_value_satoshis < 1000 {
635 return Err(APIError::APIMisuseError { err: "channel_value must be at least 1000 satoshis" });
638 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)?;
639 let res = channel.get_open_channel(self.genesis_hash.clone(), &*self.fee_estimator);
641 let _ = self.total_consistency_lock.read().unwrap();
642 let mut channel_state = self.channel_state.lock().unwrap();
643 match channel_state.by_id.entry(channel.channel_id()) {
644 hash_map::Entry::Occupied(_) => {
645 if cfg!(feature = "fuzztarget") {
646 return Err(APIError::APIMisuseError { err: "Fuzzy bad RNG" });
648 panic!("RNG is bad???");
651 hash_map::Entry::Vacant(entry) => { entry.insert(channel); }
653 channel_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
654 node_id: their_network_key,
660 /// Gets the list of open channels, in random order. See ChannelDetail field documentation for
661 /// more information.
662 pub fn list_channels(&self) -> Vec<ChannelDetails> {
663 let channel_state = self.channel_state.lock().unwrap();
664 let mut res = Vec::with_capacity(channel_state.by_id.len());
665 for (channel_id, channel) in channel_state.by_id.iter() {
666 let (inbound_capacity_msat, outbound_capacity_msat) = channel.get_inbound_outbound_available_balance_msat();
667 res.push(ChannelDetails {
668 channel_id: (*channel_id).clone(),
669 short_channel_id: channel.get_short_channel_id(),
670 remote_network_id: channel.get_their_node_id(),
671 channel_value_satoshis: channel.get_value_satoshis(),
672 inbound_capacity_msat,
673 outbound_capacity_msat,
674 user_id: channel.get_user_id(),
675 is_live: channel.is_live(),
681 /// Gets the list of usable channels, in random order. Useful as an argument to
682 /// Router::get_route to ensure non-announced channels are used.
684 /// These are guaranteed to have their is_live value set to true, see the documentation for
685 /// ChannelDetails::is_live for more info on exactly what the criteria are.
686 pub fn list_usable_channels(&self) -> Vec<ChannelDetails> {
687 let channel_state = self.channel_state.lock().unwrap();
688 let mut res = Vec::with_capacity(channel_state.by_id.len());
689 for (channel_id, channel) in channel_state.by_id.iter() {
690 // Note we use is_live here instead of usable which leads to somewhat confused
691 // internal/external nomenclature, but that's ok cause that's probably what the user
692 // really wanted anyway.
693 if channel.is_live() {
694 let (inbound_capacity_msat, outbound_capacity_msat) = channel.get_inbound_outbound_available_balance_msat();
695 res.push(ChannelDetails {
696 channel_id: (*channel_id).clone(),
697 short_channel_id: channel.get_short_channel_id(),
698 remote_network_id: channel.get_their_node_id(),
699 channel_value_satoshis: channel.get_value_satoshis(),
700 inbound_capacity_msat,
701 outbound_capacity_msat,
702 user_id: channel.get_user_id(),
710 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
711 /// will be accepted on the given channel, and after additional timeout/the closing of all
712 /// pending HTLCs, the channel will be closed on chain.
714 /// May generate a SendShutdown message event on success, which should be relayed.
715 pub fn close_channel(&self, channel_id: &[u8; 32]) -> Result<(), APIError> {
716 let _ = self.total_consistency_lock.read().unwrap();
718 let (mut failed_htlcs, chan_option) = {
719 let mut channel_state_lock = self.channel_state.lock().unwrap();
720 let channel_state = channel_state_lock.borrow_parts();
721 match channel_state.by_id.entry(channel_id.clone()) {
722 hash_map::Entry::Occupied(mut chan_entry) => {
723 let (shutdown_msg, failed_htlcs) = chan_entry.get_mut().get_shutdown()?;
724 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
725 node_id: chan_entry.get().get_their_node_id(),
728 if chan_entry.get().is_shutdown() {
729 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
730 channel_state.short_to_id.remove(&short_id);
732 (failed_htlcs, Some(chan_entry.remove_entry().1))
733 } else { (failed_htlcs, None) }
735 hash_map::Entry::Vacant(_) => return Err(APIError::ChannelUnavailable{err: "No such channel"})
738 for htlc_source in failed_htlcs.drain(..) {
739 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() });
741 let chan_update = if let Some(chan) = chan_option {
742 if let Ok(update) = self.get_channel_update(&chan) {
747 if let Some(update) = chan_update {
748 let mut channel_state = self.channel_state.lock().unwrap();
749 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
758 fn finish_force_close_channel(&self, shutdown_res: ShutdownResult) {
759 let (local_txn, mut failed_htlcs) = shutdown_res;
760 log_trace!(self, "Finishing force-closure of channel with {} transactions to broadcast and {} HTLCs to fail", local_txn.len(), failed_htlcs.len());
761 for htlc_source in failed_htlcs.drain(..) {
762 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() });
764 for tx in local_txn {
765 self.tx_broadcaster.broadcast_transaction(&tx);
769 /// Force closes a channel, immediately broadcasting the latest local commitment transaction to
770 /// the chain and rejecting new HTLCs on the given channel.
771 pub fn force_close_channel(&self, channel_id: &[u8; 32]) {
772 let _ = self.total_consistency_lock.read().unwrap();
775 let mut channel_state_lock = self.channel_state.lock().unwrap();
776 let channel_state = channel_state_lock.borrow_parts();
777 if let Some(chan) = channel_state.by_id.remove(channel_id) {
778 if let Some(short_id) = chan.get_short_channel_id() {
779 channel_state.short_to_id.remove(&short_id);
786 log_trace!(self, "Force-closing channel {}", log_bytes!(channel_id[..]));
787 self.finish_force_close_channel(chan.force_shutdown());
788 if let Ok(update) = self.get_channel_update(&chan) {
789 let mut channel_state = self.channel_state.lock().unwrap();
790 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
796 /// Force close all channels, immediately broadcasting the latest local commitment transaction
797 /// for each to the chain and rejecting new HTLCs on each.
798 pub fn force_close_all_channels(&self) {
799 for chan in self.list_channels() {
800 self.force_close_channel(&chan.channel_id);
804 const ZERO:[u8; 65] = [0; 65];
805 fn decode_update_add_htlc_onion(&self, msg: &msgs::UpdateAddHTLC) -> (PendingHTLCStatus, MutexGuard<ChannelHolder>) {
806 macro_rules! return_malformed_err {
807 ($msg: expr, $err_code: expr) => {
809 log_info!(self, "Failed to accept/forward incoming HTLC: {}", $msg);
810 return (PendingHTLCStatus::Fail(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
811 channel_id: msg.channel_id,
812 htlc_id: msg.htlc_id,
813 sha256_of_onion: Sha256::hash(&msg.onion_routing_packet.hop_data).into_inner(),
814 failure_code: $err_code,
815 })), self.channel_state.lock().unwrap());
820 if let Err(_) = msg.onion_routing_packet.public_key {
821 return_malformed_err!("invalid ephemeral pubkey", 0x8000 | 0x4000 | 6);
824 let shared_secret = {
825 let mut arr = [0; 32];
826 arr.copy_from_slice(&SharedSecret::new(&msg.onion_routing_packet.public_key.unwrap(), &self.our_network_key)[..]);
829 let (rho, mu) = onion_utils::gen_rho_mu_from_shared_secret(&shared_secret);
831 if msg.onion_routing_packet.version != 0 {
832 //TODO: Spec doesn't indicate if we should only hash hop_data here (and in other
833 //sha256_of_onion error data packets), or the entire onion_routing_packet. Either way,
834 //the hash doesn't really serve any purpose - in the case of hashing all data, the
835 //receiving node would have to brute force to figure out which version was put in the
836 //packet by the node that send us the message, in the case of hashing the hop_data, the
837 //node knows the HMAC matched, so they already know what is there...
838 return_malformed_err!("Unknown onion packet version", 0x8000 | 0x4000 | 4);
841 let mut hmac = HmacEngine::<Sha256>::new(&mu);
842 hmac.input(&msg.onion_routing_packet.hop_data);
843 hmac.input(&msg.payment_hash.0[..]);
844 if !fixed_time_eq(&Hmac::from_engine(hmac).into_inner(), &msg.onion_routing_packet.hmac) {
845 return_malformed_err!("HMAC Check failed", 0x8000 | 0x4000 | 5);
848 let mut channel_state = None;
849 macro_rules! return_err {
850 ($msg: expr, $err_code: expr, $data: expr) => {
852 log_info!(self, "Failed to accept/forward incoming HTLC: {}", $msg);
853 if channel_state.is_none() {
854 channel_state = Some(self.channel_state.lock().unwrap());
856 return (PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
857 channel_id: msg.channel_id,
858 htlc_id: msg.htlc_id,
859 reason: onion_utils::build_first_hop_failure_packet(&shared_secret, $err_code, $data),
860 })), channel_state.unwrap());
865 let mut chacha = ChaCha20::new(&rho, &[0u8; 8]);
866 let next_hop_data = {
867 let mut decoded = [0; 65];
868 chacha.process(&msg.onion_routing_packet.hop_data[0..65], &mut decoded);
869 match msgs::OnionHopData::read(&mut Cursor::new(&decoded[..])) {
871 let error_code = match err {
872 msgs::DecodeError::UnknownVersion => 0x4000 | 1, // unknown realm byte
873 _ => 0x2000 | 2, // Should never happen
875 return_err!("Unable to decode our hop data", error_code, &[0;0]);
881 let pending_forward_info = if next_hop_data.hmac == [0; 32] {
883 // final_expiry_too_soon
884 if (msg.cltv_expiry as u64) < self.latest_block_height.load(Ordering::Acquire) as u64 + (CLTV_CLAIM_BUFFER + LATENCY_GRACE_PERIOD_BLOCKS) as u64 {
885 return_err!("The final CLTV expiry is too soon to handle", 17, &[0;0]);
887 // final_incorrect_htlc_amount
888 if next_hop_data.data.amt_to_forward > msg.amount_msat {
889 return_err!("Upstream node sent less than we were supposed to receive in payment", 19, &byte_utils::be64_to_array(msg.amount_msat));
891 // final_incorrect_cltv_expiry
892 if next_hop_data.data.outgoing_cltv_value != msg.cltv_expiry {
893 return_err!("Upstream node set CLTV to the wrong value", 18, &byte_utils::be32_to_array(msg.cltv_expiry));
896 // Note that we could obviously respond immediately with an update_fulfill_htlc
897 // message, however that would leak that we are the recipient of this payment, so
898 // instead we stay symmetric with the forwarding case, only responding (after a
899 // delay) once they've send us a commitment_signed!
901 PendingHTLCStatus::Forward(PendingForwardHTLCInfo {
903 payment_hash: msg.payment_hash.clone(),
905 incoming_shared_secret: shared_secret,
906 amt_to_forward: next_hop_data.data.amt_to_forward,
907 outgoing_cltv_value: next_hop_data.data.outgoing_cltv_value,
910 let mut new_packet_data = [0; 20*65];
911 chacha.process(&msg.onion_routing_packet.hop_data[65..], &mut new_packet_data[0..19*65]);
912 chacha.process(&ChannelManager::ZERO[..], &mut new_packet_data[19*65..]);
914 let mut new_pubkey = msg.onion_routing_packet.public_key.unwrap();
916 let blinding_factor = {
917 let mut sha = Sha256::engine();
918 sha.input(&new_pubkey.serialize()[..]);
919 sha.input(&shared_secret);
920 Sha256::from_engine(sha).into_inner()
923 let public_key = if let Err(e) = new_pubkey.mul_assign(&self.secp_ctx, &blinding_factor[..]) {
925 } else { Ok(new_pubkey) };
927 let outgoing_packet = msgs::OnionPacket {
930 hop_data: new_packet_data,
931 hmac: next_hop_data.hmac.clone(),
934 PendingHTLCStatus::Forward(PendingForwardHTLCInfo {
935 onion_packet: Some(outgoing_packet),
936 payment_hash: msg.payment_hash.clone(),
937 short_channel_id: next_hop_data.data.short_channel_id,
938 incoming_shared_secret: shared_secret,
939 amt_to_forward: next_hop_data.data.amt_to_forward,
940 outgoing_cltv_value: next_hop_data.data.outgoing_cltv_value,
944 channel_state = Some(self.channel_state.lock().unwrap());
945 if let &PendingHTLCStatus::Forward(PendingForwardHTLCInfo { ref onion_packet, ref short_channel_id, ref amt_to_forward, ref outgoing_cltv_value, .. }) = &pending_forward_info {
946 if onion_packet.is_some() { // If short_channel_id is 0 here, we'll reject them in the body here
947 let id_option = channel_state.as_ref().unwrap().short_to_id.get(&short_channel_id).cloned();
948 let forwarding_id = match id_option {
949 None => { // unknown_next_peer
950 return_err!("Don't have available channel for forwarding as requested.", 0x4000 | 10, &[0;0]);
952 Some(id) => id.clone(),
954 if let Some((err, code, chan_update)) = loop {
955 let chan = channel_state.as_mut().unwrap().by_id.get_mut(&forwarding_id).unwrap();
957 // Note that we could technically not return an error yet here and just hope
958 // that the connection is reestablished or monitor updated by the time we get
959 // around to doing the actual forward, but better to fail early if we can and
960 // hopefully an attacker trying to path-trace payments cannot make this occur
961 // on a small/per-node/per-channel scale.
962 if !chan.is_live() { // channel_disabled
963 break Some(("Forwarding channel is not in a ready state.", 0x1000 | 20, Some(self.get_channel_update(chan).unwrap())));
965 if *amt_to_forward < chan.get_their_htlc_minimum_msat() { // amount_below_minimum
966 break Some(("HTLC amount was below the htlc_minimum_msat", 0x1000 | 11, Some(self.get_channel_update(chan).unwrap())));
968 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) });
969 if fee.is_none() || msg.amount_msat < fee.unwrap() || (msg.amount_msat - fee.unwrap()) < *amt_to_forward { // fee_insufficient
970 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())));
972 if (msg.cltv_expiry as u64) < (*outgoing_cltv_value) as u64 + CLTV_EXPIRY_DELTA as u64 { // incorrect_cltv_expiry
973 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())));
975 let cur_height = self.latest_block_height.load(Ordering::Acquire) as u32 + 1;
976 // We want to have at least LATENCY_GRACE_PERIOD_BLOCKS to fail prior to going on chain CLAIM_BUFFER blocks before expiration
977 if msg.cltv_expiry <= cur_height + CLTV_CLAIM_BUFFER + LATENCY_GRACE_PERIOD_BLOCKS as u32 { // expiry_too_soon
978 break Some(("CLTV expiry is too close", 0x1000 | 14, Some(self.get_channel_update(chan).unwrap())));
980 if msg.cltv_expiry > cur_height + CLTV_FAR_FAR_AWAY as u32 { // expiry_too_far
981 break Some(("CLTV expiry is too far in the future", 21, None));
986 let mut res = Vec::with_capacity(8 + 128);
987 if let Some(chan_update) = chan_update {
988 if code == 0x1000 | 11 || code == 0x1000 | 12 {
989 res.extend_from_slice(&byte_utils::be64_to_array(msg.amount_msat));
991 else if code == 0x1000 | 13 {
992 res.extend_from_slice(&byte_utils::be32_to_array(msg.cltv_expiry));
994 else if code == 0x1000 | 20 {
995 res.extend_from_slice(&byte_utils::be16_to_array(chan_update.contents.flags));
997 res.extend_from_slice(&chan_update.encode_with_len()[..]);
999 return_err!(err, code, &res[..]);
1004 (pending_forward_info, channel_state.unwrap())
1007 /// only fails if the channel does not yet have an assigned short_id
1008 /// May be called with channel_state already locked!
1009 fn get_channel_update(&self, chan: &Channel) -> Result<msgs::ChannelUpdate, HandleError> {
1010 let short_channel_id = match chan.get_short_channel_id() {
1011 None => return Err(HandleError{err: "Channel not yet established", action: None}),
1015 let were_node_one = PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key).serialize()[..] < chan.get_their_node_id().serialize()[..];
1017 let unsigned = msgs::UnsignedChannelUpdate {
1018 chain_hash: self.genesis_hash,
1019 short_channel_id: short_channel_id,
1020 timestamp: chan.get_channel_update_count(),
1021 flags: (!were_node_one) as u16 | ((!chan.is_live() as u16) << 1),
1022 cltv_expiry_delta: CLTV_EXPIRY_DELTA,
1023 htlc_minimum_msat: chan.get_our_htlc_minimum_msat(),
1024 fee_base_msat: chan.get_our_fee_base_msat(&*self.fee_estimator),
1025 fee_proportional_millionths: chan.get_fee_proportional_millionths(),
1026 excess_data: Vec::new(),
1029 let msg_hash = Sha256dHash::hash(&unsigned.encode()[..]);
1030 let sig = self.secp_ctx.sign(&hash_to_message!(&msg_hash[..]), &self.our_network_key);
1032 Ok(msgs::ChannelUpdate {
1038 /// Sends a payment along a given route.
1040 /// Value parameters are provided via the last hop in route, see documentation for RouteHop
1041 /// fields for more info.
1043 /// Note that if the payment_hash already exists elsewhere (eg you're sending a duplicative
1044 /// payment), we don't do anything to stop you! We always try to ensure that if the provided
1045 /// next hop knows the preimage to payment_hash they can claim an additional amount as
1046 /// specified in the last hop in the route! Thus, you should probably do your own
1047 /// payment_preimage tracking (which you should already be doing as they represent "proof of
1048 /// payment") and prevent double-sends yourself.
1050 /// May generate a SendHTLCs message event on success, which should be relayed.
1052 /// Raises APIError::RoutError when invalid route or forward parameter
1053 /// (cltv_delta, fee, node public key) is specified.
1054 /// Raises APIError::ChannelUnavailable if the next-hop channel is not available for updates
1055 /// (including due to previous monitor update failure or new permanent monitor update failure).
1056 /// Raised APIError::MonitorUpdateFailed if a new monitor update failure prevented sending the
1057 /// relevant updates.
1059 /// In case of APIError::RouteError/APIError::ChannelUnavailable, the payment send has failed
1060 /// and you may wish to retry via a different route immediately.
1061 /// In case of APIError::MonitorUpdateFailed, the commitment update has been irrevocably
1062 /// committed on our end and we're just waiting for a monitor update to send it. Do NOT retry
1063 /// the payment via a different route unless you intend to pay twice!
1064 pub fn send_payment(&self, route: Route, payment_hash: PaymentHash) -> Result<(), APIError> {
1065 if route.hops.len() < 1 || route.hops.len() > 20 {
1066 return Err(APIError::RouteError{err: "Route didn't go anywhere/had bogus size"});
1068 let our_node_id = self.get_our_node_id();
1069 for (idx, hop) in route.hops.iter().enumerate() {
1070 if idx != route.hops.len() - 1 && hop.pubkey == our_node_id {
1071 return Err(APIError::RouteError{err: "Route went through us but wasn't a simple rebalance loop to us"});
1075 let session_priv = self.keys_manager.get_session_key();
1077 let cur_height = self.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1079 let onion_keys = secp_call!(onion_utils::construct_onion_keys(&self.secp_ctx, &route, &session_priv),
1080 APIError::RouteError{err: "Pubkey along hop was maliciously selected"});
1081 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height)?;
1082 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, &payment_hash);
1084 let _ = self.total_consistency_lock.read().unwrap();
1086 let err: Result<(), _> = loop {
1087 let mut channel_lock = self.channel_state.lock().unwrap();
1089 let id = match channel_lock.short_to_id.get(&route.hops.first().unwrap().short_channel_id) {
1090 None => return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!"}),
1091 Some(id) => id.clone(),
1094 let channel_state = channel_lock.borrow_parts();
1095 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(id) {
1097 if chan.get().get_their_node_id() != route.hops.first().unwrap().pubkey {
1098 return Err(APIError::RouteError{err: "Node ID mismatch on first hop!"});
1100 if !chan.get().is_live() {
1101 return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected/pending monitor update!"});
1103 break_chan_entry!(self, chan.get_mut().send_htlc_and_commit(htlc_msat, payment_hash.clone(), htlc_cltv, HTLCSource::OutboundRoute {
1104 route: route.clone(),
1105 session_priv: session_priv.clone(),
1106 first_hop_htlc_msat: htlc_msat,
1107 }, onion_packet), channel_state, chan)
1109 Some((update_add, commitment_signed, chan_monitor)) => {
1110 if let Err(e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1111 maybe_break_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, true);
1112 // Note that MonitorUpdateFailed here indicates (per function docs)
1113 // that we will resent the commitment update once we unfree monitor
1114 // updating, so we have to take special care that we don't return
1115 // something else in case we will resend later!
1116 return Err(APIError::MonitorUpdateFailed);
1119 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1120 node_id: route.hops.first().unwrap().pubkey,
1121 updates: msgs::CommitmentUpdate {
1122 update_add_htlcs: vec![update_add],
1123 update_fulfill_htlcs: Vec::new(),
1124 update_fail_htlcs: Vec::new(),
1125 update_fail_malformed_htlcs: Vec::new(),
1133 } else { unreachable!(); }
1137 match handle_error!(self, err) {
1138 Ok(_) => unreachable!(),
1140 if let Some(msgs::ErrorAction::IgnoreError) = e.action {
1142 log_error!(self, "Got bad keys: {}!", e.err);
1143 let mut channel_state = self.channel_state.lock().unwrap();
1144 channel_state.pending_msg_events.push(events::MessageSendEvent::HandleError {
1145 node_id: route.hops.first().unwrap().pubkey,
1149 Err(APIError::ChannelUnavailable { err: e.err })
1154 /// Call this upon creation of a funding transaction for the given channel.
1156 /// Note that ALL inputs in the transaction pointed to by funding_txo MUST spend SegWit outputs
1157 /// or your counterparty can steal your funds!
1159 /// Panics if a funding transaction has already been provided for this channel.
1161 /// May panic if the funding_txo is duplicative with some other channel (note that this should
1162 /// be trivially prevented by using unique funding transaction keys per-channel).
1163 pub fn funding_transaction_generated(&self, temporary_channel_id: &[u8; 32], funding_txo: OutPoint) {
1164 let _ = self.total_consistency_lock.read().unwrap();
1166 let (mut chan, msg, chan_monitor) = {
1168 let mut channel_state = self.channel_state.lock().unwrap();
1169 match channel_state.by_id.remove(temporary_channel_id) {
1171 (chan.get_outbound_funding_created(funding_txo)
1172 .map_err(|e| if let ChannelError::Close(msg) = e {
1173 MsgHandleErrInternal::from_finish_shutdown(msg, chan.channel_id(), chan.force_shutdown(), None)
1174 } else { unreachable!(); })
1180 match handle_error!(self, res) {
1181 Ok(funding_msg) => {
1182 (chan, funding_msg.0, funding_msg.1)
1185 log_error!(self, "Got bad signatures: {}!", e.err);
1186 let mut channel_state = self.channel_state.lock().unwrap();
1187 channel_state.pending_msg_events.push(events::MessageSendEvent::HandleError {
1188 node_id: chan.get_their_node_id(),
1195 // Because we have exclusive ownership of the channel here we can release the channel_state
1196 // lock before add_update_monitor
1197 if let Err(e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1199 ChannelMonitorUpdateErr::PermanentFailure => {
1200 match handle_error!(self, Err(MsgHandleErrInternal::from_finish_shutdown("ChannelMonitor storage failure", *temporary_channel_id, chan.force_shutdown(), None))) {
1202 log_error!(self, "Failed to store ChannelMonitor update for funding tx generation");
1203 let mut channel_state = self.channel_state.lock().unwrap();
1204 channel_state.pending_msg_events.push(events::MessageSendEvent::HandleError {
1205 node_id: chan.get_their_node_id(),
1210 Ok(()) => unreachable!(),
1213 ChannelMonitorUpdateErr::TemporaryFailure => {
1214 // Its completely fine to continue with a FundingCreated until the monitor
1215 // update is persisted, as long as we don't generate the FundingBroadcastSafe
1216 // until the monitor has been safely persisted (as funding broadcast is not,
1218 chan.monitor_update_failed(false, false, Vec::new(), Vec::new());
1223 let mut channel_state = self.channel_state.lock().unwrap();
1224 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
1225 node_id: chan.get_their_node_id(),
1228 match channel_state.by_id.entry(chan.channel_id()) {
1229 hash_map::Entry::Occupied(_) => {
1230 panic!("Generated duplicate funding txid?");
1232 hash_map::Entry::Vacant(e) => {
1238 fn get_announcement_sigs(&self, chan: &Channel) -> Option<msgs::AnnouncementSignatures> {
1239 if !chan.should_announce() { return None }
1241 let (announcement, our_bitcoin_sig) = match chan.get_channel_announcement(self.get_our_node_id(), self.genesis_hash.clone()) {
1243 Err(_) => return None, // Only in case of state precondition violations eg channel is closing
1245 let msghash = hash_to_message!(&Sha256dHash::hash(&announcement.encode()[..])[..]);
1246 let our_node_sig = self.secp_ctx.sign(&msghash, &self.our_network_key);
1248 Some(msgs::AnnouncementSignatures {
1249 channel_id: chan.channel_id(),
1250 short_channel_id: chan.get_short_channel_id().unwrap(),
1251 node_signature: our_node_sig,
1252 bitcoin_signature: our_bitcoin_sig,
1256 /// Processes HTLCs which are pending waiting on random forward delay.
1258 /// Should only really ever be called in response to a PendingHTLCsForwardable event.
1259 /// Will likely generate further events.
1260 pub fn process_pending_htlc_forwards(&self) {
1261 let _ = self.total_consistency_lock.read().unwrap();
1263 let mut new_events = Vec::new();
1264 let mut failed_forwards = Vec::new();
1265 let mut handle_errors = Vec::new();
1267 let mut channel_state_lock = self.channel_state.lock().unwrap();
1268 let channel_state = channel_state_lock.borrow_parts();
1270 for (short_chan_id, mut pending_forwards) in channel_state.forward_htlcs.drain() {
1271 if short_chan_id != 0 {
1272 let forward_chan_id = match channel_state.short_to_id.get(&short_chan_id) {
1273 Some(chan_id) => chan_id.clone(),
1275 failed_forwards.reserve(pending_forwards.len());
1276 for forward_info in pending_forwards.drain(..) {
1277 match forward_info {
1278 HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info } => {
1279 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
1280 short_channel_id: prev_short_channel_id,
1281 htlc_id: prev_htlc_id,
1282 incoming_packet_shared_secret: forward_info.incoming_shared_secret,
1284 failed_forwards.push((htlc_source, forward_info.payment_hash, 0x4000 | 10, None));
1286 HTLCForwardInfo::FailHTLC { .. } => {
1287 // Channel went away before we could fail it. This implies
1288 // the channel is now on chain and our counterparty is
1289 // trying to broadcast the HTLC-Timeout, but that's their
1290 // problem, not ours.
1297 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(forward_chan_id) {
1298 let mut add_htlc_msgs = Vec::new();
1299 let mut fail_htlc_msgs = Vec::new();
1300 for forward_info in pending_forwards.drain(..) {
1301 match forward_info {
1302 HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info } => {
1303 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);
1304 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
1305 short_channel_id: prev_short_channel_id,
1306 htlc_id: prev_htlc_id,
1307 incoming_packet_shared_secret: forward_info.incoming_shared_secret,
1309 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()) {
1311 if let ChannelError::Ignore(msg) = e {
1312 log_trace!(self, "Failed to forward HTLC with payment_hash {}: {}", log_bytes!(forward_info.payment_hash.0), msg);
1314 panic!("Stated return value requirements in send_htlc() were not met");
1316 let chan_update = self.get_channel_update(chan.get()).unwrap();
1317 failed_forwards.push((htlc_source, forward_info.payment_hash, 0x1000 | 7, Some(chan_update)));
1322 Some(msg) => { add_htlc_msgs.push(msg); },
1324 // Nothing to do here...we're waiting on a remote
1325 // revoke_and_ack before we can add anymore HTLCs. The Channel
1326 // will automatically handle building the update_add_htlc and
1327 // commitment_signed messages when we can.
1328 // TODO: Do some kind of timer to set the channel as !is_live()
1329 // as we don't really want others relying on us relaying through
1330 // this channel currently :/.
1336 HTLCForwardInfo::FailHTLC { htlc_id, err_packet } => {
1337 log_trace!(self, "Failing HTLC back to channel with short id {} after delay", short_chan_id);
1338 match chan.get_mut().get_update_fail_htlc(htlc_id, err_packet) {
1340 if let ChannelError::Ignore(msg) = e {
1341 log_trace!(self, "Failed to fail backwards to short_id {}: {}", short_chan_id, msg);
1343 panic!("Stated return value requirements in get_update_fail_htlc() were not met");
1345 // fail-backs are best-effort, we probably already have one
1346 // pending, and if not that's OK, if not, the channel is on
1347 // the chain and sending the HTLC-Timeout is their problem.
1350 Ok(Some(msg)) => { fail_htlc_msgs.push(msg); },
1352 // Nothing to do here...we're waiting on a remote
1353 // revoke_and_ack before we can update the commitment
1354 // transaction. The Channel will automatically handle
1355 // building the update_fail_htlc and commitment_signed
1356 // messages when we can.
1357 // We don't need any kind of timer here as they should fail
1358 // the channel onto the chain if they can't get our
1359 // update_fail_htlc in time, it's not our problem.
1366 if !add_htlc_msgs.is_empty() || !fail_htlc_msgs.is_empty() {
1367 let (commitment_msg, monitor) = match chan.get_mut().send_commitment() {
1370 if let ChannelError::Ignore(_) = e {
1371 panic!("Stated return value requirements in send_commitment() were not met");
1373 //TODO: Handle...this is bad!
1377 if let Err(e) = self.monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor) {
1378 handle_errors.push((chan.get().get_their_node_id(), handle_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, true)));
1381 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1382 node_id: chan.get().get_their_node_id(),
1383 updates: msgs::CommitmentUpdate {
1384 update_add_htlcs: add_htlc_msgs,
1385 update_fulfill_htlcs: Vec::new(),
1386 update_fail_htlcs: fail_htlc_msgs,
1387 update_fail_malformed_htlcs: Vec::new(),
1389 commitment_signed: commitment_msg,
1397 for forward_info in pending_forwards.drain(..) {
1398 match forward_info {
1399 HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info } => {
1400 let prev_hop_data = HTLCPreviousHopData {
1401 short_channel_id: prev_short_channel_id,
1402 htlc_id: prev_htlc_id,
1403 incoming_packet_shared_secret: forward_info.incoming_shared_secret,
1405 match channel_state.claimable_htlcs.entry(forward_info.payment_hash) {
1406 hash_map::Entry::Occupied(mut entry) => entry.get_mut().push((forward_info.amt_to_forward, prev_hop_data)),
1407 hash_map::Entry::Vacant(entry) => { entry.insert(vec![(forward_info.amt_to_forward, prev_hop_data)]); },
1409 new_events.push(events::Event::PaymentReceived {
1410 payment_hash: forward_info.payment_hash,
1411 amt: forward_info.amt_to_forward,
1414 HTLCForwardInfo::FailHTLC { .. } => {
1415 panic!("Got pending fail of our own HTLC");
1423 for (htlc_source, payment_hash, failure_code, update) in failed_forwards.drain(..) {
1425 None => self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source, &payment_hash, HTLCFailReason::Reason { failure_code, data: Vec::new() }),
1426 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() }),
1430 for (their_node_id, err) in handle_errors.drain(..) {
1431 match handle_error!(self, err) {
1434 if let Some(msgs::ErrorAction::IgnoreError) = e.action {
1436 let mut channel_state = self.channel_state.lock().unwrap();
1437 channel_state.pending_msg_events.push(events::MessageSendEvent::HandleError {
1438 node_id: their_node_id,
1446 if new_events.is_empty() { return }
1447 let mut events = self.pending_events.lock().unwrap();
1448 events.append(&mut new_events);
1451 /// Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
1452 /// after a PaymentReceived event, failing the HTLC back to its origin and freeing resources
1453 /// along the path (including in our own channel on which we received it).
1454 /// Returns false if no payment was found to fail backwards, true if the process of failing the
1455 /// HTLC backwards has been started.
1456 pub fn fail_htlc_backwards(&self, payment_hash: &PaymentHash) -> bool {
1457 let _ = self.total_consistency_lock.read().unwrap();
1459 let mut channel_state = Some(self.channel_state.lock().unwrap());
1460 let removed_source = channel_state.as_mut().unwrap().claimable_htlcs.remove(payment_hash);
1461 if let Some(mut sources) = removed_source {
1462 for (recvd_value, htlc_with_hash) in sources.drain(..) {
1463 if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
1464 self.fail_htlc_backwards_internal(channel_state.take().unwrap(),
1465 HTLCSource::PreviousHopData(htlc_with_hash), payment_hash,
1466 HTLCFailReason::Reason { failure_code: 0x4000 | 15, data: byte_utils::be64_to_array(recvd_value).to_vec() });
1472 /// Fails an HTLC backwards to the sender of it to us.
1473 /// Note that while we take a channel_state lock as input, we do *not* assume consistency here.
1474 /// There are several callsites that do stupid things like loop over a list of payment_hashes
1475 /// to fail and take the channel_state lock for each iteration (as we take ownership and may
1476 /// drop it). In other words, no assumptions are made that entries in claimable_htlcs point to
1477 /// still-available channels.
1478 fn fail_htlc_backwards_internal(&self, mut channel_state_lock: MutexGuard<ChannelHolder>, source: HTLCSource, payment_hash: &PaymentHash, onion_error: HTLCFailReason) {
1479 //TODO: There is a timing attack here where if a node fails an HTLC back to us they can
1480 //identify whether we sent it or not based on the (I presume) very different runtime
1481 //between the branches here. We should make this async and move it into the forward HTLCs
1484 HTLCSource::OutboundRoute { ref route, .. } => {
1485 log_trace!(self, "Failing outbound payment HTLC with payment_hash {}", log_bytes!(payment_hash.0));
1486 mem::drop(channel_state_lock);
1487 match &onion_error {
1488 &HTLCFailReason::ErrorPacket { ref err } => {
1490 let (channel_update, payment_retryable, onion_error_code) = onion_utils::process_onion_failure(&self.secp_ctx, &self.logger, &source, err.data.clone());
1492 let (channel_update, payment_retryable, _) = onion_utils::process_onion_failure(&self.secp_ctx, &self.logger, &source, err.data.clone());
1493 // TODO: If we decided to blame ourselves (or one of our channels) in
1494 // process_onion_failure we should close that channel as it implies our
1495 // next-hop is needlessly blaming us!
1496 if let Some(update) = channel_update {
1497 self.channel_state.lock().unwrap().pending_msg_events.push(
1498 events::MessageSendEvent::PaymentFailureNetworkUpdate {
1503 self.pending_events.lock().unwrap().push(
1504 events::Event::PaymentFailed {
1505 payment_hash: payment_hash.clone(),
1506 rejected_by_dest: !payment_retryable,
1508 error_code: onion_error_code
1512 &HTLCFailReason::Reason {
1516 // we get a fail_malformed_htlc from the first hop
1517 // TODO: We'd like to generate a PaymentFailureNetworkUpdate for temporary
1518 // failures here, but that would be insufficient as Router::get_route
1519 // generally ignores its view of our own channels as we provide them via
1521 // TODO: For non-temporary failures, we really should be closing the
1522 // channel here as we apparently can't relay through them anyway.
1523 self.pending_events.lock().unwrap().push(
1524 events::Event::PaymentFailed {
1525 payment_hash: payment_hash.clone(),
1526 rejected_by_dest: route.hops.len() == 1,
1528 error_code: Some(*failure_code),
1534 HTLCSource::PreviousHopData(HTLCPreviousHopData { short_channel_id, htlc_id, incoming_packet_shared_secret }) => {
1535 let err_packet = match onion_error {
1536 HTLCFailReason::Reason { failure_code, data } => {
1537 log_trace!(self, "Failing HTLC with payment_hash {} backwards from us with code {}", log_bytes!(payment_hash.0), failure_code);
1538 let packet = onion_utils::build_failure_packet(&incoming_packet_shared_secret, failure_code, &data[..]).encode();
1539 onion_utils::encrypt_failure_packet(&incoming_packet_shared_secret, &packet)
1541 HTLCFailReason::ErrorPacket { err } => {
1542 log_trace!(self, "Failing HTLC with payment_hash {} backwards with pre-built ErrorPacket", log_bytes!(payment_hash.0));
1543 onion_utils::encrypt_failure_packet(&incoming_packet_shared_secret, &err.data)
1547 let mut forward_event = None;
1548 if channel_state_lock.forward_htlcs.is_empty() {
1549 forward_event = Some(Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS));
1551 match channel_state_lock.forward_htlcs.entry(short_channel_id) {
1552 hash_map::Entry::Occupied(mut entry) => {
1553 entry.get_mut().push(HTLCForwardInfo::FailHTLC { htlc_id, err_packet });
1555 hash_map::Entry::Vacant(entry) => {
1556 entry.insert(vec!(HTLCForwardInfo::FailHTLC { htlc_id, err_packet }));
1559 mem::drop(channel_state_lock);
1560 if let Some(time) = forward_event {
1561 let mut pending_events = self.pending_events.lock().unwrap();
1562 pending_events.push(events::Event::PendingHTLCsForwardable {
1563 time_forwardable: time
1570 /// Provides a payment preimage in response to a PaymentReceived event, returning true and
1571 /// generating message events for the net layer to claim the payment, if possible. Thus, you
1572 /// should probably kick the net layer to go send messages if this returns true!
1574 /// May panic if called except in response to a PaymentReceived event.
1575 pub fn claim_funds(&self, payment_preimage: PaymentPreimage) -> bool {
1576 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
1578 let _ = self.total_consistency_lock.read().unwrap();
1580 let mut channel_state = Some(self.channel_state.lock().unwrap());
1581 let removed_source = channel_state.as_mut().unwrap().claimable_htlcs.remove(&payment_hash);
1582 if let Some(mut sources) = removed_source {
1583 // TODO: We should require the user specify the expected amount so that we can claim
1584 // only payments for the correct amount, and reject payments for incorrect amounts
1585 // (which are probably middle nodes probing to break our privacy).
1586 for (_, htlc_with_hash) in sources.drain(..) {
1587 if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
1588 self.claim_funds_internal(channel_state.take().unwrap(), HTLCSource::PreviousHopData(htlc_with_hash), payment_preimage);
1593 fn claim_funds_internal(&self, mut channel_state_lock: MutexGuard<ChannelHolder>, source: HTLCSource, payment_preimage: PaymentPreimage) {
1594 let (their_node_id, err) = loop {
1596 HTLCSource::OutboundRoute { .. } => {
1597 mem::drop(channel_state_lock);
1598 let mut pending_events = self.pending_events.lock().unwrap();
1599 pending_events.push(events::Event::PaymentSent {
1603 HTLCSource::PreviousHopData(HTLCPreviousHopData { short_channel_id, htlc_id, .. }) => {
1604 //TODO: Delay the claimed_funds relaying just like we do outbound relay!
1605 let channel_state = channel_state_lock.borrow_parts();
1607 let chan_id = match channel_state.short_to_id.get(&short_channel_id) {
1608 Some(chan_id) => chan_id.clone(),
1610 // TODO: There is probably a channel manager somewhere that needs to
1611 // learn the preimage as the channel already hit the chain and that's
1612 // why it's missing.
1617 if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(chan_id) {
1618 let was_frozen_for_monitor = chan.get().is_awaiting_monitor_update();
1619 match chan.get_mut().get_update_fulfill_htlc_and_commit(htlc_id, payment_preimage) {
1620 Ok((msgs, monitor_option)) => {
1621 if let Some(chan_monitor) = monitor_option {
1622 if let Err(e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1623 if was_frozen_for_monitor {
1624 assert!(msgs.is_none());
1626 break (chan.get().get_their_node_id(), handle_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, msgs.is_some()));
1630 if let Some((msg, commitment_signed)) = msgs {
1631 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1632 node_id: chan.get().get_their_node_id(),
1633 updates: msgs::CommitmentUpdate {
1634 update_add_htlcs: Vec::new(),
1635 update_fulfill_htlcs: vec![msg],
1636 update_fail_htlcs: Vec::new(),
1637 update_fail_malformed_htlcs: Vec::new(),
1645 // TODO: There is probably a channel manager somewhere that needs to
1646 // learn the preimage as the channel may be about to hit the chain.
1647 //TODO: Do something with e?
1651 } else { unreachable!(); }
1657 match handle_error!(self, err) {
1660 if let Some(msgs::ErrorAction::IgnoreError) = e.action {
1662 let mut channel_state = self.channel_state.lock().unwrap();
1663 channel_state.pending_msg_events.push(events::MessageSendEvent::HandleError {
1664 node_id: their_node_id,
1672 /// Gets the node_id held by this ChannelManager
1673 pub fn get_our_node_id(&self) -> PublicKey {
1674 PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key)
1677 /// Used to restore channels to normal operation after a
1678 /// ChannelMonitorUpdateErr::TemporaryFailure was returned from a channel monitor update
1680 pub fn test_restore_channel_monitor(&self) {
1681 let mut close_results = Vec::new();
1682 let mut htlc_forwards = Vec::new();
1683 let mut htlc_failures = Vec::new();
1684 let mut pending_events = Vec::new();
1685 let _ = self.total_consistency_lock.read().unwrap();
1688 let mut channel_lock = self.channel_state.lock().unwrap();
1689 let channel_state = channel_lock.borrow_parts();
1690 let short_to_id = channel_state.short_to_id;
1691 let pending_msg_events = channel_state.pending_msg_events;
1692 channel_state.by_id.retain(|_, channel| {
1693 if channel.is_awaiting_monitor_update() {
1694 let chan_monitor = channel.channel_monitor();
1695 if let Err(e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1697 ChannelMonitorUpdateErr::PermanentFailure => {
1698 // TODO: There may be some pending HTLCs that we intended to fail
1699 // backwards when a monitor update failed. We should make sure
1700 // knowledge of those gets moved into the appropriate in-memory
1701 // ChannelMonitor and they get failed backwards once we get
1702 // on-chain confirmations.
1703 // Note I think #198 addresses this, so once it's merged a test
1704 // should be written.
1705 if let Some(short_id) = channel.get_short_channel_id() {
1706 short_to_id.remove(&short_id);
1708 close_results.push(channel.force_shutdown());
1709 if let Ok(update) = self.get_channel_update(&channel) {
1710 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1716 ChannelMonitorUpdateErr::TemporaryFailure => true,
1719 let (raa, commitment_update, order, pending_forwards, mut pending_failures, needs_broadcast_safe, funding_locked) = channel.monitor_updating_restored();
1720 if !pending_forwards.is_empty() {
1721 htlc_forwards.push((channel.get_short_channel_id().expect("We can't have pending forwards before funding confirmation"), pending_forwards));
1723 htlc_failures.append(&mut pending_failures);
1725 macro_rules! handle_cs { () => {
1726 if let Some(update) = commitment_update {
1727 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1728 node_id: channel.get_their_node_id(),
1733 macro_rules! handle_raa { () => {
1734 if let Some(revoke_and_ack) = raa {
1735 pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
1736 node_id: channel.get_their_node_id(),
1737 msg: revoke_and_ack,
1742 RAACommitmentOrder::CommitmentFirst => {
1746 RAACommitmentOrder::RevokeAndACKFirst => {
1751 if needs_broadcast_safe {
1752 pending_events.push(events::Event::FundingBroadcastSafe {
1753 funding_txo: channel.get_funding_txo().unwrap(),
1754 user_channel_id: channel.get_user_id(),
1757 if let Some(msg) = funding_locked {
1758 pending_msg_events.push(events::MessageSendEvent::SendFundingLocked {
1759 node_id: channel.get_their_node_id(),
1762 if let Some(announcement_sigs) = self.get_announcement_sigs(channel) {
1763 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
1764 node_id: channel.get_their_node_id(),
1765 msg: announcement_sigs,
1768 short_to_id.insert(channel.get_short_channel_id().unwrap(), channel.channel_id());
1776 self.pending_events.lock().unwrap().append(&mut pending_events);
1778 for failure in htlc_failures.drain(..) {
1779 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), failure.0, &failure.1, failure.2);
1781 self.forward_htlcs(&mut htlc_forwards[..]);
1783 for res in close_results.drain(..) {
1784 self.finish_force_close_channel(res);
1788 fn internal_open_channel(&self, their_node_id: &PublicKey, their_local_features: LocalFeatures, msg: &msgs::OpenChannel) -> Result<(), MsgHandleErrInternal> {
1789 if msg.chain_hash != self.genesis_hash {
1790 return Err(MsgHandleErrInternal::send_err_msg_no_close("Unknown genesis block hash", msg.temporary_channel_id.clone()));
1793 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)
1794 .map_err(|e| MsgHandleErrInternal::from_chan_no_close(e, msg.temporary_channel_id))?;
1795 let mut channel_state_lock = self.channel_state.lock().unwrap();
1796 let channel_state = channel_state_lock.borrow_parts();
1797 match channel_state.by_id.entry(channel.channel_id()) {
1798 hash_map::Entry::Occupied(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("temporary_channel_id collision!", msg.temporary_channel_id.clone())),
1799 hash_map::Entry::Vacant(entry) => {
1800 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
1801 node_id: their_node_id.clone(),
1802 msg: channel.get_accept_channel(),
1804 entry.insert(channel);
1810 fn internal_accept_channel(&self, their_node_id: &PublicKey, their_local_features: LocalFeatures, msg: &msgs::AcceptChannel) -> Result<(), MsgHandleErrInternal> {
1811 let (value, output_script, user_id) = {
1812 let mut channel_lock = self.channel_state.lock().unwrap();
1813 let channel_state = channel_lock.borrow_parts();
1814 match channel_state.by_id.entry(msg.temporary_channel_id) {
1815 hash_map::Entry::Occupied(mut chan) => {
1816 if chan.get().get_their_node_id() != *their_node_id {
1817 //TODO: see issue #153, need a consistent behavior on obnoxious behavior from random node
1818 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.temporary_channel_id));
1820 try_chan_entry!(self, chan.get_mut().accept_channel(&msg, &self.default_configuration, their_local_features), channel_state, chan);
1821 (chan.get().get_value_satoshis(), chan.get().get_funding_redeemscript().to_v0_p2wsh(), chan.get().get_user_id())
1823 //TODO: same as above
1824 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.temporary_channel_id))
1827 let mut pending_events = self.pending_events.lock().unwrap();
1828 pending_events.push(events::Event::FundingGenerationReady {
1829 temporary_channel_id: msg.temporary_channel_id,
1830 channel_value_satoshis: value,
1831 output_script: output_script,
1832 user_channel_id: user_id,
1837 fn internal_funding_created(&self, their_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), MsgHandleErrInternal> {
1838 let ((funding_msg, monitor_update), mut chan) = {
1839 let mut channel_lock = self.channel_state.lock().unwrap();
1840 let channel_state = channel_lock.borrow_parts();
1841 match channel_state.by_id.entry(msg.temporary_channel_id.clone()) {
1842 hash_map::Entry::Occupied(mut chan) => {
1843 if chan.get().get_their_node_id() != *their_node_id {
1844 //TODO: here and below MsgHandleErrInternal, #153 case
1845 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.temporary_channel_id));
1847 (try_chan_entry!(self, chan.get_mut().funding_created(msg), channel_state, chan), chan.remove())
1849 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.temporary_channel_id))
1852 // Because we have exclusive ownership of the channel here we can release the channel_state
1853 // lock before add_update_monitor
1854 if let Err(e) = self.monitor.add_update_monitor(monitor_update.get_funding_txo().unwrap(), monitor_update) {
1856 ChannelMonitorUpdateErr::PermanentFailure => {
1857 // Note that we reply with the new channel_id in error messages if we gave up on the
1858 // channel, not the temporary_channel_id. This is compatible with ourselves, but the
1859 // spec is somewhat ambiguous here. Not a huge deal since we'll send error messages for
1860 // any messages referencing a previously-closed channel anyway.
1861 return Err(MsgHandleErrInternal::from_finish_shutdown("ChannelMonitor storage failure", funding_msg.channel_id, chan.force_shutdown(), None));
1863 ChannelMonitorUpdateErr::TemporaryFailure => {
1864 // There's no problem signing a counterparty's funding transaction if our monitor
1865 // hasn't persisted to disk yet - we can't lose money on a transaction that we haven't
1866 // accepted payment from yet. We do, however, need to wait to send our funding_locked
1867 // until we have persisted our monitor.
1868 chan.monitor_update_failed(false, false, Vec::new(), Vec::new());
1872 let mut channel_state_lock = self.channel_state.lock().unwrap();
1873 let channel_state = channel_state_lock.borrow_parts();
1874 match channel_state.by_id.entry(funding_msg.channel_id) {
1875 hash_map::Entry::Occupied(_) => {
1876 return Err(MsgHandleErrInternal::send_err_msg_no_close("Already had channel with the new channel_id", funding_msg.channel_id))
1878 hash_map::Entry::Vacant(e) => {
1879 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
1880 node_id: their_node_id.clone(),
1889 fn internal_funding_signed(&self, their_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), MsgHandleErrInternal> {
1890 let (funding_txo, user_id) = {
1891 let mut channel_lock = self.channel_state.lock().unwrap();
1892 let channel_state = channel_lock.borrow_parts();
1893 match channel_state.by_id.entry(msg.channel_id) {
1894 hash_map::Entry::Occupied(mut chan) => {
1895 if chan.get().get_their_node_id() != *their_node_id {
1896 //TODO: here and below MsgHandleErrInternal, #153 case
1897 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1899 let chan_monitor = try_chan_entry!(self, chan.get_mut().funding_signed(&msg), channel_state, chan);
1900 if let Err(e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1901 return_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::RevokeAndACKFirst, false, false);
1903 (chan.get().get_funding_txo().unwrap(), chan.get().get_user_id())
1905 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
1908 let mut pending_events = self.pending_events.lock().unwrap();
1909 pending_events.push(events::Event::FundingBroadcastSafe {
1910 funding_txo: funding_txo,
1911 user_channel_id: user_id,
1916 fn internal_funding_locked(&self, their_node_id: &PublicKey, msg: &msgs::FundingLocked) -> Result<(), MsgHandleErrInternal> {
1917 let mut channel_state_lock = self.channel_state.lock().unwrap();
1918 let channel_state = channel_state_lock.borrow_parts();
1919 match channel_state.by_id.entry(msg.channel_id) {
1920 hash_map::Entry::Occupied(mut chan) => {
1921 if chan.get().get_their_node_id() != *their_node_id {
1922 //TODO: here and below MsgHandleErrInternal, #153 case
1923 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1925 try_chan_entry!(self, chan.get_mut().funding_locked(&msg), channel_state, chan);
1926 if let Some(announcement_sigs) = self.get_announcement_sigs(chan.get()) {
1927 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
1928 node_id: their_node_id.clone(),
1929 msg: announcement_sigs,
1934 hash_map::Entry::Vacant(_) => Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
1938 fn internal_shutdown(&self, their_node_id: &PublicKey, msg: &msgs::Shutdown) -> Result<(), MsgHandleErrInternal> {
1939 let (mut dropped_htlcs, chan_option) = {
1940 let mut channel_state_lock = self.channel_state.lock().unwrap();
1941 let channel_state = channel_state_lock.borrow_parts();
1943 match channel_state.by_id.entry(msg.channel_id.clone()) {
1944 hash_map::Entry::Occupied(mut chan_entry) => {
1945 if chan_entry.get().get_their_node_id() != *their_node_id {
1946 //TODO: here and below MsgHandleErrInternal, #153 case
1947 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1949 let (shutdown, closing_signed, dropped_htlcs) = try_chan_entry!(self, chan_entry.get_mut().shutdown(&*self.fee_estimator, &msg), channel_state, chan_entry);
1950 if let Some(msg) = shutdown {
1951 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
1952 node_id: their_node_id.clone(),
1956 if let Some(msg) = closing_signed {
1957 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
1958 node_id: their_node_id.clone(),
1962 if chan_entry.get().is_shutdown() {
1963 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
1964 channel_state.short_to_id.remove(&short_id);
1966 (dropped_htlcs, Some(chan_entry.remove_entry().1))
1967 } else { (dropped_htlcs, None) }
1969 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
1972 for htlc_source in dropped_htlcs.drain(..) {
1973 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() });
1975 if let Some(chan) = chan_option {
1976 if let Ok(update) = self.get_channel_update(&chan) {
1977 let mut channel_state = self.channel_state.lock().unwrap();
1978 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1986 fn internal_closing_signed(&self, their_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<(), MsgHandleErrInternal> {
1987 let (tx, chan_option) = {
1988 let mut channel_state_lock = self.channel_state.lock().unwrap();
1989 let channel_state = channel_state_lock.borrow_parts();
1990 match channel_state.by_id.entry(msg.channel_id.clone()) {
1991 hash_map::Entry::Occupied(mut chan_entry) => {
1992 if chan_entry.get().get_their_node_id() != *their_node_id {
1993 //TODO: here and below MsgHandleErrInternal, #153 case
1994 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1996 let (closing_signed, tx) = try_chan_entry!(self, chan_entry.get_mut().closing_signed(&*self.fee_estimator, &msg), channel_state, chan_entry);
1997 if let Some(msg) = closing_signed {
1998 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
1999 node_id: their_node_id.clone(),
2004 // We're done with this channel, we've got a signed closing transaction and
2005 // will send the closing_signed back to the remote peer upon return. This
2006 // also implies there are no pending HTLCs left on the channel, so we can
2007 // fully delete it from tracking (the channel monitor is still around to
2008 // watch for old state broadcasts)!
2009 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
2010 channel_state.short_to_id.remove(&short_id);
2012 (tx, Some(chan_entry.remove_entry().1))
2013 } else { (tx, None) }
2015 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2018 if let Some(broadcast_tx) = tx {
2019 self.tx_broadcaster.broadcast_transaction(&broadcast_tx);
2021 if let Some(chan) = chan_option {
2022 if let Ok(update) = self.get_channel_update(&chan) {
2023 let mut channel_state = self.channel_state.lock().unwrap();
2024 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2032 fn internal_update_add_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), MsgHandleErrInternal> {
2033 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
2034 //determine the state of the payment based on our response/if we forward anything/the time
2035 //we take to respond. We should take care to avoid allowing such an attack.
2037 //TODO: There exists a further attack where a node may garble the onion data, forward it to
2038 //us repeatedly garbled in different ways, and compare our error messages, which are
2039 //encrypted with the same key. It's not immediately obvious how to usefully exploit that,
2040 //but we should prevent it anyway.
2042 let (mut pending_forward_info, mut channel_state_lock) = self.decode_update_add_htlc_onion(msg);
2043 let channel_state = channel_state_lock.borrow_parts();
2045 match channel_state.by_id.entry(msg.channel_id) {
2046 hash_map::Entry::Occupied(mut chan) => {
2047 if chan.get().get_their_node_id() != *their_node_id {
2048 //TODO: here MsgHandleErrInternal, #153 case
2049 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2051 if !chan.get().is_usable() {
2052 // If the update_add is completely bogus, the call will Err and we will close,
2053 // but if we've sent a shutdown and they haven't acknowledged it yet, we just
2054 // want to reject the new HTLC and fail it backwards instead of forwarding.
2055 if let PendingHTLCStatus::Forward(PendingForwardHTLCInfo { incoming_shared_secret, .. }) = pending_forward_info {
2056 let chan_update = self.get_channel_update(chan.get());
2057 pending_forward_info = PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
2058 channel_id: msg.channel_id,
2059 htlc_id: msg.htlc_id,
2060 reason: if let Ok(update) = chan_update {
2061 // TODO: Note that |20 is defined as "channel FROM the processing
2062 // node has been disabled" (emphasis mine), which seems to imply
2063 // that we can't return |20 for an inbound channel being disabled.
2064 // This probably needs a spec update but should definitely be
2066 onion_utils::build_first_hop_failure_packet(&incoming_shared_secret, 0x1000|20, &{
2067 let mut res = Vec::with_capacity(8 + 128);
2068 res.extend_from_slice(&byte_utils::be16_to_array(update.contents.flags));
2069 res.extend_from_slice(&update.encode_with_len()[..]);
2073 // This can only happen if the channel isn't in the fully-funded
2074 // state yet, implying our counterparty is trying to route payments
2075 // over the channel back to themselves (cause no one else should
2076 // know the short_id is a lightning channel yet). We should have no
2077 // problem just calling this unknown_next_peer
2078 onion_utils::build_first_hop_failure_packet(&incoming_shared_secret, 0x4000|10, &[])
2083 try_chan_entry!(self, chan.get_mut().update_add_htlc(&msg, pending_forward_info), channel_state, chan);
2085 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2090 fn internal_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), MsgHandleErrInternal> {
2091 let mut channel_lock = self.channel_state.lock().unwrap();
2093 let channel_state = channel_lock.borrow_parts();
2094 match channel_state.by_id.entry(msg.channel_id) {
2095 hash_map::Entry::Occupied(mut chan) => {
2096 if chan.get().get_their_node_id() != *their_node_id {
2097 //TODO: here and below MsgHandleErrInternal, #153 case
2098 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2100 try_chan_entry!(self, chan.get_mut().update_fulfill_htlc(&msg), channel_state, chan)
2102 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2105 self.claim_funds_internal(channel_lock, htlc_source, msg.payment_preimage.clone());
2109 fn internal_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), MsgHandleErrInternal> {
2110 let mut channel_lock = self.channel_state.lock().unwrap();
2111 let channel_state = channel_lock.borrow_parts();
2112 match channel_state.by_id.entry(msg.channel_id) {
2113 hash_map::Entry::Occupied(mut chan) => {
2114 if chan.get().get_their_node_id() != *their_node_id {
2115 //TODO: here and below MsgHandleErrInternal, #153 case
2116 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2118 try_chan_entry!(self, chan.get_mut().update_fail_htlc(&msg, HTLCFailReason::ErrorPacket { err: msg.reason.clone() }), channel_state, chan);
2120 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2125 fn internal_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), MsgHandleErrInternal> {
2126 let mut channel_lock = self.channel_state.lock().unwrap();
2127 let channel_state = channel_lock.borrow_parts();
2128 match channel_state.by_id.entry(msg.channel_id) {
2129 hash_map::Entry::Occupied(mut chan) => {
2130 if chan.get().get_their_node_id() != *their_node_id {
2131 //TODO: here and below MsgHandleErrInternal, #153 case
2132 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2134 if (msg.failure_code & 0x8000) == 0 {
2135 try_chan_entry!(self, Err(ChannelError::Close("Got update_fail_malformed_htlc with BADONION not set")), channel_state, chan);
2137 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);
2140 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2144 fn internal_commitment_signed(&self, their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), MsgHandleErrInternal> {
2145 let mut channel_state_lock = self.channel_state.lock().unwrap();
2146 let channel_state = channel_state_lock.borrow_parts();
2147 match channel_state.by_id.entry(msg.channel_id) {
2148 hash_map::Entry::Occupied(mut chan) => {
2149 if chan.get().get_their_node_id() != *their_node_id {
2150 //TODO: here and below MsgHandleErrInternal, #153 case
2151 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2153 let (revoke_and_ack, commitment_signed, closing_signed, chan_monitor) =
2154 try_chan_entry!(self, chan.get_mut().commitment_signed(&msg, &*self.fee_estimator), channel_state, chan);
2155 if let Err(e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
2156 return_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::RevokeAndACKFirst, true, commitment_signed.is_some());
2157 //TODO: Rebroadcast closing_signed if present on monitor update restoration
2159 channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
2160 node_id: their_node_id.clone(),
2161 msg: revoke_and_ack,
2163 if let Some(msg) = commitment_signed {
2164 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2165 node_id: their_node_id.clone(),
2166 updates: msgs::CommitmentUpdate {
2167 update_add_htlcs: Vec::new(),
2168 update_fulfill_htlcs: Vec::new(),
2169 update_fail_htlcs: Vec::new(),
2170 update_fail_malformed_htlcs: Vec::new(),
2172 commitment_signed: msg,
2176 if let Some(msg) = closing_signed {
2177 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
2178 node_id: their_node_id.clone(),
2184 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2189 fn forward_htlcs(&self, per_source_pending_forwards: &mut [(u64, Vec<(PendingForwardHTLCInfo, u64)>)]) {
2190 for &mut (prev_short_channel_id, ref mut pending_forwards) in per_source_pending_forwards {
2191 let mut forward_event = None;
2192 if !pending_forwards.is_empty() {
2193 let mut channel_state = self.channel_state.lock().unwrap();
2194 if channel_state.forward_htlcs.is_empty() {
2195 forward_event = Some(Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS))
2197 for (forward_info, prev_htlc_id) in pending_forwards.drain(..) {
2198 match channel_state.forward_htlcs.entry(forward_info.short_channel_id) {
2199 hash_map::Entry::Occupied(mut entry) => {
2200 entry.get_mut().push(HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info });
2202 hash_map::Entry::Vacant(entry) => {
2203 entry.insert(vec!(HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info }));
2208 match forward_event {
2210 let mut pending_events = self.pending_events.lock().unwrap();
2211 pending_events.push(events::Event::PendingHTLCsForwardable {
2212 time_forwardable: time
2220 fn internal_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), MsgHandleErrInternal> {
2221 let (pending_forwards, mut pending_failures, short_channel_id) = {
2222 let mut channel_state_lock = self.channel_state.lock().unwrap();
2223 let channel_state = channel_state_lock.borrow_parts();
2224 match channel_state.by_id.entry(msg.channel_id) {
2225 hash_map::Entry::Occupied(mut chan) => {
2226 if chan.get().get_their_node_id() != *their_node_id {
2227 //TODO: here and below MsgHandleErrInternal, #153 case
2228 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2230 let was_frozen_for_monitor = chan.get().is_awaiting_monitor_update();
2231 let (commitment_update, pending_forwards, pending_failures, closing_signed, chan_monitor) =
2232 try_chan_entry!(self, chan.get_mut().revoke_and_ack(&msg, &*self.fee_estimator), channel_state, chan);
2233 if let Err(e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
2234 if was_frozen_for_monitor {
2235 assert!(commitment_update.is_none() && closing_signed.is_none() && pending_forwards.is_empty() && pending_failures.is_empty());
2236 return Err(MsgHandleErrInternal::ignore_no_close("Previous monitor update failure prevented responses to RAA"));
2238 return_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, commitment_update.is_some(), pending_forwards, pending_failures);
2241 if let Some(updates) = commitment_update {
2242 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2243 node_id: their_node_id.clone(),
2247 if let Some(msg) = closing_signed {
2248 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
2249 node_id: their_node_id.clone(),
2253 (pending_forwards, pending_failures, chan.get().get_short_channel_id().expect("RAA should only work on a short-id-available channel"))
2255 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2258 for failure in pending_failures.drain(..) {
2259 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), failure.0, &failure.1, failure.2);
2261 self.forward_htlcs(&mut [(short_channel_id, pending_forwards)]);
2266 fn internal_update_fee(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), MsgHandleErrInternal> {
2267 let mut channel_lock = self.channel_state.lock().unwrap();
2268 let channel_state = channel_lock.borrow_parts();
2269 match channel_state.by_id.entry(msg.channel_id) {
2270 hash_map::Entry::Occupied(mut chan) => {
2271 if chan.get().get_their_node_id() != *their_node_id {
2272 //TODO: here and below MsgHandleErrInternal, #153 case
2273 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2275 try_chan_entry!(self, chan.get_mut().update_fee(&*self.fee_estimator, &msg), channel_state, chan);
2277 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2282 fn internal_announcement_signatures(&self, their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), MsgHandleErrInternal> {
2283 let mut channel_state_lock = self.channel_state.lock().unwrap();
2284 let channel_state = channel_state_lock.borrow_parts();
2286 match channel_state.by_id.entry(msg.channel_id) {
2287 hash_map::Entry::Occupied(mut chan) => {
2288 if chan.get().get_their_node_id() != *their_node_id {
2289 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2291 if !chan.get().is_usable() {
2292 return Err(MsgHandleErrInternal::from_no_close(HandleError{err: "Got an announcement_signatures before we were ready for it", action: Some(msgs::ErrorAction::IgnoreError)}));
2295 let our_node_id = self.get_our_node_id();
2296 let (announcement, our_bitcoin_sig) =
2297 try_chan_entry!(self, chan.get_mut().get_channel_announcement(our_node_id.clone(), self.genesis_hash.clone()), channel_state, chan);
2299 let were_node_one = announcement.node_id_1 == our_node_id;
2300 let msghash = hash_to_message!(&Sha256dHash::hash(&announcement.encode()[..])[..]);
2301 if self.secp_ctx.verify(&msghash, &msg.node_signature, if were_node_one { &announcement.node_id_2 } else { &announcement.node_id_1 }).is_err() ||
2302 self.secp_ctx.verify(&msghash, &msg.bitcoin_signature, if were_node_one { &announcement.bitcoin_key_2 } else { &announcement.bitcoin_key_1 }).is_err() {
2303 try_chan_entry!(self, Err(ChannelError::Close("Bad announcement_signatures node_signature")), channel_state, chan);
2306 let our_node_sig = self.secp_ctx.sign(&msghash, &self.our_network_key);
2308 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
2309 msg: msgs::ChannelAnnouncement {
2310 node_signature_1: if were_node_one { our_node_sig } else { msg.node_signature },
2311 node_signature_2: if were_node_one { msg.node_signature } else { our_node_sig },
2312 bitcoin_signature_1: if were_node_one { our_bitcoin_sig } else { msg.bitcoin_signature },
2313 bitcoin_signature_2: if were_node_one { msg.bitcoin_signature } else { our_bitcoin_sig },
2314 contents: announcement,
2316 update_msg: self.get_channel_update(chan.get()).unwrap(), // can only fail if we're not in a ready state
2319 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2324 fn internal_channel_reestablish(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<(), MsgHandleErrInternal> {
2325 let mut channel_state_lock = self.channel_state.lock().unwrap();
2326 let channel_state = channel_state_lock.borrow_parts();
2328 match channel_state.by_id.entry(msg.channel_id) {
2329 hash_map::Entry::Occupied(mut chan) => {
2330 if chan.get().get_their_node_id() != *their_node_id {
2331 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2333 let (funding_locked, revoke_and_ack, commitment_update, channel_monitor, mut order, shutdown) =
2334 try_chan_entry!(self, chan.get_mut().channel_reestablish(msg), channel_state, chan);
2335 if let Some(monitor) = channel_monitor {
2336 if let Err(e) = self.monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor) {
2337 // channel_reestablish doesn't guarantee the order it returns is sensical
2338 // for the messages it returns, but if we're setting what messages to
2339 // re-transmit on monitor update success, we need to make sure it is sane.
2340 if revoke_and_ack.is_none() {
2341 order = RAACommitmentOrder::CommitmentFirst;
2343 if commitment_update.is_none() {
2344 order = RAACommitmentOrder::RevokeAndACKFirst;
2346 return_monitor_err!(self, e, channel_state, chan, order, revoke_and_ack.is_some(), commitment_update.is_some());
2347 //TODO: Resend the funding_locked if needed once we get the monitor running again
2350 if let Some(msg) = funding_locked {
2351 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingLocked {
2352 node_id: their_node_id.clone(),
2356 macro_rules! send_raa { () => {
2357 if let Some(msg) = revoke_and_ack {
2358 channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
2359 node_id: their_node_id.clone(),
2364 macro_rules! send_cu { () => {
2365 if let Some(updates) = commitment_update {
2366 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2367 node_id: their_node_id.clone(),
2373 RAACommitmentOrder::RevokeAndACKFirst => {
2377 RAACommitmentOrder::CommitmentFirst => {
2382 if let Some(msg) = shutdown {
2383 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
2384 node_id: their_node_id.clone(),
2390 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2394 /// Begin Update fee process. Allowed only on an outbound channel.
2395 /// If successful, will generate a UpdateHTLCs event, so you should probably poll
2396 /// PeerManager::process_events afterwards.
2397 /// Note: This API is likely to change!
2399 pub fn update_fee(&self, channel_id: [u8;32], feerate_per_kw: u64) -> Result<(), APIError> {
2400 let _ = self.total_consistency_lock.read().unwrap();
2402 let err: Result<(), _> = loop {
2403 let mut channel_state_lock = self.channel_state.lock().unwrap();
2404 let channel_state = channel_state_lock.borrow_parts();
2406 match channel_state.by_id.entry(channel_id) {
2407 hash_map::Entry::Vacant(_) => return Err(APIError::APIMisuseError{err: "Failed to find corresponding channel"}),
2408 hash_map::Entry::Occupied(mut chan) => {
2409 if !chan.get().is_outbound() {
2410 return Err(APIError::APIMisuseError{err: "update_fee cannot be sent for an inbound channel"});
2412 if chan.get().is_awaiting_monitor_update() {
2413 return Err(APIError::MonitorUpdateFailed);
2415 if !chan.get().is_live() {
2416 return Err(APIError::ChannelUnavailable{err: "Channel is either not yet fully established or peer is currently disconnected"});
2418 their_node_id = chan.get().get_their_node_id();
2419 if let Some((update_fee, commitment_signed, chan_monitor)) =
2420 break_chan_entry!(self, chan.get_mut().send_update_fee_and_commit(feerate_per_kw), channel_state, chan)
2422 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
2425 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2426 node_id: chan.get().get_their_node_id(),
2427 updates: msgs::CommitmentUpdate {
2428 update_add_htlcs: Vec::new(),
2429 update_fulfill_htlcs: Vec::new(),
2430 update_fail_htlcs: Vec::new(),
2431 update_fail_malformed_htlcs: Vec::new(),
2432 update_fee: Some(update_fee),
2442 match handle_error!(self, err) {
2443 Ok(_) => unreachable!(),
2445 if let Some(msgs::ErrorAction::IgnoreError) = e.action {
2447 log_error!(self, "Got bad keys: {}!", e.err);
2448 let mut channel_state = self.channel_state.lock().unwrap();
2449 channel_state.pending_msg_events.push(events::MessageSendEvent::HandleError {
2450 node_id: their_node_id,
2454 Err(APIError::APIMisuseError { err: e.err })
2460 impl events::MessageSendEventsProvider for ChannelManager {
2461 fn get_and_clear_pending_msg_events(&self) -> Vec<events::MessageSendEvent> {
2462 // TODO: Event release to users and serialization is currently race-y: it's very easy for a
2463 // user to serialize a ChannelManager with pending events in it and lose those events on
2464 // restart. This is doubly true for the fail/fulfill-backs from monitor events!
2466 //TODO: This behavior should be documented.
2467 for htlc_update in self.monitor.fetch_pending_htlc_updated() {
2468 if let Some(preimage) = htlc_update.payment_preimage {
2469 log_trace!(self, "Claiming HTLC with preimage {} from our monitor", log_bytes!(preimage.0));
2470 self.claim_funds_internal(self.channel_state.lock().unwrap(), htlc_update.source, preimage);
2472 log_trace!(self, "Failing HTLC with hash {} from our monitor", log_bytes!(htlc_update.payment_hash.0));
2473 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() });
2478 let mut ret = Vec::new();
2479 let mut channel_state = self.channel_state.lock().unwrap();
2480 mem::swap(&mut ret, &mut channel_state.pending_msg_events);
2485 impl events::EventsProvider for ChannelManager {
2486 fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
2487 // TODO: Event release to users and serialization is currently race-y: it's very easy for a
2488 // user to serialize a ChannelManager with pending events in it and lose those events on
2489 // restart. This is doubly true for the fail/fulfill-backs from monitor events!
2491 //TODO: This behavior should be documented.
2492 for htlc_update in self.monitor.fetch_pending_htlc_updated() {
2493 if let Some(preimage) = htlc_update.payment_preimage {
2494 log_trace!(self, "Claiming HTLC with preimage {} from our monitor", log_bytes!(preimage.0));
2495 self.claim_funds_internal(self.channel_state.lock().unwrap(), htlc_update.source, preimage);
2497 log_trace!(self, "Failing HTLC with hash {} from our monitor", log_bytes!(htlc_update.payment_hash.0));
2498 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() });
2503 let mut ret = Vec::new();
2504 let mut pending_events = self.pending_events.lock().unwrap();
2505 mem::swap(&mut ret, &mut *pending_events);
2510 impl ChainListener for ChannelManager {
2511 fn block_connected(&self, header: &BlockHeader, height: u32, txn_matched: &[&Transaction], indexes_of_txn_matched: &[u32]) {
2512 let header_hash = header.bitcoin_hash();
2513 log_trace!(self, "Block {} at height {} connected with {} txn matched", header_hash, height, txn_matched.len());
2514 let _ = self.total_consistency_lock.read().unwrap();
2515 let mut failed_channels = Vec::new();
2517 let mut channel_lock = self.channel_state.lock().unwrap();
2518 let channel_state = channel_lock.borrow_parts();
2519 let short_to_id = channel_state.short_to_id;
2520 let pending_msg_events = channel_state.pending_msg_events;
2521 channel_state.by_id.retain(|_, channel| {
2522 let chan_res = channel.block_connected(header, height, txn_matched, indexes_of_txn_matched);
2523 if let Ok(Some(funding_locked)) = chan_res {
2524 pending_msg_events.push(events::MessageSendEvent::SendFundingLocked {
2525 node_id: channel.get_their_node_id(),
2526 msg: funding_locked,
2528 if let Some(announcement_sigs) = self.get_announcement_sigs(channel) {
2529 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
2530 node_id: channel.get_their_node_id(),
2531 msg: announcement_sigs,
2534 short_to_id.insert(channel.get_short_channel_id().unwrap(), channel.channel_id());
2535 } else if let Err(e) = chan_res {
2536 pending_msg_events.push(events::MessageSendEvent::HandleError {
2537 node_id: channel.get_their_node_id(),
2538 action: Some(msgs::ErrorAction::SendErrorMessage { msg: e }),
2542 if let Some(funding_txo) = channel.get_funding_txo() {
2543 for tx in txn_matched {
2544 for inp in tx.input.iter() {
2545 if inp.previous_output == funding_txo.into_bitcoin_outpoint() {
2546 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()));
2547 if let Some(short_id) = channel.get_short_channel_id() {
2548 short_to_id.remove(&short_id);
2550 // It looks like our counterparty went on-chain. We go ahead and
2551 // broadcast our latest local state as well here, just in case its
2552 // some kind of SPV attack, though we expect these to be dropped.
2553 failed_channels.push(channel.force_shutdown());
2554 if let Ok(update) = self.get_channel_update(&channel) {
2555 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2564 if channel.is_funding_initiated() && channel.channel_monitor().would_broadcast_at_height(height) {
2565 if let Some(short_id) = channel.get_short_channel_id() {
2566 short_to_id.remove(&short_id);
2568 failed_channels.push(channel.force_shutdown());
2569 // If would_broadcast_at_height() is true, the channel_monitor will broadcast
2570 // the latest local tx for us, so we should skip that here (it doesn't really
2571 // hurt anything, but does make tests a bit simpler).
2572 failed_channels.last_mut().unwrap().0 = Vec::new();
2573 if let Ok(update) = self.get_channel_update(&channel) {
2574 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2583 for failure in failed_channels.drain(..) {
2584 self.finish_force_close_channel(failure);
2586 self.latest_block_height.store(height as usize, Ordering::Release);
2587 *self.last_block_hash.try_lock().expect("block_(dis)connected must not be called in parallel") = header_hash;
2590 /// We force-close the channel without letting our counterparty participate in the shutdown
2591 fn block_disconnected(&self, header: &BlockHeader, _: u32) {
2592 let _ = self.total_consistency_lock.read().unwrap();
2593 let mut failed_channels = Vec::new();
2595 let mut channel_lock = self.channel_state.lock().unwrap();
2596 let channel_state = channel_lock.borrow_parts();
2597 let short_to_id = channel_state.short_to_id;
2598 let pending_msg_events = channel_state.pending_msg_events;
2599 channel_state.by_id.retain(|_, v| {
2600 if v.block_disconnected(header) {
2601 if let Some(short_id) = v.get_short_channel_id() {
2602 short_to_id.remove(&short_id);
2604 failed_channels.push(v.force_shutdown());
2605 if let Ok(update) = self.get_channel_update(&v) {
2606 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2616 for failure in failed_channels.drain(..) {
2617 self.finish_force_close_channel(failure);
2619 self.latest_block_height.fetch_sub(1, Ordering::AcqRel);
2620 *self.last_block_hash.try_lock().expect("block_(dis)connected must not be called in parallel") = header.bitcoin_hash();
2624 impl ChannelMessageHandler for ChannelManager {
2625 //TODO: Handle errors and close channel (or so)
2626 fn handle_open_channel(&self, their_node_id: &PublicKey, their_local_features: LocalFeatures, msg: &msgs::OpenChannel) -> Result<(), HandleError> {
2627 let _ = self.total_consistency_lock.read().unwrap();
2628 handle_error!(self, self.internal_open_channel(their_node_id, their_local_features, msg))
2631 fn handle_accept_channel(&self, their_node_id: &PublicKey, their_local_features: LocalFeatures, msg: &msgs::AcceptChannel) -> Result<(), HandleError> {
2632 let _ = self.total_consistency_lock.read().unwrap();
2633 handle_error!(self, self.internal_accept_channel(their_node_id, their_local_features, msg))
2636 fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), HandleError> {
2637 let _ = self.total_consistency_lock.read().unwrap();
2638 handle_error!(self, self.internal_funding_created(their_node_id, msg))
2641 fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), HandleError> {
2642 let _ = self.total_consistency_lock.read().unwrap();
2643 handle_error!(self, self.internal_funding_signed(their_node_id, msg))
2646 fn handle_funding_locked(&self, their_node_id: &PublicKey, msg: &msgs::FundingLocked) -> Result<(), HandleError> {
2647 let _ = self.total_consistency_lock.read().unwrap();
2648 handle_error!(self, self.internal_funding_locked(their_node_id, msg))
2651 fn handle_shutdown(&self, their_node_id: &PublicKey, msg: &msgs::Shutdown) -> Result<(), HandleError> {
2652 let _ = self.total_consistency_lock.read().unwrap();
2653 handle_error!(self, self.internal_shutdown(their_node_id, msg))
2656 fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<(), HandleError> {
2657 let _ = self.total_consistency_lock.read().unwrap();
2658 handle_error!(self, self.internal_closing_signed(their_node_id, msg))
2661 fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), msgs::HandleError> {
2662 let _ = self.total_consistency_lock.read().unwrap();
2663 handle_error!(self, self.internal_update_add_htlc(their_node_id, msg))
2666 fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), HandleError> {
2667 let _ = self.total_consistency_lock.read().unwrap();
2668 handle_error!(self, self.internal_update_fulfill_htlc(their_node_id, msg))
2671 fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), HandleError> {
2672 let _ = self.total_consistency_lock.read().unwrap();
2673 handle_error!(self, self.internal_update_fail_htlc(their_node_id, msg))
2676 fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), HandleError> {
2677 let _ = self.total_consistency_lock.read().unwrap();
2678 handle_error!(self, self.internal_update_fail_malformed_htlc(their_node_id, msg))
2681 fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), HandleError> {
2682 let _ = self.total_consistency_lock.read().unwrap();
2683 handle_error!(self, self.internal_commitment_signed(their_node_id, msg))
2686 fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), HandleError> {
2687 let _ = self.total_consistency_lock.read().unwrap();
2688 handle_error!(self, self.internal_revoke_and_ack(their_node_id, msg))
2691 fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), HandleError> {
2692 let _ = self.total_consistency_lock.read().unwrap();
2693 handle_error!(self, self.internal_update_fee(their_node_id, msg))
2696 fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), HandleError> {
2697 let _ = self.total_consistency_lock.read().unwrap();
2698 handle_error!(self, self.internal_announcement_signatures(their_node_id, msg))
2701 fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<(), HandleError> {
2702 let _ = self.total_consistency_lock.read().unwrap();
2703 handle_error!(self, self.internal_channel_reestablish(their_node_id, msg))
2706 fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool) {
2707 let _ = self.total_consistency_lock.read().unwrap();
2708 let mut failed_channels = Vec::new();
2709 let mut failed_payments = Vec::new();
2711 let mut channel_state_lock = self.channel_state.lock().unwrap();
2712 let channel_state = channel_state_lock.borrow_parts();
2713 let short_to_id = channel_state.short_to_id;
2714 let pending_msg_events = channel_state.pending_msg_events;
2715 if no_connection_possible {
2716 log_debug!(self, "Failing all channels with {} due to no_connection_possible", log_pubkey!(their_node_id));
2717 channel_state.by_id.retain(|_, chan| {
2718 if chan.get_their_node_id() == *their_node_id {
2719 if let Some(short_id) = chan.get_short_channel_id() {
2720 short_to_id.remove(&short_id);
2722 failed_channels.push(chan.force_shutdown());
2723 if let Ok(update) = self.get_channel_update(&chan) {
2724 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2734 log_debug!(self, "Marking channels with {} disconnected and generating channel_updates", log_pubkey!(their_node_id));
2735 channel_state.by_id.retain(|_, chan| {
2736 if chan.get_their_node_id() == *their_node_id {
2737 //TODO: mark channel disabled (and maybe announce such after a timeout).
2738 let failed_adds = chan.remove_uncommitted_htlcs_and_mark_paused();
2739 if !failed_adds.is_empty() {
2740 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
2741 failed_payments.push((chan_update, failed_adds));
2743 if chan.is_shutdown() {
2744 if let Some(short_id) = chan.get_short_channel_id() {
2745 short_to_id.remove(&short_id);
2753 pending_msg_events.retain(|msg| {
2755 &events::MessageSendEvent::SendAcceptChannel { ref node_id, .. } => node_id != their_node_id,
2756 &events::MessageSendEvent::SendOpenChannel { ref node_id, .. } => node_id != their_node_id,
2757 &events::MessageSendEvent::SendFundingCreated { ref node_id, .. } => node_id != their_node_id,
2758 &events::MessageSendEvent::SendFundingSigned { ref node_id, .. } => node_id != their_node_id,
2759 &events::MessageSendEvent::SendFundingLocked { ref node_id, .. } => node_id != their_node_id,
2760 &events::MessageSendEvent::SendAnnouncementSignatures { ref node_id, .. } => node_id != their_node_id,
2761 &events::MessageSendEvent::UpdateHTLCs { ref node_id, .. } => node_id != their_node_id,
2762 &events::MessageSendEvent::SendRevokeAndACK { ref node_id, .. } => node_id != their_node_id,
2763 &events::MessageSendEvent::SendClosingSigned { ref node_id, .. } => node_id != their_node_id,
2764 &events::MessageSendEvent::SendShutdown { ref node_id, .. } => node_id != their_node_id,
2765 &events::MessageSendEvent::SendChannelReestablish { ref node_id, .. } => node_id != their_node_id,
2766 &events::MessageSendEvent::BroadcastChannelAnnouncement { .. } => true,
2767 &events::MessageSendEvent::BroadcastChannelUpdate { .. } => true,
2768 &events::MessageSendEvent::HandleError { ref node_id, .. } => node_id != their_node_id,
2769 &events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => true,
2773 for failure in failed_channels.drain(..) {
2774 self.finish_force_close_channel(failure);
2776 for (chan_update, mut htlc_sources) in failed_payments {
2777 for (htlc_source, payment_hash) in htlc_sources.drain(..) {
2778 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source, &payment_hash, HTLCFailReason::Reason { failure_code: 0x1000 | 7, data: chan_update.clone() });
2783 fn peer_connected(&self, their_node_id: &PublicKey) {
2784 log_debug!(self, "Generating channel_reestablish events for {}", log_pubkey!(their_node_id));
2786 let _ = self.total_consistency_lock.read().unwrap();
2787 let mut channel_state_lock = self.channel_state.lock().unwrap();
2788 let channel_state = channel_state_lock.borrow_parts();
2789 let pending_msg_events = channel_state.pending_msg_events;
2790 channel_state.by_id.retain(|_, chan| {
2791 if chan.get_their_node_id() == *their_node_id {
2792 if !chan.have_received_message() {
2793 // If we created this (outbound) channel while we were disconnected from the
2794 // peer we probably failed to send the open_channel message, which is now
2795 // lost. We can't have had anything pending related to this channel, so we just
2799 pending_msg_events.push(events::MessageSendEvent::SendChannelReestablish {
2800 node_id: chan.get_their_node_id(),
2801 msg: chan.get_channel_reestablish(),
2807 //TODO: Also re-broadcast announcement_signatures
2810 fn handle_error(&self, their_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
2811 let _ = self.total_consistency_lock.read().unwrap();
2813 if msg.channel_id == [0; 32] {
2814 for chan in self.list_channels() {
2815 if chan.remote_network_id == *their_node_id {
2816 self.force_close_channel(&chan.channel_id);
2820 self.force_close_channel(&msg.channel_id);
2825 const SERIALIZATION_VERSION: u8 = 1;
2826 const MIN_SERIALIZATION_VERSION: u8 = 1;
2828 impl Writeable for PendingForwardHTLCInfo {
2829 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
2830 self.onion_packet.write(writer)?;
2831 self.incoming_shared_secret.write(writer)?;
2832 self.payment_hash.write(writer)?;
2833 self.short_channel_id.write(writer)?;
2834 self.amt_to_forward.write(writer)?;
2835 self.outgoing_cltv_value.write(writer)?;
2840 impl<R: ::std::io::Read> Readable<R> for PendingForwardHTLCInfo {
2841 fn read(reader: &mut R) -> Result<PendingForwardHTLCInfo, DecodeError> {
2842 Ok(PendingForwardHTLCInfo {
2843 onion_packet: Readable::read(reader)?,
2844 incoming_shared_secret: Readable::read(reader)?,
2845 payment_hash: Readable::read(reader)?,
2846 short_channel_id: Readable::read(reader)?,
2847 amt_to_forward: Readable::read(reader)?,
2848 outgoing_cltv_value: Readable::read(reader)?,
2853 impl Writeable for HTLCFailureMsg {
2854 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
2856 &HTLCFailureMsg::Relay(ref fail_msg) => {
2858 fail_msg.write(writer)?;
2860 &HTLCFailureMsg::Malformed(ref fail_msg) => {
2862 fail_msg.write(writer)?;
2869 impl<R: ::std::io::Read> Readable<R> for HTLCFailureMsg {
2870 fn read(reader: &mut R) -> Result<HTLCFailureMsg, DecodeError> {
2871 match <u8 as Readable<R>>::read(reader)? {
2872 0 => Ok(HTLCFailureMsg::Relay(Readable::read(reader)?)),
2873 1 => Ok(HTLCFailureMsg::Malformed(Readable::read(reader)?)),
2874 _ => Err(DecodeError::InvalidValue),
2879 impl Writeable for PendingHTLCStatus {
2880 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
2882 &PendingHTLCStatus::Forward(ref forward_info) => {
2884 forward_info.write(writer)?;
2886 &PendingHTLCStatus::Fail(ref fail_msg) => {
2888 fail_msg.write(writer)?;
2895 impl<R: ::std::io::Read> Readable<R> for PendingHTLCStatus {
2896 fn read(reader: &mut R) -> Result<PendingHTLCStatus, DecodeError> {
2897 match <u8 as Readable<R>>::read(reader)? {
2898 0 => Ok(PendingHTLCStatus::Forward(Readable::read(reader)?)),
2899 1 => Ok(PendingHTLCStatus::Fail(Readable::read(reader)?)),
2900 _ => Err(DecodeError::InvalidValue),
2905 impl_writeable!(HTLCPreviousHopData, 0, {
2908 incoming_packet_shared_secret
2911 impl Writeable for HTLCSource {
2912 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
2914 &HTLCSource::PreviousHopData(ref hop_data) => {
2916 hop_data.write(writer)?;
2918 &HTLCSource::OutboundRoute { ref route, ref session_priv, ref first_hop_htlc_msat } => {
2920 route.write(writer)?;
2921 session_priv.write(writer)?;
2922 first_hop_htlc_msat.write(writer)?;
2929 impl<R: ::std::io::Read> Readable<R> for HTLCSource {
2930 fn read(reader: &mut R) -> Result<HTLCSource, DecodeError> {
2931 match <u8 as Readable<R>>::read(reader)? {
2932 0 => Ok(HTLCSource::PreviousHopData(Readable::read(reader)?)),
2933 1 => Ok(HTLCSource::OutboundRoute {
2934 route: Readable::read(reader)?,
2935 session_priv: Readable::read(reader)?,
2936 first_hop_htlc_msat: Readable::read(reader)?,
2938 _ => Err(DecodeError::InvalidValue),
2943 impl Writeable for HTLCFailReason {
2944 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
2946 &HTLCFailReason::ErrorPacket { ref err } => {
2950 &HTLCFailReason::Reason { ref failure_code, ref data } => {
2952 failure_code.write(writer)?;
2953 data.write(writer)?;
2960 impl<R: ::std::io::Read> Readable<R> for HTLCFailReason {
2961 fn read(reader: &mut R) -> Result<HTLCFailReason, DecodeError> {
2962 match <u8 as Readable<R>>::read(reader)? {
2963 0 => Ok(HTLCFailReason::ErrorPacket { err: Readable::read(reader)? }),
2964 1 => Ok(HTLCFailReason::Reason {
2965 failure_code: Readable::read(reader)?,
2966 data: Readable::read(reader)?,
2968 _ => Err(DecodeError::InvalidValue),
2973 impl Writeable for HTLCForwardInfo {
2974 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
2976 &HTLCForwardInfo::AddHTLC { ref prev_short_channel_id, ref prev_htlc_id, ref forward_info } => {
2978 prev_short_channel_id.write(writer)?;
2979 prev_htlc_id.write(writer)?;
2980 forward_info.write(writer)?;
2982 &HTLCForwardInfo::FailHTLC { ref htlc_id, ref err_packet } => {
2984 htlc_id.write(writer)?;
2985 err_packet.write(writer)?;
2992 impl<R: ::std::io::Read> Readable<R> for HTLCForwardInfo {
2993 fn read(reader: &mut R) -> Result<HTLCForwardInfo, DecodeError> {
2994 match <u8 as Readable<R>>::read(reader)? {
2995 0 => Ok(HTLCForwardInfo::AddHTLC {
2996 prev_short_channel_id: Readable::read(reader)?,
2997 prev_htlc_id: Readable::read(reader)?,
2998 forward_info: Readable::read(reader)?,
3000 1 => Ok(HTLCForwardInfo::FailHTLC {
3001 htlc_id: Readable::read(reader)?,
3002 err_packet: Readable::read(reader)?,
3004 _ => Err(DecodeError::InvalidValue),
3009 impl Writeable for ChannelManager {
3010 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3011 let _ = self.total_consistency_lock.write().unwrap();
3013 writer.write_all(&[SERIALIZATION_VERSION; 1])?;
3014 writer.write_all(&[MIN_SERIALIZATION_VERSION; 1])?;
3016 self.genesis_hash.write(writer)?;
3017 (self.latest_block_height.load(Ordering::Acquire) as u32).write(writer)?;
3018 self.last_block_hash.lock().unwrap().write(writer)?;
3020 let channel_state = self.channel_state.lock().unwrap();
3021 let mut unfunded_channels = 0;
3022 for (_, channel) in channel_state.by_id.iter() {
3023 if !channel.is_funding_initiated() {
3024 unfunded_channels += 1;
3027 ((channel_state.by_id.len() - unfunded_channels) as u64).write(writer)?;
3028 for (_, channel) in channel_state.by_id.iter() {
3029 if channel.is_funding_initiated() {
3030 channel.write(writer)?;
3034 (channel_state.forward_htlcs.len() as u64).write(writer)?;
3035 for (short_channel_id, pending_forwards) in channel_state.forward_htlcs.iter() {
3036 short_channel_id.write(writer)?;
3037 (pending_forwards.len() as u64).write(writer)?;
3038 for forward in pending_forwards {
3039 forward.write(writer)?;
3043 (channel_state.claimable_htlcs.len() as u64).write(writer)?;
3044 for (payment_hash, previous_hops) in channel_state.claimable_htlcs.iter() {
3045 payment_hash.write(writer)?;
3046 (previous_hops.len() as u64).write(writer)?;
3047 for &(recvd_amt, ref previous_hop) in previous_hops.iter() {
3048 recvd_amt.write(writer)?;
3049 previous_hop.write(writer)?;
3057 /// Arguments for the creation of a ChannelManager that are not deserialized.
3059 /// At a high-level, the process for deserializing a ChannelManager and resuming normal operation
3061 /// 1) Deserialize all stored ChannelMonitors.
3062 /// 2) Deserialize the ChannelManager by filling in this struct and calling <(Sha256dHash,
3063 /// ChannelManager)>::read(reader, args).
3064 /// This may result in closing some Channels if the ChannelMonitor is newer than the stored
3065 /// ChannelManager state to ensure no loss of funds. Thus, transactions may be broadcasted.
3066 /// 3) Register all relevant ChannelMonitor outpoints with your chain watch mechanism using
3067 /// ChannelMonitor::get_monitored_outpoints and ChannelMonitor::get_funding_txo().
3068 /// 4) Reconnect blocks on your ChannelMonitors.
3069 /// 5) Move the ChannelMonitors into your local ManyChannelMonitor.
3070 /// 6) Disconnect/connect blocks on the ChannelManager.
3071 /// 7) Register the new ChannelManager with your ChainWatchInterface (this does not happen
3072 /// automatically as it does in ChannelManager::new()).
3073 pub struct ChannelManagerReadArgs<'a> {
3074 /// The keys provider which will give us relevant keys. Some keys will be loaded during
3075 /// deserialization.
3076 pub keys_manager: Arc<KeysInterface>,
3078 /// The fee_estimator for use in the ChannelManager in the future.
3080 /// No calls to the FeeEstimator will be made during deserialization.
3081 pub fee_estimator: Arc<FeeEstimator>,
3082 /// The ManyChannelMonitor for use in the ChannelManager in the future.
3084 /// No calls to the ManyChannelMonitor will be made during deserialization. It is assumed that
3085 /// you have deserialized ChannelMonitors separately and will add them to your
3086 /// ManyChannelMonitor after deserializing this ChannelManager.
3087 pub monitor: Arc<ManyChannelMonitor>,
3088 /// The ChainWatchInterface for use in the ChannelManager in the future.
3090 /// No calls to the ChainWatchInterface will be made during deserialization.
3091 pub chain_monitor: Arc<ChainWatchInterface>,
3092 /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
3093 /// used to broadcast the latest local commitment transactions of channels which must be
3094 /// force-closed during deserialization.
3095 pub tx_broadcaster: Arc<BroadcasterInterface>,
3096 /// The Logger for use in the ChannelManager and which may be used to log information during
3097 /// deserialization.
3098 pub logger: Arc<Logger>,
3099 /// Default settings used for new channels. Any existing channels will continue to use the
3100 /// runtime settings which were stored when the ChannelManager was serialized.
3101 pub default_config: UserConfig,
3103 /// A map from channel funding outpoints to ChannelMonitors for those channels (ie
3104 /// value.get_funding_txo() should be the key).
3106 /// If a monitor is inconsistent with the channel state during deserialization the channel will
3107 /// be force-closed using the data in the ChannelMonitor and the channel will be dropped. This
3108 /// is true for missing channels as well. If there is a monitor missing for which we find
3109 /// channel data Err(DecodeError::InvalidValue) will be returned.
3111 /// In such cases the latest local transactions will be sent to the tx_broadcaster included in
3113 pub channel_monitors: &'a HashMap<OutPoint, &'a ChannelMonitor>,
3116 impl<'a, R : ::std::io::Read> ReadableArgs<R, ChannelManagerReadArgs<'a>> for (Sha256dHash, ChannelManager) {
3117 fn read(reader: &mut R, args: ChannelManagerReadArgs<'a>) -> Result<Self, DecodeError> {
3118 let _ver: u8 = Readable::read(reader)?;
3119 let min_ver: u8 = Readable::read(reader)?;
3120 if min_ver > SERIALIZATION_VERSION {
3121 return Err(DecodeError::UnknownVersion);
3124 let genesis_hash: Sha256dHash = Readable::read(reader)?;
3125 let latest_block_height: u32 = Readable::read(reader)?;
3126 let last_block_hash: Sha256dHash = Readable::read(reader)?;
3128 let mut closed_channels = Vec::new();
3130 let channel_count: u64 = Readable::read(reader)?;
3131 let mut funding_txo_set = HashSet::with_capacity(cmp::min(channel_count as usize, 128));
3132 let mut by_id = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
3133 let mut short_to_id = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
3134 for _ in 0..channel_count {
3135 let mut channel: Channel = ReadableArgs::read(reader, args.logger.clone())?;
3136 if channel.last_block_connected != last_block_hash {
3137 return Err(DecodeError::InvalidValue);
3140 let funding_txo = channel.channel_monitor().get_funding_txo().ok_or(DecodeError::InvalidValue)?;
3141 funding_txo_set.insert(funding_txo.clone());
3142 if let Some(monitor) = args.channel_monitors.get(&funding_txo) {
3143 if channel.get_cur_local_commitment_transaction_number() != monitor.get_cur_local_commitment_number() ||
3144 channel.get_revoked_remote_commitment_transaction_number() != monitor.get_min_seen_secret() ||
3145 channel.get_cur_remote_commitment_transaction_number() != monitor.get_cur_remote_commitment_number() {
3146 let mut force_close_res = channel.force_shutdown();
3147 force_close_res.0 = monitor.get_latest_local_commitment_txn();
3148 closed_channels.push(force_close_res);
3150 if let Some(short_channel_id) = channel.get_short_channel_id() {
3151 short_to_id.insert(short_channel_id, channel.channel_id());
3153 by_id.insert(channel.channel_id(), channel);
3156 return Err(DecodeError::InvalidValue);
3160 for (ref funding_txo, ref monitor) in args.channel_monitors.iter() {
3161 if !funding_txo_set.contains(funding_txo) {
3162 closed_channels.push((monitor.get_latest_local_commitment_txn(), Vec::new()));
3166 let forward_htlcs_count: u64 = Readable::read(reader)?;
3167 let mut forward_htlcs = HashMap::with_capacity(cmp::min(forward_htlcs_count as usize, 128));
3168 for _ in 0..forward_htlcs_count {
3169 let short_channel_id = Readable::read(reader)?;
3170 let pending_forwards_count: u64 = Readable::read(reader)?;
3171 let mut pending_forwards = Vec::with_capacity(cmp::min(pending_forwards_count as usize, 128));
3172 for _ in 0..pending_forwards_count {
3173 pending_forwards.push(Readable::read(reader)?);
3175 forward_htlcs.insert(short_channel_id, pending_forwards);
3178 let claimable_htlcs_count: u64 = Readable::read(reader)?;
3179 let mut claimable_htlcs = HashMap::with_capacity(cmp::min(claimable_htlcs_count as usize, 128));
3180 for _ in 0..claimable_htlcs_count {
3181 let payment_hash = Readable::read(reader)?;
3182 let previous_hops_len: u64 = Readable::read(reader)?;
3183 let mut previous_hops = Vec::with_capacity(cmp::min(previous_hops_len as usize, 2));
3184 for _ in 0..previous_hops_len {
3185 previous_hops.push((Readable::read(reader)?, Readable::read(reader)?));
3187 claimable_htlcs.insert(payment_hash, previous_hops);
3190 let channel_manager = ChannelManager {
3192 fee_estimator: args.fee_estimator,
3193 monitor: args.monitor,
3194 chain_monitor: args.chain_monitor,
3195 tx_broadcaster: args.tx_broadcaster,
3197 latest_block_height: AtomicUsize::new(latest_block_height as usize),
3198 last_block_hash: Mutex::new(last_block_hash),
3199 secp_ctx: Secp256k1::new(),
3201 channel_state: Mutex::new(ChannelHolder {
3206 pending_msg_events: Vec::new(),
3208 our_network_key: args.keys_manager.get_node_secret(),
3210 pending_events: Mutex::new(Vec::new()),
3211 total_consistency_lock: RwLock::new(()),
3212 keys_manager: args.keys_manager,
3213 logger: args.logger,
3214 default_configuration: args.default_config,
3217 for close_res in closed_channels.drain(..) {
3218 channel_manager.finish_force_close_channel(close_res);
3219 //TODO: Broadcast channel update for closed channels, but only after we've made a
3220 //connection or two.
3223 Ok((last_block_hash.clone(), channel_manager))