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;
7 use bitcoin::util::uint::Uint256;
9 use secp256k1::key::{SecretKey,PublicKey};
10 use secp256k1::{Secp256k1,Message};
11 use secp256k1::ecdh::SharedSecret;
14 use chain::chaininterface::{BroadcasterInterface,ChainListener,ChainWatchInterface,FeeEstimator};
15 use ln::channel::Channel;
16 use ln::channelmonitor::ManyChannelMonitor;
17 use ln::router::Route;
19 use ln::msgs::{HandleError,ChannelMessageHandler,MsgEncodable,MsgDecodable};
20 use util::{byte_utils, events, internal_traits, rng};
21 use util::sha2::Sha256;
23 use crypto::mac::{Mac,MacResult};
24 use crypto::hmac::Hmac;
25 use crypto::digest::Digest;
26 use crypto::symmetriccipher::SynchronousStreamCipher;
27 use crypto::chacha20::ChaCha20;
29 use std::sync::{Mutex,MutexGuard,Arc};
30 use std::collections::HashMap;
31 use std::collections::hash_map;
33 use std::time::{Instant,Duration};
35 mod channel_held_info {
38 /// Stores the info we will need to send when we want to forward an HTLC onwards
39 pub struct PendingForwardHTLCInfo {
40 pub(super) onion_packet: Option<msgs::OnionPacket>,
41 pub(super) payment_hash: [u8; 32],
42 pub(super) short_channel_id: u64,
43 pub(super) prev_short_channel_id: u64,
44 pub(super) amt_to_forward: u64,
45 pub(super) outgoing_cltv_value: u32,
48 #[cfg(feature = "fuzztarget")]
49 impl PendingForwardHTLCInfo {
50 pub fn dummy() -> Self {
53 payment_hash: [0; 32],
55 prev_short_channel_id: 0,
57 outgoing_cltv_value: 0,
62 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
63 pub enum HTLCFailReason {
65 err: msgs::OnionErrorPacket,
73 #[cfg(feature = "fuzztarget")]
75 pub fn dummy() -> Self {
76 HTLCFailReason::Reason {
77 failure_code: 0, data: Vec::new(),
82 #[cfg(feature = "fuzztarget")]
83 pub use self::channel_held_info::*;
84 #[cfg(not(feature = "fuzztarget"))]
85 pub(crate) use self::channel_held_info::*;
87 enum PendingOutboundHTLC {
89 source_short_channel_id: u64,
90 incoming_packet_shared_secret: SharedSecret,
95 /// Used for channel rebalancing
97 source_short_channel_id: u64,
98 incoming_packet_shared_secret: SharedSecret,
103 /// We hold back HTLCs we intend to relay for a random interval in the range (this, 5*this). This
104 /// provides some limited amount of privacy. Ideally this would range from somewhere like 1 second
105 /// to 30 seconds, but people expect lightning to be, you know, kinda fast, sadly. We could
106 /// probably increase this significantly.
107 const MIN_HTLC_RELAY_HOLDING_CELL_MILLIS: u32 = 50;
109 struct ChannelHolder {
110 by_id: HashMap<Uint256, Channel>,
111 short_to_id: HashMap<u64, Uint256>,
112 next_forward: Instant,
113 /// short channel id -> forward infos. Key of 0 means payments received
114 forward_htlcs: HashMap<u64, Vec<PendingForwardHTLCInfo>>,
115 claimable_htlcs: HashMap<[u8; 32], PendingOutboundHTLC>,
117 struct MutChannelHolder<'a> {
118 by_id: &'a mut HashMap<Uint256, Channel>,
119 short_to_id: &'a mut HashMap<u64, Uint256>,
120 next_forward: &'a mut Instant,
121 /// short channel id -> forward infos. Key of 0 means payments received
122 forward_htlcs: &'a mut HashMap<u64, Vec<PendingForwardHTLCInfo>>,
123 claimable_htlcs: &'a mut HashMap<[u8; 32], PendingOutboundHTLC>,
126 fn borrow_parts(&mut self) -> MutChannelHolder {
128 by_id: &mut self.by_id,
129 short_to_id: &mut self.short_to_id,
130 next_forward: &mut self.next_forward,
131 /// short channel id -> forward infos. Key of 0 means payments received
132 forward_htlcs: &mut self.forward_htlcs,
133 claimable_htlcs: &mut self.claimable_htlcs,
138 /// Manager which keeps track of a number of channels and sends messages to the appropriate
139 /// channel, also tracking HTLC preimages and forwarding onion packets appropriately.
140 /// Implements ChannelMessageHandler, handling the multi-channel parts and passing things through
141 /// to individual Channels.
142 pub struct ChannelManager {
143 genesis_hash: Sha256dHash,
144 fee_estimator: Arc<FeeEstimator>,
145 monitor: Arc<ManyChannelMonitor>,
146 chain_monitor: Arc<ChainWatchInterface>,
147 tx_broadcaster: Arc<BroadcasterInterface>,
149 announce_channels_publicly: bool,
150 fee_proportional_millionths: u32,
153 channel_state: Mutex<ChannelHolder>,
154 our_network_key: SecretKey,
156 pending_events: Mutex<Vec<events::Event>>,
159 const CLTV_EXPIRY_DELTA: u16 = 6 * 24 * 2; //TODO?
161 macro_rules! secp_call {
165 //TODO: Make the err a parameter!
166 Err(_) => return Err(HandleError{err: "Key error", msg: None})
173 shared_secret: SharedSecret,
175 blinding_factor: [u8; 32],
176 ephemeral_pubkey: PublicKey,
181 pub struct ChannelDetails {
182 /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
183 /// thereafter this is the txid of the funding transaction xor the funding transaction output).
184 /// Note that this means this value is *not* persistent - it can change once during the
185 /// lifetime of the channel.
186 pub channel_id: Uint256,
187 /// The position of the funding transaction in the chain. None if the funding transaction has
188 /// not yet been confirmed and the channel fully opened.
189 pub short_channel_id: Option<u64>,
190 pub remote_network_id: PublicKey,
191 pub channel_value_satoshis: u64,
192 /// The user_id passed in to create_channel, or 0 if the channel was inbound.
196 impl ChannelManager {
197 /// Constructs a new ChannelManager to hold several channels and route between them. This is
198 /// the main "logic hub" for all channel-related actions, and implements ChannelMessageHandler.
199 /// fee_proportional_millionths is an optional fee to charge any payments routed through us.
200 /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
201 /// panics if channel_value_satoshis is >= (1 << 24)!
202 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>) -> Result<Arc<ChannelManager>, secp256k1::Error> {
203 let secp_ctx = Secp256k1::new();
205 let res = Arc::new(ChannelManager {
206 genesis_hash: genesis_block(network).header.bitcoin_hash(),
207 fee_estimator: feeest.clone(),
208 monitor: monitor.clone(),
212 announce_channels_publicly,
213 fee_proportional_millionths,
216 channel_state: Mutex::new(ChannelHolder{
217 by_id: HashMap::new(),
218 short_to_id: HashMap::new(),
219 next_forward: Instant::now(),
220 forward_htlcs: HashMap::new(),
221 claimable_htlcs: HashMap::new(),
225 pending_events: Mutex::new(Vec::new()),
227 let weak_res = Arc::downgrade(&res);
228 res.chain_monitor.register_listener(weak_res);
232 pub fn create_channel(&self, their_network_key: PublicKey, channel_value_satoshis: u64, user_id: u64) -> Result<msgs::OpenChannel, HandleError> {
233 let channel = Channel::new_outbound(&*self.fee_estimator, their_network_key, channel_value_satoshis, self.announce_channels_publicly, user_id);
234 let res = channel.get_open_channel(self.genesis_hash.clone(), &*self.fee_estimator)?;
235 let mut channel_state = self.channel_state.lock().unwrap();
236 match channel_state.by_id.insert(channel.channel_id(), channel) {
237 Some(_) => panic!("RNG is bad???"),
242 /// Gets the list of open channels, in random order. See ChannelDetail field documentation for
243 /// more information.
244 pub fn list_channels(&self) -> Vec<ChannelDetails> {
245 let channel_state = self.channel_state.lock().unwrap();
246 let mut res = Vec::with_capacity(channel_state.by_id.len());
247 for (channel_id, channel) in channel_state.by_id.iter() {
248 res.push(ChannelDetails {
249 channel_id: (*channel_id).clone(),
250 short_channel_id: channel.get_short_channel_id(),
251 remote_network_id: channel.get_their_node_id(),
252 channel_value_satoshis: channel.get_value_satoshis(),
253 user_id: channel.get_user_id(),
259 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
260 /// will be accepted on the given channel, and after additional timeout/the closing of all
261 /// pending HTLCs, the channel will be closed on chain.
262 pub fn close_channel(&self, channel_id: &Uint256) -> Result<msgs::Shutdown, HandleError> {
264 let mut channel_state = self.channel_state.lock().unwrap();
265 match channel_state.by_id.entry(channel_id.clone()) {
266 hash_map::Entry::Occupied(mut chan_entry) => {
267 let res = chan_entry.get_mut().get_shutdown()?;
268 if chan_entry.get().is_shutdown() {
269 chan_entry.remove_entry();
273 hash_map::Entry::Vacant(_) => return Err(HandleError{err: "No such channel", msg: None})
276 for payment_hash in res.1 {
277 // unknown_next_peer...I dunno who that is anymore....
278 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), &payment_hash, HTLCFailReason::Reason { failure_code: 0x4000 | 10, data: Vec::new() });
284 fn gen_rho_mu_from_shared_secret(shared_secret: &SharedSecret) -> ([u8; 32], [u8; 32]) {
286 let mut hmac = Hmac::new(Sha256::new(), &[0x72, 0x68, 0x6f]); // rho
287 hmac.input(&shared_secret[..]);
288 let mut res = [0; 32];
289 hmac.raw_result(&mut res);
293 let mut hmac = Hmac::new(Sha256::new(), &[0x6d, 0x75]); // mu
294 hmac.input(&shared_secret[..]);
295 let mut res = [0; 32];
296 hmac.raw_result(&mut res);
302 fn gen_um_from_shared_secret(shared_secret: &SharedSecret) -> [u8; 32] {
303 let mut hmac = Hmac::new(Sha256::new(), &[0x75, 0x6d]); // um
304 hmac.input(&shared_secret[..]);
305 let mut res = [0; 32];
306 hmac.raw_result(&mut res);
310 fn gen_ammag_from_shared_secret(shared_secret: &SharedSecret) -> [u8; 32] {
311 let mut hmac = Hmac::new(Sha256::new(), &[0x61, 0x6d, 0x6d, 0x61, 0x67]); // ammag
312 hmac.input(&shared_secret[..]);
313 let mut res = [0; 32];
314 hmac.raw_result(&mut res);
318 fn construct_onion_keys(secp_ctx: &Secp256k1, route: &Route, session_priv: &SecretKey) -> Result<Vec<OnionKeys>, HandleError> {
319 let mut res = Vec::with_capacity(route.hops.len());
320 let mut blinded_priv = session_priv.clone();
321 let mut blinded_pub = secp_call!(PublicKey::from_secret_key(secp_ctx, &blinded_priv));
322 let mut first_iteration = true;
324 for hop in route.hops.iter() {
325 let shared_secret = SharedSecret::new(secp_ctx, &hop.pubkey, &blinded_priv);
327 let mut sha = Sha256::new();
328 sha.input(&blinded_pub.serialize()[..]);
329 sha.input(&shared_secret[..]);
330 let mut blinding_factor = [0u8; 32];
331 sha.result(&mut blinding_factor);
334 blinded_pub = secp_call!(PublicKey::from_secret_key(secp_ctx, &blinded_priv));
335 first_iteration = false;
337 let ephemeral_pubkey = blinded_pub;
339 secp_call!(blinded_priv.mul_assign(secp_ctx, &secp_call!(SecretKey::from_slice(secp_ctx, &blinding_factor))));
340 blinded_pub = secp_call!(PublicKey::from_secret_key(secp_ctx, &blinded_priv));
342 let (rho, mu) = ChannelManager::gen_rho_mu_from_shared_secret(&shared_secret);
346 shared_secret: shared_secret,
348 blinding_factor: blinding_factor,
349 ephemeral_pubkey: ephemeral_pubkey,
358 /// returns the hop data, as well as the first-hop value_msat and CLTV value we should send.
359 fn build_onion_payloads(route: &Route) -> Result<(Vec<msgs::OnionHopData>, u64, u32), HandleError> {
360 let mut cur_value_msat = 0u64;
361 let mut cur_cltv = 0u32;
362 let mut last_short_channel_id = 0;
363 let mut res: Vec<msgs::OnionHopData> = Vec::with_capacity(route.hops.len());
364 internal_traits::test_no_dealloc::<msgs::OnionHopData>(None);
365 unsafe { res.set_len(route.hops.len()); }
367 for (idx, hop) in route.hops.iter().enumerate().rev() {
368 // First hop gets special values so that it can check, on receipt, that everything is
369 // exactly as it should be (and the next hop isn't trying to probe to find out if we're
370 // the intended recipient).
371 let value_msat = if cur_value_msat == 0 { hop.fee_msat } else { cur_value_msat };
372 let cltv = if cur_cltv == 0 { hop.cltv_expiry_delta } else { cur_cltv };
373 res[idx] = msgs::OnionHopData {
375 data: msgs::OnionRealm0HopData {
376 short_channel_id: last_short_channel_id,
377 amt_to_forward: value_msat,
378 outgoing_cltv_value: cltv,
382 cur_value_msat += hop.fee_msat;
383 if cur_value_msat >= 21000000 * 100000000 * 1000 {
384 return Err(HandleError{err: "Channel fees overflowed?!", msg: None});
386 cur_cltv += hop.cltv_expiry_delta as u32;
387 if cur_cltv >= 500000000 {
388 return Err(HandleError{err: "Channel CLTV overflowed?!", msg: None});
390 last_short_channel_id = hop.short_channel_id;
392 Ok((res, cur_value_msat, cur_cltv))
396 fn shift_arr_right(arr: &mut [u8; 20*65]) {
398 ptr::copy(arr[0..].as_ptr(), arr[65..].as_mut_ptr(), 19*65);
406 fn xor_bufs(dst: &mut[u8], src: &[u8]) {
407 assert_eq!(dst.len(), src.len());
409 for i in 0..dst.len() {
414 const ZERO:[u8; 21*65] = [0; 21*65];
415 fn construct_onion_packet(mut payloads: Vec<msgs::OnionHopData>, onion_keys: Vec<OnionKeys>, associated_data: Vec<u8>) -> Result<msgs::OnionPacket, HandleError> {
416 let mut buf = Vec::with_capacity(21*65);
417 buf.resize(21*65, 0);
420 let iters = payloads.len() - 1;
421 let end_len = iters * 65;
422 let mut res = Vec::with_capacity(end_len);
423 res.resize(end_len, 0);
425 for (i, keys) in onion_keys.iter().enumerate() {
426 if i == payloads.len() - 1 { continue; }
427 let mut chacha = ChaCha20::new(&keys.rho, &[0u8; 8]);
428 chacha.process(&ChannelManager::ZERO, &mut buf); // We don't have a seek function :(
429 ChannelManager::xor_bufs(&mut res[0..(i + 1)*65], &buf[(20 - i)*65..21*65]);
434 let mut packet_data = [0; 20*65];
435 let mut hmac_res = [0; 32];
437 for (i, (payload, keys)) in payloads.iter_mut().zip(onion_keys.iter()).rev().enumerate() {
438 ChannelManager::shift_arr_right(&mut packet_data);
439 payload.hmac = hmac_res;
440 packet_data[0..65].copy_from_slice(&payload.encode()[..]);
442 let mut chacha = ChaCha20::new(&keys.rho, &[0u8; 8]);
443 chacha.process(&packet_data, &mut buf[0..20*65]);
444 packet_data[..].copy_from_slice(&buf[0..20*65]);
447 packet_data[20*65 - filler.len()..20*65].copy_from_slice(&filler[..]);
450 let mut hmac = Hmac::new(Sha256::new(), &keys.mu);
451 hmac.input(&packet_data);
452 hmac.input(&associated_data[..]);
453 hmac.raw_result(&mut hmac_res);
456 Ok(msgs::OnionPacket{
458 public_key: onion_keys.first().unwrap().ephemeral_pubkey,
459 hop_data: packet_data,
464 /// Encrypts a failure packet. raw_packet can either be a
465 /// msgs::DecodedOnionErrorPacket.encode() result or a msgs::OnionErrorPacket.data element.
466 fn encrypt_failure_packet(shared_secret: &SharedSecret, raw_packet: &[u8]) -> msgs::OnionErrorPacket {
467 let ammag = ChannelManager::gen_ammag_from_shared_secret(&shared_secret);
469 let mut packet_crypted = Vec::with_capacity(raw_packet.len());
470 packet_crypted.resize(raw_packet.len(), 0);
471 let mut chacha = ChaCha20::new(&ammag, &[0u8; 8]);
472 chacha.process(&raw_packet, &mut packet_crypted[..]);
473 msgs::OnionErrorPacket {
474 data: packet_crypted,
478 fn build_failure_packet(shared_secret: &SharedSecret, failure_type: u16, failure_data: &[u8]) -> msgs::DecodedOnionErrorPacket {
479 assert!(failure_data.len() <= 256 - 2);
481 let um = ChannelManager::gen_um_from_shared_secret(&shared_secret);
484 let mut res = Vec::with_capacity(2 + failure_data.len());
485 res.push(((failure_type >> 8) & 0xff) as u8);
486 res.push(((failure_type >> 0) & 0xff) as u8);
487 res.extend_from_slice(&failure_data[..]);
491 let mut res = Vec::with_capacity(256 - 2 - failure_data.len());
492 res.resize(256 - 2 - failure_data.len(), 0);
495 let mut packet = msgs::DecodedOnionErrorPacket {
497 failuremsg: failuremsg,
501 let mut hmac = Hmac::new(Sha256::new(), &um);
502 hmac.input(&packet.encode()[32..]);
503 hmac.raw_result(&mut packet.hmac);
508 fn build_first_hop_failure_packet(shared_secret: &SharedSecret, failure_type: u16, failure_data: &[u8]) -> msgs::OnionErrorPacket {
509 let failure_packet = ChannelManager::build_failure_packet(shared_secret, failure_type, failure_data);
510 ChannelManager::encrypt_failure_packet(shared_secret, &failure_packet.encode()[..])
513 /// only fails if the channel does not yet have an assigned short_id
514 fn get_channel_update(&self, chan: &mut Channel) -> Result<msgs::ChannelUpdate, HandleError> {
515 let short_channel_id = match chan.get_short_channel_id() {
516 None => return Err(HandleError{err: "Channel not yet established", msg: None}),
520 let were_node_one = PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key).unwrap().serialize()[..] < chan.get_their_node_id().serialize()[..];
522 let unsigned = msgs::UnsignedChannelUpdate {
523 chain_hash: self.genesis_hash,
524 short_channel_id: short_channel_id,
525 timestamp: chan.get_channel_update_count(),
526 flags: (!were_node_one) as u16 | ((!chan.is_live() as u16) << 1),
527 cltv_expiry_delta: CLTV_EXPIRY_DELTA,
528 htlc_minimum_msat: chan.get_our_htlc_minimum_msat(),
529 fee_base_msat: chan.get_our_fee_base_msat(&*self.fee_estimator),
530 fee_proportional_millionths: self.fee_proportional_millionths,
533 let msg_hash = Sha256dHash::from_data(&unsigned.encode()[..]);
534 let sig = self.secp_ctx.sign(&Message::from_slice(&msg_hash[..]).unwrap(), &self.our_network_key).unwrap(); //TODO Can we unwrap here?
536 Ok(msgs::ChannelUpdate {
542 /// Sends a payment along a given route, returning the UpdateAddHTLC message to give to the
543 /// first hop in route. Value parameters are provided via the last hop in route, see
544 /// documentation for RouteHop fields for more info.
545 /// See-also docs on Channel::send_htlc_and_commit.
546 pub fn send_payment(&self, route: Route, payment_hash: [u8; 32]) -> Result<Option<(msgs::UpdateAddHTLC, msgs::CommitmentSigned)>, HandleError> {
547 if route.hops.len() < 1 || route.hops.len() > 20 {
548 return Err(HandleError{err: "Route didn't go anywhere/had bogus size", msg: None});
550 let our_node_id = self.get_our_node_id();
551 for (idx, hop) in route.hops.iter().enumerate() {
552 if idx != route.hops.len() - 1 && hop.pubkey == our_node_id {
553 return Err(HandleError{err: "Route went through us but wasn't a simple rebalance loop to us", msg: None});
557 let session_priv = secp_call!(SecretKey::from_slice(&self.secp_ctx, &{
558 let mut session_key = [0; 32];
559 rng::fill_bytes(&mut session_key);
563 let associated_data = Vec::new(); //TODO: What to put here?
565 let onion_keys = ChannelManager::construct_onion_keys(&self.secp_ctx, &route, &session_priv)?;
566 let (onion_payloads, htlc_msat, htlc_cltv) = ChannelManager::build_onion_payloads(&route)?;
567 let onion_packet = ChannelManager::construct_onion_packet(onion_payloads, onion_keys, associated_data)?;
569 let mut channel_state = self.channel_state.lock().unwrap();
570 let id = match channel_state.short_to_id.get(&route.hops.first().unwrap().short_channel_id) {
571 None => return Err(HandleError{err: "No channel available with first hop!", msg: None}),
572 Some(id) => id.clone()
575 let chan = channel_state.by_id.get_mut(&id).unwrap();
576 if chan.get_their_node_id() != route.hops.first().unwrap().pubkey {
577 return Err(HandleError{err: "Node ID mismatch on first hop!", msg: None});
579 chan.send_htlc_and_commit(htlc_msat, payment_hash.clone(), htlc_cltv, onion_packet)?
582 if channel_state.claimable_htlcs.insert(payment_hash, PendingOutboundHTLC::OutboundRoute {
585 // TODO: We need to track these better, we're not generating these, so a
586 // third-party might make this happen:
587 panic!("payment_hash was repeated! Don't let this happen");
593 /// Call this upon creation of a funding transaction for the given channel.
594 /// Panics if a funding transaction has already been provided for this channel.
595 pub fn funding_transaction_generated(&self, temporary_channel_id: &Uint256, funding_txo: (Sha256dHash, u16)) {
597 let mut channel_state = self.channel_state.lock().unwrap();
598 match channel_state.by_id.remove(&temporary_channel_id) {
600 match chan.get_outbound_funding_created(funding_txo.0, funding_txo.1) {
605 //TODO: Push e to pendingevents
612 }; // Release channel lock for install_watch_outpoint call,
613 let chan_monitor = chan.channel_monitor();
614 match self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
617 //TODO: Push e to pendingevents?
623 let mut pending_events = self.pending_events.lock().unwrap();
624 pending_events.push(events::Event::SendFundingCreated {
625 node_id: chan.get_their_node_id(),
630 let mut channel_state = self.channel_state.lock().unwrap();
631 channel_state.by_id.insert(chan.channel_id(), chan);
634 fn get_announcement_sigs(&self, chan: &Channel) -> Result<Option<msgs::AnnouncementSignatures>, HandleError> {
635 if !chan.is_usable() { return Ok(None) }
637 let (announcement, our_bitcoin_sig) = chan.get_channel_announcement(self.get_our_node_id(), self.genesis_hash.clone())?;
638 let msghash = Message::from_slice(&Sha256dHash::from_data(&announcement.encode()[..])[..]).unwrap();
639 let our_node_sig = secp_call!(self.secp_ctx.sign(&msghash, &self.our_network_key));
641 Ok(Some(msgs::AnnouncementSignatures {
642 channel_id: chan.channel_id(),
643 short_channel_id: chan.get_short_channel_id().unwrap(),
644 node_signature: our_node_sig,
645 bitcoin_signature: our_bitcoin_sig,
649 pub fn process_pending_htlc_forward(&self) {
650 let mut new_events = Vec::new();
651 let mut failed_forwards = Vec::new();
653 let mut channel_state_lock = self.channel_state.lock().unwrap();
654 let channel_state = channel_state_lock.borrow_parts();
656 if cfg!(not(feature = "fuzztarget")) && Instant::now() < *channel_state.next_forward {
660 for (short_chan_id, pending_forwards) in channel_state.forward_htlcs.drain() {
661 if short_chan_id != 0 {
662 let forward_chan_id = match channel_state.short_to_id.get(&short_chan_id) {
663 Some(chan_id) => chan_id.clone(),
665 failed_forwards.reserve(pending_forwards.len());
666 for forward_info in pending_forwards {
667 failed_forwards.push((forward_info.payment_hash, 0x4000 | 10, None));
669 // TODO: Send a failure packet back on each pending_forward
673 let forward_chan = &mut channel_state.by_id.get_mut(&forward_chan_id).unwrap();
675 let mut add_htlc_msgs = Vec::new();
676 for forward_info in pending_forwards {
677 match forward_chan.send_htlc(forward_info.amt_to_forward, forward_info.payment_hash, forward_info.outgoing_cltv_value, forward_info.onion_packet.unwrap()) {
679 let chan_update = self.get_channel_update(forward_chan).unwrap();
680 failed_forwards.push((forward_info.payment_hash, 0x4000 | 7, Some(chan_update)));
685 Some(msg) => { add_htlc_msgs.push(msg); },
687 // Nothing to do here...we're waiting on a remote
688 // revoke_and_ack before we can add anymore HTLCs. The Channel
689 // will automatically handle building the update_add_htlc and
690 // commitment_signed messages when we can.
691 // TODO: Do some kind of timer to set the channel as !is_live()
692 // as we don't really want others relying on us relaying through
693 // this channel currently :/.
700 if !add_htlc_msgs.is_empty() {
701 let commitment_msg = match forward_chan.send_commitment() {
704 //TODO: Handle...this is bad!
708 new_events.push(events::Event::SendHTLCs {
709 node_id: forward_chan.get_their_node_id(),
711 commitment_msg: commitment_msg,
715 for forward_info in pending_forwards {
716 new_events.push(events::Event::PaymentReceived {
717 payment_hash: forward_info.payment_hash,
718 amt: forward_info.amt_to_forward,
725 for failed_forward in failed_forwards.drain(..) {
726 match failed_forward.2 {
727 None => self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), &failed_forward.0, HTLCFailReason::Reason { failure_code: failed_forward.1, data: Vec::new() }),
728 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() }),
732 if new_events.is_empty() { return }
734 let mut events = self.pending_events.lock().unwrap();
735 events.reserve(new_events.len());
736 for event in new_events.drain(..) {
741 /// Indicates that the preimage for payment_hash is unknown after a PaymentReceived event.
742 pub fn fail_htlc_backwards(&self, payment_hash: &[u8; 32]) -> bool {
743 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), payment_hash, HTLCFailReason::Reason { failure_code: 0x4000 | 15, data: Vec::new() })
746 fn fail_htlc_backwards_internal(&self, mut channel_state: MutexGuard<ChannelHolder>, payment_hash: &[u8; 32], onion_error: HTLCFailReason) -> bool {
747 let mut pending_htlc = {
748 match channel_state.claimable_htlcs.remove(payment_hash) {
749 Some(pending_htlc) => pending_htlc,
750 None => return false,
755 PendingOutboundHTLC::CycledRoute { source_short_channel_id, incoming_packet_shared_secret, .. } => {
756 pending_htlc = PendingOutboundHTLC::IntermediaryHopData { source_short_channel_id, incoming_packet_shared_secret };
762 PendingOutboundHTLC::CycledRoute { .. } => { panic!("WAT"); },
763 PendingOutboundHTLC::OutboundRoute { .. } => {
764 //TODO: DECRYPT route from OutboundRoute
765 mem::drop(channel_state);
766 let mut pending_events = self.pending_events.lock().unwrap();
767 pending_events.push(events::Event::PaymentFailed {
768 payment_hash: payment_hash.clone()
772 PendingOutboundHTLC::IntermediaryHopData { source_short_channel_id, incoming_packet_shared_secret } => {
773 let err_packet = match onion_error {
774 HTLCFailReason::Reason { failure_code, data } => {
775 let packet = ChannelManager::build_failure_packet(&incoming_packet_shared_secret, failure_code, &data[..]).encode();
776 ChannelManager::encrypt_failure_packet(&incoming_packet_shared_secret, &packet)
778 HTLCFailReason::ErrorPacket { err } => {
779 ChannelManager::encrypt_failure_packet(&incoming_packet_shared_secret, &err.data)
783 let (node_id, fail_msgs) = {
784 let chan_id = match channel_state.short_to_id.get(&source_short_channel_id) {
785 Some(chan_id) => chan_id.clone(),
789 let chan = channel_state.by_id.get_mut(&chan_id).unwrap();
790 match chan.get_update_fail_htlc_and_commit(payment_hash, err_packet) {
791 Ok(msg) => (chan.get_their_node_id(), msg),
793 //TODO: Do something with e?
801 mem::drop(channel_state);
802 let mut pending_events = self.pending_events.lock().unwrap();
803 pending_events.push(events::Event::SendFailHTLC {
806 commitment_msg: msgs.1,
817 /// Provides a payment preimage in response to a PaymentReceived event, returning true and
818 /// generating message events for the net layer to claim the payment, if possible. Thus, you
819 /// should probably kick the net layer to go send messages if this returns true!
820 /// May panic if called except in response to a PaymentReceived event.
821 pub fn claim_funds(&self, payment_preimage: [u8; 32]) -> bool {
822 self.claim_funds_internal(payment_preimage, true)
824 pub fn claim_funds_internal(&self, payment_preimage: [u8; 32], from_user: bool) -> bool {
825 let mut sha = Sha256::new();
826 sha.input(&payment_preimage);
827 let mut payment_hash = [0; 32];
828 sha.result(&mut payment_hash);
830 let mut channel_state = self.channel_state.lock().unwrap();
831 let mut pending_htlc = {
832 match channel_state.claimable_htlcs.remove(&payment_hash) {
833 Some(pending_htlc) => pending_htlc,
834 None => return false,
839 PendingOutboundHTLC::CycledRoute { source_short_channel_id, incoming_packet_shared_secret, route } => {
840 if from_user { // This was the end hop back to us
841 pending_htlc = PendingOutboundHTLC::IntermediaryHopData { source_short_channel_id, incoming_packet_shared_secret };
842 channel_state.claimable_htlcs.insert(payment_hash, PendingOutboundHTLC::OutboundRoute { route });
843 } else { // This came from the first upstream node
844 // Bank error in our favor! Maybe we should tell the user this somehow???
845 pending_htlc = PendingOutboundHTLC::OutboundRoute { route };
846 channel_state.claimable_htlcs.insert(payment_hash, PendingOutboundHTLC::IntermediaryHopData { source_short_channel_id, incoming_packet_shared_secret });
853 PendingOutboundHTLC::CycledRoute { .. } => { panic!("WAT"); },
854 PendingOutboundHTLC::OutboundRoute { .. } => {
856 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...");
858 mem::drop(channel_state);
859 let mut pending_events = self.pending_events.lock().unwrap();
860 pending_events.push(events::Event::PaymentSent {
865 PendingOutboundHTLC::IntermediaryHopData { source_short_channel_id, .. } => {
866 let (node_id, fulfill_msgs, monitor) = {
867 let chan_id = match channel_state.short_to_id.get(&source_short_channel_id) {
868 Some(chan_id) => chan_id.clone(),
872 let chan = channel_state.by_id.get_mut(&chan_id).unwrap();
873 match chan.get_update_fulfill_htlc_and_commit(payment_preimage) {
874 Ok(msg) => (chan.get_their_node_id(), msg, if from_user { Some(chan.channel_monitor()) } else { None }),
876 //TODO: Do something with e?
882 mem::drop(channel_state);
885 let mut pending_events = self.pending_events.lock().unwrap();
886 pending_events.push(events::Event::SendFulfillHTLC {
889 commitment_msg: msgs.1,
895 //TODO: It may not be possible to handle add_update_monitor fails gracefully, maybe
896 //it should return no Err? Sadly, panic!()s instead doesn't help much :(
898 match self.monitor.add_update_monitor(monitor.as_ref().unwrap().get_funding_txo().unwrap(), monitor.unwrap()) {
907 /// Gets the node_id held by this ChannelManager
908 pub fn get_our_node_id(&self) -> PublicKey {
909 PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key).unwrap()
913 impl events::EventsProvider for ChannelManager {
914 fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
915 let mut pending_events = self.pending_events.lock().unwrap();
916 let mut ret = Vec::new();
917 mem::swap(&mut ret, &mut *pending_events);
922 impl ChainListener for ChannelManager {
923 fn block_connected(&self, header: &BlockHeader, height: u32, txn_matched: &[&Transaction], indexes_of_txn_matched: &[u32]) {
924 let mut new_funding_locked_messages = Vec::new();
926 let mut channel_state = self.channel_state.lock().unwrap();
927 let mut short_to_ids_to_insert = Vec::new();
928 for channel in channel_state.by_id.values_mut() {
929 match channel.block_connected(header, height, txn_matched, indexes_of_txn_matched) {
930 Some(funding_locked) => {
931 let announcement_sigs = match self.get_announcement_sigs(channel) {
934 //TODO: push e on events and blow up the channel (it has bad keys)
938 new_funding_locked_messages.push(events::Event::SendFundingLocked {
939 node_id: channel.get_their_node_id(),
941 announcement_sigs: announcement_sigs
943 short_to_ids_to_insert.push((channel.get_short_channel_id().unwrap(), channel.channel_id()));
947 //TODO: Check if channel was closed (or disabled) here
949 for to_insert in short_to_ids_to_insert {
950 channel_state.short_to_id.insert(to_insert.0, to_insert.1);
953 let mut pending_events = self.pending_events.lock().unwrap();
954 for funding_locked in new_funding_locked_messages.drain(..) {
955 pending_events.push(funding_locked);
959 fn block_disconnected(&self, header: &BlockHeader) {
960 let mut channel_state = self.channel_state.lock().unwrap();
961 for channel in channel_state.by_id.values_mut() {
962 if channel.block_disconnected(header) {
963 //TODO Close channel here
969 impl ChannelMessageHandler for ChannelManager {
970 //TODO: Handle errors and close channel (or so)
971 fn handle_open_channel(&self, their_node_id: &PublicKey, msg: &msgs::OpenChannel) -> Result<msgs::AcceptChannel, HandleError> {
972 if msg.chain_hash != self.genesis_hash {
973 return Err(HandleError{err: "Unknown genesis block hash", msg: None});
975 let mut channel_state = self.channel_state.lock().unwrap();
976 if channel_state.by_id.contains_key(&msg.temporary_channel_id) {
977 return Err(HandleError{err: "temporary_channel_id collision!", msg: None});
979 let channel = Channel::new_from_req(&*self.fee_estimator, their_node_id.clone(), msg, 0, self.announce_channels_publicly)?;
980 let accept_msg = channel.get_accept_channel()?;
981 channel_state.by_id.insert(channel.channel_id(), channel);
985 fn handle_accept_channel(&self, their_node_id: &PublicKey, msg: &msgs::AcceptChannel) -> Result<(), HandleError> {
986 let (value, output_script, user_id) = {
987 let mut channel_state = self.channel_state.lock().unwrap();
988 match channel_state.by_id.get_mut(&msg.temporary_channel_id) {
990 if chan.get_their_node_id() != *their_node_id {
991 return Err(HandleError{err: "Got a message for a channel from the wrong node!", msg: None})
993 chan.accept_channel(&msg)?;
994 (chan.get_value_satoshis(), chan.get_funding_redeemscript().to_v0_p2wsh(), chan.get_user_id())
996 None => return Err(HandleError{err: "Failed to find corresponding channel", msg: None})
999 let mut pending_events = self.pending_events.lock().unwrap();
1000 pending_events.push(events::Event::FundingGenerationReady {
1001 temporary_channel_id: msg.temporary_channel_id,
1002 channel_value_satoshis: value,
1003 output_script: output_script,
1004 user_channel_id: user_id,
1009 fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<msgs::FundingSigned, HandleError> {
1010 //TODO: broke this - a node shouldn't be able to get their channel removed by sending a
1011 //funding_created a second time, or long after the first, or whatever (note this also
1012 //leaves the short_to_id map in a busted state.
1014 let mut channel_state = self.channel_state.lock().unwrap();
1015 match channel_state.by_id.remove(&msg.temporary_channel_id) {
1017 if chan.get_their_node_id() != *their_node_id {
1018 return Err(HandleError{err: "Got a message for a channel from the wrong node!", msg: None})
1020 match chan.funding_created(msg) {
1021 Ok(funding_msg) => {
1029 None => return Err(HandleError{err: "Failed to find corresponding channel", msg: None})
1031 }; // Release channel lock for install_watch_outpoint call,
1032 // note that this means if the remote end is misbehaving and sends a message for the same
1033 // channel back-to-back with funding_created, we'll end up thinking they sent a message
1034 // for a bogus channel.
1035 let chan_monitor = chan.0.channel_monitor();
1036 self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor)?;
1037 let mut channel_state = self.channel_state.lock().unwrap();
1038 channel_state.by_id.insert(chan.1.channel_id, chan.0);
1042 fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), HandleError> {
1043 let (funding_txo, user_id) = {
1044 let mut channel_state = self.channel_state.lock().unwrap();
1045 match channel_state.by_id.get_mut(&msg.channel_id) {
1047 if chan.get_their_node_id() != *their_node_id {
1048 return Err(HandleError{err: "Got a message for a channel from the wrong node!", msg: None})
1050 chan.funding_signed(&msg)?;
1051 (chan.get_funding_txo().unwrap(), chan.get_user_id())
1053 None => return Err(HandleError{err: "Failed to find corresponding channel", msg: None})
1056 let mut pending_events = self.pending_events.lock().unwrap();
1057 pending_events.push(events::Event::FundingBroadcastSafe {
1058 funding_txo: funding_txo,
1059 user_channel_id: user_id,
1064 fn handle_funding_locked(&self, their_node_id: &PublicKey, msg: &msgs::FundingLocked) -> Result<Option<msgs::AnnouncementSignatures>, HandleError> {
1065 let mut channel_state = self.channel_state.lock().unwrap();
1066 match channel_state.by_id.get_mut(&msg.channel_id) {
1068 if chan.get_their_node_id() != *their_node_id {
1069 return Err(HandleError{err: "Got a message for a channel from the wrong node!", msg: None})
1071 chan.funding_locked(&msg)?;
1072 return Ok(self.get_announcement_sigs(chan)?);
1074 None => return Err(HandleError{err: "Failed to find corresponding channel", msg: None})
1078 fn handle_shutdown(&self, their_node_id: &PublicKey, msg: &msgs::Shutdown) -> Result<(Option<msgs::Shutdown>, Option<msgs::ClosingSigned>), HandleError> {
1080 let mut channel_state = self.channel_state.lock().unwrap();
1082 match channel_state.by_id.entry(msg.channel_id.clone()) {
1083 hash_map::Entry::Occupied(mut chan_entry) => {
1084 if chan_entry.get().get_their_node_id() != *their_node_id {
1085 return Err(HandleError{err: "Got a message for a channel from the wrong node!", msg: None})
1087 let res = chan_entry.get_mut().shutdown(&*self.fee_estimator, &msg)?;
1088 if chan_entry.get().is_shutdown() {
1089 chan_entry.remove_entry();
1093 hash_map::Entry::Vacant(_) => return Err(HandleError{err: "Failed to find corresponding channel", msg: None})
1096 for payment_hash in res.2 {
1097 // unknown_next_peer...I dunno who that is anymore....
1098 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), &payment_hash, HTLCFailReason::Reason { failure_code: 0x4000 | 10, data: Vec::new() });
1103 fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<Option<msgs::ClosingSigned>, HandleError> {
1105 let mut channel_state = self.channel_state.lock().unwrap();
1106 match channel_state.by_id.entry(msg.channel_id.clone()) {
1107 hash_map::Entry::Occupied(mut chan_entry) => {
1108 if chan_entry.get().get_their_node_id() != *their_node_id {
1109 return Err(HandleError{err: "Got a message for a channel from the wrong node!", msg: None})
1111 let res = chan_entry.get_mut().closing_signed(&*self.fee_estimator, &msg)?;
1112 if res.1.is_some() {
1113 // We're done with this channel, we've got a signed closing transaction and
1114 // will send the closing_signed back to the remote peer upon return. This
1115 // also implies there are no pending HTLCs left on the channel, so we can
1116 // fully delete it from tracking (the channel monitor is still around to
1117 // watch for old state broadcasts)!
1118 chan_entry.remove_entry();
1122 hash_map::Entry::Vacant(_) => return Err(HandleError{err: "Failed to find corresponding channel", msg: None})
1125 if let Some(broadcast_tx) = res.1 {
1126 self.tx_broadcaster.broadcast_transaction(&broadcast_tx);
1131 fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), msgs::HandleError> {
1132 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
1133 //determine the state of the payment based on our response/if we forward anything/the time
1134 //we take to respond. We should take care to avoid allowing such an attack.
1136 //TODO: There exists a further attack where a node may garble the onion data, forward it to
1137 //us repeatedly garbled in different ways, and compare our error messages, which are
1138 //encrypted with the same key. Its not immediately obvious how to usefully exploit that,
1139 //but we should prevent it anyway.
1141 let shared_secret = SharedSecret::new(&self.secp_ctx, &msg.onion_routing_packet.public_key, &self.our_network_key);
1142 let (rho, mu) = ChannelManager::gen_rho_mu_from_shared_secret(&shared_secret);
1144 let associated_data = Vec::new(); //TODO: What to put here?
1146 macro_rules! get_onion_hash {
1149 let mut sha = Sha256::new();
1150 sha.input(&msg.onion_routing_packet.hop_data);
1151 let mut onion_hash = [0; 32];
1152 sha.result(&mut onion_hash);
1158 macro_rules! return_err {
1159 ($msg: expr, $err_code: expr, $data: expr) => {
1160 return Err(msgs::HandleError {
1162 msg: Some(msgs::ErrorAction::UpdateFailHTLC {
1163 msg: msgs::UpdateFailHTLC {
1164 channel_id: msg.channel_id,
1165 htlc_id: msg.htlc_id,
1166 reason: ChannelManager::build_first_hop_failure_packet(&shared_secret, $err_code, $data),
1173 if msg.onion_routing_packet.version != 0 {
1174 //TODO: Spec doesn't indicate if we should only hash hop_data here (and in other
1175 //sha256_of_onion error data packets), or the entire onion_routing_packet. Either way,
1176 //the hash doesn't really serve any purpuse - in the case of hashing all data, the
1177 //receiving node would have to brute force to figure out which version was put in the
1178 //packet by the node that send us the message, in the case of hashing the hop_data, the
1179 //node knows the HMAC matched, so they already know what is there...
1180 return_err!("Unknown onion packet version", 0x8000 | 0x4000 | 4, &get_onion_hash!());
1183 let mut hmac = Hmac::new(Sha256::new(), &mu);
1184 hmac.input(&msg.onion_routing_packet.hop_data);
1185 hmac.input(&associated_data[..]);
1186 if hmac.result() != MacResult::new(&msg.onion_routing_packet.hmac) {
1187 return_err!("HMAC Check failed", 0x8000 | 0x4000 | 5, &get_onion_hash!());
1190 let mut chacha = ChaCha20::new(&rho, &[0u8; 8]);
1191 let next_hop_data = {
1192 let mut decoded = [0; 65];
1193 chacha.process(&msg.onion_routing_packet.hop_data[0..65], &mut decoded);
1194 match msgs::OnionHopData::decode(&decoded[..]) {
1196 let error_code = match err {
1197 msgs::DecodeError::UnknownRealmByte => 0x4000 | 1,
1198 _ => 0x2000 | 2, // Should never happen
1200 return_err!("Unable to decode our hop data", error_code, &[0;0]);
1206 let mut pending_forward_info = if next_hop_data.hmac == [0; 32] {
1208 if next_hop_data.data.amt_to_forward != msg.amount_msat {
1209 return_err!("Upstream node sent less than we were supposed to receive in payment", 19, &byte_utils::be64_to_array(msg.amount_msat));
1211 if next_hop_data.data.outgoing_cltv_value != msg.cltv_expiry {
1212 return_err!("Upstream node set CLTV to the wrong value", 18, &byte_utils::be32_to_array(msg.cltv_expiry));
1215 // Note that we could obviously respond immediately with an update_fulfill_htlc
1216 // message, however that would leak that we are the recipient of this payment, so
1217 // instead we stay symmetric with the forwarding case, only responding (after a
1218 // delay) once they've send us a commitment_signed!
1220 PendingForwardHTLCInfo {
1222 payment_hash: msg.payment_hash.clone(),
1223 short_channel_id: 0,
1224 prev_short_channel_id: 0,
1225 amt_to_forward: next_hop_data.data.amt_to_forward,
1226 outgoing_cltv_value: next_hop_data.data.outgoing_cltv_value,
1229 let mut new_packet_data = [0; 20*65];
1230 chacha.process(&msg.onion_routing_packet.hop_data[65..], &mut new_packet_data[0..19*65]);
1231 chacha.process(&ChannelManager::ZERO[0..65], &mut new_packet_data[19*65..]);
1233 let mut new_pubkey = msg.onion_routing_packet.public_key.clone();
1235 let blinding_factor = {
1236 let mut sha = Sha256::new();
1237 sha.input(&new_pubkey.serialize()[..]);
1238 sha.input(&shared_secret[..]);
1239 let mut res = [0u8; 32];
1240 sha.result(&mut res);
1241 match SecretKey::from_slice(&self.secp_ctx, &res) {
1243 // Return temporary node failure as its technically our issue, not the
1245 return_err!("Blinding factor is an invalid private key", 0x2000 | 2, &[0;0]);
1251 match new_pubkey.mul_assign(&self.secp_ctx, &blinding_factor) {
1253 // Return temporary node failure as its technically our issue, not the
1255 return_err!("New blinding factor is an invalid private key", 0x2000 | 2, &[0;0]);
1260 let outgoing_packet = msgs::OnionPacket {
1262 public_key: new_pubkey,
1263 hop_data: new_packet_data,
1264 hmac: next_hop_data.hmac.clone(),
1267 //TODO: Check amt_to_forward and outgoing_cltv_value are within acceptable ranges!
1269 PendingForwardHTLCInfo {
1270 onion_packet: Some(outgoing_packet),
1271 payment_hash: msg.payment_hash.clone(),
1272 short_channel_id: next_hop_data.data.short_channel_id,
1273 prev_short_channel_id: 0,
1274 amt_to_forward: next_hop_data.data.amt_to_forward,
1275 outgoing_cltv_value: next_hop_data.data.outgoing_cltv_value,
1279 let mut channel_state_lock = self.channel_state.lock().unwrap();
1280 let channel_state = channel_state_lock.borrow_parts();
1282 if pending_forward_info.onion_packet.is_some() { // If short_channel_id is 0 here, we'll reject them in the body here
1283 let forwarding_id = match channel_state.short_to_id.get(&pending_forward_info.short_channel_id) {
1285 return_err!("Don't have available channel for forwarding as requested.", 0x4000 | 10, &[0;0]);
1287 Some(id) => id.clone(),
1289 let chan = channel_state.by_id.get_mut(&forwarding_id).unwrap();
1290 if !chan.is_live() {
1291 let chan_update = self.get_channel_update(chan).unwrap();
1292 return_err!("Forwarding channel is not in a ready state.", 0x4000 | 10, &chan_update.encode()[..]);
1296 let claimable_htlcs_entry = channel_state.claimable_htlcs.entry(msg.payment_hash.clone());
1298 // We dont correctly handle payments that route through us twice on their way to their
1299 // destination. That's OK since those nodes are probably busted or trying to do network
1300 // mapping through repeated loops. In either case, we want them to stop talking to us, so
1301 // we send permanent_node_failure.
1302 match &claimable_htlcs_entry {
1303 &hash_map::Entry::Occupied(ref e) => {
1304 let mut acceptable_cycle = false;
1306 &PendingOutboundHTLC::OutboundRoute { .. } => {
1307 acceptable_cycle = pending_forward_info.short_channel_id == 0;
1311 if !acceptable_cycle {
1312 return_err!("Payment looped through us twice", 0x4000 | 0x2000 | 2, &[0;0]);
1318 let (source_short_channel_id, res) = match channel_state.by_id.get_mut(&msg.channel_id) {
1320 if chan.get_their_node_id() != *their_node_id {
1321 return Err(HandleError{err: "Got a message for a channel from the wrong node!", msg: None})
1323 if !chan.is_usable() {
1324 return Err(HandleError{err: "Channel not yet available for receiving HTLCs", msg: None});
1326 let short_channel_id = chan.get_short_channel_id().unwrap();
1327 pending_forward_info.prev_short_channel_id = short_channel_id;
1328 (short_channel_id, chan.update_add_htlc(&msg, pending_forward_info)?)
1330 None => return Err(HandleError{err: "Failed to find corresponding channel", msg: None}), //TODO: panic?
1333 match claimable_htlcs_entry {
1334 hash_map::Entry::Occupied(mut e) => {
1335 let outbound_route = e.get_mut();
1336 let route = match outbound_route {
1337 &mut PendingOutboundHTLC::OutboundRoute { ref route } => {
1340 _ => { panic!("WAT") },
1342 *outbound_route = PendingOutboundHTLC::CycledRoute {
1343 source_short_channel_id,
1344 incoming_packet_shared_secret: shared_secret,
1348 hash_map::Entry::Vacant(e) => {
1349 e.insert(PendingOutboundHTLC::IntermediaryHopData {
1350 source_short_channel_id,
1351 incoming_packet_shared_secret: shared_secret,
1359 fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), HandleError> {
1360 //TODO: Delay the claimed_funds relaying just like we do outbound relay!
1361 // Claim funds first, cause we don't really care if the channel we received the message on
1362 // is broken, we may have enough info to get our own money!
1363 self.claim_funds_internal(msg.payment_preimage.clone(), false);
1366 let mut channel_state = self.channel_state.lock().unwrap();
1367 match channel_state.by_id.get_mut(&msg.channel_id) {
1369 if chan.get_their_node_id() != *their_node_id {
1370 return Err(HandleError{err: "Got a message for a channel from the wrong node!", msg: None})
1372 chan.update_fulfill_htlc(&msg)?;
1373 chan.channel_monitor()
1375 None => return Err(HandleError{err: "Failed to find corresponding channel", msg: None})
1378 self.monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor)?;
1382 fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), HandleError> {
1383 let mut channel_state = self.channel_state.lock().unwrap();
1384 match channel_state.by_id.get_mut(&msg.channel_id) {
1386 if chan.get_their_node_id() != *their_node_id {
1387 return Err(HandleError{err: "Got a message for a channel from the wrong node!", msg: None})
1389 chan.update_fail_htlc(&msg, HTLCFailReason::ErrorPacket { err: msg.reason.clone() })
1391 None => return Err(HandleError{err: "Failed to find corresponding channel", msg: None})
1395 fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), HandleError> {
1396 let mut channel_state = self.channel_state.lock().unwrap();
1397 match channel_state.by_id.get_mut(&msg.channel_id) {
1399 if chan.get_their_node_id() != *their_node_id {
1400 return Err(HandleError{err: "Got a message for a channel from the wrong node!", msg: None})
1402 chan.update_fail_malformed_htlc(&msg, HTLCFailReason::Reason { failure_code: msg.failure_code, data: Vec::new() })
1404 None => return Err(HandleError{err: "Failed to find corresponding channel", msg: None})
1408 fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(msgs::RevokeAndACK, Option<msgs::CommitmentSigned>), HandleError> {
1409 let (res, monitor) = {
1410 let mut channel_state = self.channel_state.lock().unwrap();
1411 match channel_state.by_id.get_mut(&msg.channel_id) {
1413 if chan.get_their_node_id() != *their_node_id {
1414 return Err(HandleError{err: "Got a message for a channel from the wrong node!", msg: None})
1416 (chan.commitment_signed(&msg)?, chan.channel_monitor())
1418 None => return Err(HandleError{err: "Failed to find corresponding channel", msg: None})
1421 //TODO: Only if we store HTLC sigs
1422 self.monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor)?;
1427 fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<Option<msgs::CommitmentUpdate>, HandleError> {
1428 let ((res, mut pending_forwards, mut pending_failures), monitor) = {
1429 let mut channel_state = self.channel_state.lock().unwrap();
1430 match channel_state.by_id.get_mut(&msg.channel_id) {
1432 if chan.get_their_node_id() != *their_node_id {
1433 return Err(HandleError{err: "Got a message for a channel from the wrong node!", msg: None})
1435 (chan.revoke_and_ack(&msg)?, chan.channel_monitor())
1437 None => return Err(HandleError{err: "Failed to find corresponding channel", msg: None})
1440 self.monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor)?;
1441 for failure in pending_failures.drain(..) {
1442 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), &failure.0, failure.1);
1445 let mut forward_event = None;
1446 if !pending_forwards.is_empty() {
1447 let mut channel_state = self.channel_state.lock().unwrap();
1448 if channel_state.forward_htlcs.is_empty() {
1449 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));
1450 channel_state.next_forward = forward_event.unwrap();
1452 for forward_info in pending_forwards.drain(..) {
1453 match channel_state.forward_htlcs.entry(forward_info.short_channel_id) {
1454 hash_map::Entry::Occupied(mut entry) => {
1455 entry.get_mut().push(forward_info);
1457 hash_map::Entry::Vacant(entry) => {
1458 entry.insert(vec!(forward_info));
1463 match forward_event {
1465 let mut pending_events = self.pending_events.lock().unwrap();
1466 pending_events.push(events::Event::PendingHTLCsForwardable {
1467 time_forwardable: time
1476 fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), HandleError> {
1477 let mut channel_state = self.channel_state.lock().unwrap();
1478 match channel_state.by_id.get_mut(&msg.channel_id) {
1480 if chan.get_their_node_id() != *their_node_id {
1481 return Err(HandleError{err: "Got a message for a channel from the wrong node!", msg: None})
1483 chan.update_fee(&*self.fee_estimator, &msg)
1485 None => return Err(HandleError{err: "Failed to find corresponding channel", msg: None})
1489 fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), HandleError> {
1490 let (chan_announcement, chan_update) = {
1491 let mut channel_state = self.channel_state.lock().unwrap();
1492 match channel_state.by_id.get_mut(&msg.channel_id) {
1494 if chan.get_their_node_id() != *their_node_id {
1495 return Err(HandleError{err: "Got a message for a channel from the wrong node!", msg: None})
1497 if !chan.is_usable() {
1498 return Err(HandleError{err: "Got an announcement_signatures before we were ready for it", msg: None });
1501 let our_node_id = self.get_our_node_id();
1502 let (announcement, our_bitcoin_sig) = chan.get_channel_announcement(our_node_id.clone(), self.genesis_hash.clone())?;
1504 let were_node_one = announcement.node_id_1 == our_node_id;
1505 let msghash = Message::from_slice(&Sha256dHash::from_data(&announcement.encode()[..])[..]).unwrap();
1506 secp_call!(self.secp_ctx.verify(&msghash, &msg.node_signature, if were_node_one { &announcement.node_id_2 } else { &announcement.node_id_1 }));
1507 secp_call!(self.secp_ctx.verify(&msghash, &msg.bitcoin_signature, if were_node_one { &announcement.bitcoin_key_2 } else { &announcement.bitcoin_key_1 }));
1509 let our_node_sig = secp_call!(self.secp_ctx.sign(&msghash, &self.our_network_key));
1511 (msgs::ChannelAnnouncement {
1512 node_signature_1: if were_node_one { our_node_sig } else { msg.node_signature },
1513 node_signature_2: if were_node_one { msg.node_signature } else { our_node_sig },
1514 bitcoin_signature_1: if were_node_one { our_bitcoin_sig } else { msg.bitcoin_signature },
1515 bitcoin_signature_2: if were_node_one { msg.bitcoin_signature } else { our_bitcoin_sig },
1516 contents: announcement,
1517 }, self.get_channel_update(chan).unwrap()) // can only fail if we're not in a ready state
1519 None => return Err(HandleError{err: "Failed to find corresponding channel", msg: None})
1522 let mut pending_events = self.pending_events.lock().unwrap();
1523 pending_events.push(events::Event::BroadcastChannelAnnouncement { msg: chan_announcement, update_msg: chan_update });
1527 fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool) {
1528 let mut channel_state_lock = self.channel_state.lock().unwrap();
1529 let channel_state = channel_state_lock.borrow_parts();
1530 let short_to_id = channel_state.short_to_id;
1531 if no_connection_possible {
1532 channel_state.by_id.retain(move |_, chan| {
1533 if chan.get_their_node_id() == *their_node_id {
1534 match chan.get_short_channel_id() {
1536 short_to_id.remove(&short_id);
1540 //TODO: get the latest commitment tx, any HTLC txn built on top of it, etc out
1541 //of the channel and throw those into the announcement blackhole.
1548 for chan in channel_state.by_id {
1549 if chan.1.get_their_node_id() == *their_node_id {
1550 //TODO: mark channel disabled (and maybe announce such after a timeout). Also
1551 //fail and wipe any uncommitted outbound HTLCs as those are considered after
1561 use chain::chaininterface;
1562 use ln::channelmanager::{ChannelManager,OnionKeys};
1563 use ln::router::{Route, RouteHop, Router};
1565 use ln::msgs::{MsgEncodable,ChannelMessageHandler,RoutingMessageHandler};
1566 use util::test_utils;
1567 use util::events::{Event, EventsProvider};
1569 use bitcoin::util::misc::hex_bytes;
1570 use bitcoin::util::hash::Sha256dHash;
1571 use bitcoin::util::uint::Uint256;
1572 use bitcoin::blockdata::block::BlockHeader;
1573 use bitcoin::blockdata::transaction::{Transaction, TxOut};
1574 use bitcoin::network::constants::Network;
1575 use bitcoin::network::serialize::serialize;
1576 use bitcoin::network::serialize::BitcoinHash;
1578 use secp256k1::Secp256k1;
1579 use secp256k1::key::{PublicKey,SecretKey};
1581 use crypto::sha2::Sha256;
1582 use crypto::digest::Digest;
1584 use rand::{thread_rng,Rng};
1586 use std::collections::HashMap;
1587 use std::default::Default;
1588 use std::sync::{Arc, Mutex};
1589 use std::time::Instant;
1591 fn build_test_onion_keys() -> Vec<OnionKeys> {
1592 // Keys from BOLT 4, used in both test vector tests
1593 let secp_ctx = Secp256k1::new();
1598 pubkey: PublicKey::from_slice(&secp_ctx, &hex_bytes("02eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619").unwrap()[..]).unwrap(),
1599 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
1602 pubkey: PublicKey::from_slice(&secp_ctx, &hex_bytes("0324653eac434488002cc06bbfb7f10fe18991e35f9fe4302dbea6d2353dc0ab1c").unwrap()[..]).unwrap(),
1603 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
1606 pubkey: PublicKey::from_slice(&secp_ctx, &hex_bytes("027f31ebc5462c1fdce1b737ecff52d37d75dea43ce11c74d25aa297165faa2007").unwrap()[..]).unwrap(),
1607 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
1610 pubkey: PublicKey::from_slice(&secp_ctx, &hex_bytes("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]).unwrap(),
1611 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
1614 pubkey: PublicKey::from_slice(&secp_ctx, &hex_bytes("02edabbd16b41c8371b92ef2f04c1185b4f03b6dcd52ba9b78d9d7c89c8f221145").unwrap()[..]).unwrap(),
1615 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
1620 let session_priv = SecretKey::from_slice(&secp_ctx, &hex_bytes("4141414141414141414141414141414141414141414141414141414141414141").unwrap()[..]).unwrap();
1622 let onion_keys = ChannelManager::construct_onion_keys(&secp_ctx, &route, &session_priv).unwrap();
1623 assert_eq!(onion_keys.len(), route.hops.len());
1628 fn onion_vectors() {
1629 // Packet creation test vectors from BOLT 4
1630 let onion_keys = build_test_onion_keys();
1632 assert_eq!(onion_keys[0].shared_secret[..], hex_bytes("53eb63ea8a3fec3b3cd433b85cd62a4b145e1dda09391b348c4e1cd36a03ea66").unwrap()[..]);
1633 assert_eq!(onion_keys[0].blinding_factor[..], hex_bytes("2ec2e5da605776054187180343287683aa6a51b4b1c04d6dd49c45d8cffb3c36").unwrap()[..]);
1634 assert_eq!(onion_keys[0].ephemeral_pubkey.serialize()[..], hex_bytes("02eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619").unwrap()[..]);
1635 assert_eq!(onion_keys[0].rho, hex_bytes("ce496ec94def95aadd4bec15cdb41a740c9f2b62347c4917325fcc6fb0453986").unwrap()[..]);
1636 assert_eq!(onion_keys[0].mu, hex_bytes("b57061dc6d0a2b9f261ac410c8b26d64ac5506cbba30267a649c28c179400eba").unwrap()[..]);
1638 assert_eq!(onion_keys[1].shared_secret[..], hex_bytes("a6519e98832a0b179f62123b3567c106db99ee37bef036e783263602f3488fae").unwrap()[..]);
1639 assert_eq!(onion_keys[1].blinding_factor[..], hex_bytes("bf66c28bc22e598cfd574a1931a2bafbca09163df2261e6d0056b2610dab938f").unwrap()[..]);
1640 assert_eq!(onion_keys[1].ephemeral_pubkey.serialize()[..], hex_bytes("028f9438bfbf7feac2e108d677e3a82da596be706cc1cf342b75c7b7e22bf4e6e2").unwrap()[..]);
1641 assert_eq!(onion_keys[1].rho, hex_bytes("450ffcabc6449094918ebe13d4f03e433d20a3d28a768203337bc40b6e4b2c59").unwrap()[..]);
1642 assert_eq!(onion_keys[1].mu, hex_bytes("05ed2b4a3fb023c2ff5dd6ed4b9b6ea7383f5cfe9d59c11d121ec2c81ca2eea9").unwrap()[..]);
1644 assert_eq!(onion_keys[2].shared_secret[..], hex_bytes("3a6b412548762f0dbccce5c7ae7bb8147d1caf9b5471c34120b30bc9c04891cc").unwrap()[..]);
1645 assert_eq!(onion_keys[2].blinding_factor[..], hex_bytes("a1f2dadd184eb1627049673f18c6325814384facdee5bfd935d9cb031a1698a5").unwrap()[..]);
1646 assert_eq!(onion_keys[2].ephemeral_pubkey.serialize()[..], hex_bytes("03bfd8225241ea71cd0843db7709f4c222f62ff2d4516fd38b39914ab6b83e0da0").unwrap()[..]);
1647 assert_eq!(onion_keys[2].rho, hex_bytes("11bf5c4f960239cb37833936aa3d02cea82c0f39fd35f566109c41f9eac8deea").unwrap()[..]);
1648 assert_eq!(onion_keys[2].mu, hex_bytes("caafe2820fa00eb2eeb78695ae452eba38f5a53ed6d53518c5c6edf76f3f5b78").unwrap()[..]);
1650 assert_eq!(onion_keys[3].shared_secret[..], hex_bytes("21e13c2d7cfe7e18836df50872466117a295783ab8aab0e7ecc8c725503ad02d").unwrap()[..]);
1651 assert_eq!(onion_keys[3].blinding_factor[..], hex_bytes("7cfe0b699f35525029ae0fa437c69d0f20f7ed4e3916133f9cacbb13c82ff262").unwrap()[..]);
1652 assert_eq!(onion_keys[3].ephemeral_pubkey.serialize()[..], hex_bytes("031dde6926381289671300239ea8e57ffaf9bebd05b9a5b95beaf07af05cd43595").unwrap()[..]);
1653 assert_eq!(onion_keys[3].rho, hex_bytes("cbe784ab745c13ff5cffc2fbe3e84424aa0fd669b8ead4ee562901a4a4e89e9e").unwrap()[..]);
1654 assert_eq!(onion_keys[3].mu, hex_bytes("5052aa1b3d9f0655a0932e50d42f0c9ba0705142c25d225515c45f47c0036ee9").unwrap()[..]);
1656 assert_eq!(onion_keys[4].shared_secret[..], hex_bytes("b5756b9b542727dbafc6765a49488b023a725d631af688fc031217e90770c328").unwrap()[..]);
1657 assert_eq!(onion_keys[4].blinding_factor[..], hex_bytes("c96e00dddaf57e7edcd4fb5954be5b65b09f17cb6d20651b4e90315be5779205").unwrap()[..]);
1658 assert_eq!(onion_keys[4].ephemeral_pubkey.serialize()[..], hex_bytes("03a214ebd875aab6ddfd77f22c5e7311d7f77f17a169e599f157bbcdae8bf071f4").unwrap()[..]);
1659 assert_eq!(onion_keys[4].rho, hex_bytes("034e18b8cc718e8af6339106e706c52d8df89e2b1f7e9142d996acf88df8799b").unwrap()[..]);
1660 assert_eq!(onion_keys[4].mu, hex_bytes("8e45e5c61c2b24cb6382444db6698727afb063adecd72aada233d4bf273d975a").unwrap()[..]);
1662 // Test vectors below are flat-out wrong: they claim to set outgoing_cltv_value to non-0 :/
1663 let payloads = vec!(
1664 msgs::OnionHopData {
1666 data: msgs::OnionRealm0HopData {
1667 short_channel_id: 0,
1669 outgoing_cltv_value: 0,
1673 msgs::OnionHopData {
1675 data: msgs::OnionRealm0HopData {
1676 short_channel_id: 0x0101010101010101,
1677 amt_to_forward: 0x0100000001,
1678 outgoing_cltv_value: 0,
1682 msgs::OnionHopData {
1684 data: msgs::OnionRealm0HopData {
1685 short_channel_id: 0x0202020202020202,
1686 amt_to_forward: 0x0200000002,
1687 outgoing_cltv_value: 0,
1691 msgs::OnionHopData {
1693 data: msgs::OnionRealm0HopData {
1694 short_channel_id: 0x0303030303030303,
1695 amt_to_forward: 0x0300000003,
1696 outgoing_cltv_value: 0,
1700 msgs::OnionHopData {
1702 data: msgs::OnionRealm0HopData {
1703 short_channel_id: 0x0404040404040404,
1704 amt_to_forward: 0x0400000004,
1705 outgoing_cltv_value: 0,
1711 let packet = ChannelManager::construct_onion_packet(payloads, onion_keys, hex_bytes("4242424242424242424242424242424242424242424242424242424242424242").unwrap()).unwrap();
1712 // Just check the final packet encoding, as it includes all the per-hop vectors in it
1714 assert_eq!(packet.encode(), hex_bytes("0002eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619e5f14350c2a76fc232b5e46d421e9615471ab9e0bc887beff8c95fdb878f7b3a716a996c7845c93d90e4ecbb9bde4ece2f69425c99e4bc820e44485455f135edc0d10f7d61ab590531cf08000179a333a347f8b4072f216400406bdf3bf038659793d4a1fd7b246979e3150a0a4cb052c9ec69acf0f48c3d39cd55675fe717cb7d80ce721caad69320c3a469a202f1e468c67eaf7a7cd8226d0fd32f7b48084dca885d56047694762b67021713ca673929c163ec36e04e40ca8e1c6d17569419d3039d9a1ec866abe044a9ad635778b961fc0776dc832b3a451bd5d35072d2269cf9b040f6b7a7dad84fb114ed413b1426cb96ceaf83825665ed5a1d002c1687f92465b49ed4c7f0218ff8c6c7dd7221d589c65b3b9aaa71a41484b122846c7c7b57e02e679ea8469b70e14fe4f70fee4d87b910cf144be6fe48eef24da475c0b0bcc6565ae82cd3f4e3b24c76eaa5616c6111343306ab35c1fe5ca4a77c0e314ed7dba39d6f1e0de791719c241a939cc493bea2bae1c1e932679ea94d29084278513c77b899cc98059d06a27d171b0dbdf6bee13ddc4fc17a0c4d2827d488436b57baa167544138ca2e64a11b43ac8a06cd0c2fba2d4d900ed2d9205305e2d7383cc98dacb078133de5f6fb6bed2ef26ba92cea28aafc3b9948dd9ae5559e8bd6920b8cea462aa445ca6a95e0e7ba52961b181c79e73bd581821df2b10173727a810c92b83b5ba4a0403eb710d2ca10689a35bec6c3a708e9e92f7d78ff3c5d9989574b00c6736f84c199256e76e19e78f0c98a9d580b4a658c84fc8f2096c2fbea8f5f8c59d0fdacb3be2802ef802abbecb3aba4acaac69a0e965abd8981e9896b1f6ef9d60f7a164b371af869fd0e48073742825e9434fc54da837e120266d53302954843538ea7c6c3dbfb4ff3b2fdbe244437f2a153ccf7bdb4c92aa08102d4f3cff2ae5ef86fab4653595e6a5837fa2f3e29f27a9cde5966843fb847a4a61f1e76c281fe8bb2b0a181d096100db5a1a5ce7a910238251a43ca556712eaadea167fb4d7d75825e440f3ecd782036d7574df8bceacb397abefc5f5254d2722215c53ff54af8299aaaad642c6d72a14d27882d9bbd539e1cc7a527526ba89b8c037ad09120e98ab042d3e8652b31ae0e478516bfaf88efca9f3676ffe99d2819dcaeb7610a626695f53117665d267d3f7abebd6bbd6733f645c72c389f03855bdf1e4b8075b516569b118233a0f0971d24b83113c0b096f5216a207ca99a7cddc81c130923fe3d91e7508c9ac5f2e914ff5dccab9e558566fa14efb34ac98d878580814b94b73acbfde9072f30b881f7f0fff42d4045d1ace6322d86a97d164aa84d93a60498065cc7c20e636f5862dc81531a88c60305a2e59a985be327a6902e4bed986dbf4a0b50c217af0ea7fdf9ab37f9ea1a1aaa72f54cf40154ea9b269f1a7c09f9f43245109431a175d50e2db0132337baa0ef97eed0fcf20489da36b79a1172faccc2f7ded7c60e00694282d93359c4682135642bc81f433574aa8ef0c97b4ade7ca372c5ffc23c7eddd839bab4e0f14d6df15c9dbeab176bec8b5701cf054eb3072f6dadc98f88819042bf10c407516ee58bce33fbe3b3d86a54255e577db4598e30a135361528c101683a5fcde7e8ba53f3456254be8f45fe3a56120ae96ea3773631fcb3873aa3abd91bcff00bd38bd43697a2e789e00da6077482e7b1b1a677b5afae4c54e6cbdf7377b694eb7d7a5b913476a5be923322d3de06060fd5e819635232a2cf4f0731da13b8546d1d6d4f8d75b9fce6c2341a71b0ea6f780df54bfdb0dd5cd9855179f602f9172307c7268724c3618e6817abd793adc214a0dc0bc616816632f27ea336fb56dfd").unwrap());
1718 fn test_failure_packet_onion() {
1719 // Returning Errors test vectors from BOLT 4
1721 let onion_keys = build_test_onion_keys();
1722 let onion_error = ChannelManager::build_failure_packet(&onion_keys[4].shared_secret, 0x2002, &[0; 0]);
1723 assert_eq!(onion_error.encode(), hex_bytes("4c2fc8bc08510334b6833ad9c3e79cd1b52ae59dfe5c2a4b23ead50f09f7ee0b0002200200fe0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap());
1725 let onion_packet_1 = ChannelManager::encrypt_failure_packet(&onion_keys[4].shared_secret, &onion_error.encode()[..]);
1726 assert_eq!(onion_packet_1.data, hex_bytes("a5e6bd0c74cb347f10cce367f949098f2457d14c046fd8a22cb96efb30b0fdcda8cb9168b50f2fd45edd73c1b0c8b33002df376801ff58aaa94000bf8a86f92620f343baef38a580102395ae3abf9128d1047a0736ff9b83d456740ebbb4aeb3aa9737f18fb4afb4aa074fb26c4d702f42968888550a3bded8c05247e045b866baef0499f079fdaeef6538f31d44deafffdfd3afa2fb4ca9082b8f1c465371a9894dd8c243fb4847e004f5256b3e90e2edde4c9fb3082ddfe4d1e734cacd96ef0706bf63c9984e22dc98851bcccd1c3494351feb458c9c6af41c0044bea3c47552b1d992ae542b17a2d0bba1a096c78d169034ecb55b6e3a7263c26017f033031228833c1daefc0dedb8cf7c3e37c9c37ebfe42f3225c326e8bcfd338804c145b16e34e4").unwrap());
1728 let onion_packet_2 = ChannelManager::encrypt_failure_packet(&onion_keys[3].shared_secret, &onion_packet_1.data[..]);
1729 assert_eq!(onion_packet_2.data, hex_bytes("c49a1ce81680f78f5f2000cda36268de34a3f0a0662f55b4e837c83a8773c22aa081bab1616a0011585323930fa5b9fae0c85770a2279ff59ec427ad1bbff9001c0cd1497004bd2a0f68b50704cf6d6a4bf3c8b6a0833399a24b3456961ba00736785112594f65b6b2d44d9f5ea4e49b5e1ec2af978cbe31c67114440ac51a62081df0ed46d4a3df295da0b0fe25c0115019f03f15ec86fabb4c852f83449e812f141a9395b3f70b766ebbd4ec2fae2b6955bd8f32684c15abfe8fd3a6261e52650e8807a92158d9f1463261a925e4bfba44bd20b166d532f0017185c3a6ac7957adefe45559e3072c8dc35abeba835a8cb01a71a15c736911126f27d46a36168ca5ef7dccd4e2886212602b181463e0dd30185c96348f9743a02aca8ec27c0b90dca270").unwrap());
1731 let onion_packet_3 = ChannelManager::encrypt_failure_packet(&onion_keys[2].shared_secret, &onion_packet_2.data[..]);
1732 assert_eq!(onion_packet_3.data, hex_bytes("a5d3e8634cfe78b2307d87c6d90be6fe7855b4f2cc9b1dfb19e92e4b79103f61ff9ac25f412ddfb7466e74f81b3e545563cdd8f5524dae873de61d7bdfccd496af2584930d2b566b4f8d3881f8c043df92224f38cf094cfc09d92655989531524593ec6d6caec1863bdfaa79229b5020acc034cd6deeea1021c50586947b9b8e6faa83b81fbfa6133c0af5d6b07c017f7158fa94f0d206baf12dda6b68f785b773b360fd0497e16cc402d779c8d48d0fa6315536ef0660f3f4e1865f5b38ea49c7da4fd959de4e83ff3ab686f059a45c65ba2af4a6a79166aa0f496bf04d06987b6d2ea205bdb0d347718b9aeff5b61dfff344993a275b79717cd815b6ad4c0beb568c4ac9c36ff1c315ec1119a1993c4b61e6eaa0375e0aaf738ac691abd3263bf937e3").unwrap());
1734 let onion_packet_4 = ChannelManager::encrypt_failure_packet(&onion_keys[1].shared_secret, &onion_packet_3.data[..]);
1735 assert_eq!(onion_packet_4.data, hex_bytes("aac3200c4968f56b21f53e5e374e3a2383ad2b1b6501bbcc45abc31e59b26881b7dfadbb56ec8dae8857add94e6702fb4c3a4de22e2e669e1ed926b04447fc73034bb730f4932acd62727b75348a648a1128744657ca6a4e713b9b646c3ca66cac02cdab44dd3439890ef3aaf61708714f7375349b8da541b2548d452d84de7084bb95b3ac2345201d624d31f4d52078aa0fa05a88b4e20202bd2b86ac5b52919ea305a8949de95e935eed0319cf3cf19ebea61d76ba92532497fcdc9411d06bcd4275094d0a4a3c5d3a945e43305a5a9256e333e1f64dbca5fcd4e03a39b9012d197506e06f29339dfee3331995b21615337ae060233d39befea925cc262873e0530408e6990f1cbd233a150ef7b004ff6166c70c68d9f8c853c1abca640b8660db2921").unwrap());
1737 let onion_packet_5 = ChannelManager::encrypt_failure_packet(&onion_keys[0].shared_secret, &onion_packet_4.data[..]);
1738 assert_eq!(onion_packet_5.data, hex_bytes("9c5add3963fc7f6ed7f148623c84134b5647e1306419dbe2174e523fa9e2fbed3a06a19f899145610741c83ad40b7712aefaddec8c6baf7325d92ea4ca4d1df8bce517f7e54554608bf2bd8071a4f52a7a2f7ffbb1413edad81eeea5785aa9d990f2865dc23b4bc3c301a94eec4eabebca66be5cf638f693ec256aec514620cc28ee4a94bd9565bc4d4962b9d3641d4278fb319ed2b84de5b665f307a2db0f7fbb757366067d88c50f7e829138fde4f78d39b5b5802f1b92a8a820865af5cc79f9f30bc3f461c66af95d13e5e1f0381c184572a91dee1c849048a647a1158cf884064deddbf1b0b88dfe2f791428d0ba0f6fb2f04e14081f69165ae66d9297c118f0907705c9c4954a199bae0bb96fad763d690e7daa6cfda59ba7f2c8d11448b604d12d").unwrap());
1741 fn confirm_transaction(chain: &chaininterface::ChainWatchInterfaceUtil, tx: &Transaction, chan_id: u32) {
1742 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1743 chain.block_connected_checked(&header, 1, &[tx; 1], &[chan_id; 1]);
1745 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1746 chain.block_connected_checked(&header, i, &[tx; 0], &[0; 0]);
1751 feeest: Arc<test_utils::TestFeeEstimator>,
1752 chain_monitor: Arc<chaininterface::ChainWatchInterfaceUtil>,
1753 tx_broadcaster: Arc<test_utils::TestBroadcaster>,
1754 chan_monitor: Arc<test_utils::TestChannelMonitor>,
1756 node: Arc<ChannelManager>,
1760 static mut CHAN_COUNT: u32 = 0;
1761 fn create_chan_between_nodes(node_a: &Node, node_b: &Node) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate, Uint256, Transaction) {
1762 let open_chan = node_a.node.create_channel(node_b.node.get_our_node_id(), 100000, 42).unwrap();
1763 let accept_chan = node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), &open_chan).unwrap();
1764 node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), &accept_chan).unwrap();
1766 let chan_id = unsafe { CHAN_COUNT };
1770 let events_1 = node_a.node.get_and_clear_pending_events();
1771 assert_eq!(events_1.len(), 1);
1773 Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
1774 assert_eq!(*channel_value_satoshis, 100000);
1775 assert_eq!(user_channel_id, 42);
1777 tx = Transaction { version: chan_id as u32, lock_time: 0, input: Vec::new(), output: vec![TxOut {
1778 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
1780 funding_output = (Sha256dHash::from_data(&serialize(&tx).unwrap()[..]), 0);
1782 node_a.node.funding_transaction_generated(&temporary_channel_id, funding_output.clone());
1783 let mut added_monitors = node_a.chan_monitor.added_monitors.lock().unwrap();
1784 assert_eq!(added_monitors.len(), 1);
1785 assert_eq!(added_monitors[0].0, funding_output);
1786 added_monitors.clear();
1788 _ => panic!("Unexpected event"),
1791 let events_2 = node_a.node.get_and_clear_pending_events();
1792 assert_eq!(events_2.len(), 1);
1793 let funding_signed = match events_2[0] {
1794 Event::SendFundingCreated { ref node_id, ref msg } => {
1795 assert_eq!(*node_id, node_b.node.get_our_node_id());
1796 let res = node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), msg).unwrap();
1797 let mut added_monitors = node_b.chan_monitor.added_monitors.lock().unwrap();
1798 assert_eq!(added_monitors.len(), 1);
1799 assert_eq!(added_monitors[0].0, funding_output);
1800 added_monitors.clear();
1803 _ => panic!("Unexpected event"),
1806 node_a.node.handle_funding_signed(&node_b.node.get_our_node_id(), &funding_signed).unwrap();
1808 let events_3 = node_a.node.get_and_clear_pending_events();
1809 assert_eq!(events_3.len(), 1);
1811 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
1812 assert_eq!(user_channel_id, 42);
1813 assert_eq!(*funding_txo, funding_output);
1815 _ => panic!("Unexpected event"),
1818 confirm_transaction(&node_a.chain_monitor, &tx, chan_id);
1819 let events_4 = node_a.node.get_and_clear_pending_events();
1820 assert_eq!(events_4.len(), 1);
1822 Event::SendFundingLocked { ref node_id, ref msg, ref announcement_sigs } => {
1823 assert_eq!(*node_id, node_b.node.get_our_node_id());
1824 assert!(announcement_sigs.is_none());
1825 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), msg).unwrap()
1827 _ => panic!("Unexpected event"),
1832 confirm_transaction(&node_b.chain_monitor, &tx, chan_id);
1833 let events_5 = node_b.node.get_and_clear_pending_events();
1834 assert_eq!(events_5.len(), 1);
1835 let as_announcement_sigs = match events_5[0] {
1836 Event::SendFundingLocked { ref node_id, ref msg, ref announcement_sigs } => {
1837 assert_eq!(*node_id, node_a.node.get_our_node_id());
1838 channel_id = msg.channel_id.clone();
1839 let as_announcement_sigs = node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), msg).unwrap().unwrap();
1840 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &(*announcement_sigs).clone().unwrap()).unwrap();
1841 as_announcement_sigs
1843 _ => panic!("Unexpected event"),
1846 let events_6 = node_a.node.get_and_clear_pending_events();
1847 assert_eq!(events_6.len(), 1);
1848 let (announcement, as_update) = match events_6[0] {
1849 Event::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1852 _ => panic!("Unexpected event"),
1855 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_announcement_sigs).unwrap();
1856 let events_7 = node_b.node.get_and_clear_pending_events();
1857 assert_eq!(events_7.len(), 1);
1858 let bs_update = match events_7[0] {
1859 Event::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1860 assert!(*announcement == *msg);
1863 _ => panic!("Unexpected event"),
1870 ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone(), channel_id, tx)
1873 fn create_announced_chan_between_nodes(nodes: &Vec<Node>, a: usize, b: usize) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, Uint256, Transaction) {
1874 let chan_announcement = create_chan_between_nodes(&nodes[a], &nodes[b]);
1876 assert!(node.router.handle_channel_announcement(&chan_announcement.0).unwrap());
1877 node.router.handle_channel_update(&chan_announcement.1).unwrap();
1878 node.router.handle_channel_update(&chan_announcement.2).unwrap();
1880 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
1883 fn close_channel(outbound_node: &Node, inbound_node: &Node, channel_id: &Uint256, funding_tx: Transaction, close_inbound_first: bool) {
1884 let (node_a, broadcaster_a) = if close_inbound_first { (&inbound_node.node, &inbound_node.tx_broadcaster) } else { (&outbound_node.node, &outbound_node.tx_broadcaster) };
1885 let (node_b, broadcaster_b) = if close_inbound_first { (&outbound_node.node, &outbound_node.tx_broadcaster) } else { (&inbound_node.node, &inbound_node.tx_broadcaster) };
1888 let shutdown_a = node_a.close_channel(channel_id).unwrap();
1889 let (shutdown_b, mut closing_signed_b) = node_b.handle_shutdown(&node_a.get_our_node_id(), &shutdown_a).unwrap();
1890 if !close_inbound_first {
1891 assert!(closing_signed_b.is_none());
1893 let (empty_a, mut closing_signed_a) = node_a.handle_shutdown(&node_b.get_our_node_id(), &shutdown_b.unwrap()).unwrap();
1894 assert!(empty_a.is_none());
1895 if close_inbound_first {
1896 assert!(closing_signed_a.is_none());
1897 closing_signed_a = node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap()).unwrap();
1898 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1899 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1901 let empty_b = node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap()).unwrap();
1902 assert!(empty_b.is_none());
1903 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1904 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1906 closing_signed_b = node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap()).unwrap();
1907 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1908 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1910 let empty_a2 = node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap()).unwrap();
1911 assert!(empty_a2.is_none());
1912 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1913 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1915 assert_eq!(tx_a, tx_b);
1916 let mut funding_tx_map = HashMap::new();
1917 funding_tx_map.insert(funding_tx.txid(), funding_tx);
1918 tx_a.verify(&funding_tx_map).unwrap();
1923 msgs: Vec<msgs::UpdateAddHTLC>,
1924 commitment_msg: msgs::CommitmentSigned,
1927 fn from_event(event: Event) -> SendEvent {
1929 Event::SendHTLCs { node_id, msgs, commitment_msg } => {
1930 SendEvent { node_id: node_id, msgs: msgs, commitment_msg: commitment_msg }
1932 _ => panic!("Unexpected event type!"),
1937 static mut PAYMENT_COUNT: u8 = 0;
1938 fn send_along_route(origin_node: &Node, route: Route, expected_route: &[&Node], recv_value: u64) -> ([u8; 32], [u8; 32]) {
1939 let our_payment_preimage = unsafe { [PAYMENT_COUNT; 32] };
1940 unsafe { PAYMENT_COUNT += 1 };
1941 let our_payment_hash = {
1942 let mut sha = Sha256::new();
1943 sha.input(&our_payment_preimage[..]);
1944 let mut ret = [0; 32];
1945 sha.result(&mut ret);
1949 let mut payment_event = {
1950 let msgs = origin_node.node.send_payment(route, our_payment_hash).unwrap().unwrap();
1952 node_id: expected_route[0].node.get_our_node_id(),
1954 commitment_msg: msgs.1,
1957 let mut prev_node = origin_node;
1959 for (idx, &node) in expected_route.iter().enumerate() {
1960 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
1962 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
1964 let added_monitors = node.chan_monitor.added_monitors.lock().unwrap();
1965 assert_eq!(added_monitors.len(), 0);
1968 let revoke_and_ack = node.node.handle_commitment_signed(&prev_node.node.get_our_node_id(), &payment_event.commitment_msg).unwrap();
1970 let mut added_monitors = node.chan_monitor.added_monitors.lock().unwrap();
1971 assert_eq!(added_monitors.len(), 1);
1972 added_monitors.clear();
1974 assert!(prev_node.node.handle_revoke_and_ack(&node.node.get_our_node_id(), &revoke_and_ack.0).unwrap().is_none());
1975 let prev_revoke_and_ack = prev_node.node.handle_commitment_signed(&node.node.get_our_node_id(), &revoke_and_ack.1.unwrap()).unwrap();
1977 let mut added_monitors = prev_node.chan_monitor.added_monitors.lock().unwrap();
1978 assert_eq!(added_monitors.len(), 2);
1979 added_monitors.clear();
1981 assert!(node.node.handle_revoke_and_ack(&prev_node.node.get_our_node_id(), &prev_revoke_and_ack.0).unwrap().is_none());
1982 assert!(prev_revoke_and_ack.1.is_none());
1984 let mut added_monitors = node.chan_monitor.added_monitors.lock().unwrap();
1985 assert_eq!(added_monitors.len(), 1);
1986 added_monitors.clear();
1989 let events_1 = node.node.get_and_clear_pending_events();
1990 assert_eq!(events_1.len(), 1);
1992 Event::PendingHTLCsForwardable { .. } => { },
1993 _ => panic!("Unexpected event"),
1996 node.node.channel_state.lock().unwrap().next_forward = Instant::now();
1997 node.node.process_pending_htlc_forward();
1999 let mut events_2 = node.node.get_and_clear_pending_events();
2000 assert_eq!(events_2.len(), 1);
2001 if idx == expected_route.len() - 1 {
2003 Event::PaymentReceived { ref payment_hash, amt } => {
2004 assert_eq!(our_payment_hash, *payment_hash);
2005 assert_eq!(amt, recv_value);
2007 _ => panic!("Unexpected event"),
2010 for event in events_2.drain(..) {
2011 payment_event = SendEvent::from_event(event);
2013 assert_eq!(payment_event.msgs.len(), 1);
2019 (our_payment_preimage, our_payment_hash)
2022 fn claim_payment(origin_node: &Node, expected_route: &[&Node], our_payment_preimage: [u8; 32]) {
2023 assert!(expected_route.last().unwrap().node.claim_funds(our_payment_preimage));
2025 let mut added_monitors = expected_route.last().unwrap().chan_monitor.added_monitors.lock().unwrap();
2026 assert_eq!(added_monitors.len(), 1);
2027 added_monitors.clear();
2030 let mut next_msgs: Option<(msgs::UpdateFulfillHTLC, msgs::CommitmentSigned)> = None;
2031 macro_rules! update_fulfill_dance {
2032 ($node: expr, $prev_node: expr) => {
2034 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0).unwrap();
2035 let revoke_and_commit = $node.node.handle_commitment_signed(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().1).unwrap();
2037 let mut added_monitors = $node.chan_monitor.added_monitors.lock().unwrap();
2038 assert_eq!(added_monitors.len(), 2);
2039 added_monitors.clear();
2041 assert!($prev_node.node.handle_revoke_and_ack(&$node.node.get_our_node_id(), &revoke_and_commit.0).unwrap().is_none());
2042 let revoke_and_ack = $prev_node.node.handle_commitment_signed(&$node.node.get_our_node_id(), &revoke_and_commit.1.unwrap()).unwrap();
2043 assert!(revoke_and_ack.1.is_none());
2045 let mut added_monitors = $prev_node.chan_monitor.added_monitors.lock().unwrap();
2046 assert_eq!(added_monitors.len(), 2);
2047 added_monitors.clear();
2049 assert!($node.node.handle_revoke_and_ack(&$prev_node.node.get_our_node_id(), &revoke_and_ack.0).unwrap().is_none());
2051 let mut added_monitors = $node.chan_monitor.added_monitors.lock().unwrap();
2052 assert_eq!(added_monitors.len(), 1);
2053 added_monitors.clear();
2059 let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
2060 let mut prev_node = expected_route.last().unwrap();
2061 for node in expected_route.iter().rev() {
2062 assert_eq!(expected_next_node, node.node.get_our_node_id());
2063 if next_msgs.is_some() {
2064 update_fulfill_dance!(node, prev_node);
2067 let events = node.node.get_and_clear_pending_events();
2068 assert_eq!(events.len(), 1);
2070 Event::SendFulfillHTLC { ref node_id, ref msg, ref commitment_msg } => {
2071 expected_next_node = node_id.clone();
2072 next_msgs = Some((msg.clone(), commitment_msg.clone()));
2074 _ => panic!("Unexpected event"),
2080 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2081 update_fulfill_dance!(origin_node, expected_route.first().unwrap());
2083 let events = origin_node.node.get_and_clear_pending_events();
2084 assert_eq!(events.len(), 1);
2086 Event::PaymentSent { payment_preimage } => {
2087 assert_eq!(payment_preimage, our_payment_preimage);
2089 _ => panic!("Unexpected event"),
2093 fn route_payment(origin_node: &Node, expected_route: &[&Node], recv_value: u64) -> ([u8; 32], [u8; 32]) {
2094 let route = origin_node.router.get_route(&expected_route.last().unwrap().node.get_our_node_id(), &Vec::new(), recv_value, 142).unwrap();
2095 assert_eq!(route.hops.len(), expected_route.len());
2096 for (node, hop) in expected_route.iter().zip(route.hops.iter()) {
2097 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2100 send_along_route(origin_node, route, expected_route, recv_value)
2103 fn route_over_limit(origin_node: &Node, expected_route: &[&Node], recv_value: u64) {
2104 let route = origin_node.router.get_route(&expected_route.last().unwrap().node.get_our_node_id(), &Vec::new(), recv_value, 142).unwrap();
2105 assert_eq!(route.hops.len(), expected_route.len());
2106 for (node, hop) in expected_route.iter().zip(route.hops.iter()) {
2107 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2110 let our_payment_preimage = unsafe { [PAYMENT_COUNT; 32] };
2111 unsafe { PAYMENT_COUNT += 1 };
2112 let our_payment_hash = {
2113 let mut sha = Sha256::new();
2114 sha.input(&our_payment_preimage[..]);
2115 let mut ret = [0; 32];
2116 sha.result(&mut ret);
2120 let err = origin_node.node.send_payment(route, our_payment_hash).err().unwrap();
2121 assert_eq!(err.err, "Cannot send value that would put us over our max HTLC value in flight");
2124 fn send_payment(origin: &Node, expected_route: &[&Node], recv_value: u64) {
2125 let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
2126 claim_payment(&origin, expected_route, our_payment_preimage);
2129 fn send_failed_payment(origin_node: &Node, expected_route: &[&Node]) {
2130 let route = origin_node.router.get_route(&expected_route.last().unwrap().node.get_our_node_id(), &Vec::new(), 1000000, 142).unwrap();
2131 assert_eq!(route.hops.len(), expected_route.len());
2132 for (node, hop) in expected_route.iter().zip(route.hops.iter()) {
2133 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2135 let our_payment_hash = send_along_route(origin_node, route, expected_route, 1000000).1;
2137 assert!(expected_route.last().unwrap().node.fail_htlc_backwards(&our_payment_hash));
2139 let mut next_msgs: Option<(msgs::UpdateFailHTLC, msgs::CommitmentSigned)> = None;
2140 macro_rules! update_fail_dance {
2141 ($node: expr, $prev_node: expr) => {
2143 $node.node.handle_update_fail_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0).unwrap();
2144 let revoke_and_commit = $node.node.handle_commitment_signed(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().1).unwrap();
2146 let mut added_monitors = $node.chan_monitor.added_monitors.lock().unwrap();
2147 assert_eq!(added_monitors.len(), 1);
2148 added_monitors.clear();
2150 assert!($prev_node.node.handle_revoke_and_ack(&$node.node.get_our_node_id(), &revoke_and_commit.0).unwrap().is_none());
2151 let revoke_and_ack = $prev_node.node.handle_commitment_signed(&$node.node.get_our_node_id(), &revoke_and_commit.1.unwrap()).unwrap();
2152 assert!(revoke_and_ack.1.is_none());
2154 let mut added_monitors = $prev_node.chan_monitor.added_monitors.lock().unwrap();
2155 assert_eq!(added_monitors.len(), 2);
2156 added_monitors.clear();
2158 assert!($node.node.handle_revoke_and_ack(&$prev_node.node.get_our_node_id(), &revoke_and_ack.0).unwrap().is_none());
2160 let mut added_monitors = $node.chan_monitor.added_monitors.lock().unwrap();
2161 assert_eq!(added_monitors.len(), 1);
2162 added_monitors.clear();
2168 let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
2169 let mut prev_node = expected_route.last().unwrap();
2170 for node in expected_route.iter().rev() {
2171 assert_eq!(expected_next_node, node.node.get_our_node_id());
2172 if next_msgs.is_some() {
2173 update_fail_dance!(node, prev_node);
2176 let events = node.node.get_and_clear_pending_events();
2177 assert_eq!(events.len(), 1);
2179 Event::SendFailHTLC { ref node_id, ref msg, ref commitment_msg } => {
2180 expected_next_node = node_id.clone();
2181 next_msgs = Some((msg.clone(), commitment_msg.clone()));
2183 _ => panic!("Unexpected event"),
2189 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2190 update_fail_dance!(origin_node, expected_route.first().unwrap());
2192 let events = origin_node.node.get_and_clear_pending_events();
2193 assert_eq!(events.len(), 1);
2195 Event::PaymentFailed { payment_hash } => {
2196 assert_eq!(payment_hash, our_payment_hash);
2198 _ => panic!("Unexpected event"),
2202 fn create_network(node_count: usize) -> Vec<Node> {
2203 let mut nodes = Vec::new();
2204 let mut rng = thread_rng();
2205 let secp_ctx = Secp256k1::new();
2207 for _ in 0..node_count {
2208 let feeest = Arc::new(test_utils::TestFeeEstimator { sat_per_vbyte: 1 });
2209 let chain_monitor = Arc::new(chaininterface::ChainWatchInterfaceUtil::new());
2210 let tx_broadcaster = Arc::new(test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())});
2211 let chan_monitor = Arc::new(test_utils::TestChannelMonitor::new(chain_monitor.clone(), tx_broadcaster.clone()));
2213 let mut key_slice = [0; 32];
2214 rng.fill_bytes(&mut key_slice);
2215 SecretKey::from_slice(&secp_ctx, &key_slice).unwrap()
2217 let node = ChannelManager::new(node_id.clone(), 0, true, Network::Testnet, feeest.clone(), chan_monitor.clone(), chain_monitor.clone(), tx_broadcaster.clone()).unwrap();
2218 let router = Router::new(PublicKey::from_secret_key(&secp_ctx, &node_id).unwrap());
2219 nodes.push(Node { feeest, chain_monitor, tx_broadcaster, chan_monitor, node_id, node, router });
2226 fn fake_network_test() {
2227 // Simple test which builds a network of ChannelManagers, connects them to each other, and
2228 // tests that payments get routed and transactions broadcast in semi-reasonable ways.
2229 let nodes = create_network(4);
2231 // Create some initial channels
2232 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
2233 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
2234 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3);
2236 // Rebalance the network a bit by relaying one payment through all the channels...
2237 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
2238 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
2239 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
2240 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
2242 // Send some more payments
2243 send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000);
2244 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000);
2245 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000);
2247 // Test failure packets
2248 send_failed_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..]);
2250 // Add a new channel that skips 3
2251 let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3);
2253 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000);
2254 send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000);
2255 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
2256 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
2257 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
2258 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
2259 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
2261 // Do some rebalance loop payments, simultaneously
2262 let mut hops = Vec::with_capacity(3);
2263 hops.push(RouteHop {
2264 pubkey: nodes[2].node.get_our_node_id(),
2265 short_channel_id: chan_2.0.contents.short_channel_id,
2267 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
2269 hops.push(RouteHop {
2270 pubkey: nodes[3].node.get_our_node_id(),
2271 short_channel_id: chan_3.0.contents.short_channel_id,
2273 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
2275 hops.push(RouteHop {
2276 pubkey: nodes[1].node.get_our_node_id(),
2277 short_channel_id: chan_4.0.contents.short_channel_id,
2279 cltv_expiry_delta: 142,
2281 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;
2282 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;
2283 let payment_preimage_1 = send_along_route(&nodes[1], Route { hops }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
2285 let mut hops = Vec::with_capacity(3);
2286 hops.push(RouteHop {
2287 pubkey: nodes[3].node.get_our_node_id(),
2288 short_channel_id: chan_4.0.contents.short_channel_id,
2290 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
2292 hops.push(RouteHop {
2293 pubkey: nodes[2].node.get_our_node_id(),
2294 short_channel_id: chan_3.0.contents.short_channel_id,
2296 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
2298 hops.push(RouteHop {
2299 pubkey: nodes[1].node.get_our_node_id(),
2300 short_channel_id: chan_2.0.contents.short_channel_id,
2302 cltv_expiry_delta: 142,
2304 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;
2305 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;
2306 let payment_preimage_2 = send_along_route(&nodes[1], Route { hops }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).0;
2308 // Claim the rebalances...
2309 claim_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_preimage_2);
2310 claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1);
2312 // Add a duplicate new channel from 2 to 4
2313 let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3);
2315 // Send some payments across both channels
2316 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
2317 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
2318 let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
2320 route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
2322 //TODO: Test that routes work again here as we've been notified that the channel is full
2324 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3);
2325 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4);
2326 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5);
2328 // Close down the channels...
2329 close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
2330 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
2331 close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
2332 close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
2333 close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
2335 // Check that we processed all pending events
2337 assert_eq!(node.node.get_and_clear_pending_events().len(), 0);
2338 assert_eq!(node.chan_monitor.added_monitors.lock().unwrap().len(), 0);