1 use bitcoin::blockdata::block::BlockHeader;
2 use bitcoin::blockdata::transaction::Transaction;
3 use bitcoin::blockdata::constants::genesis_block;
4 use bitcoin::network::constants::Network;
5 use bitcoin::network::serialize::BitcoinHash;
6 use bitcoin::util::hash::Sha256dHash;
8 use secp256k1::key::{SecretKey,PublicKey};
9 use secp256k1::{Secp256k1,Message};
10 use secp256k1::ecdh::SharedSecret;
13 use chain::chaininterface::{BroadcasterInterface,ChainListener,ChainWatchInterface,FeeEstimator};
14 use chain::transaction::OutPoint;
15 use ln::channel::{Channel, ChannelKeys};
16 use ln::channelmonitor::ManyChannelMonitor;
17 use ln::router::{Route,RouteHop};
19 use ln::msgs::{HandleError,ChannelMessageHandler,MsgEncodable,MsgDecodable};
20 use util::{byte_utils, events, internal_traits, rng};
21 use util::sha2::Sha256;
22 use util::chacha20poly1305rfc::ChaCha20;
23 use util::logger::Logger;
24 use util::errors::APIError;
27 use crypto::mac::{Mac,MacResult};
28 use crypto::hmac::Hmac;
29 use crypto::digest::Digest;
30 use crypto::symmetriccipher::SynchronousStreamCipher;
33 use std::collections::HashMap;
34 use std::collections::hash_map;
35 use std::sync::{Mutex,MutexGuard,Arc};
36 use std::sync::atomic::{AtomicUsize, Ordering};
37 use std::time::{Instant,Duration};
39 mod channel_held_info {
42 /// Stores the info we will need to send when we want to forward an HTLC onwards
43 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
44 pub struct PendingForwardHTLCInfo {
45 pub(super) onion_packet: Option<msgs::OnionPacket>,
46 pub(super) payment_hash: [u8; 32],
47 pub(super) short_channel_id: u64,
48 pub(super) prev_short_channel_id: u64,
49 pub(super) amt_to_forward: u64,
50 pub(super) outgoing_cltv_value: u32,
53 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
54 pub enum HTLCFailureMsg {
55 Relay(msgs::UpdateFailHTLC),
56 Malformed(msgs::UpdateFailMalformedHTLC),
59 /// Stores whether we can't forward an HTLC or relevant forwarding info
60 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
61 pub enum PendingHTLCStatus {
62 Forward(PendingForwardHTLCInfo),
66 #[cfg(feature = "fuzztarget")]
67 impl PendingHTLCStatus {
68 pub fn dummy() -> Self {
69 PendingHTLCStatus::Forward(PendingForwardHTLCInfo {
71 payment_hash: [0; 32],
73 prev_short_channel_id: 0,
75 outgoing_cltv_value: 0,
80 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
81 pub enum HTLCFailReason {
83 err: msgs::OnionErrorPacket,
91 #[cfg(feature = "fuzztarget")]
93 pub fn dummy() -> Self {
94 HTLCFailReason::Reason {
95 failure_code: 0, data: Vec::new(),
100 #[cfg(feature = "fuzztarget")]
101 pub use self::channel_held_info::*;
102 #[cfg(not(feature = "fuzztarget"))]
103 pub(crate) use self::channel_held_info::*;
105 enum PendingOutboundHTLC {
106 IntermediaryHopData {
107 source_short_channel_id: u64,
108 incoming_packet_shared_secret: SharedSecret,
112 session_priv: SecretKey,
114 /// Used for channel rebalancing
116 source_short_channel_id: u64,
117 incoming_packet_shared_secret: SharedSecret,
119 session_priv: SecretKey,
123 struct MsgHandleErrInternal {
124 err: msgs::HandleError,
125 needs_channel_force_close: bool,
127 impl MsgHandleErrInternal {
129 fn send_err_msg_no_close(err: &'static str, channel_id: [u8; 32]) -> Self {
133 action: Some(msgs::ErrorAction::SendErrorMessage {
134 msg: msgs::ErrorMessage {
136 data: err.to_string()
140 needs_channel_force_close: false,
144 fn send_err_msg_close_chan(err: &'static str, channel_id: [u8; 32]) -> Self {
148 action: Some(msgs::ErrorAction::SendErrorMessage {
149 msg: msgs::ErrorMessage {
151 data: err.to_string()
155 needs_channel_force_close: true,
159 fn from_maybe_close(err: msgs::HandleError) -> Self {
160 Self { err, needs_channel_force_close: true }
163 fn from_no_close(err: msgs::HandleError) -> Self {
164 Self { err, needs_channel_force_close: false }
168 /// We hold back HTLCs we intend to relay for a random interval in the range (this, 5*this). This
169 /// provides some limited amount of privacy. Ideally this would range from somewhere like 1 second
170 /// to 30 seconds, but people expect lightning to be, you know, kinda fast, sadly. We could
171 /// probably increase this significantly.
172 const MIN_HTLC_RELAY_HOLDING_CELL_MILLIS: u32 = 50;
174 struct ChannelHolder {
175 by_id: HashMap<[u8; 32], Channel>,
176 short_to_id: HashMap<u64, [u8; 32]>,
177 next_forward: Instant,
178 /// short channel id -> forward infos. Key of 0 means payments received
179 /// Note that while this is held in the same mutex as the channels themselves, no consistency
180 /// guarantees are made about there existing a channel with the short id here, nor the short
181 /// ids in the PendingForwardHTLCInfo!
182 forward_htlcs: HashMap<u64, Vec<PendingForwardHTLCInfo>>,
183 /// Note that while this is held in the same mutex as the channels themselves, no consistency
184 /// guarantees are made about the channels given here actually existing anymore by the time you
186 claimable_htlcs: HashMap<[u8; 32], PendingOutboundHTLC>,
188 struct MutChannelHolder<'a> {
189 by_id: &'a mut HashMap<[u8; 32], Channel>,
190 short_to_id: &'a mut HashMap<u64, [u8; 32]>,
191 next_forward: &'a mut Instant,
192 forward_htlcs: &'a mut HashMap<u64, Vec<PendingForwardHTLCInfo>>,
193 claimable_htlcs: &'a mut HashMap<[u8; 32], PendingOutboundHTLC>,
196 fn borrow_parts(&mut self) -> MutChannelHolder {
198 by_id: &mut self.by_id,
199 short_to_id: &mut self.short_to_id,
200 next_forward: &mut self.next_forward,
201 forward_htlcs: &mut self.forward_htlcs,
202 claimable_htlcs: &mut self.claimable_htlcs,
207 #[cfg(not(any(target_pointer_width = "32", target_pointer_width = "64")))]
208 const ERR: () = "You need at least 32 bit pointers (well, usize, but we'll assume they're the same) for ChannelManager::latest_block_height";
210 /// Manager which keeps track of a number of channels and sends messages to the appropriate
211 /// channel, also tracking HTLC preimages and forwarding onion packets appropriately.
212 /// Implements ChannelMessageHandler, handling the multi-channel parts and passing things through
213 /// to individual Channels.
214 pub struct ChannelManager {
215 genesis_hash: Sha256dHash,
216 fee_estimator: Arc<FeeEstimator>,
217 monitor: Arc<ManyChannelMonitor>,
218 chain_monitor: Arc<ChainWatchInterface>,
219 tx_broadcaster: Arc<BroadcasterInterface>,
221 announce_channels_publicly: bool,
222 fee_proportional_millionths: u32,
223 latest_block_height: AtomicUsize,
224 secp_ctx: Secp256k1<secp256k1::All>,
226 channel_state: Mutex<ChannelHolder>,
227 our_network_key: SecretKey,
229 pending_events: Mutex<Vec<events::Event>>,
234 const CLTV_EXPIRY_DELTA: u16 = 6 * 24 * 2; //TODO?
236 macro_rules! secp_call {
237 ( $res: expr, $err: expr ) => {
240 Err(_) => return Err($err),
247 shared_secret: SharedSecret,
249 blinding_factor: [u8; 32],
250 ephemeral_pubkey: PublicKey,
255 pub struct ChannelDetails {
256 /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
257 /// thereafter this is the txid of the funding transaction xor the funding transaction output).
258 /// Note that this means this value is *not* persistent - it can change once during the
259 /// lifetime of the channel.
260 pub channel_id: [u8; 32],
261 /// The position of the funding transaction in the chain. None if the funding transaction has
262 /// not yet been confirmed and the channel fully opened.
263 pub short_channel_id: Option<u64>,
264 pub remote_network_id: PublicKey,
265 pub channel_value_satoshis: u64,
266 /// The user_id passed in to create_channel, or 0 if the channel was inbound.
270 impl ChannelManager {
271 /// Constructs a new ChannelManager to hold several channels and route between them. This is
272 /// the main "logic hub" for all channel-related actions, and implements ChannelMessageHandler.
273 /// fee_proportional_millionths is an optional fee to charge any payments routed through us.
274 /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
275 /// panics if channel_value_satoshis is >= `MAX_FUNDING_SATOSHIS`!
276 pub fn new(our_network_key: SecretKey, fee_proportional_millionths: u32, announce_channels_publicly: bool, network: Network, feeest: Arc<FeeEstimator>, monitor: Arc<ManyChannelMonitor>, chain_monitor: Arc<ChainWatchInterface>, tx_broadcaster: Arc<BroadcasterInterface>, logger: Arc<Logger>) -> Result<Arc<ChannelManager>, secp256k1::Error> {
277 let secp_ctx = Secp256k1::new();
279 let res = Arc::new(ChannelManager {
280 genesis_hash: genesis_block(network).header.bitcoin_hash(),
281 fee_estimator: feeest.clone(),
282 monitor: monitor.clone(),
286 announce_channels_publicly,
287 fee_proportional_millionths,
288 latest_block_height: AtomicUsize::new(0), //TODO: Get an init value (generally need to replay recent chain on chain_monitor registration)
291 channel_state: Mutex::new(ChannelHolder{
292 by_id: HashMap::new(),
293 short_to_id: HashMap::new(),
294 next_forward: Instant::now(),
295 forward_htlcs: HashMap::new(),
296 claimable_htlcs: HashMap::new(),
300 pending_events: Mutex::new(Vec::new()),
304 let weak_res = Arc::downgrade(&res);
305 res.chain_monitor.register_listener(weak_res);
309 /// Creates a new outbound channel to the given remote node and with the given value.
310 /// user_id will be provided back as user_channel_id in FundingGenerationReady and
311 /// FundingBroadcastSafe events to allow tracking of which events correspond with which
312 /// create_channel call. Note that user_channel_id defaults to 0 for inbound channels, so you
313 /// may wish to avoid using 0 for user_id here.
314 /// If successful, will generate a SendOpenChannel event, so you should probably poll
315 /// PeerManager::process_events afterwards.
316 /// Raises APIError::APIMisuseError when channel_value_satoshis > 2**24 or push_msat being greater than channel_value_satoshis * 1k
317 pub fn create_channel(&self, their_network_key: PublicKey, channel_value_satoshis: u64, push_msat: u64, user_id: u64) -> Result<(), APIError> {
318 let chan_keys = if cfg!(feature = "fuzztarget") {
320 funding_key: SecretKey::from_slice(&self.secp_ctx, &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]).unwrap(),
321 revocation_base_key: SecretKey::from_slice(&self.secp_ctx, &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]).unwrap(),
322 payment_base_key: SecretKey::from_slice(&self.secp_ctx, &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]).unwrap(),
323 delayed_payment_base_key: SecretKey::from_slice(&self.secp_ctx, &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]).unwrap(),
324 htlc_base_key: SecretKey::from_slice(&self.secp_ctx, &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]).unwrap(),
325 channel_close_key: SecretKey::from_slice(&self.secp_ctx, &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]).unwrap(),
326 channel_monitor_claim_key: SecretKey::from_slice(&self.secp_ctx, &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]).unwrap(),
327 commitment_seed: [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
330 let mut key_seed = [0u8; 32];
331 rng::fill_bytes(&mut key_seed);
332 match ChannelKeys::new_from_seed(&key_seed) {
334 Err(_) => panic!("RNG is busted!")
338 let channel = Channel::new_outbound(&*self.fee_estimator, chan_keys, their_network_key, channel_value_satoshis, push_msat, self.announce_channels_publicly, user_id, Arc::clone(&self.logger))?;
339 let res = channel.get_open_channel(self.genesis_hash.clone(), &*self.fee_estimator)?;
340 let mut channel_state = self.channel_state.lock().unwrap();
341 match channel_state.by_id.insert(channel.channel_id(), channel) {
342 Some(_) => panic!("RNG is bad???"),
346 let mut events = self.pending_events.lock().unwrap();
347 events.push(events::Event::SendOpenChannel {
348 node_id: their_network_key,
354 /// Gets the list of open channels, in random order. See ChannelDetail field documentation for
355 /// more information.
356 pub fn list_channels(&self) -> Vec<ChannelDetails> {
357 let channel_state = self.channel_state.lock().unwrap();
358 let mut res = Vec::with_capacity(channel_state.by_id.len());
359 for (channel_id, channel) in channel_state.by_id.iter() {
360 res.push(ChannelDetails {
361 channel_id: (*channel_id).clone(),
362 short_channel_id: channel.get_short_channel_id(),
363 remote_network_id: channel.get_their_node_id(),
364 channel_value_satoshis: channel.get_value_satoshis(),
365 user_id: channel.get_user_id(),
371 /// Gets the list of usable channels, in random order. Useful as an argument to
372 /// Router::get_route to ensure non-announced channels are used.
373 pub fn list_usable_channels(&self) -> Vec<ChannelDetails> {
374 let channel_state = self.channel_state.lock().unwrap();
375 let mut res = Vec::with_capacity(channel_state.by_id.len());
376 for (channel_id, channel) in channel_state.by_id.iter() {
377 if channel.is_usable() {
378 res.push(ChannelDetails {
379 channel_id: (*channel_id).clone(),
380 short_channel_id: channel.get_short_channel_id(),
381 remote_network_id: channel.get_their_node_id(),
382 channel_value_satoshis: channel.get_value_satoshis(),
383 user_id: channel.get_user_id(),
390 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
391 /// will be accepted on the given channel, and after additional timeout/the closing of all
392 /// pending HTLCs, the channel will be closed on chain.
393 /// May generate a SendShutdown event on success, which should be relayed.
394 pub fn close_channel(&self, channel_id: &[u8; 32]) -> Result<(), HandleError> {
395 let (res, node_id, chan_option) = {
396 let mut channel_state_lock = self.channel_state.lock().unwrap();
397 let channel_state = channel_state_lock.borrow_parts();
398 match channel_state.by_id.entry(channel_id.clone()) {
399 hash_map::Entry::Occupied(mut chan_entry) => {
400 let res = chan_entry.get_mut().get_shutdown()?;
401 if chan_entry.get().is_shutdown() {
402 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
403 channel_state.short_to_id.remove(&short_id);
405 (res, chan_entry.get().get_their_node_id(), Some(chan_entry.remove_entry().1))
406 } else { (res, chan_entry.get().get_their_node_id(), None) }
408 hash_map::Entry::Vacant(_) => return Err(HandleError{err: "No such channel", action: None})
411 for payment_hash in res.1 {
412 // unknown_next_peer...I dunno who that is anymore....
413 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), &payment_hash, HTLCFailReason::Reason { failure_code: 0x4000 | 10, data: Vec::new() });
415 let chan_update = if let Some(chan) = chan_option {
416 if let Ok(update) = self.get_channel_update(&chan) {
421 let mut events = self.pending_events.lock().unwrap();
422 if let Some(update) = chan_update {
423 events.push(events::Event::BroadcastChannelUpdate {
427 events.push(events::Event::SendShutdown {
436 fn finish_force_close_channel(&self, shutdown_res: (Vec<Transaction>, Vec<[u8; 32]>)) {
437 let (local_txn, failed_htlcs) = shutdown_res;
438 for payment_hash in failed_htlcs {
439 // unknown_next_peer...I dunno who that is anymore....
440 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), &payment_hash, HTLCFailReason::Reason { failure_code: 0x4000 | 10, data: Vec::new() });
442 for tx in local_txn {
443 self.tx_broadcaster.broadcast_transaction(&tx);
445 //TODO: We need to have a way where outbound HTLC claims can result in us claiming the
446 //now-on-chain HTLC output for ourselves (and, thereafter, passing the HTLC backwards).
447 //TODO: We need to handle monitoring of pending offered HTLCs which just hit the chain and
448 //may be claimed, resulting in us claiming the inbound HTLCs (and back-failing after
449 //timeouts are hit and our claims confirm).
452 /// Force closes a channel, immediately broadcasting the latest local commitment transaction to
453 /// the chain and rejecting new HTLCs on the given channel.
454 pub fn force_close_channel(&self, channel_id: &[u8; 32]) {
456 let mut channel_state_lock = self.channel_state.lock().unwrap();
457 let channel_state = channel_state_lock.borrow_parts();
458 if let Some(chan) = channel_state.by_id.remove(channel_id) {
459 if let Some(short_id) = chan.get_short_channel_id() {
460 channel_state.short_to_id.remove(&short_id);
467 self.finish_force_close_channel(chan.force_shutdown());
468 let mut events = self.pending_events.lock().unwrap();
469 if let Ok(update) = self.get_channel_update(&chan) {
470 events.push(events::Event::BroadcastChannelUpdate {
476 /// Force close all channels, immediately broadcasting the latest local commitment transaction
477 /// for each to the chain and rejecting new HTLCs on each.
478 pub fn force_close_all_channels(&self) {
479 for chan in self.list_channels() {
480 self.force_close_channel(&chan.channel_id);
485 fn gen_rho_mu_from_shared_secret(shared_secret: &SharedSecret) -> ([u8; 32], [u8; 32]) {
487 let mut hmac = Hmac::new(Sha256::new(), &[0x72, 0x68, 0x6f]); // rho
488 hmac.input(&shared_secret[..]);
489 let mut res = [0; 32];
490 hmac.raw_result(&mut res);
494 let mut hmac = Hmac::new(Sha256::new(), &[0x6d, 0x75]); // mu
495 hmac.input(&shared_secret[..]);
496 let mut res = [0; 32];
497 hmac.raw_result(&mut res);
503 fn gen_um_from_shared_secret(shared_secret: &SharedSecret) -> [u8; 32] {
504 let mut hmac = Hmac::new(Sha256::new(), &[0x75, 0x6d]); // um
505 hmac.input(&shared_secret[..]);
506 let mut res = [0; 32];
507 hmac.raw_result(&mut res);
512 fn gen_ammag_from_shared_secret(shared_secret: &SharedSecret) -> [u8; 32] {
513 let mut hmac = Hmac::new(Sha256::new(), &[0x61, 0x6d, 0x6d, 0x61, 0x67]); // ammag
514 hmac.input(&shared_secret[..]);
515 let mut res = [0; 32];
516 hmac.raw_result(&mut res);
520 // can only fail if an intermediary hop has an invalid public key or session_priv is invalid
522 fn construct_onion_keys_callback<T: secp256k1::Signing, FType: FnMut(SharedSecret, [u8; 32], PublicKey, &RouteHop)> (secp_ctx: &Secp256k1<T>, route: &Route, session_priv: &SecretKey, mut callback: FType) -> Result<(), secp256k1::Error> {
523 let mut blinded_priv = session_priv.clone();
524 let mut blinded_pub = PublicKey::from_secret_key(secp_ctx, &blinded_priv);
526 for hop in route.hops.iter() {
527 let shared_secret = SharedSecret::new(secp_ctx, &hop.pubkey, &blinded_priv);
529 let mut sha = Sha256::new();
530 sha.input(&blinded_pub.serialize()[..]);
531 sha.input(&shared_secret[..]);
532 let mut blinding_factor = [0u8; 32];
533 sha.result(&mut blinding_factor);
535 let ephemeral_pubkey = blinded_pub;
537 blinded_priv.mul_assign(secp_ctx, &SecretKey::from_slice(secp_ctx, &blinding_factor)?)?;
538 blinded_pub = PublicKey::from_secret_key(secp_ctx, &blinded_priv);
540 callback(shared_secret, blinding_factor, ephemeral_pubkey, hop);
546 // can only fail if an intermediary hop has an invalid public key or session_priv is invalid
547 fn construct_onion_keys<T: secp256k1::Signing>(secp_ctx: &Secp256k1<T>, route: &Route, session_priv: &SecretKey) -> Result<Vec<OnionKeys>, secp256k1::Error> {
548 let mut res = Vec::with_capacity(route.hops.len());
550 Self::construct_onion_keys_callback(secp_ctx, route, session_priv, |shared_secret, _blinding_factor, ephemeral_pubkey, _| {
551 let (rho, mu) = ChannelManager::gen_rho_mu_from_shared_secret(&shared_secret);
557 blinding_factor: _blinding_factor,
567 /// returns the hop data, as well as the first-hop value_msat and CLTV value we should send.
568 fn build_onion_payloads(route: &Route, starting_htlc_offset: u32) -> Result<(Vec<msgs::OnionHopData>, u64, u32), HandleError> {
569 let mut cur_value_msat = 0u64;
570 let mut cur_cltv = starting_htlc_offset;
571 let mut last_short_channel_id = 0;
572 let mut res: Vec<msgs::OnionHopData> = Vec::with_capacity(route.hops.len());
573 internal_traits::test_no_dealloc::<msgs::OnionHopData>(None);
574 unsafe { res.set_len(route.hops.len()); }
576 for (idx, hop) in route.hops.iter().enumerate().rev() {
577 // First hop gets special values so that it can check, on receipt, that everything is
578 // exactly as it should be (and the next hop isn't trying to probe to find out if we're
579 // the intended recipient).
580 let value_msat = if cur_value_msat == 0 { hop.fee_msat } else { cur_value_msat };
581 let cltv = if cur_cltv == starting_htlc_offset { hop.cltv_expiry_delta + starting_htlc_offset } else { cur_cltv };
582 res[idx] = msgs::OnionHopData {
584 data: msgs::OnionRealm0HopData {
585 short_channel_id: last_short_channel_id,
586 amt_to_forward: value_msat,
587 outgoing_cltv_value: cltv,
591 cur_value_msat += hop.fee_msat;
592 if cur_value_msat >= 21000000 * 100000000 * 1000 {
593 return Err(HandleError{err: "Channel fees overflowed?!", action: None});
595 cur_cltv += hop.cltv_expiry_delta as u32;
596 if cur_cltv >= 500000000 {
597 return Err(HandleError{err: "Channel CLTV overflowed?!", action: None});
599 last_short_channel_id = hop.short_channel_id;
601 Ok((res, cur_value_msat, cur_cltv))
605 fn shift_arr_right(arr: &mut [u8; 20*65]) {
607 ptr::copy(arr[0..].as_ptr(), arr[65..].as_mut_ptr(), 19*65);
615 fn xor_bufs(dst: &mut[u8], src: &[u8]) {
616 assert_eq!(dst.len(), src.len());
618 for i in 0..dst.len() {
623 const ZERO:[u8; 21*65] = [0; 21*65];
624 fn construct_onion_packet(mut payloads: Vec<msgs::OnionHopData>, onion_keys: Vec<OnionKeys>, associated_data: &[u8; 32]) -> Result<msgs::OnionPacket, HandleError> {
625 let mut buf = Vec::with_capacity(21*65);
626 buf.resize(21*65, 0);
629 let iters = payloads.len() - 1;
630 let end_len = iters * 65;
631 let mut res = Vec::with_capacity(end_len);
632 res.resize(end_len, 0);
634 for (i, keys) in onion_keys.iter().enumerate() {
635 if i == payloads.len() - 1 { continue; }
636 let mut chacha = ChaCha20::new(&keys.rho, &[0u8; 8]);
637 chacha.process(&ChannelManager::ZERO, &mut buf); // We don't have a seek function :(
638 ChannelManager::xor_bufs(&mut res[0..(i + 1)*65], &buf[(20 - i)*65..21*65]);
643 let mut packet_data = [0; 20*65];
644 let mut hmac_res = [0; 32];
646 for (i, (payload, keys)) in payloads.iter_mut().zip(onion_keys.iter()).rev().enumerate() {
647 ChannelManager::shift_arr_right(&mut packet_data);
648 payload.hmac = hmac_res;
649 packet_data[0..65].copy_from_slice(&payload.encode()[..]);
651 let mut chacha = ChaCha20::new(&keys.rho, &[0u8; 8]);
652 chacha.process(&packet_data, &mut buf[0..20*65]);
653 packet_data[..].copy_from_slice(&buf[0..20*65]);
656 packet_data[20*65 - filler.len()..20*65].copy_from_slice(&filler[..]);
659 let mut hmac = Hmac::new(Sha256::new(), &keys.mu);
660 hmac.input(&packet_data);
661 hmac.input(&associated_data[..]);
662 hmac.raw_result(&mut hmac_res);
665 Ok(msgs::OnionPacket{
667 public_key: Ok(onion_keys.first().unwrap().ephemeral_pubkey),
668 hop_data: packet_data,
673 /// Encrypts a failure packet. raw_packet can either be a
674 /// msgs::DecodedOnionErrorPacket.encode() result or a msgs::OnionErrorPacket.data element.
675 fn encrypt_failure_packet(shared_secret: &SharedSecret, raw_packet: &[u8]) -> msgs::OnionErrorPacket {
676 let ammag = ChannelManager::gen_ammag_from_shared_secret(&shared_secret);
678 let mut packet_crypted = Vec::with_capacity(raw_packet.len());
679 packet_crypted.resize(raw_packet.len(), 0);
680 let mut chacha = ChaCha20::new(&ammag, &[0u8; 8]);
681 chacha.process(&raw_packet, &mut packet_crypted[..]);
682 msgs::OnionErrorPacket {
683 data: packet_crypted,
687 fn build_failure_packet(shared_secret: &SharedSecret, failure_type: u16, failure_data: &[u8]) -> msgs::DecodedOnionErrorPacket {
688 assert!(failure_data.len() <= 256 - 2);
690 let um = ChannelManager::gen_um_from_shared_secret(&shared_secret);
693 let mut res = Vec::with_capacity(2 + failure_data.len());
694 res.push(((failure_type >> 8) & 0xff) as u8);
695 res.push(((failure_type >> 0) & 0xff) as u8);
696 res.extend_from_slice(&failure_data[..]);
700 let mut res = Vec::with_capacity(256 - 2 - failure_data.len());
701 res.resize(256 - 2 - failure_data.len(), 0);
704 let mut packet = msgs::DecodedOnionErrorPacket {
706 failuremsg: failuremsg,
710 let mut hmac = Hmac::new(Sha256::new(), &um);
711 hmac.input(&packet.encode()[32..]);
712 hmac.raw_result(&mut packet.hmac);
718 fn build_first_hop_failure_packet(shared_secret: &SharedSecret, failure_type: u16, failure_data: &[u8]) -> msgs::OnionErrorPacket {
719 let failure_packet = ChannelManager::build_failure_packet(shared_secret, failure_type, failure_data);
720 ChannelManager::encrypt_failure_packet(shared_secret, &failure_packet.encode()[..])
723 fn decode_update_add_htlc_onion(&self, msg: &msgs::UpdateAddHTLC) -> (PendingHTLCStatus, Option<SharedSecret>, MutexGuard<ChannelHolder>) {
724 macro_rules! get_onion_hash {
727 let mut sha = Sha256::new();
728 sha.input(&msg.onion_routing_packet.hop_data);
729 let mut onion_hash = [0; 32];
730 sha.result(&mut onion_hash);
736 if let Err(_) = msg.onion_routing_packet.public_key {
737 log_info!(self, "Failed to accept/forward incoming HTLC with invalid ephemeral pubkey");
738 return (PendingHTLCStatus::Fail(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
739 channel_id: msg.channel_id,
740 htlc_id: msg.htlc_id,
741 sha256_of_onion: get_onion_hash!(),
742 failure_code: 0x8000 | 0x4000 | 6,
743 })), None, self.channel_state.lock().unwrap());
746 let shared_secret = SharedSecret::new(&self.secp_ctx, &msg.onion_routing_packet.public_key.unwrap(), &self.our_network_key);
747 let (rho, mu) = ChannelManager::gen_rho_mu_from_shared_secret(&shared_secret);
749 let mut channel_state = None;
750 macro_rules! return_err {
751 ($msg: expr, $err_code: expr, $data: expr) => {
753 log_info!(self, "Failed to accept/forward incoming HTLC: {}", $msg);
754 if channel_state.is_none() {
755 channel_state = Some(self.channel_state.lock().unwrap());
757 return (PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
758 channel_id: msg.channel_id,
759 htlc_id: msg.htlc_id,
760 reason: ChannelManager::build_first_hop_failure_packet(&shared_secret, $err_code, $data),
761 })), Some(shared_secret), channel_state.unwrap());
766 if msg.onion_routing_packet.version != 0 {
767 //TODO: Spec doesn't indicate if we should only hash hop_data here (and in other
768 //sha256_of_onion error data packets), or the entire onion_routing_packet. Either way,
769 //the hash doesn't really serve any purpuse - in the case of hashing all data, the
770 //receiving node would have to brute force to figure out which version was put in the
771 //packet by the node that send us the message, in the case of hashing the hop_data, the
772 //node knows the HMAC matched, so they already know what is there...
773 return_err!("Unknown onion packet version", 0x8000 | 0x4000 | 4, &get_onion_hash!());
776 let mut hmac = Hmac::new(Sha256::new(), &mu);
777 hmac.input(&msg.onion_routing_packet.hop_data);
778 hmac.input(&msg.payment_hash);
779 if hmac.result() != MacResult::new(&msg.onion_routing_packet.hmac) {
780 return_err!("HMAC Check failed", 0x8000 | 0x4000 | 5, &get_onion_hash!());
783 let mut chacha = ChaCha20::new(&rho, &[0u8; 8]);
784 let next_hop_data = {
785 let mut decoded = [0; 65];
786 chacha.process(&msg.onion_routing_packet.hop_data[0..65], &mut decoded);
787 match msgs::OnionHopData::decode(&decoded[..]) {
789 let error_code = match err {
790 msgs::DecodeError::UnknownRealmByte => 0x4000 | 1,
791 _ => 0x2000 | 2, // Should never happen
793 return_err!("Unable to decode our hop data", error_code, &[0;0]);
799 //TODO: Check that msg.cltv_expiry is within acceptable bounds!
801 let pending_forward_info = if next_hop_data.hmac == [0; 32] {
803 if next_hop_data.data.amt_to_forward != msg.amount_msat {
804 return_err!("Upstream node sent less than we were supposed to receive in payment", 19, &byte_utils::be64_to_array(msg.amount_msat));
806 if next_hop_data.data.outgoing_cltv_value != msg.cltv_expiry {
807 return_err!("Upstream node set CLTV to the wrong value", 18, &byte_utils::be32_to_array(msg.cltv_expiry));
810 // Note that we could obviously respond immediately with an update_fulfill_htlc
811 // message, however that would leak that we are the recipient of this payment, so
812 // instead we stay symmetric with the forwarding case, only responding (after a
813 // delay) once they've send us a commitment_signed!
815 PendingHTLCStatus::Forward(PendingForwardHTLCInfo {
817 payment_hash: msg.payment_hash.clone(),
819 prev_short_channel_id: 0,
820 amt_to_forward: next_hop_data.data.amt_to_forward,
821 outgoing_cltv_value: next_hop_data.data.outgoing_cltv_value,
824 let mut new_packet_data = [0; 20*65];
825 chacha.process(&msg.onion_routing_packet.hop_data[65..], &mut new_packet_data[0..19*65]);
826 chacha.process(&ChannelManager::ZERO[0..65], &mut new_packet_data[19*65..]);
828 let mut new_pubkey = msg.onion_routing_packet.public_key.unwrap();
830 let blinding_factor = {
831 let mut sha = Sha256::new();
832 sha.input(&new_pubkey.serialize()[..]);
833 sha.input(&shared_secret[..]);
834 let mut res = [0u8; 32];
835 sha.result(&mut res);
836 match SecretKey::from_slice(&self.secp_ctx, &res) {
838 return_err!("Blinding factor is an invalid private key", 0x8000 | 0x4000 | 6, &get_onion_hash!());
844 if let Err(_) = new_pubkey.mul_assign(&self.secp_ctx, &blinding_factor) {
845 return_err!("New blinding factor is an invalid private key", 0x8000 | 0x4000 | 6, &get_onion_hash!());
848 let outgoing_packet = msgs::OnionPacket {
850 public_key: Ok(new_pubkey),
851 hop_data: new_packet_data,
852 hmac: next_hop_data.hmac.clone(),
855 PendingHTLCStatus::Forward(PendingForwardHTLCInfo {
856 onion_packet: Some(outgoing_packet),
857 payment_hash: msg.payment_hash.clone(),
858 short_channel_id: next_hop_data.data.short_channel_id,
859 prev_short_channel_id: 0,
860 amt_to_forward: next_hop_data.data.amt_to_forward,
861 outgoing_cltv_value: next_hop_data.data.outgoing_cltv_value,
865 channel_state = Some(self.channel_state.lock().unwrap());
866 if let &PendingHTLCStatus::Forward(PendingForwardHTLCInfo { ref onion_packet, ref short_channel_id, ref amt_to_forward, ref outgoing_cltv_value, .. }) = &pending_forward_info {
867 if onion_packet.is_some() { // If short_channel_id is 0 here, we'll reject them in the body here
868 let id_option = channel_state.as_ref().unwrap().short_to_id.get(&short_channel_id).cloned();
869 let forwarding_id = match id_option {
871 return_err!("Don't have available channel for forwarding as requested.", 0x4000 | 10, &[0;0]);
873 Some(id) => id.clone(),
875 if let Some((err, code, chan_update)) = {
876 let chan = channel_state.as_mut().unwrap().by_id.get_mut(&forwarding_id).unwrap();
878 Some(("Forwarding channel is not in a ready state.", 0x1000 | 7, self.get_channel_update(chan).unwrap()))
880 let fee = amt_to_forward.checked_mul(self.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) });
881 if fee.is_none() || msg.amount_msat < fee.unwrap() || (msg.amount_msat - fee.unwrap()) < *amt_to_forward {
882 Some(("Prior hop has deviated from specified fees parameters or origin node has obsolete ones", 0x1000 | 12, self.get_channel_update(chan).unwrap()))
884 if (msg.cltv_expiry as u64) < (*outgoing_cltv_value) as u64 + CLTV_EXPIRY_DELTA as u64 {
885 Some(("Forwarding node has tampered with the intended HTLC values or origin node has an obsolete cltv_expiry_delta", 0x1000 | 13, self.get_channel_update(chan).unwrap()))
892 return_err!(err, code, &chan_update.encode_with_len()[..]);
897 (pending_forward_info, Some(shared_secret), channel_state.unwrap())
900 /// only fails if the channel does not yet have an assigned short_id
901 fn get_channel_update(&self, chan: &Channel) -> Result<msgs::ChannelUpdate, HandleError> {
902 let short_channel_id = match chan.get_short_channel_id() {
903 None => return Err(HandleError{err: "Channel not yet established", action: None}),
907 let were_node_one = PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key).serialize()[..] < chan.get_their_node_id().serialize()[..];
909 let unsigned = msgs::UnsignedChannelUpdate {
910 chain_hash: self.genesis_hash,
911 short_channel_id: short_channel_id,
912 timestamp: chan.get_channel_update_count(),
913 flags: (!were_node_one) as u16 | ((!chan.is_live() as u16) << 1),
914 cltv_expiry_delta: CLTV_EXPIRY_DELTA,
915 htlc_minimum_msat: chan.get_our_htlc_minimum_msat(),
916 fee_base_msat: chan.get_our_fee_base_msat(&*self.fee_estimator),
917 fee_proportional_millionths: self.fee_proportional_millionths,
918 excess_data: Vec::new(),
921 let msg_hash = Sha256dHash::from_data(&unsigned.encode()[..]);
922 let sig = self.secp_ctx.sign(&Message::from_slice(&msg_hash[..]).unwrap(), &self.our_network_key); //TODO Can we unwrap here?
924 Ok(msgs::ChannelUpdate {
930 /// Sends a payment along a given route.
931 /// Value parameters are provided via the last hop in route, see documentation for RouteHop
932 /// fields for more info.
933 /// Note that if the payment_hash already exists elsewhere (eg you're sending a duplicative
934 /// payment), we don't do anything to stop you! We always try to ensure that if the provided
935 /// next hop knows the preimage to payment_hash they can claim an additional amount as
936 /// specified in the last hop in the route! Thus, you should probably do your own
937 /// payment_preimage tracking (which you should already be doing as they represent "proof of
938 /// payment") and prevent double-sends yourself.
939 /// See-also docs on Channel::send_htlc_and_commit.
940 /// May generate a SendHTLCs event on success, which should be relayed.
941 pub fn send_payment(&self, route: Route, payment_hash: [u8; 32]) -> Result<(), HandleError> {
942 if route.hops.len() < 1 || route.hops.len() > 20 {
943 return Err(HandleError{err: "Route didn't go anywhere/had bogus size", action: None});
945 let our_node_id = self.get_our_node_id();
946 for (idx, hop) in route.hops.iter().enumerate() {
947 if idx != route.hops.len() - 1 && hop.pubkey == our_node_id {
948 return Err(HandleError{err: "Route went through us but wasn't a simple rebalance loop to us", action: None});
952 let session_priv = SecretKey::from_slice(&self.secp_ctx, &{
953 let mut session_key = [0; 32];
954 rng::fill_bytes(&mut session_key);
956 }).expect("RNG is bad!");
958 let cur_height = self.latest_block_height.load(Ordering::Acquire) as u32 + 1;
960 //TODO: This should return something other than HandleError, that's really intended for
962 let onion_keys = secp_call!(ChannelManager::construct_onion_keys(&self.secp_ctx, &route, &session_priv),
963 HandleError{err: "Pubkey along hop was maliciously selected", action: Some(msgs::ErrorAction::IgnoreError)});
964 let (onion_payloads, htlc_msat, htlc_cltv) = ChannelManager::build_onion_payloads(&route, cur_height)?;
965 let onion_packet = ChannelManager::construct_onion_packet(onion_payloads, onion_keys, &payment_hash)?;
967 let (first_hop_node_id, (update_add, commitment_signed, chan_monitor)) = {
968 let mut channel_state_lock = self.channel_state.lock().unwrap();
969 let channel_state = channel_state_lock.borrow_parts();
971 let id = match channel_state.short_to_id.get(&route.hops.first().unwrap().short_channel_id) {
972 None => return Err(HandleError{err: "No channel available with first hop!", action: None}),
973 Some(id) => id.clone()
976 let claimable_htlc_entry = channel_state.claimable_htlcs.entry(payment_hash.clone());
977 if let hash_map::Entry::Occupied(_) = claimable_htlc_entry {
978 return Err(HandleError{err: "Already had pending HTLC with the same payment_hash", action: None});
982 let chan = channel_state.by_id.get_mut(&id).unwrap();
983 if chan.get_their_node_id() != route.hops.first().unwrap().pubkey {
984 return Err(HandleError{err: "Node ID mismatch on first hop!", action: None});
986 chan.send_htlc_and_commit(htlc_msat, payment_hash, htlc_cltv, onion_packet)?
989 let first_hop_node_id = route.hops.first().unwrap().pubkey;
991 claimable_htlc_entry.or_insert(PendingOutboundHTLC::OutboundRoute {
997 Some(msgs) => (first_hop_node_id, msgs),
998 None => return Ok(()),
1002 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1003 unimplemented!(); // maybe remove from claimable_htlcs?
1006 let mut events = self.pending_events.lock().unwrap();
1007 events.push(events::Event::UpdateHTLCs {
1008 node_id: first_hop_node_id,
1009 updates: msgs::CommitmentUpdate {
1010 update_add_htlcs: vec![update_add],
1011 update_fulfill_htlcs: Vec::new(),
1012 update_fail_htlcs: Vec::new(),
1013 update_fail_malformed_htlcs: Vec::new(),
1020 /// Call this upon creation of a funding transaction for the given channel.
1021 /// Panics if a funding transaction has already been provided for this channel.
1022 /// May panic if the funding_txo is duplicative with some other channel (note that this should
1023 /// be trivially prevented by using unique funding transaction keys per-channel).
1024 pub fn funding_transaction_generated(&self, temporary_channel_id: &[u8; 32], funding_txo: OutPoint) {
1026 macro_rules! add_pending_event {
1029 let mut pending_events = self.pending_events.lock().unwrap();
1030 pending_events.push($event);
1035 let (chan, msg, chan_monitor) = {
1036 let mut channel_state = self.channel_state.lock().unwrap();
1037 match channel_state.by_id.remove(temporary_channel_id) {
1039 match chan.get_outbound_funding_created(funding_txo) {
1040 Ok(funding_msg) => {
1041 (chan, funding_msg.0, funding_msg.1)
1044 log_error!(self, "Got bad signatures: {}!", e.err);
1045 mem::drop(channel_state);
1046 add_pending_event!(events::Event::HandleError {
1047 node_id: chan.get_their_node_id(),
1056 }; // Release channel lock for install_watch_outpoint call,
1057 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1058 unimplemented!(); // maybe remove from claimable_htlcs?
1060 add_pending_event!(events::Event::SendFundingCreated {
1061 node_id: chan.get_their_node_id(),
1065 let mut channel_state = self.channel_state.lock().unwrap();
1066 match channel_state.by_id.entry(chan.channel_id()) {
1067 hash_map::Entry::Occupied(_) => {
1068 panic!("Generated duplicate funding txid?");
1070 hash_map::Entry::Vacant(e) => {
1076 fn get_announcement_sigs(&self, chan: &Channel) -> Option<msgs::AnnouncementSignatures> {
1077 if !chan.should_announce() { return None }
1079 let (announcement, our_bitcoin_sig) = match chan.get_channel_announcement(self.get_our_node_id(), self.genesis_hash.clone()) {
1081 Err(_) => return None, // Only in case of state precondition violations eg channel is closing
1083 let msghash = Message::from_slice(&Sha256dHash::from_data(&announcement.encode()[..])[..]).unwrap();
1084 let our_node_sig = self.secp_ctx.sign(&msghash, &self.our_network_key);
1086 Some(msgs::AnnouncementSignatures {
1087 channel_id: chan.channel_id(),
1088 short_channel_id: chan.get_short_channel_id().unwrap(),
1089 node_signature: our_node_sig,
1090 bitcoin_signature: our_bitcoin_sig,
1094 /// Processes HTLCs which are pending waiting on random forward delay.
1095 /// Should only really ever be called in response to an PendingHTLCsForwardable event.
1096 /// Will likely generate further events.
1097 pub fn process_pending_htlc_forwards(&self) {
1098 let mut new_events = Vec::new();
1099 let mut failed_forwards = Vec::new();
1101 let mut channel_state_lock = self.channel_state.lock().unwrap();
1102 let channel_state = channel_state_lock.borrow_parts();
1104 if cfg!(not(feature = "fuzztarget")) && Instant::now() < *channel_state.next_forward {
1108 for (short_chan_id, pending_forwards) in channel_state.forward_htlcs.drain() {
1109 if short_chan_id != 0 {
1110 let forward_chan_id = match channel_state.short_to_id.get(&short_chan_id) {
1111 Some(chan_id) => chan_id.clone(),
1113 failed_forwards.reserve(pending_forwards.len());
1114 for forward_info in pending_forwards {
1115 failed_forwards.push((forward_info.payment_hash, 0x4000 | 10, None));
1120 let forward_chan = &mut channel_state.by_id.get_mut(&forward_chan_id).unwrap();
1122 let mut add_htlc_msgs = Vec::new();
1123 for forward_info in pending_forwards {
1124 match forward_chan.send_htlc(forward_info.amt_to_forward, forward_info.payment_hash, forward_info.outgoing_cltv_value, forward_info.onion_packet.unwrap()) {
1126 let chan_update = self.get_channel_update(forward_chan).unwrap();
1127 failed_forwards.push((forward_info.payment_hash, 0x1000 | 7, Some(chan_update)));
1132 Some(msg) => { add_htlc_msgs.push(msg); },
1134 // Nothing to do here...we're waiting on a remote
1135 // revoke_and_ack before we can add anymore HTLCs. The Channel
1136 // will automatically handle building the update_add_htlc and
1137 // commitment_signed messages when we can.
1138 // TODO: Do some kind of timer to set the channel as !is_live()
1139 // as we don't really want others relying on us relaying through
1140 // this channel currently :/.
1147 if !add_htlc_msgs.is_empty() {
1148 let (commitment_msg, monitor) = match forward_chan.send_commitment() {
1151 if let &Some(msgs::ErrorAction::DisconnectPeer{msg: Some(ref _err_msg)}) = &e.action {
1152 } else if let &Some(msgs::ErrorAction::SendErrorMessage{msg: ref _err_msg}) = &e.action {
1154 panic!("Stated return value requirements in send_commitment() were not met");
1156 //TODO: Handle...this is bad!
1160 new_events.push((Some(monitor), events::Event::UpdateHTLCs {
1161 node_id: forward_chan.get_their_node_id(),
1162 updates: msgs::CommitmentUpdate {
1163 update_add_htlcs: add_htlc_msgs,
1164 update_fulfill_htlcs: Vec::new(),
1165 update_fail_htlcs: Vec::new(),
1166 update_fail_malformed_htlcs: Vec::new(),
1167 commitment_signed: commitment_msg,
1172 for forward_info in pending_forwards {
1173 new_events.push((None, events::Event::PaymentReceived {
1174 payment_hash: forward_info.payment_hash,
1175 amt: forward_info.amt_to_forward,
1182 for failed_forward in failed_forwards.drain(..) {
1183 match failed_forward.2 {
1184 None => self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), &failed_forward.0, HTLCFailReason::Reason { failure_code: failed_forward.1, data: Vec::new() }),
1185 Some(chan_update) => self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), &failed_forward.0, HTLCFailReason::Reason { failure_code: failed_forward.1, data: chan_update.encode_with_len() }),
1189 if new_events.is_empty() { return }
1191 new_events.retain(|event| {
1192 if let &Some(ref monitor) = &event.0 {
1193 if let Err(_e) = self.monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor.clone()) {
1194 unimplemented!();// but def dont push the event...
1200 let mut events = self.pending_events.lock().unwrap();
1201 events.reserve(new_events.len());
1202 for event in new_events.drain(..) {
1203 events.push(event.1);
1207 /// Indicates that the preimage for payment_hash is unknown after a PaymentReceived event.
1208 pub fn fail_htlc_backwards(&self, payment_hash: &[u8; 32]) -> bool {
1209 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), payment_hash, HTLCFailReason::Reason { failure_code: 0x4000 | 15, data: Vec::new() })
1212 /// Fails an HTLC backwards to the sender of it to us.
1213 /// Note that while we take a channel_state lock as input, we do *not* assume consistency here.
1214 /// There are several callsites that do stupid things like loop over a list of payment_hashes
1215 /// to fail and take the channel_state lock for each iteration (as we take ownership and may
1216 /// drop it). In other words, no assumptions are made that entries in claimable_htlcs point to
1217 /// still-available channels.
1218 fn fail_htlc_backwards_internal(&self, mut channel_state: MutexGuard<ChannelHolder>, payment_hash: &[u8; 32], onion_error: HTLCFailReason) -> bool {
1219 let mut pending_htlc = {
1220 match channel_state.claimable_htlcs.remove(payment_hash) {
1221 Some(pending_htlc) => pending_htlc,
1222 None => return false,
1226 match pending_htlc {
1227 PendingOutboundHTLC::CycledRoute { source_short_channel_id, incoming_packet_shared_secret, route, session_priv } => {
1228 channel_state.claimable_htlcs.insert(payment_hash.clone(), PendingOutboundHTLC::OutboundRoute {
1232 pending_htlc = PendingOutboundHTLC::IntermediaryHopData { source_short_channel_id, incoming_packet_shared_secret };
1237 match pending_htlc {
1238 PendingOutboundHTLC::CycledRoute { .. } => unreachable!(),
1239 PendingOutboundHTLC::OutboundRoute { .. } => {
1240 mem::drop(channel_state);
1242 let mut pending_events = self.pending_events.lock().unwrap();
1243 pending_events.push(events::Event::PaymentFailed {
1244 payment_hash: payment_hash.clone()
1248 PendingOutboundHTLC::IntermediaryHopData { source_short_channel_id, incoming_packet_shared_secret } => {
1249 let err_packet = match onion_error {
1250 HTLCFailReason::Reason { failure_code, data } => {
1251 let packet = ChannelManager::build_failure_packet(&incoming_packet_shared_secret, failure_code, &data[..]).encode();
1252 ChannelManager::encrypt_failure_packet(&incoming_packet_shared_secret, &packet)
1254 HTLCFailReason::ErrorPacket { err } => {
1255 ChannelManager::encrypt_failure_packet(&incoming_packet_shared_secret, &err.data)
1259 let (node_id, fail_msgs) = {
1260 let chan_id = match channel_state.short_to_id.get(&source_short_channel_id) {
1261 Some(chan_id) => chan_id.clone(),
1262 None => return false
1265 let chan = channel_state.by_id.get_mut(&chan_id).unwrap();
1266 match chan.get_update_fail_htlc_and_commit(payment_hash, err_packet) {
1267 Ok(msg) => (chan.get_their_node_id(), msg),
1269 //TODO: Do something with e?
1276 Some((msg, commitment_msg, chan_monitor)) => {
1277 mem::drop(channel_state);
1279 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1280 unimplemented!();// but def dont push the event...
1283 let mut pending_events = self.pending_events.lock().unwrap();
1284 pending_events.push(events::Event::UpdateHTLCs {
1286 updates: msgs::CommitmentUpdate {
1287 update_add_htlcs: Vec::new(),
1288 update_fulfill_htlcs: Vec::new(),
1289 update_fail_htlcs: vec![msg],
1290 update_fail_malformed_htlcs: Vec::new(),
1291 commitment_signed: commitment_msg,
1303 /// Provides a payment preimage in response to a PaymentReceived event, returning true and
1304 /// generating message events for the net layer to claim the payment, if possible. Thus, you
1305 /// should probably kick the net layer to go send messages if this returns true!
1306 /// May panic if called except in response to a PaymentReceived event.
1307 pub fn claim_funds(&self, payment_preimage: [u8; 32]) -> bool {
1308 self.claim_funds_internal(payment_preimage, true)
1310 fn claim_funds_internal(&self, payment_preimage: [u8; 32], from_user: bool) -> bool {
1311 let mut sha = Sha256::new();
1312 sha.input(&payment_preimage);
1313 let mut payment_hash = [0; 32];
1314 sha.result(&mut payment_hash);
1316 let mut channel_state = self.channel_state.lock().unwrap();
1317 let mut pending_htlc = {
1318 match channel_state.claimable_htlcs.remove(&payment_hash) {
1319 Some(pending_htlc) => pending_htlc,
1320 None => return false,
1324 match pending_htlc {
1325 PendingOutboundHTLC::CycledRoute { source_short_channel_id, incoming_packet_shared_secret, route, session_priv } => {
1326 if from_user { // This was the end hop back to us
1327 pending_htlc = PendingOutboundHTLC::IntermediaryHopData { source_short_channel_id, incoming_packet_shared_secret };
1328 channel_state.claimable_htlcs.insert(payment_hash, PendingOutboundHTLC::OutboundRoute { route, session_priv });
1329 } else { // This came from the first upstream node
1330 // Bank error in our favor! Maybe we should tell the user this somehow???
1331 pending_htlc = PendingOutboundHTLC::OutboundRoute { route, session_priv };
1332 channel_state.claimable_htlcs.insert(payment_hash, PendingOutboundHTLC::IntermediaryHopData { source_short_channel_id, incoming_packet_shared_secret });
1338 match pending_htlc {
1339 PendingOutboundHTLC::CycledRoute { .. } => unreachable!(),
1340 PendingOutboundHTLC::OutboundRoute { .. } => {
1342 panic!("Called claim_funds with a preimage for an outgoing payment. There is nothing we can do with this, and something is seriously wrong if you knew this...");
1344 mem::drop(channel_state);
1345 let mut pending_events = self.pending_events.lock().unwrap();
1346 pending_events.push(events::Event::PaymentSent {
1351 PendingOutboundHTLC::IntermediaryHopData { source_short_channel_id, .. } => {
1352 let (node_id, fulfill_msgs) = {
1353 let chan_id = match channel_state.short_to_id.get(&source_short_channel_id) {
1354 Some(chan_id) => chan_id.clone(),
1356 // TODO: There is probably a channel manager somewhere that needs to
1357 // learn the preimage as the channel already hit the chain and that's
1363 let chan = channel_state.by_id.get_mut(&chan_id).unwrap();
1364 match chan.get_update_fulfill_htlc_and_commit(payment_preimage) {
1365 Ok(msg) => (chan.get_their_node_id(), msg),
1367 // TODO: There is probably a channel manager somewhere that needs to
1368 // learn the preimage as the channel may be about to hit the chain.
1369 //TODO: Do something with e?
1375 mem::drop(channel_state);
1376 if let Some(chan_monitor) = fulfill_msgs.1 {
1377 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1378 unimplemented!();// but def dont push the event...
1382 if let Some((msg, commitment_msg)) = fulfill_msgs.0 {
1383 let mut pending_events = self.pending_events.lock().unwrap();
1384 pending_events.push(events::Event::UpdateHTLCs {
1386 updates: msgs::CommitmentUpdate {
1387 update_add_htlcs: Vec::new(),
1388 update_fulfill_htlcs: vec![msg],
1389 update_fail_htlcs: Vec::new(),
1390 update_fail_malformed_htlcs: Vec::new(),
1391 commitment_signed: commitment_msg,
1400 /// Gets the node_id held by this ChannelManager
1401 pub fn get_our_node_id(&self) -> PublicKey {
1402 PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key)
1405 /// Used to restore channels to normal operation after a
1406 /// ChannelMonitorUpdateErr::TemporaryFailure was returned from a channel monitor update
1408 pub fn test_restore_channel_monitor(&self) {
1412 fn internal_open_channel(&self, their_node_id: &PublicKey, msg: &msgs::OpenChannel) -> Result<msgs::AcceptChannel, MsgHandleErrInternal> {
1413 if msg.chain_hash != self.genesis_hash {
1414 return Err(MsgHandleErrInternal::send_err_msg_no_close("Unknown genesis block hash", msg.temporary_channel_id.clone()));
1416 let mut channel_state = self.channel_state.lock().unwrap();
1417 if channel_state.by_id.contains_key(&msg.temporary_channel_id) {
1418 return Err(MsgHandleErrInternal::send_err_msg_no_close("temporary_channel_id collision!", msg.temporary_channel_id.clone()));
1421 let chan_keys = if cfg!(feature = "fuzztarget") {
1423 funding_key: SecretKey::from_slice(&self.secp_ctx, &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0]).unwrap(),
1424 revocation_base_key: SecretKey::from_slice(&self.secp_ctx, &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2, 0]).unwrap(),
1425 payment_base_key: SecretKey::from_slice(&self.secp_ctx, &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 0]).unwrap(),
1426 delayed_payment_base_key: SecretKey::from_slice(&self.secp_ctx, &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 0]).unwrap(),
1427 htlc_base_key: SecretKey::from_slice(&self.secp_ctx, &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 5, 0]).unwrap(),
1428 channel_close_key: SecretKey::from_slice(&self.secp_ctx, &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 6, 0]).unwrap(),
1429 channel_monitor_claim_key: SecretKey::from_slice(&self.secp_ctx, &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 7, 0]).unwrap(),
1430 commitment_seed: [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
1433 let mut key_seed = [0u8; 32];
1434 rng::fill_bytes(&mut key_seed);
1435 match ChannelKeys::new_from_seed(&key_seed) {
1437 Err(_) => panic!("RNG is busted!")
1441 let channel = Channel::new_from_req(&*self.fee_estimator, chan_keys, their_node_id.clone(), msg, 0, false, self.announce_channels_publicly, Arc::clone(&self.logger)).map_err(|e| MsgHandleErrInternal::from_no_close(e))?;
1442 let accept_msg = channel.get_accept_channel();
1443 channel_state.by_id.insert(channel.channel_id(), channel);
1447 fn internal_announcement_signatures(&self, their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), MsgHandleErrInternal> {
1448 let (chan_announcement, chan_update) = {
1449 let mut channel_state = self.channel_state.lock().unwrap();
1450 match channel_state.by_id.get_mut(&msg.channel_id) {
1452 if chan.get_their_node_id() != *their_node_id {
1453 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1455 if !chan.is_usable() {
1456 return Err(MsgHandleErrInternal::from_no_close(HandleError{err: "Got an announcement_signatures before we were ready for it", action: Some(msgs::ErrorAction::IgnoreError)}));
1459 let our_node_id = self.get_our_node_id();
1460 let (announcement, our_bitcoin_sig) = chan.get_channel_announcement(our_node_id.clone(), self.genesis_hash.clone())
1461 .map_err(|e| MsgHandleErrInternal::from_maybe_close(e))?;
1463 let were_node_one = announcement.node_id_1 == our_node_id;
1464 let msghash = Message::from_slice(&Sha256dHash::from_data(&announcement.encode()[..])[..]).unwrap();
1465 let bad_sig_action = MsgHandleErrInternal::send_err_msg_close_chan("Bad announcement_signatures node_signature", msg.channel_id);
1466 secp_call!(self.secp_ctx.verify(&msghash, &msg.node_signature, if were_node_one { &announcement.node_id_2 } else { &announcement.node_id_1 }), bad_sig_action);
1467 secp_call!(self.secp_ctx.verify(&msghash, &msg.bitcoin_signature, if were_node_one { &announcement.bitcoin_key_2 } else { &announcement.bitcoin_key_1 }), bad_sig_action);
1469 let our_node_sig = self.secp_ctx.sign(&msghash, &self.our_network_key);
1471 (msgs::ChannelAnnouncement {
1472 node_signature_1: if were_node_one { our_node_sig } else { msg.node_signature },
1473 node_signature_2: if were_node_one { msg.node_signature } else { our_node_sig },
1474 bitcoin_signature_1: if were_node_one { our_bitcoin_sig } else { msg.bitcoin_signature },
1475 bitcoin_signature_2: if were_node_one { msg.bitcoin_signature } else { our_bitcoin_sig },
1476 contents: announcement,
1477 }, self.get_channel_update(chan).unwrap()) // can only fail if we're not in a ready state
1479 None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
1482 let mut pending_events = self.pending_events.lock().unwrap();
1483 pending_events.push(events::Event::BroadcastChannelAnnouncement { msg: chan_announcement, update_msg: chan_update });
1490 impl events::EventsProvider for ChannelManager {
1491 fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
1492 let mut pending_events = self.pending_events.lock().unwrap();
1493 let mut ret = Vec::new();
1494 mem::swap(&mut ret, &mut *pending_events);
1499 impl ChainListener for ChannelManager {
1500 fn block_connected(&self, header: &BlockHeader, height: u32, txn_matched: &[&Transaction], indexes_of_txn_matched: &[u32]) {
1501 let mut new_events = Vec::new();
1502 let mut failed_channels = Vec::new();
1504 let mut channel_lock = self.channel_state.lock().unwrap();
1505 let channel_state = channel_lock.borrow_parts();
1506 let short_to_id = channel_state.short_to_id;
1507 channel_state.by_id.retain(|_, channel| {
1508 let chan_res = channel.block_connected(header, height, txn_matched, indexes_of_txn_matched);
1509 if let Ok(Some(funding_locked)) = chan_res {
1510 let announcement_sigs = self.get_announcement_sigs(channel);
1511 new_events.push(events::Event::SendFundingLocked {
1512 node_id: channel.get_their_node_id(),
1513 msg: funding_locked,
1514 announcement_sigs: announcement_sigs
1516 short_to_id.insert(channel.get_short_channel_id().unwrap(), channel.channel_id());
1517 } else if let Err(e) = chan_res {
1518 new_events.push(events::Event::HandleError {
1519 node_id: channel.get_their_node_id(),
1522 if channel.is_shutdown() {
1526 if let Some(funding_txo) = channel.get_funding_txo() {
1527 for tx in txn_matched {
1528 for inp in tx.input.iter() {
1529 if inp.previous_output == funding_txo.into_bitcoin_outpoint() {
1530 if let Some(short_id) = channel.get_short_channel_id() {
1531 short_to_id.remove(&short_id);
1533 // It looks like our counterparty went on-chain. We go ahead and
1534 // broadcast our latest local state as well here, just in case its
1535 // some kind of SPV attack, though we expect these to be dropped.
1536 failed_channels.push(channel.force_shutdown());
1537 if let Ok(update) = self.get_channel_update(&channel) {
1538 new_events.push(events::Event::BroadcastChannelUpdate {
1547 if channel.is_funding_initiated() && channel.channel_monitor().would_broadcast_at_height(height) {
1548 if let Some(short_id) = channel.get_short_channel_id() {
1549 short_to_id.remove(&short_id);
1551 failed_channels.push(channel.force_shutdown());
1552 // If would_broadcast_at_height() is true, the channel_monitor will broadcast
1553 // the latest local tx for us, so we should skip that here (it doesn't really
1554 // hurt anything, but does make tests a bit simpler).
1555 failed_channels.last_mut().unwrap().0 = Vec::new();
1556 if let Ok(update) = self.get_channel_update(&channel) {
1557 new_events.push(events::Event::BroadcastChannelUpdate {
1566 for failure in failed_channels.drain(..) {
1567 self.finish_force_close_channel(failure);
1569 let mut pending_events = self.pending_events.lock().unwrap();
1570 for funding_locked in new_events.drain(..) {
1571 pending_events.push(funding_locked);
1573 self.latest_block_height.store(height as usize, Ordering::Release);
1576 /// We force-close the channel without letting our counterparty participate in the shutdown
1577 fn block_disconnected(&self, header: &BlockHeader) {
1578 let mut new_events = Vec::new();
1579 let mut failed_channels = Vec::new();
1581 let mut channel_lock = self.channel_state.lock().unwrap();
1582 let channel_state = channel_lock.borrow_parts();
1583 let short_to_id = channel_state.short_to_id;
1584 channel_state.by_id.retain(|_, v| {
1585 if v.block_disconnected(header) {
1586 if let Some(short_id) = v.get_short_channel_id() {
1587 short_to_id.remove(&short_id);
1589 failed_channels.push(v.force_shutdown());
1590 if let Ok(update) = self.get_channel_update(&v) {
1591 new_events.push(events::Event::BroadcastChannelUpdate {
1601 for failure in failed_channels.drain(..) {
1602 self.finish_force_close_channel(failure);
1604 if !new_events.is_empty() {
1605 let mut pending_events = self.pending_events.lock().unwrap();
1606 for funding_locked in new_events.drain(..) {
1607 pending_events.push(funding_locked);
1610 self.latest_block_height.fetch_sub(1, Ordering::AcqRel);
1614 macro_rules! handle_error {
1615 ($self: ident, $internal: expr, $their_node_id: expr) => {
1618 Err(MsgHandleErrInternal { err, needs_channel_force_close }) => {
1619 if needs_channel_force_close {
1621 &Some(msgs::ErrorAction::DisconnectPeer { msg: Some(ref msg) }) => {
1622 if msg.channel_id == [0; 32] {
1623 $self.peer_disconnected(&$their_node_id, true);
1625 $self.force_close_channel(&msg.channel_id);
1628 &Some(msgs::ErrorAction::DisconnectPeer { msg: None }) => {},
1629 &Some(msgs::ErrorAction::IgnoreError) => {},
1630 &Some(msgs::ErrorAction::SendErrorMessage { ref msg }) => {
1631 if msg.channel_id == [0; 32] {
1632 $self.peer_disconnected(&$their_node_id, true);
1634 $self.force_close_channel(&msg.channel_id);
1646 impl ChannelMessageHandler for ChannelManager {
1647 //TODO: Handle errors and close channel (or so)
1648 fn handle_open_channel(&self, their_node_id: &PublicKey, msg: &msgs::OpenChannel) -> Result<msgs::AcceptChannel, HandleError> {
1649 handle_error!(self, self.internal_open_channel(their_node_id, msg), their_node_id)
1652 fn handle_accept_channel(&self, their_node_id: &PublicKey, msg: &msgs::AcceptChannel) -> Result<(), HandleError> {
1653 let (value, output_script, user_id) = {
1654 let mut channel_state = self.channel_state.lock().unwrap();
1655 match channel_state.by_id.get_mut(&msg.temporary_channel_id) {
1657 if chan.get_their_node_id() != *their_node_id {
1658 return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None})
1660 chan.accept_channel(&msg)?;
1661 (chan.get_value_satoshis(), chan.get_funding_redeemscript().to_v0_p2wsh(), chan.get_user_id())
1663 None => return Err(HandleError{err: "Failed to find corresponding channel", action: None})
1666 let mut pending_events = self.pending_events.lock().unwrap();
1667 pending_events.push(events::Event::FundingGenerationReady {
1668 temporary_channel_id: msg.temporary_channel_id,
1669 channel_value_satoshis: value,
1670 output_script: output_script,
1671 user_channel_id: user_id,
1676 fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<msgs::FundingSigned, HandleError> {
1677 let (chan, funding_msg, monitor_update) = {
1678 let mut channel_state = self.channel_state.lock().unwrap();
1679 match channel_state.by_id.entry(msg.temporary_channel_id.clone()) {
1680 hash_map::Entry::Occupied(mut chan) => {
1681 if chan.get().get_their_node_id() != *their_node_id {
1682 return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None})
1684 match chan.get_mut().funding_created(msg) {
1685 Ok((funding_msg, monitor_update)) => {
1686 (chan.remove(), funding_msg, monitor_update)
1689 //TODO: Possibly remove the channel depending on e.action
1694 hash_map::Entry::Vacant(_) => return Err(HandleError{err: "Failed to find corresponding channel", action: None})
1696 }; // Release channel lock for install_watch_outpoint call,
1697 // note that this means if the remote end is misbehaving and sends a message for the same
1698 // channel back-to-back with funding_created, we'll end up thinking they sent a message
1699 // for a bogus channel.
1700 if let Err(_e) = self.monitor.add_update_monitor(monitor_update.get_funding_txo().unwrap(), monitor_update) {
1703 let mut channel_state = self.channel_state.lock().unwrap();
1704 match channel_state.by_id.entry(funding_msg.channel_id) {
1705 hash_map::Entry::Occupied(_) => {
1706 return Err(HandleError {
1707 err: "Duplicate channel_id!",
1708 action: Some(msgs::ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage { channel_id: funding_msg.channel_id, data: "Already had channel with the new channel_id".to_owned() } })
1711 hash_map::Entry::Vacant(e) => {
1718 fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), HandleError> {
1719 let (funding_txo, user_id, monitor) = {
1720 let mut channel_state = self.channel_state.lock().unwrap();
1721 match channel_state.by_id.get_mut(&msg.channel_id) {
1723 if chan.get_their_node_id() != *their_node_id {
1724 return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None})
1726 let chan_monitor = chan.funding_signed(&msg)?;
1727 (chan.get_funding_txo().unwrap(), chan.get_user_id(), chan_monitor)
1729 None => return Err(HandleError{err: "Failed to find corresponding channel", action: None})
1732 if let Err(_e) = self.monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor) {
1735 let mut pending_events = self.pending_events.lock().unwrap();
1736 pending_events.push(events::Event::FundingBroadcastSafe {
1737 funding_txo: funding_txo,
1738 user_channel_id: user_id,
1743 fn handle_funding_locked(&self, their_node_id: &PublicKey, msg: &msgs::FundingLocked) -> Result<Option<msgs::AnnouncementSignatures>, HandleError> {
1744 let mut channel_state = self.channel_state.lock().unwrap();
1745 match channel_state.by_id.get_mut(&msg.channel_id) {
1747 if chan.get_their_node_id() != *their_node_id {
1748 return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None})
1750 chan.funding_locked(&msg)?;
1751 return Ok(self.get_announcement_sigs(chan));
1753 None => return Err(HandleError{err: "Failed to find corresponding channel", action: None})
1757 fn handle_shutdown(&self, their_node_id: &PublicKey, msg: &msgs::Shutdown) -> Result<(Option<msgs::Shutdown>, Option<msgs::ClosingSigned>), HandleError> {
1758 let (res, chan_option) = {
1759 let mut channel_state_lock = self.channel_state.lock().unwrap();
1760 let channel_state = channel_state_lock.borrow_parts();
1762 match channel_state.by_id.entry(msg.channel_id.clone()) {
1763 hash_map::Entry::Occupied(mut chan_entry) => {
1764 if chan_entry.get().get_their_node_id() != *their_node_id {
1765 return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None})
1767 let res = chan_entry.get_mut().shutdown(&*self.fee_estimator, &msg)?;
1768 if chan_entry.get().is_shutdown() {
1769 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
1770 channel_state.short_to_id.remove(&short_id);
1772 (res, Some(chan_entry.remove_entry().1))
1773 } else { (res, None) }
1775 hash_map::Entry::Vacant(_) => return Err(HandleError{err: "Failed to find corresponding channel", action: None})
1778 for payment_hash in res.2 {
1779 // unknown_next_peer...I dunno who that is anymore....
1780 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), &payment_hash, HTLCFailReason::Reason { failure_code: 0x4000 | 10, data: Vec::new() });
1782 if let Some(chan) = chan_option {
1783 if let Ok(update) = self.get_channel_update(&chan) {
1784 let mut events = self.pending_events.lock().unwrap();
1785 events.push(events::Event::BroadcastChannelUpdate {
1793 fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<Option<msgs::ClosingSigned>, HandleError> {
1794 let (res, chan_option) = {
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(msg.channel_id.clone()) {
1798 hash_map::Entry::Occupied(mut chan_entry) => {
1799 if chan_entry.get().get_their_node_id() != *their_node_id {
1800 return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None})
1802 let res = chan_entry.get_mut().closing_signed(&*self.fee_estimator, &msg)?;
1803 if res.1.is_some() {
1804 // We're done with this channel, we've got a signed closing transaction and
1805 // will send the closing_signed back to the remote peer upon return. This
1806 // also implies there are no pending HTLCs left on the channel, so we can
1807 // fully delete it from tracking (the channel monitor is still around to
1808 // watch for old state broadcasts)!
1809 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
1810 channel_state.short_to_id.remove(&short_id);
1812 (res, Some(chan_entry.remove_entry().1))
1813 } else { (res, None) }
1815 hash_map::Entry::Vacant(_) => return Err(HandleError{err: "Failed to find corresponding channel", action: None})
1818 if let Some(broadcast_tx) = res.1 {
1819 self.tx_broadcaster.broadcast_transaction(&broadcast_tx);
1821 if let Some(chan) = chan_option {
1822 if let Ok(update) = self.get_channel_update(&chan) {
1823 let mut events = self.pending_events.lock().unwrap();
1824 events.push(events::Event::BroadcastChannelUpdate {
1832 fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), msgs::HandleError> {
1833 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
1834 //determine the state of the payment based on our response/if we forward anything/the time
1835 //we take to respond. We should take care to avoid allowing such an attack.
1837 //TODO: There exists a further attack where a node may garble the onion data, forward it to
1838 //us repeatedly garbled in different ways, and compare our error messages, which are
1839 //encrypted with the same key. Its not immediately obvious how to usefully exploit that,
1840 //but we should prevent it anyway.
1842 let (mut pending_forward_info, shared_secret, mut channel_state_lock) = self.decode_update_add_htlc_onion(msg);
1843 let channel_state = channel_state_lock.borrow_parts();
1845 let claimable_htlcs_entry = channel_state.claimable_htlcs.entry(msg.payment_hash.clone());
1847 // We dont correctly handle payments that route through us twice on their way to their
1848 // destination. That's OK since those nodes are probably busted or trying to do network
1849 // mapping through repeated loops. In either case, we want them to stop talking to us, so
1850 // we send permanent_node_failure.
1851 let mut will_forward = false;
1852 if let PendingHTLCStatus::Forward(PendingForwardHTLCInfo { short_channel_id, .. }) = pending_forward_info {
1853 if let &hash_map::Entry::Occupied(ref e) = &claimable_htlcs_entry {
1854 let mut acceptable_cycle = false;
1855 if let &PendingOutboundHTLC::OutboundRoute { .. } = e.get() {
1856 acceptable_cycle = short_channel_id == 0;
1858 if !acceptable_cycle {
1859 log_info!(self, "Failed to accept incoming HTLC: Payment looped through us twice");
1860 pending_forward_info = PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
1861 channel_id: msg.channel_id,
1862 htlc_id: msg.htlc_id,
1863 reason: ChannelManager::build_first_hop_failure_packet(&shared_secret.unwrap(), 0x4000 | 0x2000 | 2, &[0;0]),
1866 will_forward = true;
1869 will_forward = true;
1873 let (source_short_channel_id, res) = match channel_state.by_id.get_mut(&msg.channel_id) {
1875 if chan.get_their_node_id() != *their_node_id {
1876 return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None})
1878 if !chan.is_usable() {
1879 return Err(HandleError{err: "Channel not yet available for receiving HTLCs", action: None});
1881 let short_channel_id = chan.get_short_channel_id().unwrap();
1882 if let PendingHTLCStatus::Forward(ref mut forward_info) = pending_forward_info {
1883 forward_info.prev_short_channel_id = short_channel_id;
1885 (short_channel_id, chan.update_add_htlc(&msg, pending_forward_info)?)
1887 None => return Err(HandleError{err: "Failed to find corresponding channel", action: None}),
1891 match claimable_htlcs_entry {
1892 hash_map::Entry::Occupied(mut e) => {
1893 let outbound_route = e.get_mut();
1894 let (route, session_priv) = match outbound_route {
1895 &mut PendingOutboundHTLC::OutboundRoute { ref route, ref session_priv } => {
1896 (route.clone(), session_priv.clone())
1898 _ => unreachable!(),
1900 *outbound_route = PendingOutboundHTLC::CycledRoute {
1901 source_short_channel_id,
1902 incoming_packet_shared_secret: shared_secret.unwrap(),
1907 hash_map::Entry::Vacant(e) => {
1908 e.insert(PendingOutboundHTLC::IntermediaryHopData {
1909 source_short_channel_id,
1910 incoming_packet_shared_secret: shared_secret.unwrap(),
1919 fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), HandleError> {
1920 //TODO: Delay the claimed_funds relaying just like we do outbound relay!
1921 // Claim funds first, cause we don't really care if the channel we received the message on
1922 // is broken, we may have enough info to get our own money!
1923 self.claim_funds_internal(msg.payment_preimage.clone(), false);
1925 let mut channel_state = self.channel_state.lock().unwrap();
1926 match channel_state.by_id.get_mut(&msg.channel_id) {
1928 if chan.get_their_node_id() != *their_node_id {
1929 return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None})
1931 chan.update_fulfill_htlc(&msg)
1933 None => return Err(HandleError{err: "Failed to find corresponding channel", action: None})
1937 fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<Option<msgs::HTLCFailChannelUpdate>, HandleError> {
1938 let mut channel_state = self.channel_state.lock().unwrap();
1939 let payment_hash = match channel_state.by_id.get_mut(&msg.channel_id) {
1941 if chan.get_their_node_id() != *their_node_id {
1942 return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None})
1944 chan.update_fail_htlc(&msg, HTLCFailReason::ErrorPacket { err: msg.reason.clone() })
1946 None => return Err(HandleError{err: "Failed to find corresponding channel", action: None})
1949 if let Some(pending_htlc) = channel_state.claimable_htlcs.get(&payment_hash) {
1950 match pending_htlc {
1951 &PendingOutboundHTLC::OutboundRoute { ref route, ref session_priv } => {
1952 // Handle packed channel/node updates for passing back for the route handler
1953 let mut packet_decrypted = msg.reason.data.clone();
1955 Self::construct_onion_keys_callback(&self.secp_ctx, &route, &session_priv, |shared_secret, _, _, route_hop| {
1956 if res.is_some() { return; }
1958 let ammag = ChannelManager::gen_ammag_from_shared_secret(&shared_secret);
1960 let mut decryption_tmp = Vec::with_capacity(packet_decrypted.len());
1961 decryption_tmp.resize(packet_decrypted.len(), 0);
1962 let mut chacha = ChaCha20::new(&ammag, &[0u8; 8]);
1963 chacha.process(&packet_decrypted, &mut decryption_tmp[..]);
1964 packet_decrypted = decryption_tmp;
1966 if let Ok(err_packet) = msgs::DecodedOnionErrorPacket::decode(&packet_decrypted) {
1967 if err_packet.failuremsg.len() >= 2 {
1968 let um = ChannelManager::gen_um_from_shared_secret(&shared_secret);
1970 let mut hmac = Hmac::new(Sha256::new(), &um);
1971 hmac.input(&err_packet.encode()[32..]);
1972 let mut calc_tag = [0u8; 32];
1973 hmac.raw_result(&mut calc_tag);
1974 if crypto::util::fixed_time_eq(&calc_tag, &err_packet.hmac) {
1975 const UNKNOWN_CHAN: u16 = 0x4000|10;
1976 const TEMP_CHAN_FAILURE: u16 = 0x4000|7;
1977 match byte_utils::slice_to_be16(&err_packet.failuremsg[0..2]) {
1978 TEMP_CHAN_FAILURE => {
1979 if err_packet.failuremsg.len() >= 4 {
1980 let update_len = byte_utils::slice_to_be16(&err_packet.failuremsg[2..4]) as usize;
1981 if err_packet.failuremsg.len() >= 4 + update_len {
1982 if let Ok(chan_update) = msgs::ChannelUpdate::decode(&err_packet.failuremsg[4..4 + update_len]) {
1983 res = Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage {
1991 // No such next-hop. We know this came from the
1992 // current node as the HMAC validated.
1993 res = Some(msgs::HTLCFailChannelUpdate::ChannelClosed {
1994 short_channel_id: route_hop.short_channel_id
1997 _ => {}, //TODO: Enumerate all of these!
2012 fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), HandleError> {
2013 let mut channel_state = self.channel_state.lock().unwrap();
2014 match channel_state.by_id.get_mut(&msg.channel_id) {
2016 if chan.get_their_node_id() != *their_node_id {
2017 return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None})
2019 chan.update_fail_malformed_htlc(&msg, HTLCFailReason::Reason { failure_code: msg.failure_code, data: Vec::new() })
2021 None => return Err(HandleError{err: "Failed to find corresponding channel", action: None})
2025 fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(msgs::RevokeAndACK, Option<msgs::CommitmentSigned>), HandleError> {
2026 let (revoke_and_ack, commitment_signed, chan_monitor) = {
2027 let mut channel_state = self.channel_state.lock().unwrap();
2028 match channel_state.by_id.get_mut(&msg.channel_id) {
2030 if chan.get_their_node_id() != *their_node_id {
2031 return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None})
2033 chan.commitment_signed(&msg)?
2035 None => return Err(HandleError{err: "Failed to find corresponding channel", action: None})
2038 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
2042 Ok((revoke_and_ack, commitment_signed))
2045 fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<Option<msgs::CommitmentUpdate>, HandleError> {
2046 let (res, mut pending_forwards, mut pending_failures, chan_monitor) = {
2047 let mut channel_state = self.channel_state.lock().unwrap();
2048 match channel_state.by_id.get_mut(&msg.channel_id) {
2050 if chan.get_their_node_id() != *their_node_id {
2051 return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None})
2053 chan.revoke_and_ack(&msg)?
2055 None => return Err(HandleError{err: "Failed to find corresponding channel", action: None})
2058 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
2061 for failure in pending_failures.drain(..) {
2062 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), &failure.0, failure.1);
2065 let mut forward_event = None;
2066 if !pending_forwards.is_empty() {
2067 let mut channel_state = self.channel_state.lock().unwrap();
2068 if channel_state.forward_htlcs.is_empty() {
2069 forward_event = Some(Instant::now() + Duration::from_millis(((rng::rand_f32() * 4.0 + 1.0) * MIN_HTLC_RELAY_HOLDING_CELL_MILLIS as f32) as u64));
2070 channel_state.next_forward = forward_event.unwrap();
2072 for forward_info in pending_forwards.drain(..) {
2073 match channel_state.forward_htlcs.entry(forward_info.short_channel_id) {
2074 hash_map::Entry::Occupied(mut entry) => {
2075 entry.get_mut().push(forward_info);
2077 hash_map::Entry::Vacant(entry) => {
2078 entry.insert(vec!(forward_info));
2083 match forward_event {
2085 let mut pending_events = self.pending_events.lock().unwrap();
2086 pending_events.push(events::Event::PendingHTLCsForwardable {
2087 time_forwardable: time
2096 fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), HandleError> {
2097 let mut channel_state = self.channel_state.lock().unwrap();
2098 match channel_state.by_id.get_mut(&msg.channel_id) {
2100 if chan.get_their_node_id() != *their_node_id {
2101 return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None})
2103 chan.update_fee(&*self.fee_estimator, &msg)
2105 None => return Err(HandleError{err: "Failed to find corresponding channel", action: None})
2109 fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), HandleError> {
2110 handle_error!(self, self.internal_announcement_signatures(their_node_id, msg), their_node_id)
2113 fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool) {
2114 let mut new_events = Vec::new();
2115 let mut failed_channels = Vec::new();
2117 let mut channel_state_lock = self.channel_state.lock().unwrap();
2118 let channel_state = channel_state_lock.borrow_parts();
2119 let short_to_id = channel_state.short_to_id;
2120 if no_connection_possible {
2121 channel_state.by_id.retain(|_, chan| {
2122 if chan.get_their_node_id() == *their_node_id {
2123 if let Some(short_id) = chan.get_short_channel_id() {
2124 short_to_id.remove(&short_id);
2126 failed_channels.push(chan.force_shutdown());
2127 if let Ok(update) = self.get_channel_update(&chan) {
2128 new_events.push(events::Event::BroadcastChannelUpdate {
2138 for chan in channel_state.by_id {
2139 if chan.1.get_their_node_id() == *their_node_id {
2140 //TODO: mark channel disabled (and maybe announce such after a timeout). Also
2141 //fail and wipe any uncommitted outbound HTLCs as those are considered after
2147 for failure in failed_channels.drain(..) {
2148 self.finish_force_close_channel(failure);
2150 if !new_events.is_empty() {
2151 let mut pending_events = self.pending_events.lock().unwrap();
2152 for event in new_events.drain(..) {
2153 pending_events.push(event);
2158 fn handle_error(&self, their_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
2159 if msg.channel_id == [0; 32] {
2160 for chan in self.list_channels() {
2161 if chan.remote_network_id == *their_node_id {
2162 self.force_close_channel(&chan.channel_id);
2166 self.force_close_channel(&msg.channel_id);
2173 use chain::chaininterface;
2174 use chain::transaction::OutPoint;
2175 use chain::chaininterface::ChainListener;
2176 use ln::channelmanager::{ChannelManager,OnionKeys};
2177 use ln::router::{Route, RouteHop, Router};
2179 use ln::msgs::{MsgEncodable,ChannelMessageHandler,RoutingMessageHandler};
2180 use util::test_utils;
2181 use util::events::{Event, EventsProvider};
2182 use util::logger::Logger;
2184 use bitcoin::util::hash::Sha256dHash;
2185 use bitcoin::blockdata::block::{Block, BlockHeader};
2186 use bitcoin::blockdata::transaction::{Transaction, TxOut};
2187 use bitcoin::blockdata::constants::genesis_block;
2188 use bitcoin::network::constants::Network;
2189 use bitcoin::network::serialize::serialize;
2190 use bitcoin::network::serialize::BitcoinHash;
2194 use secp256k1::{Secp256k1, Message};
2195 use secp256k1::key::{PublicKey,SecretKey};
2197 use crypto::sha2::Sha256;
2198 use crypto::digest::Digest;
2200 use rand::{thread_rng,Rng};
2202 use std::collections::HashMap;
2203 use std::default::Default;
2204 use std::sync::{Arc, Mutex};
2205 use std::time::Instant;
2208 fn build_test_onion_keys() -> Vec<OnionKeys> {
2209 // Keys from BOLT 4, used in both test vector tests
2210 let secp_ctx = Secp256k1::new();
2215 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("02eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619").unwrap()[..]).unwrap(),
2216 short_channel_id: 0, fee_msat: 0, cltv_expiry_delta: 0 // Test vectors are garbage and not generateble from a RouteHop, we fill in payloads manually
2219 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("0324653eac434488002cc06bbfb7f10fe18991e35f9fe4302dbea6d2353dc0ab1c").unwrap()[..]).unwrap(),
2220 short_channel_id: 0, fee_msat: 0, cltv_expiry_delta: 0 // Test vectors are garbage and not generateble from a RouteHop, we fill in payloads manually
2223 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("027f31ebc5462c1fdce1b737ecff52d37d75dea43ce11c74d25aa297165faa2007").unwrap()[..]).unwrap(),
2224 short_channel_id: 0, fee_msat: 0, cltv_expiry_delta: 0 // Test vectors are garbage and not generateble from a RouteHop, we fill in payloads manually
2227 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]).unwrap(),
2228 short_channel_id: 0, fee_msat: 0, cltv_expiry_delta: 0 // Test vectors are garbage and not generateble from a RouteHop, we fill in payloads manually
2231 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("02edabbd16b41c8371b92ef2f04c1185b4f03b6dcd52ba9b78d9d7c89c8f221145").unwrap()[..]).unwrap(),
2232 short_channel_id: 0, fee_msat: 0, cltv_expiry_delta: 0 // Test vectors are garbage and not generateble from a RouteHop, we fill in payloads manually
2237 let session_priv = SecretKey::from_slice(&secp_ctx, &hex::decode("4141414141414141414141414141414141414141414141414141414141414141").unwrap()[..]).unwrap();
2239 let onion_keys = ChannelManager::construct_onion_keys(&secp_ctx, &route, &session_priv).unwrap();
2240 assert_eq!(onion_keys.len(), route.hops.len());
2245 fn onion_vectors() {
2246 // Packet creation test vectors from BOLT 4
2247 let onion_keys = build_test_onion_keys();
2249 assert_eq!(onion_keys[0].shared_secret[..], hex::decode("53eb63ea8a3fec3b3cd433b85cd62a4b145e1dda09391b348c4e1cd36a03ea66").unwrap()[..]);
2250 assert_eq!(onion_keys[0].blinding_factor[..], hex::decode("2ec2e5da605776054187180343287683aa6a51b4b1c04d6dd49c45d8cffb3c36").unwrap()[..]);
2251 assert_eq!(onion_keys[0].ephemeral_pubkey.serialize()[..], hex::decode("02eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619").unwrap()[..]);
2252 assert_eq!(onion_keys[0].rho, hex::decode("ce496ec94def95aadd4bec15cdb41a740c9f2b62347c4917325fcc6fb0453986").unwrap()[..]);
2253 assert_eq!(onion_keys[0].mu, hex::decode("b57061dc6d0a2b9f261ac410c8b26d64ac5506cbba30267a649c28c179400eba").unwrap()[..]);
2255 assert_eq!(onion_keys[1].shared_secret[..], hex::decode("a6519e98832a0b179f62123b3567c106db99ee37bef036e783263602f3488fae").unwrap()[..]);
2256 assert_eq!(onion_keys[1].blinding_factor[..], hex::decode("bf66c28bc22e598cfd574a1931a2bafbca09163df2261e6d0056b2610dab938f").unwrap()[..]);
2257 assert_eq!(onion_keys[1].ephemeral_pubkey.serialize()[..], hex::decode("028f9438bfbf7feac2e108d677e3a82da596be706cc1cf342b75c7b7e22bf4e6e2").unwrap()[..]);
2258 assert_eq!(onion_keys[1].rho, hex::decode("450ffcabc6449094918ebe13d4f03e433d20a3d28a768203337bc40b6e4b2c59").unwrap()[..]);
2259 assert_eq!(onion_keys[1].mu, hex::decode("05ed2b4a3fb023c2ff5dd6ed4b9b6ea7383f5cfe9d59c11d121ec2c81ca2eea9").unwrap()[..]);
2261 assert_eq!(onion_keys[2].shared_secret[..], hex::decode("3a6b412548762f0dbccce5c7ae7bb8147d1caf9b5471c34120b30bc9c04891cc").unwrap()[..]);
2262 assert_eq!(onion_keys[2].blinding_factor[..], hex::decode("a1f2dadd184eb1627049673f18c6325814384facdee5bfd935d9cb031a1698a5").unwrap()[..]);
2263 assert_eq!(onion_keys[2].ephemeral_pubkey.serialize()[..], hex::decode("03bfd8225241ea71cd0843db7709f4c222f62ff2d4516fd38b39914ab6b83e0da0").unwrap()[..]);
2264 assert_eq!(onion_keys[2].rho, hex::decode("11bf5c4f960239cb37833936aa3d02cea82c0f39fd35f566109c41f9eac8deea").unwrap()[..]);
2265 assert_eq!(onion_keys[2].mu, hex::decode("caafe2820fa00eb2eeb78695ae452eba38f5a53ed6d53518c5c6edf76f3f5b78").unwrap()[..]);
2267 assert_eq!(onion_keys[3].shared_secret[..], hex::decode("21e13c2d7cfe7e18836df50872466117a295783ab8aab0e7ecc8c725503ad02d").unwrap()[..]);
2268 assert_eq!(onion_keys[3].blinding_factor[..], hex::decode("7cfe0b699f35525029ae0fa437c69d0f20f7ed4e3916133f9cacbb13c82ff262").unwrap()[..]);
2269 assert_eq!(onion_keys[3].ephemeral_pubkey.serialize()[..], hex::decode("031dde6926381289671300239ea8e57ffaf9bebd05b9a5b95beaf07af05cd43595").unwrap()[..]);
2270 assert_eq!(onion_keys[3].rho, hex::decode("cbe784ab745c13ff5cffc2fbe3e84424aa0fd669b8ead4ee562901a4a4e89e9e").unwrap()[..]);
2271 assert_eq!(onion_keys[3].mu, hex::decode("5052aa1b3d9f0655a0932e50d42f0c9ba0705142c25d225515c45f47c0036ee9").unwrap()[..]);
2273 assert_eq!(onion_keys[4].shared_secret[..], hex::decode("b5756b9b542727dbafc6765a49488b023a725d631af688fc031217e90770c328").unwrap()[..]);
2274 assert_eq!(onion_keys[4].blinding_factor[..], hex::decode("c96e00dddaf57e7edcd4fb5954be5b65b09f17cb6d20651b4e90315be5779205").unwrap()[..]);
2275 assert_eq!(onion_keys[4].ephemeral_pubkey.serialize()[..], hex::decode("03a214ebd875aab6ddfd77f22c5e7311d7f77f17a169e599f157bbcdae8bf071f4").unwrap()[..]);
2276 assert_eq!(onion_keys[4].rho, hex::decode("034e18b8cc718e8af6339106e706c52d8df89e2b1f7e9142d996acf88df8799b").unwrap()[..]);
2277 assert_eq!(onion_keys[4].mu, hex::decode("8e45e5c61c2b24cb6382444db6698727afb063adecd72aada233d4bf273d975a").unwrap()[..]);
2279 // Test vectors below are flat-out wrong: they claim to set outgoing_cltv_value to non-0 :/
2280 let payloads = vec!(
2281 msgs::OnionHopData {
2283 data: msgs::OnionRealm0HopData {
2284 short_channel_id: 0,
2286 outgoing_cltv_value: 0,
2290 msgs::OnionHopData {
2292 data: msgs::OnionRealm0HopData {
2293 short_channel_id: 0x0101010101010101,
2294 amt_to_forward: 0x0100000001,
2295 outgoing_cltv_value: 0,
2299 msgs::OnionHopData {
2301 data: msgs::OnionRealm0HopData {
2302 short_channel_id: 0x0202020202020202,
2303 amt_to_forward: 0x0200000002,
2304 outgoing_cltv_value: 0,
2308 msgs::OnionHopData {
2310 data: msgs::OnionRealm0HopData {
2311 short_channel_id: 0x0303030303030303,
2312 amt_to_forward: 0x0300000003,
2313 outgoing_cltv_value: 0,
2317 msgs::OnionHopData {
2319 data: msgs::OnionRealm0HopData {
2320 short_channel_id: 0x0404040404040404,
2321 amt_to_forward: 0x0400000004,
2322 outgoing_cltv_value: 0,
2328 let packet = ChannelManager::construct_onion_packet(payloads, onion_keys, &[0x42; 32]).unwrap();
2329 // Just check the final packet encoding, as it includes all the per-hop vectors in it
2331 assert_eq!(packet.encode(), hex::decode("0002eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619e5f14350c2a76fc232b5e46d421e9615471ab9e0bc887beff8c95fdb878f7b3a716a996c7845c93d90e4ecbb9bde4ece2f69425c99e4bc820e44485455f135edc0d10f7d61ab590531cf08000179a333a347f8b4072f216400406bdf3bf038659793d4a1fd7b246979e3150a0a4cb052c9ec69acf0f48c3d39cd55675fe717cb7d80ce721caad69320c3a469a202f1e468c67eaf7a7cd8226d0fd32f7b48084dca885d56047694762b67021713ca673929c163ec36e04e40ca8e1c6d17569419d3039d9a1ec866abe044a9ad635778b961fc0776dc832b3a451bd5d35072d2269cf9b040f6b7a7dad84fb114ed413b1426cb96ceaf83825665ed5a1d002c1687f92465b49ed4c7f0218ff8c6c7dd7221d589c65b3b9aaa71a41484b122846c7c7b57e02e679ea8469b70e14fe4f70fee4d87b910cf144be6fe48eef24da475c0b0bcc6565ae82cd3f4e3b24c76eaa5616c6111343306ab35c1fe5ca4a77c0e314ed7dba39d6f1e0de791719c241a939cc493bea2bae1c1e932679ea94d29084278513c77b899cc98059d06a27d171b0dbdf6bee13ddc4fc17a0c4d2827d488436b57baa167544138ca2e64a11b43ac8a06cd0c2fba2d4d900ed2d9205305e2d7383cc98dacb078133de5f6fb6bed2ef26ba92cea28aafc3b9948dd9ae5559e8bd6920b8cea462aa445ca6a95e0e7ba52961b181c79e73bd581821df2b10173727a810c92b83b5ba4a0403eb710d2ca10689a35bec6c3a708e9e92f7d78ff3c5d9989574b00c6736f84c199256e76e19e78f0c98a9d580b4a658c84fc8f2096c2fbea8f5f8c59d0fdacb3be2802ef802abbecb3aba4acaac69a0e965abd8981e9896b1f6ef9d60f7a164b371af869fd0e48073742825e9434fc54da837e120266d53302954843538ea7c6c3dbfb4ff3b2fdbe244437f2a153ccf7bdb4c92aa08102d4f3cff2ae5ef86fab4653595e6a5837fa2f3e29f27a9cde5966843fb847a4a61f1e76c281fe8bb2b0a181d096100db5a1a5ce7a910238251a43ca556712eaadea167fb4d7d75825e440f3ecd782036d7574df8bceacb397abefc5f5254d2722215c53ff54af8299aaaad642c6d72a14d27882d9bbd539e1cc7a527526ba89b8c037ad09120e98ab042d3e8652b31ae0e478516bfaf88efca9f3676ffe99d2819dcaeb7610a626695f53117665d267d3f7abebd6bbd6733f645c72c389f03855bdf1e4b8075b516569b118233a0f0971d24b83113c0b096f5216a207ca99a7cddc81c130923fe3d91e7508c9ac5f2e914ff5dccab9e558566fa14efb34ac98d878580814b94b73acbfde9072f30b881f7f0fff42d4045d1ace6322d86a97d164aa84d93a60498065cc7c20e636f5862dc81531a88c60305a2e59a985be327a6902e4bed986dbf4a0b50c217af0ea7fdf9ab37f9ea1a1aaa72f54cf40154ea9b269f1a7c09f9f43245109431a175d50e2db0132337baa0ef97eed0fcf20489da36b79a1172faccc2f7ded7c60e00694282d93359c4682135642bc81f433574aa8ef0c97b4ade7ca372c5ffc23c7eddd839bab4e0f14d6df15c9dbeab176bec8b5701cf054eb3072f6dadc98f88819042bf10c407516ee58bce33fbe3b3d86a54255e577db4598e30a135361528c101683a5fcde7e8ba53f3456254be8f45fe3a56120ae96ea3773631fcb3873aa3abd91bcff00bd38bd43697a2e789e00da6077482e7b1b1a677b5afae4c54e6cbdf7377b694eb7d7a5b913476a5be923322d3de06060fd5e819635232a2cf4f0731da13b8546d1d6d4f8d75b9fce6c2341a71b0ea6f780df54bfdb0dd5cd9855179f602f9172307c7268724c3618e6817abd793adc214a0dc0bc616816632f27ea336fb56dfd").unwrap());
2335 fn test_failure_packet_onion() {
2336 // Returning Errors test vectors from BOLT 4
2338 let onion_keys = build_test_onion_keys();
2339 let onion_error = ChannelManager::build_failure_packet(&onion_keys[4].shared_secret, 0x2002, &[0; 0]);
2340 assert_eq!(onion_error.encode(), hex::decode("4c2fc8bc08510334b6833ad9c3e79cd1b52ae59dfe5c2a4b23ead50f09f7ee0b0002200200fe0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap());
2342 let onion_packet_1 = ChannelManager::encrypt_failure_packet(&onion_keys[4].shared_secret, &onion_error.encode()[..]);
2343 assert_eq!(onion_packet_1.data, hex::decode("a5e6bd0c74cb347f10cce367f949098f2457d14c046fd8a22cb96efb30b0fdcda8cb9168b50f2fd45edd73c1b0c8b33002df376801ff58aaa94000bf8a86f92620f343baef38a580102395ae3abf9128d1047a0736ff9b83d456740ebbb4aeb3aa9737f18fb4afb4aa074fb26c4d702f42968888550a3bded8c05247e045b866baef0499f079fdaeef6538f31d44deafffdfd3afa2fb4ca9082b8f1c465371a9894dd8c243fb4847e004f5256b3e90e2edde4c9fb3082ddfe4d1e734cacd96ef0706bf63c9984e22dc98851bcccd1c3494351feb458c9c6af41c0044bea3c47552b1d992ae542b17a2d0bba1a096c78d169034ecb55b6e3a7263c26017f033031228833c1daefc0dedb8cf7c3e37c9c37ebfe42f3225c326e8bcfd338804c145b16e34e4").unwrap());
2345 let onion_packet_2 = ChannelManager::encrypt_failure_packet(&onion_keys[3].shared_secret, &onion_packet_1.data[..]);
2346 assert_eq!(onion_packet_2.data, hex::decode("c49a1ce81680f78f5f2000cda36268de34a3f0a0662f55b4e837c83a8773c22aa081bab1616a0011585323930fa5b9fae0c85770a2279ff59ec427ad1bbff9001c0cd1497004bd2a0f68b50704cf6d6a4bf3c8b6a0833399a24b3456961ba00736785112594f65b6b2d44d9f5ea4e49b5e1ec2af978cbe31c67114440ac51a62081df0ed46d4a3df295da0b0fe25c0115019f03f15ec86fabb4c852f83449e812f141a9395b3f70b766ebbd4ec2fae2b6955bd8f32684c15abfe8fd3a6261e52650e8807a92158d9f1463261a925e4bfba44bd20b166d532f0017185c3a6ac7957adefe45559e3072c8dc35abeba835a8cb01a71a15c736911126f27d46a36168ca5ef7dccd4e2886212602b181463e0dd30185c96348f9743a02aca8ec27c0b90dca270").unwrap());
2348 let onion_packet_3 = ChannelManager::encrypt_failure_packet(&onion_keys[2].shared_secret, &onion_packet_2.data[..]);
2349 assert_eq!(onion_packet_3.data, hex::decode("a5d3e8634cfe78b2307d87c6d90be6fe7855b4f2cc9b1dfb19e92e4b79103f61ff9ac25f412ddfb7466e74f81b3e545563cdd8f5524dae873de61d7bdfccd496af2584930d2b566b4f8d3881f8c043df92224f38cf094cfc09d92655989531524593ec6d6caec1863bdfaa79229b5020acc034cd6deeea1021c50586947b9b8e6faa83b81fbfa6133c0af5d6b07c017f7158fa94f0d206baf12dda6b68f785b773b360fd0497e16cc402d779c8d48d0fa6315536ef0660f3f4e1865f5b38ea49c7da4fd959de4e83ff3ab686f059a45c65ba2af4a6a79166aa0f496bf04d06987b6d2ea205bdb0d347718b9aeff5b61dfff344993a275b79717cd815b6ad4c0beb568c4ac9c36ff1c315ec1119a1993c4b61e6eaa0375e0aaf738ac691abd3263bf937e3").unwrap());
2351 let onion_packet_4 = ChannelManager::encrypt_failure_packet(&onion_keys[1].shared_secret, &onion_packet_3.data[..]);
2352 assert_eq!(onion_packet_4.data, hex::decode("aac3200c4968f56b21f53e5e374e3a2383ad2b1b6501bbcc45abc31e59b26881b7dfadbb56ec8dae8857add94e6702fb4c3a4de22e2e669e1ed926b04447fc73034bb730f4932acd62727b75348a648a1128744657ca6a4e713b9b646c3ca66cac02cdab44dd3439890ef3aaf61708714f7375349b8da541b2548d452d84de7084bb95b3ac2345201d624d31f4d52078aa0fa05a88b4e20202bd2b86ac5b52919ea305a8949de95e935eed0319cf3cf19ebea61d76ba92532497fcdc9411d06bcd4275094d0a4a3c5d3a945e43305a5a9256e333e1f64dbca5fcd4e03a39b9012d197506e06f29339dfee3331995b21615337ae060233d39befea925cc262873e0530408e6990f1cbd233a150ef7b004ff6166c70c68d9f8c853c1abca640b8660db2921").unwrap());
2354 let onion_packet_5 = ChannelManager::encrypt_failure_packet(&onion_keys[0].shared_secret, &onion_packet_4.data[..]);
2355 assert_eq!(onion_packet_5.data, hex::decode("9c5add3963fc7f6ed7f148623c84134b5647e1306419dbe2174e523fa9e2fbed3a06a19f899145610741c83ad40b7712aefaddec8c6baf7325d92ea4ca4d1df8bce517f7e54554608bf2bd8071a4f52a7a2f7ffbb1413edad81eeea5785aa9d990f2865dc23b4bc3c301a94eec4eabebca66be5cf638f693ec256aec514620cc28ee4a94bd9565bc4d4962b9d3641d4278fb319ed2b84de5b665f307a2db0f7fbb757366067d88c50f7e829138fde4f78d39b5b5802f1b92a8a820865af5cc79f9f30bc3f461c66af95d13e5e1f0381c184572a91dee1c849048a647a1158cf884064deddbf1b0b88dfe2f791428d0ba0f6fb2f04e14081f69165ae66d9297c118f0907705c9c4954a199bae0bb96fad763d690e7daa6cfda59ba7f2c8d11448b604d12d").unwrap());
2358 fn confirm_transaction(chain: &chaininterface::ChainWatchInterfaceUtil, tx: &Transaction, chan_id: u32) {
2359 assert!(chain.does_match_tx(tx));
2360 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2361 chain.block_connected_checked(&header, 1, &[tx; 1], &[chan_id; 1]);
2363 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2364 chain.block_connected_checked(&header, i, &[tx; 0], &[0; 0]);
2369 chain_monitor: Arc<chaininterface::ChainWatchInterfaceUtil>,
2370 tx_broadcaster: Arc<test_utils::TestBroadcaster>,
2371 chan_monitor: Arc<test_utils::TestChannelMonitor>,
2372 node: Arc<ChannelManager>,
2376 static mut CHAN_COUNT: u32 = 0;
2377 fn create_chan_between_nodes(node_a: &Node, node_b: &Node) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
2378 node_a.node.create_channel(node_b.node.get_our_node_id(), 100000, 10001, 42).unwrap();
2380 let events_1 = node_a.node.get_and_clear_pending_events();
2381 assert_eq!(events_1.len(), 1);
2382 let accept_chan = match events_1[0] {
2383 Event::SendOpenChannel { ref node_id, ref msg } => {
2384 assert_eq!(*node_id, node_b.node.get_our_node_id());
2385 node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), msg).unwrap()
2387 _ => panic!("Unexpected event"),
2390 node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), &accept_chan).unwrap();
2392 let chan_id = unsafe { CHAN_COUNT };
2396 let events_2 = node_a.node.get_and_clear_pending_events();
2397 assert_eq!(events_2.len(), 1);
2399 Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
2400 assert_eq!(*channel_value_satoshis, 100000);
2401 assert_eq!(user_channel_id, 42);
2403 tx = Transaction { version: chan_id as u32, lock_time: 0, input: Vec::new(), output: vec![TxOut {
2404 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
2406 funding_output = OutPoint::new(Sha256dHash::from_data(&serialize(&tx).unwrap()[..]), 0);
2408 node_a.node.funding_transaction_generated(&temporary_channel_id, funding_output);
2409 let mut added_monitors = node_a.chan_monitor.added_monitors.lock().unwrap();
2410 assert_eq!(added_monitors.len(), 1);
2411 assert_eq!(added_monitors[0].0, funding_output);
2412 added_monitors.clear();
2414 _ => panic!("Unexpected event"),
2417 let events_3 = node_a.node.get_and_clear_pending_events();
2418 assert_eq!(events_3.len(), 1);
2419 let funding_signed = match events_3[0] {
2420 Event::SendFundingCreated { ref node_id, ref msg } => {
2421 assert_eq!(*node_id, node_b.node.get_our_node_id());
2422 let res = node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), msg).unwrap();
2423 let mut added_monitors = node_b.chan_monitor.added_monitors.lock().unwrap();
2424 assert_eq!(added_monitors.len(), 1);
2425 assert_eq!(added_monitors[0].0, funding_output);
2426 added_monitors.clear();
2429 _ => panic!("Unexpected event"),
2432 node_a.node.handle_funding_signed(&node_b.node.get_our_node_id(), &funding_signed).unwrap();
2434 let mut added_monitors = node_a.chan_monitor.added_monitors.lock().unwrap();
2435 assert_eq!(added_monitors.len(), 1);
2436 assert_eq!(added_monitors[0].0, funding_output);
2437 added_monitors.clear();
2440 let events_4 = node_a.node.get_and_clear_pending_events();
2441 assert_eq!(events_4.len(), 1);
2443 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
2444 assert_eq!(user_channel_id, 42);
2445 assert_eq!(*funding_txo, funding_output);
2447 _ => panic!("Unexpected event"),
2450 confirm_transaction(&node_a.chain_monitor, &tx, chan_id);
2451 let events_5 = node_a.node.get_and_clear_pending_events();
2452 assert_eq!(events_5.len(), 1);
2454 Event::SendFundingLocked { ref node_id, ref msg, ref announcement_sigs } => {
2455 assert_eq!(*node_id, node_b.node.get_our_node_id());
2456 assert!(announcement_sigs.is_none());
2457 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), msg).unwrap()
2459 _ => panic!("Unexpected event"),
2464 confirm_transaction(&node_b.chain_monitor, &tx, chan_id);
2465 let events_6 = node_b.node.get_and_clear_pending_events();
2466 assert_eq!(events_6.len(), 1);
2467 let as_announcement_sigs = match events_6[0] {
2468 Event::SendFundingLocked { ref node_id, ref msg, ref announcement_sigs } => {
2469 assert_eq!(*node_id, node_a.node.get_our_node_id());
2470 channel_id = msg.channel_id.clone();
2471 let as_announcement_sigs = node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), msg).unwrap().unwrap();
2472 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &(*announcement_sigs).clone().unwrap()).unwrap();
2473 as_announcement_sigs
2475 _ => panic!("Unexpected event"),
2478 let events_7 = node_a.node.get_and_clear_pending_events();
2479 assert_eq!(events_7.len(), 1);
2480 let (announcement, as_update) = match events_7[0] {
2481 Event::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
2484 _ => panic!("Unexpected event"),
2487 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_announcement_sigs).unwrap();
2488 let events_8 = node_b.node.get_and_clear_pending_events();
2489 assert_eq!(events_8.len(), 1);
2490 let bs_update = match events_8[0] {
2491 Event::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
2492 assert!(*announcement == *msg);
2495 _ => panic!("Unexpected event"),
2502 ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone(), channel_id, tx)
2505 fn create_announced_chan_between_nodes(nodes: &Vec<Node>, a: usize, b: usize) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
2506 let chan_announcement = create_chan_between_nodes(&nodes[a], &nodes[b]);
2508 assert!(node.router.handle_channel_announcement(&chan_announcement.0).unwrap());
2509 node.router.handle_channel_update(&chan_announcement.1).unwrap();
2510 node.router.handle_channel_update(&chan_announcement.2).unwrap();
2512 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
2515 fn close_channel(outbound_node: &Node, inbound_node: &Node, channel_id: &[u8; 32], funding_tx: Transaction, close_inbound_first: bool) -> (msgs::ChannelUpdate, msgs::ChannelUpdate) {
2516 let (node_a, broadcaster_a) = if close_inbound_first { (&inbound_node.node, &inbound_node.tx_broadcaster) } else { (&outbound_node.node, &outbound_node.tx_broadcaster) };
2517 let (node_b, broadcaster_b) = if close_inbound_first { (&outbound_node.node, &outbound_node.tx_broadcaster) } else { (&inbound_node.node, &inbound_node.tx_broadcaster) };
2520 node_a.close_channel(channel_id).unwrap();
2521 let events_1 = node_a.get_and_clear_pending_events();
2522 assert_eq!(events_1.len(), 1);
2523 let shutdown_a = match events_1[0] {
2524 Event::SendShutdown { ref node_id, ref msg } => {
2525 assert_eq!(node_id, &node_b.get_our_node_id());
2528 _ => panic!("Unexpected event"),
2531 let (shutdown_b, mut closing_signed_b) = node_b.handle_shutdown(&node_a.get_our_node_id(), &shutdown_a).unwrap();
2532 if !close_inbound_first {
2533 assert!(closing_signed_b.is_none());
2535 let (empty_a, mut closing_signed_a) = node_a.handle_shutdown(&node_b.get_our_node_id(), &shutdown_b.unwrap()).unwrap();
2536 assert!(empty_a.is_none());
2537 if close_inbound_first {
2538 assert!(closing_signed_a.is_none());
2539 closing_signed_a = node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap()).unwrap();
2540 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
2541 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
2543 let empty_b = node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap()).unwrap();
2544 assert!(empty_b.is_none());
2545 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
2546 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
2548 closing_signed_b = node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap()).unwrap();
2549 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
2550 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
2552 let empty_a2 = node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap()).unwrap();
2553 assert!(empty_a2.is_none());
2554 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
2555 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
2557 assert_eq!(tx_a, tx_b);
2558 let mut funding_tx_map = HashMap::new();
2559 funding_tx_map.insert(funding_tx.txid(), funding_tx);
2560 tx_a.verify(&funding_tx_map).unwrap();
2562 let events_2 = node_a.get_and_clear_pending_events();
2563 assert_eq!(events_2.len(), 1);
2564 let as_update = match events_2[0] {
2565 Event::BroadcastChannelUpdate { ref msg } => {
2568 _ => panic!("Unexpected event"),
2571 let events_3 = node_b.get_and_clear_pending_events();
2572 assert_eq!(events_3.len(), 1);
2573 let bs_update = match events_3[0] {
2574 Event::BroadcastChannelUpdate { ref msg } => {
2577 _ => panic!("Unexpected event"),
2580 (as_update, bs_update)
2585 msgs: Vec<msgs::UpdateAddHTLC>,
2586 commitment_msg: msgs::CommitmentSigned,
2589 fn from_event(event: Event) -> SendEvent {
2591 Event::UpdateHTLCs { node_id, updates: msgs::CommitmentUpdate { update_add_htlcs, update_fulfill_htlcs, update_fail_htlcs, update_fail_malformed_htlcs, commitment_signed } } => {
2592 assert!(update_fulfill_htlcs.is_empty());
2593 assert!(update_fail_htlcs.is_empty());
2594 assert!(update_fail_malformed_htlcs.is_empty());
2595 SendEvent { node_id: node_id, msgs: update_add_htlcs, commitment_msg: commitment_signed }
2597 _ => panic!("Unexpected event type!"),
2602 static mut PAYMENT_COUNT: u8 = 0;
2603 fn send_along_route(origin_node: &Node, route: Route, expected_route: &[&Node], recv_value: u64) -> ([u8; 32], [u8; 32]) {
2604 let our_payment_preimage = unsafe { [PAYMENT_COUNT; 32] };
2605 unsafe { PAYMENT_COUNT += 1 };
2606 let our_payment_hash = {
2607 let mut sha = Sha256::new();
2608 sha.input(&our_payment_preimage[..]);
2609 let mut ret = [0; 32];
2610 sha.result(&mut ret);
2614 let mut payment_event = {
2615 origin_node.node.send_payment(route, our_payment_hash).unwrap();
2617 let mut added_monitors = origin_node.chan_monitor.added_monitors.lock().unwrap();
2618 assert_eq!(added_monitors.len(), 1);
2619 added_monitors.clear();
2622 let mut events = origin_node.node.get_and_clear_pending_events();
2623 assert_eq!(events.len(), 1);
2624 SendEvent::from_event(events.remove(0))
2626 let mut prev_node = origin_node;
2628 for (idx, &node) in expected_route.iter().enumerate() {
2629 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
2631 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
2633 let added_monitors = node.chan_monitor.added_monitors.lock().unwrap();
2634 assert_eq!(added_monitors.len(), 0);
2637 let revoke_and_ack = node.node.handle_commitment_signed(&prev_node.node.get_our_node_id(), &payment_event.commitment_msg).unwrap();
2639 let mut added_monitors = node.chan_monitor.added_monitors.lock().unwrap();
2640 assert_eq!(added_monitors.len(), 1);
2641 added_monitors.clear();
2643 assert!(prev_node.node.handle_revoke_and_ack(&node.node.get_our_node_id(), &revoke_and_ack.0).unwrap().is_none());
2644 let prev_revoke_and_ack = prev_node.node.handle_commitment_signed(&node.node.get_our_node_id(), &revoke_and_ack.1.unwrap()).unwrap();
2646 let mut added_monitors = prev_node.chan_monitor.added_monitors.lock().unwrap();
2647 assert_eq!(added_monitors.len(), 2);
2648 added_monitors.clear();
2650 assert!(node.node.handle_revoke_and_ack(&prev_node.node.get_our_node_id(), &prev_revoke_and_ack.0).unwrap().is_none());
2651 assert!(prev_revoke_and_ack.1.is_none());
2653 let mut added_monitors = node.chan_monitor.added_monitors.lock().unwrap();
2654 assert_eq!(added_monitors.len(), 1);
2655 added_monitors.clear();
2658 let events_1 = node.node.get_and_clear_pending_events();
2659 assert_eq!(events_1.len(), 1);
2661 Event::PendingHTLCsForwardable { .. } => { },
2662 _ => panic!("Unexpected event"),
2665 node.node.channel_state.lock().unwrap().next_forward = Instant::now();
2666 node.node.process_pending_htlc_forwards();
2668 let mut events_2 = node.node.get_and_clear_pending_events();
2669 assert_eq!(events_2.len(), 1);
2670 if idx == expected_route.len() - 1 {
2672 Event::PaymentReceived { ref payment_hash, amt } => {
2673 assert_eq!(our_payment_hash, *payment_hash);
2674 assert_eq!(amt, recv_value);
2676 _ => panic!("Unexpected event"),
2680 let mut added_monitors = node.chan_monitor.added_monitors.lock().unwrap();
2681 assert_eq!(added_monitors.len(), 1);
2682 added_monitors.clear();
2684 payment_event = SendEvent::from_event(events_2.remove(0));
2685 assert_eq!(payment_event.msgs.len(), 1);
2691 (our_payment_preimage, our_payment_hash)
2694 fn claim_payment(origin_node: &Node, expected_route: &[&Node], our_payment_preimage: [u8; 32]) {
2695 assert!(expected_route.last().unwrap().node.claim_funds(our_payment_preimage));
2697 let mut added_monitors = expected_route.last().unwrap().chan_monitor.added_monitors.lock().unwrap();
2698 assert_eq!(added_monitors.len(), 1);
2699 added_monitors.clear();
2702 let mut next_msgs: Option<(msgs::UpdateFulfillHTLC, msgs::CommitmentSigned)> = None;
2703 macro_rules! update_fulfill_dance {
2704 ($node: expr, $prev_node: expr, $last_node: expr) => {
2706 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0).unwrap();
2708 let mut added_monitors = $node.chan_monitor.added_monitors.lock().unwrap();
2710 assert_eq!(added_monitors.len(), 0);
2712 assert_eq!(added_monitors.len(), 1);
2714 added_monitors.clear();
2716 let revoke_and_commit = $node.node.handle_commitment_signed(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().1).unwrap();
2718 let mut added_monitors = $node.chan_monitor.added_monitors.lock().unwrap();
2719 assert_eq!(added_monitors.len(), 1);
2720 added_monitors.clear();
2722 assert!($prev_node.node.handle_revoke_and_ack(&$node.node.get_our_node_id(), &revoke_and_commit.0).unwrap().is_none());
2723 let revoke_and_ack = $prev_node.node.handle_commitment_signed(&$node.node.get_our_node_id(), &revoke_and_commit.1.unwrap()).unwrap();
2724 assert!(revoke_and_ack.1.is_none());
2726 let mut added_monitors = $prev_node.chan_monitor.added_monitors.lock().unwrap();
2727 assert_eq!(added_monitors.len(), 2);
2728 added_monitors.clear();
2730 assert!($node.node.handle_revoke_and_ack(&$prev_node.node.get_our_node_id(), &revoke_and_ack.0).unwrap().is_none());
2732 let mut added_monitors = $node.chan_monitor.added_monitors.lock().unwrap();
2733 assert_eq!(added_monitors.len(), 1);
2734 added_monitors.clear();
2740 let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
2741 let mut prev_node = expected_route.last().unwrap();
2742 for node in expected_route.iter().rev() {
2743 assert_eq!(expected_next_node, node.node.get_our_node_id());
2744 if next_msgs.is_some() {
2745 update_fulfill_dance!(node, prev_node, false);
2748 let events = node.node.get_and_clear_pending_events();
2749 assert_eq!(events.len(), 1);
2751 Event::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, ref commitment_signed } } => {
2752 assert!(update_add_htlcs.is_empty());
2753 assert_eq!(update_fulfill_htlcs.len(), 1);
2754 assert!(update_fail_htlcs.is_empty());
2755 assert!(update_fail_malformed_htlcs.is_empty());
2756 expected_next_node = node_id.clone();
2757 next_msgs = Some((update_fulfill_htlcs[0].clone(), commitment_signed.clone()));
2759 _ => panic!("Unexpected event"),
2765 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2766 update_fulfill_dance!(origin_node, expected_route.first().unwrap(), true);
2768 let events = origin_node.node.get_and_clear_pending_events();
2769 assert_eq!(events.len(), 1);
2771 Event::PaymentSent { payment_preimage } => {
2772 assert_eq!(payment_preimage, our_payment_preimage);
2774 _ => panic!("Unexpected event"),
2778 const TEST_FINAL_CLTV: u32 = 32;
2780 fn route_payment(origin_node: &Node, expected_route: &[&Node], recv_value: u64) -> ([u8; 32], [u8; 32]) {
2781 let route = origin_node.router.get_route(&expected_route.last().unwrap().node.get_our_node_id(), None, &Vec::new(), recv_value, TEST_FINAL_CLTV).unwrap();
2782 assert_eq!(route.hops.len(), expected_route.len());
2783 for (node, hop) in expected_route.iter().zip(route.hops.iter()) {
2784 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2787 send_along_route(origin_node, route, expected_route, recv_value)
2790 fn route_over_limit(origin_node: &Node, expected_route: &[&Node], recv_value: u64) {
2791 let route = origin_node.router.get_route(&expected_route.last().unwrap().node.get_our_node_id(), None, &Vec::new(), recv_value, TEST_FINAL_CLTV).unwrap();
2792 assert_eq!(route.hops.len(), expected_route.len());
2793 for (node, hop) in expected_route.iter().zip(route.hops.iter()) {
2794 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2797 let our_payment_preimage = unsafe { [PAYMENT_COUNT; 32] };
2798 unsafe { PAYMENT_COUNT += 1 };
2799 let our_payment_hash = {
2800 let mut sha = Sha256::new();
2801 sha.input(&our_payment_preimage[..]);
2802 let mut ret = [0; 32];
2803 sha.result(&mut ret);
2807 let err = origin_node.node.send_payment(route, our_payment_hash).err().unwrap();
2808 assert_eq!(err.err, "Cannot send value that would put us over our max HTLC value in flight");
2811 fn send_payment(origin: &Node, expected_route: &[&Node], recv_value: u64) {
2812 let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
2813 claim_payment(&origin, expected_route, our_payment_preimage);
2816 fn fail_payment(origin_node: &Node, expected_route: &[&Node], our_payment_hash: [u8; 32]) {
2817 assert!(expected_route.last().unwrap().node.fail_htlc_backwards(&our_payment_hash));
2819 let mut added_monitors = expected_route.last().unwrap().chan_monitor.added_monitors.lock().unwrap();
2820 assert_eq!(added_monitors.len(), 1);
2821 added_monitors.clear();
2824 let mut next_msgs: Option<(msgs::UpdateFailHTLC, msgs::CommitmentSigned)> = None;
2825 macro_rules! update_fail_dance {
2826 ($node: expr, $prev_node: expr, $last_node: expr) => {
2828 $node.node.handle_update_fail_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0).unwrap();
2829 let revoke_and_commit = $node.node.handle_commitment_signed(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().1).unwrap();
2832 let mut added_monitors = $node.chan_monitor.added_monitors.lock().unwrap();
2833 assert_eq!(added_monitors.len(), 1);
2834 added_monitors.clear();
2836 assert!($prev_node.node.handle_revoke_and_ack(&$node.node.get_our_node_id(), &revoke_and_commit.0).unwrap().is_none());
2838 let mut added_monitors = $prev_node.chan_monitor.added_monitors.lock().unwrap();
2839 assert_eq!(added_monitors.len(), 1);
2840 added_monitors.clear();
2842 let revoke_and_ack = $prev_node.node.handle_commitment_signed(&$node.node.get_our_node_id(), &revoke_and_commit.1.unwrap()).unwrap();
2844 let mut added_monitors = $prev_node.chan_monitor.added_monitors.lock().unwrap();
2845 assert_eq!(added_monitors.len(), 1);
2846 added_monitors.clear();
2848 assert!(revoke_and_ack.1.is_none());
2849 assert!($node.node.get_and_clear_pending_events().is_empty());
2850 assert!($node.node.handle_revoke_and_ack(&$prev_node.node.get_our_node_id(), &revoke_and_ack.0).unwrap().is_none());
2852 let mut added_monitors = $node.chan_monitor.added_monitors.lock().unwrap();
2854 assert_eq!(added_monitors.len(), 1);
2856 assert_eq!(added_monitors.len(), 2);
2857 assert!(added_monitors[0].0 != added_monitors[1].0);
2859 added_monitors.clear();
2865 let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
2866 let mut prev_node = expected_route.last().unwrap();
2867 for node in expected_route.iter().rev() {
2868 assert_eq!(expected_next_node, node.node.get_our_node_id());
2869 if next_msgs.is_some() {
2870 update_fail_dance!(node, prev_node, false);
2873 let events = node.node.get_and_clear_pending_events();
2874 assert_eq!(events.len(), 1);
2876 Event::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, ref commitment_signed } } => {
2877 assert!(update_add_htlcs.is_empty());
2878 assert!(update_fulfill_htlcs.is_empty());
2879 assert_eq!(update_fail_htlcs.len(), 1);
2880 assert!(update_fail_malformed_htlcs.is_empty());
2881 expected_next_node = node_id.clone();
2882 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
2884 _ => panic!("Unexpected event"),
2890 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2891 update_fail_dance!(origin_node, expected_route.first().unwrap(), true);
2893 let events = origin_node.node.get_and_clear_pending_events();
2894 assert_eq!(events.len(), 1);
2896 Event::PaymentFailed { payment_hash } => {
2897 assert_eq!(payment_hash, our_payment_hash);
2899 _ => panic!("Unexpected event"),
2903 fn create_network(node_count: usize) -> Vec<Node> {
2904 let mut nodes = Vec::new();
2905 let mut rng = thread_rng();
2906 let secp_ctx = Secp256k1::new();
2907 let logger: Arc<Logger> = Arc::new(test_utils::TestLogger::new());
2909 for _ in 0..node_count {
2910 let feeest = Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 });
2911 let chain_monitor = Arc::new(chaininterface::ChainWatchInterfaceUtil::new(Network::Testnet, Arc::clone(&logger)));
2912 let tx_broadcaster = Arc::new(test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())});
2913 let chan_monitor = Arc::new(test_utils::TestChannelMonitor::new(chain_monitor.clone(), tx_broadcaster.clone()));
2915 let mut key_slice = [0; 32];
2916 rng.fill_bytes(&mut key_slice);
2917 SecretKey::from_slice(&secp_ctx, &key_slice).unwrap()
2919 let node = ChannelManager::new(node_id.clone(), 0, true, Network::Testnet, feeest.clone(), chan_monitor.clone(), chain_monitor.clone(), tx_broadcaster.clone(), Arc::clone(&logger)).unwrap();
2920 let router = Router::new(PublicKey::from_secret_key(&secp_ctx, &node_id), chain_monitor.clone(), Arc::clone(&logger));
2921 nodes.push(Node { chain_monitor, tx_broadcaster, chan_monitor, node, router });
2928 fn fake_network_test() {
2929 // Simple test which builds a network of ChannelManagers, connects them to each other, and
2930 // tests that payments get routed and transactions broadcast in semi-reasonable ways.
2931 let nodes = create_network(4);
2933 // Create some initial channels
2934 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
2935 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
2936 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3);
2938 // Rebalance the network a bit by relaying one payment through all the channels...
2939 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
2940 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
2941 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
2942 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
2944 // Send some more payments
2945 send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000);
2946 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000);
2947 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000);
2949 // Test failure packets
2950 let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
2951 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
2953 // Add a new channel that skips 3
2954 let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3);
2956 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000);
2957 send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000);
2958 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
2959 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
2960 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
2961 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
2962 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
2964 // Do some rebalance loop payments, simultaneously
2965 let mut hops = Vec::with_capacity(3);
2966 hops.push(RouteHop {
2967 pubkey: nodes[2].node.get_our_node_id(),
2968 short_channel_id: chan_2.0.contents.short_channel_id,
2970 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
2972 hops.push(RouteHop {
2973 pubkey: nodes[3].node.get_our_node_id(),
2974 short_channel_id: chan_3.0.contents.short_channel_id,
2976 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
2978 hops.push(RouteHop {
2979 pubkey: nodes[1].node.get_our_node_id(),
2980 short_channel_id: chan_4.0.contents.short_channel_id,
2982 cltv_expiry_delta: TEST_FINAL_CLTV,
2984 hops[1].fee_msat = chan_4.1.contents.fee_base_msat as u64 + chan_4.1.contents.fee_proportional_millionths as u64 * hops[2].fee_msat as u64 / 1000000;
2985 hops[0].fee_msat = chan_3.0.contents.fee_base_msat as u64 + chan_3.0.contents.fee_proportional_millionths as u64 * hops[1].fee_msat as u64 / 1000000;
2986 let payment_preimage_1 = send_along_route(&nodes[1], Route { hops }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
2988 let mut hops = Vec::with_capacity(3);
2989 hops.push(RouteHop {
2990 pubkey: nodes[3].node.get_our_node_id(),
2991 short_channel_id: chan_4.0.contents.short_channel_id,
2993 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
2995 hops.push(RouteHop {
2996 pubkey: nodes[2].node.get_our_node_id(),
2997 short_channel_id: chan_3.0.contents.short_channel_id,
2999 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
3001 hops.push(RouteHop {
3002 pubkey: nodes[1].node.get_our_node_id(),
3003 short_channel_id: chan_2.0.contents.short_channel_id,
3005 cltv_expiry_delta: TEST_FINAL_CLTV,
3007 hops[1].fee_msat = chan_2.1.contents.fee_base_msat as u64 + chan_2.1.contents.fee_proportional_millionths as u64 * hops[2].fee_msat as u64 / 1000000;
3008 hops[0].fee_msat = chan_3.1.contents.fee_base_msat as u64 + chan_3.1.contents.fee_proportional_millionths as u64 * hops[1].fee_msat as u64 / 1000000;
3009 let payment_hash_2 = send_along_route(&nodes[1], Route { hops }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
3011 // Claim the rebalances...
3012 fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
3013 claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1);
3015 // Add a duplicate new channel from 2 to 4
3016 let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3);
3018 // Send some payments across both channels
3019 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
3020 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
3021 let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
3023 route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
3025 //TODO: Test that routes work again here as we've been notified that the channel is full
3027 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3);
3028 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4);
3029 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5);
3031 // Close down the channels...
3032 close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
3033 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
3034 close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
3035 close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
3036 close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
3038 // Check that we processed all pending events
3040 assert_eq!(node.node.get_and_clear_pending_events().len(), 0);
3041 assert_eq!(node.chan_monitor.added_monitors.lock().unwrap().len(), 0);
3045 #[derive(PartialEq)]
3046 enum HTLCType { NONE, TIMEOUT, SUCCESS }
3047 fn test_txn_broadcast(node: &Node, chan: &(msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction), commitment_tx: Option<Transaction>, has_htlc_tx: HTLCType) -> Vec<Transaction> {
3048 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
3049 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
3051 let mut res = Vec::with_capacity(2);
3053 if let Some(explicit_tx) = commitment_tx {
3054 res.push(explicit_tx.clone());
3056 for tx in node_txn.iter() {
3057 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
3058 let mut funding_tx_map = HashMap::new();
3059 funding_tx_map.insert(chan.3.txid(), chan.3.clone());
3060 tx.verify(&funding_tx_map).unwrap();
3061 res.push(tx.clone());
3065 assert_eq!(res.len(), 1);
3067 if has_htlc_tx != HTLCType::NONE {
3068 for tx in node_txn.iter() {
3069 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
3070 let mut funding_tx_map = HashMap::new();
3071 funding_tx_map.insert(res[0].txid(), res[0].clone());
3072 tx.verify(&funding_tx_map).unwrap();
3073 if has_htlc_tx == HTLCType::TIMEOUT {
3074 assert!(tx.lock_time != 0);
3076 assert!(tx.lock_time == 0);
3078 res.push(tx.clone());
3082 assert_eq!(res.len(), 2);
3088 fn check_preimage_claim(node: &Node, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
3089 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
3091 assert!(node_txn.len() >= 1);
3092 assert_eq!(node_txn[0].input.len(), 1);
3093 let mut found_prev = false;
3095 for tx in prev_txn {
3096 if node_txn[0].input[0].previous_output.txid == tx.txid() {
3097 let mut funding_tx_map = HashMap::new();
3098 funding_tx_map.insert(tx.txid(), tx.clone());
3099 node_txn[0].verify(&funding_tx_map).unwrap();
3101 assert!(node_txn[0].input[0].witness[2].len() > 106); // must spend an htlc output
3102 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
3108 assert!(found_prev);
3110 let mut res = Vec::new();
3111 mem::swap(&mut *node_txn, &mut res);
3115 fn get_announce_close_broadcast_events(nodes: &Vec<Node>, a: usize, b: usize) {
3116 let events_1 = nodes[a].node.get_and_clear_pending_events();
3117 assert_eq!(events_1.len(), 1);
3118 let as_update = match events_1[0] {
3119 Event::BroadcastChannelUpdate { ref msg } => {
3122 _ => panic!("Unexpected event"),
3125 let events_2 = nodes[b].node.get_and_clear_pending_events();
3126 assert_eq!(events_2.len(), 1);
3127 let bs_update = match events_2[0] {
3128 Event::BroadcastChannelUpdate { ref msg } => {
3131 _ => panic!("Unexpected event"),
3135 node.router.handle_channel_update(&as_update).unwrap();
3136 node.router.handle_channel_update(&bs_update).unwrap();
3141 fn channel_monitor_network_test() {
3142 // Simple test which builds a network of ChannelManagers, connects them to each other, and
3143 // tests that ChannelMonitor is able to recover from various states.
3144 let nodes = create_network(5);
3146 // Create some initial channels
3147 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
3148 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
3149 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3);
3150 let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4);
3152 // Rebalance the network a bit by relaying one payment through all the channels...
3153 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
3154 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
3155 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
3156 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
3158 // Simple case with no pending HTLCs:
3159 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
3161 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
3162 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3163 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
3164 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
3166 get_announce_close_broadcast_events(&nodes, 0, 1);
3167 assert_eq!(nodes[0].node.list_channels().len(), 0);
3168 assert_eq!(nodes[1].node.list_channels().len(), 1);
3170 // One pending HTLC is discarded by the force-close:
3171 let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
3173 // Simple case of one pending HTLC to HTLC-Timeout
3174 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
3176 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
3177 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3178 nodes[2].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
3179 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
3181 get_announce_close_broadcast_events(&nodes, 1, 2);
3182 assert_eq!(nodes[1].node.list_channels().len(), 0);
3183 assert_eq!(nodes[2].node.list_channels().len(), 1);
3185 macro_rules! claim_funds {
3186 ($node: expr, $prev_node: expr, $preimage: expr) => {
3188 assert!($node.node.claim_funds($preimage));
3190 let mut added_monitors = $node.chan_monitor.added_monitors.lock().unwrap();
3191 assert_eq!(added_monitors.len(), 1);
3192 added_monitors.clear();
3195 let events = $node.node.get_and_clear_pending_events();
3196 assert_eq!(events.len(), 1);
3198 Event::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
3199 assert!(update_add_htlcs.is_empty());
3200 assert!(update_fail_htlcs.is_empty());
3201 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
3203 _ => panic!("Unexpected event"),
3209 // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
3210 // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
3211 nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
3213 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
3215 // Claim the payment on nodes[3], giving it knowledge of the preimage
3216 claim_funds!(nodes[3], nodes[2], payment_preimage_1);
3218 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3219 nodes[3].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[0].clone()] }, 1);
3221 check_preimage_claim(&nodes[3], &node_txn);
3223 get_announce_close_broadcast_events(&nodes, 2, 3);
3224 assert_eq!(nodes[2].node.list_channels().len(), 0);
3225 assert_eq!(nodes[3].node.list_channels().len(), 1);
3227 // One pending HTLC to time out:
3228 let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
3231 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3232 nodes[3].chain_monitor.block_connected_checked(&header, 1, &Vec::new()[..], &[0; 0]);
3233 for i in 2..TEST_FINAL_CLTV - 3 {
3234 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3235 nodes[3].chain_monitor.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
3238 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
3240 // Claim the payment on nodes[3], giving it knowledge of the preimage
3241 claim_funds!(nodes[4], nodes[3], payment_preimage_2);
3243 header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3244 nodes[4].chain_monitor.block_connected_checked(&header, 1, &Vec::new()[..], &[0; 0]);
3245 for i in 2..TEST_FINAL_CLTV - 3 {
3246 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3247 nodes[4].chain_monitor.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
3250 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
3252 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3253 nodes[4].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[0].clone()] }, TEST_FINAL_CLTV - 5);
3255 check_preimage_claim(&nodes[4], &node_txn);
3257 get_announce_close_broadcast_events(&nodes, 3, 4);
3258 assert_eq!(nodes[3].node.list_channels().len(), 0);
3259 assert_eq!(nodes[4].node.list_channels().len(), 0);
3261 // Create some new channels:
3262 let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1);
3264 // A pending HTLC which will be revoked:
3265 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
3266 // Get the will-be-revoked local txn from nodes[0]
3267 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.iter().next().unwrap().1.last_local_commitment_txn.clone();
3268 // Revoke the old state
3269 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
3272 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3273 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3275 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3276 assert_eq!(node_txn.len(), 2);
3277 assert_eq!(node_txn[0].input.len(), 1);
3279 let mut funding_tx_map = HashMap::new();
3280 funding_tx_map.insert(revoked_local_txn[0].txid(), revoked_local_txn[0].clone());
3281 node_txn[0].verify(&funding_tx_map).unwrap();
3282 node_txn.swap_remove(0);
3284 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
3286 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3287 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
3288 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3289 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
3291 //TODO: At this point nodes[1] should claim the revoked HTLC-Timeout output, but that's
3292 //not yet implemented in ChannelMonitor
3294 get_announce_close_broadcast_events(&nodes, 0, 1);
3295 assert_eq!(nodes[0].node.list_channels().len(), 0);
3296 assert_eq!(nodes[1].node.list_channels().len(), 0);
3298 // Check that we processed all pending events
3300 assert_eq!(node.node.get_and_clear_pending_events().len(), 0);
3301 assert_eq!(node.chan_monitor.added_monitors.lock().unwrap().len(), 0);
3306 fn test_unconf_chan() {
3307 // After creating a chan between nodes, we disconnect all blocks previously seen to force a channel close on nodes[0] side
3308 let nodes = create_network(2);
3309 create_announced_chan_between_nodes(&nodes, 0, 1);
3311 let channel_state = nodes[0].node.channel_state.lock().unwrap();
3312 assert_eq!(channel_state.by_id.len(), 1);
3313 assert_eq!(channel_state.short_to_id.len(), 1);
3314 mem::drop(channel_state);
3316 let mut headers = Vec::new();
3317 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3318 headers.push(header.clone());
3320 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3321 headers.push(header.clone());
3323 while !headers.is_empty() {
3324 nodes[0].node.block_disconnected(&headers.pop().unwrap());
3326 let channel_state = nodes[0].node.channel_state.lock().unwrap();
3327 assert_eq!(channel_state.by_id.len(), 0);
3328 assert_eq!(channel_state.short_to_id.len(), 0);
3332 fn test_invalid_channel_announcement() {
3333 //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
3334 let secp_ctx = Secp256k1::new();
3335 let nodes = create_network(2);
3337 let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1]);
3339 let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
3340 let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
3341 let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
3342 let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
3344 let _ = nodes[0].router.handle_htlc_fail_channel_update(&msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id : as_chan.get_short_channel_id().unwrap() } );
3346 let as_bitcoin_key = PublicKey::from_secret_key(&secp_ctx, &as_chan.get_local_keys().funding_key);
3347 let bs_bitcoin_key = PublicKey::from_secret_key(&secp_ctx, &bs_chan.get_local_keys().funding_key);
3349 let as_network_key = nodes[0].node.get_our_node_id();
3350 let bs_network_key = nodes[1].node.get_our_node_id();
3352 let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
3354 let mut chan_announcement;
3356 macro_rules! dummy_unsigned_msg {
3358 msgs::UnsignedChannelAnnouncement {
3359 features: msgs::GlobalFeatures::new(),
3360 chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
3361 short_channel_id: as_chan.get_short_channel_id().unwrap(),
3362 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
3363 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
3364 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
3365 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
3366 excess_data: Vec::new(),
3371 macro_rules! sign_msg {
3372 ($unsigned_msg: expr) => {
3373 let msghash = Message::from_slice(&Sha256dHash::from_data(&$unsigned_msg.encode()[..])[..]).unwrap();
3374 let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_local_keys().funding_key);
3375 let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_local_keys().funding_key);
3376 let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].node.our_network_key);
3377 let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].node.our_network_key);
3378 chan_announcement = msgs::ChannelAnnouncement {
3379 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
3380 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
3381 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
3382 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
3383 contents: $unsigned_msg
3388 let unsigned_msg = dummy_unsigned_msg!();
3389 sign_msg!(unsigned_msg);
3390 assert_eq!(nodes[0].router.handle_channel_announcement(&chan_announcement).unwrap(), true);
3391 let _ = nodes[0].router.handle_htlc_fail_channel_update(&msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id : as_chan.get_short_channel_id().unwrap() } );
3393 // Configured with Network::Testnet
3394 let mut unsigned_msg = dummy_unsigned_msg!();
3395 unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.bitcoin_hash();
3396 sign_msg!(unsigned_msg);
3397 assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
3399 let mut unsigned_msg = dummy_unsigned_msg!();
3400 unsigned_msg.chain_hash = Sha256dHash::from_data(&[1,2,3,4,5,6,7,8,9]);
3401 sign_msg!(unsigned_msg);
3402 assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());