1 use bitcoin::blockdata::block::BlockHeader;
2 use bitcoin::blockdata::transaction::Transaction;
3 use bitcoin::blockdata::constants::genesis_block;
4 use bitcoin::network::constants::Network;
5 use bitcoin::network::serialize::BitcoinHash;
6 use bitcoin::util::hash::Sha256dHash;
8 use secp256k1::key::{SecretKey,PublicKey};
9 use secp256k1::{Secp256k1,Message};
10 use secp256k1::ecdh::SharedSecret;
13 use chain::chaininterface::{BroadcasterInterface,ChainListener,ChainWatchInterface,FeeEstimator};
14 use chain::transaction::OutPoint;
15 use ln::channel::{Channel, ChannelKeys};
16 use ln::channelmonitor::ManyChannelMonitor;
17 use ln::router::{Route,RouteHop};
19 use ln::msgs::{HandleError,ChannelMessageHandler,MsgEncodable,MsgDecodable};
20 use util::{byte_utils, events, internal_traits, rng};
21 use util::sha2::Sha256;
22 use util::chacha20poly1305rfc::ChaCha20;
23 use util::logger::Logger;
24 use util::errors::APIError;
27 use crypto::mac::{Mac,MacResult};
28 use crypto::hmac::Hmac;
29 use crypto::digest::Digest;
30 use crypto::symmetriccipher::SynchronousStreamCipher;
33 use std::collections::HashMap;
34 use std::collections::hash_map;
35 use std::sync::{Mutex,MutexGuard,Arc};
36 use std::sync::atomic::{AtomicUsize, Ordering};
37 use std::time::{Instant,Duration};
39 mod channel_held_info {
42 /// Stores the info we will need to send when we want to forward an HTLC onwards
43 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
44 pub struct PendingForwardHTLCInfo {
45 pub(super) onion_packet: Option<msgs::OnionPacket>,
46 pub(super) payment_hash: [u8; 32],
47 pub(super) short_channel_id: u64,
48 pub(super) prev_short_channel_id: u64,
49 pub(super) amt_to_forward: u64,
50 pub(super) outgoing_cltv_value: u32,
53 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
54 pub enum HTLCFailureMsg {
55 Relay(msgs::UpdateFailHTLC),
56 Malformed(msgs::UpdateFailMalformedHTLC),
59 /// Stores whether we can't forward an HTLC or relevant forwarding info
60 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
61 pub enum PendingHTLCStatus {
62 Forward(PendingForwardHTLCInfo),
66 #[cfg(feature = "fuzztarget")]
67 impl PendingHTLCStatus {
68 pub fn dummy() -> Self {
69 PendingHTLCStatus::Forward(PendingForwardHTLCInfo {
71 payment_hash: [0; 32],
73 prev_short_channel_id: 0,
75 outgoing_cltv_value: 0,
80 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
81 pub enum HTLCFailReason {
83 err: msgs::OnionErrorPacket,
91 #[cfg(feature = "fuzztarget")]
93 pub fn dummy() -> Self {
94 HTLCFailReason::Reason {
95 failure_code: 0, data: Vec::new(),
100 #[cfg(feature = "fuzztarget")]
101 pub use self::channel_held_info::*;
102 #[cfg(not(feature = "fuzztarget"))]
103 pub(crate) use self::channel_held_info::*;
105 enum PendingOutboundHTLC {
106 IntermediaryHopData {
107 source_short_channel_id: u64,
108 incoming_packet_shared_secret: SharedSecret,
112 session_priv: SecretKey,
114 /// Used for channel rebalancing
116 source_short_channel_id: u64,
117 incoming_packet_shared_secret: SharedSecret,
119 session_priv: SecretKey,
123 /// We hold back HTLCs we intend to relay for a random interval in the range (this, 5*this). This
124 /// provides some limited amount of privacy. Ideally this would range from somewhere like 1 second
125 /// to 30 seconds, but people expect lightning to be, you know, kinda fast, sadly. We could
126 /// probably increase this significantly.
127 const MIN_HTLC_RELAY_HOLDING_CELL_MILLIS: u32 = 50;
129 struct ChannelHolder {
130 by_id: HashMap<[u8; 32], Channel>,
131 short_to_id: HashMap<u64, [u8; 32]>,
132 next_forward: Instant,
133 /// short channel id -> forward infos. Key of 0 means payments received
134 /// Note that while this is held in the same mutex as the channels themselves, no consistency
135 /// guarantees are made about there existing a channel with the short id here, nor the short
136 /// ids in the PendingForwardHTLCInfo!
137 forward_htlcs: HashMap<u64, Vec<PendingForwardHTLCInfo>>,
138 /// Note that while this is held in the same mutex as the channels themselves, no consistency
139 /// guarantees are made about the channels given here actually existing anymore by the time you
141 claimable_htlcs: HashMap<[u8; 32], PendingOutboundHTLC>,
143 struct MutChannelHolder<'a> {
144 by_id: &'a mut HashMap<[u8; 32], Channel>,
145 short_to_id: &'a mut HashMap<u64, [u8; 32]>,
146 next_forward: &'a mut Instant,
147 forward_htlcs: &'a mut HashMap<u64, Vec<PendingForwardHTLCInfo>>,
148 claimable_htlcs: &'a mut HashMap<[u8; 32], PendingOutboundHTLC>,
151 fn borrow_parts(&mut self) -> MutChannelHolder {
153 by_id: &mut self.by_id,
154 short_to_id: &mut self.short_to_id,
155 next_forward: &mut self.next_forward,
156 forward_htlcs: &mut self.forward_htlcs,
157 claimable_htlcs: &mut self.claimable_htlcs,
162 #[cfg(not(any(target_pointer_width = "32", target_pointer_width = "64")))]
163 const ERR: () = "You need at least 32 bit pointers (well, usize, but we'll assume they're the same) for ChannelManager::latest_block_height";
165 /// Manager which keeps track of a number of channels and sends messages to the appropriate
166 /// channel, also tracking HTLC preimages and forwarding onion packets appropriately.
167 /// Implements ChannelMessageHandler, handling the multi-channel parts and passing things through
168 /// to individual Channels.
169 pub struct ChannelManager {
170 genesis_hash: Sha256dHash,
171 fee_estimator: Arc<FeeEstimator>,
172 monitor: Arc<ManyChannelMonitor>,
173 chain_monitor: Arc<ChainWatchInterface>,
174 tx_broadcaster: Arc<BroadcasterInterface>,
176 announce_channels_publicly: bool,
177 fee_proportional_millionths: u32,
178 latest_block_height: AtomicUsize,
179 secp_ctx: Secp256k1<secp256k1::All>,
181 channel_state: Mutex<ChannelHolder>,
182 our_network_key: SecretKey,
184 pending_events: Mutex<Vec<events::Event>>,
189 const CLTV_EXPIRY_DELTA: u16 = 6 * 24 * 2; //TODO?
191 macro_rules! secp_call {
192 ( $res: expr, $err_msg: expr, $action: expr ) => {
195 Err(_) => return Err(HandleError{err: $err_msg, action: Some($action)})
202 shared_secret: SharedSecret,
204 blinding_factor: [u8; 32],
205 ephemeral_pubkey: PublicKey,
210 pub struct ChannelDetails {
211 /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
212 /// thereafter this is the txid of the funding transaction xor the funding transaction output).
213 /// Note that this means this value is *not* persistent - it can change once during the
214 /// lifetime of the channel.
215 pub channel_id: [u8; 32],
216 /// The position of the funding transaction in the chain. None if the funding transaction has
217 /// not yet been confirmed and the channel fully opened.
218 pub short_channel_id: Option<u64>,
219 pub remote_network_id: PublicKey,
220 pub channel_value_satoshis: u64,
221 /// The user_id passed in to create_channel, or 0 if the channel was inbound.
225 impl ChannelManager {
226 /// Constructs a new ChannelManager to hold several channels and route between them. This is
227 /// the main "logic hub" for all channel-related actions, and implements ChannelMessageHandler.
228 /// fee_proportional_millionths is an optional fee to charge any payments routed through us.
229 /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
230 /// panics if channel_value_satoshis is >= `MAX_FUNDING_SATOSHIS`!
231 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> {
232 let secp_ctx = Secp256k1::new();
234 let res = Arc::new(ChannelManager {
235 genesis_hash: genesis_block(network).header.bitcoin_hash(),
236 fee_estimator: feeest.clone(),
237 monitor: monitor.clone(),
241 announce_channels_publicly,
242 fee_proportional_millionths,
243 latest_block_height: AtomicUsize::new(0), //TODO: Get an init value (generally need to replay recent chain on chain_monitor registration)
246 channel_state: Mutex::new(ChannelHolder{
247 by_id: HashMap::new(),
248 short_to_id: HashMap::new(),
249 next_forward: Instant::now(),
250 forward_htlcs: HashMap::new(),
251 claimable_htlcs: HashMap::new(),
255 pending_events: Mutex::new(Vec::new()),
259 let weak_res = Arc::downgrade(&res);
260 res.chain_monitor.register_listener(weak_res);
264 /// Creates a new outbound channel to the given remote node and with the given value.
265 /// user_id will be provided back as user_channel_id in FundingGenerationReady and
266 /// FundingBroadcastSafe events to allow tracking of which events correspond with which
267 /// create_channel call. Note that user_channel_id defaults to 0 for inbound channels, so you
268 /// may wish to avoid using 0 for user_id here.
269 /// If successful, will generate a SendOpenChannel event, so you should probably poll
270 /// PeerManager::process_events afterwards.
271 /// Raises APIError::APIMisuseError when channel_value_satoshis > 2**24 or push_msat being greater than channel_value_satoshis * 1k
272 pub fn create_channel(&self, their_network_key: PublicKey, channel_value_satoshis: u64, push_msat: u64, user_id: u64) -> Result<(), APIError> {
273 let chan_keys = if cfg!(feature = "fuzztarget") {
275 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(),
276 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(),
277 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(),
278 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(),
279 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(),
280 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(),
281 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(),
282 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],
285 let mut key_seed = [0u8; 32];
286 rng::fill_bytes(&mut key_seed);
287 match ChannelKeys::new_from_seed(&key_seed) {
289 Err(_) => panic!("RNG is busted!")
293 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))?;
294 let res = channel.get_open_channel(self.genesis_hash.clone(), &*self.fee_estimator)?;
295 let mut channel_state = self.channel_state.lock().unwrap();
296 match channel_state.by_id.insert(channel.channel_id(), channel) {
297 Some(_) => panic!("RNG is bad???"),
301 let mut events = self.pending_events.lock().unwrap();
302 events.push(events::Event::SendOpenChannel {
303 node_id: their_network_key,
309 /// Gets the list of open channels, in random order. See ChannelDetail field documentation for
310 /// more information.
311 pub fn list_channels(&self) -> Vec<ChannelDetails> {
312 let channel_state = self.channel_state.lock().unwrap();
313 let mut res = Vec::with_capacity(channel_state.by_id.len());
314 for (channel_id, channel) in channel_state.by_id.iter() {
315 res.push(ChannelDetails {
316 channel_id: (*channel_id).clone(),
317 short_channel_id: channel.get_short_channel_id(),
318 remote_network_id: channel.get_their_node_id(),
319 channel_value_satoshis: channel.get_value_satoshis(),
320 user_id: channel.get_user_id(),
326 /// Gets the list of usable channels, in random order. Useful as an argument to
327 /// Router::get_route to ensure non-announced channels are used.
328 pub fn list_usable_channels(&self) -> Vec<ChannelDetails> {
329 let channel_state = self.channel_state.lock().unwrap();
330 let mut res = Vec::with_capacity(channel_state.by_id.len());
331 for (channel_id, channel) in channel_state.by_id.iter() {
332 if channel.is_usable() {
333 res.push(ChannelDetails {
334 channel_id: (*channel_id).clone(),
335 short_channel_id: channel.get_short_channel_id(),
336 remote_network_id: channel.get_their_node_id(),
337 channel_value_satoshis: channel.get_value_satoshis(),
338 user_id: channel.get_user_id(),
345 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
346 /// will be accepted on the given channel, and after additional timeout/the closing of all
347 /// pending HTLCs, the channel will be closed on chain.
348 /// May generate a SendShutdown event on success, which should be relayed.
349 pub fn close_channel(&self, channel_id: &[u8; 32]) -> Result<(), HandleError> {
350 let (res, node_id, chan_option) = {
351 let mut channel_state_lock = self.channel_state.lock().unwrap();
352 let channel_state = channel_state_lock.borrow_parts();
353 match channel_state.by_id.entry(channel_id.clone()) {
354 hash_map::Entry::Occupied(mut chan_entry) => {
355 let res = chan_entry.get_mut().get_shutdown()?;
356 if chan_entry.get().is_shutdown() {
357 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
358 channel_state.short_to_id.remove(&short_id);
360 (res, chan_entry.get().get_their_node_id(), Some(chan_entry.remove_entry().1))
361 } else { (res, chan_entry.get().get_their_node_id(), None) }
363 hash_map::Entry::Vacant(_) => return Err(HandleError{err: "No such channel", action: None})
366 for payment_hash in res.1 {
367 // unknown_next_peer...I dunno who that is anymore....
368 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), &payment_hash, HTLCFailReason::Reason { failure_code: 0x4000 | 10, data: Vec::new() });
370 let chan_update = if let Some(chan) = chan_option {
371 if let Ok(update) = self.get_channel_update(&chan) {
376 let mut events = self.pending_events.lock().unwrap();
377 if let Some(update) = chan_update {
378 events.push(events::Event::BroadcastChannelUpdate {
382 events.push(events::Event::SendShutdown {
391 fn finish_force_close_channel(&self, shutdown_res: (Vec<Transaction>, Vec<[u8; 32]>)) {
392 let (local_txn, failed_htlcs) = shutdown_res;
393 for payment_hash in failed_htlcs {
394 // unknown_next_peer...I dunno who that is anymore....
395 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), &payment_hash, HTLCFailReason::Reason { failure_code: 0x4000 | 10, data: Vec::new() });
397 for tx in local_txn {
398 self.tx_broadcaster.broadcast_transaction(&tx);
400 //TODO: We need to have a way where outbound HTLC claims can result in us claiming the
401 //now-on-chain HTLC output for ourselves (and, thereafter, passing the HTLC backwards).
402 //TODO: We need to handle monitoring of pending offered HTLCs which just hit the chain and
403 //may be claimed, resulting in us claiming the inbound HTLCs (and back-failing after
404 //timeouts are hit and our claims confirm).
407 /// Force closes a channel, immediately broadcasting the latest local commitment transaction to
408 /// the chain and rejecting new HTLCs on the given channel.
409 pub fn force_close_channel(&self, channel_id: &[u8; 32]) {
411 let mut channel_state_lock = self.channel_state.lock().unwrap();
412 let channel_state = channel_state_lock.borrow_parts();
413 if let Some(chan) = channel_state.by_id.remove(channel_id) {
414 if let Some(short_id) = chan.get_short_channel_id() {
415 channel_state.short_to_id.remove(&short_id);
422 self.finish_force_close_channel(chan.force_shutdown());
423 let mut events = self.pending_events.lock().unwrap();
424 if let Ok(update) = self.get_channel_update(&chan) {
425 events.push(events::Event::BroadcastChannelUpdate {
431 /// Force close all channels, immediately broadcasting the latest local commitment transaction
432 /// for each to the chain and rejecting new HTLCs on each.
433 pub fn force_close_all_channels(&self) {
434 for chan in self.list_channels() {
435 self.force_close_channel(&chan.channel_id);
440 fn gen_rho_mu_from_shared_secret(shared_secret: &SharedSecret) -> ([u8; 32], [u8; 32]) {
442 let mut hmac = Hmac::new(Sha256::new(), &[0x72, 0x68, 0x6f]); // rho
443 hmac.input(&shared_secret[..]);
444 let mut res = [0; 32];
445 hmac.raw_result(&mut res);
449 let mut hmac = Hmac::new(Sha256::new(), &[0x6d, 0x75]); // mu
450 hmac.input(&shared_secret[..]);
451 let mut res = [0; 32];
452 hmac.raw_result(&mut res);
458 fn gen_um_from_shared_secret(shared_secret: &SharedSecret) -> [u8; 32] {
459 let mut hmac = Hmac::new(Sha256::new(), &[0x75, 0x6d]); // um
460 hmac.input(&shared_secret[..]);
461 let mut res = [0; 32];
462 hmac.raw_result(&mut res);
467 fn gen_ammag_from_shared_secret(shared_secret: &SharedSecret) -> [u8; 32] {
468 let mut hmac = Hmac::new(Sha256::new(), &[0x61, 0x6d, 0x6d, 0x61, 0x67]); // ammag
469 hmac.input(&shared_secret[..]);
470 let mut res = [0; 32];
471 hmac.raw_result(&mut res);
475 // can only fail if an intermediary hop has an invalid public key or session_priv is invalid
477 fn construct_onion_keys_callback<T: secp256k1::Signing, FType: FnMut(SharedSecret, [u8; 32], PublicKey, &RouteHop)> (secp_ctx: &Secp256k1<T>, route: &Route, session_priv: &SecretKey, mut callback: FType) -> Result<(), secp256k1::Error> {
478 let mut blinded_priv = session_priv.clone();
479 let mut blinded_pub = PublicKey::from_secret_key(secp_ctx, &blinded_priv);
480 let mut first_iteration = true;
482 for hop in route.hops.iter() {
483 let shared_secret = SharedSecret::new(secp_ctx, &hop.pubkey, &blinded_priv);
485 let mut sha = Sha256::new();
486 sha.input(&blinded_pub.serialize()[..]);
487 sha.input(&shared_secret[..]);
488 let mut blinding_factor = [0u8; 32];
489 sha.result(&mut blinding_factor);
492 blinded_pub = PublicKey::from_secret_key(secp_ctx, &blinded_priv);
493 first_iteration = false;
495 let ephemeral_pubkey = blinded_pub;
497 blinded_priv.mul_assign(secp_ctx, &SecretKey::from_slice(secp_ctx, &blinding_factor)?)?;
498 blinded_pub = PublicKey::from_secret_key(secp_ctx, &blinded_priv);
500 callback(shared_secret, blinding_factor, ephemeral_pubkey, hop);
506 // can only fail if an intermediary hop has an invalid public key or session_priv is invalid
507 fn construct_onion_keys<T: secp256k1::Signing>(secp_ctx: &Secp256k1<T>, route: &Route, session_priv: &SecretKey) -> Result<Vec<OnionKeys>, secp256k1::Error> {
508 let mut res = Vec::with_capacity(route.hops.len());
510 Self::construct_onion_keys_callback(secp_ctx, route, session_priv, |shared_secret, _blinding_factor, ephemeral_pubkey, _| {
511 let (rho, mu) = ChannelManager::gen_rho_mu_from_shared_secret(&shared_secret);
517 blinding_factor: _blinding_factor,
527 /// returns the hop data, as well as the first-hop value_msat and CLTV value we should send.
528 fn build_onion_payloads(route: &Route, starting_htlc_offset: u32) -> Result<(Vec<msgs::OnionHopData>, u64, u32), HandleError> {
529 let mut cur_value_msat = 0u64;
530 let mut cur_cltv = starting_htlc_offset;
531 let mut last_short_channel_id = 0;
532 let mut res: Vec<msgs::OnionHopData> = Vec::with_capacity(route.hops.len());
533 internal_traits::test_no_dealloc::<msgs::OnionHopData>(None);
534 unsafe { res.set_len(route.hops.len()); }
536 for (idx, hop) in route.hops.iter().enumerate().rev() {
537 // First hop gets special values so that it can check, on receipt, that everything is
538 // exactly as it should be (and the next hop isn't trying to probe to find out if we're
539 // the intended recipient).
540 let value_msat = if cur_value_msat == 0 { hop.fee_msat } else { cur_value_msat };
541 let cltv = if cur_cltv == starting_htlc_offset { hop.cltv_expiry_delta + starting_htlc_offset } else { cur_cltv };
542 res[idx] = msgs::OnionHopData {
544 data: msgs::OnionRealm0HopData {
545 short_channel_id: last_short_channel_id,
546 amt_to_forward: value_msat,
547 outgoing_cltv_value: cltv,
551 cur_value_msat += hop.fee_msat;
552 if cur_value_msat >= 21000000 * 100000000 * 1000 {
553 return Err(HandleError{err: "Channel fees overflowed?!", action: None});
555 cur_cltv += hop.cltv_expiry_delta as u32;
556 if cur_cltv >= 500000000 {
557 return Err(HandleError{err: "Channel CLTV overflowed?!", action: None});
559 last_short_channel_id = hop.short_channel_id;
561 Ok((res, cur_value_msat, cur_cltv))
565 fn shift_arr_right(arr: &mut [u8; 20*65]) {
567 ptr::copy(arr[0..].as_ptr(), arr[65..].as_mut_ptr(), 19*65);
575 fn xor_bufs(dst: &mut[u8], src: &[u8]) {
576 assert_eq!(dst.len(), src.len());
578 for i in 0..dst.len() {
583 const ZERO:[u8; 21*65] = [0; 21*65];
584 fn construct_onion_packet(mut payloads: Vec<msgs::OnionHopData>, onion_keys: Vec<OnionKeys>, associated_data: &[u8; 32]) -> Result<msgs::OnionPacket, HandleError> {
585 let mut buf = Vec::with_capacity(21*65);
586 buf.resize(21*65, 0);
589 let iters = payloads.len() - 1;
590 let end_len = iters * 65;
591 let mut res = Vec::with_capacity(end_len);
592 res.resize(end_len, 0);
594 for (i, keys) in onion_keys.iter().enumerate() {
595 if i == payloads.len() - 1 { continue; }
596 let mut chacha = ChaCha20::new(&keys.rho, &[0u8; 8]);
597 chacha.process(&ChannelManager::ZERO, &mut buf); // We don't have a seek function :(
598 ChannelManager::xor_bufs(&mut res[0..(i + 1)*65], &buf[(20 - i)*65..21*65]);
603 let mut packet_data = [0; 20*65];
604 let mut hmac_res = [0; 32];
606 for (i, (payload, keys)) in payloads.iter_mut().zip(onion_keys.iter()).rev().enumerate() {
607 ChannelManager::shift_arr_right(&mut packet_data);
608 payload.hmac = hmac_res;
609 packet_data[0..65].copy_from_slice(&payload.encode()[..]);
611 let mut chacha = ChaCha20::new(&keys.rho, &[0u8; 8]);
612 chacha.process(&packet_data, &mut buf[0..20*65]);
613 packet_data[..].copy_from_slice(&buf[0..20*65]);
616 packet_data[20*65 - filler.len()..20*65].copy_from_slice(&filler[..]);
619 let mut hmac = Hmac::new(Sha256::new(), &keys.mu);
620 hmac.input(&packet_data);
621 hmac.input(&associated_data[..]);
622 hmac.raw_result(&mut hmac_res);
625 Ok(msgs::OnionPacket{
627 public_key: Ok(onion_keys.first().unwrap().ephemeral_pubkey),
628 hop_data: packet_data,
633 /// Encrypts a failure packet. raw_packet can either be a
634 /// msgs::DecodedOnionErrorPacket.encode() result or a msgs::OnionErrorPacket.data element.
635 fn encrypt_failure_packet(shared_secret: &SharedSecret, raw_packet: &[u8]) -> msgs::OnionErrorPacket {
636 let ammag = ChannelManager::gen_ammag_from_shared_secret(&shared_secret);
638 let mut packet_crypted = Vec::with_capacity(raw_packet.len());
639 packet_crypted.resize(raw_packet.len(), 0);
640 let mut chacha = ChaCha20::new(&ammag, &[0u8; 8]);
641 chacha.process(&raw_packet, &mut packet_crypted[..]);
642 msgs::OnionErrorPacket {
643 data: packet_crypted,
647 fn build_failure_packet(shared_secret: &SharedSecret, failure_type: u16, failure_data: &[u8]) -> msgs::DecodedOnionErrorPacket {
648 assert!(failure_data.len() <= 256 - 2);
650 let um = ChannelManager::gen_um_from_shared_secret(&shared_secret);
653 let mut res = Vec::with_capacity(2 + failure_data.len());
654 res.push(((failure_type >> 8) & 0xff) as u8);
655 res.push(((failure_type >> 0) & 0xff) as u8);
656 res.extend_from_slice(&failure_data[..]);
660 let mut res = Vec::with_capacity(256 - 2 - failure_data.len());
661 res.resize(256 - 2 - failure_data.len(), 0);
664 let mut packet = msgs::DecodedOnionErrorPacket {
666 failuremsg: failuremsg,
670 let mut hmac = Hmac::new(Sha256::new(), &um);
671 hmac.input(&packet.encode()[32..]);
672 hmac.raw_result(&mut packet.hmac);
678 fn build_first_hop_failure_packet(shared_secret: &SharedSecret, failure_type: u16, failure_data: &[u8]) -> msgs::OnionErrorPacket {
679 let failure_packet = ChannelManager::build_failure_packet(shared_secret, failure_type, failure_data);
680 ChannelManager::encrypt_failure_packet(shared_secret, &failure_packet.encode()[..])
683 fn decode_update_add_htlc_onion(&self, msg: &msgs::UpdateAddHTLC) -> (PendingHTLCStatus, Option<SharedSecret>, MutexGuard<ChannelHolder>) {
684 macro_rules! get_onion_hash {
687 let mut sha = Sha256::new();
688 sha.input(&msg.onion_routing_packet.hop_data);
689 let mut onion_hash = [0; 32];
690 sha.result(&mut onion_hash);
696 if let Err(_) = msg.onion_routing_packet.public_key {
697 log_info!(self, "Failed to accept/forward incoming HTLC with invalid ephemeral pubkey");
698 return (PendingHTLCStatus::Fail(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
699 channel_id: msg.channel_id,
700 htlc_id: msg.htlc_id,
701 sha256_of_onion: get_onion_hash!(),
702 failure_code: 0x8000 | 0x4000 | 6,
703 })), None, self.channel_state.lock().unwrap());
706 let shared_secret = SharedSecret::new(&self.secp_ctx, &msg.onion_routing_packet.public_key.unwrap(), &self.our_network_key);
707 let (rho, mu) = ChannelManager::gen_rho_mu_from_shared_secret(&shared_secret);
709 let mut channel_state = None;
710 macro_rules! return_err {
711 ($msg: expr, $err_code: expr, $data: expr) => {
713 log_info!(self, "Failed to accept/forward incoming HTLC: {}", $msg);
714 if channel_state.is_none() {
715 channel_state = Some(self.channel_state.lock().unwrap());
717 return (PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
718 channel_id: msg.channel_id,
719 htlc_id: msg.htlc_id,
720 reason: ChannelManager::build_first_hop_failure_packet(&shared_secret, $err_code, $data),
721 })), Some(shared_secret), channel_state.unwrap());
726 if msg.onion_routing_packet.version != 0 {
727 //TODO: Spec doesn't indicate if we should only hash hop_data here (and in other
728 //sha256_of_onion error data packets), or the entire onion_routing_packet. Either way,
729 //the hash doesn't really serve any purpuse - in the case of hashing all data, the
730 //receiving node would have to brute force to figure out which version was put in the
731 //packet by the node that send us the message, in the case of hashing the hop_data, the
732 //node knows the HMAC matched, so they already know what is there...
733 return_err!("Unknown onion packet version", 0x8000 | 0x4000 | 4, &get_onion_hash!());
736 let mut hmac = Hmac::new(Sha256::new(), &mu);
737 hmac.input(&msg.onion_routing_packet.hop_data);
738 hmac.input(&msg.payment_hash);
739 if hmac.result() != MacResult::new(&msg.onion_routing_packet.hmac) {
740 return_err!("HMAC Check failed", 0x8000 | 0x4000 | 5, &get_onion_hash!());
743 let mut chacha = ChaCha20::new(&rho, &[0u8; 8]);
744 let next_hop_data = {
745 let mut decoded = [0; 65];
746 chacha.process(&msg.onion_routing_packet.hop_data[0..65], &mut decoded);
747 match msgs::OnionHopData::decode(&decoded[..]) {
749 let error_code = match err {
750 msgs::DecodeError::UnknownRealmByte => 0x4000 | 1,
751 _ => 0x2000 | 2, // Should never happen
753 return_err!("Unable to decode our hop data", error_code, &[0;0]);
759 //TODO: Check that msg.cltv_expiry is within acceptable bounds!
761 let pending_forward_info = if next_hop_data.hmac == [0; 32] {
763 if next_hop_data.data.amt_to_forward != msg.amount_msat {
764 return_err!("Upstream node sent less than we were supposed to receive in payment", 19, &byte_utils::be64_to_array(msg.amount_msat));
766 if next_hop_data.data.outgoing_cltv_value != msg.cltv_expiry {
767 return_err!("Upstream node set CLTV to the wrong value", 18, &byte_utils::be32_to_array(msg.cltv_expiry));
770 // Note that we could obviously respond immediately with an update_fulfill_htlc
771 // message, however that would leak that we are the recipient of this payment, so
772 // instead we stay symmetric with the forwarding case, only responding (after a
773 // delay) once they've send us a commitment_signed!
775 PendingHTLCStatus::Forward(PendingForwardHTLCInfo {
777 payment_hash: msg.payment_hash.clone(),
779 prev_short_channel_id: 0,
780 amt_to_forward: next_hop_data.data.amt_to_forward,
781 outgoing_cltv_value: next_hop_data.data.outgoing_cltv_value,
784 let mut new_packet_data = [0; 20*65];
785 chacha.process(&msg.onion_routing_packet.hop_data[65..], &mut new_packet_data[0..19*65]);
786 chacha.process(&ChannelManager::ZERO[0..65], &mut new_packet_data[19*65..]);
788 let mut new_pubkey = msg.onion_routing_packet.public_key.unwrap();
790 let blinding_factor = {
791 let mut sha = Sha256::new();
792 sha.input(&new_pubkey.serialize()[..]);
793 sha.input(&shared_secret[..]);
794 let mut res = [0u8; 32];
795 sha.result(&mut res);
796 match SecretKey::from_slice(&self.secp_ctx, &res) {
798 return_err!("Blinding factor is an invalid private key", 0x8000 | 0x4000 | 6, &get_onion_hash!());
804 if let Err(_) = new_pubkey.mul_assign(&self.secp_ctx, &blinding_factor) {
805 return_err!("New blinding factor is an invalid private key", 0x8000 | 0x4000 | 6, &get_onion_hash!());
808 let outgoing_packet = msgs::OnionPacket {
810 public_key: Ok(new_pubkey),
811 hop_data: new_packet_data,
812 hmac: next_hop_data.hmac.clone(),
815 PendingHTLCStatus::Forward(PendingForwardHTLCInfo {
816 onion_packet: Some(outgoing_packet),
817 payment_hash: msg.payment_hash.clone(),
818 short_channel_id: next_hop_data.data.short_channel_id,
819 prev_short_channel_id: 0,
820 amt_to_forward: next_hop_data.data.amt_to_forward,
821 outgoing_cltv_value: next_hop_data.data.outgoing_cltv_value,
825 channel_state = Some(self.channel_state.lock().unwrap());
826 if let &PendingHTLCStatus::Forward(PendingForwardHTLCInfo { ref onion_packet, ref short_channel_id, ref amt_to_forward, ref outgoing_cltv_value, .. }) = &pending_forward_info {
827 if onion_packet.is_some() { // If short_channel_id is 0 here, we'll reject them in the body here
828 let id_option = channel_state.as_ref().unwrap().short_to_id.get(&short_channel_id).cloned();
829 let forwarding_id = match id_option {
831 return_err!("Don't have available channel for forwarding as requested.", 0x4000 | 10, &[0;0]);
833 Some(id) => id.clone(),
835 if let Some((err, code, chan_update)) = {
836 let chan = channel_state.as_mut().unwrap().by_id.get_mut(&forwarding_id).unwrap();
838 Some(("Forwarding channel is not in a ready state.", 0x1000 | 7, self.get_channel_update(chan).unwrap()))
840 let fee = amt_to_forward.checked_mul(self.fee_proportional_millionths as u64).and_then(|prop_fee| { (prop_fee / 1000000).checked_add(chan.get_our_fee_base_msat(&*self.fee_estimator) as u64) });
841 if fee.is_none() || msg.amount_msat < fee.unwrap() || (msg.amount_msat - fee.unwrap()) < *amt_to_forward {
842 Some(("Prior hop has deviated from specified fees parameters or origin node has obsolete ones", 0x1000 | 12, self.get_channel_update(chan).unwrap()))
844 if (msg.cltv_expiry as u64) < (*outgoing_cltv_value) as u64 + CLTV_EXPIRY_DELTA as u64 {
845 Some(("Forwarding node has tampered with the intended HTLC values or origin node has an obsolete cltv_expiry_delta", 0x1000 | 13, self.get_channel_update(chan).unwrap()))
852 return_err!(err, code, &chan_update.encode_with_len()[..]);
857 (pending_forward_info, Some(shared_secret), channel_state.unwrap())
860 /// only fails if the channel does not yet have an assigned short_id
861 fn get_channel_update(&self, chan: &Channel) -> Result<msgs::ChannelUpdate, HandleError> {
862 let short_channel_id = match chan.get_short_channel_id() {
863 None => return Err(HandleError{err: "Channel not yet established", action: None}),
867 let were_node_one = PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key).serialize()[..] < chan.get_their_node_id().serialize()[..];
869 let unsigned = msgs::UnsignedChannelUpdate {
870 chain_hash: self.genesis_hash,
871 short_channel_id: short_channel_id,
872 timestamp: chan.get_channel_update_count(),
873 flags: (!were_node_one) as u16 | ((!chan.is_live() as u16) << 1),
874 cltv_expiry_delta: CLTV_EXPIRY_DELTA,
875 htlc_minimum_msat: chan.get_our_htlc_minimum_msat(),
876 fee_base_msat: chan.get_our_fee_base_msat(&*self.fee_estimator),
877 fee_proportional_millionths: self.fee_proportional_millionths,
878 excess_data: Vec::new(),
881 let msg_hash = Sha256dHash::from_data(&unsigned.encode()[..]);
882 let sig = self.secp_ctx.sign(&Message::from_slice(&msg_hash[..]).unwrap(), &self.our_network_key); //TODO Can we unwrap here?
884 Ok(msgs::ChannelUpdate {
890 /// Sends a payment along a given route.
891 /// Value parameters are provided via the last hop in route, see documentation for RouteHop
892 /// fields for more info.
893 /// Note that if the payment_hash already exists elsewhere (eg you're sending a duplicative
894 /// payment), we don't do anything to stop you! We always try to ensure that if the provided
895 /// next hop knows the preimage to payment_hash they can claim an additional amount as
896 /// specified in the last hop in the route! Thus, you should probably do your own
897 /// payment_preimage tracking (which you should already be doing as they represent "proof of
898 /// payment") and prevent double-sends yourself.
899 /// See-also docs on Channel::send_htlc_and_commit.
900 /// May generate a SendHTLCs event on success, which should be relayed.
901 pub fn send_payment(&self, route: Route, payment_hash: [u8; 32]) -> Result<(), HandleError> {
902 if route.hops.len() < 1 || route.hops.len() > 20 {
903 return Err(HandleError{err: "Route didn't go anywhere/had bogus size", action: None});
905 let our_node_id = self.get_our_node_id();
906 for (idx, hop) in route.hops.iter().enumerate() {
907 if idx != route.hops.len() - 1 && hop.pubkey == our_node_id {
908 return Err(HandleError{err: "Route went through us but wasn't a simple rebalance loop to us", action: None});
912 let session_priv = SecretKey::from_slice(&self.secp_ctx, &{
913 let mut session_key = [0; 32];
914 rng::fill_bytes(&mut session_key);
916 }).expect("RNG is bad!");
918 let cur_height = self.latest_block_height.load(Ordering::Acquire) as u32 + 1;
920 //TODO: This should return something other than HandleError, that's really intended for
922 let onion_keys = secp_call!(ChannelManager::construct_onion_keys(&self.secp_ctx, &route, &session_priv), "Pubkey along hop was maliciously selected", msgs::ErrorAction::IgnoreError);
923 let (onion_payloads, htlc_msat, htlc_cltv) = ChannelManager::build_onion_payloads(&route, cur_height)?;
924 let onion_packet = ChannelManager::construct_onion_packet(onion_payloads, onion_keys, &payment_hash)?;
926 let (first_hop_node_id, (update_add, commitment_signed, chan_monitor)) = {
927 let mut channel_state_lock = self.channel_state.lock().unwrap();
928 let channel_state = channel_state_lock.borrow_parts();
930 let id = match channel_state.short_to_id.get(&route.hops.first().unwrap().short_channel_id) {
931 None => return Err(HandleError{err: "No channel available with first hop!", action: None}),
932 Some(id) => id.clone()
935 let claimable_htlc_entry = channel_state.claimable_htlcs.entry(payment_hash.clone());
936 if let hash_map::Entry::Occupied(_) = claimable_htlc_entry {
937 return Err(HandleError{err: "Already had pending HTLC with the same payment_hash", action: None});
941 let chan = channel_state.by_id.get_mut(&id).unwrap();
942 if chan.get_their_node_id() != route.hops.first().unwrap().pubkey {
943 return Err(HandleError{err: "Node ID mismatch on first hop!", action: None});
945 chan.send_htlc_and_commit(htlc_msat, payment_hash, htlc_cltv, onion_packet)?
948 let first_hop_node_id = route.hops.first().unwrap().pubkey;
950 claimable_htlc_entry.or_insert(PendingOutboundHTLC::OutboundRoute {
956 Some(msgs) => (first_hop_node_id, msgs),
957 None => return Ok(()),
961 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
962 unimplemented!(); // maybe remove from claimable_htlcs?
965 let mut events = self.pending_events.lock().unwrap();
966 events.push(events::Event::UpdateHTLCs {
967 node_id: first_hop_node_id,
968 updates: msgs::CommitmentUpdate {
969 update_add_htlcs: vec![update_add],
970 update_fulfill_htlcs: Vec::new(),
971 update_fail_htlcs: Vec::new(),
972 update_fail_malformed_htlcs: Vec::new(),
979 /// Call this upon creation of a funding transaction for the given channel.
980 /// Panics if a funding transaction has already been provided for this channel.
981 /// May panic if the funding_txo is duplicative with some other channel (note that this should
982 /// be trivially prevented by using unique funding transaction keys per-channel).
983 pub fn funding_transaction_generated(&self, temporary_channel_id: &[u8; 32], funding_txo: OutPoint) {
985 macro_rules! add_pending_event {
988 let mut pending_events = self.pending_events.lock().unwrap();
989 pending_events.push($event);
994 let (chan, msg, chan_monitor) = {
995 let mut channel_state = self.channel_state.lock().unwrap();
996 match channel_state.by_id.remove(temporary_channel_id) {
998 match chan.get_outbound_funding_created(funding_txo) {
1000 (chan, funding_msg.0, funding_msg.1)
1003 log_error!(self, "Got bad signatures: {}!", e.err);
1004 mem::drop(channel_state);
1005 add_pending_event!(events::Event::HandleError {
1006 node_id: chan.get_their_node_id(),
1015 }; // Release channel lock for install_watch_outpoint call,
1016 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1017 unimplemented!(); // maybe remove from claimable_htlcs?
1019 add_pending_event!(events::Event::SendFundingCreated {
1020 node_id: chan.get_their_node_id(),
1024 let mut channel_state = self.channel_state.lock().unwrap();
1025 match channel_state.by_id.entry(chan.channel_id()) {
1026 hash_map::Entry::Occupied(_) => {
1027 panic!("Generated duplicate funding txid?");
1029 hash_map::Entry::Vacant(e) => {
1035 fn get_announcement_sigs(&self, chan: &Channel) -> Option<msgs::AnnouncementSignatures> {
1036 if !chan.should_announce() { return None }
1038 let (announcement, our_bitcoin_sig) = match chan.get_channel_announcement(self.get_our_node_id(), self.genesis_hash.clone()) {
1040 Err(_) => return None, // Only in case of state precondition violations eg channel is closing
1042 let msghash = Message::from_slice(&Sha256dHash::from_data(&announcement.encode()[..])[..]).unwrap();
1043 let our_node_sig = self.secp_ctx.sign(&msghash, &self.our_network_key);
1045 Some(msgs::AnnouncementSignatures {
1046 channel_id: chan.channel_id(),
1047 short_channel_id: chan.get_short_channel_id().unwrap(),
1048 node_signature: our_node_sig,
1049 bitcoin_signature: our_bitcoin_sig,
1053 /// Processes HTLCs which are pending waiting on random forward delay.
1054 /// Should only really ever be called in response to an PendingHTLCsForwardable event.
1055 /// Will likely generate further events.
1056 pub fn process_pending_htlc_forwards(&self) {
1057 let mut new_events = Vec::new();
1058 let mut failed_forwards = Vec::new();
1060 let mut channel_state_lock = self.channel_state.lock().unwrap();
1061 let channel_state = channel_state_lock.borrow_parts();
1063 if cfg!(not(feature = "fuzztarget")) && Instant::now() < *channel_state.next_forward {
1067 for (short_chan_id, pending_forwards) in channel_state.forward_htlcs.drain() {
1068 if short_chan_id != 0 {
1069 let forward_chan_id = match channel_state.short_to_id.get(&short_chan_id) {
1070 Some(chan_id) => chan_id.clone(),
1072 failed_forwards.reserve(pending_forwards.len());
1073 for forward_info in pending_forwards {
1074 failed_forwards.push((forward_info.payment_hash, 0x4000 | 10, None));
1079 let forward_chan = &mut channel_state.by_id.get_mut(&forward_chan_id).unwrap();
1081 let mut add_htlc_msgs = Vec::new();
1082 for forward_info in pending_forwards {
1083 match forward_chan.send_htlc(forward_info.amt_to_forward, forward_info.payment_hash, forward_info.outgoing_cltv_value, forward_info.onion_packet.unwrap()) {
1085 let chan_update = self.get_channel_update(forward_chan).unwrap();
1086 failed_forwards.push((forward_info.payment_hash, 0x1000 | 7, Some(chan_update)));
1091 Some(msg) => { add_htlc_msgs.push(msg); },
1093 // Nothing to do here...we're waiting on a remote
1094 // revoke_and_ack before we can add anymore HTLCs. The Channel
1095 // will automatically handle building the update_add_htlc and
1096 // commitment_signed messages when we can.
1097 // TODO: Do some kind of timer to set the channel as !is_live()
1098 // as we don't really want others relying on us relaying through
1099 // this channel currently :/.
1106 if !add_htlc_msgs.is_empty() {
1107 let (commitment_msg, monitor) = match forward_chan.send_commitment() {
1110 //TODO: Handle...this is bad!
1114 new_events.push((Some(monitor), events::Event::UpdateHTLCs {
1115 node_id: forward_chan.get_their_node_id(),
1116 updates: msgs::CommitmentUpdate {
1117 update_add_htlcs: add_htlc_msgs,
1118 update_fulfill_htlcs: Vec::new(),
1119 update_fail_htlcs: Vec::new(),
1120 update_fail_malformed_htlcs: Vec::new(),
1121 commitment_signed: commitment_msg,
1126 for forward_info in pending_forwards {
1127 new_events.push((None, events::Event::PaymentReceived {
1128 payment_hash: forward_info.payment_hash,
1129 amt: forward_info.amt_to_forward,
1136 for failed_forward in failed_forwards.drain(..) {
1137 match failed_forward.2 {
1138 None => self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), &failed_forward.0, HTLCFailReason::Reason { failure_code: failed_forward.1, data: Vec::new() }),
1139 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() }),
1143 if new_events.is_empty() { return }
1145 new_events.retain(|event| {
1146 if let &Some(ref monitor) = &event.0 {
1147 if let Err(_e) = self.monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor.clone()) {
1148 unimplemented!();// but def dont push the event...
1154 let mut events = self.pending_events.lock().unwrap();
1155 events.reserve(new_events.len());
1156 for event in new_events.drain(..) {
1157 events.push(event.1);
1161 /// Indicates that the preimage for payment_hash is unknown after a PaymentReceived event.
1162 pub fn fail_htlc_backwards(&self, payment_hash: &[u8; 32]) -> bool {
1163 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), payment_hash, HTLCFailReason::Reason { failure_code: 0x4000 | 15, data: Vec::new() })
1166 /// Fails an HTLC backwards to the sender of it to us.
1167 /// Note that while we take a channel_state lock as input, we do *not* assume consistency here.
1168 /// There are several callsites that do stupid things like loop over a list of payment_hashes
1169 /// to fail and take the channel_state lock for each iteration (as we take ownership and may
1170 /// drop it). In other words, no assumptions are made that entries in claimable_htlcs point to
1171 /// still-available channels.
1172 fn fail_htlc_backwards_internal(&self, mut channel_state: MutexGuard<ChannelHolder>, payment_hash: &[u8; 32], onion_error: HTLCFailReason) -> bool {
1173 let mut pending_htlc = {
1174 match channel_state.claimable_htlcs.remove(payment_hash) {
1175 Some(pending_htlc) => pending_htlc,
1176 None => return false,
1180 match pending_htlc {
1181 PendingOutboundHTLC::CycledRoute { source_short_channel_id, incoming_packet_shared_secret, route, session_priv } => {
1182 channel_state.claimable_htlcs.insert(payment_hash.clone(), PendingOutboundHTLC::OutboundRoute {
1186 pending_htlc = PendingOutboundHTLC::IntermediaryHopData { source_short_channel_id, incoming_packet_shared_secret };
1191 match pending_htlc {
1192 PendingOutboundHTLC::CycledRoute { .. } => unreachable!(),
1193 PendingOutboundHTLC::OutboundRoute { .. } => {
1194 mem::drop(channel_state);
1196 let mut pending_events = self.pending_events.lock().unwrap();
1197 pending_events.push(events::Event::PaymentFailed {
1198 payment_hash: payment_hash.clone()
1202 PendingOutboundHTLC::IntermediaryHopData { source_short_channel_id, incoming_packet_shared_secret } => {
1203 let err_packet = match onion_error {
1204 HTLCFailReason::Reason { failure_code, data } => {
1205 let packet = ChannelManager::build_failure_packet(&incoming_packet_shared_secret, failure_code, &data[..]).encode();
1206 ChannelManager::encrypt_failure_packet(&incoming_packet_shared_secret, &packet)
1208 HTLCFailReason::ErrorPacket { err } => {
1209 ChannelManager::encrypt_failure_packet(&incoming_packet_shared_secret, &err.data)
1213 let (node_id, fail_msgs) = {
1214 let chan_id = match channel_state.short_to_id.get(&source_short_channel_id) {
1215 Some(chan_id) => chan_id.clone(),
1216 None => return false
1219 let chan = channel_state.by_id.get_mut(&chan_id).unwrap();
1220 match chan.get_update_fail_htlc_and_commit(payment_hash, err_packet) {
1221 Ok(msg) => (chan.get_their_node_id(), msg),
1223 //TODO: Do something with e?
1230 Some((msg, commitment_msg, chan_monitor)) => {
1231 mem::drop(channel_state);
1233 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1234 unimplemented!();// but def dont push the event...
1237 let mut pending_events = self.pending_events.lock().unwrap();
1238 pending_events.push(events::Event::UpdateHTLCs {
1240 updates: msgs::CommitmentUpdate {
1241 update_add_htlcs: Vec::new(),
1242 update_fulfill_htlcs: Vec::new(),
1243 update_fail_htlcs: vec![msg],
1244 update_fail_malformed_htlcs: Vec::new(),
1245 commitment_signed: commitment_msg,
1257 /// Provides a payment preimage in response to a PaymentReceived event, returning true and
1258 /// generating message events for the net layer to claim the payment, if possible. Thus, you
1259 /// should probably kick the net layer to go send messages if this returns true!
1260 /// May panic if called except in response to a PaymentReceived event.
1261 pub fn claim_funds(&self, payment_preimage: [u8; 32]) -> bool {
1262 self.claim_funds_internal(payment_preimage, true)
1264 fn claim_funds_internal(&self, payment_preimage: [u8; 32], from_user: bool) -> bool {
1265 let mut sha = Sha256::new();
1266 sha.input(&payment_preimage);
1267 let mut payment_hash = [0; 32];
1268 sha.result(&mut payment_hash);
1270 let mut channel_state = self.channel_state.lock().unwrap();
1271 let mut pending_htlc = {
1272 match channel_state.claimable_htlcs.remove(&payment_hash) {
1273 Some(pending_htlc) => pending_htlc,
1274 None => return false,
1278 match pending_htlc {
1279 PendingOutboundHTLC::CycledRoute { source_short_channel_id, incoming_packet_shared_secret, route, session_priv } => {
1280 if from_user { // This was the end hop back to us
1281 pending_htlc = PendingOutboundHTLC::IntermediaryHopData { source_short_channel_id, incoming_packet_shared_secret };
1282 channel_state.claimable_htlcs.insert(payment_hash, PendingOutboundHTLC::OutboundRoute { route, session_priv });
1283 } else { // This came from the first upstream node
1284 // Bank error in our favor! Maybe we should tell the user this somehow???
1285 pending_htlc = PendingOutboundHTLC::OutboundRoute { route, session_priv };
1286 channel_state.claimable_htlcs.insert(payment_hash, PendingOutboundHTLC::IntermediaryHopData { source_short_channel_id, incoming_packet_shared_secret });
1292 match pending_htlc {
1293 PendingOutboundHTLC::CycledRoute { .. } => unreachable!(),
1294 PendingOutboundHTLC::OutboundRoute { .. } => {
1296 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...");
1298 mem::drop(channel_state);
1299 let mut pending_events = self.pending_events.lock().unwrap();
1300 pending_events.push(events::Event::PaymentSent {
1305 PendingOutboundHTLC::IntermediaryHopData { source_short_channel_id, .. } => {
1306 let (node_id, fulfill_msgs) = {
1307 let chan_id = match channel_state.short_to_id.get(&source_short_channel_id) {
1308 Some(chan_id) => chan_id.clone(),
1310 // TODO: There is probably a channel manager somewhere that needs to
1311 // learn the preimage as the channel already hit the chain and that's
1317 let chan = channel_state.by_id.get_mut(&chan_id).unwrap();
1318 match chan.get_update_fulfill_htlc_and_commit(payment_preimage) {
1319 Ok(msg) => (chan.get_their_node_id(), msg),
1321 // TODO: There is probably a channel manager somewhere that needs to
1322 // learn the preimage as the channel may be about to hit the chain.
1323 //TODO: Do something with e?
1329 mem::drop(channel_state);
1330 if let Some(chan_monitor) = fulfill_msgs.1 {
1331 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1332 unimplemented!();// but def dont push the event...
1336 if let Some((msg, commitment_msg)) = fulfill_msgs.0 {
1337 let mut pending_events = self.pending_events.lock().unwrap();
1338 pending_events.push(events::Event::UpdateHTLCs {
1340 updates: msgs::CommitmentUpdate {
1341 update_add_htlcs: Vec::new(),
1342 update_fulfill_htlcs: vec![msg],
1343 update_fail_htlcs: Vec::new(),
1344 update_fail_malformed_htlcs: Vec::new(),
1345 commitment_signed: commitment_msg,
1354 /// Gets the node_id held by this ChannelManager
1355 pub fn get_our_node_id(&self) -> PublicKey {
1356 PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key)
1359 /// Used to restore channels to normal operation after a
1360 /// ChannelMonitorUpdateErr::TemporaryFailure was returned from a channel monitor update
1362 pub fn test_restore_channel_monitor(&self) {
1367 impl events::EventsProvider for ChannelManager {
1368 fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
1369 let mut pending_events = self.pending_events.lock().unwrap();
1370 let mut ret = Vec::new();
1371 mem::swap(&mut ret, &mut *pending_events);
1376 impl ChainListener for ChannelManager {
1377 fn block_connected(&self, header: &BlockHeader, height: u32, txn_matched: &[&Transaction], indexes_of_txn_matched: &[u32]) {
1378 let mut new_events = Vec::new();
1379 let mut failed_channels = Vec::new();
1381 let mut channel_lock = self.channel_state.lock().unwrap();
1382 let channel_state = channel_lock.borrow_parts();
1383 let short_to_id = channel_state.short_to_id;
1384 channel_state.by_id.retain(|_, channel| {
1385 let chan_res = channel.block_connected(header, height, txn_matched, indexes_of_txn_matched);
1386 if let Ok(Some(funding_locked)) = chan_res {
1387 let announcement_sigs = self.get_announcement_sigs(channel);
1388 new_events.push(events::Event::SendFundingLocked {
1389 node_id: channel.get_their_node_id(),
1390 msg: funding_locked,
1391 announcement_sigs: announcement_sigs
1393 short_to_id.insert(channel.get_short_channel_id().unwrap(), channel.channel_id());
1394 } else if let Err(e) = chan_res {
1395 new_events.push(events::Event::HandleError {
1396 node_id: channel.get_their_node_id(),
1399 if channel.is_shutdown() {
1403 if let Some(funding_txo) = channel.get_funding_txo() {
1404 for tx in txn_matched {
1405 for inp in tx.input.iter() {
1406 if inp.previous_output == funding_txo.into_bitcoin_outpoint() {
1407 if let Some(short_id) = channel.get_short_channel_id() {
1408 short_to_id.remove(&short_id);
1410 // It looks like our counterparty went on-chain. We go ahead and
1411 // broadcast our latest local state as well here, just in case its
1412 // some kind of SPV attack, though we expect these to be dropped.
1413 failed_channels.push(channel.force_shutdown());
1414 if let Ok(update) = self.get_channel_update(&channel) {
1415 new_events.push(events::Event::BroadcastChannelUpdate {
1424 if channel.is_funding_initiated() && channel.channel_monitor().would_broadcast_at_height(height) {
1425 if let Some(short_id) = channel.get_short_channel_id() {
1426 short_to_id.remove(&short_id);
1428 failed_channels.push(channel.force_shutdown());
1429 // If would_broadcast_at_height() is true, the channel_monitor will broadcast
1430 // the latest local tx for us, so we should skip that here (it doesn't really
1431 // hurt anything, but does make tests a bit simpler).
1432 failed_channels.last_mut().unwrap().0 = Vec::new();
1433 if let Ok(update) = self.get_channel_update(&channel) {
1434 new_events.push(events::Event::BroadcastChannelUpdate {
1443 for failure in failed_channels.drain(..) {
1444 self.finish_force_close_channel(failure);
1446 let mut pending_events = self.pending_events.lock().unwrap();
1447 for funding_locked in new_events.drain(..) {
1448 pending_events.push(funding_locked);
1450 self.latest_block_height.store(height as usize, Ordering::Release);
1453 /// We force-close the channel without letting our counterparty participate in the shutdown
1454 fn block_disconnected(&self, header: &BlockHeader) {
1455 let mut new_events = Vec::new();
1456 let mut failed_channels = Vec::new();
1458 let mut channel_lock = self.channel_state.lock().unwrap();
1459 let channel_state = channel_lock.borrow_parts();
1460 let short_to_id = channel_state.short_to_id;
1461 channel_state.by_id.retain(|_, v| {
1462 if v.block_disconnected(header) {
1463 if let Some(short_id) = v.get_short_channel_id() {
1464 short_to_id.remove(&short_id);
1466 failed_channels.push(v.force_shutdown());
1467 if let Ok(update) = self.get_channel_update(&v) {
1468 new_events.push(events::Event::BroadcastChannelUpdate {
1478 for failure in failed_channels.drain(..) {
1479 self.finish_force_close_channel(failure);
1481 if !new_events.is_empty() {
1482 let mut pending_events = self.pending_events.lock().unwrap();
1483 for funding_locked in new_events.drain(..) {
1484 pending_events.push(funding_locked);
1487 self.latest_block_height.fetch_sub(1, Ordering::AcqRel);
1491 impl ChannelMessageHandler for ChannelManager {
1492 //TODO: Handle errors and close channel (or so)
1493 fn handle_open_channel(&self, their_node_id: &PublicKey, msg: &msgs::OpenChannel) -> Result<msgs::AcceptChannel, HandleError> {
1494 if msg.chain_hash != self.genesis_hash {
1495 return Err(HandleError{err: "Unknown genesis block hash", action: None});
1497 let mut channel_state = self.channel_state.lock().unwrap();
1498 if channel_state.by_id.contains_key(&msg.temporary_channel_id) {
1499 return Err(HandleError{err: "temporary_channel_id collision!", action: None});
1502 let chan_keys = if cfg!(feature = "fuzztarget") {
1504 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(),
1505 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(),
1506 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(),
1507 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(),
1508 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(),
1509 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(),
1510 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(),
1511 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],
1514 let mut key_seed = [0u8; 32];
1515 rng::fill_bytes(&mut key_seed);
1516 match ChannelKeys::new_from_seed(&key_seed) {
1518 Err(_) => panic!("RNG is busted!")
1522 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))?;
1523 let accept_msg = channel.get_accept_channel()?;
1524 channel_state.by_id.insert(channel.channel_id(), channel);
1528 fn handle_accept_channel(&self, their_node_id: &PublicKey, msg: &msgs::AcceptChannel) -> Result<(), HandleError> {
1529 let (value, output_script, user_id) = {
1530 let mut channel_state = self.channel_state.lock().unwrap();
1531 match channel_state.by_id.get_mut(&msg.temporary_channel_id) {
1533 if chan.get_their_node_id() != *their_node_id {
1534 return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None})
1536 chan.accept_channel(&msg)?;
1537 (chan.get_value_satoshis(), chan.get_funding_redeemscript().to_v0_p2wsh(), chan.get_user_id())
1539 None => return Err(HandleError{err: "Failed to find corresponding channel", action: None})
1542 let mut pending_events = self.pending_events.lock().unwrap();
1543 pending_events.push(events::Event::FundingGenerationReady {
1544 temporary_channel_id: msg.temporary_channel_id,
1545 channel_value_satoshis: value,
1546 output_script: output_script,
1547 user_channel_id: user_id,
1552 fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<msgs::FundingSigned, HandleError> {
1553 let (chan, funding_msg, monitor_update) = {
1554 let mut channel_state = self.channel_state.lock().unwrap();
1555 match channel_state.by_id.entry(msg.temporary_channel_id.clone()) {
1556 hash_map::Entry::Occupied(mut chan) => {
1557 if chan.get().get_their_node_id() != *their_node_id {
1558 return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None})
1560 match chan.get_mut().funding_created(msg) {
1561 Ok((funding_msg, monitor_update)) => {
1562 (chan.remove(), funding_msg, monitor_update)
1565 //TODO: Possibly remove the channel depending on e.action
1570 hash_map::Entry::Vacant(_) => return Err(HandleError{err: "Failed to find corresponding channel", action: None})
1572 }; // Release channel lock for install_watch_outpoint call,
1573 // note that this means if the remote end is misbehaving and sends a message for the same
1574 // channel back-to-back with funding_created, we'll end up thinking they sent a message
1575 // for a bogus channel.
1576 if let Err(_e) = self.monitor.add_update_monitor(monitor_update.get_funding_txo().unwrap(), monitor_update) {
1579 let mut channel_state = self.channel_state.lock().unwrap();
1580 match channel_state.by_id.entry(funding_msg.channel_id) {
1581 hash_map::Entry::Occupied(_) => {
1582 return Err(HandleError {
1583 err: "Duplicate channel_id!",
1584 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() } })
1587 hash_map::Entry::Vacant(e) => {
1594 fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), HandleError> {
1595 let (funding_txo, user_id, monitor) = {
1596 let mut channel_state = self.channel_state.lock().unwrap();
1597 match channel_state.by_id.get_mut(&msg.channel_id) {
1599 if chan.get_their_node_id() != *their_node_id {
1600 return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None})
1602 let chan_monitor = chan.funding_signed(&msg)?;
1603 (chan.get_funding_txo().unwrap(), chan.get_user_id(), chan_monitor)
1605 None => return Err(HandleError{err: "Failed to find corresponding channel", action: None})
1608 if let Err(_e) = self.monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor) {
1611 let mut pending_events = self.pending_events.lock().unwrap();
1612 pending_events.push(events::Event::FundingBroadcastSafe {
1613 funding_txo: funding_txo,
1614 user_channel_id: user_id,
1619 fn handle_funding_locked(&self, their_node_id: &PublicKey, msg: &msgs::FundingLocked) -> Result<Option<msgs::AnnouncementSignatures>, HandleError> {
1620 let mut channel_state = self.channel_state.lock().unwrap();
1621 match channel_state.by_id.get_mut(&msg.channel_id) {
1623 if chan.get_their_node_id() != *their_node_id {
1624 return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None})
1626 chan.funding_locked(&msg)?;
1627 return Ok(self.get_announcement_sigs(chan));
1629 None => return Err(HandleError{err: "Failed to find corresponding channel", action: None})
1633 fn handle_shutdown(&self, their_node_id: &PublicKey, msg: &msgs::Shutdown) -> Result<(Option<msgs::Shutdown>, Option<msgs::ClosingSigned>), HandleError> {
1634 let (res, chan_option) = {
1635 let mut channel_state_lock = self.channel_state.lock().unwrap();
1636 let channel_state = channel_state_lock.borrow_parts();
1638 match channel_state.by_id.entry(msg.channel_id.clone()) {
1639 hash_map::Entry::Occupied(mut chan_entry) => {
1640 if chan_entry.get().get_their_node_id() != *their_node_id {
1641 return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None})
1643 let res = chan_entry.get_mut().shutdown(&*self.fee_estimator, &msg)?;
1644 if chan_entry.get().is_shutdown() {
1645 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
1646 channel_state.short_to_id.remove(&short_id);
1648 (res, Some(chan_entry.remove_entry().1))
1649 } else { (res, None) }
1651 hash_map::Entry::Vacant(_) => return Err(HandleError{err: "Failed to find corresponding channel", action: None})
1654 for payment_hash in res.2 {
1655 // unknown_next_peer...I dunno who that is anymore....
1656 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), &payment_hash, HTLCFailReason::Reason { failure_code: 0x4000 | 10, data: Vec::new() });
1658 if let Some(chan) = chan_option {
1659 if let Ok(update) = self.get_channel_update(&chan) {
1660 let mut events = self.pending_events.lock().unwrap();
1661 events.push(events::Event::BroadcastChannelUpdate {
1669 fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<Option<msgs::ClosingSigned>, HandleError> {
1670 let (res, chan_option) = {
1671 let mut channel_state_lock = self.channel_state.lock().unwrap();
1672 let channel_state = channel_state_lock.borrow_parts();
1673 match channel_state.by_id.entry(msg.channel_id.clone()) {
1674 hash_map::Entry::Occupied(mut chan_entry) => {
1675 if chan_entry.get().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 let res = chan_entry.get_mut().closing_signed(&*self.fee_estimator, &msg)?;
1679 if res.1.is_some() {
1680 // We're done with this channel, we've got a signed closing transaction and
1681 // will send the closing_signed back to the remote peer upon return. This
1682 // also implies there are no pending HTLCs left on the channel, so we can
1683 // fully delete it from tracking (the channel monitor is still around to
1684 // watch for old state broadcasts)!
1685 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
1686 channel_state.short_to_id.remove(&short_id);
1688 (res, Some(chan_entry.remove_entry().1))
1689 } else { (res, None) }
1691 hash_map::Entry::Vacant(_) => return Err(HandleError{err: "Failed to find corresponding channel", action: None})
1694 if let Some(broadcast_tx) = res.1 {
1695 self.tx_broadcaster.broadcast_transaction(&broadcast_tx);
1697 if let Some(chan) = chan_option {
1698 if let Ok(update) = self.get_channel_update(&chan) {
1699 let mut events = self.pending_events.lock().unwrap();
1700 events.push(events::Event::BroadcastChannelUpdate {
1708 fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), msgs::HandleError> {
1709 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
1710 //determine the state of the payment based on our response/if we forward anything/the time
1711 //we take to respond. We should take care to avoid allowing such an attack.
1713 //TODO: There exists a further attack where a node may garble the onion data, forward it to
1714 //us repeatedly garbled in different ways, and compare our error messages, which are
1715 //encrypted with the same key. Its not immediately obvious how to usefully exploit that,
1716 //but we should prevent it anyway.
1718 let (mut pending_forward_info, shared_secret, mut channel_state_lock) = self.decode_update_add_htlc_onion(msg);
1719 let channel_state = channel_state_lock.borrow_parts();
1721 let claimable_htlcs_entry = channel_state.claimable_htlcs.entry(msg.payment_hash.clone());
1723 // We dont correctly handle payments that route through us twice on their way to their
1724 // destination. That's OK since those nodes are probably busted or trying to do network
1725 // mapping through repeated loops. In either case, we want them to stop talking to us, so
1726 // we send permanent_node_failure.
1727 let mut will_forward = false;
1728 if let PendingHTLCStatus::Forward(PendingForwardHTLCInfo { short_channel_id, .. }) = pending_forward_info {
1729 if let &hash_map::Entry::Occupied(ref e) = &claimable_htlcs_entry {
1730 let mut acceptable_cycle = false;
1731 if let &PendingOutboundHTLC::OutboundRoute { .. } = e.get() {
1732 acceptable_cycle = short_channel_id == 0;
1734 if !acceptable_cycle {
1735 log_info!(self, "Failed to accept incoming HTLC: Payment looped through us twice");
1736 pending_forward_info = PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
1737 channel_id: msg.channel_id,
1738 htlc_id: msg.htlc_id,
1739 reason: ChannelManager::build_first_hop_failure_packet(&shared_secret.unwrap(), 0x4000 | 0x2000 | 2, &[0;0]),
1742 will_forward = true;
1745 will_forward = true;
1749 let (source_short_channel_id, res) = match channel_state.by_id.get_mut(&msg.channel_id) {
1751 if chan.get_their_node_id() != *their_node_id {
1752 return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None})
1754 if !chan.is_usable() {
1755 return Err(HandleError{err: "Channel not yet available for receiving HTLCs", action: None});
1757 let short_channel_id = chan.get_short_channel_id().unwrap();
1758 if let PendingHTLCStatus::Forward(ref mut forward_info) = pending_forward_info {
1759 forward_info.prev_short_channel_id = short_channel_id;
1761 (short_channel_id, chan.update_add_htlc(&msg, pending_forward_info)?)
1763 None => return Err(HandleError{err: "Failed to find corresponding channel", action: None}),
1767 match claimable_htlcs_entry {
1768 hash_map::Entry::Occupied(mut e) => {
1769 let outbound_route = e.get_mut();
1770 let (route, session_priv) = match outbound_route {
1771 &mut PendingOutboundHTLC::OutboundRoute { ref route, ref session_priv } => {
1772 (route.clone(), session_priv.clone())
1774 _ => unreachable!(),
1776 *outbound_route = PendingOutboundHTLC::CycledRoute {
1777 source_short_channel_id,
1778 incoming_packet_shared_secret: shared_secret.unwrap(),
1783 hash_map::Entry::Vacant(e) => {
1784 e.insert(PendingOutboundHTLC::IntermediaryHopData {
1785 source_short_channel_id,
1786 incoming_packet_shared_secret: shared_secret.unwrap(),
1795 fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), HandleError> {
1796 //TODO: Delay the claimed_funds relaying just like we do outbound relay!
1797 // Claim funds first, cause we don't really care if the channel we received the message on
1798 // is broken, we may have enough info to get our own money!
1799 self.claim_funds_internal(msg.payment_preimage.clone(), false);
1801 let mut channel_state = self.channel_state.lock().unwrap();
1802 match channel_state.by_id.get_mut(&msg.channel_id) {
1804 if chan.get_their_node_id() != *their_node_id {
1805 return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None})
1807 chan.update_fulfill_htlc(&msg)
1809 None => return Err(HandleError{err: "Failed to find corresponding channel", action: None})
1813 fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<Option<msgs::HTLCFailChannelUpdate>, HandleError> {
1814 let mut channel_state = self.channel_state.lock().unwrap();
1815 let payment_hash = match channel_state.by_id.get_mut(&msg.channel_id) {
1817 if chan.get_their_node_id() != *their_node_id {
1818 return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None})
1820 chan.update_fail_htlc(&msg, HTLCFailReason::ErrorPacket { err: msg.reason.clone() })
1822 None => return Err(HandleError{err: "Failed to find corresponding channel", action: None})
1825 if let Some(pending_htlc) = channel_state.claimable_htlcs.get(&payment_hash) {
1826 match pending_htlc {
1827 &PendingOutboundHTLC::OutboundRoute { ref route, ref session_priv } => {
1828 // Handle packed channel/node updates for passing back for the route handler
1829 let mut packet_decrypted = msg.reason.data.clone();
1831 Self::construct_onion_keys_callback(&self.secp_ctx, &route, &session_priv, |shared_secret, _, _, route_hop| {
1832 if res.is_some() { return; }
1834 let ammag = ChannelManager::gen_ammag_from_shared_secret(&shared_secret);
1836 let mut decryption_tmp = Vec::with_capacity(packet_decrypted.len());
1837 decryption_tmp.resize(packet_decrypted.len(), 0);
1838 let mut chacha = ChaCha20::new(&ammag, &[0u8; 8]);
1839 chacha.process(&packet_decrypted, &mut decryption_tmp[..]);
1840 packet_decrypted = decryption_tmp;
1842 if let Ok(err_packet) = msgs::DecodedOnionErrorPacket::decode(&packet_decrypted) {
1843 if err_packet.failuremsg.len() >= 2 {
1844 let um = ChannelManager::gen_um_from_shared_secret(&shared_secret);
1846 let mut hmac = Hmac::new(Sha256::new(), &um);
1847 hmac.input(&err_packet.encode()[32..]);
1848 let mut calc_tag = [0u8; 32];
1849 hmac.raw_result(&mut calc_tag);
1850 if crypto::util::fixed_time_eq(&calc_tag, &err_packet.hmac) {
1851 const UNKNOWN_CHAN: u16 = 0x4000|10;
1852 const TEMP_CHAN_FAILURE: u16 = 0x4000|7;
1853 match byte_utils::slice_to_be16(&err_packet.failuremsg[0..2]) {
1854 TEMP_CHAN_FAILURE => {
1855 if err_packet.failuremsg.len() >= 4 {
1856 let update_len = byte_utils::slice_to_be16(&err_packet.failuremsg[2..4]) as usize;
1857 if err_packet.failuremsg.len() >= 4 + update_len {
1858 if let Ok(chan_update) = msgs::ChannelUpdate::decode(&err_packet.failuremsg[4..4 + update_len]) {
1859 res = Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage {
1867 // No such next-hop. We know this came from the
1868 // current node as the HMAC validated.
1869 res = Some(msgs::HTLCFailChannelUpdate::ChannelClosed {
1870 short_channel_id: route_hop.short_channel_id
1873 _ => {}, //TODO: Enumerate all of these!
1888 fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), HandleError> {
1889 let mut channel_state = self.channel_state.lock().unwrap();
1890 match channel_state.by_id.get_mut(&msg.channel_id) {
1892 if chan.get_their_node_id() != *their_node_id {
1893 return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None})
1895 chan.update_fail_malformed_htlc(&msg, HTLCFailReason::Reason { failure_code: msg.failure_code, data: Vec::new() })
1897 None => return Err(HandleError{err: "Failed to find corresponding channel", action: None})
1901 fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(msgs::RevokeAndACK, Option<msgs::CommitmentSigned>), HandleError> {
1902 let (revoke_and_ack, commitment_signed, chan_monitor) = {
1903 let mut channel_state = self.channel_state.lock().unwrap();
1904 match channel_state.by_id.get_mut(&msg.channel_id) {
1906 if chan.get_their_node_id() != *their_node_id {
1907 return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None})
1909 chan.commitment_signed(&msg)?
1911 None => return Err(HandleError{err: "Failed to find corresponding channel", action: None})
1914 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1918 Ok((revoke_and_ack, commitment_signed))
1921 fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<Option<msgs::CommitmentUpdate>, HandleError> {
1922 let (res, mut pending_forwards, mut pending_failures, chan_monitor) = {
1923 let mut channel_state = self.channel_state.lock().unwrap();
1924 match channel_state.by_id.get_mut(&msg.channel_id) {
1926 if chan.get_their_node_id() != *their_node_id {
1927 return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None})
1929 chan.revoke_and_ack(&msg)?
1931 None => return Err(HandleError{err: "Failed to find corresponding channel", action: None})
1934 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1937 for failure in pending_failures.drain(..) {
1938 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), &failure.0, failure.1);
1941 let mut forward_event = None;
1942 if !pending_forwards.is_empty() {
1943 let mut channel_state = self.channel_state.lock().unwrap();
1944 if channel_state.forward_htlcs.is_empty() {
1945 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));
1946 channel_state.next_forward = forward_event.unwrap();
1948 for forward_info in pending_forwards.drain(..) {
1949 match channel_state.forward_htlcs.entry(forward_info.short_channel_id) {
1950 hash_map::Entry::Occupied(mut entry) => {
1951 entry.get_mut().push(forward_info);
1953 hash_map::Entry::Vacant(entry) => {
1954 entry.insert(vec!(forward_info));
1959 match forward_event {
1961 let mut pending_events = self.pending_events.lock().unwrap();
1962 pending_events.push(events::Event::PendingHTLCsForwardable {
1963 time_forwardable: time
1972 fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), HandleError> {
1973 let mut channel_state = self.channel_state.lock().unwrap();
1974 match channel_state.by_id.get_mut(&msg.channel_id) {
1976 if chan.get_their_node_id() != *their_node_id {
1977 return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None})
1979 chan.update_fee(&*self.fee_estimator, &msg)
1981 None => return Err(HandleError{err: "Failed to find corresponding channel", action: None})
1985 fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), HandleError> {
1986 let (chan_announcement, chan_update) = {
1987 let mut channel_state = self.channel_state.lock().unwrap();
1988 match channel_state.by_id.get_mut(&msg.channel_id) {
1990 if chan.get_their_node_id() != *their_node_id {
1991 return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None})
1993 if !chan.is_usable() {
1994 return Err(HandleError{err: "Got an announcement_signatures before we were ready for it", action: None });
1997 let our_node_id = self.get_our_node_id();
1998 let (announcement, our_bitcoin_sig) = chan.get_channel_announcement(our_node_id.clone(), self.genesis_hash.clone())?;
2000 let were_node_one = announcement.node_id_1 == our_node_id;
2001 let msghash = Message::from_slice(&Sha256dHash::from_data(&announcement.encode()[..])[..]).unwrap();
2002 let bad_sig_action = msgs::ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage { channel_id: msg.channel_id.clone(), data: "Invalid signature in announcement_signatures".to_string() } };
2003 secp_call!(self.secp_ctx.verify(&msghash, &msg.node_signature, if were_node_one { &announcement.node_id_2 } else { &announcement.node_id_1 }), "Bad announcement_signatures node_signature", bad_sig_action);
2004 secp_call!(self.secp_ctx.verify(&msghash, &msg.bitcoin_signature, if were_node_one { &announcement.bitcoin_key_2 } else { &announcement.bitcoin_key_1 }), "Bad announcement_signatures bitcoin_signature", bad_sig_action);
2006 let our_node_sig = self.secp_ctx.sign(&msghash, &self.our_network_key);
2008 (msgs::ChannelAnnouncement {
2009 node_signature_1: if were_node_one { our_node_sig } else { msg.node_signature },
2010 node_signature_2: if were_node_one { msg.node_signature } else { our_node_sig },
2011 bitcoin_signature_1: if were_node_one { our_bitcoin_sig } else { msg.bitcoin_signature },
2012 bitcoin_signature_2: if were_node_one { msg.bitcoin_signature } else { our_bitcoin_sig },
2013 contents: announcement,
2014 }, self.get_channel_update(chan).unwrap()) // can only fail if we're not in a ready state
2016 None => return Err(HandleError{err: "Failed to find corresponding channel", action: None})
2019 let mut pending_events = self.pending_events.lock().unwrap();
2020 pending_events.push(events::Event::BroadcastChannelAnnouncement { msg: chan_announcement, update_msg: chan_update });
2024 fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool) {
2025 let mut new_events = Vec::new();
2026 let mut failed_channels = Vec::new();
2028 let mut channel_state_lock = self.channel_state.lock().unwrap();
2029 let channel_state = channel_state_lock.borrow_parts();
2030 let short_to_id = channel_state.short_to_id;
2031 if no_connection_possible {
2032 channel_state.by_id.retain(|_, chan| {
2033 if chan.get_their_node_id() == *their_node_id {
2034 if let Some(short_id) = chan.get_short_channel_id() {
2035 short_to_id.remove(&short_id);
2037 failed_channels.push(chan.force_shutdown());
2038 if let Ok(update) = self.get_channel_update(&chan) {
2039 new_events.push(events::Event::BroadcastChannelUpdate {
2049 for chan in channel_state.by_id {
2050 if chan.1.get_their_node_id() == *their_node_id {
2051 //TODO: mark channel disabled (and maybe announce such after a timeout). Also
2052 //fail and wipe any uncommitted outbound HTLCs as those are considered after
2058 for failure in failed_channels.drain(..) {
2059 self.finish_force_close_channel(failure);
2061 if !new_events.is_empty() {
2062 let mut pending_events = self.pending_events.lock().unwrap();
2063 for event in new_events.drain(..) {
2064 pending_events.push(event);
2069 fn handle_error(&self, their_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
2070 if msg.channel_id == [0; 32] {
2071 for chan in self.list_channels() {
2072 if chan.remote_network_id == *their_node_id {
2073 self.force_close_channel(&chan.channel_id);
2077 self.force_close_channel(&msg.channel_id);
2084 use chain::chaininterface;
2085 use chain::transaction::OutPoint;
2086 use chain::chaininterface::ChainListener;
2087 use ln::channelmanager::{ChannelManager,OnionKeys};
2088 use ln::router::{Route, RouteHop, Router};
2090 use ln::msgs::{MsgEncodable,ChannelMessageHandler,RoutingMessageHandler};
2091 use util::test_utils;
2092 use util::events::{Event, EventsProvider};
2093 use util::logger::Logger;
2095 use bitcoin::util::hash::Sha256dHash;
2096 use bitcoin::blockdata::block::{Block, BlockHeader};
2097 use bitcoin::blockdata::transaction::{Transaction, TxOut};
2098 use bitcoin::network::constants::Network;
2099 use bitcoin::network::serialize::serialize;
2100 use bitcoin::network::serialize::BitcoinHash;
2104 use secp256k1::Secp256k1;
2105 use secp256k1::key::{PublicKey,SecretKey};
2107 use crypto::sha2::Sha256;
2108 use crypto::digest::Digest;
2110 use rand::{thread_rng,Rng};
2112 use std::collections::HashMap;
2113 use std::default::Default;
2114 use std::sync::{Arc, Mutex};
2115 use std::time::Instant;
2118 fn build_test_onion_keys() -> Vec<OnionKeys> {
2119 // Keys from BOLT 4, used in both test vector tests
2120 let secp_ctx = Secp256k1::new();
2125 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("02eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619").unwrap()[..]).unwrap(),
2126 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
2129 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("0324653eac434488002cc06bbfb7f10fe18991e35f9fe4302dbea6d2353dc0ab1c").unwrap()[..]).unwrap(),
2130 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
2133 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("027f31ebc5462c1fdce1b737ecff52d37d75dea43ce11c74d25aa297165faa2007").unwrap()[..]).unwrap(),
2134 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
2137 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]).unwrap(),
2138 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
2141 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("02edabbd16b41c8371b92ef2f04c1185b4f03b6dcd52ba9b78d9d7c89c8f221145").unwrap()[..]).unwrap(),
2142 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
2147 let session_priv = SecretKey::from_slice(&secp_ctx, &hex::decode("4141414141414141414141414141414141414141414141414141414141414141").unwrap()[..]).unwrap();
2149 let onion_keys = ChannelManager::construct_onion_keys(&secp_ctx, &route, &session_priv).unwrap();
2150 assert_eq!(onion_keys.len(), route.hops.len());
2155 fn onion_vectors() {
2156 // Packet creation test vectors from BOLT 4
2157 let onion_keys = build_test_onion_keys();
2159 assert_eq!(onion_keys[0].shared_secret[..], hex::decode("53eb63ea8a3fec3b3cd433b85cd62a4b145e1dda09391b348c4e1cd36a03ea66").unwrap()[..]);
2160 assert_eq!(onion_keys[0].blinding_factor[..], hex::decode("2ec2e5da605776054187180343287683aa6a51b4b1c04d6dd49c45d8cffb3c36").unwrap()[..]);
2161 assert_eq!(onion_keys[0].ephemeral_pubkey.serialize()[..], hex::decode("02eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619").unwrap()[..]);
2162 assert_eq!(onion_keys[0].rho, hex::decode("ce496ec94def95aadd4bec15cdb41a740c9f2b62347c4917325fcc6fb0453986").unwrap()[..]);
2163 assert_eq!(onion_keys[0].mu, hex::decode("b57061dc6d0a2b9f261ac410c8b26d64ac5506cbba30267a649c28c179400eba").unwrap()[..]);
2165 assert_eq!(onion_keys[1].shared_secret[..], hex::decode("a6519e98832a0b179f62123b3567c106db99ee37bef036e783263602f3488fae").unwrap()[..]);
2166 assert_eq!(onion_keys[1].blinding_factor[..], hex::decode("bf66c28bc22e598cfd574a1931a2bafbca09163df2261e6d0056b2610dab938f").unwrap()[..]);
2167 assert_eq!(onion_keys[1].ephemeral_pubkey.serialize()[..], hex::decode("028f9438bfbf7feac2e108d677e3a82da596be706cc1cf342b75c7b7e22bf4e6e2").unwrap()[..]);
2168 assert_eq!(onion_keys[1].rho, hex::decode("450ffcabc6449094918ebe13d4f03e433d20a3d28a768203337bc40b6e4b2c59").unwrap()[..]);
2169 assert_eq!(onion_keys[1].mu, hex::decode("05ed2b4a3fb023c2ff5dd6ed4b9b6ea7383f5cfe9d59c11d121ec2c81ca2eea9").unwrap()[..]);
2171 assert_eq!(onion_keys[2].shared_secret[..], hex::decode("3a6b412548762f0dbccce5c7ae7bb8147d1caf9b5471c34120b30bc9c04891cc").unwrap()[..]);
2172 assert_eq!(onion_keys[2].blinding_factor[..], hex::decode("a1f2dadd184eb1627049673f18c6325814384facdee5bfd935d9cb031a1698a5").unwrap()[..]);
2173 assert_eq!(onion_keys[2].ephemeral_pubkey.serialize()[..], hex::decode("03bfd8225241ea71cd0843db7709f4c222f62ff2d4516fd38b39914ab6b83e0da0").unwrap()[..]);
2174 assert_eq!(onion_keys[2].rho, hex::decode("11bf5c4f960239cb37833936aa3d02cea82c0f39fd35f566109c41f9eac8deea").unwrap()[..]);
2175 assert_eq!(onion_keys[2].mu, hex::decode("caafe2820fa00eb2eeb78695ae452eba38f5a53ed6d53518c5c6edf76f3f5b78").unwrap()[..]);
2177 assert_eq!(onion_keys[3].shared_secret[..], hex::decode("21e13c2d7cfe7e18836df50872466117a295783ab8aab0e7ecc8c725503ad02d").unwrap()[..]);
2178 assert_eq!(onion_keys[3].blinding_factor[..], hex::decode("7cfe0b699f35525029ae0fa437c69d0f20f7ed4e3916133f9cacbb13c82ff262").unwrap()[..]);
2179 assert_eq!(onion_keys[3].ephemeral_pubkey.serialize()[..], hex::decode("031dde6926381289671300239ea8e57ffaf9bebd05b9a5b95beaf07af05cd43595").unwrap()[..]);
2180 assert_eq!(onion_keys[3].rho, hex::decode("cbe784ab745c13ff5cffc2fbe3e84424aa0fd669b8ead4ee562901a4a4e89e9e").unwrap()[..]);
2181 assert_eq!(onion_keys[3].mu, hex::decode("5052aa1b3d9f0655a0932e50d42f0c9ba0705142c25d225515c45f47c0036ee9").unwrap()[..]);
2183 assert_eq!(onion_keys[4].shared_secret[..], hex::decode("b5756b9b542727dbafc6765a49488b023a725d631af688fc031217e90770c328").unwrap()[..]);
2184 assert_eq!(onion_keys[4].blinding_factor[..], hex::decode("c96e00dddaf57e7edcd4fb5954be5b65b09f17cb6d20651b4e90315be5779205").unwrap()[..]);
2185 assert_eq!(onion_keys[4].ephemeral_pubkey.serialize()[..], hex::decode("03a214ebd875aab6ddfd77f22c5e7311d7f77f17a169e599f157bbcdae8bf071f4").unwrap()[..]);
2186 assert_eq!(onion_keys[4].rho, hex::decode("034e18b8cc718e8af6339106e706c52d8df89e2b1f7e9142d996acf88df8799b").unwrap()[..]);
2187 assert_eq!(onion_keys[4].mu, hex::decode("8e45e5c61c2b24cb6382444db6698727afb063adecd72aada233d4bf273d975a").unwrap()[..]);
2189 // Test vectors below are flat-out wrong: they claim to set outgoing_cltv_value to non-0 :/
2190 let payloads = vec!(
2191 msgs::OnionHopData {
2193 data: msgs::OnionRealm0HopData {
2194 short_channel_id: 0,
2196 outgoing_cltv_value: 0,
2200 msgs::OnionHopData {
2202 data: msgs::OnionRealm0HopData {
2203 short_channel_id: 0x0101010101010101,
2204 amt_to_forward: 0x0100000001,
2205 outgoing_cltv_value: 0,
2209 msgs::OnionHopData {
2211 data: msgs::OnionRealm0HopData {
2212 short_channel_id: 0x0202020202020202,
2213 amt_to_forward: 0x0200000002,
2214 outgoing_cltv_value: 0,
2218 msgs::OnionHopData {
2220 data: msgs::OnionRealm0HopData {
2221 short_channel_id: 0x0303030303030303,
2222 amt_to_forward: 0x0300000003,
2223 outgoing_cltv_value: 0,
2227 msgs::OnionHopData {
2229 data: msgs::OnionRealm0HopData {
2230 short_channel_id: 0x0404040404040404,
2231 amt_to_forward: 0x0400000004,
2232 outgoing_cltv_value: 0,
2238 let packet = ChannelManager::construct_onion_packet(payloads, onion_keys, &[0x42; 32]).unwrap();
2239 // Just check the final packet encoding, as it includes all the per-hop vectors in it
2241 assert_eq!(packet.encode(), hex::decode("0002eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619e5f14350c2a76fc232b5e46d421e9615471ab9e0bc887beff8c95fdb878f7b3a716a996c7845c93d90e4ecbb9bde4ece2f69425c99e4bc820e44485455f135edc0d10f7d61ab590531cf08000179a333a347f8b4072f216400406bdf3bf038659793d4a1fd7b246979e3150a0a4cb052c9ec69acf0f48c3d39cd55675fe717cb7d80ce721caad69320c3a469a202f1e468c67eaf7a7cd8226d0fd32f7b48084dca885d56047694762b67021713ca673929c163ec36e04e40ca8e1c6d17569419d3039d9a1ec866abe044a9ad635778b961fc0776dc832b3a451bd5d35072d2269cf9b040f6b7a7dad84fb114ed413b1426cb96ceaf83825665ed5a1d002c1687f92465b49ed4c7f0218ff8c6c7dd7221d589c65b3b9aaa71a41484b122846c7c7b57e02e679ea8469b70e14fe4f70fee4d87b910cf144be6fe48eef24da475c0b0bcc6565ae82cd3f4e3b24c76eaa5616c6111343306ab35c1fe5ca4a77c0e314ed7dba39d6f1e0de791719c241a939cc493bea2bae1c1e932679ea94d29084278513c77b899cc98059d06a27d171b0dbdf6bee13ddc4fc17a0c4d2827d488436b57baa167544138ca2e64a11b43ac8a06cd0c2fba2d4d900ed2d9205305e2d7383cc98dacb078133de5f6fb6bed2ef26ba92cea28aafc3b9948dd9ae5559e8bd6920b8cea462aa445ca6a95e0e7ba52961b181c79e73bd581821df2b10173727a810c92b83b5ba4a0403eb710d2ca10689a35bec6c3a708e9e92f7d78ff3c5d9989574b00c6736f84c199256e76e19e78f0c98a9d580b4a658c84fc8f2096c2fbea8f5f8c59d0fdacb3be2802ef802abbecb3aba4acaac69a0e965abd8981e9896b1f6ef9d60f7a164b371af869fd0e48073742825e9434fc54da837e120266d53302954843538ea7c6c3dbfb4ff3b2fdbe244437f2a153ccf7bdb4c92aa08102d4f3cff2ae5ef86fab4653595e6a5837fa2f3e29f27a9cde5966843fb847a4a61f1e76c281fe8bb2b0a181d096100db5a1a5ce7a910238251a43ca556712eaadea167fb4d7d75825e440f3ecd782036d7574df8bceacb397abefc5f5254d2722215c53ff54af8299aaaad642c6d72a14d27882d9bbd539e1cc7a527526ba89b8c037ad09120e98ab042d3e8652b31ae0e478516bfaf88efca9f3676ffe99d2819dcaeb7610a626695f53117665d267d3f7abebd6bbd6733f645c72c389f03855bdf1e4b8075b516569b118233a0f0971d24b83113c0b096f5216a207ca99a7cddc81c130923fe3d91e7508c9ac5f2e914ff5dccab9e558566fa14efb34ac98d878580814b94b73acbfde9072f30b881f7f0fff42d4045d1ace6322d86a97d164aa84d93a60498065cc7c20e636f5862dc81531a88c60305a2e59a985be327a6902e4bed986dbf4a0b50c217af0ea7fdf9ab37f9ea1a1aaa72f54cf40154ea9b269f1a7c09f9f43245109431a175d50e2db0132337baa0ef97eed0fcf20489da36b79a1172faccc2f7ded7c60e00694282d93359c4682135642bc81f433574aa8ef0c97b4ade7ca372c5ffc23c7eddd839bab4e0f14d6df15c9dbeab176bec8b5701cf054eb3072f6dadc98f88819042bf10c407516ee58bce33fbe3b3d86a54255e577db4598e30a135361528c101683a5fcde7e8ba53f3456254be8f45fe3a56120ae96ea3773631fcb3873aa3abd91bcff00bd38bd43697a2e789e00da6077482e7b1b1a677b5afae4c54e6cbdf7377b694eb7d7a5b913476a5be923322d3de06060fd5e819635232a2cf4f0731da13b8546d1d6d4f8d75b9fce6c2341a71b0ea6f780df54bfdb0dd5cd9855179f602f9172307c7268724c3618e6817abd793adc214a0dc0bc616816632f27ea336fb56dfd").unwrap());
2245 fn test_failure_packet_onion() {
2246 // Returning Errors test vectors from BOLT 4
2248 let onion_keys = build_test_onion_keys();
2249 let onion_error = ChannelManager::build_failure_packet(&onion_keys[4].shared_secret, 0x2002, &[0; 0]);
2250 assert_eq!(onion_error.encode(), hex::decode("4c2fc8bc08510334b6833ad9c3e79cd1b52ae59dfe5c2a4b23ead50f09f7ee0b0002200200fe0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap());
2252 let onion_packet_1 = ChannelManager::encrypt_failure_packet(&onion_keys[4].shared_secret, &onion_error.encode()[..]);
2253 assert_eq!(onion_packet_1.data, hex::decode("a5e6bd0c74cb347f10cce367f949098f2457d14c046fd8a22cb96efb30b0fdcda8cb9168b50f2fd45edd73c1b0c8b33002df376801ff58aaa94000bf8a86f92620f343baef38a580102395ae3abf9128d1047a0736ff9b83d456740ebbb4aeb3aa9737f18fb4afb4aa074fb26c4d702f42968888550a3bded8c05247e045b866baef0499f079fdaeef6538f31d44deafffdfd3afa2fb4ca9082b8f1c465371a9894dd8c243fb4847e004f5256b3e90e2edde4c9fb3082ddfe4d1e734cacd96ef0706bf63c9984e22dc98851bcccd1c3494351feb458c9c6af41c0044bea3c47552b1d992ae542b17a2d0bba1a096c78d169034ecb55b6e3a7263c26017f033031228833c1daefc0dedb8cf7c3e37c9c37ebfe42f3225c326e8bcfd338804c145b16e34e4").unwrap());
2255 let onion_packet_2 = ChannelManager::encrypt_failure_packet(&onion_keys[3].shared_secret, &onion_packet_1.data[..]);
2256 assert_eq!(onion_packet_2.data, hex::decode("c49a1ce81680f78f5f2000cda36268de34a3f0a0662f55b4e837c83a8773c22aa081bab1616a0011585323930fa5b9fae0c85770a2279ff59ec427ad1bbff9001c0cd1497004bd2a0f68b50704cf6d6a4bf3c8b6a0833399a24b3456961ba00736785112594f65b6b2d44d9f5ea4e49b5e1ec2af978cbe31c67114440ac51a62081df0ed46d4a3df295da0b0fe25c0115019f03f15ec86fabb4c852f83449e812f141a9395b3f70b766ebbd4ec2fae2b6955bd8f32684c15abfe8fd3a6261e52650e8807a92158d9f1463261a925e4bfba44bd20b166d532f0017185c3a6ac7957adefe45559e3072c8dc35abeba835a8cb01a71a15c736911126f27d46a36168ca5ef7dccd4e2886212602b181463e0dd30185c96348f9743a02aca8ec27c0b90dca270").unwrap());
2258 let onion_packet_3 = ChannelManager::encrypt_failure_packet(&onion_keys[2].shared_secret, &onion_packet_2.data[..]);
2259 assert_eq!(onion_packet_3.data, hex::decode("a5d3e8634cfe78b2307d87c6d90be6fe7855b4f2cc9b1dfb19e92e4b79103f61ff9ac25f412ddfb7466e74f81b3e545563cdd8f5524dae873de61d7bdfccd496af2584930d2b566b4f8d3881f8c043df92224f38cf094cfc09d92655989531524593ec6d6caec1863bdfaa79229b5020acc034cd6deeea1021c50586947b9b8e6faa83b81fbfa6133c0af5d6b07c017f7158fa94f0d206baf12dda6b68f785b773b360fd0497e16cc402d779c8d48d0fa6315536ef0660f3f4e1865f5b38ea49c7da4fd959de4e83ff3ab686f059a45c65ba2af4a6a79166aa0f496bf04d06987b6d2ea205bdb0d347718b9aeff5b61dfff344993a275b79717cd815b6ad4c0beb568c4ac9c36ff1c315ec1119a1993c4b61e6eaa0375e0aaf738ac691abd3263bf937e3").unwrap());
2261 let onion_packet_4 = ChannelManager::encrypt_failure_packet(&onion_keys[1].shared_secret, &onion_packet_3.data[..]);
2262 assert_eq!(onion_packet_4.data, hex::decode("aac3200c4968f56b21f53e5e374e3a2383ad2b1b6501bbcc45abc31e59b26881b7dfadbb56ec8dae8857add94e6702fb4c3a4de22e2e669e1ed926b04447fc73034bb730f4932acd62727b75348a648a1128744657ca6a4e713b9b646c3ca66cac02cdab44dd3439890ef3aaf61708714f7375349b8da541b2548d452d84de7084bb95b3ac2345201d624d31f4d52078aa0fa05a88b4e20202bd2b86ac5b52919ea305a8949de95e935eed0319cf3cf19ebea61d76ba92532497fcdc9411d06bcd4275094d0a4a3c5d3a945e43305a5a9256e333e1f64dbca5fcd4e03a39b9012d197506e06f29339dfee3331995b21615337ae060233d39befea925cc262873e0530408e6990f1cbd233a150ef7b004ff6166c70c68d9f8c853c1abca640b8660db2921").unwrap());
2264 let onion_packet_5 = ChannelManager::encrypt_failure_packet(&onion_keys[0].shared_secret, &onion_packet_4.data[..]);
2265 assert_eq!(onion_packet_5.data, hex::decode("9c5add3963fc7f6ed7f148623c84134b5647e1306419dbe2174e523fa9e2fbed3a06a19f899145610741c83ad40b7712aefaddec8c6baf7325d92ea4ca4d1df8bce517f7e54554608bf2bd8071a4f52a7a2f7ffbb1413edad81eeea5785aa9d990f2865dc23b4bc3c301a94eec4eabebca66be5cf638f693ec256aec514620cc28ee4a94bd9565bc4d4962b9d3641d4278fb319ed2b84de5b665f307a2db0f7fbb757366067d88c50f7e829138fde4f78d39b5b5802f1b92a8a820865af5cc79f9f30bc3f461c66af95d13e5e1f0381c184572a91dee1c849048a647a1158cf884064deddbf1b0b88dfe2f791428d0ba0f6fb2f04e14081f69165ae66d9297c118f0907705c9c4954a199bae0bb96fad763d690e7daa6cfda59ba7f2c8d11448b604d12d").unwrap());
2268 fn confirm_transaction(chain: &chaininterface::ChainWatchInterfaceUtil, tx: &Transaction, chan_id: u32) {
2269 assert!(chain.does_match_tx(tx));
2270 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2271 chain.block_connected_checked(&header, 1, &[tx; 1], &[chan_id; 1]);
2273 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2274 chain.block_connected_checked(&header, i, &[tx; 0], &[0; 0]);
2279 chain_monitor: Arc<chaininterface::ChainWatchInterfaceUtil>,
2280 tx_broadcaster: Arc<test_utils::TestBroadcaster>,
2281 chan_monitor: Arc<test_utils::TestChannelMonitor>,
2282 node: Arc<ChannelManager>,
2286 static mut CHAN_COUNT: u32 = 0;
2287 fn create_chan_between_nodes(node_a: &Node, node_b: &Node) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
2288 node_a.node.create_channel(node_b.node.get_our_node_id(), 100000, 10001, 42).unwrap();
2290 let events_1 = node_a.node.get_and_clear_pending_events();
2291 assert_eq!(events_1.len(), 1);
2292 let accept_chan = match events_1[0] {
2293 Event::SendOpenChannel { ref node_id, ref msg } => {
2294 assert_eq!(*node_id, node_b.node.get_our_node_id());
2295 node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), msg).unwrap()
2297 _ => panic!("Unexpected event"),
2300 node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), &accept_chan).unwrap();
2302 let chan_id = unsafe { CHAN_COUNT };
2306 let events_2 = node_a.node.get_and_clear_pending_events();
2307 assert_eq!(events_2.len(), 1);
2309 Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
2310 assert_eq!(*channel_value_satoshis, 100000);
2311 assert_eq!(user_channel_id, 42);
2313 tx = Transaction { version: chan_id as u32, lock_time: 0, input: Vec::new(), output: vec![TxOut {
2314 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
2316 funding_output = OutPoint::new(Sha256dHash::from_data(&serialize(&tx).unwrap()[..]), 0);
2318 node_a.node.funding_transaction_generated(&temporary_channel_id, funding_output);
2319 let mut added_monitors = node_a.chan_monitor.added_monitors.lock().unwrap();
2320 assert_eq!(added_monitors.len(), 1);
2321 assert_eq!(added_monitors[0].0, funding_output);
2322 added_monitors.clear();
2324 _ => panic!("Unexpected event"),
2327 let events_3 = node_a.node.get_and_clear_pending_events();
2328 assert_eq!(events_3.len(), 1);
2329 let funding_signed = match events_3[0] {
2330 Event::SendFundingCreated { ref node_id, ref msg } => {
2331 assert_eq!(*node_id, node_b.node.get_our_node_id());
2332 let res = node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), msg).unwrap();
2333 let mut added_monitors = node_b.chan_monitor.added_monitors.lock().unwrap();
2334 assert_eq!(added_monitors.len(), 1);
2335 assert_eq!(added_monitors[0].0, funding_output);
2336 added_monitors.clear();
2339 _ => panic!("Unexpected event"),
2342 node_a.node.handle_funding_signed(&node_b.node.get_our_node_id(), &funding_signed).unwrap();
2344 let mut added_monitors = node_a.chan_monitor.added_monitors.lock().unwrap();
2345 assert_eq!(added_monitors.len(), 1);
2346 assert_eq!(added_monitors[0].0, funding_output);
2347 added_monitors.clear();
2350 let events_4 = node_a.node.get_and_clear_pending_events();
2351 assert_eq!(events_4.len(), 1);
2353 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
2354 assert_eq!(user_channel_id, 42);
2355 assert_eq!(*funding_txo, funding_output);
2357 _ => panic!("Unexpected event"),
2360 confirm_transaction(&node_a.chain_monitor, &tx, chan_id);
2361 let events_5 = node_a.node.get_and_clear_pending_events();
2362 assert_eq!(events_5.len(), 1);
2364 Event::SendFundingLocked { ref node_id, ref msg, ref announcement_sigs } => {
2365 assert_eq!(*node_id, node_b.node.get_our_node_id());
2366 assert!(announcement_sigs.is_none());
2367 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), msg).unwrap()
2369 _ => panic!("Unexpected event"),
2374 confirm_transaction(&node_b.chain_monitor, &tx, chan_id);
2375 let events_6 = node_b.node.get_and_clear_pending_events();
2376 assert_eq!(events_6.len(), 1);
2377 let as_announcement_sigs = match events_6[0] {
2378 Event::SendFundingLocked { ref node_id, ref msg, ref announcement_sigs } => {
2379 assert_eq!(*node_id, node_a.node.get_our_node_id());
2380 channel_id = msg.channel_id.clone();
2381 let as_announcement_sigs = node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), msg).unwrap().unwrap();
2382 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &(*announcement_sigs).clone().unwrap()).unwrap();
2383 as_announcement_sigs
2385 _ => panic!("Unexpected event"),
2388 let events_7 = node_a.node.get_and_clear_pending_events();
2389 assert_eq!(events_7.len(), 1);
2390 let (announcement, as_update) = match events_7[0] {
2391 Event::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
2394 _ => panic!("Unexpected event"),
2397 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_announcement_sigs).unwrap();
2398 let events_8 = node_b.node.get_and_clear_pending_events();
2399 assert_eq!(events_8.len(), 1);
2400 let bs_update = match events_8[0] {
2401 Event::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
2402 assert!(*announcement == *msg);
2405 _ => panic!("Unexpected event"),
2412 ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone(), channel_id, tx)
2415 fn create_announced_chan_between_nodes(nodes: &Vec<Node>, a: usize, b: usize) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
2416 let chan_announcement = create_chan_between_nodes(&nodes[a], &nodes[b]);
2418 assert!(node.router.handle_channel_announcement(&chan_announcement.0).unwrap());
2419 node.router.handle_channel_update(&chan_announcement.1).unwrap();
2420 node.router.handle_channel_update(&chan_announcement.2).unwrap();
2422 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
2425 fn close_channel(outbound_node: &Node, inbound_node: &Node, channel_id: &[u8; 32], funding_tx: Transaction, close_inbound_first: bool) -> (msgs::ChannelUpdate, msgs::ChannelUpdate) {
2426 let (node_a, broadcaster_a) = if close_inbound_first { (&inbound_node.node, &inbound_node.tx_broadcaster) } else { (&outbound_node.node, &outbound_node.tx_broadcaster) };
2427 let (node_b, broadcaster_b) = if close_inbound_first { (&outbound_node.node, &outbound_node.tx_broadcaster) } else { (&inbound_node.node, &inbound_node.tx_broadcaster) };
2430 node_a.close_channel(channel_id).unwrap();
2431 let events_1 = node_a.get_and_clear_pending_events();
2432 assert_eq!(events_1.len(), 1);
2433 let shutdown_a = match events_1[0] {
2434 Event::SendShutdown { ref node_id, ref msg } => {
2435 assert_eq!(node_id, &node_b.get_our_node_id());
2438 _ => panic!("Unexpected event"),
2441 let (shutdown_b, mut closing_signed_b) = node_b.handle_shutdown(&node_a.get_our_node_id(), &shutdown_a).unwrap();
2442 if !close_inbound_first {
2443 assert!(closing_signed_b.is_none());
2445 let (empty_a, mut closing_signed_a) = node_a.handle_shutdown(&node_b.get_our_node_id(), &shutdown_b.unwrap()).unwrap();
2446 assert!(empty_a.is_none());
2447 if close_inbound_first {
2448 assert!(closing_signed_a.is_none());
2449 closing_signed_a = node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap()).unwrap();
2450 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
2451 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
2453 let empty_b = node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap()).unwrap();
2454 assert!(empty_b.is_none());
2455 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
2456 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
2458 closing_signed_b = node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap()).unwrap();
2459 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
2460 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
2462 let empty_a2 = node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap()).unwrap();
2463 assert!(empty_a2.is_none());
2464 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
2465 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
2467 assert_eq!(tx_a, tx_b);
2468 let mut funding_tx_map = HashMap::new();
2469 funding_tx_map.insert(funding_tx.txid(), funding_tx);
2470 tx_a.verify(&funding_tx_map).unwrap();
2472 let events_2 = node_a.get_and_clear_pending_events();
2473 assert_eq!(events_2.len(), 1);
2474 let as_update = match events_2[0] {
2475 Event::BroadcastChannelUpdate { ref msg } => {
2478 _ => panic!("Unexpected event"),
2481 let events_3 = node_b.get_and_clear_pending_events();
2482 assert_eq!(events_3.len(), 1);
2483 let bs_update = match events_3[0] {
2484 Event::BroadcastChannelUpdate { ref msg } => {
2487 _ => panic!("Unexpected event"),
2490 (as_update, bs_update)
2495 msgs: Vec<msgs::UpdateAddHTLC>,
2496 commitment_msg: msgs::CommitmentSigned,
2499 fn from_event(event: Event) -> SendEvent {
2501 Event::UpdateHTLCs { node_id, updates: msgs::CommitmentUpdate { update_add_htlcs, update_fulfill_htlcs, update_fail_htlcs, update_fail_malformed_htlcs, commitment_signed } } => {
2502 assert!(update_fulfill_htlcs.is_empty());
2503 assert!(update_fail_htlcs.is_empty());
2504 assert!(update_fail_malformed_htlcs.is_empty());
2505 SendEvent { node_id: node_id, msgs: update_add_htlcs, commitment_msg: commitment_signed }
2507 _ => panic!("Unexpected event type!"),
2512 static mut PAYMENT_COUNT: u8 = 0;
2513 fn send_along_route(origin_node: &Node, route: Route, expected_route: &[&Node], recv_value: u64) -> ([u8; 32], [u8; 32]) {
2514 let our_payment_preimage = unsafe { [PAYMENT_COUNT; 32] };
2515 unsafe { PAYMENT_COUNT += 1 };
2516 let our_payment_hash = {
2517 let mut sha = Sha256::new();
2518 sha.input(&our_payment_preimage[..]);
2519 let mut ret = [0; 32];
2520 sha.result(&mut ret);
2524 let mut payment_event = {
2525 origin_node.node.send_payment(route, our_payment_hash).unwrap();
2527 let mut added_monitors = origin_node.chan_monitor.added_monitors.lock().unwrap();
2528 assert_eq!(added_monitors.len(), 1);
2529 added_monitors.clear();
2532 let mut events = origin_node.node.get_and_clear_pending_events();
2533 assert_eq!(events.len(), 1);
2534 SendEvent::from_event(events.remove(0))
2536 let mut prev_node = origin_node;
2538 for (idx, &node) in expected_route.iter().enumerate() {
2539 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
2541 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
2543 let added_monitors = node.chan_monitor.added_monitors.lock().unwrap();
2544 assert_eq!(added_monitors.len(), 0);
2547 let revoke_and_ack = node.node.handle_commitment_signed(&prev_node.node.get_our_node_id(), &payment_event.commitment_msg).unwrap();
2549 let mut added_monitors = node.chan_monitor.added_monitors.lock().unwrap();
2550 assert_eq!(added_monitors.len(), 1);
2551 added_monitors.clear();
2553 assert!(prev_node.node.handle_revoke_and_ack(&node.node.get_our_node_id(), &revoke_and_ack.0).unwrap().is_none());
2554 let prev_revoke_and_ack = prev_node.node.handle_commitment_signed(&node.node.get_our_node_id(), &revoke_and_ack.1.unwrap()).unwrap();
2556 let mut added_monitors = prev_node.chan_monitor.added_monitors.lock().unwrap();
2557 assert_eq!(added_monitors.len(), 2);
2558 added_monitors.clear();
2560 assert!(node.node.handle_revoke_and_ack(&prev_node.node.get_our_node_id(), &prev_revoke_and_ack.0).unwrap().is_none());
2561 assert!(prev_revoke_and_ack.1.is_none());
2563 let mut added_monitors = node.chan_monitor.added_monitors.lock().unwrap();
2564 assert_eq!(added_monitors.len(), 1);
2565 added_monitors.clear();
2568 let events_1 = node.node.get_and_clear_pending_events();
2569 assert_eq!(events_1.len(), 1);
2571 Event::PendingHTLCsForwardable { .. } => { },
2572 _ => panic!("Unexpected event"),
2575 node.node.channel_state.lock().unwrap().next_forward = Instant::now();
2576 node.node.process_pending_htlc_forwards();
2578 let mut events_2 = node.node.get_and_clear_pending_events();
2579 assert_eq!(events_2.len(), 1);
2580 if idx == expected_route.len() - 1 {
2582 Event::PaymentReceived { ref payment_hash, amt } => {
2583 assert_eq!(our_payment_hash, *payment_hash);
2584 assert_eq!(amt, recv_value);
2586 _ => panic!("Unexpected event"),
2590 let mut added_monitors = node.chan_monitor.added_monitors.lock().unwrap();
2591 assert_eq!(added_monitors.len(), 1);
2592 added_monitors.clear();
2594 payment_event = SendEvent::from_event(events_2.remove(0));
2595 assert_eq!(payment_event.msgs.len(), 1);
2601 (our_payment_preimage, our_payment_hash)
2604 fn claim_payment(origin_node: &Node, expected_route: &[&Node], our_payment_preimage: [u8; 32]) {
2605 assert!(expected_route.last().unwrap().node.claim_funds(our_payment_preimage));
2607 let mut added_monitors = expected_route.last().unwrap().chan_monitor.added_monitors.lock().unwrap();
2608 assert_eq!(added_monitors.len(), 1);
2609 added_monitors.clear();
2612 let mut next_msgs: Option<(msgs::UpdateFulfillHTLC, msgs::CommitmentSigned)> = None;
2613 macro_rules! update_fulfill_dance {
2614 ($node: expr, $prev_node: expr, $last_node: expr) => {
2616 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0).unwrap();
2618 let mut added_monitors = $node.chan_monitor.added_monitors.lock().unwrap();
2620 assert_eq!(added_monitors.len(), 0);
2622 assert_eq!(added_monitors.len(), 1);
2624 added_monitors.clear();
2626 let revoke_and_commit = $node.node.handle_commitment_signed(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().1).unwrap();
2628 let mut added_monitors = $node.chan_monitor.added_monitors.lock().unwrap();
2629 assert_eq!(added_monitors.len(), 1);
2630 added_monitors.clear();
2632 assert!($prev_node.node.handle_revoke_and_ack(&$node.node.get_our_node_id(), &revoke_and_commit.0).unwrap().is_none());
2633 let revoke_and_ack = $prev_node.node.handle_commitment_signed(&$node.node.get_our_node_id(), &revoke_and_commit.1.unwrap()).unwrap();
2634 assert!(revoke_and_ack.1.is_none());
2636 let mut added_monitors = $prev_node.chan_monitor.added_monitors.lock().unwrap();
2637 assert_eq!(added_monitors.len(), 2);
2638 added_monitors.clear();
2640 assert!($node.node.handle_revoke_and_ack(&$prev_node.node.get_our_node_id(), &revoke_and_ack.0).unwrap().is_none());
2642 let mut added_monitors = $node.chan_monitor.added_monitors.lock().unwrap();
2643 assert_eq!(added_monitors.len(), 1);
2644 added_monitors.clear();
2650 let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
2651 let mut prev_node = expected_route.last().unwrap();
2652 for node in expected_route.iter().rev() {
2653 assert_eq!(expected_next_node, node.node.get_our_node_id());
2654 if next_msgs.is_some() {
2655 update_fulfill_dance!(node, prev_node, false);
2658 let events = node.node.get_and_clear_pending_events();
2659 assert_eq!(events.len(), 1);
2661 Event::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, ref commitment_signed } } => {
2662 assert!(update_add_htlcs.is_empty());
2663 assert_eq!(update_fulfill_htlcs.len(), 1);
2664 assert!(update_fail_htlcs.is_empty());
2665 assert!(update_fail_malformed_htlcs.is_empty());
2666 expected_next_node = node_id.clone();
2667 next_msgs = Some((update_fulfill_htlcs[0].clone(), commitment_signed.clone()));
2669 _ => panic!("Unexpected event"),
2675 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2676 update_fulfill_dance!(origin_node, expected_route.first().unwrap(), true);
2678 let events = origin_node.node.get_and_clear_pending_events();
2679 assert_eq!(events.len(), 1);
2681 Event::PaymentSent { payment_preimage } => {
2682 assert_eq!(payment_preimage, our_payment_preimage);
2684 _ => panic!("Unexpected event"),
2688 const TEST_FINAL_CLTV: u32 = 32;
2690 fn route_payment(origin_node: &Node, expected_route: &[&Node], recv_value: u64) -> ([u8; 32], [u8; 32]) {
2691 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();
2692 assert_eq!(route.hops.len(), expected_route.len());
2693 for (node, hop) in expected_route.iter().zip(route.hops.iter()) {
2694 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2697 send_along_route(origin_node, route, expected_route, recv_value)
2700 fn route_over_limit(origin_node: &Node, expected_route: &[&Node], recv_value: u64) {
2701 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();
2702 assert_eq!(route.hops.len(), expected_route.len());
2703 for (node, hop) in expected_route.iter().zip(route.hops.iter()) {
2704 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2707 let our_payment_preimage = unsafe { [PAYMENT_COUNT; 32] };
2708 unsafe { PAYMENT_COUNT += 1 };
2709 let our_payment_hash = {
2710 let mut sha = Sha256::new();
2711 sha.input(&our_payment_preimage[..]);
2712 let mut ret = [0; 32];
2713 sha.result(&mut ret);
2717 let err = origin_node.node.send_payment(route, our_payment_hash).err().unwrap();
2718 assert_eq!(err.err, "Cannot send value that would put us over our max HTLC value in flight");
2721 fn send_payment(origin: &Node, expected_route: &[&Node], recv_value: u64) {
2722 let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
2723 claim_payment(&origin, expected_route, our_payment_preimage);
2726 fn fail_payment(origin_node: &Node, expected_route: &[&Node], our_payment_hash: [u8; 32]) {
2727 assert!(expected_route.last().unwrap().node.fail_htlc_backwards(&our_payment_hash));
2729 let mut added_monitors = expected_route.last().unwrap().chan_monitor.added_monitors.lock().unwrap();
2730 assert_eq!(added_monitors.len(), 1);
2731 added_monitors.clear();
2734 let mut next_msgs: Option<(msgs::UpdateFailHTLC, msgs::CommitmentSigned)> = None;
2735 macro_rules! update_fail_dance {
2736 ($node: expr, $prev_node: expr, $last_node: expr) => {
2738 $node.node.handle_update_fail_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0).unwrap();
2739 let revoke_and_commit = $node.node.handle_commitment_signed(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().1).unwrap();
2742 let mut added_monitors = $node.chan_monitor.added_monitors.lock().unwrap();
2743 assert_eq!(added_monitors.len(), 1);
2744 added_monitors.clear();
2746 assert!($prev_node.node.handle_revoke_and_ack(&$node.node.get_our_node_id(), &revoke_and_commit.0).unwrap().is_none());
2748 let mut added_monitors = $prev_node.chan_monitor.added_monitors.lock().unwrap();
2749 assert_eq!(added_monitors.len(), 1);
2750 added_monitors.clear();
2752 let revoke_and_ack = $prev_node.node.handle_commitment_signed(&$node.node.get_our_node_id(), &revoke_and_commit.1.unwrap()).unwrap();
2754 let mut added_monitors = $prev_node.chan_monitor.added_monitors.lock().unwrap();
2755 assert_eq!(added_monitors.len(), 1);
2756 added_monitors.clear();
2758 assert!(revoke_and_ack.1.is_none());
2759 assert!($node.node.get_and_clear_pending_events().is_empty());
2760 assert!($node.node.handle_revoke_and_ack(&$prev_node.node.get_our_node_id(), &revoke_and_ack.0).unwrap().is_none());
2762 let mut added_monitors = $node.chan_monitor.added_monitors.lock().unwrap();
2764 assert_eq!(added_monitors.len(), 1);
2766 assert_eq!(added_monitors.len(), 2);
2767 assert!(added_monitors[0].0 != added_monitors[1].0);
2769 added_monitors.clear();
2775 let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
2776 let mut prev_node = expected_route.last().unwrap();
2777 for node in expected_route.iter().rev() {
2778 assert_eq!(expected_next_node, node.node.get_our_node_id());
2779 if next_msgs.is_some() {
2780 update_fail_dance!(node, prev_node, false);
2783 let events = node.node.get_and_clear_pending_events();
2784 assert_eq!(events.len(), 1);
2786 Event::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, ref commitment_signed } } => {
2787 assert!(update_add_htlcs.is_empty());
2788 assert!(update_fulfill_htlcs.is_empty());
2789 assert_eq!(update_fail_htlcs.len(), 1);
2790 assert!(update_fail_malformed_htlcs.is_empty());
2791 expected_next_node = node_id.clone();
2792 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
2794 _ => panic!("Unexpected event"),
2800 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2801 update_fail_dance!(origin_node, expected_route.first().unwrap(), true);
2803 let events = origin_node.node.get_and_clear_pending_events();
2804 assert_eq!(events.len(), 1);
2806 Event::PaymentFailed { payment_hash } => {
2807 assert_eq!(payment_hash, our_payment_hash);
2809 _ => panic!("Unexpected event"),
2813 fn create_network(node_count: usize) -> Vec<Node> {
2814 let mut nodes = Vec::new();
2815 let mut rng = thread_rng();
2816 let secp_ctx = Secp256k1::new();
2817 let logger: Arc<Logger> = Arc::new(test_utils::TestLogger::new());
2819 for _ in 0..node_count {
2820 let feeest = Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 });
2821 let chain_monitor = Arc::new(chaininterface::ChainWatchInterfaceUtil::new(Arc::clone(&logger)));
2822 let tx_broadcaster = Arc::new(test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())});
2823 let chan_monitor = Arc::new(test_utils::TestChannelMonitor::new(chain_monitor.clone(), tx_broadcaster.clone()));
2825 let mut key_slice = [0; 32];
2826 rng.fill_bytes(&mut key_slice);
2827 SecretKey::from_slice(&secp_ctx, &key_slice).unwrap()
2829 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();
2830 let router = Router::new(PublicKey::from_secret_key(&secp_ctx, &node_id), Arc::clone(&logger));
2831 nodes.push(Node { chain_monitor, tx_broadcaster, chan_monitor, node, router });
2838 fn fake_network_test() {
2839 // Simple test which builds a network of ChannelManagers, connects them to each other, and
2840 // tests that payments get routed and transactions broadcast in semi-reasonable ways.
2841 let nodes = create_network(4);
2843 // Create some initial channels
2844 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
2845 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
2846 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3);
2848 // Rebalance the network a bit by relaying one payment through all the channels...
2849 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
2850 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
2851 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
2852 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
2854 // Send some more payments
2855 send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000);
2856 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000);
2857 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000);
2859 // Test failure packets
2860 let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
2861 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
2863 // Add a new channel that skips 3
2864 let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3);
2866 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000);
2867 send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000);
2868 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
2869 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
2870 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
2871 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
2872 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
2874 // Do some rebalance loop payments, simultaneously
2875 let mut hops = Vec::with_capacity(3);
2876 hops.push(RouteHop {
2877 pubkey: nodes[2].node.get_our_node_id(),
2878 short_channel_id: chan_2.0.contents.short_channel_id,
2880 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
2882 hops.push(RouteHop {
2883 pubkey: nodes[3].node.get_our_node_id(),
2884 short_channel_id: chan_3.0.contents.short_channel_id,
2886 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
2888 hops.push(RouteHop {
2889 pubkey: nodes[1].node.get_our_node_id(),
2890 short_channel_id: chan_4.0.contents.short_channel_id,
2892 cltv_expiry_delta: TEST_FINAL_CLTV,
2894 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;
2895 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;
2896 let payment_preimage_1 = send_along_route(&nodes[1], Route { hops }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
2898 let mut hops = Vec::with_capacity(3);
2899 hops.push(RouteHop {
2900 pubkey: nodes[3].node.get_our_node_id(),
2901 short_channel_id: chan_4.0.contents.short_channel_id,
2903 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
2905 hops.push(RouteHop {
2906 pubkey: nodes[2].node.get_our_node_id(),
2907 short_channel_id: chan_3.0.contents.short_channel_id,
2909 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
2911 hops.push(RouteHop {
2912 pubkey: nodes[1].node.get_our_node_id(),
2913 short_channel_id: chan_2.0.contents.short_channel_id,
2915 cltv_expiry_delta: TEST_FINAL_CLTV,
2917 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;
2918 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;
2919 let payment_hash_2 = send_along_route(&nodes[1], Route { hops }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
2921 // Claim the rebalances...
2922 fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
2923 claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1);
2925 // Add a duplicate new channel from 2 to 4
2926 let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3);
2928 // Send some payments across both channels
2929 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
2930 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
2931 let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
2933 route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
2935 //TODO: Test that routes work again here as we've been notified that the channel is full
2937 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3);
2938 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4);
2939 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5);
2941 // Close down the channels...
2942 close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
2943 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
2944 close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
2945 close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
2946 close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
2948 // Check that we processed all pending events
2950 assert_eq!(node.node.get_and_clear_pending_events().len(), 0);
2951 assert_eq!(node.chan_monitor.added_monitors.lock().unwrap().len(), 0);
2955 #[derive(PartialEq)]
2956 enum HTLCType { NONE, TIMEOUT, SUCCESS }
2957 fn test_txn_broadcast(node: &Node, chan: &(msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction), commitment_tx: Option<Transaction>, has_htlc_tx: HTLCType) -> Vec<Transaction> {
2958 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2959 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
2961 let mut res = Vec::with_capacity(2);
2963 if let Some(explicit_tx) = commitment_tx {
2964 res.push(explicit_tx.clone());
2966 for tx in node_txn.iter() {
2967 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
2968 let mut funding_tx_map = HashMap::new();
2969 funding_tx_map.insert(chan.3.txid(), chan.3.clone());
2970 tx.verify(&funding_tx_map).unwrap();
2971 res.push(tx.clone());
2975 assert_eq!(res.len(), 1);
2977 if has_htlc_tx != HTLCType::NONE {
2978 for tx in node_txn.iter() {
2979 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
2980 let mut funding_tx_map = HashMap::new();
2981 funding_tx_map.insert(res[0].txid(), res[0].clone());
2982 tx.verify(&funding_tx_map).unwrap();
2983 if has_htlc_tx == HTLCType::TIMEOUT {
2984 assert!(tx.lock_time != 0);
2986 assert!(tx.lock_time == 0);
2988 res.push(tx.clone());
2992 assert_eq!(res.len(), 2);
2998 fn check_preimage_claim(node: &Node, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
2999 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
3001 assert!(node_txn.len() >= 1);
3002 assert_eq!(node_txn[0].input.len(), 1);
3003 let mut found_prev = false;
3005 for tx in prev_txn {
3006 if node_txn[0].input[0].previous_output.txid == tx.txid() {
3007 let mut funding_tx_map = HashMap::new();
3008 funding_tx_map.insert(tx.txid(), tx.clone());
3009 node_txn[0].verify(&funding_tx_map).unwrap();
3011 assert!(node_txn[0].input[0].witness[2].len() > 106); // must spend an htlc output
3012 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
3018 assert!(found_prev);
3020 let mut res = Vec::new();
3021 mem::swap(&mut *node_txn, &mut res);
3025 fn get_announce_close_broadcast_events(nodes: &Vec<Node>, a: usize, b: usize) {
3026 let events_1 = nodes[a].node.get_and_clear_pending_events();
3027 assert_eq!(events_1.len(), 1);
3028 let as_update = match events_1[0] {
3029 Event::BroadcastChannelUpdate { ref msg } => {
3032 _ => panic!("Unexpected event"),
3035 let events_2 = nodes[b].node.get_and_clear_pending_events();
3036 assert_eq!(events_2.len(), 1);
3037 let bs_update = match events_2[0] {
3038 Event::BroadcastChannelUpdate { ref msg } => {
3041 _ => panic!("Unexpected event"),
3045 node.router.handle_channel_update(&as_update).unwrap();
3046 node.router.handle_channel_update(&bs_update).unwrap();
3051 fn channel_monitor_network_test() {
3052 // Simple test which builds a network of ChannelManagers, connects them to each other, and
3053 // tests that ChannelMonitor is able to recover from various states.
3054 let nodes = create_network(5);
3056 // Create some initial channels
3057 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
3058 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
3059 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3);
3060 let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4);
3062 // Rebalance the network a bit by relaying one payment through all the channels...
3063 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
3064 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
3065 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
3066 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
3068 // Simple case with no pending HTLCs:
3069 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
3071 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
3072 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3073 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
3074 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
3076 get_announce_close_broadcast_events(&nodes, 0, 1);
3077 assert_eq!(nodes[0].node.list_channels().len(), 0);
3078 assert_eq!(nodes[1].node.list_channels().len(), 1);
3080 // One pending HTLC is discarded by the force-close:
3081 let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
3083 // Simple case of one pending HTLC to HTLC-Timeout
3084 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
3086 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
3087 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3088 nodes[2].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
3089 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
3091 get_announce_close_broadcast_events(&nodes, 1, 2);
3092 assert_eq!(nodes[1].node.list_channels().len(), 0);
3093 assert_eq!(nodes[2].node.list_channels().len(), 1);
3095 macro_rules! claim_funds {
3096 ($node: expr, $prev_node: expr, $preimage: expr) => {
3098 assert!($node.node.claim_funds($preimage));
3100 let mut added_monitors = $node.chan_monitor.added_monitors.lock().unwrap();
3101 assert_eq!(added_monitors.len(), 1);
3102 added_monitors.clear();
3105 let events = $node.node.get_and_clear_pending_events();
3106 assert_eq!(events.len(), 1);
3108 Event::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
3109 assert!(update_add_htlcs.is_empty());
3110 assert!(update_fail_htlcs.is_empty());
3111 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
3113 _ => panic!("Unexpected event"),
3119 // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
3120 // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
3121 nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
3123 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
3125 // Claim the payment on nodes[3], giving it knowledge of the preimage
3126 claim_funds!(nodes[3], nodes[2], payment_preimage_1);
3128 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3129 nodes[3].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[0].clone()] }, 1);
3131 check_preimage_claim(&nodes[3], &node_txn);
3133 get_announce_close_broadcast_events(&nodes, 2, 3);
3134 assert_eq!(nodes[2].node.list_channels().len(), 0);
3135 assert_eq!(nodes[3].node.list_channels().len(), 1);
3137 // One pending HTLC to time out:
3138 let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
3141 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3142 nodes[3].chain_monitor.block_connected_checked(&header, 1, &Vec::new()[..], &[0; 0]);
3143 for i in 2..TEST_FINAL_CLTV - 3 {
3144 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3145 nodes[3].chain_monitor.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
3148 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
3150 // Claim the payment on nodes[3], giving it knowledge of the preimage
3151 claim_funds!(nodes[4], nodes[3], payment_preimage_2);
3153 header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3154 nodes[4].chain_monitor.block_connected_checked(&header, 1, &Vec::new()[..], &[0; 0]);
3155 for i in 2..TEST_FINAL_CLTV - 3 {
3156 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3157 nodes[4].chain_monitor.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
3160 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
3162 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3163 nodes[4].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[0].clone()] }, TEST_FINAL_CLTV - 5);
3165 check_preimage_claim(&nodes[4], &node_txn);
3167 get_announce_close_broadcast_events(&nodes, 3, 4);
3168 assert_eq!(nodes[3].node.list_channels().len(), 0);
3169 assert_eq!(nodes[4].node.list_channels().len(), 0);
3171 // Create some new channels:
3172 let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1);
3174 // A pending HTLC which will be revoked:
3175 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
3176 // Get the will-be-revoked local txn from nodes[0]
3177 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.iter().next().unwrap().1.last_local_commitment_txn.clone();
3178 // Revoke the old state
3179 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
3182 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3183 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3185 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3186 assert_eq!(node_txn.len(), 2);
3187 assert_eq!(node_txn[0].input.len(), 1);
3189 let mut funding_tx_map = HashMap::new();
3190 funding_tx_map.insert(revoked_local_txn[0].txid(), revoked_local_txn[0].clone());
3191 node_txn[0].verify(&funding_tx_map).unwrap();
3192 node_txn.swap_remove(0);
3194 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
3196 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3197 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
3198 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3199 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
3201 //TODO: At this point nodes[1] should claim the revoked HTLC-Timeout output, but that's
3202 //not yet implemented in ChannelMonitor
3204 get_announce_close_broadcast_events(&nodes, 0, 1);
3205 assert_eq!(nodes[0].node.list_channels().len(), 0);
3206 assert_eq!(nodes[1].node.list_channels().len(), 0);
3208 // Check that we processed all pending events
3210 assert_eq!(node.node.get_and_clear_pending_events().len(), 0);
3211 assert_eq!(node.chan_monitor.added_monitors.lock().unwrap().len(), 0);
3216 fn test_unconf_chan() {
3217 // After creating a chan between nodes, we disconnect all blocks previously seen to force a channel close on nodes[0] side
3218 let nodes = create_network(2);
3219 create_announced_chan_between_nodes(&nodes, 0, 1);
3221 let channel_state = nodes[0].node.channel_state.lock().unwrap();
3222 assert_eq!(channel_state.by_id.len(), 1);
3223 assert_eq!(channel_state.short_to_id.len(), 1);
3224 mem::drop(channel_state);
3226 let mut headers = Vec::new();
3227 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3228 headers.push(header.clone());
3230 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3231 headers.push(header.clone());
3233 while !headers.is_empty() {
3234 nodes[0].node.block_disconnected(&headers.pop().unwrap());
3236 let channel_state = nodes[0].node.channel_state.lock().unwrap();
3237 assert_eq!(channel_state.by_id.len(), 0);
3238 assert_eq!(channel_state.short_to_id.len(), 0);