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 pub struct PendingForwardHTLCInfo {
44 pub(super) onion_packet: Option<msgs::OnionPacket>,
45 pub(super) payment_hash: [u8; 32],
46 pub(super) short_channel_id: u64,
47 pub(super) prev_short_channel_id: u64,
48 pub(super) amt_to_forward: u64,
49 pub(super) outgoing_cltv_value: u32,
52 #[cfg(feature = "fuzztarget")]
53 impl PendingForwardHTLCInfo {
54 pub fn dummy() -> Self {
57 payment_hash: [0; 32],
59 prev_short_channel_id: 0,
61 outgoing_cltv_value: 0,
66 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
67 pub enum HTLCFailReason {
69 err: msgs::OnionErrorPacket,
77 #[cfg(feature = "fuzztarget")]
79 pub fn dummy() -> Self {
80 HTLCFailReason::Reason {
81 failure_code: 0, data: Vec::new(),
86 #[cfg(feature = "fuzztarget")]
87 pub use self::channel_held_info::*;
88 #[cfg(not(feature = "fuzztarget"))]
89 pub(crate) use self::channel_held_info::*;
91 enum PendingOutboundHTLC {
93 source_short_channel_id: u64,
94 incoming_packet_shared_secret: SharedSecret,
98 session_priv: SecretKey,
100 /// Used for channel rebalancing
102 source_short_channel_id: u64,
103 incoming_packet_shared_secret: SharedSecret,
105 session_priv: SecretKey,
109 /// We hold back HTLCs we intend to relay for a random interval in the range (this, 5*this). This
110 /// provides some limited amount of privacy. Ideally this would range from somewhere like 1 second
111 /// to 30 seconds, but people expect lightning to be, you know, kinda fast, sadly. We could
112 /// probably increase this significantly.
113 const MIN_HTLC_RELAY_HOLDING_CELL_MILLIS: u32 = 50;
115 struct ChannelHolder {
116 by_id: HashMap<[u8; 32], Channel>,
117 short_to_id: HashMap<u64, [u8; 32]>,
118 next_forward: Instant,
119 /// short channel id -> forward infos. Key of 0 means payments received
120 /// Note that while this is held in the same mutex as the channels themselves, no consistency
121 /// guarantees are made about there existing a channel with the short id here, nor the short
122 /// ids in the PendingForwardHTLCInfo!
123 forward_htlcs: HashMap<u64, Vec<PendingForwardHTLCInfo>>,
124 /// Note that while this is held in the same mutex as the channels themselves, no consistency
125 /// guarantees are made about the channels given here actually existing anymore by the time you
127 claimable_htlcs: HashMap<[u8; 32], PendingOutboundHTLC>,
129 struct MutChannelHolder<'a> {
130 by_id: &'a mut HashMap<[u8; 32], Channel>,
131 short_to_id: &'a mut HashMap<u64, [u8; 32]>,
132 next_forward: &'a mut Instant,
133 forward_htlcs: &'a mut HashMap<u64, Vec<PendingForwardHTLCInfo>>,
134 claimable_htlcs: &'a mut HashMap<[u8; 32], PendingOutboundHTLC>,
137 fn borrow_parts(&mut self) -> MutChannelHolder {
139 by_id: &mut self.by_id,
140 short_to_id: &mut self.short_to_id,
141 next_forward: &mut self.next_forward,
142 forward_htlcs: &mut self.forward_htlcs,
143 claimable_htlcs: &mut self.claimable_htlcs,
148 #[cfg(not(any(target_pointer_width = "32", target_pointer_width = "64")))]
149 const ERR: () = "You need at least 32 bit pointers (well, usize, but we'll assume they're the same) for ChannelManager::latest_block_height";
151 /// Manager which keeps track of a number of channels and sends messages to the appropriate
152 /// channel, also tracking HTLC preimages and forwarding onion packets appropriately.
153 /// Implements ChannelMessageHandler, handling the multi-channel parts and passing things through
154 /// to individual Channels.
155 pub struct ChannelManager {
156 genesis_hash: Sha256dHash,
157 fee_estimator: Arc<FeeEstimator>,
158 monitor: Arc<ManyChannelMonitor>,
159 chain_monitor: Arc<ChainWatchInterface>,
160 tx_broadcaster: Arc<BroadcasterInterface>,
162 announce_channels_publicly: bool,
163 fee_proportional_millionths: u32,
164 latest_block_height: AtomicUsize,
167 channel_state: Mutex<ChannelHolder>,
168 our_network_key: SecretKey,
170 pending_events: Mutex<Vec<events::Event>>,
175 const CLTV_EXPIRY_DELTA: u16 = 6 * 24 * 2; //TODO?
177 macro_rules! secp_call {
181 //TODO: Make the err a parameter!
182 Err(_) => return Err(HandleError{err: "Key error", action: None})
189 shared_secret: SharedSecret,
191 blinding_factor: [u8; 32],
192 ephemeral_pubkey: PublicKey,
197 pub struct ChannelDetails {
198 /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
199 /// thereafter this is the txid of the funding transaction xor the funding transaction output).
200 /// Note that this means this value is *not* persistent - it can change once during the
201 /// lifetime of the channel.
202 pub channel_id: [u8; 32],
203 /// The position of the funding transaction in the chain. None if the funding transaction has
204 /// not yet been confirmed and the channel fully opened.
205 pub short_channel_id: Option<u64>,
206 pub remote_network_id: PublicKey,
207 pub channel_value_satoshis: u64,
208 /// The user_id passed in to create_channel, or 0 if the channel was inbound.
212 impl ChannelManager {
213 /// Constructs a new ChannelManager to hold several channels and route between them. This is
214 /// the main "logic hub" for all channel-related actions, and implements ChannelMessageHandler.
215 /// fee_proportional_millionths is an optional fee to charge any payments routed through us.
216 /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
217 /// panics if channel_value_satoshis is >= `MAX_FUNDING_SATOSHIS`!
218 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> {
219 let secp_ctx = Secp256k1::new();
221 let res = Arc::new(ChannelManager {
222 genesis_hash: genesis_block(network).header.bitcoin_hash(),
223 fee_estimator: feeest.clone(),
224 monitor: monitor.clone(),
228 announce_channels_publicly,
229 fee_proportional_millionths,
230 latest_block_height: AtomicUsize::new(0), //TODO: Get an init value (generally need to replay recent chain on chain_monitor registration)
233 channel_state: Mutex::new(ChannelHolder{
234 by_id: HashMap::new(),
235 short_to_id: HashMap::new(),
236 next_forward: Instant::now(),
237 forward_htlcs: HashMap::new(),
238 claimable_htlcs: HashMap::new(),
242 pending_events: Mutex::new(Vec::new()),
246 let weak_res = Arc::downgrade(&res);
247 res.chain_monitor.register_listener(weak_res);
251 /// Creates a new outbound channel to the given remote node and with the given value.
252 /// user_id will be provided back as user_channel_id in FundingGenerationReady and
253 /// FundingBroadcastSafe events to allow tracking of which events correspond with which
254 /// create_channel call. Note that user_channel_id defaults to 0 for inbound channels, so you
255 /// may wish to avoid using 0 for user_id here.
256 /// If successful, will generate a SendOpenChannel event, so you should probably poll
257 /// PeerManager::process_events afterwards.
258 /// Raises APIError::APIMisuseError when channel_value_satoshis > 2**24 or push_msat being greater than channel_value_satoshis * 1k
259 pub fn create_channel(&self, their_network_key: PublicKey, channel_value_satoshis: u64, push_msat: u64, user_id: u64) -> Result<(), APIError> {
260 let chan_keys = if cfg!(feature = "fuzztarget") {
262 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(),
263 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(),
264 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(),
265 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(),
266 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(),
267 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(),
268 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(),
269 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],
272 let mut key_seed = [0u8; 32];
273 rng::fill_bytes(&mut key_seed);
274 match ChannelKeys::new_from_seed(&key_seed) {
276 Err(_) => panic!("RNG is busted!")
280 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))?;
281 let res = channel.get_open_channel(self.genesis_hash.clone(), &*self.fee_estimator)?;
282 let mut channel_state = self.channel_state.lock().unwrap();
283 match channel_state.by_id.insert(channel.channel_id(), channel) {
284 Some(_) => panic!("RNG is bad???"),
288 let mut events = self.pending_events.lock().unwrap();
289 events.push(events::Event::SendOpenChannel {
290 node_id: their_network_key,
296 /// Gets the list of open channels, in random order. See ChannelDetail field documentation for
297 /// more information.
298 pub fn list_channels(&self) -> Vec<ChannelDetails> {
299 let channel_state = self.channel_state.lock().unwrap();
300 let mut res = Vec::with_capacity(channel_state.by_id.len());
301 for (channel_id, channel) in channel_state.by_id.iter() {
302 res.push(ChannelDetails {
303 channel_id: (*channel_id).clone(),
304 short_channel_id: channel.get_short_channel_id(),
305 remote_network_id: channel.get_their_node_id(),
306 channel_value_satoshis: channel.get_value_satoshis(),
307 user_id: channel.get_user_id(),
313 /// Gets the list of usable channels, in random order. Useful as an argument to
314 /// Router::get_route to ensure non-announced channels are used.
315 pub fn list_usable_channels(&self) -> Vec<ChannelDetails> {
316 let channel_state = self.channel_state.lock().unwrap();
317 let mut res = Vec::with_capacity(channel_state.by_id.len());
318 for (channel_id, channel) in channel_state.by_id.iter() {
319 if channel.is_usable() {
320 res.push(ChannelDetails {
321 channel_id: (*channel_id).clone(),
322 short_channel_id: channel.get_short_channel_id(),
323 remote_network_id: channel.get_their_node_id(),
324 channel_value_satoshis: channel.get_value_satoshis(),
325 user_id: channel.get_user_id(),
332 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
333 /// will be accepted on the given channel, and after additional timeout/the closing of all
334 /// pending HTLCs, the channel will be closed on chain.
335 /// May generate a SendShutdown event on success, which should be relayed.
336 pub fn close_channel(&self, channel_id: &[u8; 32]) -> Result<(), HandleError> {
337 let (res, node_id, chan_option) = {
338 let mut channel_state_lock = self.channel_state.lock().unwrap();
339 let channel_state = channel_state_lock.borrow_parts();
340 match channel_state.by_id.entry(channel_id.clone()) {
341 hash_map::Entry::Occupied(mut chan_entry) => {
342 let res = chan_entry.get_mut().get_shutdown()?;
343 if chan_entry.get().is_shutdown() {
344 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
345 channel_state.short_to_id.remove(&short_id);
347 (res, chan_entry.get().get_their_node_id(), Some(chan_entry.remove_entry().1))
348 } else { (res, chan_entry.get().get_their_node_id(), None) }
350 hash_map::Entry::Vacant(_) => return Err(HandleError{err: "No such channel", action: None})
353 for payment_hash in res.1 {
354 // unknown_next_peer...I dunno who that is anymore....
355 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), &payment_hash, HTLCFailReason::Reason { failure_code: 0x4000 | 10, data: Vec::new() });
357 let chan_update = if let Some(chan) = chan_option {
358 if let Ok(update) = self.get_channel_update(&chan) {
363 let mut events = self.pending_events.lock().unwrap();
364 if let Some(update) = chan_update {
365 events.push(events::Event::BroadcastChannelUpdate {
369 events.push(events::Event::SendShutdown {
378 fn finish_force_close_channel(&self, shutdown_res: (Vec<Transaction>, Vec<[u8; 32]>)) {
379 let (local_txn, failed_htlcs) = shutdown_res;
380 for payment_hash in failed_htlcs {
381 // unknown_next_peer...I dunno who that is anymore....
382 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), &payment_hash, HTLCFailReason::Reason { failure_code: 0x4000 | 10, data: Vec::new() });
384 for tx in local_txn {
385 self.tx_broadcaster.broadcast_transaction(&tx);
387 //TODO: We need to have a way where outbound HTLC claims can result in us claiming the
388 //now-on-chain HTLC output for ourselves (and, thereafter, passing the HTLC backwards).
389 //TODO: We need to handle monitoring of pending offered HTLCs which just hit the chain and
390 //may be claimed, resulting in us claiming the inbound HTLCs (and back-failing after
391 //timeouts are hit and our claims confirm).
394 /// Force closes a channel, immediately broadcasting the latest local commitment transaction to
395 /// the chain and rejecting new HTLCs on the given channel.
396 pub fn force_close_channel(&self, channel_id: &[u8; 32]) {
398 let mut channel_state_lock = self.channel_state.lock().unwrap();
399 let channel_state = channel_state_lock.borrow_parts();
400 if let Some(chan) = channel_state.by_id.remove(channel_id) {
401 if let Some(short_id) = chan.get_short_channel_id() {
402 channel_state.short_to_id.remove(&short_id);
409 self.finish_force_close_channel(chan.force_shutdown());
410 let mut events = self.pending_events.lock().unwrap();
411 if let Ok(update) = self.get_channel_update(&chan) {
412 events.push(events::Event::BroadcastChannelUpdate {
419 fn gen_rho_mu_from_shared_secret(shared_secret: &SharedSecret) -> ([u8; 32], [u8; 32]) {
421 let mut hmac = Hmac::new(Sha256::new(), &[0x72, 0x68, 0x6f]); // rho
422 hmac.input(&shared_secret[..]);
423 let mut res = [0; 32];
424 hmac.raw_result(&mut res);
428 let mut hmac = Hmac::new(Sha256::new(), &[0x6d, 0x75]); // mu
429 hmac.input(&shared_secret[..]);
430 let mut res = [0; 32];
431 hmac.raw_result(&mut res);
437 fn gen_um_from_shared_secret(shared_secret: &SharedSecret) -> [u8; 32] {
438 let mut hmac = Hmac::new(Sha256::new(), &[0x75, 0x6d]); // um
439 hmac.input(&shared_secret[..]);
440 let mut res = [0; 32];
441 hmac.raw_result(&mut res);
446 fn gen_ammag_from_shared_secret(shared_secret: &SharedSecret) -> [u8; 32] {
447 let mut hmac = Hmac::new(Sha256::new(), &[0x61, 0x6d, 0x6d, 0x61, 0x67]); // ammag
448 hmac.input(&shared_secret[..]);
449 let mut res = [0; 32];
450 hmac.raw_result(&mut res);
454 // can only fail if an intermediary hop has an invalid public key or session_priv is invalid
456 fn construct_onion_keys_callback<FType: FnMut(SharedSecret, [u8; 32], PublicKey, &RouteHop)> (secp_ctx: &Secp256k1, route: &Route, session_priv: &SecretKey, mut callback: FType) -> Result<(), HandleError> {
457 let mut blinded_priv = session_priv.clone();
458 let mut blinded_pub = secp_call!(PublicKey::from_secret_key(secp_ctx, &blinded_priv));
459 let mut first_iteration = true;
461 for hop in route.hops.iter() {
462 let shared_secret = SharedSecret::new(secp_ctx, &hop.pubkey, &blinded_priv);
464 let mut sha = Sha256::new();
465 sha.input(&blinded_pub.serialize()[..]);
466 sha.input(&shared_secret[..]);
467 let mut blinding_factor = [0u8; 32];
468 sha.result(&mut blinding_factor);
471 blinded_pub = secp_call!(PublicKey::from_secret_key(secp_ctx, &blinded_priv));
472 first_iteration = false;
474 let ephemeral_pubkey = blinded_pub;
476 secp_call!(blinded_priv.mul_assign(secp_ctx, &secp_call!(SecretKey::from_slice(secp_ctx, &blinding_factor))));
477 blinded_pub = secp_call!(PublicKey::from_secret_key(secp_ctx, &blinded_priv));
479 callback(shared_secret, blinding_factor, ephemeral_pubkey, hop);
485 // can only fail if an intermediary hop has an invalid public key or session_priv is invalid
486 fn construct_onion_keys(secp_ctx: &Secp256k1, route: &Route, session_priv: &SecretKey) -> Result<Vec<OnionKeys>, HandleError> {
487 let mut res = Vec::with_capacity(route.hops.len());
489 Self::construct_onion_keys_callback(secp_ctx, route, session_priv, |shared_secret, _blinding_factor, ephemeral_pubkey, _| {
490 let (rho, mu) = ChannelManager::gen_rho_mu_from_shared_secret(&shared_secret);
496 blinding_factor: _blinding_factor,
506 /// returns the hop data, as well as the first-hop value_msat and CLTV value we should send.
507 fn build_onion_payloads(route: &Route, starting_htlc_offset: u32) -> Result<(Vec<msgs::OnionHopData>, u64, u32), HandleError> {
508 let mut cur_value_msat = 0u64;
509 let mut cur_cltv = starting_htlc_offset;
510 let mut last_short_channel_id = 0;
511 let mut res: Vec<msgs::OnionHopData> = Vec::with_capacity(route.hops.len());
512 internal_traits::test_no_dealloc::<msgs::OnionHopData>(None);
513 unsafe { res.set_len(route.hops.len()); }
515 for (idx, hop) in route.hops.iter().enumerate().rev() {
516 // First hop gets special values so that it can check, on receipt, that everything is
517 // exactly as it should be (and the next hop isn't trying to probe to find out if we're
518 // the intended recipient).
519 let value_msat = if cur_value_msat == 0 { hop.fee_msat } else { cur_value_msat };
520 let cltv = if cur_cltv == starting_htlc_offset { hop.cltv_expiry_delta + starting_htlc_offset } else { cur_cltv };
521 res[idx] = msgs::OnionHopData {
523 data: msgs::OnionRealm0HopData {
524 short_channel_id: last_short_channel_id,
525 amt_to_forward: value_msat,
526 outgoing_cltv_value: cltv,
530 cur_value_msat += hop.fee_msat;
531 if cur_value_msat >= 21000000 * 100000000 * 1000 {
532 return Err(HandleError{err: "Channel fees overflowed?!", action: None});
534 cur_cltv += hop.cltv_expiry_delta as u32;
535 if cur_cltv >= 500000000 {
536 return Err(HandleError{err: "Channel CLTV overflowed?!", action: None});
538 last_short_channel_id = hop.short_channel_id;
540 Ok((res, cur_value_msat, cur_cltv))
544 fn shift_arr_right(arr: &mut [u8; 20*65]) {
546 ptr::copy(arr[0..].as_ptr(), arr[65..].as_mut_ptr(), 19*65);
554 fn xor_bufs(dst: &mut[u8], src: &[u8]) {
555 assert_eq!(dst.len(), src.len());
557 for i in 0..dst.len() {
562 const ZERO:[u8; 21*65] = [0; 21*65];
563 fn construct_onion_packet(mut payloads: Vec<msgs::OnionHopData>, onion_keys: Vec<OnionKeys>, associated_data: &[u8; 32]) -> Result<msgs::OnionPacket, HandleError> {
564 let mut buf = Vec::with_capacity(21*65);
565 buf.resize(21*65, 0);
568 let iters = payloads.len() - 1;
569 let end_len = iters * 65;
570 let mut res = Vec::with_capacity(end_len);
571 res.resize(end_len, 0);
573 for (i, keys) in onion_keys.iter().enumerate() {
574 if i == payloads.len() - 1 { continue; }
575 let mut chacha = ChaCha20::new(&keys.rho, &[0u8; 8]);
576 chacha.process(&ChannelManager::ZERO, &mut buf); // We don't have a seek function :(
577 ChannelManager::xor_bufs(&mut res[0..(i + 1)*65], &buf[(20 - i)*65..21*65]);
582 let mut packet_data = [0; 20*65];
583 let mut hmac_res = [0; 32];
585 for (i, (payload, keys)) in payloads.iter_mut().zip(onion_keys.iter()).rev().enumerate() {
586 ChannelManager::shift_arr_right(&mut packet_data);
587 payload.hmac = hmac_res;
588 packet_data[0..65].copy_from_slice(&payload.encode()[..]);
590 let mut chacha = ChaCha20::new(&keys.rho, &[0u8; 8]);
591 chacha.process(&packet_data, &mut buf[0..20*65]);
592 packet_data[..].copy_from_slice(&buf[0..20*65]);
595 packet_data[20*65 - filler.len()..20*65].copy_from_slice(&filler[..]);
598 let mut hmac = Hmac::new(Sha256::new(), &keys.mu);
599 hmac.input(&packet_data);
600 hmac.input(&associated_data[..]);
601 hmac.raw_result(&mut hmac_res);
604 Ok(msgs::OnionPacket{
606 public_key: onion_keys.first().unwrap().ephemeral_pubkey,
607 hop_data: packet_data,
612 /// Encrypts a failure packet. raw_packet can either be a
613 /// msgs::DecodedOnionErrorPacket.encode() result or a msgs::OnionErrorPacket.data element.
614 fn encrypt_failure_packet(shared_secret: &SharedSecret, raw_packet: &[u8]) -> msgs::OnionErrorPacket {
615 let ammag = ChannelManager::gen_ammag_from_shared_secret(&shared_secret);
617 let mut packet_crypted = Vec::with_capacity(raw_packet.len());
618 packet_crypted.resize(raw_packet.len(), 0);
619 let mut chacha = ChaCha20::new(&ammag, &[0u8; 8]);
620 chacha.process(&raw_packet, &mut packet_crypted[..]);
621 msgs::OnionErrorPacket {
622 data: packet_crypted,
626 fn build_failure_packet(shared_secret: &SharedSecret, failure_type: u16, failure_data: &[u8]) -> msgs::DecodedOnionErrorPacket {
627 assert!(failure_data.len() <= 256 - 2);
629 let um = ChannelManager::gen_um_from_shared_secret(&shared_secret);
632 let mut res = Vec::with_capacity(2 + failure_data.len());
633 res.push(((failure_type >> 8) & 0xff) as u8);
634 res.push(((failure_type >> 0) & 0xff) as u8);
635 res.extend_from_slice(&failure_data[..]);
639 let mut res = Vec::with_capacity(256 - 2 - failure_data.len());
640 res.resize(256 - 2 - failure_data.len(), 0);
643 let mut packet = msgs::DecodedOnionErrorPacket {
645 failuremsg: failuremsg,
649 let mut hmac = Hmac::new(Sha256::new(), &um);
650 hmac.input(&packet.encode()[32..]);
651 hmac.raw_result(&mut packet.hmac);
657 fn build_first_hop_failure_packet(shared_secret: &SharedSecret, failure_type: u16, failure_data: &[u8]) -> msgs::OnionErrorPacket {
658 let failure_packet = ChannelManager::build_failure_packet(shared_secret, failure_type, failure_data);
659 ChannelManager::encrypt_failure_packet(shared_secret, &failure_packet.encode()[..])
662 /// only fails if the channel does not yet have an assigned short_id
663 fn get_channel_update(&self, chan: &Channel) -> Result<msgs::ChannelUpdate, HandleError> {
664 let short_channel_id = match chan.get_short_channel_id() {
665 None => return Err(HandleError{err: "Channel not yet established", action: None}),
669 let were_node_one = PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key).unwrap().serialize()[..] < chan.get_their_node_id().serialize()[..];
671 let unsigned = msgs::UnsignedChannelUpdate {
672 chain_hash: self.genesis_hash,
673 short_channel_id: short_channel_id,
674 timestamp: chan.get_channel_update_count(),
675 flags: (!were_node_one) as u16 | ((!chan.is_live() as u16) << 1),
676 cltv_expiry_delta: CLTV_EXPIRY_DELTA,
677 htlc_minimum_msat: chan.get_our_htlc_minimum_msat(),
678 fee_base_msat: chan.get_our_fee_base_msat(&*self.fee_estimator),
679 fee_proportional_millionths: self.fee_proportional_millionths,
682 let msg_hash = Sha256dHash::from_data(&unsigned.encode()[..]);
683 let sig = self.secp_ctx.sign(&Message::from_slice(&msg_hash[..]).unwrap(), &self.our_network_key).unwrap(); //TODO Can we unwrap here?
685 Ok(msgs::ChannelUpdate {
691 /// Sends a payment along a given route.
692 /// Value parameters are provided via the last hop in route, see documentation for RouteHop
693 /// fields for more info.
694 /// Note that if the payment_hash already exists elsewhere (eg you're sending a duplicative
695 /// payment), we don't do anything to stop you! We always try to ensure that if the provided
696 /// next hop knows the preimage to payment_hash they can claim an additional amount as
697 /// specified in the last hop in the route! Thus, you should probably do your own
698 /// payment_preimage tracking (which you should already be doing as they represent "proof of
699 /// payment") and prevent double-sends yourself.
700 /// See-also docs on Channel::send_htlc_and_commit.
701 /// May generate a SendHTLCs event on success, which should be relayed.
702 pub fn send_payment(&self, route: Route, payment_hash: [u8; 32]) -> Result<(), HandleError> {
703 if route.hops.len() < 1 || route.hops.len() > 20 {
704 return Err(HandleError{err: "Route didn't go anywhere/had bogus size", action: None});
706 let our_node_id = self.get_our_node_id();
707 for (idx, hop) in route.hops.iter().enumerate() {
708 if idx != route.hops.len() - 1 && hop.pubkey == our_node_id {
709 return Err(HandleError{err: "Route went through us but wasn't a simple rebalance loop to us", action: None});
713 let session_priv = secp_call!(SecretKey::from_slice(&self.secp_ctx, &{
714 let mut session_key = [0; 32];
715 rng::fill_bytes(&mut session_key);
719 let cur_height = self.latest_block_height.load(Ordering::Acquire) as u32 + 1;
721 let onion_keys = ChannelManager::construct_onion_keys(&self.secp_ctx, &route, &session_priv)?;
722 let (onion_payloads, htlc_msat, htlc_cltv) = ChannelManager::build_onion_payloads(&route, cur_height)?;
723 let onion_packet = ChannelManager::construct_onion_packet(onion_payloads, onion_keys, &payment_hash)?;
725 let (first_hop_node_id, (update_add, commitment_signed, chan_monitor)) = {
726 let mut channel_state_lock = self.channel_state.lock().unwrap();
727 let channel_state = channel_state_lock.borrow_parts();
729 let id = match channel_state.short_to_id.get(&route.hops.first().unwrap().short_channel_id) {
730 None => return Err(HandleError{err: "No channel available with first hop!", action: None}),
731 Some(id) => id.clone()
734 let claimable_htlc_entry = channel_state.claimable_htlcs.entry(payment_hash.clone());
735 if let hash_map::Entry::Occupied(_) = claimable_htlc_entry {
736 return Err(HandleError{err: "Already had pending HTLC with the same payment_hash", action: None});
740 let chan = channel_state.by_id.get_mut(&id).unwrap();
741 if chan.get_their_node_id() != route.hops.first().unwrap().pubkey {
742 return Err(HandleError{err: "Node ID mismatch on first hop!", action: None});
744 chan.send_htlc_and_commit(htlc_msat, payment_hash, htlc_cltv, onion_packet)?
747 let first_hop_node_id = route.hops.first().unwrap().pubkey;
749 claimable_htlc_entry.or_insert(PendingOutboundHTLC::OutboundRoute {
755 Some(msgs) => (first_hop_node_id, msgs),
756 None => return Ok(()),
760 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
761 unimplemented!(); // maybe remove from claimable_htlcs?
764 let mut events = self.pending_events.lock().unwrap();
765 events.push(events::Event::SendHTLCs {
766 node_id: first_hop_node_id,
767 msgs: vec![update_add],
768 commitment_msg: commitment_signed,
773 /// Call this upon creation of a funding transaction for the given channel.
774 /// Panics if a funding transaction has already been provided for this channel.
775 /// May panic if the funding_txo is duplicative with some other channel (note that this should
776 /// be trivially prevented by using unique funding transaction keys per-channel).
777 pub fn funding_transaction_generated(&self, temporary_channel_id: &[u8; 32], funding_txo: OutPoint) {
779 macro_rules! add_pending_event {
782 let mut pending_events = self.pending_events.lock().unwrap();
783 pending_events.push($event);
788 let (chan, msg, chan_monitor) = {
789 let mut channel_state = self.channel_state.lock().unwrap();
790 match channel_state.by_id.remove(temporary_channel_id) {
792 match chan.get_outbound_funding_created(funding_txo) {
794 (chan, funding_msg.0, funding_msg.1)
797 log_error!(self, "Got bad signatures: {}!", e.err);
798 mem::drop(channel_state);
799 add_pending_event!(events::Event::HandleError {
800 node_id: chan.get_their_node_id(),
809 }; // Release channel lock for install_watch_outpoint call,
810 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
811 unimplemented!(); // maybe remove from claimable_htlcs?
813 add_pending_event!(events::Event::SendFundingCreated {
814 node_id: chan.get_their_node_id(),
818 let mut channel_state = self.channel_state.lock().unwrap();
819 match channel_state.by_id.entry(chan.channel_id()) {
820 hash_map::Entry::Occupied(_) => {
821 panic!("Generated duplicate funding txid?");
823 hash_map::Entry::Vacant(e) => {
829 fn get_announcement_sigs(&self, chan: &Channel) -> Result<Option<msgs::AnnouncementSignatures>, HandleError> {
830 if !chan.is_usable() || !chan.should_announce() { return Ok(None) }
832 let (announcement, our_bitcoin_sig) = chan.get_channel_announcement(self.get_our_node_id(), self.genesis_hash.clone())?;
833 let msghash = Message::from_slice(&Sha256dHash::from_data(&announcement.encode()[..])[..]).unwrap();
834 let our_node_sig = secp_call!(self.secp_ctx.sign(&msghash, &self.our_network_key));
836 Ok(Some(msgs::AnnouncementSignatures {
837 channel_id: chan.channel_id(),
838 short_channel_id: chan.get_short_channel_id().unwrap(),
839 node_signature: our_node_sig,
840 bitcoin_signature: our_bitcoin_sig,
844 /// Processes HTLCs which are pending waiting on random forward delay.
845 /// Should only really ever be called in response to an PendingHTLCsForwardable event.
846 /// Will likely generate further events.
847 pub fn process_pending_htlc_forwards(&self) {
848 let mut new_events = Vec::new();
849 let mut failed_forwards = Vec::new();
851 let mut channel_state_lock = self.channel_state.lock().unwrap();
852 let channel_state = channel_state_lock.borrow_parts();
854 if cfg!(not(feature = "fuzztarget")) && Instant::now() < *channel_state.next_forward {
858 for (short_chan_id, pending_forwards) in channel_state.forward_htlcs.drain() {
859 if short_chan_id != 0 {
860 let forward_chan_id = match channel_state.short_to_id.get(&short_chan_id) {
861 Some(chan_id) => chan_id.clone(),
863 failed_forwards.reserve(pending_forwards.len());
864 for forward_info in pending_forwards {
865 failed_forwards.push((forward_info.payment_hash, 0x4000 | 10, None));
870 let forward_chan = &mut channel_state.by_id.get_mut(&forward_chan_id).unwrap();
872 let mut add_htlc_msgs = Vec::new();
873 for forward_info in pending_forwards {
874 match forward_chan.send_htlc(forward_info.amt_to_forward, forward_info.payment_hash, forward_info.outgoing_cltv_value, forward_info.onion_packet.unwrap()) {
876 let chan_update = self.get_channel_update(forward_chan).unwrap();
877 failed_forwards.push((forward_info.payment_hash, 0x1000 | 7, Some(chan_update)));
882 Some(msg) => { add_htlc_msgs.push(msg); },
884 // Nothing to do here...we're waiting on a remote
885 // revoke_and_ack before we can add anymore HTLCs. The Channel
886 // will automatically handle building the update_add_htlc and
887 // commitment_signed messages when we can.
888 // TODO: Do some kind of timer to set the channel as !is_live()
889 // as we don't really want others relying on us relaying through
890 // this channel currently :/.
897 if !add_htlc_msgs.is_empty() {
898 let (commitment_msg, monitor) = match forward_chan.send_commitment() {
901 //TODO: Handle...this is bad!
905 new_events.push((Some(monitor), events::Event::SendHTLCs {
906 node_id: forward_chan.get_their_node_id(),
908 commitment_msg: commitment_msg,
912 for forward_info in pending_forwards {
913 new_events.push((None, events::Event::PaymentReceived {
914 payment_hash: forward_info.payment_hash,
915 amt: forward_info.amt_to_forward,
922 for failed_forward in failed_forwards.drain(..) {
923 match failed_forward.2 {
924 None => self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), &failed_forward.0, HTLCFailReason::Reason { failure_code: failed_forward.1, data: Vec::new() }),
925 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() }),
929 if new_events.is_empty() { return }
931 new_events.retain(|event| {
932 if let &Some(ref monitor) = &event.0 {
933 if let Err(_e) = self.monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor.clone()) {
934 unimplemented!();// but def dont push the event...
940 let mut events = self.pending_events.lock().unwrap();
941 events.reserve(new_events.len());
942 for event in new_events.drain(..) {
943 events.push(event.1);
947 /// Indicates that the preimage for payment_hash is unknown after a PaymentReceived event.
948 pub fn fail_htlc_backwards(&self, payment_hash: &[u8; 32]) -> bool {
949 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), payment_hash, HTLCFailReason::Reason { failure_code: 0x4000 | 15, data: Vec::new() })
952 /// Fails an HTLC backwards to the sender of it to us.
953 /// Note that while we take a channel_state lock as input, we do *not* assume consistency here.
954 /// There are several callsites that do stupid things like loop over a list of payment_hashes
955 /// to fail and take the channel_state lock for each iteration (as we take ownership and may
956 /// drop it). In other words, no assumptions are made that entries in claimable_htlcs point to
957 /// still-available channels.
958 fn fail_htlc_backwards_internal(&self, mut channel_state: MutexGuard<ChannelHolder>, payment_hash: &[u8; 32], onion_error: HTLCFailReason) -> bool {
959 let mut pending_htlc = {
960 match channel_state.claimable_htlcs.remove(payment_hash) {
961 Some(pending_htlc) => pending_htlc,
962 None => return false,
967 PendingOutboundHTLC::CycledRoute { source_short_channel_id, incoming_packet_shared_secret, route, session_priv } => {
968 channel_state.claimable_htlcs.insert(payment_hash.clone(), PendingOutboundHTLC::OutboundRoute {
972 pending_htlc = PendingOutboundHTLC::IntermediaryHopData { source_short_channel_id, incoming_packet_shared_secret };
978 PendingOutboundHTLC::CycledRoute { .. } => unreachable!(),
979 PendingOutboundHTLC::OutboundRoute { .. } => {
980 mem::drop(channel_state);
982 let mut pending_events = self.pending_events.lock().unwrap();
983 pending_events.push(events::Event::PaymentFailed {
984 payment_hash: payment_hash.clone()
988 PendingOutboundHTLC::IntermediaryHopData { source_short_channel_id, incoming_packet_shared_secret } => {
989 let err_packet = match onion_error {
990 HTLCFailReason::Reason { failure_code, data } => {
991 let packet = ChannelManager::build_failure_packet(&incoming_packet_shared_secret, failure_code, &data[..]).encode();
992 ChannelManager::encrypt_failure_packet(&incoming_packet_shared_secret, &packet)
994 HTLCFailReason::ErrorPacket { err } => {
995 ChannelManager::encrypt_failure_packet(&incoming_packet_shared_secret, &err.data)
999 let (node_id, fail_msgs) = {
1000 let chan_id = match channel_state.short_to_id.get(&source_short_channel_id) {
1001 Some(chan_id) => chan_id.clone(),
1002 None => return false
1005 let chan = channel_state.by_id.get_mut(&chan_id).unwrap();
1006 match chan.get_update_fail_htlc_and_commit(payment_hash, err_packet) {
1007 Ok(msg) => (chan.get_their_node_id(), msg),
1009 //TODO: Do something with e?
1016 Some((msg, commitment_msg, chan_monitor)) => {
1017 mem::drop(channel_state);
1019 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1020 unimplemented!();// but def dont push the event...
1023 let mut pending_events = self.pending_events.lock().unwrap();
1024 //TODO: replace by HandleError ? UpdateFailHTLC in handle_update_add_htlc need also to build a CommitmentSigned
1025 pending_events.push(events::Event::SendFailHTLC {
1028 commitment_msg: commitment_msg,
1039 /// Provides a payment preimage in response to a PaymentReceived event, returning true and
1040 /// generating message events for the net layer to claim the payment, if possible. Thus, you
1041 /// should probably kick the net layer to go send messages if this returns true!
1042 /// May panic if called except in response to a PaymentReceived event.
1043 pub fn claim_funds(&self, payment_preimage: [u8; 32]) -> bool {
1044 self.claim_funds_internal(payment_preimage, true)
1046 fn claim_funds_internal(&self, payment_preimage: [u8; 32], from_user: bool) -> bool {
1047 let mut sha = Sha256::new();
1048 sha.input(&payment_preimage);
1049 let mut payment_hash = [0; 32];
1050 sha.result(&mut payment_hash);
1052 let mut channel_state = self.channel_state.lock().unwrap();
1053 let mut pending_htlc = {
1054 match channel_state.claimable_htlcs.remove(&payment_hash) {
1055 Some(pending_htlc) => pending_htlc,
1056 None => return false,
1060 match pending_htlc {
1061 PendingOutboundHTLC::CycledRoute { source_short_channel_id, incoming_packet_shared_secret, route, session_priv } => {
1062 if from_user { // This was the end hop back to us
1063 pending_htlc = PendingOutboundHTLC::IntermediaryHopData { source_short_channel_id, incoming_packet_shared_secret };
1064 channel_state.claimable_htlcs.insert(payment_hash, PendingOutboundHTLC::OutboundRoute { route, session_priv });
1065 } else { // This came from the first upstream node
1066 // Bank error in our favor! Maybe we should tell the user this somehow???
1067 pending_htlc = PendingOutboundHTLC::OutboundRoute { route, session_priv };
1068 channel_state.claimable_htlcs.insert(payment_hash, PendingOutboundHTLC::IntermediaryHopData { source_short_channel_id, incoming_packet_shared_secret });
1074 match pending_htlc {
1075 PendingOutboundHTLC::CycledRoute { .. } => unreachable!(),
1076 PendingOutboundHTLC::OutboundRoute { .. } => {
1078 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...");
1080 mem::drop(channel_state);
1081 let mut pending_events = self.pending_events.lock().unwrap();
1082 pending_events.push(events::Event::PaymentSent {
1087 PendingOutboundHTLC::IntermediaryHopData { source_short_channel_id, .. } => {
1088 let (node_id, fulfill_msgs) = {
1089 let chan_id = match channel_state.short_to_id.get(&source_short_channel_id) {
1090 Some(chan_id) => chan_id.clone(),
1092 // TODO: There is probably a channel manager somewhere that needs to
1093 // learn the preimage as the channel already hit the chain and that's
1099 let chan = channel_state.by_id.get_mut(&chan_id).unwrap();
1100 match chan.get_update_fulfill_htlc_and_commit(payment_preimage) {
1101 Ok(msg) => (chan.get_their_node_id(), msg),
1103 // TODO: There is probably a channel manager somewhere that needs to
1104 // learn the preimage as the channel may be about to hit the chain.
1105 //TODO: Do something with e?
1111 mem::drop(channel_state);
1112 if let Some(chan_monitor) = fulfill_msgs.1 {
1113 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1114 unimplemented!();// but def dont push the event...
1118 if let Some((msg, commitment_msg)) = fulfill_msgs.0 {
1119 let mut pending_events = self.pending_events.lock().unwrap();
1120 pending_events.push(events::Event::SendFulfillHTLC {
1131 /// Gets the node_id held by this ChannelManager
1132 pub fn get_our_node_id(&self) -> PublicKey {
1133 PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key).unwrap()
1136 /// Used to restore channels to normal operation after a
1137 /// ChannelMonitorUpdateErr::TemporaryFailure was returned from a channel monitor update
1139 pub fn test_restore_channel_monitor(&self) {
1144 impl events::EventsProvider for ChannelManager {
1145 fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
1146 let mut pending_events = self.pending_events.lock().unwrap();
1147 let mut ret = Vec::new();
1148 mem::swap(&mut ret, &mut *pending_events);
1153 impl ChainListener for ChannelManager {
1154 fn block_connected(&self, header: &BlockHeader, height: u32, txn_matched: &[&Transaction], indexes_of_txn_matched: &[u32]) {
1155 let mut new_events = Vec::new();
1156 let mut failed_channels = Vec::new();
1158 let mut channel_lock = self.channel_state.lock().unwrap();
1159 let channel_state = channel_lock.borrow_parts();
1160 let short_to_id = channel_state.short_to_id;
1161 channel_state.by_id.retain(|_, channel| {
1162 let chan_res = channel.block_connected(header, height, txn_matched, indexes_of_txn_matched);
1163 if let Ok(Some(funding_locked)) = chan_res {
1164 let announcement_sigs = match self.get_announcement_sigs(channel) {
1167 log_error!(self, "Got error handling message: {}!", e.err);
1168 //TODO: push e on events and blow up the channel (it has bad keys)
1172 new_events.push(events::Event::SendFundingLocked {
1173 node_id: channel.get_their_node_id(),
1174 msg: funding_locked,
1175 announcement_sigs: announcement_sigs
1177 short_to_id.insert(channel.get_short_channel_id().unwrap(), channel.channel_id());
1178 } else if let Err(e) = chan_res {
1179 new_events.push(events::Event::HandleError {
1180 node_id: channel.get_their_node_id(),
1183 if channel.is_shutdown() {
1187 if let Some(funding_txo) = channel.get_funding_txo() {
1188 for tx in txn_matched {
1189 for inp in tx.input.iter() {
1190 if inp.prev_hash == funding_txo.txid && inp.prev_index == funding_txo.index as u32 {
1191 if let Some(short_id) = channel.get_short_channel_id() {
1192 short_to_id.remove(&short_id);
1194 // It looks like our counterparty went on-chain. We go ahead and
1195 // broadcast our latest local state as well here, just in case its
1196 // some kind of SPV attack, though we expect these to be dropped.
1197 failed_channels.push(channel.force_shutdown());
1198 if let Ok(update) = self.get_channel_update(&channel) {
1199 new_events.push(events::Event::BroadcastChannelUpdate {
1208 if channel.is_funding_initiated() && channel.channel_monitor().would_broadcast_at_height(height) {
1209 if let Some(short_id) = channel.get_short_channel_id() {
1210 short_to_id.remove(&short_id);
1212 failed_channels.push(channel.force_shutdown());
1213 // If would_broadcast_at_height() is true, the channel_monitor will broadcast
1214 // the latest local tx for us, so we should skip that here (it doesn't really
1215 // hurt anything, but does make tests a bit simpler).
1216 failed_channels.last_mut().unwrap().0 = Vec::new();
1217 if let Ok(update) = self.get_channel_update(&channel) {
1218 new_events.push(events::Event::BroadcastChannelUpdate {
1227 for failure in failed_channels.drain(..) {
1228 self.finish_force_close_channel(failure);
1230 let mut pending_events = self.pending_events.lock().unwrap();
1231 for funding_locked in new_events.drain(..) {
1232 pending_events.push(funding_locked);
1234 self.latest_block_height.store(height as usize, Ordering::Release);
1237 /// We force-close the channel without letting our counterparty participate in the shutdown
1238 fn block_disconnected(&self, header: &BlockHeader) {
1239 let mut new_events = Vec::new();
1240 let mut failed_channels = Vec::new();
1242 let mut channel_lock = self.channel_state.lock().unwrap();
1243 let channel_state = channel_lock.borrow_parts();
1244 let short_to_id = channel_state.short_to_id;
1245 channel_state.by_id.retain(|_, v| {
1246 if v.block_disconnected(header) {
1247 if let Some(short_id) = v.get_short_channel_id() {
1248 short_to_id.remove(&short_id);
1250 failed_channels.push(v.force_shutdown());
1251 if let Ok(update) = self.get_channel_update(&v) {
1252 new_events.push(events::Event::BroadcastChannelUpdate {
1262 for failure in failed_channels.drain(..) {
1263 self.finish_force_close_channel(failure);
1265 if !new_events.is_empty() {
1266 let mut pending_events = self.pending_events.lock().unwrap();
1267 for funding_locked in new_events.drain(..) {
1268 pending_events.push(funding_locked);
1271 self.latest_block_height.fetch_sub(1, Ordering::AcqRel);
1275 impl ChannelMessageHandler for ChannelManager {
1276 //TODO: Handle errors and close channel (or so)
1277 fn handle_open_channel(&self, their_node_id: &PublicKey, msg: &msgs::OpenChannel) -> Result<msgs::AcceptChannel, HandleError> {
1278 if msg.chain_hash != self.genesis_hash {
1279 return Err(HandleError{err: "Unknown genesis block hash", action: None});
1281 let mut channel_state = self.channel_state.lock().unwrap();
1282 if channel_state.by_id.contains_key(&msg.temporary_channel_id) {
1283 return Err(HandleError{err: "temporary_channel_id collision!", action: None});
1286 let chan_keys = if cfg!(feature = "fuzztarget") {
1288 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(),
1289 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(),
1290 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(),
1291 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(),
1292 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(),
1293 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(),
1294 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(),
1295 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],
1298 let mut key_seed = [0u8; 32];
1299 rng::fill_bytes(&mut key_seed);
1300 match ChannelKeys::new_from_seed(&key_seed) {
1302 Err(_) => panic!("RNG is busted!")
1306 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))?;
1307 let accept_msg = channel.get_accept_channel()?;
1308 channel_state.by_id.insert(channel.channel_id(), channel);
1312 fn handle_accept_channel(&self, their_node_id: &PublicKey, msg: &msgs::AcceptChannel) -> Result<(), HandleError> {
1313 let (value, output_script, user_id) = {
1314 let mut channel_state = self.channel_state.lock().unwrap();
1315 match channel_state.by_id.get_mut(&msg.temporary_channel_id) {
1317 if chan.get_their_node_id() != *their_node_id {
1318 return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None})
1320 chan.accept_channel(&msg)?;
1321 (chan.get_value_satoshis(), chan.get_funding_redeemscript().to_v0_p2wsh(), chan.get_user_id())
1323 None => return Err(HandleError{err: "Failed to find corresponding channel", action: None})
1326 let mut pending_events = self.pending_events.lock().unwrap();
1327 pending_events.push(events::Event::FundingGenerationReady {
1328 temporary_channel_id: msg.temporary_channel_id,
1329 channel_value_satoshis: value,
1330 output_script: output_script,
1331 user_channel_id: user_id,
1336 fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<msgs::FundingSigned, HandleError> {
1337 let (chan, funding_msg, monitor_update) = {
1338 let mut channel_state = self.channel_state.lock().unwrap();
1339 match channel_state.by_id.entry(msg.temporary_channel_id.clone()) {
1340 hash_map::Entry::Occupied(mut chan) => {
1341 if chan.get().get_their_node_id() != *their_node_id {
1342 return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None})
1344 match chan.get_mut().funding_created(msg) {
1345 Ok((funding_msg, monitor_update)) => {
1346 (chan.remove(), funding_msg, monitor_update)
1349 //TODO: Possibly remove the channel depending on e.action
1354 hash_map::Entry::Vacant(_) => return Err(HandleError{err: "Failed to find corresponding channel", action: None})
1356 }; // Release channel lock for install_watch_outpoint call,
1357 // note that this means if the remote end is misbehaving and sends a message for the same
1358 // channel back-to-back with funding_created, we'll end up thinking they sent a message
1359 // for a bogus channel.
1360 if let Err(_e) = self.monitor.add_update_monitor(monitor_update.get_funding_txo().unwrap(), monitor_update) {
1363 let mut channel_state = self.channel_state.lock().unwrap();
1364 match channel_state.by_id.entry(funding_msg.channel_id) {
1365 hash_map::Entry::Occupied(_) => {
1366 return Err(HandleError {
1367 err: "Duplicate channel_id!",
1368 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() } })
1371 hash_map::Entry::Vacant(e) => {
1378 fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), HandleError> {
1379 let (funding_txo, user_id, monitor) = {
1380 let mut channel_state = self.channel_state.lock().unwrap();
1381 match channel_state.by_id.get_mut(&msg.channel_id) {
1383 if chan.get_their_node_id() != *their_node_id {
1384 return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None})
1386 let chan_monitor = chan.funding_signed(&msg)?;
1387 (chan.get_funding_txo().unwrap(), chan.get_user_id(), chan_monitor)
1389 None => return Err(HandleError{err: "Failed to find corresponding channel", action: None})
1392 if let Err(_e) = self.monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor) {
1395 let mut pending_events = self.pending_events.lock().unwrap();
1396 pending_events.push(events::Event::FundingBroadcastSafe {
1397 funding_txo: funding_txo,
1398 user_channel_id: user_id,
1403 fn handle_funding_locked(&self, their_node_id: &PublicKey, msg: &msgs::FundingLocked) -> Result<Option<msgs::AnnouncementSignatures>, HandleError> {
1404 let mut channel_state = self.channel_state.lock().unwrap();
1405 match channel_state.by_id.get_mut(&msg.channel_id) {
1407 if chan.get_their_node_id() != *their_node_id {
1408 return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None})
1410 chan.funding_locked(&msg)?;
1411 return Ok(self.get_announcement_sigs(chan)?);
1413 None => return Err(HandleError{err: "Failed to find corresponding channel", action: None})
1417 fn handle_shutdown(&self, their_node_id: &PublicKey, msg: &msgs::Shutdown) -> Result<(Option<msgs::Shutdown>, Option<msgs::ClosingSigned>), HandleError> {
1418 let (res, chan_option) = {
1419 let mut channel_state_lock = self.channel_state.lock().unwrap();
1420 let channel_state = channel_state_lock.borrow_parts();
1422 match channel_state.by_id.entry(msg.channel_id.clone()) {
1423 hash_map::Entry::Occupied(mut chan_entry) => {
1424 if chan_entry.get().get_their_node_id() != *their_node_id {
1425 return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None})
1427 let res = chan_entry.get_mut().shutdown(&*self.fee_estimator, &msg)?;
1428 if chan_entry.get().is_shutdown() {
1429 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
1430 channel_state.short_to_id.remove(&short_id);
1432 (res, Some(chan_entry.remove_entry().1))
1433 } else { (res, None) }
1435 hash_map::Entry::Vacant(_) => return Err(HandleError{err: "Failed to find corresponding channel", action: None})
1438 for payment_hash in res.2 {
1439 // unknown_next_peer...I dunno who that is anymore....
1440 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), &payment_hash, HTLCFailReason::Reason { failure_code: 0x4000 | 10, data: Vec::new() });
1442 if let Some(chan) = chan_option {
1443 if let Ok(update) = self.get_channel_update(&chan) {
1444 let mut events = self.pending_events.lock().unwrap();
1445 events.push(events::Event::BroadcastChannelUpdate {
1453 fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<Option<msgs::ClosingSigned>, HandleError> {
1454 let (res, chan_option) = {
1455 let mut channel_state_lock = self.channel_state.lock().unwrap();
1456 let channel_state = channel_state_lock.borrow_parts();
1457 match channel_state.by_id.entry(msg.channel_id.clone()) {
1458 hash_map::Entry::Occupied(mut chan_entry) => {
1459 if chan_entry.get().get_their_node_id() != *their_node_id {
1460 return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None})
1462 let res = chan_entry.get_mut().closing_signed(&*self.fee_estimator, &msg)?;
1463 if res.1.is_some() {
1464 // We're done with this channel, we've got a signed closing transaction and
1465 // will send the closing_signed back to the remote peer upon return. This
1466 // also implies there are no pending HTLCs left on the channel, so we can
1467 // fully delete it from tracking (the channel monitor is still around to
1468 // watch for old state broadcasts)!
1469 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
1470 channel_state.short_to_id.remove(&short_id);
1472 (res, Some(chan_entry.remove_entry().1))
1473 } else { (res, None) }
1475 hash_map::Entry::Vacant(_) => return Err(HandleError{err: "Failed to find corresponding channel", action: None})
1478 if let Some(broadcast_tx) = res.1 {
1479 self.tx_broadcaster.broadcast_transaction(&broadcast_tx);
1481 if let Some(chan) = chan_option {
1482 if let Ok(update) = self.get_channel_update(&chan) {
1483 let mut events = self.pending_events.lock().unwrap();
1484 events.push(events::Event::BroadcastChannelUpdate {
1492 fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), msgs::HandleError> {
1493 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
1494 //determine the state of the payment based on our response/if we forward anything/the time
1495 //we take to respond. We should take care to avoid allowing such an attack.
1497 //TODO: There exists a further attack where a node may garble the onion data, forward it to
1498 //us repeatedly garbled in different ways, and compare our error messages, which are
1499 //encrypted with the same key. Its not immediately obvious how to usefully exploit that,
1500 //but we should prevent it anyway.
1502 let shared_secret = SharedSecret::new(&self.secp_ctx, &msg.onion_routing_packet.public_key, &self.our_network_key);
1503 let (rho, mu) = ChannelManager::gen_rho_mu_from_shared_secret(&shared_secret);
1505 macro_rules! get_onion_hash {
1508 let mut sha = Sha256::new();
1509 sha.input(&msg.onion_routing_packet.hop_data);
1510 let mut onion_hash = [0; 32];
1511 sha.result(&mut onion_hash);
1517 macro_rules! return_err {
1518 ($msg: expr, $err_code: expr, $data: expr) => {
1519 return Err(msgs::HandleError {
1521 action: Some(msgs::ErrorAction::UpdateFailHTLC {
1522 msg: msgs::UpdateFailHTLC {
1523 channel_id: msg.channel_id,
1524 htlc_id: msg.htlc_id,
1525 reason: ChannelManager::build_first_hop_failure_packet(&shared_secret, $err_code, $data),
1532 if msg.onion_routing_packet.version != 0 {
1533 //TODO: Spec doesn't indicate if we should only hash hop_data here (and in other
1534 //sha256_of_onion error data packets), or the entire onion_routing_packet. Either way,
1535 //the hash doesn't really serve any purpuse - in the case of hashing all data, the
1536 //receiving node would have to brute force to figure out which version was put in the
1537 //packet by the node that send us the message, in the case of hashing the hop_data, the
1538 //node knows the HMAC matched, so they already know what is there...
1539 return_err!("Unknown onion packet version", 0x8000 | 0x4000 | 4, &get_onion_hash!());
1542 let mut hmac = Hmac::new(Sha256::new(), &mu);
1543 hmac.input(&msg.onion_routing_packet.hop_data);
1544 hmac.input(&msg.payment_hash);
1545 if hmac.result() != MacResult::new(&msg.onion_routing_packet.hmac) {
1546 return_err!("HMAC Check failed", 0x8000 | 0x4000 | 5, &get_onion_hash!());
1549 let mut chacha = ChaCha20::new(&rho, &[0u8; 8]);
1550 let next_hop_data = {
1551 let mut decoded = [0; 65];
1552 chacha.process(&msg.onion_routing_packet.hop_data[0..65], &mut decoded);
1553 match msgs::OnionHopData::decode(&decoded[..]) {
1555 let error_code = match err {
1556 msgs::DecodeError::UnknownRealmByte => 0x4000 | 1,
1557 _ => 0x2000 | 2, // Should never happen
1559 return_err!("Unable to decode our hop data", error_code, &[0;0]);
1565 //TODO: Check that msg.cltv_expiry is within acceptable bounds!
1567 let mut pending_forward_info = if next_hop_data.hmac == [0; 32] {
1569 if next_hop_data.data.amt_to_forward != msg.amount_msat {
1570 return_err!("Upstream node sent less than we were supposed to receive in payment", 19, &byte_utils::be64_to_array(msg.amount_msat));
1572 if next_hop_data.data.outgoing_cltv_value != msg.cltv_expiry {
1573 return_err!("Upstream node set CLTV to the wrong value", 18, &byte_utils::be32_to_array(msg.cltv_expiry));
1576 // Note that we could obviously respond immediately with an update_fulfill_htlc
1577 // message, however that would leak that we are the recipient of this payment, so
1578 // instead we stay symmetric with the forwarding case, only responding (after a
1579 // delay) once they've send us a commitment_signed!
1581 PendingForwardHTLCInfo {
1583 payment_hash: msg.payment_hash.clone(),
1584 short_channel_id: 0,
1585 prev_short_channel_id: 0,
1586 amt_to_forward: next_hop_data.data.amt_to_forward,
1587 outgoing_cltv_value: next_hop_data.data.outgoing_cltv_value,
1590 let mut new_packet_data = [0; 20*65];
1591 chacha.process(&msg.onion_routing_packet.hop_data[65..], &mut new_packet_data[0..19*65]);
1592 chacha.process(&ChannelManager::ZERO[0..65], &mut new_packet_data[19*65..]);
1594 let mut new_pubkey = msg.onion_routing_packet.public_key.clone();
1596 let blinding_factor = {
1597 let mut sha = Sha256::new();
1598 sha.input(&new_pubkey.serialize()[..]);
1599 sha.input(&shared_secret[..]);
1600 let mut res = [0u8; 32];
1601 sha.result(&mut res);
1602 match SecretKey::from_slice(&self.secp_ctx, &res) {
1604 // Return temporary node failure as its technically our issue, not the
1606 return_err!("Blinding factor is an invalid private key", 0x2000 | 2, &[0;0]);
1612 match new_pubkey.mul_assign(&self.secp_ctx, &blinding_factor) {
1614 // Return temporary node failure as its technically our issue, not the
1616 return_err!("New blinding factor is an invalid private key", 0x2000 | 2, &[0;0]);
1621 let outgoing_packet = msgs::OnionPacket {
1623 public_key: new_pubkey,
1624 hop_data: new_packet_data,
1625 hmac: next_hop_data.hmac.clone(),
1628 //TODO: Check amt_to_forward and outgoing_cltv_value are within acceptable ranges!
1630 PendingForwardHTLCInfo {
1631 onion_packet: Some(outgoing_packet),
1632 payment_hash: msg.payment_hash.clone(),
1633 short_channel_id: next_hop_data.data.short_channel_id,
1634 prev_short_channel_id: 0,
1635 amt_to_forward: next_hop_data.data.amt_to_forward,
1636 outgoing_cltv_value: next_hop_data.data.outgoing_cltv_value,
1640 let mut channel_state_lock = self.channel_state.lock().unwrap();
1641 let channel_state = channel_state_lock.borrow_parts();
1643 if pending_forward_info.onion_packet.is_some() { // If short_channel_id is 0 here, we'll reject them in the body here
1644 let forwarding_id = match channel_state.short_to_id.get(&pending_forward_info.short_channel_id) {
1646 return_err!("Don't have available channel for forwarding as requested.", 0x4000 | 10, &[0;0]);
1648 Some(id) => id.clone(),
1650 let chan = channel_state.by_id.get_mut(&forwarding_id).unwrap();
1651 if !chan.is_live() {
1652 let chan_update = self.get_channel_update(chan).unwrap();
1653 return_err!("Forwarding channel is not in a ready state.", 0x1000 | 7, &chan_update.encode_with_len()[..]);
1657 let claimable_htlcs_entry = channel_state.claimable_htlcs.entry(msg.payment_hash.clone());
1659 // We dont correctly handle payments that route through us twice on their way to their
1660 // destination. That's OK since those nodes are probably busted or trying to do network
1661 // mapping through repeated loops. In either case, we want them to stop talking to us, so
1662 // we send permanent_node_failure.
1663 if let &hash_map::Entry::Occupied(ref e) = &claimable_htlcs_entry {
1664 let mut acceptable_cycle = false;
1665 if let &PendingOutboundHTLC::OutboundRoute { .. } = e.get() {
1666 acceptable_cycle = pending_forward_info.short_channel_id == 0;
1668 if !acceptable_cycle {
1669 return_err!("Payment looped through us twice", 0x4000 | 0x2000 | 2, &[0;0]);
1673 let (source_short_channel_id, res) = match channel_state.by_id.get_mut(&msg.channel_id) {
1675 if chan.get_their_node_id() != *their_node_id {
1676 return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None})
1678 if !chan.is_usable() {
1679 return Err(HandleError{err: "Channel not yet available for receiving HTLCs", action: None});
1681 let short_channel_id = chan.get_short_channel_id().unwrap();
1682 pending_forward_info.prev_short_channel_id = short_channel_id;
1683 (short_channel_id, chan.update_add_htlc(&msg, pending_forward_info)?)
1685 None => return Err(HandleError{err: "Failed to find corresponding channel", action: None}),
1688 match claimable_htlcs_entry {
1689 hash_map::Entry::Occupied(mut e) => {
1690 let outbound_route = e.get_mut();
1691 let (route, session_priv) = match outbound_route {
1692 &mut PendingOutboundHTLC::OutboundRoute { ref route, ref session_priv } => {
1693 (route.clone(), session_priv.clone())
1695 _ => unreachable!(),
1697 *outbound_route = PendingOutboundHTLC::CycledRoute {
1698 source_short_channel_id,
1699 incoming_packet_shared_secret: shared_secret,
1704 hash_map::Entry::Vacant(e) => {
1705 e.insert(PendingOutboundHTLC::IntermediaryHopData {
1706 source_short_channel_id,
1707 incoming_packet_shared_secret: shared_secret,
1715 fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), HandleError> {
1716 //TODO: Delay the claimed_funds relaying just like we do outbound relay!
1717 // Claim funds first, cause we don't really care if the channel we received the message on
1718 // is broken, we may have enough info to get our own money!
1719 self.claim_funds_internal(msg.payment_preimage.clone(), false);
1721 let mut channel_state = self.channel_state.lock().unwrap();
1722 match channel_state.by_id.get_mut(&msg.channel_id) {
1724 if chan.get_their_node_id() != *their_node_id {
1725 return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None})
1727 chan.update_fulfill_htlc(&msg)
1729 None => return Err(HandleError{err: "Failed to find corresponding channel", action: None})
1733 fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<Option<msgs::HTLCFailChannelUpdate>, HandleError> {
1734 let mut channel_state = self.channel_state.lock().unwrap();
1735 let payment_hash = match channel_state.by_id.get_mut(&msg.channel_id) {
1737 if chan.get_their_node_id() != *their_node_id {
1738 return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None})
1740 chan.update_fail_htlc(&msg, HTLCFailReason::ErrorPacket { err: msg.reason.clone() })
1742 None => return Err(HandleError{err: "Failed to find corresponding channel", action: None})
1745 if let Some(pending_htlc) = channel_state.claimable_htlcs.get(&payment_hash) {
1746 match pending_htlc {
1747 &PendingOutboundHTLC::OutboundRoute { ref route, ref session_priv } => {
1748 // Handle packed channel/node updates for passing back for the route handler
1749 let mut packet_decrypted = msg.reason.data.clone();
1751 Self::construct_onion_keys_callback(&self.secp_ctx, &route, &session_priv, |shared_secret, _, _, route_hop| {
1752 if res.is_some() { return; }
1754 let ammag = ChannelManager::gen_ammag_from_shared_secret(&shared_secret);
1756 let mut decryption_tmp = Vec::with_capacity(packet_decrypted.len());
1757 decryption_tmp.resize(packet_decrypted.len(), 0);
1758 let mut chacha = ChaCha20::new(&ammag, &[0u8; 8]);
1759 chacha.process(&packet_decrypted, &mut decryption_tmp[..]);
1760 packet_decrypted = decryption_tmp;
1762 if let Ok(err_packet) = msgs::DecodedOnionErrorPacket::decode(&packet_decrypted) {
1763 if err_packet.failuremsg.len() >= 2 {
1764 let um = ChannelManager::gen_um_from_shared_secret(&shared_secret);
1766 let mut hmac = Hmac::new(Sha256::new(), &um);
1767 hmac.input(&err_packet.encode()[32..]);
1768 let mut calc_tag = [0u8; 32];
1769 hmac.raw_result(&mut calc_tag);
1770 if crypto::util::fixed_time_eq(&calc_tag, &err_packet.hmac) {
1771 const UNKNOWN_CHAN: u16 = 0x4000|10;
1772 const TEMP_CHAN_FAILURE: u16 = 0x4000|7;
1773 match byte_utils::slice_to_be16(&err_packet.failuremsg[0..2]) {
1774 TEMP_CHAN_FAILURE => {
1775 if err_packet.failuremsg.len() >= 4 {
1776 let update_len = byte_utils::slice_to_be16(&err_packet.failuremsg[2..4]) as usize;
1777 if err_packet.failuremsg.len() >= 4 + update_len {
1778 if let Ok(chan_update) = msgs::ChannelUpdate::decode(&err_packet.failuremsg[4..4 + update_len]) {
1779 res = Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage {
1787 // No such next-hop. We know this came from the
1788 // current node as the HMAC validated.
1789 res = Some(msgs::HTLCFailChannelUpdate::ChannelClosed {
1790 short_channel_id: route_hop.short_channel_id
1793 _ => {}, //TODO: Enumerate all of these!
1808 fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), HandleError> {
1809 let mut channel_state = self.channel_state.lock().unwrap();
1810 match channel_state.by_id.get_mut(&msg.channel_id) {
1812 if chan.get_their_node_id() != *their_node_id {
1813 return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None})
1815 chan.update_fail_malformed_htlc(&msg, HTLCFailReason::Reason { failure_code: msg.failure_code, data: Vec::new() })
1817 None => return Err(HandleError{err: "Failed to find corresponding channel", action: None})
1821 fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(msgs::RevokeAndACK, Option<msgs::CommitmentSigned>), HandleError> {
1822 let (revoke_and_ack, commitment_signed, chan_monitor) = {
1823 let mut channel_state = self.channel_state.lock().unwrap();
1824 match channel_state.by_id.get_mut(&msg.channel_id) {
1826 if chan.get_their_node_id() != *their_node_id {
1827 return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None})
1829 chan.commitment_signed(&msg)?
1831 None => return Err(HandleError{err: "Failed to find corresponding channel", action: None})
1834 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1838 Ok((revoke_and_ack, commitment_signed))
1841 fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<Option<msgs::CommitmentUpdate>, HandleError> {
1842 let (res, mut pending_forwards, mut pending_failures, chan_monitor) = {
1843 let mut channel_state = self.channel_state.lock().unwrap();
1844 match channel_state.by_id.get_mut(&msg.channel_id) {
1846 if chan.get_their_node_id() != *their_node_id {
1847 return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None})
1849 chan.revoke_and_ack(&msg)?
1851 None => return Err(HandleError{err: "Failed to find corresponding channel", action: None})
1854 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1857 for failure in pending_failures.drain(..) {
1858 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), &failure.0, failure.1);
1861 let mut forward_event = None;
1862 if !pending_forwards.is_empty() {
1863 let mut channel_state = self.channel_state.lock().unwrap();
1864 if channel_state.forward_htlcs.is_empty() {
1865 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));
1866 channel_state.next_forward = forward_event.unwrap();
1868 for forward_info in pending_forwards.drain(..) {
1869 match channel_state.forward_htlcs.entry(forward_info.short_channel_id) {
1870 hash_map::Entry::Occupied(mut entry) => {
1871 entry.get_mut().push(forward_info);
1873 hash_map::Entry::Vacant(entry) => {
1874 entry.insert(vec!(forward_info));
1879 match forward_event {
1881 let mut pending_events = self.pending_events.lock().unwrap();
1882 pending_events.push(events::Event::PendingHTLCsForwardable {
1883 time_forwardable: time
1892 fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), HandleError> {
1893 let mut channel_state = self.channel_state.lock().unwrap();
1894 match channel_state.by_id.get_mut(&msg.channel_id) {
1896 if chan.get_their_node_id() != *their_node_id {
1897 return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None})
1899 chan.update_fee(&*self.fee_estimator, &msg)
1901 None => return Err(HandleError{err: "Failed to find corresponding channel", action: None})
1905 fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), HandleError> {
1906 let (chan_announcement, chan_update) = {
1907 let mut channel_state = self.channel_state.lock().unwrap();
1908 match channel_state.by_id.get_mut(&msg.channel_id) {
1910 if chan.get_their_node_id() != *their_node_id {
1911 return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None})
1913 if !chan.is_usable() {
1914 return Err(HandleError{err: "Got an announcement_signatures before we were ready for it", action: None });
1917 let our_node_id = self.get_our_node_id();
1918 let (announcement, our_bitcoin_sig) = chan.get_channel_announcement(our_node_id.clone(), self.genesis_hash.clone())?;
1920 let were_node_one = announcement.node_id_1 == our_node_id;
1921 let msghash = Message::from_slice(&Sha256dHash::from_data(&announcement.encode()[..])[..]).unwrap();
1922 secp_call!(self.secp_ctx.verify(&msghash, &msg.node_signature, if were_node_one { &announcement.node_id_2 } else { &announcement.node_id_1 }));
1923 secp_call!(self.secp_ctx.verify(&msghash, &msg.bitcoin_signature, if were_node_one { &announcement.bitcoin_key_2 } else { &announcement.bitcoin_key_1 }));
1925 let our_node_sig = secp_call!(self.secp_ctx.sign(&msghash, &self.our_network_key));
1927 (msgs::ChannelAnnouncement {
1928 node_signature_1: if were_node_one { our_node_sig } else { msg.node_signature },
1929 node_signature_2: if were_node_one { msg.node_signature } else { our_node_sig },
1930 bitcoin_signature_1: if were_node_one { our_bitcoin_sig } else { msg.bitcoin_signature },
1931 bitcoin_signature_2: if were_node_one { msg.bitcoin_signature } else { our_bitcoin_sig },
1932 contents: announcement,
1933 }, self.get_channel_update(chan).unwrap()) // can only fail if we're not in a ready state
1935 None => return Err(HandleError{err: "Failed to find corresponding channel", action: None})
1938 let mut pending_events = self.pending_events.lock().unwrap();
1939 pending_events.push(events::Event::BroadcastChannelAnnouncement { msg: chan_announcement, update_msg: chan_update });
1943 fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool) {
1944 let mut new_events = Vec::new();
1945 let mut failed_channels = Vec::new();
1947 let mut channel_state_lock = self.channel_state.lock().unwrap();
1948 let channel_state = channel_state_lock.borrow_parts();
1949 let short_to_id = channel_state.short_to_id;
1950 if no_connection_possible {
1951 channel_state.by_id.retain(|_, chan| {
1952 if chan.get_their_node_id() == *their_node_id {
1953 if let Some(short_id) = chan.get_short_channel_id() {
1954 short_to_id.remove(&short_id);
1956 failed_channels.push(chan.force_shutdown());
1957 if let Ok(update) = self.get_channel_update(&chan) {
1958 new_events.push(events::Event::BroadcastChannelUpdate {
1968 for chan in channel_state.by_id {
1969 if chan.1.get_their_node_id() == *their_node_id {
1970 //TODO: mark channel disabled (and maybe announce such after a timeout). Also
1971 //fail and wipe any uncommitted outbound HTLCs as those are considered after
1977 for failure in failed_channels.drain(..) {
1978 self.finish_force_close_channel(failure);
1980 if !new_events.is_empty() {
1981 let mut pending_events = self.pending_events.lock().unwrap();
1982 for event in new_events.drain(..) {
1983 pending_events.push(event);
1991 use chain::chaininterface;
1992 use chain::transaction::OutPoint;
1993 use chain::chaininterface::ChainListener;
1994 use ln::channelmanager::{ChannelManager,OnionKeys};
1995 use ln::router::{Route, RouteHop, Router};
1997 use ln::msgs::{MsgEncodable,ChannelMessageHandler,RoutingMessageHandler};
1998 use util::test_utils;
1999 use util::events::{Event, EventsProvider};
2000 use util::logger::Logger;
2002 use bitcoin::util::hash::Sha256dHash;
2003 use bitcoin::blockdata::block::{Block, BlockHeader};
2004 use bitcoin::blockdata::transaction::{Transaction, TxOut};
2005 use bitcoin::network::constants::Network;
2006 use bitcoin::network::serialize::serialize;
2007 use bitcoin::network::serialize::BitcoinHash;
2011 use secp256k1::Secp256k1;
2012 use secp256k1::key::{PublicKey,SecretKey};
2014 use crypto::sha2::Sha256;
2015 use crypto::digest::Digest;
2017 use rand::{thread_rng,Rng};
2019 use std::collections::HashMap;
2020 use std::default::Default;
2021 use std::sync::{Arc, Mutex};
2022 use std::time::Instant;
2025 fn build_test_onion_keys() -> Vec<OnionKeys> {
2026 // Keys from BOLT 4, used in both test vector tests
2027 let secp_ctx = Secp256k1::new();
2032 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("02eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619").unwrap()[..]).unwrap(),
2033 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
2036 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("0324653eac434488002cc06bbfb7f10fe18991e35f9fe4302dbea6d2353dc0ab1c").unwrap()[..]).unwrap(),
2037 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
2040 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("027f31ebc5462c1fdce1b737ecff52d37d75dea43ce11c74d25aa297165faa2007").unwrap()[..]).unwrap(),
2041 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
2044 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]).unwrap(),
2045 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
2048 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("02edabbd16b41c8371b92ef2f04c1185b4f03b6dcd52ba9b78d9d7c89c8f221145").unwrap()[..]).unwrap(),
2049 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
2054 let session_priv = SecretKey::from_slice(&secp_ctx, &hex::decode("4141414141414141414141414141414141414141414141414141414141414141").unwrap()[..]).unwrap();
2056 let onion_keys = ChannelManager::construct_onion_keys(&secp_ctx, &route, &session_priv).unwrap();
2057 assert_eq!(onion_keys.len(), route.hops.len());
2062 fn onion_vectors() {
2063 // Packet creation test vectors from BOLT 4
2064 let onion_keys = build_test_onion_keys();
2066 assert_eq!(onion_keys[0].shared_secret[..], hex::decode("53eb63ea8a3fec3b3cd433b85cd62a4b145e1dda09391b348c4e1cd36a03ea66").unwrap()[..]);
2067 assert_eq!(onion_keys[0].blinding_factor[..], hex::decode("2ec2e5da605776054187180343287683aa6a51b4b1c04d6dd49c45d8cffb3c36").unwrap()[..]);
2068 assert_eq!(onion_keys[0].ephemeral_pubkey.serialize()[..], hex::decode("02eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619").unwrap()[..]);
2069 assert_eq!(onion_keys[0].rho, hex::decode("ce496ec94def95aadd4bec15cdb41a740c9f2b62347c4917325fcc6fb0453986").unwrap()[..]);
2070 assert_eq!(onion_keys[0].mu, hex::decode("b57061dc6d0a2b9f261ac410c8b26d64ac5506cbba30267a649c28c179400eba").unwrap()[..]);
2072 assert_eq!(onion_keys[1].shared_secret[..], hex::decode("a6519e98832a0b179f62123b3567c106db99ee37bef036e783263602f3488fae").unwrap()[..]);
2073 assert_eq!(onion_keys[1].blinding_factor[..], hex::decode("bf66c28bc22e598cfd574a1931a2bafbca09163df2261e6d0056b2610dab938f").unwrap()[..]);
2074 assert_eq!(onion_keys[1].ephemeral_pubkey.serialize()[..], hex::decode("028f9438bfbf7feac2e108d677e3a82da596be706cc1cf342b75c7b7e22bf4e6e2").unwrap()[..]);
2075 assert_eq!(onion_keys[1].rho, hex::decode("450ffcabc6449094918ebe13d4f03e433d20a3d28a768203337bc40b6e4b2c59").unwrap()[..]);
2076 assert_eq!(onion_keys[1].mu, hex::decode("05ed2b4a3fb023c2ff5dd6ed4b9b6ea7383f5cfe9d59c11d121ec2c81ca2eea9").unwrap()[..]);
2078 assert_eq!(onion_keys[2].shared_secret[..], hex::decode("3a6b412548762f0dbccce5c7ae7bb8147d1caf9b5471c34120b30bc9c04891cc").unwrap()[..]);
2079 assert_eq!(onion_keys[2].blinding_factor[..], hex::decode("a1f2dadd184eb1627049673f18c6325814384facdee5bfd935d9cb031a1698a5").unwrap()[..]);
2080 assert_eq!(onion_keys[2].ephemeral_pubkey.serialize()[..], hex::decode("03bfd8225241ea71cd0843db7709f4c222f62ff2d4516fd38b39914ab6b83e0da0").unwrap()[..]);
2081 assert_eq!(onion_keys[2].rho, hex::decode("11bf5c4f960239cb37833936aa3d02cea82c0f39fd35f566109c41f9eac8deea").unwrap()[..]);
2082 assert_eq!(onion_keys[2].mu, hex::decode("caafe2820fa00eb2eeb78695ae452eba38f5a53ed6d53518c5c6edf76f3f5b78").unwrap()[..]);
2084 assert_eq!(onion_keys[3].shared_secret[..], hex::decode("21e13c2d7cfe7e18836df50872466117a295783ab8aab0e7ecc8c725503ad02d").unwrap()[..]);
2085 assert_eq!(onion_keys[3].blinding_factor[..], hex::decode("7cfe0b699f35525029ae0fa437c69d0f20f7ed4e3916133f9cacbb13c82ff262").unwrap()[..]);
2086 assert_eq!(onion_keys[3].ephemeral_pubkey.serialize()[..], hex::decode("031dde6926381289671300239ea8e57ffaf9bebd05b9a5b95beaf07af05cd43595").unwrap()[..]);
2087 assert_eq!(onion_keys[3].rho, hex::decode("cbe784ab745c13ff5cffc2fbe3e84424aa0fd669b8ead4ee562901a4a4e89e9e").unwrap()[..]);
2088 assert_eq!(onion_keys[3].mu, hex::decode("5052aa1b3d9f0655a0932e50d42f0c9ba0705142c25d225515c45f47c0036ee9").unwrap()[..]);
2090 assert_eq!(onion_keys[4].shared_secret[..], hex::decode("b5756b9b542727dbafc6765a49488b023a725d631af688fc031217e90770c328").unwrap()[..]);
2091 assert_eq!(onion_keys[4].blinding_factor[..], hex::decode("c96e00dddaf57e7edcd4fb5954be5b65b09f17cb6d20651b4e90315be5779205").unwrap()[..]);
2092 assert_eq!(onion_keys[4].ephemeral_pubkey.serialize()[..], hex::decode("03a214ebd875aab6ddfd77f22c5e7311d7f77f17a169e599f157bbcdae8bf071f4").unwrap()[..]);
2093 assert_eq!(onion_keys[4].rho, hex::decode("034e18b8cc718e8af6339106e706c52d8df89e2b1f7e9142d996acf88df8799b").unwrap()[..]);
2094 assert_eq!(onion_keys[4].mu, hex::decode("8e45e5c61c2b24cb6382444db6698727afb063adecd72aada233d4bf273d975a").unwrap()[..]);
2096 // Test vectors below are flat-out wrong: they claim to set outgoing_cltv_value to non-0 :/
2097 let payloads = vec!(
2098 msgs::OnionHopData {
2100 data: msgs::OnionRealm0HopData {
2101 short_channel_id: 0,
2103 outgoing_cltv_value: 0,
2107 msgs::OnionHopData {
2109 data: msgs::OnionRealm0HopData {
2110 short_channel_id: 0x0101010101010101,
2111 amt_to_forward: 0x0100000001,
2112 outgoing_cltv_value: 0,
2116 msgs::OnionHopData {
2118 data: msgs::OnionRealm0HopData {
2119 short_channel_id: 0x0202020202020202,
2120 amt_to_forward: 0x0200000002,
2121 outgoing_cltv_value: 0,
2125 msgs::OnionHopData {
2127 data: msgs::OnionRealm0HopData {
2128 short_channel_id: 0x0303030303030303,
2129 amt_to_forward: 0x0300000003,
2130 outgoing_cltv_value: 0,
2134 msgs::OnionHopData {
2136 data: msgs::OnionRealm0HopData {
2137 short_channel_id: 0x0404040404040404,
2138 amt_to_forward: 0x0400000004,
2139 outgoing_cltv_value: 0,
2145 let packet = ChannelManager::construct_onion_packet(payloads, onion_keys, &[0x42; 32]).unwrap();
2146 // Just check the final packet encoding, as it includes all the per-hop vectors in it
2148 assert_eq!(packet.encode(), hex::decode("0002eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619e5f14350c2a76fc232b5e46d421e9615471ab9e0bc887beff8c95fdb878f7b3a716a996c7845c93d90e4ecbb9bde4ece2f69425c99e4bc820e44485455f135edc0d10f7d61ab590531cf08000179a333a347f8b4072f216400406bdf3bf038659793d4a1fd7b246979e3150a0a4cb052c9ec69acf0f48c3d39cd55675fe717cb7d80ce721caad69320c3a469a202f1e468c67eaf7a7cd8226d0fd32f7b48084dca885d56047694762b67021713ca673929c163ec36e04e40ca8e1c6d17569419d3039d9a1ec866abe044a9ad635778b961fc0776dc832b3a451bd5d35072d2269cf9b040f6b7a7dad84fb114ed413b1426cb96ceaf83825665ed5a1d002c1687f92465b49ed4c7f0218ff8c6c7dd7221d589c65b3b9aaa71a41484b122846c7c7b57e02e679ea8469b70e14fe4f70fee4d87b910cf144be6fe48eef24da475c0b0bcc6565ae82cd3f4e3b24c76eaa5616c6111343306ab35c1fe5ca4a77c0e314ed7dba39d6f1e0de791719c241a939cc493bea2bae1c1e932679ea94d29084278513c77b899cc98059d06a27d171b0dbdf6bee13ddc4fc17a0c4d2827d488436b57baa167544138ca2e64a11b43ac8a06cd0c2fba2d4d900ed2d9205305e2d7383cc98dacb078133de5f6fb6bed2ef26ba92cea28aafc3b9948dd9ae5559e8bd6920b8cea462aa445ca6a95e0e7ba52961b181c79e73bd581821df2b10173727a810c92b83b5ba4a0403eb710d2ca10689a35bec6c3a708e9e92f7d78ff3c5d9989574b00c6736f84c199256e76e19e78f0c98a9d580b4a658c84fc8f2096c2fbea8f5f8c59d0fdacb3be2802ef802abbecb3aba4acaac69a0e965abd8981e9896b1f6ef9d60f7a164b371af869fd0e48073742825e9434fc54da837e120266d53302954843538ea7c6c3dbfb4ff3b2fdbe244437f2a153ccf7bdb4c92aa08102d4f3cff2ae5ef86fab4653595e6a5837fa2f3e29f27a9cde5966843fb847a4a61f1e76c281fe8bb2b0a181d096100db5a1a5ce7a910238251a43ca556712eaadea167fb4d7d75825e440f3ecd782036d7574df8bceacb397abefc5f5254d2722215c53ff54af8299aaaad642c6d72a14d27882d9bbd539e1cc7a527526ba89b8c037ad09120e98ab042d3e8652b31ae0e478516bfaf88efca9f3676ffe99d2819dcaeb7610a626695f53117665d267d3f7abebd6bbd6733f645c72c389f03855bdf1e4b8075b516569b118233a0f0971d24b83113c0b096f5216a207ca99a7cddc81c130923fe3d91e7508c9ac5f2e914ff5dccab9e558566fa14efb34ac98d878580814b94b73acbfde9072f30b881f7f0fff42d4045d1ace6322d86a97d164aa84d93a60498065cc7c20e636f5862dc81531a88c60305a2e59a985be327a6902e4bed986dbf4a0b50c217af0ea7fdf9ab37f9ea1a1aaa72f54cf40154ea9b269f1a7c09f9f43245109431a175d50e2db0132337baa0ef97eed0fcf20489da36b79a1172faccc2f7ded7c60e00694282d93359c4682135642bc81f433574aa8ef0c97b4ade7ca372c5ffc23c7eddd839bab4e0f14d6df15c9dbeab176bec8b5701cf054eb3072f6dadc98f88819042bf10c407516ee58bce33fbe3b3d86a54255e577db4598e30a135361528c101683a5fcde7e8ba53f3456254be8f45fe3a56120ae96ea3773631fcb3873aa3abd91bcff00bd38bd43697a2e789e00da6077482e7b1b1a677b5afae4c54e6cbdf7377b694eb7d7a5b913476a5be923322d3de06060fd5e819635232a2cf4f0731da13b8546d1d6d4f8d75b9fce6c2341a71b0ea6f780df54bfdb0dd5cd9855179f602f9172307c7268724c3618e6817abd793adc214a0dc0bc616816632f27ea336fb56dfd").unwrap());
2152 fn test_failure_packet_onion() {
2153 // Returning Errors test vectors from BOLT 4
2155 let onion_keys = build_test_onion_keys();
2156 let onion_error = ChannelManager::build_failure_packet(&onion_keys[4].shared_secret, 0x2002, &[0; 0]);
2157 assert_eq!(onion_error.encode(), hex::decode("4c2fc8bc08510334b6833ad9c3e79cd1b52ae59dfe5c2a4b23ead50f09f7ee0b0002200200fe0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap());
2159 let onion_packet_1 = ChannelManager::encrypt_failure_packet(&onion_keys[4].shared_secret, &onion_error.encode()[..]);
2160 assert_eq!(onion_packet_1.data, hex::decode("a5e6bd0c74cb347f10cce367f949098f2457d14c046fd8a22cb96efb30b0fdcda8cb9168b50f2fd45edd73c1b0c8b33002df376801ff58aaa94000bf8a86f92620f343baef38a580102395ae3abf9128d1047a0736ff9b83d456740ebbb4aeb3aa9737f18fb4afb4aa074fb26c4d702f42968888550a3bded8c05247e045b866baef0499f079fdaeef6538f31d44deafffdfd3afa2fb4ca9082b8f1c465371a9894dd8c243fb4847e004f5256b3e90e2edde4c9fb3082ddfe4d1e734cacd96ef0706bf63c9984e22dc98851bcccd1c3494351feb458c9c6af41c0044bea3c47552b1d992ae542b17a2d0bba1a096c78d169034ecb55b6e3a7263c26017f033031228833c1daefc0dedb8cf7c3e37c9c37ebfe42f3225c326e8bcfd338804c145b16e34e4").unwrap());
2162 let onion_packet_2 = ChannelManager::encrypt_failure_packet(&onion_keys[3].shared_secret, &onion_packet_1.data[..]);
2163 assert_eq!(onion_packet_2.data, hex::decode("c49a1ce81680f78f5f2000cda36268de34a3f0a0662f55b4e837c83a8773c22aa081bab1616a0011585323930fa5b9fae0c85770a2279ff59ec427ad1bbff9001c0cd1497004bd2a0f68b50704cf6d6a4bf3c8b6a0833399a24b3456961ba00736785112594f65b6b2d44d9f5ea4e49b5e1ec2af978cbe31c67114440ac51a62081df0ed46d4a3df295da0b0fe25c0115019f03f15ec86fabb4c852f83449e812f141a9395b3f70b766ebbd4ec2fae2b6955bd8f32684c15abfe8fd3a6261e52650e8807a92158d9f1463261a925e4bfba44bd20b166d532f0017185c3a6ac7957adefe45559e3072c8dc35abeba835a8cb01a71a15c736911126f27d46a36168ca5ef7dccd4e2886212602b181463e0dd30185c96348f9743a02aca8ec27c0b90dca270").unwrap());
2165 let onion_packet_3 = ChannelManager::encrypt_failure_packet(&onion_keys[2].shared_secret, &onion_packet_2.data[..]);
2166 assert_eq!(onion_packet_3.data, hex::decode("a5d3e8634cfe78b2307d87c6d90be6fe7855b4f2cc9b1dfb19e92e4b79103f61ff9ac25f412ddfb7466e74f81b3e545563cdd8f5524dae873de61d7bdfccd496af2584930d2b566b4f8d3881f8c043df92224f38cf094cfc09d92655989531524593ec6d6caec1863bdfaa79229b5020acc034cd6deeea1021c50586947b9b8e6faa83b81fbfa6133c0af5d6b07c017f7158fa94f0d206baf12dda6b68f785b773b360fd0497e16cc402d779c8d48d0fa6315536ef0660f3f4e1865f5b38ea49c7da4fd959de4e83ff3ab686f059a45c65ba2af4a6a79166aa0f496bf04d06987b6d2ea205bdb0d347718b9aeff5b61dfff344993a275b79717cd815b6ad4c0beb568c4ac9c36ff1c315ec1119a1993c4b61e6eaa0375e0aaf738ac691abd3263bf937e3").unwrap());
2168 let onion_packet_4 = ChannelManager::encrypt_failure_packet(&onion_keys[1].shared_secret, &onion_packet_3.data[..]);
2169 assert_eq!(onion_packet_4.data, hex::decode("aac3200c4968f56b21f53e5e374e3a2383ad2b1b6501bbcc45abc31e59b26881b7dfadbb56ec8dae8857add94e6702fb4c3a4de22e2e669e1ed926b04447fc73034bb730f4932acd62727b75348a648a1128744657ca6a4e713b9b646c3ca66cac02cdab44dd3439890ef3aaf61708714f7375349b8da541b2548d452d84de7084bb95b3ac2345201d624d31f4d52078aa0fa05a88b4e20202bd2b86ac5b52919ea305a8949de95e935eed0319cf3cf19ebea61d76ba92532497fcdc9411d06bcd4275094d0a4a3c5d3a945e43305a5a9256e333e1f64dbca5fcd4e03a39b9012d197506e06f29339dfee3331995b21615337ae060233d39befea925cc262873e0530408e6990f1cbd233a150ef7b004ff6166c70c68d9f8c853c1abca640b8660db2921").unwrap());
2171 let onion_packet_5 = ChannelManager::encrypt_failure_packet(&onion_keys[0].shared_secret, &onion_packet_4.data[..]);
2172 assert_eq!(onion_packet_5.data, hex::decode("9c5add3963fc7f6ed7f148623c84134b5647e1306419dbe2174e523fa9e2fbed3a06a19f899145610741c83ad40b7712aefaddec8c6baf7325d92ea4ca4d1df8bce517f7e54554608bf2bd8071a4f52a7a2f7ffbb1413edad81eeea5785aa9d990f2865dc23b4bc3c301a94eec4eabebca66be5cf638f693ec256aec514620cc28ee4a94bd9565bc4d4962b9d3641d4278fb319ed2b84de5b665f307a2db0f7fbb757366067d88c50f7e829138fde4f78d39b5b5802f1b92a8a820865af5cc79f9f30bc3f461c66af95d13e5e1f0381c184572a91dee1c849048a647a1158cf884064deddbf1b0b88dfe2f791428d0ba0f6fb2f04e14081f69165ae66d9297c118f0907705c9c4954a199bae0bb96fad763d690e7daa6cfda59ba7f2c8d11448b604d12d").unwrap());
2175 fn confirm_transaction(chain: &chaininterface::ChainWatchInterfaceUtil, tx: &Transaction, chan_id: u32) {
2176 assert!(chain.does_match_tx(tx));
2177 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2178 chain.block_connected_checked(&header, 1, &[tx; 1], &[chan_id; 1]);
2180 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2181 chain.block_connected_checked(&header, i, &[tx; 0], &[0; 0]);
2186 feeest: Arc<test_utils::TestFeeEstimator>,
2187 chain_monitor: Arc<chaininterface::ChainWatchInterfaceUtil>,
2188 tx_broadcaster: Arc<test_utils::TestBroadcaster>,
2189 chan_monitor: Arc<test_utils::TestChannelMonitor>,
2191 node: Arc<ChannelManager>,
2195 static mut CHAN_COUNT: u32 = 0;
2196 fn create_chan_between_nodes(node_a: &Node, node_b: &Node) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
2197 node_a.node.create_channel(node_b.node.get_our_node_id(), 100000, 10001, 42).unwrap();
2199 let events_1 = node_a.node.get_and_clear_pending_events();
2200 assert_eq!(events_1.len(), 1);
2201 let accept_chan = match events_1[0] {
2202 Event::SendOpenChannel { ref node_id, ref msg } => {
2203 assert_eq!(*node_id, node_b.node.get_our_node_id());
2204 node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), msg).unwrap()
2206 _ => panic!("Unexpected event"),
2209 node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), &accept_chan).unwrap();
2211 let chan_id = unsafe { CHAN_COUNT };
2215 let events_2 = node_a.node.get_and_clear_pending_events();
2216 assert_eq!(events_2.len(), 1);
2218 Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
2219 assert_eq!(*channel_value_satoshis, 100000);
2220 assert_eq!(user_channel_id, 42);
2222 tx = Transaction { version: chan_id as u32, lock_time: 0, input: Vec::new(), output: vec![TxOut {
2223 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
2225 funding_output = OutPoint::new(Sha256dHash::from_data(&serialize(&tx).unwrap()[..]), 0);
2227 node_a.node.funding_transaction_generated(&temporary_channel_id, funding_output);
2228 let mut added_monitors = node_a.chan_monitor.added_monitors.lock().unwrap();
2229 assert_eq!(added_monitors.len(), 1);
2230 assert_eq!(added_monitors[0].0, funding_output);
2231 added_monitors.clear();
2233 _ => panic!("Unexpected event"),
2236 let events_3 = node_a.node.get_and_clear_pending_events();
2237 assert_eq!(events_3.len(), 1);
2238 let funding_signed = match events_3[0] {
2239 Event::SendFundingCreated { ref node_id, ref msg } => {
2240 assert_eq!(*node_id, node_b.node.get_our_node_id());
2241 let res = node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), msg).unwrap();
2242 let mut added_monitors = node_b.chan_monitor.added_monitors.lock().unwrap();
2243 assert_eq!(added_monitors.len(), 1);
2244 assert_eq!(added_monitors[0].0, funding_output);
2245 added_monitors.clear();
2248 _ => panic!("Unexpected event"),
2251 node_a.node.handle_funding_signed(&node_b.node.get_our_node_id(), &funding_signed).unwrap();
2253 let mut added_monitors = node_a.chan_monitor.added_monitors.lock().unwrap();
2254 assert_eq!(added_monitors.len(), 1);
2255 assert_eq!(added_monitors[0].0, funding_output);
2256 added_monitors.clear();
2259 let events_4 = node_a.node.get_and_clear_pending_events();
2260 assert_eq!(events_4.len(), 1);
2262 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
2263 assert_eq!(user_channel_id, 42);
2264 assert_eq!(*funding_txo, funding_output);
2266 _ => panic!("Unexpected event"),
2269 confirm_transaction(&node_a.chain_monitor, &tx, chan_id);
2270 let events_5 = node_a.node.get_and_clear_pending_events();
2271 assert_eq!(events_5.len(), 1);
2273 Event::SendFundingLocked { ref node_id, ref msg, ref announcement_sigs } => {
2274 assert_eq!(*node_id, node_b.node.get_our_node_id());
2275 assert!(announcement_sigs.is_none());
2276 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), msg).unwrap()
2278 _ => panic!("Unexpected event"),
2283 confirm_transaction(&node_b.chain_monitor, &tx, chan_id);
2284 let events_6 = node_b.node.get_and_clear_pending_events();
2285 assert_eq!(events_6.len(), 1);
2286 let as_announcement_sigs = match events_6[0] {
2287 Event::SendFundingLocked { ref node_id, ref msg, ref announcement_sigs } => {
2288 assert_eq!(*node_id, node_a.node.get_our_node_id());
2289 channel_id = msg.channel_id.clone();
2290 let as_announcement_sigs = node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), msg).unwrap().unwrap();
2291 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &(*announcement_sigs).clone().unwrap()).unwrap();
2292 as_announcement_sigs
2294 _ => panic!("Unexpected event"),
2297 let events_7 = node_a.node.get_and_clear_pending_events();
2298 assert_eq!(events_7.len(), 1);
2299 let (announcement, as_update) = match events_7[0] {
2300 Event::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
2303 _ => panic!("Unexpected event"),
2306 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_announcement_sigs).unwrap();
2307 let events_8 = node_b.node.get_and_clear_pending_events();
2308 assert_eq!(events_8.len(), 1);
2309 let bs_update = match events_8[0] {
2310 Event::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
2311 assert!(*announcement == *msg);
2314 _ => panic!("Unexpected event"),
2321 ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone(), channel_id, tx)
2324 fn create_announced_chan_between_nodes(nodes: &Vec<Node>, a: usize, b: usize) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
2325 let chan_announcement = create_chan_between_nodes(&nodes[a], &nodes[b]);
2327 assert!(node.router.handle_channel_announcement(&chan_announcement.0).unwrap());
2328 node.router.handle_channel_update(&chan_announcement.1).unwrap();
2329 node.router.handle_channel_update(&chan_announcement.2).unwrap();
2331 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
2334 fn close_channel(outbound_node: &Node, inbound_node: &Node, channel_id: &[u8; 32], funding_tx: Transaction, close_inbound_first: bool) -> (msgs::ChannelUpdate, msgs::ChannelUpdate) {
2335 let (node_a, broadcaster_a) = if close_inbound_first { (&inbound_node.node, &inbound_node.tx_broadcaster) } else { (&outbound_node.node, &outbound_node.tx_broadcaster) };
2336 let (node_b, broadcaster_b) = if close_inbound_first { (&outbound_node.node, &outbound_node.tx_broadcaster) } else { (&inbound_node.node, &inbound_node.tx_broadcaster) };
2339 node_a.close_channel(channel_id).unwrap();
2340 let events_1 = node_a.get_and_clear_pending_events();
2341 assert_eq!(events_1.len(), 1);
2342 let shutdown_a = match events_1[0] {
2343 Event::SendShutdown { ref node_id, ref msg } => {
2344 assert_eq!(node_id, &node_b.get_our_node_id());
2347 _ => panic!("Unexpected event"),
2350 let (shutdown_b, mut closing_signed_b) = node_b.handle_shutdown(&node_a.get_our_node_id(), &shutdown_a).unwrap();
2351 if !close_inbound_first {
2352 assert!(closing_signed_b.is_none());
2354 let (empty_a, mut closing_signed_a) = node_a.handle_shutdown(&node_b.get_our_node_id(), &shutdown_b.unwrap()).unwrap();
2355 assert!(empty_a.is_none());
2356 if close_inbound_first {
2357 assert!(closing_signed_a.is_none());
2358 closing_signed_a = node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap()).unwrap();
2359 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
2360 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
2362 let empty_b = node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap()).unwrap();
2363 assert!(empty_b.is_none());
2364 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
2365 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
2367 closing_signed_b = node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap()).unwrap();
2368 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
2369 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
2371 let empty_a2 = node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap()).unwrap();
2372 assert!(empty_a2.is_none());
2373 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
2374 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
2376 assert_eq!(tx_a, tx_b);
2377 let mut funding_tx_map = HashMap::new();
2378 funding_tx_map.insert(funding_tx.txid(), funding_tx);
2379 tx_a.verify(&funding_tx_map).unwrap();
2381 let events_2 = node_a.get_and_clear_pending_events();
2382 assert_eq!(events_2.len(), 1);
2383 let as_update = match events_2[0] {
2384 Event::BroadcastChannelUpdate { ref msg } => {
2387 _ => panic!("Unexpected event"),
2390 let events_3 = node_b.get_and_clear_pending_events();
2391 assert_eq!(events_3.len(), 1);
2392 let bs_update = match events_3[0] {
2393 Event::BroadcastChannelUpdate { ref msg } => {
2396 _ => panic!("Unexpected event"),
2399 (as_update, bs_update)
2404 msgs: Vec<msgs::UpdateAddHTLC>,
2405 commitment_msg: msgs::CommitmentSigned,
2408 fn from_event(event: Event) -> SendEvent {
2410 Event::SendHTLCs { node_id, msgs, commitment_msg } => {
2411 SendEvent { node_id: node_id, msgs: msgs, commitment_msg: commitment_msg }
2413 _ => panic!("Unexpected event type!"),
2418 static mut PAYMENT_COUNT: u8 = 0;
2419 fn send_along_route(origin_node: &Node, route: Route, expected_route: &[&Node], recv_value: u64) -> ([u8; 32], [u8; 32]) {
2420 let our_payment_preimage = unsafe { [PAYMENT_COUNT; 32] };
2421 unsafe { PAYMENT_COUNT += 1 };
2422 let our_payment_hash = {
2423 let mut sha = Sha256::new();
2424 sha.input(&our_payment_preimage[..]);
2425 let mut ret = [0; 32];
2426 sha.result(&mut ret);
2430 let mut payment_event = {
2431 origin_node.node.send_payment(route, our_payment_hash).unwrap();
2433 let mut added_monitors = origin_node.chan_monitor.added_monitors.lock().unwrap();
2434 assert_eq!(added_monitors.len(), 1);
2435 added_monitors.clear();
2438 let mut events = origin_node.node.get_and_clear_pending_events();
2439 assert_eq!(events.len(), 1);
2440 SendEvent::from_event(events.remove(0))
2442 let mut prev_node = origin_node;
2444 for (idx, &node) in expected_route.iter().enumerate() {
2445 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
2447 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
2449 let added_monitors = node.chan_monitor.added_monitors.lock().unwrap();
2450 assert_eq!(added_monitors.len(), 0);
2453 let revoke_and_ack = node.node.handle_commitment_signed(&prev_node.node.get_our_node_id(), &payment_event.commitment_msg).unwrap();
2455 let mut added_monitors = node.chan_monitor.added_monitors.lock().unwrap();
2456 assert_eq!(added_monitors.len(), 1);
2457 added_monitors.clear();
2459 assert!(prev_node.node.handle_revoke_and_ack(&node.node.get_our_node_id(), &revoke_and_ack.0).unwrap().is_none());
2460 let prev_revoke_and_ack = prev_node.node.handle_commitment_signed(&node.node.get_our_node_id(), &revoke_and_ack.1.unwrap()).unwrap();
2462 let mut added_monitors = prev_node.chan_monitor.added_monitors.lock().unwrap();
2463 assert_eq!(added_monitors.len(), 2);
2464 added_monitors.clear();
2466 assert!(node.node.handle_revoke_and_ack(&prev_node.node.get_our_node_id(), &prev_revoke_and_ack.0).unwrap().is_none());
2467 assert!(prev_revoke_and_ack.1.is_none());
2469 let mut added_monitors = node.chan_monitor.added_monitors.lock().unwrap();
2470 assert_eq!(added_monitors.len(), 1);
2471 added_monitors.clear();
2474 let events_1 = node.node.get_and_clear_pending_events();
2475 assert_eq!(events_1.len(), 1);
2477 Event::PendingHTLCsForwardable { .. } => { },
2478 _ => panic!("Unexpected event"),
2481 node.node.channel_state.lock().unwrap().next_forward = Instant::now();
2482 node.node.process_pending_htlc_forwards();
2484 let mut events_2 = node.node.get_and_clear_pending_events();
2485 assert_eq!(events_2.len(), 1);
2486 if idx == expected_route.len() - 1 {
2488 Event::PaymentReceived { ref payment_hash, amt } => {
2489 assert_eq!(our_payment_hash, *payment_hash);
2490 assert_eq!(amt, recv_value);
2492 _ => panic!("Unexpected event"),
2496 let mut added_monitors = node.chan_monitor.added_monitors.lock().unwrap();
2497 assert_eq!(added_monitors.len(), 1);
2498 added_monitors.clear();
2500 payment_event = SendEvent::from_event(events_2.remove(0));
2501 assert_eq!(payment_event.msgs.len(), 1);
2507 (our_payment_preimage, our_payment_hash)
2510 fn claim_payment(origin_node: &Node, expected_route: &[&Node], our_payment_preimage: [u8; 32]) {
2511 assert!(expected_route.last().unwrap().node.claim_funds(our_payment_preimage));
2513 let mut added_monitors = expected_route.last().unwrap().chan_monitor.added_monitors.lock().unwrap();
2514 assert_eq!(added_monitors.len(), 1);
2515 added_monitors.clear();
2518 let mut next_msgs: Option<(msgs::UpdateFulfillHTLC, msgs::CommitmentSigned)> = None;
2519 macro_rules! update_fulfill_dance {
2520 ($node: expr, $prev_node: expr, $last_node: expr) => {
2522 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0).unwrap();
2524 let mut added_monitors = $node.chan_monitor.added_monitors.lock().unwrap();
2526 assert_eq!(added_monitors.len(), 0);
2528 assert_eq!(added_monitors.len(), 1);
2530 added_monitors.clear();
2532 let revoke_and_commit = $node.node.handle_commitment_signed(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().1).unwrap();
2534 let mut added_monitors = $node.chan_monitor.added_monitors.lock().unwrap();
2535 assert_eq!(added_monitors.len(), 1);
2536 added_monitors.clear();
2538 assert!($prev_node.node.handle_revoke_and_ack(&$node.node.get_our_node_id(), &revoke_and_commit.0).unwrap().is_none());
2539 let revoke_and_ack = $prev_node.node.handle_commitment_signed(&$node.node.get_our_node_id(), &revoke_and_commit.1.unwrap()).unwrap();
2540 assert!(revoke_and_ack.1.is_none());
2542 let mut added_monitors = $prev_node.chan_monitor.added_monitors.lock().unwrap();
2543 assert_eq!(added_monitors.len(), 2);
2544 added_monitors.clear();
2546 assert!($node.node.handle_revoke_and_ack(&$prev_node.node.get_our_node_id(), &revoke_and_ack.0).unwrap().is_none());
2548 let mut added_monitors = $node.chan_monitor.added_monitors.lock().unwrap();
2549 assert_eq!(added_monitors.len(), 1);
2550 added_monitors.clear();
2556 let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
2557 let mut prev_node = expected_route.last().unwrap();
2558 for node in expected_route.iter().rev() {
2559 assert_eq!(expected_next_node, node.node.get_our_node_id());
2560 if next_msgs.is_some() {
2561 update_fulfill_dance!(node, prev_node, false);
2564 let events = node.node.get_and_clear_pending_events();
2565 assert_eq!(events.len(), 1);
2567 Event::SendFulfillHTLC { ref node_id, ref msg, ref commitment_msg } => {
2568 expected_next_node = node_id.clone();
2569 next_msgs = Some((msg.clone(), commitment_msg.clone()));
2571 _ => panic!("Unexpected event"),
2577 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2578 update_fulfill_dance!(origin_node, expected_route.first().unwrap(), true);
2580 let events = origin_node.node.get_and_clear_pending_events();
2581 assert_eq!(events.len(), 1);
2583 Event::PaymentSent { payment_preimage } => {
2584 assert_eq!(payment_preimage, our_payment_preimage);
2586 _ => panic!("Unexpected event"),
2590 const TEST_FINAL_CLTV: u32 = 32;
2592 fn route_payment(origin_node: &Node, expected_route: &[&Node], recv_value: u64) -> ([u8; 32], [u8; 32]) {
2593 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();
2594 assert_eq!(route.hops.len(), expected_route.len());
2595 for (node, hop) in expected_route.iter().zip(route.hops.iter()) {
2596 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2599 send_along_route(origin_node, route, expected_route, recv_value)
2602 fn route_over_limit(origin_node: &Node, expected_route: &[&Node], recv_value: u64) {
2603 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();
2604 assert_eq!(route.hops.len(), expected_route.len());
2605 for (node, hop) in expected_route.iter().zip(route.hops.iter()) {
2606 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2609 let our_payment_preimage = unsafe { [PAYMENT_COUNT; 32] };
2610 unsafe { PAYMENT_COUNT += 1 };
2611 let our_payment_hash = {
2612 let mut sha = Sha256::new();
2613 sha.input(&our_payment_preimage[..]);
2614 let mut ret = [0; 32];
2615 sha.result(&mut ret);
2619 let err = origin_node.node.send_payment(route, our_payment_hash).err().unwrap();
2620 assert_eq!(err.err, "Cannot send value that would put us over our max HTLC value in flight");
2623 fn send_payment(origin: &Node, expected_route: &[&Node], recv_value: u64) {
2624 let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
2625 claim_payment(&origin, expected_route, our_payment_preimage);
2628 fn fail_payment(origin_node: &Node, expected_route: &[&Node], our_payment_hash: [u8; 32]) {
2629 assert!(expected_route.last().unwrap().node.fail_htlc_backwards(&our_payment_hash));
2631 let mut added_monitors = expected_route.last().unwrap().chan_monitor.added_monitors.lock().unwrap();
2632 assert_eq!(added_monitors.len(), 1);
2633 added_monitors.clear();
2636 let mut next_msgs: Option<(msgs::UpdateFailHTLC, msgs::CommitmentSigned)> = None;
2637 macro_rules! update_fail_dance {
2638 ($node: expr, $prev_node: expr, $last_node: expr) => {
2640 $node.node.handle_update_fail_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0).unwrap();
2641 let revoke_and_commit = $node.node.handle_commitment_signed(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().1).unwrap();
2644 let mut added_monitors = $node.chan_monitor.added_monitors.lock().unwrap();
2645 assert_eq!(added_monitors.len(), 1);
2646 added_monitors.clear();
2648 assert!($prev_node.node.handle_revoke_and_ack(&$node.node.get_our_node_id(), &revoke_and_commit.0).unwrap().is_none());
2650 let mut added_monitors = $prev_node.chan_monitor.added_monitors.lock().unwrap();
2651 assert_eq!(added_monitors.len(), 1);
2652 added_monitors.clear();
2654 let revoke_and_ack = $prev_node.node.handle_commitment_signed(&$node.node.get_our_node_id(), &revoke_and_commit.1.unwrap()).unwrap();
2656 let mut added_monitors = $prev_node.chan_monitor.added_monitors.lock().unwrap();
2657 assert_eq!(added_monitors.len(), 1);
2658 added_monitors.clear();
2660 assert!(revoke_and_ack.1.is_none());
2661 assert!($node.node.get_and_clear_pending_events().is_empty());
2662 assert!($node.node.handle_revoke_and_ack(&$prev_node.node.get_our_node_id(), &revoke_and_ack.0).unwrap().is_none());
2664 let mut added_monitors = $node.chan_monitor.added_monitors.lock().unwrap();
2666 assert_eq!(added_monitors.len(), 1);
2668 assert_eq!(added_monitors.len(), 2);
2669 assert!(added_monitors[0].0 != added_monitors[1].0);
2671 added_monitors.clear();
2677 let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
2678 let mut prev_node = expected_route.last().unwrap();
2679 for node in expected_route.iter().rev() {
2680 assert_eq!(expected_next_node, node.node.get_our_node_id());
2681 if next_msgs.is_some() {
2682 update_fail_dance!(node, prev_node, false);
2685 let events = node.node.get_and_clear_pending_events();
2686 assert_eq!(events.len(), 1);
2688 Event::SendFailHTLC { ref node_id, ref msg, ref commitment_msg } => {
2689 expected_next_node = node_id.clone();
2690 next_msgs = Some((msg.clone(), commitment_msg.clone()));
2692 _ => panic!("Unexpected event"),
2698 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2699 update_fail_dance!(origin_node, expected_route.first().unwrap(), true);
2701 let events = origin_node.node.get_and_clear_pending_events();
2702 assert_eq!(events.len(), 1);
2704 Event::PaymentFailed { payment_hash } => {
2705 assert_eq!(payment_hash, our_payment_hash);
2707 _ => panic!("Unexpected event"),
2711 fn create_network(node_count: usize) -> Vec<Node> {
2712 let mut nodes = Vec::new();
2713 let mut rng = thread_rng();
2714 let secp_ctx = Secp256k1::new();
2715 let logger: Arc<Logger> = Arc::new(test_utils::TestLogger::new());
2717 for _ in 0..node_count {
2718 let feeest = Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 });
2719 let chain_monitor = Arc::new(chaininterface::ChainWatchInterfaceUtil::new(Arc::clone(&logger)));
2720 let tx_broadcaster = Arc::new(test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())});
2721 let chan_monitor = Arc::new(test_utils::TestChannelMonitor::new(chain_monitor.clone(), tx_broadcaster.clone()));
2723 let mut key_slice = [0; 32];
2724 rng.fill_bytes(&mut key_slice);
2725 SecretKey::from_slice(&secp_ctx, &key_slice).unwrap()
2727 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();
2728 let router = Router::new(PublicKey::from_secret_key(&secp_ctx, &node_id).unwrap(), Arc::clone(&logger));
2729 nodes.push(Node { feeest, chain_monitor, tx_broadcaster, chan_monitor, node_id, node, router });
2736 fn fake_network_test() {
2737 // Simple test which builds a network of ChannelManagers, connects them to each other, and
2738 // tests that payments get routed and transactions broadcast in semi-reasonable ways.
2739 let nodes = create_network(4);
2741 // Create some initial channels
2742 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
2743 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
2744 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3);
2746 // Rebalance the network a bit by relaying one payment through all the channels...
2747 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
2748 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
2749 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
2750 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
2752 // Send some more payments
2753 send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000);
2754 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000);
2755 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000);
2757 // Test failure packets
2758 let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
2759 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
2761 // Add a new channel that skips 3
2762 let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3);
2764 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000);
2765 send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000);
2766 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
2767 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
2768 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
2769 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
2770 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
2772 // Do some rebalance loop payments, simultaneously
2773 let mut hops = Vec::with_capacity(3);
2774 hops.push(RouteHop {
2775 pubkey: nodes[2].node.get_our_node_id(),
2776 short_channel_id: chan_2.0.contents.short_channel_id,
2778 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
2780 hops.push(RouteHop {
2781 pubkey: nodes[3].node.get_our_node_id(),
2782 short_channel_id: chan_3.0.contents.short_channel_id,
2784 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
2786 hops.push(RouteHop {
2787 pubkey: nodes[1].node.get_our_node_id(),
2788 short_channel_id: chan_4.0.contents.short_channel_id,
2790 cltv_expiry_delta: TEST_FINAL_CLTV,
2792 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;
2793 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;
2794 let payment_preimage_1 = send_along_route(&nodes[1], Route { hops }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
2796 let mut hops = Vec::with_capacity(3);
2797 hops.push(RouteHop {
2798 pubkey: nodes[3].node.get_our_node_id(),
2799 short_channel_id: chan_4.0.contents.short_channel_id,
2801 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
2803 hops.push(RouteHop {
2804 pubkey: nodes[2].node.get_our_node_id(),
2805 short_channel_id: chan_3.0.contents.short_channel_id,
2807 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
2809 hops.push(RouteHop {
2810 pubkey: nodes[1].node.get_our_node_id(),
2811 short_channel_id: chan_2.0.contents.short_channel_id,
2813 cltv_expiry_delta: TEST_FINAL_CLTV,
2815 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;
2816 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;
2817 let payment_hash_2 = send_along_route(&nodes[1], Route { hops }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
2819 // Claim the rebalances...
2820 fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
2821 claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1);
2823 // Add a duplicate new channel from 2 to 4
2824 let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3);
2826 // Send some payments across both channels
2827 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
2828 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
2829 let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
2831 route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
2833 //TODO: Test that routes work again here as we've been notified that the channel is full
2835 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3);
2836 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4);
2837 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5);
2839 // Close down the channels...
2840 close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
2841 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
2842 close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
2843 close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
2844 close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
2846 // Check that we processed all pending events
2848 assert_eq!(node.node.get_and_clear_pending_events().len(), 0);
2849 assert_eq!(node.chan_monitor.added_monitors.lock().unwrap().len(), 0);
2853 #[derive(PartialEq)]
2854 enum HTLCType { NONE, TIMEOUT, SUCCESS }
2855 fn test_txn_broadcast(node: &Node, chan: &(msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction), commitment_tx: Option<Transaction>, has_htlc_tx: HTLCType) -> Vec<Transaction> {
2856 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2857 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
2859 let mut res = Vec::with_capacity(2);
2861 if let Some(explicit_tx) = commitment_tx {
2862 res.push(explicit_tx.clone());
2864 for tx in node_txn.iter() {
2865 if tx.input.len() == 1 && tx.input[0].prev_hash == chan.3.txid() {
2866 let mut funding_tx_map = HashMap::new();
2867 funding_tx_map.insert(chan.3.txid(), chan.3.clone());
2868 tx.verify(&funding_tx_map).unwrap();
2869 res.push(tx.clone());
2873 assert_eq!(res.len(), 1);
2875 if has_htlc_tx != HTLCType::NONE {
2876 for tx in node_txn.iter() {
2877 if tx.input.len() == 1 && tx.input[0].prev_hash == res[0].txid() {
2878 let mut funding_tx_map = HashMap::new();
2879 funding_tx_map.insert(res[0].txid(), res[0].clone());
2880 tx.verify(&funding_tx_map).unwrap();
2881 if has_htlc_tx == HTLCType::TIMEOUT {
2882 assert!(tx.lock_time != 0);
2884 assert!(tx.lock_time == 0);
2886 res.push(tx.clone());
2890 assert_eq!(res.len(), 2);
2896 fn check_preimage_claim(node: &Node, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
2897 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2899 assert!(node_txn.len() >= 1);
2900 assert_eq!(node_txn[0].input.len(), 1);
2901 let mut found_prev = false;
2903 for tx in prev_txn {
2904 if node_txn[0].input[0].prev_hash == tx.txid() {
2905 let mut funding_tx_map = HashMap::new();
2906 funding_tx_map.insert(tx.txid(), tx.clone());
2907 node_txn[0].verify(&funding_tx_map).unwrap();
2909 assert!(node_txn[0].input[0].witness[2].len() > 106); // must spend an htlc output
2910 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
2916 assert!(found_prev);
2918 let mut res = Vec::new();
2919 mem::swap(&mut *node_txn, &mut res);
2923 fn get_announce_close_broadcast_events(nodes: &Vec<Node>, a: usize, b: usize) {
2924 let events_1 = nodes[a].node.get_and_clear_pending_events();
2925 assert_eq!(events_1.len(), 1);
2926 let as_update = match events_1[0] {
2927 Event::BroadcastChannelUpdate { ref msg } => {
2930 _ => panic!("Unexpected event"),
2933 let events_2 = nodes[b].node.get_and_clear_pending_events();
2934 assert_eq!(events_2.len(), 1);
2935 let bs_update = match events_2[0] {
2936 Event::BroadcastChannelUpdate { ref msg } => {
2939 _ => panic!("Unexpected event"),
2943 node.router.handle_channel_update(&as_update).unwrap();
2944 node.router.handle_channel_update(&bs_update).unwrap();
2949 fn channel_monitor_network_test() {
2950 // Simple test which builds a network of ChannelManagers, connects them to each other, and
2951 // tests that ChannelMonitor is able to recover from various states.
2952 let nodes = create_network(5);
2954 // Create some initial channels
2955 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
2956 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
2957 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3);
2958 let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4);
2960 // Rebalance the network a bit by relaying one payment through all the channels...
2961 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2962 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2963 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2964 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
2966 // Simple case with no pending HTLCs:
2967 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
2969 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
2970 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2971 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
2972 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
2974 get_announce_close_broadcast_events(&nodes, 0, 1);
2975 assert_eq!(nodes[0].node.list_channels().len(), 0);
2976 assert_eq!(nodes[1].node.list_channels().len(), 1);
2978 // One pending HTLC is discarded by the force-close:
2979 let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
2981 // Simple case of one pending HTLC to HTLC-Timeout
2982 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
2984 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
2985 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2986 nodes[2].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
2987 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
2989 get_announce_close_broadcast_events(&nodes, 1, 2);
2990 assert_eq!(nodes[1].node.list_channels().len(), 0);
2991 assert_eq!(nodes[2].node.list_channels().len(), 1);
2993 macro_rules! claim_funds {
2994 ($node: expr, $prev_node: expr, $preimage: expr) => {
2996 assert!($node.node.claim_funds($preimage));
2998 let mut added_monitors = $node.chan_monitor.added_monitors.lock().unwrap();
2999 assert_eq!(added_monitors.len(), 1);
3000 added_monitors.clear();
3003 let events = $node.node.get_and_clear_pending_events();
3004 assert_eq!(events.len(), 1);
3006 Event::SendFulfillHTLC { ref node_id, .. } => {
3007 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
3009 _ => panic!("Unexpected event"),
3015 // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
3016 // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
3017 nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
3019 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
3021 // Claim the payment on nodes[3], giving it knowledge of the preimage
3022 claim_funds!(nodes[3], nodes[2], payment_preimage_1);
3024 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3025 nodes[3].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[0].clone()] }, 1);
3027 check_preimage_claim(&nodes[3], &node_txn);
3029 get_announce_close_broadcast_events(&nodes, 2, 3);
3030 assert_eq!(nodes[2].node.list_channels().len(), 0);
3031 assert_eq!(nodes[3].node.list_channels().len(), 1);
3033 // One pending HTLC to time out:
3034 let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
3037 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3038 nodes[3].chain_monitor.block_connected_checked(&header, 1, &Vec::new()[..], &[0; 0]);
3039 for i in 2..TEST_FINAL_CLTV - 3 {
3040 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3041 nodes[3].chain_monitor.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
3044 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
3046 // Claim the payment on nodes[3], giving it knowledge of the preimage
3047 claim_funds!(nodes[4], nodes[3], payment_preimage_2);
3049 header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3050 nodes[4].chain_monitor.block_connected_checked(&header, 1, &Vec::new()[..], &[0; 0]);
3051 for i in 2..TEST_FINAL_CLTV - 3 {
3052 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3053 nodes[4].chain_monitor.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
3056 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
3058 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3059 nodes[4].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[0].clone()] }, TEST_FINAL_CLTV - 5);
3061 check_preimage_claim(&nodes[4], &node_txn);
3063 get_announce_close_broadcast_events(&nodes, 3, 4);
3064 assert_eq!(nodes[3].node.list_channels().len(), 0);
3065 assert_eq!(nodes[4].node.list_channels().len(), 0);
3067 // Create some new channels:
3068 let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1);
3070 // A pending HTLC which will be revoked:
3071 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
3072 // Get the will-be-revoked local txn from nodes[0]
3073 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.iter().next().unwrap().1.last_local_commitment_txn.clone();
3074 // Revoke the old state
3075 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
3078 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3079 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3081 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3082 assert_eq!(node_txn.len(), 2);
3083 assert_eq!(node_txn[0].input.len(), 1);
3085 let mut funding_tx_map = HashMap::new();
3086 funding_tx_map.insert(revoked_local_txn[0].txid(), revoked_local_txn[0].clone());
3087 node_txn[0].verify(&funding_tx_map).unwrap();
3088 node_txn.swap_remove(0);
3090 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
3092 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3093 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
3094 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3095 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
3097 //TODO: At this point nodes[1] should claim the revoked HTLC-Timeout output, but that's
3098 //not yet implemented in ChannelMonitor
3100 get_announce_close_broadcast_events(&nodes, 0, 1);
3101 assert_eq!(nodes[0].node.list_channels().len(), 0);
3102 assert_eq!(nodes[1].node.list_channels().len(), 0);
3104 // Check that we processed all pending events
3106 assert_eq!(node.node.get_and_clear_pending_events().len(), 0);
3107 assert_eq!(node.chan_monitor.added_monitors.lock().unwrap().len(), 0);
3112 fn test_unconf_chan() {
3113 // After creating a chan between nodes, we disconnect all blocks previously seen to force a channel close on nodes[0] side
3114 let nodes = create_network(2);
3115 create_announced_chan_between_nodes(&nodes, 0, 1);
3117 let channel_state = nodes[0].node.channel_state.lock().unwrap();
3118 assert_eq!(channel_state.by_id.len(), 1);
3119 assert_eq!(channel_state.short_to_id.len(), 1);
3120 mem::drop(channel_state);
3122 let mut headers = Vec::new();
3123 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3124 headers.push(header.clone());
3126 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3127 headers.push(header.clone());
3129 while !headers.is_empty() {
3130 nodes[0].node.block_disconnected(&headers.pop().unwrap());
3132 let channel_state = nodes[0].node.channel_state.lock().unwrap();
3133 assert_eq!(channel_state.by_id.len(), 0);
3134 assert_eq!(channel_state.short_to_id.len(), 0);