1 //! The top-level channel management and payment tracking stuff lives here.
3 //! The ChannelManager is the main chunk of logic implementing the lightning protocol and is
4 //! responsible for tracking which channels are open, HTLCs are in flight and reestablishing those
5 //! upon reconnect to the relevant peer(s).
7 //! It does not manage routing logic (see ln::router for that) nor does it manage constructing
8 //! on-chain transactions (it only monitors the chain to watch for any force-closes that might
9 //! imply it needs to fail HTLCs/payments/channels it manages).
11 use bitcoin::blockdata::block::BlockHeader;
12 use bitcoin::blockdata::transaction::Transaction;
13 use bitcoin::blockdata::constants::genesis_block;
14 use bitcoin::network::constants::Network;
15 use bitcoin::network::serialize::BitcoinHash;
16 use bitcoin::util::hash::Sha256dHash;
18 use secp256k1::key::{SecretKey,PublicKey};
19 use secp256k1::{Secp256k1,Message};
20 use secp256k1::ecdh::SharedSecret;
23 use chain::chaininterface::{BroadcasterInterface,ChainListener,ChainWatchInterface,FeeEstimator};
24 use chain::transaction::OutPoint;
25 use ln::channel::{Channel, ChannelError, ChannelKeys};
26 use ln::channelmonitor::ManyChannelMonitor;
27 use ln::router::{Route,RouteHop};
29 use ln::msgs::{HandleError,ChannelMessageHandler};
30 use util::{byte_utils, events, internal_traits, rng};
31 use util::sha2::Sha256;
32 use util::ser::{Readable, Writeable};
33 use util::chacha20poly1305rfc::ChaCha20;
34 use util::logger::Logger;
35 use util::errors::APIError;
38 use crypto::mac::{Mac,MacResult};
39 use crypto::hmac::Hmac;
40 use crypto::digest::Digest;
41 use crypto::symmetriccipher::SynchronousStreamCipher;
44 use std::collections::HashMap;
45 use std::collections::hash_map;
47 use std::sync::{Mutex,MutexGuard,Arc};
48 use std::sync::atomic::{AtomicUsize, Ordering};
49 use std::time::{Instant,Duration};
51 /// We hold various information about HTLC relay in the HTLC objects in Channel itself:
53 /// Upon receipt of an HTLC from a peer, we'll give it a PendingHTLCStatus indicating if it should
54 /// forward the HTLC with information it will give back to us when it does so, or if it should Fail
55 /// the HTLC with the relevant message for the Channel to handle giving to the remote peer.
57 /// When a Channel forwards an HTLC to its peer, it will give us back the PendingForwardHTLCInfo
58 /// which we will use to construct an outbound HTLC, with a relevant HTLCSource::PreviousHopData
59 /// filled in to indicate where it came from (which we can use to either fail-backwards or fulfill
60 /// the HTLC backwards along the relevant path).
61 /// Alternatively, we can fill an outbound HTLC with a HTLCSource::OutboundRoute indicating this is
62 /// our payment, which we can use to decode errors or inform the user that the payment was sent.
63 mod channel_held_info {
65 use ln::router::Route;
66 use secp256k1::key::SecretKey;
67 use secp256k1::ecdh::SharedSecret;
69 /// Stores the info we will need to send when we want to forward an HTLC onwards
70 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
71 pub struct PendingForwardHTLCInfo {
72 pub(super) onion_packet: Option<msgs::OnionPacket>,
73 pub(super) incoming_shared_secret: SharedSecret,
74 pub(super) payment_hash: [u8; 32],
75 pub(super) short_channel_id: u64,
76 pub(super) amt_to_forward: u64,
77 pub(super) outgoing_cltv_value: u32,
80 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
81 pub enum HTLCFailureMsg {
82 Relay(msgs::UpdateFailHTLC),
83 Malformed(msgs::UpdateFailMalformedHTLC),
86 /// Stores whether we can't forward an HTLC or relevant forwarding info
87 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
88 pub enum PendingHTLCStatus {
89 Forward(PendingForwardHTLCInfo),
93 /// Tracks the inbound corresponding to an outbound HTLC
95 pub struct HTLCPreviousHopData {
96 pub(super) short_channel_id: u64,
97 pub(super) htlc_id: u64,
98 pub(super) incoming_packet_shared_secret: SharedSecret,
101 /// Tracks the inbound corresponding to an outbound HTLC
103 pub enum HTLCSource {
104 PreviousHopData(HTLCPreviousHopData),
107 session_priv: SecretKey,
112 pub fn dummy() -> Self {
113 HTLCSource::OutboundRoute {
114 route: Route { hops: Vec::new() },
115 session_priv: SecretKey::from_slice(&::secp256k1::Secp256k1::without_caps(), &[1; 32]).unwrap(),
120 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
121 pub(crate) enum HTLCFailReason {
123 err: msgs::OnionErrorPacket,
131 pub(super) use self::channel_held_info::*;
133 struct MsgHandleErrInternal {
134 err: msgs::HandleError,
135 needs_channel_force_close: bool,
137 impl MsgHandleErrInternal {
139 fn send_err_msg_no_close(err: &'static str, channel_id: [u8; 32]) -> Self {
143 action: Some(msgs::ErrorAction::SendErrorMessage {
144 msg: msgs::ErrorMessage {
146 data: err.to_string()
150 needs_channel_force_close: false,
154 fn send_err_msg_close_chan(err: &'static str, channel_id: [u8; 32]) -> Self {
158 action: Some(msgs::ErrorAction::SendErrorMessage {
159 msg: msgs::ErrorMessage {
161 data: err.to_string()
165 needs_channel_force_close: true,
169 fn from_maybe_close(err: msgs::HandleError) -> Self {
170 Self { err, needs_channel_force_close: true }
173 fn from_no_close(err: msgs::HandleError) -> Self {
174 Self { err, needs_channel_force_close: false }
177 fn from_chan_no_close(err: ChannelError, channel_id: [u8; 32]) -> Self {
180 ChannelError::Ignore(msg) => HandleError {
182 action: Some(msgs::ErrorAction::IgnoreError),
184 ChannelError::Close(msg) => HandleError {
186 action: Some(msgs::ErrorAction::SendErrorMessage {
187 msg: msgs::ErrorMessage {
189 data: msg.to_string()
194 needs_channel_force_close: false,
198 fn from_chan_maybe_close(err: ChannelError, channel_id: [u8; 32]) -> Self {
201 ChannelError::Ignore(msg) => HandleError {
203 action: Some(msgs::ErrorAction::IgnoreError),
205 ChannelError::Close(msg) => HandleError {
207 action: Some(msgs::ErrorAction::SendErrorMessage {
208 msg: msgs::ErrorMessage {
210 data: msg.to_string()
215 needs_channel_force_close: true,
220 /// We hold back HTLCs we intend to relay for a random interval in the range (this, 5*this). This
221 /// provides some limited amount of privacy. Ideally this would range from somewhere like 1 second
222 /// to 30 seconds, but people expect lightning to be, you know, kinda fast, sadly. We could
223 /// probably increase this significantly.
224 const MIN_HTLC_RELAY_HOLDING_CELL_MILLIS: u32 = 50;
226 struct HTLCForwardInfo {
227 prev_short_channel_id: u64,
229 forward_info: PendingForwardHTLCInfo,
232 struct ChannelHolder {
233 by_id: HashMap<[u8; 32], Channel>,
234 short_to_id: HashMap<u64, [u8; 32]>,
235 next_forward: Instant,
236 /// short channel id -> forward infos. Key of 0 means payments received
237 /// Note that while this is held in the same mutex as the channels themselves, no consistency
238 /// guarantees are made about there existing a channel with the short id here, nor the short
239 /// ids in the PendingForwardHTLCInfo!
240 forward_htlcs: HashMap<u64, Vec<HTLCForwardInfo>>,
241 /// Note that while this is held in the same mutex as the channels themselves, no consistency
242 /// guarantees are made about the channels given here actually existing anymore by the time you
244 claimable_htlcs: HashMap<[u8; 32], Vec<HTLCPreviousHopData>>,
246 struct MutChannelHolder<'a> {
247 by_id: &'a mut HashMap<[u8; 32], Channel>,
248 short_to_id: &'a mut HashMap<u64, [u8; 32]>,
249 next_forward: &'a mut Instant,
250 forward_htlcs: &'a mut HashMap<u64, Vec<HTLCForwardInfo>>,
251 claimable_htlcs: &'a mut HashMap<[u8; 32], Vec<HTLCPreviousHopData>>,
254 fn borrow_parts(&mut self) -> MutChannelHolder {
256 by_id: &mut self.by_id,
257 short_to_id: &mut self.short_to_id,
258 next_forward: &mut self.next_forward,
259 forward_htlcs: &mut self.forward_htlcs,
260 claimable_htlcs: &mut self.claimable_htlcs,
265 #[cfg(not(any(target_pointer_width = "32", target_pointer_width = "64")))]
266 const ERR: () = "You need at least 32 bit pointers (well, usize, but we'll assume they're the same) for ChannelManager::latest_block_height";
268 /// Manager which keeps track of a number of channels and sends messages to the appropriate
269 /// channel, also tracking HTLC preimages and forwarding onion packets appropriately.
271 /// Implements ChannelMessageHandler, handling the multi-channel parts and passing things through
272 /// to individual Channels.
273 pub struct ChannelManager {
274 genesis_hash: Sha256dHash,
275 fee_estimator: Arc<FeeEstimator>,
276 monitor: Arc<ManyChannelMonitor>,
277 chain_monitor: Arc<ChainWatchInterface>,
278 tx_broadcaster: Arc<BroadcasterInterface>,
280 announce_channels_publicly: bool,
281 fee_proportional_millionths: u32,
282 latest_block_height: AtomicUsize,
283 secp_ctx: Secp256k1<secp256k1::All>,
285 channel_state: Mutex<ChannelHolder>,
286 our_network_key: SecretKey,
288 pending_events: Mutex<Vec<events::Event>>,
293 const CLTV_EXPIRY_DELTA: u16 = 6 * 24 * 2; //TODO?
295 macro_rules! secp_call {
296 ( $res: expr, $err: expr ) => {
299 Err(_) => return Err($err),
306 shared_secret: SharedSecret,
308 blinding_factor: [u8; 32],
309 ephemeral_pubkey: PublicKey,
314 /// Details of a channel, as returned by ChannelManager::list_channels and ChannelManager::list_usable_channels
315 pub struct ChannelDetails {
316 /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
317 /// thereafter this is the txid of the funding transaction xor the funding transaction output).
318 /// Note that this means this value is *not* persistent - it can change once during the
319 /// lifetime of the channel.
320 pub channel_id: [u8; 32],
321 /// The position of the funding transaction in the chain. None if the funding transaction has
322 /// not yet been confirmed and the channel fully opened.
323 pub short_channel_id: Option<u64>,
324 /// The node_id of our counterparty
325 pub remote_network_id: PublicKey,
326 /// The value, in satoshis, of this channel as appears in the funding output
327 pub channel_value_satoshis: u64,
328 /// The user_id passed in to create_channel, or 0 if the channel was inbound.
332 impl ChannelManager {
333 /// Constructs a new ChannelManager to hold several channels and route between them.
335 /// This is the main "logic hub" for all channel-related actions, and implements
336 /// ChannelMessageHandler.
338 /// fee_proportional_millionths is an optional fee to charge any payments routed through us.
339 /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
341 /// panics if channel_value_satoshis is >= `MAX_FUNDING_SATOSHIS`!
342 pub fn new(our_network_key: SecretKey, fee_proportional_millionths: u32, announce_channels_publicly: bool, network: Network, feeest: Arc<FeeEstimator>, monitor: Arc<ManyChannelMonitor>, chain_monitor: Arc<ChainWatchInterface>, tx_broadcaster: Arc<BroadcasterInterface>, logger: Arc<Logger>) -> Result<Arc<ChannelManager>, secp256k1::Error> {
343 let secp_ctx = Secp256k1::new();
345 let res = Arc::new(ChannelManager {
346 genesis_hash: genesis_block(network).header.bitcoin_hash(),
347 fee_estimator: feeest.clone(),
348 monitor: monitor.clone(),
352 announce_channels_publicly,
353 fee_proportional_millionths,
354 latest_block_height: AtomicUsize::new(0), //TODO: Get an init value (generally need to replay recent chain on chain_monitor registration)
357 channel_state: Mutex::new(ChannelHolder{
358 by_id: HashMap::new(),
359 short_to_id: HashMap::new(),
360 next_forward: Instant::now(),
361 forward_htlcs: HashMap::new(),
362 claimable_htlcs: HashMap::new(),
366 pending_events: Mutex::new(Vec::new()),
370 let weak_res = Arc::downgrade(&res);
371 res.chain_monitor.register_listener(weak_res);
375 /// Creates a new outbound channel to the given remote node and with the given value.
377 /// user_id will be provided back as user_channel_id in FundingGenerationReady and
378 /// FundingBroadcastSafe events to allow tracking of which events correspond with which
379 /// create_channel call. Note that user_channel_id defaults to 0 for inbound channels, so you
380 /// may wish to avoid using 0 for user_id here.
382 /// If successful, will generate a SendOpenChannel event, so you should probably poll
383 /// PeerManager::process_events afterwards.
385 /// Raises APIError::APIMisuseError when channel_value_satoshis > 2**24 or push_msat being greater than channel_value_satoshis * 1k
386 pub fn create_channel(&self, their_network_key: PublicKey, channel_value_satoshis: u64, push_msat: u64, user_id: u64) -> Result<(), APIError> {
387 let chan_keys = if cfg!(feature = "fuzztarget") {
389 funding_key: SecretKey::from_slice(&self.secp_ctx, &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]).unwrap(),
390 revocation_base_key: SecretKey::from_slice(&self.secp_ctx, &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]).unwrap(),
391 payment_base_key: SecretKey::from_slice(&self.secp_ctx, &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]).unwrap(),
392 delayed_payment_base_key: SecretKey::from_slice(&self.secp_ctx, &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]).unwrap(),
393 htlc_base_key: SecretKey::from_slice(&self.secp_ctx, &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]).unwrap(),
394 channel_close_key: SecretKey::from_slice(&self.secp_ctx, &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]).unwrap(),
395 channel_monitor_claim_key: SecretKey::from_slice(&self.secp_ctx, &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]).unwrap(),
396 commitment_seed: [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
399 let mut key_seed = [0u8; 32];
400 rng::fill_bytes(&mut key_seed);
401 match ChannelKeys::new_from_seed(&key_seed) {
403 Err(_) => panic!("RNG is busted!")
407 let channel = Channel::new_outbound(&*self.fee_estimator, chan_keys, their_network_key, channel_value_satoshis, push_msat, self.announce_channels_publicly, user_id, Arc::clone(&self.logger))?;
408 let res = channel.get_open_channel(self.genesis_hash.clone(), &*self.fee_estimator);
409 let mut channel_state = self.channel_state.lock().unwrap();
410 match channel_state.by_id.entry(channel.channel_id()) {
411 hash_map::Entry::Occupied(_) => {
412 if cfg!(feature = "fuzztarget") {
413 return Err(APIError::APIMisuseError { err: "Fuzzy bad RNG" });
415 panic!("RNG is bad???");
418 hash_map::Entry::Vacant(entry) => { entry.insert(channel); }
421 let mut events = self.pending_events.lock().unwrap();
422 events.push(events::Event::SendOpenChannel {
423 node_id: their_network_key,
429 /// Gets the list of open channels, in random order. See ChannelDetail field documentation for
430 /// more information.
431 pub fn list_channels(&self) -> Vec<ChannelDetails> {
432 let channel_state = self.channel_state.lock().unwrap();
433 let mut res = Vec::with_capacity(channel_state.by_id.len());
434 for (channel_id, channel) in channel_state.by_id.iter() {
435 res.push(ChannelDetails {
436 channel_id: (*channel_id).clone(),
437 short_channel_id: channel.get_short_channel_id(),
438 remote_network_id: channel.get_their_node_id(),
439 channel_value_satoshis: channel.get_value_satoshis(),
440 user_id: channel.get_user_id(),
446 /// Gets the list of usable channels, in random order. Useful as an argument to
447 /// Router::get_route to ensure non-announced channels are used.
448 pub fn list_usable_channels(&self) -> Vec<ChannelDetails> {
449 let channel_state = self.channel_state.lock().unwrap();
450 let mut res = Vec::with_capacity(channel_state.by_id.len());
451 for (channel_id, channel) in channel_state.by_id.iter() {
452 // Note we use is_live here instead of usable which leads to somewhat confused
453 // internal/external nomenclature, but that's ok cause that's probably what the user
454 // really wanted anyway.
455 if channel.is_live() {
456 res.push(ChannelDetails {
457 channel_id: (*channel_id).clone(),
458 short_channel_id: channel.get_short_channel_id(),
459 remote_network_id: channel.get_their_node_id(),
460 channel_value_satoshis: channel.get_value_satoshis(),
461 user_id: channel.get_user_id(),
468 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
469 /// will be accepted on the given channel, and after additional timeout/the closing of all
470 /// pending HTLCs, the channel will be closed on chain.
472 /// May generate a SendShutdown event on success, which should be relayed.
473 pub fn close_channel(&self, channel_id: &[u8; 32]) -> Result<(), APIError> {
474 let (mut res, node_id, chan_option) = {
475 let mut channel_state_lock = self.channel_state.lock().unwrap();
476 let channel_state = channel_state_lock.borrow_parts();
477 match channel_state.by_id.entry(channel_id.clone()) {
478 hash_map::Entry::Occupied(mut chan_entry) => {
479 let res = chan_entry.get_mut().get_shutdown()?;
480 if chan_entry.get().is_shutdown() {
481 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
482 channel_state.short_to_id.remove(&short_id);
484 (res, chan_entry.get().get_their_node_id(), Some(chan_entry.remove_entry().1))
485 } else { (res, chan_entry.get().get_their_node_id(), None) }
487 hash_map::Entry::Vacant(_) => return Err(APIError::ChannelUnavailable{err: "No such channel"})
490 for htlc_source in res.1.drain(..) {
491 // unknown_next_peer...I dunno who that is anymore....
492 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source.0, &htlc_source.1, HTLCFailReason::Reason { failure_code: 0x4000 | 10, data: Vec::new() });
494 let chan_update = if let Some(chan) = chan_option {
495 if let Ok(update) = self.get_channel_update(&chan) {
500 let mut events = self.pending_events.lock().unwrap();
501 if let Some(update) = chan_update {
502 events.push(events::Event::BroadcastChannelUpdate {
506 events.push(events::Event::SendShutdown {
515 fn finish_force_close_channel(&self, shutdown_res: (Vec<Transaction>, Vec<(HTLCSource, [u8; 32])>)) {
516 let (local_txn, mut failed_htlcs) = shutdown_res;
517 for htlc_source in failed_htlcs.drain(..) {
518 // unknown_next_peer...I dunno who that is anymore....
519 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source.0, &htlc_source.1, HTLCFailReason::Reason { failure_code: 0x4000 | 10, data: Vec::new() });
521 for tx in local_txn {
522 self.tx_broadcaster.broadcast_transaction(&tx);
524 //TODO: We need to have a way where outbound HTLC claims can result in us claiming the
525 //now-on-chain HTLC output for ourselves (and, thereafter, passing the HTLC backwards).
526 //TODO: We need to handle monitoring of pending offered HTLCs which just hit the chain and
527 //may be claimed, resulting in us claiming the inbound HTLCs (and back-failing after
528 //timeouts are hit and our claims confirm).
529 //TODO: In any case, we need to make sure we remove any pending htlc tracking (via
530 //fail_backwards or claim_funds) eventually for all HTLCs that were in the channel
533 /// Force closes a channel, immediately broadcasting the latest local commitment transaction to
534 /// the chain and rejecting new HTLCs on the given channel.
535 pub fn force_close_channel(&self, channel_id: &[u8; 32]) {
537 let mut channel_state_lock = self.channel_state.lock().unwrap();
538 let channel_state = channel_state_lock.borrow_parts();
539 if let Some(chan) = channel_state.by_id.remove(channel_id) {
540 if let Some(short_id) = chan.get_short_channel_id() {
541 channel_state.short_to_id.remove(&short_id);
548 self.finish_force_close_channel(chan.force_shutdown());
549 let mut events = self.pending_events.lock().unwrap();
550 if let Ok(update) = self.get_channel_update(&chan) {
551 events.push(events::Event::BroadcastChannelUpdate {
557 /// Force close all channels, immediately broadcasting the latest local commitment transaction
558 /// for each to the chain and rejecting new HTLCs on each.
559 pub fn force_close_all_channels(&self) {
560 for chan in self.list_channels() {
561 self.force_close_channel(&chan.channel_id);
566 fn gen_rho_mu_from_shared_secret(shared_secret: &SharedSecret) -> ([u8; 32], [u8; 32]) {
568 let mut hmac = Hmac::new(Sha256::new(), &[0x72, 0x68, 0x6f]); // rho
569 hmac.input(&shared_secret[..]);
570 let mut res = [0; 32];
571 hmac.raw_result(&mut res);
575 let mut hmac = Hmac::new(Sha256::new(), &[0x6d, 0x75]); // mu
576 hmac.input(&shared_secret[..]);
577 let mut res = [0; 32];
578 hmac.raw_result(&mut res);
584 fn gen_um_from_shared_secret(shared_secret: &SharedSecret) -> [u8; 32] {
585 let mut hmac = Hmac::new(Sha256::new(), &[0x75, 0x6d]); // um
586 hmac.input(&shared_secret[..]);
587 let mut res = [0; 32];
588 hmac.raw_result(&mut res);
593 fn gen_ammag_from_shared_secret(shared_secret: &SharedSecret) -> [u8; 32] {
594 let mut hmac = Hmac::new(Sha256::new(), &[0x61, 0x6d, 0x6d, 0x61, 0x67]); // ammag
595 hmac.input(&shared_secret[..]);
596 let mut res = [0; 32];
597 hmac.raw_result(&mut res);
601 // can only fail if an intermediary hop has an invalid public key or session_priv is invalid
603 fn construct_onion_keys_callback<T: secp256k1::Signing, FType: FnMut(SharedSecret, [u8; 32], PublicKey, &RouteHop)> (secp_ctx: &Secp256k1<T>, route: &Route, session_priv: &SecretKey, mut callback: FType) -> Result<(), secp256k1::Error> {
604 let mut blinded_priv = session_priv.clone();
605 let mut blinded_pub = PublicKey::from_secret_key(secp_ctx, &blinded_priv);
607 for hop in route.hops.iter() {
608 let shared_secret = SharedSecret::new(secp_ctx, &hop.pubkey, &blinded_priv);
610 let mut sha = Sha256::new();
611 sha.input(&blinded_pub.serialize()[..]);
612 sha.input(&shared_secret[..]);
613 let mut blinding_factor = [0u8; 32];
614 sha.result(&mut blinding_factor);
616 let ephemeral_pubkey = blinded_pub;
618 blinded_priv.mul_assign(secp_ctx, &SecretKey::from_slice(secp_ctx, &blinding_factor)?)?;
619 blinded_pub = PublicKey::from_secret_key(secp_ctx, &blinded_priv);
621 callback(shared_secret, blinding_factor, ephemeral_pubkey, hop);
627 // can only fail if an intermediary hop has an invalid public key or session_priv is invalid
628 fn construct_onion_keys<T: secp256k1::Signing>(secp_ctx: &Secp256k1<T>, route: &Route, session_priv: &SecretKey) -> Result<Vec<OnionKeys>, secp256k1::Error> {
629 let mut res = Vec::with_capacity(route.hops.len());
631 Self::construct_onion_keys_callback(secp_ctx, route, session_priv, |shared_secret, _blinding_factor, ephemeral_pubkey, _| {
632 let (rho, mu) = ChannelManager::gen_rho_mu_from_shared_secret(&shared_secret);
638 blinding_factor: _blinding_factor,
648 /// returns the hop data, as well as the first-hop value_msat and CLTV value we should send.
649 fn build_onion_payloads(route: &Route, starting_htlc_offset: u32) -> Result<(Vec<msgs::OnionHopData>, u64, u32), APIError> {
650 let mut cur_value_msat = 0u64;
651 let mut cur_cltv = starting_htlc_offset;
652 let mut last_short_channel_id = 0;
653 let mut res: Vec<msgs::OnionHopData> = Vec::with_capacity(route.hops.len());
654 internal_traits::test_no_dealloc::<msgs::OnionHopData>(None);
655 unsafe { res.set_len(route.hops.len()); }
657 for (idx, hop) in route.hops.iter().enumerate().rev() {
658 // First hop gets special values so that it can check, on receipt, that everything is
659 // exactly as it should be (and the next hop isn't trying to probe to find out if we're
660 // the intended recipient).
661 let value_msat = if cur_value_msat == 0 { hop.fee_msat } else { cur_value_msat };
662 let cltv = if cur_cltv == starting_htlc_offset { hop.cltv_expiry_delta + starting_htlc_offset } else { cur_cltv };
663 res[idx] = msgs::OnionHopData {
665 data: msgs::OnionRealm0HopData {
666 short_channel_id: last_short_channel_id,
667 amt_to_forward: value_msat,
668 outgoing_cltv_value: cltv,
672 cur_value_msat += hop.fee_msat;
673 if cur_value_msat >= 21000000 * 100000000 * 1000 {
674 return Err(APIError::RouteError{err: "Channel fees overflowed?!"});
676 cur_cltv += hop.cltv_expiry_delta as u32;
677 if cur_cltv >= 500000000 {
678 return Err(APIError::RouteError{err: "Channel CLTV overflowed?!"});
680 last_short_channel_id = hop.short_channel_id;
682 Ok((res, cur_value_msat, cur_cltv))
686 fn shift_arr_right(arr: &mut [u8; 20*65]) {
688 ptr::copy(arr[0..].as_ptr(), arr[65..].as_mut_ptr(), 19*65);
696 fn xor_bufs(dst: &mut[u8], src: &[u8]) {
697 assert_eq!(dst.len(), src.len());
699 for i in 0..dst.len() {
704 const ZERO:[u8; 21*65] = [0; 21*65];
705 fn construct_onion_packet(mut payloads: Vec<msgs::OnionHopData>, onion_keys: Vec<OnionKeys>, associated_data: &[u8; 32]) -> msgs::OnionPacket {
706 let mut buf = Vec::with_capacity(21*65);
707 buf.resize(21*65, 0);
710 let iters = payloads.len() - 1;
711 let end_len = iters * 65;
712 let mut res = Vec::with_capacity(end_len);
713 res.resize(end_len, 0);
715 for (i, keys) in onion_keys.iter().enumerate() {
716 if i == payloads.len() - 1 { continue; }
717 let mut chacha = ChaCha20::new(&keys.rho, &[0u8; 8]);
718 chacha.process(&ChannelManager::ZERO, &mut buf); // We don't have a seek function :(
719 ChannelManager::xor_bufs(&mut res[0..(i + 1)*65], &buf[(20 - i)*65..21*65]);
724 let mut packet_data = [0; 20*65];
725 let mut hmac_res = [0; 32];
727 for (i, (payload, keys)) in payloads.iter_mut().zip(onion_keys.iter()).rev().enumerate() {
728 ChannelManager::shift_arr_right(&mut packet_data);
729 payload.hmac = hmac_res;
730 packet_data[0..65].copy_from_slice(&payload.encode()[..]);
732 let mut chacha = ChaCha20::new(&keys.rho, &[0u8; 8]);
733 chacha.process(&packet_data, &mut buf[0..20*65]);
734 packet_data[..].copy_from_slice(&buf[0..20*65]);
737 packet_data[20*65 - filler.len()..20*65].copy_from_slice(&filler[..]);
740 let mut hmac = Hmac::new(Sha256::new(), &keys.mu);
741 hmac.input(&packet_data);
742 hmac.input(&associated_data[..]);
743 hmac.raw_result(&mut hmac_res);
748 public_key: Ok(onion_keys.first().unwrap().ephemeral_pubkey),
749 hop_data: packet_data,
754 /// Encrypts a failure packet. raw_packet can either be a
755 /// msgs::DecodedOnionErrorPacket.encode() result or a msgs::OnionErrorPacket.data element.
756 fn encrypt_failure_packet(shared_secret: &SharedSecret, raw_packet: &[u8]) -> msgs::OnionErrorPacket {
757 let ammag = ChannelManager::gen_ammag_from_shared_secret(&shared_secret);
759 let mut packet_crypted = Vec::with_capacity(raw_packet.len());
760 packet_crypted.resize(raw_packet.len(), 0);
761 let mut chacha = ChaCha20::new(&ammag, &[0u8; 8]);
762 chacha.process(&raw_packet, &mut packet_crypted[..]);
763 msgs::OnionErrorPacket {
764 data: packet_crypted,
768 fn build_failure_packet(shared_secret: &SharedSecret, failure_type: u16, failure_data: &[u8]) -> msgs::DecodedOnionErrorPacket {
769 assert!(failure_data.len() <= 256 - 2);
771 let um = ChannelManager::gen_um_from_shared_secret(&shared_secret);
774 let mut res = Vec::with_capacity(2 + failure_data.len());
775 res.push(((failure_type >> 8) & 0xff) as u8);
776 res.push(((failure_type >> 0) & 0xff) as u8);
777 res.extend_from_slice(&failure_data[..]);
781 let mut res = Vec::with_capacity(256 - 2 - failure_data.len());
782 res.resize(256 - 2 - failure_data.len(), 0);
785 let mut packet = msgs::DecodedOnionErrorPacket {
787 failuremsg: failuremsg,
791 let mut hmac = Hmac::new(Sha256::new(), &um);
792 hmac.input(&packet.encode()[32..]);
793 hmac.raw_result(&mut packet.hmac);
799 fn build_first_hop_failure_packet(shared_secret: &SharedSecret, failure_type: u16, failure_data: &[u8]) -> msgs::OnionErrorPacket {
800 let failure_packet = ChannelManager::build_failure_packet(shared_secret, failure_type, failure_data);
801 ChannelManager::encrypt_failure_packet(shared_secret, &failure_packet.encode()[..])
804 fn decode_update_add_htlc_onion(&self, msg: &msgs::UpdateAddHTLC) -> (PendingHTLCStatus, MutexGuard<ChannelHolder>) {
805 macro_rules! get_onion_hash {
808 let mut sha = Sha256::new();
809 sha.input(&msg.onion_routing_packet.hop_data);
810 let mut onion_hash = [0; 32];
811 sha.result(&mut onion_hash);
817 if let Err(_) = msg.onion_routing_packet.public_key {
818 log_info!(self, "Failed to accept/forward incoming HTLC with invalid ephemeral pubkey");
819 return (PendingHTLCStatus::Fail(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
820 channel_id: msg.channel_id,
821 htlc_id: msg.htlc_id,
822 sha256_of_onion: get_onion_hash!(),
823 failure_code: 0x8000 | 0x4000 | 6,
824 })), self.channel_state.lock().unwrap());
827 let shared_secret = SharedSecret::new(&self.secp_ctx, &msg.onion_routing_packet.public_key.unwrap(), &self.our_network_key);
828 let (rho, mu) = ChannelManager::gen_rho_mu_from_shared_secret(&shared_secret);
830 let mut channel_state = None;
831 macro_rules! return_err {
832 ($msg: expr, $err_code: expr, $data: expr) => {
834 log_info!(self, "Failed to accept/forward incoming HTLC: {}", $msg);
835 if channel_state.is_none() {
836 channel_state = Some(self.channel_state.lock().unwrap());
838 return (PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
839 channel_id: msg.channel_id,
840 htlc_id: msg.htlc_id,
841 reason: ChannelManager::build_first_hop_failure_packet(&shared_secret, $err_code, $data),
842 })), channel_state.unwrap());
847 if msg.onion_routing_packet.version != 0 {
848 //TODO: Spec doesn't indicate if we should only hash hop_data here (and in other
849 //sha256_of_onion error data packets), or the entire onion_routing_packet. Either way,
850 //the hash doesn't really serve any purpuse - in the case of hashing all data, the
851 //receiving node would have to brute force to figure out which version was put in the
852 //packet by the node that send us the message, in the case of hashing the hop_data, the
853 //node knows the HMAC matched, so they already know what is there...
854 return_err!("Unknown onion packet version", 0x8000 | 0x4000 | 4, &get_onion_hash!());
857 let mut hmac = Hmac::new(Sha256::new(), &mu);
858 hmac.input(&msg.onion_routing_packet.hop_data);
859 hmac.input(&msg.payment_hash);
860 if hmac.result() != MacResult::new(&msg.onion_routing_packet.hmac) {
861 return_err!("HMAC Check failed", 0x8000 | 0x4000 | 5, &get_onion_hash!());
864 let mut chacha = ChaCha20::new(&rho, &[0u8; 8]);
865 let next_hop_data = {
866 let mut decoded = [0; 65];
867 chacha.process(&msg.onion_routing_packet.hop_data[0..65], &mut decoded);
868 match msgs::OnionHopData::read(&mut Cursor::new(&decoded[..])) {
870 let error_code = match err {
871 msgs::DecodeError::UnknownVersion => 0x4000 | 1, // unknown realm byte
872 _ => 0x2000 | 2, // Should never happen
874 return_err!("Unable to decode our hop data", error_code, &[0;0]);
880 //TODO: Check that msg.cltv_expiry is within acceptable bounds!
882 let pending_forward_info = if next_hop_data.hmac == [0; 32] {
884 if next_hop_data.data.amt_to_forward != msg.amount_msat {
885 return_err!("Upstream node sent less than we were supposed to receive in payment", 19, &byte_utils::be64_to_array(msg.amount_msat));
887 if next_hop_data.data.outgoing_cltv_value != msg.cltv_expiry {
888 return_err!("Upstream node set CLTV to the wrong value", 18, &byte_utils::be32_to_array(msg.cltv_expiry));
891 // Note that we could obviously respond immediately with an update_fulfill_htlc
892 // message, however that would leak that we are the recipient of this payment, so
893 // instead we stay symmetric with the forwarding case, only responding (after a
894 // delay) once they've send us a commitment_signed!
896 PendingHTLCStatus::Forward(PendingForwardHTLCInfo {
898 payment_hash: msg.payment_hash.clone(),
900 incoming_shared_secret: shared_secret.clone(),
901 amt_to_forward: next_hop_data.data.amt_to_forward,
902 outgoing_cltv_value: next_hop_data.data.outgoing_cltv_value,
905 let mut new_packet_data = [0; 20*65];
906 chacha.process(&msg.onion_routing_packet.hop_data[65..], &mut new_packet_data[0..19*65]);
907 chacha.process(&ChannelManager::ZERO[0..65], &mut new_packet_data[19*65..]);
909 let mut new_pubkey = msg.onion_routing_packet.public_key.unwrap();
911 let blinding_factor = {
912 let mut sha = Sha256::new();
913 sha.input(&new_pubkey.serialize()[..]);
914 sha.input(&shared_secret[..]);
915 let mut res = [0u8; 32];
916 sha.result(&mut res);
917 match SecretKey::from_slice(&self.secp_ctx, &res) {
919 return_err!("Blinding factor is an invalid private key", 0x8000 | 0x4000 | 6, &get_onion_hash!());
925 if let Err(_) = new_pubkey.mul_assign(&self.secp_ctx, &blinding_factor) {
926 return_err!("New blinding factor is an invalid private key", 0x8000 | 0x4000 | 6, &get_onion_hash!());
929 let outgoing_packet = msgs::OnionPacket {
931 public_key: Ok(new_pubkey),
932 hop_data: new_packet_data,
933 hmac: next_hop_data.hmac.clone(),
936 PendingHTLCStatus::Forward(PendingForwardHTLCInfo {
937 onion_packet: Some(outgoing_packet),
938 payment_hash: msg.payment_hash.clone(),
939 short_channel_id: next_hop_data.data.short_channel_id,
940 incoming_shared_secret: shared_secret.clone(),
941 amt_to_forward: next_hop_data.data.amt_to_forward,
942 outgoing_cltv_value: next_hop_data.data.outgoing_cltv_value,
946 channel_state = Some(self.channel_state.lock().unwrap());
947 if let &PendingHTLCStatus::Forward(PendingForwardHTLCInfo { ref onion_packet, ref short_channel_id, ref amt_to_forward, ref outgoing_cltv_value, .. }) = &pending_forward_info {
948 if onion_packet.is_some() { // If short_channel_id is 0 here, we'll reject them in the body here
949 let id_option = channel_state.as_ref().unwrap().short_to_id.get(&short_channel_id).cloned();
950 let forwarding_id = match id_option {
952 return_err!("Don't have available channel for forwarding as requested.", 0x4000 | 10, &[0;0]);
954 Some(id) => id.clone(),
956 if let Some((err, code, chan_update)) = {
957 let chan = channel_state.as_mut().unwrap().by_id.get_mut(&forwarding_id).unwrap();
959 Some(("Forwarding channel is not in a ready state.", 0x1000 | 7, self.get_channel_update(chan).unwrap()))
961 let fee = amt_to_forward.checked_mul(self.fee_proportional_millionths as u64).and_then(|prop_fee| { (prop_fee / 1000000).checked_add(chan.get_our_fee_base_msat(&*self.fee_estimator) as u64) });
962 if fee.is_none() || msg.amount_msat < fee.unwrap() || (msg.amount_msat - fee.unwrap()) < *amt_to_forward {
963 Some(("Prior hop has deviated from specified fees parameters or origin node has obsolete ones", 0x1000 | 12, self.get_channel_update(chan).unwrap()))
965 if (msg.cltv_expiry as u64) < (*outgoing_cltv_value) as u64 + CLTV_EXPIRY_DELTA as u64 {
966 Some(("Forwarding node has tampered with the intended HTLC values or origin node has an obsolete cltv_expiry_delta", 0x1000 | 13, self.get_channel_update(chan).unwrap()))
973 return_err!(err, code, &chan_update.encode_with_len()[..]);
978 (pending_forward_info, channel_state.unwrap())
981 /// only fails if the channel does not yet have an assigned short_id
982 fn get_channel_update(&self, chan: &Channel) -> Result<msgs::ChannelUpdate, HandleError> {
983 let short_channel_id = match chan.get_short_channel_id() {
984 None => return Err(HandleError{err: "Channel not yet established", action: None}),
988 let were_node_one = PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key).serialize()[..] < chan.get_their_node_id().serialize()[..];
990 let unsigned = msgs::UnsignedChannelUpdate {
991 chain_hash: self.genesis_hash,
992 short_channel_id: short_channel_id,
993 timestamp: chan.get_channel_update_count(),
994 flags: (!were_node_one) as u16 | ((!chan.is_live() as u16) << 1),
995 cltv_expiry_delta: CLTV_EXPIRY_DELTA,
996 htlc_minimum_msat: chan.get_our_htlc_minimum_msat(),
997 fee_base_msat: chan.get_our_fee_base_msat(&*self.fee_estimator),
998 fee_proportional_millionths: self.fee_proportional_millionths,
999 excess_data: Vec::new(),
1002 let msg_hash = Sha256dHash::from_data(&unsigned.encode()[..]);
1003 let sig = self.secp_ctx.sign(&Message::from_slice(&msg_hash[..]).unwrap(), &self.our_network_key);
1005 Ok(msgs::ChannelUpdate {
1011 /// Sends a payment along a given route.
1013 /// Value parameters are provided via the last hop in route, see documentation for RouteHop
1014 /// fields for more info.
1016 /// Note that if the payment_hash already exists elsewhere (eg you're sending a duplicative
1017 /// payment), we don't do anything to stop you! We always try to ensure that if the provided
1018 /// next hop knows the preimage to payment_hash they can claim an additional amount as
1019 /// specified in the last hop in the route! Thus, you should probably do your own
1020 /// payment_preimage tracking (which you should already be doing as they represent "proof of
1021 /// payment") and prevent double-sends yourself.
1023 /// May generate a SendHTLCs event on success, which should be relayed.
1025 /// Raises APIError::RoutError when invalid route or forward parameter
1026 /// (cltv_delta, fee, node public key) is specified
1027 pub fn send_payment(&self, route: Route, payment_hash: [u8; 32]) -> Result<(), APIError> {
1028 if route.hops.len() < 1 || route.hops.len() > 20 {
1029 return Err(APIError::RouteError{err: "Route didn't go anywhere/had bogus size"});
1031 let our_node_id = self.get_our_node_id();
1032 for (idx, hop) in route.hops.iter().enumerate() {
1033 if idx != route.hops.len() - 1 && hop.pubkey == our_node_id {
1034 return Err(APIError::RouteError{err: "Route went through us but wasn't a simple rebalance loop to us"});
1038 let session_priv = SecretKey::from_slice(&self.secp_ctx, &{
1039 let mut session_key = [0; 32];
1040 rng::fill_bytes(&mut session_key);
1042 }).expect("RNG is bad!");
1044 let cur_height = self.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1046 let onion_keys = secp_call!(ChannelManager::construct_onion_keys(&self.secp_ctx, &route, &session_priv),
1047 APIError::RouteError{err: "Pubkey along hop was maliciously selected"});
1048 let (onion_payloads, htlc_msat, htlc_cltv) = ChannelManager::build_onion_payloads(&route, cur_height)?;
1049 let onion_packet = ChannelManager::construct_onion_packet(onion_payloads, onion_keys, &payment_hash);
1051 let (first_hop_node_id, (update_add, commitment_signed, chan_monitor)) = {
1052 let mut channel_state_lock = self.channel_state.lock().unwrap();
1053 let channel_state = channel_state_lock.borrow_parts();
1055 let id = match channel_state.short_to_id.get(&route.hops.first().unwrap().short_channel_id) {
1056 None => return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!"}),
1057 Some(id) => id.clone(),
1061 let chan = channel_state.by_id.get_mut(&id).unwrap();
1062 if chan.get_their_node_id() != route.hops.first().unwrap().pubkey {
1063 return Err(APIError::RouteError{err: "Node ID mismatch on first hop!"});
1065 if !chan.is_live() {
1066 return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected!"});
1068 chan.send_htlc_and_commit(htlc_msat, payment_hash.clone(), htlc_cltv, HTLCSource::OutboundRoute {
1069 route: route.clone(),
1070 session_priv: session_priv.clone(),
1071 }, onion_packet).map_err(|he| APIError::ChannelUnavailable{err: he.err})?
1074 let first_hop_node_id = route.hops.first().unwrap().pubkey;
1077 Some(msgs) => (first_hop_node_id, msgs),
1078 None => return Ok(()),
1082 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1086 let mut events = self.pending_events.lock().unwrap();
1087 events.push(events::Event::UpdateHTLCs {
1088 node_id: first_hop_node_id,
1089 updates: msgs::CommitmentUpdate {
1090 update_add_htlcs: vec![update_add],
1091 update_fulfill_htlcs: Vec::new(),
1092 update_fail_htlcs: Vec::new(),
1093 update_fail_malformed_htlcs: Vec::new(),
1101 /// Call this upon creation of a funding transaction for the given channel.
1103 /// Panics if a funding transaction has already been provided for this channel.
1105 /// May panic if the funding_txo is duplicative with some other channel (note that this should
1106 /// be trivially prevented by using unique funding transaction keys per-channel).
1107 pub fn funding_transaction_generated(&self, temporary_channel_id: &[u8; 32], funding_txo: OutPoint) {
1108 macro_rules! add_pending_event {
1111 let mut pending_events = self.pending_events.lock().unwrap();
1112 pending_events.push($event);
1117 let (chan, msg, chan_monitor) = {
1118 let mut channel_state = self.channel_state.lock().unwrap();
1119 match channel_state.by_id.remove(temporary_channel_id) {
1121 match chan.get_outbound_funding_created(funding_txo) {
1122 Ok(funding_msg) => {
1123 (chan, funding_msg.0, funding_msg.1)
1126 log_error!(self, "Got bad signatures: {}!", e.err);
1127 mem::drop(channel_state);
1128 add_pending_event!(events::Event::HandleError {
1129 node_id: chan.get_their_node_id(),
1138 }; // Release channel lock for install_watch_outpoint call,
1139 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1142 add_pending_event!(events::Event::SendFundingCreated {
1143 node_id: chan.get_their_node_id(),
1147 let mut channel_state = self.channel_state.lock().unwrap();
1148 match channel_state.by_id.entry(chan.channel_id()) {
1149 hash_map::Entry::Occupied(_) => {
1150 panic!("Generated duplicate funding txid?");
1152 hash_map::Entry::Vacant(e) => {
1158 fn get_announcement_sigs(&self, chan: &Channel) -> Option<msgs::AnnouncementSignatures> {
1159 if !chan.should_announce() { return None }
1161 let (announcement, our_bitcoin_sig) = match chan.get_channel_announcement(self.get_our_node_id(), self.genesis_hash.clone()) {
1163 Err(_) => return None, // Only in case of state precondition violations eg channel is closing
1165 let msghash = Message::from_slice(&Sha256dHash::from_data(&announcement.encode()[..])[..]).unwrap();
1166 let our_node_sig = self.secp_ctx.sign(&msghash, &self.our_network_key);
1168 Some(msgs::AnnouncementSignatures {
1169 channel_id: chan.channel_id(),
1170 short_channel_id: chan.get_short_channel_id().unwrap(),
1171 node_signature: our_node_sig,
1172 bitcoin_signature: our_bitcoin_sig,
1176 /// Processes HTLCs which are pending waiting on random forward delay.
1178 /// Should only really ever be called in response to an PendingHTLCsForwardable event.
1179 /// Will likely generate further events.
1180 pub fn process_pending_htlc_forwards(&self) {
1181 let mut new_events = Vec::new();
1182 let mut failed_forwards = Vec::new();
1184 let mut channel_state_lock = self.channel_state.lock().unwrap();
1185 let channel_state = channel_state_lock.borrow_parts();
1187 if cfg!(not(feature = "fuzztarget")) && Instant::now() < *channel_state.next_forward {
1191 for (short_chan_id, mut pending_forwards) in channel_state.forward_htlcs.drain() {
1192 if short_chan_id != 0 {
1193 let forward_chan_id = match channel_state.short_to_id.get(&short_chan_id) {
1194 Some(chan_id) => chan_id.clone(),
1196 failed_forwards.reserve(pending_forwards.len());
1197 for HTLCForwardInfo { prev_short_channel_id, prev_htlc_id, forward_info } in pending_forwards.drain(..) {
1198 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
1199 short_channel_id: prev_short_channel_id,
1200 htlc_id: prev_htlc_id,
1201 incoming_packet_shared_secret: forward_info.incoming_shared_secret,
1203 failed_forwards.push((htlc_source, forward_info.payment_hash, 0x4000 | 10, None));
1208 let forward_chan = &mut channel_state.by_id.get_mut(&forward_chan_id).unwrap();
1210 let mut add_htlc_msgs = Vec::new();
1211 for HTLCForwardInfo { prev_short_channel_id, prev_htlc_id, forward_info } in pending_forwards.drain(..) {
1212 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
1213 short_channel_id: prev_short_channel_id,
1214 htlc_id: prev_htlc_id,
1215 incoming_packet_shared_secret: forward_info.incoming_shared_secret,
1217 match forward_chan.send_htlc(forward_info.amt_to_forward, forward_info.payment_hash, forward_info.outgoing_cltv_value, htlc_source.clone(), forward_info.onion_packet.unwrap()) {
1219 let chan_update = self.get_channel_update(forward_chan).unwrap();
1220 failed_forwards.push((htlc_source, forward_info.payment_hash, 0x1000 | 7, Some(chan_update)));
1225 Some(msg) => { add_htlc_msgs.push(msg); },
1227 // Nothing to do here...we're waiting on a remote
1228 // revoke_and_ack before we can add anymore HTLCs. The Channel
1229 // will automatically handle building the update_add_htlc and
1230 // commitment_signed messages when we can.
1231 // TODO: Do some kind of timer to set the channel as !is_live()
1232 // as we don't really want others relying on us relaying through
1233 // this channel currently :/.
1240 if !add_htlc_msgs.is_empty() {
1241 let (commitment_msg, monitor) = match forward_chan.send_commitment() {
1244 if let &Some(msgs::ErrorAction::DisconnectPeer{msg: Some(ref _err_msg)}) = &e.action {
1245 } else if let &Some(msgs::ErrorAction::SendErrorMessage{msg: ref _err_msg}) = &e.action {
1247 panic!("Stated return value requirements in send_commitment() were not met");
1249 //TODO: Handle...this is bad!
1253 new_events.push((Some(monitor), events::Event::UpdateHTLCs {
1254 node_id: forward_chan.get_their_node_id(),
1255 updates: msgs::CommitmentUpdate {
1256 update_add_htlcs: add_htlc_msgs,
1257 update_fulfill_htlcs: Vec::new(),
1258 update_fail_htlcs: Vec::new(),
1259 update_fail_malformed_htlcs: Vec::new(),
1261 commitment_signed: commitment_msg,
1266 for HTLCForwardInfo { prev_short_channel_id, prev_htlc_id, forward_info } in pending_forwards.drain(..) {
1267 let prev_hop_data = HTLCPreviousHopData {
1268 short_channel_id: prev_short_channel_id,
1269 htlc_id: prev_htlc_id,
1270 incoming_packet_shared_secret: forward_info.incoming_shared_secret,
1272 match channel_state.claimable_htlcs.entry(forward_info.payment_hash) {
1273 hash_map::Entry::Occupied(mut entry) => entry.get_mut().push(prev_hop_data),
1274 hash_map::Entry::Vacant(entry) => { entry.insert(vec![prev_hop_data]); },
1276 new_events.push((None, events::Event::PaymentReceived {
1277 payment_hash: forward_info.payment_hash,
1278 amt: forward_info.amt_to_forward,
1285 for (htlc_source, payment_hash, failure_code, update) in failed_forwards.drain(..) {
1287 None => self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source, &payment_hash, HTLCFailReason::Reason { failure_code, data: Vec::new() }),
1288 Some(chan_update) => self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source, &payment_hash, HTLCFailReason::Reason { failure_code, data: chan_update.encode_with_len() }),
1292 if new_events.is_empty() { return }
1294 new_events.retain(|event| {
1295 if let &Some(ref monitor) = &event.0 {
1296 if let Err(_e) = self.monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor.clone()) {
1297 unimplemented!();// but def dont push the event...
1303 let mut events = self.pending_events.lock().unwrap();
1304 events.reserve(new_events.len());
1305 for event in new_events.drain(..) {
1306 events.push(event.1);
1310 /// Indicates that the preimage for payment_hash is unknown after a PaymentReceived event.
1311 pub fn fail_htlc_backwards(&self, payment_hash: &[u8; 32]) -> bool {
1312 let mut channel_state = Some(self.channel_state.lock().unwrap());
1313 let removed_source = channel_state.as_mut().unwrap().claimable_htlcs.remove(payment_hash);
1314 if let Some(mut sources) = removed_source {
1315 for htlc_with_hash in sources.drain(..) {
1316 if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
1317 self.fail_htlc_backwards_internal(channel_state.take().unwrap(), HTLCSource::PreviousHopData(htlc_with_hash), payment_hash, HTLCFailReason::Reason { failure_code: 0x4000 | 15, data: Vec::new() });
1323 /// Fails an HTLC backwards to the sender of it to us.
1324 /// Note that while we take a channel_state lock as input, we do *not* assume consistency here.
1325 /// There are several callsites that do stupid things like loop over a list of payment_hashes
1326 /// to fail and take the channel_state lock for each iteration (as we take ownership and may
1327 /// drop it). In other words, no assumptions are made that entries in claimable_htlcs point to
1328 /// still-available channels.
1329 fn fail_htlc_backwards_internal(&self, mut channel_state: MutexGuard<ChannelHolder>, source: HTLCSource, payment_hash: &[u8; 32], onion_error: HTLCFailReason) {
1331 HTLCSource::OutboundRoute { .. } => {
1332 mem::drop(channel_state);
1334 let mut pending_events = self.pending_events.lock().unwrap();
1335 pending_events.push(events::Event::PaymentFailed {
1336 payment_hash: payment_hash.clone()
1339 HTLCSource::PreviousHopData(HTLCPreviousHopData { short_channel_id, htlc_id, incoming_packet_shared_secret }) => {
1340 let err_packet = match onion_error {
1341 HTLCFailReason::Reason { failure_code, data } => {
1342 let packet = ChannelManager::build_failure_packet(&incoming_packet_shared_secret, failure_code, &data[..]).encode();
1343 ChannelManager::encrypt_failure_packet(&incoming_packet_shared_secret, &packet)
1345 HTLCFailReason::ErrorPacket { err } => {
1346 ChannelManager::encrypt_failure_packet(&incoming_packet_shared_secret, &err.data)
1350 let (node_id, fail_msgs) = {
1351 let chan_id = match channel_state.short_to_id.get(&short_channel_id) {
1352 Some(chan_id) => chan_id.clone(),
1356 let chan = channel_state.by_id.get_mut(&chan_id).unwrap();
1357 match chan.get_update_fail_htlc_and_commit(htlc_id, err_packet) {
1358 Ok(msg) => (chan.get_their_node_id(), msg),
1360 //TODO: Do something with e?
1367 Some((msg, commitment_msg, chan_monitor)) => {
1368 mem::drop(channel_state);
1370 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1371 unimplemented!();// but def dont push the event...
1374 let mut pending_events = self.pending_events.lock().unwrap();
1375 pending_events.push(events::Event::UpdateHTLCs {
1377 updates: msgs::CommitmentUpdate {
1378 update_add_htlcs: Vec::new(),
1379 update_fulfill_htlcs: Vec::new(),
1380 update_fail_htlcs: vec![msg],
1381 update_fail_malformed_htlcs: Vec::new(),
1383 commitment_signed: commitment_msg,
1393 /// Provides a payment preimage in response to a PaymentReceived event, returning true and
1394 /// generating message events for the net layer to claim the payment, if possible. Thus, you
1395 /// should probably kick the net layer to go send messages if this returns true!
1397 /// May panic if called except in response to a PaymentReceived event.
1398 pub fn claim_funds(&self, payment_preimage: [u8; 32]) -> bool {
1399 let mut sha = Sha256::new();
1400 sha.input(&payment_preimage);
1401 let mut payment_hash = [0; 32];
1402 sha.result(&mut payment_hash);
1404 let mut channel_state = Some(self.channel_state.lock().unwrap());
1405 let removed_source = channel_state.as_mut().unwrap().claimable_htlcs.remove(&payment_hash);
1406 if let Some(mut sources) = removed_source {
1407 for htlc_with_hash in sources.drain(..) {
1408 if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
1409 self.claim_funds_internal(channel_state.take().unwrap(), HTLCSource::PreviousHopData(htlc_with_hash), payment_preimage);
1414 fn claim_funds_internal(&self, mut channel_state: MutexGuard<ChannelHolder>, source: HTLCSource, payment_preimage: [u8; 32]) {
1416 HTLCSource::OutboundRoute { .. } => {
1417 mem::drop(channel_state);
1418 let mut pending_events = self.pending_events.lock().unwrap();
1419 pending_events.push(events::Event::PaymentSent {
1423 HTLCSource::PreviousHopData(HTLCPreviousHopData { short_channel_id, htlc_id, .. }) => {
1424 //TODO: Delay the claimed_funds relaying just like we do outbound relay!
1425 let (node_id, fulfill_msgs) = {
1426 let chan_id = match channel_state.short_to_id.get(&short_channel_id) {
1427 Some(chan_id) => chan_id.clone(),
1429 // TODO: There is probably a channel manager somewhere that needs to
1430 // learn the preimage as the channel already hit the chain and that's
1436 let chan = channel_state.by_id.get_mut(&chan_id).unwrap();
1437 match chan.get_update_fulfill_htlc_and_commit(htlc_id, payment_preimage) {
1438 Ok(msg) => (chan.get_their_node_id(), msg),
1440 // TODO: There is probably a channel manager somewhere that needs to
1441 // learn the preimage as the channel may be about to hit the chain.
1442 //TODO: Do something with e?
1448 mem::drop(channel_state);
1449 if let Some(chan_monitor) = fulfill_msgs.1 {
1450 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1451 unimplemented!();// but def dont push the event...
1455 if let Some((msg, commitment_msg)) = fulfill_msgs.0 {
1456 let mut pending_events = self.pending_events.lock().unwrap();
1457 pending_events.push(events::Event::UpdateHTLCs {
1459 updates: msgs::CommitmentUpdate {
1460 update_add_htlcs: Vec::new(),
1461 update_fulfill_htlcs: vec![msg],
1462 update_fail_htlcs: Vec::new(),
1463 update_fail_malformed_htlcs: Vec::new(),
1465 commitment_signed: commitment_msg,
1473 /// Gets the node_id held by this ChannelManager
1474 pub fn get_our_node_id(&self) -> PublicKey {
1475 PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key)
1478 /// Used to restore channels to normal operation after a
1479 /// ChannelMonitorUpdateErr::TemporaryFailure was returned from a channel monitor update
1481 pub fn test_restore_channel_monitor(&self) {
1485 fn internal_open_channel(&self, their_node_id: &PublicKey, msg: &msgs::OpenChannel) -> Result<msgs::AcceptChannel, MsgHandleErrInternal> {
1486 if msg.chain_hash != self.genesis_hash {
1487 return Err(MsgHandleErrInternal::send_err_msg_no_close("Unknown genesis block hash", msg.temporary_channel_id.clone()));
1489 let mut channel_state = self.channel_state.lock().unwrap();
1490 if channel_state.by_id.contains_key(&msg.temporary_channel_id) {
1491 return Err(MsgHandleErrInternal::send_err_msg_no_close("temporary_channel_id collision!", msg.temporary_channel_id.clone()));
1494 let chan_keys = if cfg!(feature = "fuzztarget") {
1496 funding_key: SecretKey::from_slice(&self.secp_ctx, &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0]).unwrap(),
1497 revocation_base_key: SecretKey::from_slice(&self.secp_ctx, &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 2, 0]).unwrap(),
1498 payment_base_key: SecretKey::from_slice(&self.secp_ctx, &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 0]).unwrap(),
1499 delayed_payment_base_key: SecretKey::from_slice(&self.secp_ctx, &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 0]).unwrap(),
1500 htlc_base_key: SecretKey::from_slice(&self.secp_ctx, &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 5, 0]).unwrap(),
1501 channel_close_key: SecretKey::from_slice(&self.secp_ctx, &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 6, 0]).unwrap(),
1502 channel_monitor_claim_key: SecretKey::from_slice(&self.secp_ctx, &[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 7, 0]).unwrap(),
1503 commitment_seed: [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
1506 let mut key_seed = [0u8; 32];
1507 rng::fill_bytes(&mut key_seed);
1508 match ChannelKeys::new_from_seed(&key_seed) {
1510 Err(_) => panic!("RNG is busted!")
1514 let channel = Channel::new_from_req(&*self.fee_estimator, chan_keys, their_node_id.clone(), msg, 0, false, self.announce_channels_publicly, Arc::clone(&self.logger))
1515 .map_err(|e| MsgHandleErrInternal::from_chan_no_close(e, msg.temporary_channel_id))?;
1516 let accept_msg = channel.get_accept_channel();
1517 channel_state.by_id.insert(channel.channel_id(), channel);
1521 fn internal_accept_channel(&self, their_node_id: &PublicKey, msg: &msgs::AcceptChannel) -> Result<(), MsgHandleErrInternal> {
1522 let (value, output_script, user_id) = {
1523 let mut channel_state = self.channel_state.lock().unwrap();
1524 match channel_state.by_id.get_mut(&msg.temporary_channel_id) {
1526 if chan.get_their_node_id() != *their_node_id {
1527 //TODO: see issue #153, need a consistent behavior on obnoxious behavior from random node
1528 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.temporary_channel_id));
1530 chan.accept_channel(&msg)
1531 .map_err(|e| MsgHandleErrInternal::from_chan_maybe_close(e, msg.temporary_channel_id))?;
1532 (chan.get_value_satoshis(), chan.get_funding_redeemscript().to_v0_p2wsh(), chan.get_user_id())
1534 //TODO: same as above
1535 None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.temporary_channel_id))
1538 let mut pending_events = self.pending_events.lock().unwrap();
1539 pending_events.push(events::Event::FundingGenerationReady {
1540 temporary_channel_id: msg.temporary_channel_id,
1541 channel_value_satoshis: value,
1542 output_script: output_script,
1543 user_channel_id: user_id,
1548 fn internal_funding_created(&self, their_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<msgs::FundingSigned, MsgHandleErrInternal> {
1549 let (chan, funding_msg, monitor_update) = {
1550 let mut channel_state = self.channel_state.lock().unwrap();
1551 match channel_state.by_id.entry(msg.temporary_channel_id.clone()) {
1552 hash_map::Entry::Occupied(mut chan) => {
1553 if chan.get().get_their_node_id() != *their_node_id {
1554 //TODO: here and below MsgHandleErrInternal, #153 case
1555 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.temporary_channel_id));
1557 match chan.get_mut().funding_created(msg) {
1558 Ok((funding_msg, monitor_update)) => {
1559 (chan.remove(), funding_msg, monitor_update)
1562 return Err(e).map_err(|e| MsgHandleErrInternal::from_maybe_close(e))
1566 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.temporary_channel_id))
1568 }; // Release channel lock for install_watch_outpoint call,
1569 // note that this means if the remote end is misbehaving and sends a message for the same
1570 // channel back-to-back with funding_created, we'll end up thinking they sent a message
1571 // for a bogus channel.
1572 if let Err(_e) = self.monitor.add_update_monitor(monitor_update.get_funding_txo().unwrap(), monitor_update) {
1575 let mut channel_state = self.channel_state.lock().unwrap();
1576 match channel_state.by_id.entry(funding_msg.channel_id) {
1577 hash_map::Entry::Occupied(_) => {
1578 return Err(MsgHandleErrInternal::send_err_msg_no_close("Already had channel with the new channel_id", funding_msg.channel_id))
1580 hash_map::Entry::Vacant(e) => {
1587 fn internal_funding_signed(&self, their_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), MsgHandleErrInternal> {
1588 let (funding_txo, user_id, monitor) = {
1589 let mut channel_state = self.channel_state.lock().unwrap();
1590 match channel_state.by_id.get_mut(&msg.channel_id) {
1592 if chan.get_their_node_id() != *their_node_id {
1593 //TODO: here and below MsgHandleErrInternal, #153 case
1594 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1596 let chan_monitor = chan.funding_signed(&msg).map_err(|e| MsgHandleErrInternal::from_maybe_close(e))?;
1597 (chan.get_funding_txo().unwrap(), chan.get_user_id(), chan_monitor)
1599 None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
1602 if let Err(_e) = self.monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor) {
1605 let mut pending_events = self.pending_events.lock().unwrap();
1606 pending_events.push(events::Event::FundingBroadcastSafe {
1607 funding_txo: funding_txo,
1608 user_channel_id: user_id,
1613 fn internal_funding_locked(&self, their_node_id: &PublicKey, msg: &msgs::FundingLocked) -> Result<Option<msgs::AnnouncementSignatures>, MsgHandleErrInternal> {
1614 let mut channel_state = self.channel_state.lock().unwrap();
1615 match channel_state.by_id.get_mut(&msg.channel_id) {
1617 if chan.get_their_node_id() != *their_node_id {
1618 //TODO: here and below MsgHandleErrInternal, #153 case
1619 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1621 chan.funding_locked(&msg)
1622 .map_err(|e| MsgHandleErrInternal::from_chan_maybe_close(e, msg.channel_id))?;
1623 return Ok(self.get_announcement_sigs(chan));
1625 None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
1629 fn internal_shutdown(&self, their_node_id: &PublicKey, msg: &msgs::Shutdown) -> Result<(Option<msgs::Shutdown>, Option<msgs::ClosingSigned>), MsgHandleErrInternal> {
1630 let (mut res, chan_option) = {
1631 let mut channel_state_lock = self.channel_state.lock().unwrap();
1632 let channel_state = channel_state_lock.borrow_parts();
1634 match channel_state.by_id.entry(msg.channel_id.clone()) {
1635 hash_map::Entry::Occupied(mut chan_entry) => {
1636 if chan_entry.get().get_their_node_id() != *their_node_id {
1637 //TODO: here and below MsgHandleErrInternal, #153 case
1638 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1640 let res = chan_entry.get_mut().shutdown(&*self.fee_estimator, &msg).map_err(|e| MsgHandleErrInternal::from_maybe_close(e))?;
1641 if chan_entry.get().is_shutdown() {
1642 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
1643 channel_state.short_to_id.remove(&short_id);
1645 (res, Some(chan_entry.remove_entry().1))
1646 } else { (res, None) }
1648 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
1651 for htlc_source in res.2.drain(..) {
1652 // unknown_next_peer...I dunno who that is anymore....
1653 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source.0, &htlc_source.1, HTLCFailReason::Reason { failure_code: 0x4000 | 10, data: Vec::new() });
1655 if let Some(chan) = chan_option {
1656 if let Ok(update) = self.get_channel_update(&chan) {
1657 let mut events = self.pending_events.lock().unwrap();
1658 events.push(events::Event::BroadcastChannelUpdate {
1666 fn internal_closing_signed(&self, their_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<Option<msgs::ClosingSigned>, MsgHandleErrInternal> {
1667 let (res, chan_option) = {
1668 let mut channel_state_lock = self.channel_state.lock().unwrap();
1669 let channel_state = channel_state_lock.borrow_parts();
1670 match channel_state.by_id.entry(msg.channel_id.clone()) {
1671 hash_map::Entry::Occupied(mut chan_entry) => {
1672 if chan_entry.get().get_their_node_id() != *their_node_id {
1673 //TODO: here and below MsgHandleErrInternal, #153 case
1674 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1676 let res = chan_entry.get_mut().closing_signed(&*self.fee_estimator, &msg).map_err(|e| MsgHandleErrInternal::from_maybe_close(e))?;
1677 if res.1.is_some() {
1678 // We're done with this channel, we've got a signed closing transaction and
1679 // will send the closing_signed back to the remote peer upon return. This
1680 // also implies there are no pending HTLCs left on the channel, so we can
1681 // fully delete it from tracking (the channel monitor is still around to
1682 // watch for old state broadcasts)!
1683 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
1684 channel_state.short_to_id.remove(&short_id);
1686 (res, Some(chan_entry.remove_entry().1))
1687 } else { (res, None) }
1689 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
1692 if let Some(broadcast_tx) = res.1 {
1693 self.tx_broadcaster.broadcast_transaction(&broadcast_tx);
1695 if let Some(chan) = chan_option {
1696 if let Ok(update) = self.get_channel_update(&chan) {
1697 let mut events = self.pending_events.lock().unwrap();
1698 events.push(events::Event::BroadcastChannelUpdate {
1706 fn internal_update_add_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), MsgHandleErrInternal> {
1707 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
1708 //determine the state of the payment based on our response/if we forward anything/the time
1709 //we take to respond. We should take care to avoid allowing such an attack.
1711 //TODO: There exists a further attack where a node may garble the onion data, forward it to
1712 //us repeatedly garbled in different ways, and compare our error messages, which are
1713 //encrypted with the same key. Its not immediately obvious how to usefully exploit that,
1714 //but we should prevent it anyway.
1716 let (pending_forward_info, mut channel_state_lock) = self.decode_update_add_htlc_onion(msg);
1717 let channel_state = channel_state_lock.borrow_parts();
1719 match channel_state.by_id.get_mut(&msg.channel_id) {
1721 if chan.get_their_node_id() != *their_node_id {
1722 //TODO: here MsgHandleErrInternal, #153 case
1723 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1725 if !chan.is_usable() {
1726 return Err(MsgHandleErrInternal::from_no_close(HandleError{err: "Channel not yet available for receiving HTLCs", action: Some(msgs::ErrorAction::IgnoreError)}));
1728 chan.update_add_htlc(&msg, pending_forward_info).map_err(|e| MsgHandleErrInternal::from_maybe_close(e))
1730 None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
1734 fn internal_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), MsgHandleErrInternal> {
1735 let mut channel_state = self.channel_state.lock().unwrap();
1736 let htlc_source = match channel_state.by_id.get_mut(&msg.channel_id) {
1738 if chan.get_their_node_id() != *their_node_id {
1739 //TODO: here and below MsgHandleErrInternal, #153 case
1740 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1742 chan.update_fulfill_htlc(&msg)
1743 .map_err(|e| MsgHandleErrInternal::from_chan_maybe_close(e, msg.channel_id))?.clone()
1745 None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
1747 self.claim_funds_internal(channel_state, htlc_source, msg.payment_preimage.clone());
1751 fn internal_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<Option<msgs::HTLCFailChannelUpdate>, MsgHandleErrInternal> {
1752 let mut channel_state = self.channel_state.lock().unwrap();
1753 let htlc_source = match channel_state.by_id.get_mut(&msg.channel_id) {
1755 if chan.get_their_node_id() != *their_node_id {
1756 //TODO: here and below MsgHandleErrInternal, #153 case
1757 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1759 chan.update_fail_htlc(&msg, HTLCFailReason::ErrorPacket { err: msg.reason.clone() })
1760 .map_err(|e| MsgHandleErrInternal::from_chan_maybe_close(e, msg.channel_id))
1762 None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
1766 &HTLCSource::OutboundRoute { ref route, ref session_priv, .. } => {
1767 // Handle packed channel/node updates for passing back for the route handler
1768 let mut packet_decrypted = msg.reason.data.clone();
1770 Self::construct_onion_keys_callback(&self.secp_ctx, &route, &session_priv, |shared_secret, _, _, route_hop| {
1771 if res.is_some() { return; }
1773 let ammag = ChannelManager::gen_ammag_from_shared_secret(&shared_secret);
1775 let mut decryption_tmp = Vec::with_capacity(packet_decrypted.len());
1776 decryption_tmp.resize(packet_decrypted.len(), 0);
1777 let mut chacha = ChaCha20::new(&ammag, &[0u8; 8]);
1778 chacha.process(&packet_decrypted, &mut decryption_tmp[..]);
1779 packet_decrypted = decryption_tmp;
1781 if let Ok(err_packet) = msgs::DecodedOnionErrorPacket::read(&mut Cursor::new(&packet_decrypted)) {
1782 if err_packet.failuremsg.len() >= 2 {
1783 let um = ChannelManager::gen_um_from_shared_secret(&shared_secret);
1785 let mut hmac = Hmac::new(Sha256::new(), &um);
1786 hmac.input(&err_packet.encode()[32..]);
1787 let mut calc_tag = [0u8; 32];
1788 hmac.raw_result(&mut calc_tag);
1789 if crypto::util::fixed_time_eq(&calc_tag, &err_packet.hmac) {
1790 const UNKNOWN_CHAN: u16 = 0x4000|10;
1791 const TEMP_CHAN_FAILURE: u16 = 0x4000|7;
1792 match byte_utils::slice_to_be16(&err_packet.failuremsg[0..2]) {
1793 TEMP_CHAN_FAILURE => {
1794 if err_packet.failuremsg.len() >= 4 {
1795 let update_len = byte_utils::slice_to_be16(&err_packet.failuremsg[2..4]) as usize;
1796 if err_packet.failuremsg.len() >= 4 + update_len {
1797 if let Ok(chan_update) = msgs::ChannelUpdate::read(&mut Cursor::new(&err_packet.failuremsg[4..4 + update_len])) {
1798 res = Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage {
1806 // No such next-hop. We know this came from the
1807 // current node as the HMAC validated.
1808 res = Some(msgs::HTLCFailChannelUpdate::ChannelClosed {
1809 short_channel_id: route_hop.short_channel_id
1812 _ => {}, //TODO: Enumerate all of these!
1824 fn internal_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), MsgHandleErrInternal> {
1825 let mut channel_state = self.channel_state.lock().unwrap();
1826 match channel_state.by_id.get_mut(&msg.channel_id) {
1828 if chan.get_their_node_id() != *their_node_id {
1829 //TODO: here and below MsgHandleErrInternal, #153 case
1830 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1832 if (msg.failure_code & 0x8000) != 0 {
1833 return Err(MsgHandleErrInternal::send_err_msg_close_chan("Got update_fail_malformed_htlc with BADONION set", msg.channel_id));
1835 chan.update_fail_malformed_htlc(&msg, HTLCFailReason::Reason { failure_code: msg.failure_code, data: Vec::new() })
1836 .map_err(|e| MsgHandleErrInternal::from_chan_maybe_close(e, msg.channel_id))?;
1839 None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
1843 fn internal_commitment_signed(&self, their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(msgs::RevokeAndACK, Option<msgs::CommitmentSigned>), MsgHandleErrInternal> {
1844 let (revoke_and_ack, commitment_signed, chan_monitor) = {
1845 let mut channel_state = self.channel_state.lock().unwrap();
1846 match channel_state.by_id.get_mut(&msg.channel_id) {
1848 if chan.get_their_node_id() != *their_node_id {
1849 //TODO: here and below MsgHandleErrInternal, #153 case
1850 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1852 chan.commitment_signed(&msg).map_err(|e| MsgHandleErrInternal::from_maybe_close(e))?
1854 None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
1857 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1861 Ok((revoke_and_ack, commitment_signed))
1864 fn internal_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<Option<msgs::CommitmentUpdate>, MsgHandleErrInternal> {
1865 let ((res, mut pending_forwards, mut pending_failures, chan_monitor), short_channel_id) = {
1866 let mut channel_state = self.channel_state.lock().unwrap();
1867 match channel_state.by_id.get_mut(&msg.channel_id) {
1869 if chan.get_their_node_id() != *their_node_id {
1870 //TODO: here and below MsgHandleErrInternal, #153 case
1871 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1873 (chan.revoke_and_ack(&msg).map_err(|e| MsgHandleErrInternal::from_maybe_close(e))?, chan.get_short_channel_id().expect("RAA should only work on a short-id-available channel"))
1875 None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
1878 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1881 for failure in pending_failures.drain(..) {
1882 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), failure.0, &failure.1, failure.2);
1885 let mut forward_event = None;
1886 if !pending_forwards.is_empty() {
1887 let mut channel_state = self.channel_state.lock().unwrap();
1888 if channel_state.forward_htlcs.is_empty() {
1889 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));
1890 channel_state.next_forward = forward_event.unwrap();
1892 for (forward_info, prev_htlc_id) in pending_forwards.drain(..) {
1893 match channel_state.forward_htlcs.entry(forward_info.short_channel_id) {
1894 hash_map::Entry::Occupied(mut entry) => {
1895 entry.get_mut().push(HTLCForwardInfo { prev_short_channel_id: short_channel_id, prev_htlc_id, forward_info });
1897 hash_map::Entry::Vacant(entry) => {
1898 entry.insert(vec!(HTLCForwardInfo { prev_short_channel_id: short_channel_id, prev_htlc_id, forward_info }));
1903 match forward_event {
1905 let mut pending_events = self.pending_events.lock().unwrap();
1906 pending_events.push(events::Event::PendingHTLCsForwardable {
1907 time_forwardable: time
1916 fn internal_update_fee(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), MsgHandleErrInternal> {
1917 let mut channel_state = self.channel_state.lock().unwrap();
1918 match channel_state.by_id.get_mut(&msg.channel_id) {
1920 if chan.get_their_node_id() != *their_node_id {
1921 //TODO: here and below MsgHandleErrInternal, #153 case
1922 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1924 chan.update_fee(&*self.fee_estimator, &msg).map_err(|e| MsgHandleErrInternal::from_chan_maybe_close(e, msg.channel_id))
1926 None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
1930 fn internal_announcement_signatures(&self, their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), MsgHandleErrInternal> {
1931 let (chan_announcement, chan_update) = {
1932 let mut channel_state = self.channel_state.lock().unwrap();
1933 match channel_state.by_id.get_mut(&msg.channel_id) {
1935 if chan.get_their_node_id() != *their_node_id {
1936 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1938 if !chan.is_usable() {
1939 return Err(MsgHandleErrInternal::from_no_close(HandleError{err: "Got an announcement_signatures before we were ready for it", action: Some(msgs::ErrorAction::IgnoreError)}));
1942 let our_node_id = self.get_our_node_id();
1943 let (announcement, our_bitcoin_sig) = chan.get_channel_announcement(our_node_id.clone(), self.genesis_hash.clone())
1944 .map_err(|e| MsgHandleErrInternal::from_chan_maybe_close(e, msg.channel_id))?;
1946 let were_node_one = announcement.node_id_1 == our_node_id;
1947 let msghash = Message::from_slice(&Sha256dHash::from_data(&announcement.encode()[..])[..]).unwrap();
1948 let bad_sig_action = MsgHandleErrInternal::send_err_msg_close_chan("Bad announcement_signatures node_signature", msg.channel_id);
1949 secp_call!(self.secp_ctx.verify(&msghash, &msg.node_signature, if were_node_one { &announcement.node_id_2 } else { &announcement.node_id_1 }), bad_sig_action);
1950 secp_call!(self.secp_ctx.verify(&msghash, &msg.bitcoin_signature, if were_node_one { &announcement.bitcoin_key_2 } else { &announcement.bitcoin_key_1 }), bad_sig_action);
1952 let our_node_sig = self.secp_ctx.sign(&msghash, &self.our_network_key);
1954 (msgs::ChannelAnnouncement {
1955 node_signature_1: if were_node_one { our_node_sig } else { msg.node_signature },
1956 node_signature_2: if were_node_one { msg.node_signature } else { our_node_sig },
1957 bitcoin_signature_1: if were_node_one { our_bitcoin_sig } else { msg.bitcoin_signature },
1958 bitcoin_signature_2: if were_node_one { msg.bitcoin_signature } else { our_bitcoin_sig },
1959 contents: announcement,
1960 }, self.get_channel_update(chan).unwrap()) // can only fail if we're not in a ready state
1962 None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
1965 let mut pending_events = self.pending_events.lock().unwrap();
1966 pending_events.push(events::Event::BroadcastChannelAnnouncement { msg: chan_announcement, update_msg: chan_update });
1970 fn internal_channel_reestablish(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<(Option<msgs::FundingLocked>, Option<msgs::RevokeAndACK>, Option<msgs::CommitmentUpdate>), MsgHandleErrInternal> {
1971 let (res, chan_monitor) = {
1972 let mut channel_state = self.channel_state.lock().unwrap();
1973 match channel_state.by_id.get_mut(&msg.channel_id) {
1975 if chan.get_their_node_id() != *their_node_id {
1976 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1978 let (funding_locked, revoke_and_ack, commitment_update, channel_monitor) = chan.channel_reestablish(msg)
1979 .map_err(|e| MsgHandleErrInternal::from_chan_maybe_close(e, msg.channel_id))?;
1980 (Ok((funding_locked, revoke_and_ack, commitment_update)), channel_monitor)
1982 None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
1985 if let Some(monitor) = chan_monitor {
1986 if let Err(_e) = self.monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor) {
1993 /// Begin Update fee process. Allowed only on an outbound channel.
1994 /// If successful, will generate a UpdateHTLCs event, so you should probably poll
1995 /// PeerManager::process_events afterwards.
1996 /// Note: This API is likely to change!
1998 pub fn update_fee(&self, channel_id: [u8;32], feerate_per_kw: u64) -> Result<(), APIError> {
1999 let mut channel_state = self.channel_state.lock().unwrap();
2000 match channel_state.by_id.get_mut(&channel_id) {
2001 None => return Err(APIError::APIMisuseError{err: "Failed to find corresponding channel"}),
2003 if !chan.is_outbound() {
2004 return Err(APIError::APIMisuseError{err: "update_fee cannot be sent for an inbound channel"});
2006 if !chan.is_live() {
2007 return Err(APIError::ChannelUnavailable{err: "Channel is either not yet fully established or peer is currently disconnected"});
2009 if let Some((update_fee, commitment_signed, chan_monitor)) = chan.send_update_fee_and_commit(feerate_per_kw).map_err(|e| APIError::APIMisuseError{err: e.err})? {
2010 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
2013 let mut pending_events = self.pending_events.lock().unwrap();
2014 pending_events.push(events::Event::UpdateHTLCs {
2015 node_id: chan.get_their_node_id(),
2016 updates: msgs::CommitmentUpdate {
2017 update_add_htlcs: Vec::new(),
2018 update_fulfill_htlcs: Vec::new(),
2019 update_fail_htlcs: Vec::new(),
2020 update_fail_malformed_htlcs: Vec::new(),
2021 update_fee: Some(update_fee),
2032 impl events::EventsProvider for ChannelManager {
2033 fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
2034 let mut pending_events = self.pending_events.lock().unwrap();
2035 let mut ret = Vec::new();
2036 mem::swap(&mut ret, &mut *pending_events);
2041 impl ChainListener for ChannelManager {
2042 fn block_connected(&self, header: &BlockHeader, height: u32, txn_matched: &[&Transaction], indexes_of_txn_matched: &[u32]) {
2043 let mut new_events = Vec::new();
2044 let mut failed_channels = Vec::new();
2046 let mut channel_lock = self.channel_state.lock().unwrap();
2047 let channel_state = channel_lock.borrow_parts();
2048 let short_to_id = channel_state.short_to_id;
2049 channel_state.by_id.retain(|_, channel| {
2050 let chan_res = channel.block_connected(header, height, txn_matched, indexes_of_txn_matched);
2051 if let Ok(Some(funding_locked)) = chan_res {
2052 let announcement_sigs = self.get_announcement_sigs(channel);
2053 new_events.push(events::Event::SendFundingLocked {
2054 node_id: channel.get_their_node_id(),
2055 msg: funding_locked,
2056 announcement_sigs: announcement_sigs
2058 short_to_id.insert(channel.get_short_channel_id().unwrap(), channel.channel_id());
2059 } else if let Err(e) = chan_res {
2060 new_events.push(events::Event::HandleError {
2061 node_id: channel.get_their_node_id(),
2064 if channel.is_shutdown() {
2068 if let Some(funding_txo) = channel.get_funding_txo() {
2069 for tx in txn_matched {
2070 for inp in tx.input.iter() {
2071 if inp.previous_output == funding_txo.into_bitcoin_outpoint() {
2072 if let Some(short_id) = channel.get_short_channel_id() {
2073 short_to_id.remove(&short_id);
2075 // It looks like our counterparty went on-chain. We go ahead and
2076 // broadcast our latest local state as well here, just in case its
2077 // some kind of SPV attack, though we expect these to be dropped.
2078 failed_channels.push(channel.force_shutdown());
2079 if let Ok(update) = self.get_channel_update(&channel) {
2080 new_events.push(events::Event::BroadcastChannelUpdate {
2089 if channel.is_funding_initiated() && channel.channel_monitor().would_broadcast_at_height(height) {
2090 if let Some(short_id) = channel.get_short_channel_id() {
2091 short_to_id.remove(&short_id);
2093 failed_channels.push(channel.force_shutdown());
2094 // If would_broadcast_at_height() is true, the channel_monitor will broadcast
2095 // the latest local tx for us, so we should skip that here (it doesn't really
2096 // hurt anything, but does make tests a bit simpler).
2097 failed_channels.last_mut().unwrap().0 = Vec::new();
2098 if let Ok(update) = self.get_channel_update(&channel) {
2099 new_events.push(events::Event::BroadcastChannelUpdate {
2108 for failure in failed_channels.drain(..) {
2109 self.finish_force_close_channel(failure);
2111 let mut pending_events = self.pending_events.lock().unwrap();
2112 for funding_locked in new_events.drain(..) {
2113 pending_events.push(funding_locked);
2115 self.latest_block_height.store(height as usize, Ordering::Release);
2118 /// We force-close the channel without letting our counterparty participate in the shutdown
2119 fn block_disconnected(&self, header: &BlockHeader) {
2120 let mut new_events = Vec::new();
2121 let mut failed_channels = Vec::new();
2123 let mut channel_lock = self.channel_state.lock().unwrap();
2124 let channel_state = channel_lock.borrow_parts();
2125 let short_to_id = channel_state.short_to_id;
2126 channel_state.by_id.retain(|_, v| {
2127 if v.block_disconnected(header) {
2128 if let Some(short_id) = v.get_short_channel_id() {
2129 short_to_id.remove(&short_id);
2131 failed_channels.push(v.force_shutdown());
2132 if let Ok(update) = self.get_channel_update(&v) {
2133 new_events.push(events::Event::BroadcastChannelUpdate {
2143 for failure in failed_channels.drain(..) {
2144 self.finish_force_close_channel(failure);
2146 if !new_events.is_empty() {
2147 let mut pending_events = self.pending_events.lock().unwrap();
2148 for funding_locked in new_events.drain(..) {
2149 pending_events.push(funding_locked);
2152 self.latest_block_height.fetch_sub(1, Ordering::AcqRel);
2156 macro_rules! handle_error {
2157 ($self: ident, $internal: expr, $their_node_id: expr) => {
2160 Err(MsgHandleErrInternal { err, needs_channel_force_close }) => {
2161 if needs_channel_force_close {
2163 &Some(msgs::ErrorAction::DisconnectPeer { msg: Some(ref msg) }) => {
2164 if msg.channel_id == [0; 32] {
2165 $self.peer_disconnected(&$their_node_id, true);
2167 $self.force_close_channel(&msg.channel_id);
2170 &Some(msgs::ErrorAction::DisconnectPeer { msg: None }) => {},
2171 &Some(msgs::ErrorAction::IgnoreError) => {},
2172 &Some(msgs::ErrorAction::SendErrorMessage { ref msg }) => {
2173 if msg.channel_id == [0; 32] {
2174 $self.peer_disconnected(&$their_node_id, true);
2176 $self.force_close_channel(&msg.channel_id);
2188 impl ChannelMessageHandler for ChannelManager {
2189 //TODO: Handle errors and close channel (or so)
2190 fn handle_open_channel(&self, their_node_id: &PublicKey, msg: &msgs::OpenChannel) -> Result<msgs::AcceptChannel, HandleError> {
2191 handle_error!(self, self.internal_open_channel(their_node_id, msg), their_node_id)
2194 fn handle_accept_channel(&self, their_node_id: &PublicKey, msg: &msgs::AcceptChannel) -> Result<(), HandleError> {
2195 handle_error!(self, self.internal_accept_channel(their_node_id, msg), their_node_id)
2198 fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<msgs::FundingSigned, HandleError> {
2199 handle_error!(self, self.internal_funding_created(their_node_id, msg), their_node_id)
2202 fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), HandleError> {
2203 handle_error!(self, self.internal_funding_signed(their_node_id, msg), their_node_id)
2206 fn handle_funding_locked(&self, their_node_id: &PublicKey, msg: &msgs::FundingLocked) -> Result<Option<msgs::AnnouncementSignatures>, HandleError> {
2207 handle_error!(self, self.internal_funding_locked(their_node_id, msg), their_node_id)
2210 fn handle_shutdown(&self, their_node_id: &PublicKey, msg: &msgs::Shutdown) -> Result<(Option<msgs::Shutdown>, Option<msgs::ClosingSigned>), HandleError> {
2211 handle_error!(self, self.internal_shutdown(their_node_id, msg), their_node_id)
2214 fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<Option<msgs::ClosingSigned>, HandleError> {
2215 handle_error!(self, self.internal_closing_signed(their_node_id, msg), their_node_id)
2218 fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), msgs::HandleError> {
2219 handle_error!(self, self.internal_update_add_htlc(their_node_id, msg), their_node_id)
2222 fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), HandleError> {
2223 handle_error!(self, self.internal_update_fulfill_htlc(their_node_id, msg), their_node_id)
2226 fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<Option<msgs::HTLCFailChannelUpdate>, HandleError> {
2227 handle_error!(self, self.internal_update_fail_htlc(their_node_id, msg), their_node_id)
2230 fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), HandleError> {
2231 handle_error!(self, self.internal_update_fail_malformed_htlc(their_node_id, msg), their_node_id)
2234 fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(msgs::RevokeAndACK, Option<msgs::CommitmentSigned>), HandleError> {
2235 handle_error!(self, self.internal_commitment_signed(their_node_id, msg), their_node_id)
2238 fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<Option<msgs::CommitmentUpdate>, HandleError> {
2239 handle_error!(self, self.internal_revoke_and_ack(their_node_id, msg), their_node_id)
2242 fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), HandleError> {
2243 handle_error!(self, self.internal_update_fee(their_node_id, msg), their_node_id)
2246 fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), HandleError> {
2247 handle_error!(self, self.internal_announcement_signatures(their_node_id, msg), their_node_id)
2250 fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<(Option<msgs::FundingLocked>, Option<msgs::RevokeAndACK>, Option<msgs::CommitmentUpdate>), HandleError> {
2251 handle_error!(self, self.internal_channel_reestablish(their_node_id, msg), their_node_id)
2254 fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool) {
2255 let mut new_events = Vec::new();
2256 let mut failed_channels = Vec::new();
2257 let mut failed_payments = Vec::new();
2259 let mut channel_state_lock = self.channel_state.lock().unwrap();
2260 let channel_state = channel_state_lock.borrow_parts();
2261 let short_to_id = channel_state.short_to_id;
2262 if no_connection_possible {
2263 channel_state.by_id.retain(|_, chan| {
2264 if chan.get_their_node_id() == *their_node_id {
2265 if let Some(short_id) = chan.get_short_channel_id() {
2266 short_to_id.remove(&short_id);
2268 failed_channels.push(chan.force_shutdown());
2269 if let Ok(update) = self.get_channel_update(&chan) {
2270 new_events.push(events::Event::BroadcastChannelUpdate {
2280 channel_state.by_id.retain(|_, chan| {
2281 if chan.get_their_node_id() == *their_node_id {
2282 //TODO: mark channel disabled (and maybe announce such after a timeout).
2283 let failed_adds = chan.remove_uncommitted_htlcs_and_mark_paused();
2284 if !failed_adds.is_empty() {
2285 let chan_update = self.get_channel_update(&chan).map(|u| u.encode_with_len()).unwrap(); // Cannot add/recv HTLCs before we have a short_id so unwrap is safe
2286 failed_payments.push((chan_update, failed_adds));
2288 if chan.is_shutdown() {
2289 if let Some(short_id) = chan.get_short_channel_id() {
2290 short_to_id.remove(&short_id);
2299 for failure in failed_channels.drain(..) {
2300 self.finish_force_close_channel(failure);
2302 if !new_events.is_empty() {
2303 let mut pending_events = self.pending_events.lock().unwrap();
2304 for event in new_events.drain(..) {
2305 pending_events.push(event);
2308 for (chan_update, mut htlc_sources) in failed_payments {
2309 for (htlc_source, payment_hash) in htlc_sources.drain(..) {
2310 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source, &payment_hash, HTLCFailReason::Reason { failure_code: 0x1000 | 7, data: chan_update.clone() });
2315 fn peer_connected(&self, their_node_id: &PublicKey) -> Vec<msgs::ChannelReestablish> {
2316 let mut res = Vec::new();
2317 let mut channel_state = self.channel_state.lock().unwrap();
2318 channel_state.by_id.retain(|_, chan| {
2319 if chan.get_their_node_id() == *their_node_id {
2320 if !chan.have_received_message() {
2321 // If we created this (outbound) channel while we were disconnected from the
2322 // peer we probably failed to send the open_channel message, which is now
2323 // lost. We can't have had anything pending related to this channel, so we just
2327 res.push(chan.get_channel_reestablish());
2332 //TODO: Also re-broadcast announcement_signatures
2336 fn handle_error(&self, their_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
2337 if msg.channel_id == [0; 32] {
2338 for chan in self.list_channels() {
2339 if chan.remote_network_id == *their_node_id {
2340 self.force_close_channel(&chan.channel_id);
2344 self.force_close_channel(&msg.channel_id);
2351 use chain::chaininterface;
2352 use chain::transaction::OutPoint;
2353 use chain::chaininterface::ChainListener;
2354 use ln::channelmanager::{ChannelManager,OnionKeys};
2355 use ln::router::{Route, RouteHop, Router};
2357 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler};
2358 use util::test_utils;
2359 use util::events::{Event, EventsProvider};
2360 use util::errors::APIError;
2361 use util::logger::Logger;
2362 use util::ser::Writeable;
2364 use bitcoin::util::hash::Sha256dHash;
2365 use bitcoin::blockdata::block::{Block, BlockHeader};
2366 use bitcoin::blockdata::transaction::{Transaction, TxOut};
2367 use bitcoin::blockdata::constants::genesis_block;
2368 use bitcoin::network::constants::Network;
2369 use bitcoin::network::serialize::serialize;
2370 use bitcoin::network::serialize::BitcoinHash;
2374 use secp256k1::{Secp256k1, Message};
2375 use secp256k1::key::{PublicKey,SecretKey};
2377 use crypto::sha2::Sha256;
2378 use crypto::digest::Digest;
2380 use rand::{thread_rng,Rng};
2382 use std::cell::RefCell;
2383 use std::collections::{BTreeSet, HashMap};
2384 use std::default::Default;
2386 use std::sync::{Arc, Mutex};
2387 use std::time::Instant;
2390 fn build_test_onion_keys() -> Vec<OnionKeys> {
2391 // Keys from BOLT 4, used in both test vector tests
2392 let secp_ctx = Secp256k1::new();
2397 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("02eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619").unwrap()[..]).unwrap(),
2398 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
2401 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("0324653eac434488002cc06bbfb7f10fe18991e35f9fe4302dbea6d2353dc0ab1c").unwrap()[..]).unwrap(),
2402 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
2405 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("027f31ebc5462c1fdce1b737ecff52d37d75dea43ce11c74d25aa297165faa2007").unwrap()[..]).unwrap(),
2406 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
2409 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]).unwrap(),
2410 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
2413 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("02edabbd16b41c8371b92ef2f04c1185b4f03b6dcd52ba9b78d9d7c89c8f221145").unwrap()[..]).unwrap(),
2414 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
2419 let session_priv = SecretKey::from_slice(&secp_ctx, &hex::decode("4141414141414141414141414141414141414141414141414141414141414141").unwrap()[..]).unwrap();
2421 let onion_keys = ChannelManager::construct_onion_keys(&secp_ctx, &route, &session_priv).unwrap();
2422 assert_eq!(onion_keys.len(), route.hops.len());
2427 fn onion_vectors() {
2428 // Packet creation test vectors from BOLT 4
2429 let onion_keys = build_test_onion_keys();
2431 assert_eq!(onion_keys[0].shared_secret[..], hex::decode("53eb63ea8a3fec3b3cd433b85cd62a4b145e1dda09391b348c4e1cd36a03ea66").unwrap()[..]);
2432 assert_eq!(onion_keys[0].blinding_factor[..], hex::decode("2ec2e5da605776054187180343287683aa6a51b4b1c04d6dd49c45d8cffb3c36").unwrap()[..]);
2433 assert_eq!(onion_keys[0].ephemeral_pubkey.serialize()[..], hex::decode("02eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619").unwrap()[..]);
2434 assert_eq!(onion_keys[0].rho, hex::decode("ce496ec94def95aadd4bec15cdb41a740c9f2b62347c4917325fcc6fb0453986").unwrap()[..]);
2435 assert_eq!(onion_keys[0].mu, hex::decode("b57061dc6d0a2b9f261ac410c8b26d64ac5506cbba30267a649c28c179400eba").unwrap()[..]);
2437 assert_eq!(onion_keys[1].shared_secret[..], hex::decode("a6519e98832a0b179f62123b3567c106db99ee37bef036e783263602f3488fae").unwrap()[..]);
2438 assert_eq!(onion_keys[1].blinding_factor[..], hex::decode("bf66c28bc22e598cfd574a1931a2bafbca09163df2261e6d0056b2610dab938f").unwrap()[..]);
2439 assert_eq!(onion_keys[1].ephemeral_pubkey.serialize()[..], hex::decode("028f9438bfbf7feac2e108d677e3a82da596be706cc1cf342b75c7b7e22bf4e6e2").unwrap()[..]);
2440 assert_eq!(onion_keys[1].rho, hex::decode("450ffcabc6449094918ebe13d4f03e433d20a3d28a768203337bc40b6e4b2c59").unwrap()[..]);
2441 assert_eq!(onion_keys[1].mu, hex::decode("05ed2b4a3fb023c2ff5dd6ed4b9b6ea7383f5cfe9d59c11d121ec2c81ca2eea9").unwrap()[..]);
2443 assert_eq!(onion_keys[2].shared_secret[..], hex::decode("3a6b412548762f0dbccce5c7ae7bb8147d1caf9b5471c34120b30bc9c04891cc").unwrap()[..]);
2444 assert_eq!(onion_keys[2].blinding_factor[..], hex::decode("a1f2dadd184eb1627049673f18c6325814384facdee5bfd935d9cb031a1698a5").unwrap()[..]);
2445 assert_eq!(onion_keys[2].ephemeral_pubkey.serialize()[..], hex::decode("03bfd8225241ea71cd0843db7709f4c222f62ff2d4516fd38b39914ab6b83e0da0").unwrap()[..]);
2446 assert_eq!(onion_keys[2].rho, hex::decode("11bf5c4f960239cb37833936aa3d02cea82c0f39fd35f566109c41f9eac8deea").unwrap()[..]);
2447 assert_eq!(onion_keys[2].mu, hex::decode("caafe2820fa00eb2eeb78695ae452eba38f5a53ed6d53518c5c6edf76f3f5b78").unwrap()[..]);
2449 assert_eq!(onion_keys[3].shared_secret[..], hex::decode("21e13c2d7cfe7e18836df50872466117a295783ab8aab0e7ecc8c725503ad02d").unwrap()[..]);
2450 assert_eq!(onion_keys[3].blinding_factor[..], hex::decode("7cfe0b699f35525029ae0fa437c69d0f20f7ed4e3916133f9cacbb13c82ff262").unwrap()[..]);
2451 assert_eq!(onion_keys[3].ephemeral_pubkey.serialize()[..], hex::decode("031dde6926381289671300239ea8e57ffaf9bebd05b9a5b95beaf07af05cd43595").unwrap()[..]);
2452 assert_eq!(onion_keys[3].rho, hex::decode("cbe784ab745c13ff5cffc2fbe3e84424aa0fd669b8ead4ee562901a4a4e89e9e").unwrap()[..]);
2453 assert_eq!(onion_keys[3].mu, hex::decode("5052aa1b3d9f0655a0932e50d42f0c9ba0705142c25d225515c45f47c0036ee9").unwrap()[..]);
2455 assert_eq!(onion_keys[4].shared_secret[..], hex::decode("b5756b9b542727dbafc6765a49488b023a725d631af688fc031217e90770c328").unwrap()[..]);
2456 assert_eq!(onion_keys[4].blinding_factor[..], hex::decode("c96e00dddaf57e7edcd4fb5954be5b65b09f17cb6d20651b4e90315be5779205").unwrap()[..]);
2457 assert_eq!(onion_keys[4].ephemeral_pubkey.serialize()[..], hex::decode("03a214ebd875aab6ddfd77f22c5e7311d7f77f17a169e599f157bbcdae8bf071f4").unwrap()[..]);
2458 assert_eq!(onion_keys[4].rho, hex::decode("034e18b8cc718e8af6339106e706c52d8df89e2b1f7e9142d996acf88df8799b").unwrap()[..]);
2459 assert_eq!(onion_keys[4].mu, hex::decode("8e45e5c61c2b24cb6382444db6698727afb063adecd72aada233d4bf273d975a").unwrap()[..]);
2461 // Test vectors below are flat-out wrong: they claim to set outgoing_cltv_value to non-0 :/
2462 let payloads = vec!(
2463 msgs::OnionHopData {
2465 data: msgs::OnionRealm0HopData {
2466 short_channel_id: 0,
2468 outgoing_cltv_value: 0,
2472 msgs::OnionHopData {
2474 data: msgs::OnionRealm0HopData {
2475 short_channel_id: 0x0101010101010101,
2476 amt_to_forward: 0x0100000001,
2477 outgoing_cltv_value: 0,
2481 msgs::OnionHopData {
2483 data: msgs::OnionRealm0HopData {
2484 short_channel_id: 0x0202020202020202,
2485 amt_to_forward: 0x0200000002,
2486 outgoing_cltv_value: 0,
2490 msgs::OnionHopData {
2492 data: msgs::OnionRealm0HopData {
2493 short_channel_id: 0x0303030303030303,
2494 amt_to_forward: 0x0300000003,
2495 outgoing_cltv_value: 0,
2499 msgs::OnionHopData {
2501 data: msgs::OnionRealm0HopData {
2502 short_channel_id: 0x0404040404040404,
2503 amt_to_forward: 0x0400000004,
2504 outgoing_cltv_value: 0,
2510 let packet = ChannelManager::construct_onion_packet(payloads, onion_keys, &[0x42; 32]);
2511 // Just check the final packet encoding, as it includes all the per-hop vectors in it
2513 assert_eq!(packet.encode(), hex::decode("0002eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619e5f14350c2a76fc232b5e46d421e9615471ab9e0bc887beff8c95fdb878f7b3a716a996c7845c93d90e4ecbb9bde4ece2f69425c99e4bc820e44485455f135edc0d10f7d61ab590531cf08000179a333a347f8b4072f216400406bdf3bf038659793d4a1fd7b246979e3150a0a4cb052c9ec69acf0f48c3d39cd55675fe717cb7d80ce721caad69320c3a469a202f1e468c67eaf7a7cd8226d0fd32f7b48084dca885d56047694762b67021713ca673929c163ec36e04e40ca8e1c6d17569419d3039d9a1ec866abe044a9ad635778b961fc0776dc832b3a451bd5d35072d2269cf9b040f6b7a7dad84fb114ed413b1426cb96ceaf83825665ed5a1d002c1687f92465b49ed4c7f0218ff8c6c7dd7221d589c65b3b9aaa71a41484b122846c7c7b57e02e679ea8469b70e14fe4f70fee4d87b910cf144be6fe48eef24da475c0b0bcc6565ae82cd3f4e3b24c76eaa5616c6111343306ab35c1fe5ca4a77c0e314ed7dba39d6f1e0de791719c241a939cc493bea2bae1c1e932679ea94d29084278513c77b899cc98059d06a27d171b0dbdf6bee13ddc4fc17a0c4d2827d488436b57baa167544138ca2e64a11b43ac8a06cd0c2fba2d4d900ed2d9205305e2d7383cc98dacb078133de5f6fb6bed2ef26ba92cea28aafc3b9948dd9ae5559e8bd6920b8cea462aa445ca6a95e0e7ba52961b181c79e73bd581821df2b10173727a810c92b83b5ba4a0403eb710d2ca10689a35bec6c3a708e9e92f7d78ff3c5d9989574b00c6736f84c199256e76e19e78f0c98a9d580b4a658c84fc8f2096c2fbea8f5f8c59d0fdacb3be2802ef802abbecb3aba4acaac69a0e965abd8981e9896b1f6ef9d60f7a164b371af869fd0e48073742825e9434fc54da837e120266d53302954843538ea7c6c3dbfb4ff3b2fdbe244437f2a153ccf7bdb4c92aa08102d4f3cff2ae5ef86fab4653595e6a5837fa2f3e29f27a9cde5966843fb847a4a61f1e76c281fe8bb2b0a181d096100db5a1a5ce7a910238251a43ca556712eaadea167fb4d7d75825e440f3ecd782036d7574df8bceacb397abefc5f5254d2722215c53ff54af8299aaaad642c6d72a14d27882d9bbd539e1cc7a527526ba89b8c037ad09120e98ab042d3e8652b31ae0e478516bfaf88efca9f3676ffe99d2819dcaeb7610a626695f53117665d267d3f7abebd6bbd6733f645c72c389f03855bdf1e4b8075b516569b118233a0f0971d24b83113c0b096f5216a207ca99a7cddc81c130923fe3d91e7508c9ac5f2e914ff5dccab9e558566fa14efb34ac98d878580814b94b73acbfde9072f30b881f7f0fff42d4045d1ace6322d86a97d164aa84d93a60498065cc7c20e636f5862dc81531a88c60305a2e59a985be327a6902e4bed986dbf4a0b50c217af0ea7fdf9ab37f9ea1a1aaa72f54cf40154ea9b269f1a7c09f9f43245109431a175d50e2db0132337baa0ef97eed0fcf20489da36b79a1172faccc2f7ded7c60e00694282d93359c4682135642bc81f433574aa8ef0c97b4ade7ca372c5ffc23c7eddd839bab4e0f14d6df15c9dbeab176bec8b5701cf054eb3072f6dadc98f88819042bf10c407516ee58bce33fbe3b3d86a54255e577db4598e30a135361528c101683a5fcde7e8ba53f3456254be8f45fe3a56120ae96ea3773631fcb3873aa3abd91bcff00bd38bd43697a2e789e00da6077482e7b1b1a677b5afae4c54e6cbdf7377b694eb7d7a5b913476a5be923322d3de06060fd5e819635232a2cf4f0731da13b8546d1d6d4f8d75b9fce6c2341a71b0ea6f780df54bfdb0dd5cd9855179f602f9172307c7268724c3618e6817abd793adc214a0dc0bc616816632f27ea336fb56dfd").unwrap());
2517 fn test_failure_packet_onion() {
2518 // Returning Errors test vectors from BOLT 4
2520 let onion_keys = build_test_onion_keys();
2521 let onion_error = ChannelManager::build_failure_packet(&onion_keys[4].shared_secret, 0x2002, &[0; 0]);
2522 assert_eq!(onion_error.encode(), hex::decode("4c2fc8bc08510334b6833ad9c3e79cd1b52ae59dfe5c2a4b23ead50f09f7ee0b0002200200fe0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap());
2524 let onion_packet_1 = ChannelManager::encrypt_failure_packet(&onion_keys[4].shared_secret, &onion_error.encode()[..]);
2525 assert_eq!(onion_packet_1.data, hex::decode("a5e6bd0c74cb347f10cce367f949098f2457d14c046fd8a22cb96efb30b0fdcda8cb9168b50f2fd45edd73c1b0c8b33002df376801ff58aaa94000bf8a86f92620f343baef38a580102395ae3abf9128d1047a0736ff9b83d456740ebbb4aeb3aa9737f18fb4afb4aa074fb26c4d702f42968888550a3bded8c05247e045b866baef0499f079fdaeef6538f31d44deafffdfd3afa2fb4ca9082b8f1c465371a9894dd8c243fb4847e004f5256b3e90e2edde4c9fb3082ddfe4d1e734cacd96ef0706bf63c9984e22dc98851bcccd1c3494351feb458c9c6af41c0044bea3c47552b1d992ae542b17a2d0bba1a096c78d169034ecb55b6e3a7263c26017f033031228833c1daefc0dedb8cf7c3e37c9c37ebfe42f3225c326e8bcfd338804c145b16e34e4").unwrap());
2527 let onion_packet_2 = ChannelManager::encrypt_failure_packet(&onion_keys[3].shared_secret, &onion_packet_1.data[..]);
2528 assert_eq!(onion_packet_2.data, hex::decode("c49a1ce81680f78f5f2000cda36268de34a3f0a0662f55b4e837c83a8773c22aa081bab1616a0011585323930fa5b9fae0c85770a2279ff59ec427ad1bbff9001c0cd1497004bd2a0f68b50704cf6d6a4bf3c8b6a0833399a24b3456961ba00736785112594f65b6b2d44d9f5ea4e49b5e1ec2af978cbe31c67114440ac51a62081df0ed46d4a3df295da0b0fe25c0115019f03f15ec86fabb4c852f83449e812f141a9395b3f70b766ebbd4ec2fae2b6955bd8f32684c15abfe8fd3a6261e52650e8807a92158d9f1463261a925e4bfba44bd20b166d532f0017185c3a6ac7957adefe45559e3072c8dc35abeba835a8cb01a71a15c736911126f27d46a36168ca5ef7dccd4e2886212602b181463e0dd30185c96348f9743a02aca8ec27c0b90dca270").unwrap());
2530 let onion_packet_3 = ChannelManager::encrypt_failure_packet(&onion_keys[2].shared_secret, &onion_packet_2.data[..]);
2531 assert_eq!(onion_packet_3.data, hex::decode("a5d3e8634cfe78b2307d87c6d90be6fe7855b4f2cc9b1dfb19e92e4b79103f61ff9ac25f412ddfb7466e74f81b3e545563cdd8f5524dae873de61d7bdfccd496af2584930d2b566b4f8d3881f8c043df92224f38cf094cfc09d92655989531524593ec6d6caec1863bdfaa79229b5020acc034cd6deeea1021c50586947b9b8e6faa83b81fbfa6133c0af5d6b07c017f7158fa94f0d206baf12dda6b68f785b773b360fd0497e16cc402d779c8d48d0fa6315536ef0660f3f4e1865f5b38ea49c7da4fd959de4e83ff3ab686f059a45c65ba2af4a6a79166aa0f496bf04d06987b6d2ea205bdb0d347718b9aeff5b61dfff344993a275b79717cd815b6ad4c0beb568c4ac9c36ff1c315ec1119a1993c4b61e6eaa0375e0aaf738ac691abd3263bf937e3").unwrap());
2533 let onion_packet_4 = ChannelManager::encrypt_failure_packet(&onion_keys[1].shared_secret, &onion_packet_3.data[..]);
2534 assert_eq!(onion_packet_4.data, hex::decode("aac3200c4968f56b21f53e5e374e3a2383ad2b1b6501bbcc45abc31e59b26881b7dfadbb56ec8dae8857add94e6702fb4c3a4de22e2e669e1ed926b04447fc73034bb730f4932acd62727b75348a648a1128744657ca6a4e713b9b646c3ca66cac02cdab44dd3439890ef3aaf61708714f7375349b8da541b2548d452d84de7084bb95b3ac2345201d624d31f4d52078aa0fa05a88b4e20202bd2b86ac5b52919ea305a8949de95e935eed0319cf3cf19ebea61d76ba92532497fcdc9411d06bcd4275094d0a4a3c5d3a945e43305a5a9256e333e1f64dbca5fcd4e03a39b9012d197506e06f29339dfee3331995b21615337ae060233d39befea925cc262873e0530408e6990f1cbd233a150ef7b004ff6166c70c68d9f8c853c1abca640b8660db2921").unwrap());
2536 let onion_packet_5 = ChannelManager::encrypt_failure_packet(&onion_keys[0].shared_secret, &onion_packet_4.data[..]);
2537 assert_eq!(onion_packet_5.data, hex::decode("9c5add3963fc7f6ed7f148623c84134b5647e1306419dbe2174e523fa9e2fbed3a06a19f899145610741c83ad40b7712aefaddec8c6baf7325d92ea4ca4d1df8bce517f7e54554608bf2bd8071a4f52a7a2f7ffbb1413edad81eeea5785aa9d990f2865dc23b4bc3c301a94eec4eabebca66be5cf638f693ec256aec514620cc28ee4a94bd9565bc4d4962b9d3641d4278fb319ed2b84de5b665f307a2db0f7fbb757366067d88c50f7e829138fde4f78d39b5b5802f1b92a8a820865af5cc79f9f30bc3f461c66af95d13e5e1f0381c184572a91dee1c849048a647a1158cf884064deddbf1b0b88dfe2f791428d0ba0f6fb2f04e14081f69165ae66d9297c118f0907705c9c4954a199bae0bb96fad763d690e7daa6cfda59ba7f2c8d11448b604d12d").unwrap());
2540 fn confirm_transaction(chain: &chaininterface::ChainWatchInterfaceUtil, tx: &Transaction, chan_id: u32) {
2541 assert!(chain.does_match_tx(tx));
2542 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2543 chain.block_connected_checked(&header, 1, &[tx; 1], &[chan_id; 1]);
2545 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2546 chain.block_connected_checked(&header, i, &[tx; 0], &[0; 0]);
2551 chain_monitor: Arc<chaininterface::ChainWatchInterfaceUtil>,
2552 tx_broadcaster: Arc<test_utils::TestBroadcaster>,
2553 chan_monitor: Arc<test_utils::TestChannelMonitor>,
2554 node: Arc<ChannelManager>,
2556 network_payment_count: Rc<RefCell<u8>>,
2557 network_chan_count: Rc<RefCell<u32>>,
2559 impl Drop for Node {
2560 fn drop(&mut self) {
2561 if !::std::thread::panicking() {
2562 // Check that we processed all pending events
2563 assert_eq!(self.node.get_and_clear_pending_events().len(), 0);
2564 assert_eq!(self.chan_monitor.added_monitors.lock().unwrap().len(), 0);
2569 fn create_chan_between_nodes(node_a: &Node, node_b: &Node) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
2570 create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001)
2573 fn create_chan_between_nodes_with_value(node_a: &Node, node_b: &Node, channel_value: u64, push_msat: u64) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
2574 let (funding_locked, channel_id, tx) = create_chan_between_nodes_with_value_a(node_a, node_b, channel_value, push_msat);
2575 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &funding_locked);
2576 (announcement, as_update, bs_update, channel_id, tx)
2579 fn create_chan_between_nodes_with_value_init(node_a: &Node, node_b: &Node, channel_value: u64, push_msat: u64) -> Transaction {
2580 node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42).unwrap();
2582 let events_1 = node_a.node.get_and_clear_pending_events();
2583 assert_eq!(events_1.len(), 1);
2584 let accept_chan = match events_1[0] {
2585 Event::SendOpenChannel { ref node_id, ref msg } => {
2586 assert_eq!(*node_id, node_b.node.get_our_node_id());
2587 node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), msg).unwrap()
2589 _ => panic!("Unexpected event"),
2592 node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), &accept_chan).unwrap();
2594 let chan_id = *node_a.network_chan_count.borrow();
2598 let events_2 = node_a.node.get_and_clear_pending_events();
2599 assert_eq!(events_2.len(), 1);
2601 Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
2602 assert_eq!(*channel_value_satoshis, channel_value);
2603 assert_eq!(user_channel_id, 42);
2605 tx = Transaction { version: chan_id as u32, lock_time: 0, input: Vec::new(), output: vec![TxOut {
2606 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
2608 funding_output = OutPoint::new(Sha256dHash::from_data(&serialize(&tx).unwrap()[..]), 0);
2610 node_a.node.funding_transaction_generated(&temporary_channel_id, funding_output);
2611 let mut added_monitors = node_a.chan_monitor.added_monitors.lock().unwrap();
2612 assert_eq!(added_monitors.len(), 1);
2613 assert_eq!(added_monitors[0].0, funding_output);
2614 added_monitors.clear();
2616 _ => panic!("Unexpected event"),
2619 let events_3 = node_a.node.get_and_clear_pending_events();
2620 assert_eq!(events_3.len(), 1);
2621 let funding_signed = match events_3[0] {
2622 Event::SendFundingCreated { ref node_id, ref msg } => {
2623 assert_eq!(*node_id, node_b.node.get_our_node_id());
2624 let res = node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), msg).unwrap();
2625 let mut added_monitors = node_b.chan_monitor.added_monitors.lock().unwrap();
2626 assert_eq!(added_monitors.len(), 1);
2627 assert_eq!(added_monitors[0].0, funding_output);
2628 added_monitors.clear();
2631 _ => panic!("Unexpected event"),
2634 node_a.node.handle_funding_signed(&node_b.node.get_our_node_id(), &funding_signed).unwrap();
2636 let mut added_monitors = node_a.chan_monitor.added_monitors.lock().unwrap();
2637 assert_eq!(added_monitors.len(), 1);
2638 assert_eq!(added_monitors[0].0, funding_output);
2639 added_monitors.clear();
2642 let events_4 = node_a.node.get_and_clear_pending_events();
2643 assert_eq!(events_4.len(), 1);
2645 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
2646 assert_eq!(user_channel_id, 42);
2647 assert_eq!(*funding_txo, funding_output);
2649 _ => panic!("Unexpected event"),
2655 fn create_chan_between_nodes_with_value_confirm(node_a: &Node, node_b: &Node, tx: &Transaction) -> ((msgs::FundingLocked, msgs::AnnouncementSignatures), [u8; 32]) {
2656 confirm_transaction(&node_b.chain_monitor, &tx, tx.version);
2657 let events_5 = node_b.node.get_and_clear_pending_events();
2658 assert_eq!(events_5.len(), 1);
2660 Event::SendFundingLocked { ref node_id, ref msg, ref announcement_sigs } => {
2661 assert_eq!(*node_id, node_a.node.get_our_node_id());
2662 assert!(announcement_sigs.is_none());
2663 node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), msg).unwrap()
2665 _ => panic!("Unexpected event"),
2670 confirm_transaction(&node_a.chain_monitor, &tx, tx.version);
2671 let events_6 = node_a.node.get_and_clear_pending_events();
2672 assert_eq!(events_6.len(), 1);
2673 (match events_6[0] {
2674 Event::SendFundingLocked { ref node_id, ref msg, ref announcement_sigs } => {
2675 channel_id = msg.channel_id.clone();
2676 assert_eq!(*node_id, node_b.node.get_our_node_id());
2677 (msg.clone(), announcement_sigs.clone().unwrap())
2679 _ => panic!("Unexpected event"),
2683 fn create_chan_between_nodes_with_value_a(node_a: &Node, node_b: &Node, channel_value: u64, push_msat: u64) -> ((msgs::FundingLocked, msgs::AnnouncementSignatures), [u8; 32], Transaction) {
2684 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat);
2685 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
2689 fn create_chan_between_nodes_with_value_b(node_a: &Node, node_b: &Node, as_funding_msgs: &(msgs::FundingLocked, msgs::AnnouncementSignatures)) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate) {
2690 let bs_announcement_sigs = {
2691 let bs_announcement_sigs = node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &as_funding_msgs.0).unwrap().unwrap();
2692 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1).unwrap();
2693 bs_announcement_sigs
2696 let events_7 = node_b.node.get_and_clear_pending_events();
2697 assert_eq!(events_7.len(), 1);
2698 let (announcement, bs_update) = match events_7[0] {
2699 Event::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
2702 _ => panic!("Unexpected event"),
2705 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs).unwrap();
2706 let events_8 = node_a.node.get_and_clear_pending_events();
2707 assert_eq!(events_8.len(), 1);
2708 let as_update = match events_8[0] {
2709 Event::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
2710 assert!(*announcement == *msg);
2713 _ => panic!("Unexpected event"),
2716 *node_a.network_chan_count.borrow_mut() += 1;
2718 ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone())
2721 fn create_announced_chan_between_nodes(nodes: &Vec<Node>, a: usize, b: usize) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
2722 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001)
2725 fn create_announced_chan_between_nodes_with_value(nodes: &Vec<Node>, a: usize, b: usize, channel_value: u64, push_msat: u64) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
2726 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat);
2728 assert!(node.router.handle_channel_announcement(&chan_announcement.0).unwrap());
2729 node.router.handle_channel_update(&chan_announcement.1).unwrap();
2730 node.router.handle_channel_update(&chan_announcement.2).unwrap();
2732 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
2735 macro_rules! check_spends {
2736 ($tx: expr, $spends_tx: expr) => {
2738 let mut funding_tx_map = HashMap::new();
2739 let spends_tx = $spends_tx;
2740 funding_tx_map.insert(spends_tx.txid(), spends_tx);
2741 $tx.verify(&funding_tx_map).unwrap();
2746 fn close_channel(outbound_node: &Node, inbound_node: &Node, channel_id: &[u8; 32], funding_tx: Transaction, close_inbound_first: bool) -> (msgs::ChannelUpdate, msgs::ChannelUpdate) {
2747 let (node_a, broadcaster_a) = if close_inbound_first { (&inbound_node.node, &inbound_node.tx_broadcaster) } else { (&outbound_node.node, &outbound_node.tx_broadcaster) };
2748 let (node_b, broadcaster_b) = if close_inbound_first { (&outbound_node.node, &outbound_node.tx_broadcaster) } else { (&inbound_node.node, &inbound_node.tx_broadcaster) };
2751 node_a.close_channel(channel_id).unwrap();
2752 let events_1 = node_a.get_and_clear_pending_events();
2753 assert_eq!(events_1.len(), 1);
2754 let shutdown_a = match events_1[0] {
2755 Event::SendShutdown { ref node_id, ref msg } => {
2756 assert_eq!(node_id, &node_b.get_our_node_id());
2759 _ => panic!("Unexpected event"),
2762 let (shutdown_b, mut closing_signed_b) = node_b.handle_shutdown(&node_a.get_our_node_id(), &shutdown_a).unwrap();
2763 if !close_inbound_first {
2764 assert!(closing_signed_b.is_none());
2766 let (empty_a, mut closing_signed_a) = node_a.handle_shutdown(&node_b.get_our_node_id(), &shutdown_b.unwrap()).unwrap();
2767 assert!(empty_a.is_none());
2768 if close_inbound_first {
2769 assert!(closing_signed_a.is_none());
2770 closing_signed_a = node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap()).unwrap();
2771 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
2772 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
2774 let empty_b = node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap()).unwrap();
2775 assert!(empty_b.is_none());
2776 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
2777 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
2779 closing_signed_b = node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap()).unwrap();
2780 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
2781 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
2783 let empty_a2 = node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap()).unwrap();
2784 assert!(empty_a2.is_none());
2785 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
2786 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
2788 assert_eq!(tx_a, tx_b);
2789 check_spends!(tx_a, funding_tx);
2791 let events_2 = node_a.get_and_clear_pending_events();
2792 assert_eq!(events_2.len(), 1);
2793 let as_update = match events_2[0] {
2794 Event::BroadcastChannelUpdate { ref msg } => {
2797 _ => panic!("Unexpected event"),
2800 let events_3 = node_b.get_and_clear_pending_events();
2801 assert_eq!(events_3.len(), 1);
2802 let bs_update = match events_3[0] {
2803 Event::BroadcastChannelUpdate { ref msg } => {
2806 _ => panic!("Unexpected event"),
2809 (as_update, bs_update)
2814 msgs: Vec<msgs::UpdateAddHTLC>,
2815 commitment_msg: msgs::CommitmentSigned,
2818 fn from_event(event: Event) -> SendEvent {
2820 Event::UpdateHTLCs { node_id, updates: msgs::CommitmentUpdate { update_add_htlcs, update_fulfill_htlcs, update_fail_htlcs, update_fail_malformed_htlcs, update_fee, commitment_signed } } => {
2821 assert!(update_fulfill_htlcs.is_empty());
2822 assert!(update_fail_htlcs.is_empty());
2823 assert!(update_fail_malformed_htlcs.is_empty());
2824 assert!(update_fee.is_none());
2825 SendEvent { node_id: node_id, msgs: update_add_htlcs, commitment_msg: commitment_signed }
2827 _ => panic!("Unexpected event type!"),
2832 macro_rules! check_added_monitors {
2833 ($node: expr, $count: expr) => {
2835 let mut added_monitors = $node.chan_monitor.added_monitors.lock().unwrap();
2836 assert_eq!(added_monitors.len(), $count);
2837 added_monitors.clear();
2842 macro_rules! commitment_signed_dance {
2843 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
2845 check_added_monitors!($node_a, 0);
2846 let (as_revoke_and_ack, as_commitment_signed) = $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed).unwrap();
2847 check_added_monitors!($node_a, 1);
2848 check_added_monitors!($node_b, 0);
2849 assert!($node_b.node.handle_revoke_and_ack(&$node_a.node.get_our_node_id(), &as_revoke_and_ack).unwrap().is_none());
2850 check_added_monitors!($node_b, 1);
2851 let (bs_revoke_and_ack, bs_none) = $node_b.node.handle_commitment_signed(&$node_a.node.get_our_node_id(), &as_commitment_signed.unwrap()).unwrap();
2852 assert!(bs_none.is_none());
2853 check_added_monitors!($node_b, 1);
2854 if $fail_backwards {
2855 assert!($node_a.node.get_and_clear_pending_events().is_empty());
2857 assert!($node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack).unwrap().is_none());
2859 let mut added_monitors = $node_a.chan_monitor.added_monitors.lock().unwrap();
2860 if $fail_backwards {
2861 assert_eq!(added_monitors.len(), 2);
2862 assert!(added_monitors[0].0 != added_monitors[1].0);
2864 assert_eq!(added_monitors.len(), 1);
2866 added_monitors.clear();
2872 macro_rules! get_payment_preimage_hash {
2875 let payment_preimage = [*$node.network_payment_count.borrow(); 32];
2876 *$node.network_payment_count.borrow_mut() += 1;
2877 let mut payment_hash = [0; 32];
2878 let mut sha = Sha256::new();
2879 sha.input(&payment_preimage[..]);
2880 sha.result(&mut payment_hash);
2881 (payment_preimage, payment_hash)
2886 fn send_along_route(origin_node: &Node, route: Route, expected_route: &[&Node], recv_value: u64) -> ([u8; 32], [u8; 32]) {
2887 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(origin_node);
2889 let mut payment_event = {
2890 origin_node.node.send_payment(route, our_payment_hash).unwrap();
2891 check_added_monitors!(origin_node, 1);
2893 let mut events = origin_node.node.get_and_clear_pending_events();
2894 assert_eq!(events.len(), 1);
2895 SendEvent::from_event(events.remove(0))
2897 let mut prev_node = origin_node;
2899 for (idx, &node) in expected_route.iter().enumerate() {
2900 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
2902 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
2903 check_added_monitors!(node, 0);
2904 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
2906 let events_1 = node.node.get_and_clear_pending_events();
2907 assert_eq!(events_1.len(), 1);
2909 Event::PendingHTLCsForwardable { .. } => { },
2910 _ => panic!("Unexpected event"),
2913 node.node.channel_state.lock().unwrap().next_forward = Instant::now();
2914 node.node.process_pending_htlc_forwards();
2916 let mut events_2 = node.node.get_and_clear_pending_events();
2917 assert_eq!(events_2.len(), 1);
2918 if idx == expected_route.len() - 1 {
2920 Event::PaymentReceived { ref payment_hash, amt } => {
2921 assert_eq!(our_payment_hash, *payment_hash);
2922 assert_eq!(amt, recv_value);
2924 _ => panic!("Unexpected event"),
2927 check_added_monitors!(node, 1);
2928 payment_event = SendEvent::from_event(events_2.remove(0));
2929 assert_eq!(payment_event.msgs.len(), 1);
2935 (our_payment_preimage, our_payment_hash)
2938 fn claim_payment_along_route(origin_node: &Node, expected_route: &[&Node], skip_last: bool, our_payment_preimage: [u8; 32]) {
2939 assert!(expected_route.last().unwrap().node.claim_funds(our_payment_preimage));
2940 check_added_monitors!(expected_route.last().unwrap(), 1);
2942 let mut next_msgs: Option<(msgs::UpdateFulfillHTLC, msgs::CommitmentSigned)> = None;
2943 macro_rules! update_fulfill_dance {
2944 ($node: expr, $prev_node: expr, $last_node: expr) => {
2946 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0).unwrap();
2948 check_added_monitors!($node, 0);
2950 check_added_monitors!($node, 1);
2952 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
2957 let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
2958 let mut prev_node = expected_route.last().unwrap();
2959 for (idx, node) in expected_route.iter().rev().enumerate() {
2960 assert_eq!(expected_next_node, node.node.get_our_node_id());
2961 if next_msgs.is_some() {
2962 update_fulfill_dance!(node, prev_node, false);
2965 let events = node.node.get_and_clear_pending_events();
2966 if !skip_last || idx != expected_route.len() - 1 {
2967 assert_eq!(events.len(), 1);
2969 Event::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, ref update_fee, ref commitment_signed } } => {
2970 assert!(update_add_htlcs.is_empty());
2971 assert_eq!(update_fulfill_htlcs.len(), 1);
2972 assert!(update_fail_htlcs.is_empty());
2973 assert!(update_fail_malformed_htlcs.is_empty());
2974 assert!(update_fee.is_none());
2975 expected_next_node = node_id.clone();
2976 next_msgs = Some((update_fulfill_htlcs[0].clone(), commitment_signed.clone()));
2978 _ => panic!("Unexpected event"),
2981 assert!(events.is_empty());
2983 if !skip_last && idx == expected_route.len() - 1 {
2984 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2991 update_fulfill_dance!(origin_node, expected_route.first().unwrap(), true);
2992 let events = origin_node.node.get_and_clear_pending_events();
2993 assert_eq!(events.len(), 1);
2995 Event::PaymentSent { payment_preimage } => {
2996 assert_eq!(payment_preimage, our_payment_preimage);
2998 _ => panic!("Unexpected event"),
3003 fn claim_payment(origin_node: &Node, expected_route: &[&Node], our_payment_preimage: [u8; 32]) {
3004 claim_payment_along_route(origin_node, expected_route, false, our_payment_preimage);
3007 const TEST_FINAL_CLTV: u32 = 32;
3009 fn route_payment(origin_node: &Node, expected_route: &[&Node], recv_value: u64) -> ([u8; 32], [u8; 32]) {
3010 let route = origin_node.router.get_route(&expected_route.last().unwrap().node.get_our_node_id(), None, &Vec::new(), recv_value, TEST_FINAL_CLTV).unwrap();
3011 assert_eq!(route.hops.len(), expected_route.len());
3012 for (node, hop) in expected_route.iter().zip(route.hops.iter()) {
3013 assert_eq!(hop.pubkey, node.node.get_our_node_id());
3016 send_along_route(origin_node, route, expected_route, recv_value)
3019 fn route_over_limit(origin_node: &Node, expected_route: &[&Node], recv_value: u64) {
3020 let route = origin_node.router.get_route(&expected_route.last().unwrap().node.get_our_node_id(), None, &Vec::new(), recv_value, TEST_FINAL_CLTV).unwrap();
3021 assert_eq!(route.hops.len(), expected_route.len());
3022 for (node, hop) in expected_route.iter().zip(route.hops.iter()) {
3023 assert_eq!(hop.pubkey, node.node.get_our_node_id());
3026 let (_, our_payment_hash) = get_payment_preimage_hash!(origin_node);
3028 let err = origin_node.node.send_payment(route, our_payment_hash).err().unwrap();
3030 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over our max HTLC value in flight"),
3031 _ => panic!("Unknown error variants"),
3035 fn send_payment(origin: &Node, expected_route: &[&Node], recv_value: u64) {
3036 let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
3037 claim_payment(&origin, expected_route, our_payment_preimage);
3040 fn fail_payment_along_route(origin_node: &Node, expected_route: &[&Node], skip_last: bool, our_payment_hash: [u8; 32]) {
3041 assert!(expected_route.last().unwrap().node.fail_htlc_backwards(&our_payment_hash));
3042 check_added_monitors!(expected_route.last().unwrap(), 1);
3044 let mut next_msgs: Option<(msgs::UpdateFailHTLC, msgs::CommitmentSigned)> = None;
3045 macro_rules! update_fail_dance {
3046 ($node: expr, $prev_node: expr, $last_node: expr) => {
3048 $node.node.handle_update_fail_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0).unwrap();
3049 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, !$last_node);
3054 let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
3055 let mut prev_node = expected_route.last().unwrap();
3056 for (idx, node) in expected_route.iter().rev().enumerate() {
3057 assert_eq!(expected_next_node, node.node.get_our_node_id());
3058 if next_msgs.is_some() {
3059 // We may be the "last node" for the purpose of the commitment dance if we're
3060 // skipping the last node (implying it is disconnected) and we're the
3061 // second-to-last node!
3062 update_fail_dance!(node, prev_node, skip_last && idx == expected_route.len() - 1);
3065 let events = node.node.get_and_clear_pending_events();
3066 if !skip_last || idx != expected_route.len() - 1 {
3067 assert_eq!(events.len(), 1);
3069 Event::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, ref update_fee, ref commitment_signed } } => {
3070 assert!(update_add_htlcs.is_empty());
3071 assert!(update_fulfill_htlcs.is_empty());
3072 assert_eq!(update_fail_htlcs.len(), 1);
3073 assert!(update_fail_malformed_htlcs.is_empty());
3074 assert!(update_fee.is_none());
3075 expected_next_node = node_id.clone();
3076 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
3078 _ => panic!("Unexpected event"),
3081 assert!(events.is_empty());
3083 if !skip_last && idx == expected_route.len() - 1 {
3084 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
3091 update_fail_dance!(origin_node, expected_route.first().unwrap(), true);
3093 let events = origin_node.node.get_and_clear_pending_events();
3094 assert_eq!(events.len(), 1);
3096 Event::PaymentFailed { payment_hash } => {
3097 assert_eq!(payment_hash, our_payment_hash);
3099 _ => panic!("Unexpected event"),
3104 fn fail_payment(origin_node: &Node, expected_route: &[&Node], our_payment_hash: [u8; 32]) {
3105 fail_payment_along_route(origin_node, expected_route, false, our_payment_hash);
3108 fn create_network(node_count: usize) -> Vec<Node> {
3109 let mut nodes = Vec::new();
3110 let mut rng = thread_rng();
3111 let secp_ctx = Secp256k1::new();
3112 let logger: Arc<Logger> = Arc::new(test_utils::TestLogger::new());
3114 let chan_count = Rc::new(RefCell::new(0));
3115 let payment_count = Rc::new(RefCell::new(0));
3117 for _ in 0..node_count {
3118 let feeest = Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 });
3119 let chain_monitor = Arc::new(chaininterface::ChainWatchInterfaceUtil::new(Network::Testnet, Arc::clone(&logger)));
3120 let tx_broadcaster = Arc::new(test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())});
3121 let chan_monitor = Arc::new(test_utils::TestChannelMonitor::new(chain_monitor.clone(), tx_broadcaster.clone()));
3123 let mut key_slice = [0; 32];
3124 rng.fill_bytes(&mut key_slice);
3125 SecretKey::from_slice(&secp_ctx, &key_slice).unwrap()
3127 let node = ChannelManager::new(node_id.clone(), 0, true, Network::Testnet, feeest.clone(), chan_monitor.clone(), chain_monitor.clone(), tx_broadcaster.clone(), Arc::clone(&logger)).unwrap();
3128 let router = Router::new(PublicKey::from_secret_key(&secp_ctx, &node_id), chain_monitor.clone(), Arc::clone(&logger));
3129 nodes.push(Node { chain_monitor, tx_broadcaster, chan_monitor, node, router,
3130 network_payment_count: payment_count.clone(),
3131 network_chan_count: chan_count.clone(),
3139 fn test_async_inbound_update_fee() {
3140 let mut nodes = create_network(2);
3141 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
3142 let channel_id = chan.2;
3144 macro_rules! get_feerate {
3146 let chan_lock = $node.node.channel_state.lock().unwrap();
3147 let chan = chan_lock.by_id.get(&channel_id).unwrap();
3153 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
3157 // send (1) commitment_signed -.
3158 // <- update_add_htlc/commitment_signed
3159 // send (2) RAA (awaiting remote revoke) -.
3160 // (1) commitment_signed is delivered ->
3161 // .- send (3) RAA (awaiting remote revoke)
3162 // (2) RAA is delivered ->
3163 // .- send (4) commitment_signed
3164 // <- (3) RAA is delivered
3165 // send (5) commitment_signed -.
3166 // <- (4) commitment_signed is delivered
3168 // (5) commitment_signed is delivered ->
3170 // (6) RAA is delivered ->
3172 // First nodes[0] generates an update_fee
3173 nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0]) + 20).unwrap();
3174 check_added_monitors!(nodes[0], 1);
3176 let events_0 = nodes[0].node.get_and_clear_pending_events();
3177 assert_eq!(events_0.len(), 1);
3178 let (update_msg, commitment_signed) = match events_0[0] { // (1)
3179 Event::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
3180 (update_fee.as_ref(), commitment_signed)
3182 _ => panic!("Unexpected event"),
3185 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
3187 // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
3188 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3189 nodes[1].node.send_payment(nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 40000, TEST_FINAL_CLTV).unwrap(), our_payment_hash).unwrap();
3190 check_added_monitors!(nodes[1], 1);
3192 let payment_event = {
3193 let mut events_1 = nodes[1].node.get_and_clear_pending_events();
3194 assert_eq!(events_1.len(), 1);
3195 SendEvent::from_event(events_1.remove(0))
3197 assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
3198 assert_eq!(payment_event.msgs.len(), 1);
3200 // ...now when the messages get delivered everyone should be happy
3201 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
3202 let (as_revoke_msg, as_commitment_signed) = nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg).unwrap(); // (2)
3203 assert!(as_commitment_signed.is_none()); // nodes[0] is awaiting nodes[1] revoke_and_ack
3204 check_added_monitors!(nodes[0], 1);
3206 // deliver(1), generate (3):
3207 let (bs_revoke_msg, bs_commitment_signed) = nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
3208 assert!(bs_commitment_signed.is_none()); // nodes[1] is awaiting nodes[0] revoke_and_ack
3209 check_added_monitors!(nodes[1], 1);
3211 let bs_update = nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg).unwrap(); // deliver (2)
3212 assert!(bs_update.as_ref().unwrap().update_add_htlcs.is_empty()); // (4)
3213 assert!(bs_update.as_ref().unwrap().update_fulfill_htlcs.is_empty()); // (4)
3214 assert!(bs_update.as_ref().unwrap().update_fail_htlcs.is_empty()); // (4)
3215 assert!(bs_update.as_ref().unwrap().update_fail_malformed_htlcs.is_empty()); // (4)
3216 assert!(bs_update.as_ref().unwrap().update_fee.is_none()); // (4)
3217 check_added_monitors!(nodes[1], 1);
3219 let as_update = nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg).unwrap(); // deliver (3)
3220 assert!(as_update.as_ref().unwrap().update_add_htlcs.is_empty()); // (5)
3221 assert!(as_update.as_ref().unwrap().update_fulfill_htlcs.is_empty()); // (5)
3222 assert!(as_update.as_ref().unwrap().update_fail_htlcs.is_empty()); // (5)
3223 assert!(as_update.as_ref().unwrap().update_fail_malformed_htlcs.is_empty()); // (5)
3224 assert!(as_update.as_ref().unwrap().update_fee.is_none()); // (5)
3225 check_added_monitors!(nodes[0], 1);
3227 let (as_second_revoke, as_second_commitment_signed) = nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.unwrap().commitment_signed).unwrap(); // deliver (4)
3228 assert!(as_second_commitment_signed.is_none()); // only (6)
3229 check_added_monitors!(nodes[0], 1);
3231 let (bs_second_revoke, bs_second_commitment_signed) = nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.unwrap().commitment_signed).unwrap(); // deliver (5)
3232 assert!(bs_second_commitment_signed.is_none());
3233 check_added_monitors!(nodes[1], 1);
3235 assert!(nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke).unwrap().is_none());
3236 check_added_monitors!(nodes[0], 1);
3238 let events_2 = nodes[0].node.get_and_clear_pending_events();
3239 assert_eq!(events_2.len(), 1);
3241 Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
3242 _ => panic!("Unexpected event"),
3245 assert!(nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke).unwrap().is_none()); // deliver (6)
3246 check_added_monitors!(nodes[1], 1);
3250 fn test_update_fee_unordered_raa() {
3251 // Just the intro to the previous test followed by an out-of-order RAA (which caused a
3252 // crash in an earlier version of the update_fee patch)
3253 let mut nodes = create_network(2);
3254 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
3255 let channel_id = chan.2;
3257 macro_rules! get_feerate {
3259 let chan_lock = $node.node.channel_state.lock().unwrap();
3260 let chan = chan_lock.by_id.get(&channel_id).unwrap();
3266 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
3268 // First nodes[0] generates an update_fee
3269 nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0]) + 20).unwrap();
3270 check_added_monitors!(nodes[0], 1);
3272 let events_0 = nodes[0].node.get_and_clear_pending_events();
3273 assert_eq!(events_0.len(), 1);
3274 let update_msg = match events_0[0] { // (1)
3275 Event::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
3278 _ => panic!("Unexpected event"),
3281 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
3283 // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
3284 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3285 nodes[1].node.send_payment(nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 40000, TEST_FINAL_CLTV).unwrap(), our_payment_hash).unwrap();
3286 check_added_monitors!(nodes[1], 1);
3288 let payment_event = {
3289 let mut events_1 = nodes[1].node.get_and_clear_pending_events();
3290 assert_eq!(events_1.len(), 1);
3291 SendEvent::from_event(events_1.remove(0))
3293 assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
3294 assert_eq!(payment_event.msgs.len(), 1);
3296 // ...now when the messages get delivered everyone should be happy
3297 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
3298 let (as_revoke_msg, as_commitment_signed) = nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg).unwrap(); // (2)
3299 assert!(as_commitment_signed.is_none()); // nodes[0] is awaiting nodes[1] revoke_and_ack
3300 check_added_monitors!(nodes[0], 1);
3302 assert!(nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg).unwrap().is_none()); // deliver (2)
3303 check_added_monitors!(nodes[1], 1);
3305 // We can't continue, sadly, because our (1) now has a bogus signature
3309 fn test_multi_flight_update_fee() {
3310 let nodes = create_network(2);
3311 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
3312 let channel_id = chan.2;
3314 macro_rules! get_feerate {
3316 let chan_lock = $node.node.channel_state.lock().unwrap();
3317 let chan = chan_lock.by_id.get(&channel_id).unwrap();
3323 // update_fee/commitment_signed ->
3324 // .- send (1) RAA and (2) commitment_signed
3325 // update_fee (never committed) ->
3326 // (3) update_fee ->
3327 // We have to manually generate the above update_fee, it is allowed by the protocol but we
3328 // don't track which updates correspond to which revoke_and_ack responses so we're in
3329 // AwaitingRAA mode and will not generate the update_fee yet.
3330 // <- (1) RAA delivered
3331 // (3) is generated and send (4) CS -.
3332 // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
3333 // know the per_commitment_point to use for it.
3334 // <- (2) commitment_signed delivered
3335 // revoke_and_ack ->
3336 // B should send no response here
3337 // (4) commitment_signed delivered ->
3338 // <- RAA/commitment_signed delivered
3339 // revoke_and_ack ->
3341 // First nodes[0] generates an update_fee
3342 let initial_feerate = get_feerate!(nodes[0]);
3343 nodes[0].node.update_fee(channel_id, initial_feerate + 20).unwrap();
3344 check_added_monitors!(nodes[0], 1);
3346 let events_0 = nodes[0].node.get_and_clear_pending_events();
3347 assert_eq!(events_0.len(), 1);
3348 let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
3349 Event::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
3350 (update_fee.as_ref().unwrap(), commitment_signed)
3352 _ => panic!("Unexpected event"),
3355 // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
3356 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1).unwrap();
3357 let (bs_revoke_msg, bs_commitment_signed) = nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1).unwrap();
3358 check_added_monitors!(nodes[1], 1);
3360 // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
3362 nodes[0].node.update_fee(channel_id, initial_feerate + 40).unwrap();
3363 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
3365 // Create the (3) update_fee message that nodes[0] will generate before it does...
3366 let mut update_msg_2 = msgs::UpdateFee {
3367 channel_id: update_msg_1.channel_id.clone(),
3368 feerate_per_kw: (initial_feerate + 30) as u32,
3371 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2).unwrap();
3373 update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
3375 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2).unwrap();
3377 // Deliver (1), generating (3) and (4)
3378 let as_second_update = nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg).unwrap();
3379 check_added_monitors!(nodes[0], 1);
3380 assert!(as_second_update.as_ref().unwrap().update_add_htlcs.is_empty());
3381 assert!(as_second_update.as_ref().unwrap().update_fulfill_htlcs.is_empty());
3382 assert!(as_second_update.as_ref().unwrap().update_fail_htlcs.is_empty());
3383 assert!(as_second_update.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
3384 // Check that the update_fee newly generated matches what we delivered:
3385 assert_eq!(as_second_update.as_ref().unwrap().update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
3386 assert_eq!(as_second_update.as_ref().unwrap().update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
3388 // Deliver (2) commitment_signed
3389 let (as_revoke_msg, as_commitment_signed) = nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), bs_commitment_signed.as_ref().unwrap()).unwrap();
3390 check_added_monitors!(nodes[0], 1);
3391 assert!(as_commitment_signed.is_none());
3393 assert!(nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg).unwrap().is_none());
3394 check_added_monitors!(nodes[1], 1);
3397 let (bs_second_revoke, bs_second_commitment) = nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.unwrap().commitment_signed).unwrap();
3398 check_added_monitors!(nodes[1], 1);
3400 assert!(nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke).unwrap().is_none());
3401 check_added_monitors!(nodes[0], 1);
3403 let (as_second_revoke, as_second_commitment) = nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment.unwrap()).unwrap();
3404 assert!(as_second_commitment.is_none());
3405 check_added_monitors!(nodes[0], 1);
3407 assert!(nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke).unwrap().is_none());
3408 check_added_monitors!(nodes[1], 1);
3412 fn test_update_fee_vanilla() {
3413 let nodes = create_network(2);
3414 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
3415 let channel_id = chan.2;
3417 macro_rules! get_feerate {
3419 let chan_lock = $node.node.channel_state.lock().unwrap();
3420 let chan = chan_lock.by_id.get(&channel_id).unwrap();
3425 let feerate = get_feerate!(nodes[0]);
3426 nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
3428 let events_0 = nodes[0].node.get_and_clear_pending_events();
3429 assert_eq!(events_0.len(), 1);
3430 let (update_msg, commitment_signed) = match events_0[0] {
3431 Event::UpdateHTLCs { node_id:_, updates: msgs::CommitmentUpdate { update_add_htlcs:_, update_fulfill_htlcs:_, update_fail_htlcs:_, update_fail_malformed_htlcs:_, ref update_fee, ref commitment_signed } } => {
3432 (update_fee.as_ref(), commitment_signed)
3434 _ => panic!("Unexpected event"),
3436 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
3438 let (revoke_msg, commitment_signed) = nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
3439 let commitment_signed = commitment_signed.unwrap();
3440 check_added_monitors!(nodes[0], 1);
3441 check_added_monitors!(nodes[1], 1);
3443 let resp_option = nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg).unwrap();
3444 assert!(resp_option.is_none());
3445 check_added_monitors!(nodes[0], 1);
3447 let (revoke_msg, commitment_signed) = nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed).unwrap();
3448 assert!(commitment_signed.is_none());
3449 check_added_monitors!(nodes[0], 1);
3451 let resp_option = nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg).unwrap();
3452 assert!(resp_option.is_none());
3453 check_added_monitors!(nodes[1], 1);
3457 fn test_update_fee_with_fundee_update_add_htlc() {
3458 let mut nodes = create_network(2);
3459 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
3460 let channel_id = chan.2;
3462 macro_rules! get_feerate {
3464 let chan_lock = $node.node.channel_state.lock().unwrap();
3465 let chan = chan_lock.by_id.get(&channel_id).unwrap();
3471 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
3473 let feerate = get_feerate!(nodes[0]);
3474 nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
3476 let events_0 = nodes[0].node.get_and_clear_pending_events();
3477 assert_eq!(events_0.len(), 1);
3478 let (update_msg, commitment_signed) = match events_0[0] {
3479 Event::UpdateHTLCs { node_id:_, updates: msgs::CommitmentUpdate { update_add_htlcs:_, update_fulfill_htlcs:_, update_fail_htlcs:_, update_fail_malformed_htlcs:_, ref update_fee, ref commitment_signed } } => {
3480 (update_fee.as_ref(), commitment_signed)
3482 _ => panic!("Unexpected event"),
3484 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
3485 check_added_monitors!(nodes[0], 1);
3486 let (revoke_msg, commitment_signed) = nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
3487 let commitment_signed = commitment_signed.unwrap();
3488 check_added_monitors!(nodes[1], 1);
3490 let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 800000, TEST_FINAL_CLTV).unwrap();
3492 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[1]);
3494 // nothing happens since node[1] is in AwaitingRemoteRevoke
3495 nodes[1].node.send_payment(route, our_payment_hash).unwrap();
3497 let mut added_monitors = nodes[0].chan_monitor.added_monitors.lock().unwrap();
3498 assert_eq!(added_monitors.len(), 0);
3499 added_monitors.clear();
3501 let events = nodes[0].node.get_and_clear_pending_events();
3502 assert_eq!(events.len(), 0);
3503 // node[1] has nothing to do
3505 let resp_option = nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg).unwrap();
3506 assert!(resp_option.is_none());
3507 check_added_monitors!(nodes[0], 1);
3509 let (revoke_msg, commitment_signed) = nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed).unwrap();
3510 assert!(commitment_signed.is_none());
3511 check_added_monitors!(nodes[0], 1);
3512 let resp_option = nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg).unwrap();
3513 // AwaitingRemoteRevoke ends here
3515 let commitment_update = resp_option.unwrap();
3516 assert_eq!(commitment_update.update_add_htlcs.len(), 1);
3517 assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
3518 assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
3519 assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
3520 assert_eq!(commitment_update.update_fee.is_none(), true);
3522 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]).unwrap();
3523 let (revoke, commitment_signed) = nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed).unwrap();
3524 check_added_monitors!(nodes[0], 1);
3525 check_added_monitors!(nodes[1], 1);
3526 let commitment_signed = commitment_signed.unwrap();
3527 let resp_option = nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke).unwrap();
3528 check_added_monitors!(nodes[1], 1);
3529 assert!(resp_option.is_none());
3531 let (revoke, commitment_signed) = nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed).unwrap();
3532 check_added_monitors!(nodes[1], 1);
3533 assert!(commitment_signed.is_none());
3534 let resp_option = nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke).unwrap();
3535 check_added_monitors!(nodes[0], 1);
3536 assert!(resp_option.is_none());
3538 let events = nodes[0].node.get_and_clear_pending_events();
3539 assert_eq!(events.len(), 1);
3541 Event::PendingHTLCsForwardable { .. } => { },
3542 _ => panic!("Unexpected event"),
3544 nodes[0].node.channel_state.lock().unwrap().next_forward = Instant::now();
3545 nodes[0].node.process_pending_htlc_forwards();
3547 let events = nodes[0].node.get_and_clear_pending_events();
3548 assert_eq!(events.len(), 1);
3550 Event::PaymentReceived { .. } => { },
3551 _ => panic!("Unexpected event"),
3554 claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage);
3556 send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000);
3557 send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000);
3558 close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
3562 fn test_update_fee() {
3563 let nodes = create_network(2);
3564 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
3565 let channel_id = chan.2;
3567 macro_rules! get_feerate {
3569 let chan_lock = $node.node.channel_state.lock().unwrap();
3570 let chan = chan_lock.by_id.get(&channel_id).unwrap();
3576 // (1) update_fee/commitment_signed ->
3577 // <- (2) revoke_and_ack
3578 // .- send (3) commitment_signed
3579 // (4) update_fee/commitment_signed ->
3580 // .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
3581 // <- (3) commitment_signed delivered
3582 // send (6) revoke_and_ack -.
3583 // <- (5) deliver revoke_and_ack
3584 // (6) deliver revoke_and_ack ->
3585 // .- send (7) commitment_signed in response to (4)
3586 // <- (7) deliver commitment_signed
3587 // revoke_and_ack ->
3589 // Create and deliver (1)...
3590 let feerate = get_feerate!(nodes[0]);
3591 nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
3593 let events_0 = nodes[0].node.get_and_clear_pending_events();
3594 assert_eq!(events_0.len(), 1);
3595 let (update_msg, commitment_signed) = match events_0[0] {
3596 Event::UpdateHTLCs { node_id:_, updates: msgs::CommitmentUpdate { update_add_htlcs:_, update_fulfill_htlcs:_, update_fail_htlcs:_, update_fail_malformed_htlcs:_, ref update_fee, ref commitment_signed } } => {
3597 (update_fee.as_ref(), commitment_signed)
3599 _ => panic!("Unexpected event"),
3601 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
3603 // Generate (2) and (3):
3604 let (revoke_msg, commitment_signed) = nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
3605 let commitment_signed_0 = commitment_signed.unwrap();
3606 check_added_monitors!(nodes[0], 1);
3607 check_added_monitors!(nodes[1], 1);
3610 let resp_option = nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg).unwrap();
3611 assert!(resp_option.is_none());
3612 check_added_monitors!(nodes[0], 1);
3614 // Create and deliver (4)...
3615 nodes[0].node.update_fee(channel_id, feerate+30).unwrap();
3616 let events_0 = nodes[0].node.get_and_clear_pending_events();
3617 assert_eq!(events_0.len(), 1);
3618 let (update_msg, commitment_signed) = match events_0[0] {
3619 Event::UpdateHTLCs { node_id:_, updates: msgs::CommitmentUpdate { update_add_htlcs:_, update_fulfill_htlcs:_, update_fail_htlcs:_, update_fail_malformed_htlcs:_, ref update_fee, ref commitment_signed } } => {
3620 (update_fee.as_ref(), commitment_signed)
3622 _ => panic!("Unexpected event"),
3624 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
3626 let (revoke_msg, commitment_signed) = nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
3628 assert!(commitment_signed.is_none());
3629 check_added_monitors!(nodes[0], 1);
3630 check_added_monitors!(nodes[1], 1);
3632 // Handle (3), creating (6):
3633 let (revoke_msg_0, commitment_signed) = nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0).unwrap();
3634 assert!(commitment_signed.is_none());
3635 check_added_monitors!(nodes[0], 1);
3638 let resp_option = nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg).unwrap();
3639 assert!(resp_option.is_none());
3640 check_added_monitors!(nodes[0], 1);
3642 // Deliver (6), creating (7):
3643 let resp_option = nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0).unwrap();
3644 let commitment_signed = resp_option.unwrap().commitment_signed;
3645 check_added_monitors!(nodes[1], 1);
3648 let (revoke_msg, commitment_signed) = nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed).unwrap();
3649 assert!(commitment_signed.is_none());
3650 check_added_monitors!(nodes[0], 1);
3651 let resp_option = nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg).unwrap();
3652 assert!(resp_option.is_none());
3653 check_added_monitors!(nodes[1], 1);
3655 assert_eq!(get_feerate!(nodes[0]), feerate + 30);
3656 assert_eq!(get_feerate!(nodes[1]), feerate + 30);
3657 close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
3661 fn fake_network_test() {
3662 // Simple test which builds a network of ChannelManagers, connects them to each other, and
3663 // tests that payments get routed and transactions broadcast in semi-reasonable ways.
3664 let nodes = create_network(4);
3666 // Create some initial channels
3667 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
3668 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
3669 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3);
3671 // Rebalance the network a bit by relaying one payment through all the channels...
3672 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
3673 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
3674 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
3675 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
3677 // Send some more payments
3678 send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000);
3679 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000);
3680 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000);
3682 // Test failure packets
3683 let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
3684 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
3686 // Add a new channel that skips 3
3687 let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3);
3689 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000);
3690 send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000);
3691 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
3692 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
3693 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
3694 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
3695 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
3697 // Do some rebalance loop payments, simultaneously
3698 let mut hops = Vec::with_capacity(3);
3699 hops.push(RouteHop {
3700 pubkey: nodes[2].node.get_our_node_id(),
3701 short_channel_id: chan_2.0.contents.short_channel_id,
3703 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
3705 hops.push(RouteHop {
3706 pubkey: nodes[3].node.get_our_node_id(),
3707 short_channel_id: chan_3.0.contents.short_channel_id,
3709 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
3711 hops.push(RouteHop {
3712 pubkey: nodes[1].node.get_our_node_id(),
3713 short_channel_id: chan_4.0.contents.short_channel_id,
3715 cltv_expiry_delta: TEST_FINAL_CLTV,
3717 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;
3718 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;
3719 let payment_preimage_1 = send_along_route(&nodes[1], Route { hops }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
3721 let mut hops = Vec::with_capacity(3);
3722 hops.push(RouteHop {
3723 pubkey: nodes[3].node.get_our_node_id(),
3724 short_channel_id: chan_4.0.contents.short_channel_id,
3726 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
3728 hops.push(RouteHop {
3729 pubkey: nodes[2].node.get_our_node_id(),
3730 short_channel_id: chan_3.0.contents.short_channel_id,
3732 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
3734 hops.push(RouteHop {
3735 pubkey: nodes[1].node.get_our_node_id(),
3736 short_channel_id: chan_2.0.contents.short_channel_id,
3738 cltv_expiry_delta: TEST_FINAL_CLTV,
3740 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;
3741 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;
3742 let payment_hash_2 = send_along_route(&nodes[1], Route { hops }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
3744 // Claim the rebalances...
3745 fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
3746 claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1);
3748 // Add a duplicate new channel from 2 to 4
3749 let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3);
3751 // Send some payments across both channels
3752 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
3753 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
3754 let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
3756 route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
3758 //TODO: Test that routes work again here as we've been notified that the channel is full
3760 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3);
3761 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4);
3762 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5);
3764 // Close down the channels...
3765 close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
3766 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
3767 close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
3768 close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
3769 close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
3773 fn duplicate_htlc_test() {
3774 // Test that we accept duplicate payment_hash HTLCs across the network and that
3775 // claiming/failing them are all separate and don't effect each other
3776 let mut nodes = create_network(6);
3778 // Create some initial channels to route via 3 to 4/5 from 0/1/2
3779 create_announced_chan_between_nodes(&nodes, 0, 3);
3780 create_announced_chan_between_nodes(&nodes, 1, 3);
3781 create_announced_chan_between_nodes(&nodes, 2, 3);
3782 create_announced_chan_between_nodes(&nodes, 3, 4);
3783 create_announced_chan_between_nodes(&nodes, 3, 5);
3785 let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
3787 *nodes[0].network_payment_count.borrow_mut() -= 1;
3788 assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
3790 *nodes[0].network_payment_count.borrow_mut() -= 1;
3791 assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
3793 claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage);
3794 fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
3795 claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage);
3798 #[derive(PartialEq)]
3799 enum HTLCType { NONE, TIMEOUT, SUCCESS }
3800 /// Tests that the given node has broadcast transactions for the given Channel
3802 /// First checks that the latest local commitment tx has been broadcast, unless an explicit
3803 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
3804 /// broadcast and the revoked outputs were claimed.
3806 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
3807 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
3809 /// All broadcast transactions must be accounted for in one of the above three types of we'll
3811 fn test_txn_broadcast(node: &Node, chan: &(msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction), commitment_tx: Option<Transaction>, has_htlc_tx: HTLCType) -> Vec<Transaction> {
3812 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
3813 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
3815 let mut res = Vec::with_capacity(2);
3816 node_txn.retain(|tx| {
3817 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
3818 check_spends!(tx, chan.3.clone());
3819 if commitment_tx.is_none() {
3820 res.push(tx.clone());
3825 if let Some(explicit_tx) = commitment_tx {
3826 res.push(explicit_tx.clone());
3829 assert_eq!(res.len(), 1);
3831 if has_htlc_tx != HTLCType::NONE {
3832 node_txn.retain(|tx| {
3833 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
3834 check_spends!(tx, res[0].clone());
3835 if has_htlc_tx == HTLCType::TIMEOUT {
3836 assert!(tx.lock_time != 0);
3838 assert!(tx.lock_time == 0);
3840 res.push(tx.clone());
3844 assert_eq!(res.len(), 2);
3847 assert!(node_txn.is_empty());
3851 /// Tests that the given node has broadcast a claim transaction against the provided revoked
3852 /// HTLC transaction.
3853 fn test_revoked_htlc_claim_txn_broadcast(node: &Node, revoked_tx: Transaction) {
3854 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
3855 assert_eq!(node_txn.len(), 1);
3856 node_txn.retain(|tx| {
3857 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
3858 check_spends!(tx, revoked_tx.clone());
3862 assert!(node_txn.is_empty());
3865 fn check_preimage_claim(node: &Node, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
3866 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
3868 assert!(node_txn.len() >= 1);
3869 assert_eq!(node_txn[0].input.len(), 1);
3870 let mut found_prev = false;
3872 for tx in prev_txn {
3873 if node_txn[0].input[0].previous_output.txid == tx.txid() {
3874 check_spends!(node_txn[0], tx.clone());
3875 assert!(node_txn[0].input[0].witness[2].len() > 106); // must spend an htlc output
3876 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
3882 assert!(found_prev);
3884 let mut res = Vec::new();
3885 mem::swap(&mut *node_txn, &mut res);
3889 fn get_announce_close_broadcast_events(nodes: &Vec<Node>, a: usize, b: usize) {
3890 let events_1 = nodes[a].node.get_and_clear_pending_events();
3891 assert_eq!(events_1.len(), 1);
3892 let as_update = match events_1[0] {
3893 Event::BroadcastChannelUpdate { ref msg } => {
3896 _ => panic!("Unexpected event"),
3899 let events_2 = nodes[b].node.get_and_clear_pending_events();
3900 assert_eq!(events_2.len(), 1);
3901 let bs_update = match events_2[0] {
3902 Event::BroadcastChannelUpdate { ref msg } => {
3905 _ => panic!("Unexpected event"),
3909 node.router.handle_channel_update(&as_update).unwrap();
3910 node.router.handle_channel_update(&bs_update).unwrap();
3915 fn channel_reserve_test() {
3917 use std::sync::atomic::Ordering;
3918 use ln::msgs::HandleError;
3920 macro_rules! get_channel_value_stat {
3921 ($node: expr, $channel_id: expr) => {{
3922 let chan_lock = $node.node.channel_state.lock().unwrap();
3923 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
3924 chan.get_value_stat()
3928 let mut nodes = create_network(3);
3929 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1900, 1001);
3930 let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1900, 1001);
3932 let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
3933 let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
3935 let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
3936 let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
3938 macro_rules! get_route_and_payment_hash {
3939 ($recv_value: expr) => {{
3940 let route = nodes[0].router.get_route(&nodes.last().unwrap().node.get_our_node_id(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV).unwrap();
3941 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
3942 (route, payment_hash, payment_preimage)
3946 macro_rules! expect_pending_htlcs_forwardable {
3948 let events = $node.node.get_and_clear_pending_events();
3949 assert_eq!(events.len(), 1);
3951 Event::PendingHTLCsForwardable { .. } => { },
3952 _ => panic!("Unexpected event"),
3954 $node.node.channel_state.lock().unwrap().next_forward = Instant::now();
3955 $node.node.process_pending_htlc_forwards();
3959 macro_rules! expect_forward {
3961 let mut events = $node.node.get_and_clear_pending_events();
3962 assert_eq!(events.len(), 1);
3963 check_added_monitors!($node, 1);
3964 let payment_event = SendEvent::from_event(events.remove(0));
3969 macro_rules! expect_payment_received {
3970 ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
3971 let events = $node.node.get_and_clear_pending_events();
3972 assert_eq!(events.len(), 1);
3974 Event::PaymentReceived { ref payment_hash, amt } => {
3975 assert_eq!($expected_payment_hash, *payment_hash);
3976 assert_eq!($expected_recv_value, amt);
3978 _ => panic!("Unexpected event"),
3983 let feemsat = 239; // somehow we know?
3984 let total_fee_msat = (nodes.len() - 2) as u64 * 239;
3986 let recv_value_0 = stat01.their_max_htlc_value_in_flight_msat - total_fee_msat;
3988 // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
3990 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_0 + 1);
3991 assert!(route.hops.iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
3992 let err = nodes[0].node.send_payment(route, our_payment_hash).err().unwrap();
3994 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over our max HTLC value in flight"),
3995 _ => panic!("Unknown error variants"),
3999 let mut htlc_id = 0;
4000 // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
4001 // nodes[0]'s wealth
4003 let amt_msat = recv_value_0 + total_fee_msat;
4004 if stat01.value_to_self_msat - amt_msat < stat01.channel_reserve_msat {
4007 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0);
4010 let (stat01_, stat11_, stat12_, stat22_) = (
4011 get_channel_value_stat!(nodes[0], chan_1.2),
4012 get_channel_value_stat!(nodes[1], chan_1.2),
4013 get_channel_value_stat!(nodes[1], chan_2.2),
4014 get_channel_value_stat!(nodes[2], chan_2.2),
4017 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
4018 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
4019 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
4020 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
4021 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
4025 let recv_value = stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat;
4026 // attempt to get channel_reserve violation
4027 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value + 1);
4028 let err = nodes[0].node.send_payment(route.clone(), our_payment_hash).err().unwrap();
4030 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over our reserve value"),
4031 _ => panic!("Unknown error variants"),
4035 // adding pending output
4036 let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat)/2;
4037 let amt_msat_1 = recv_value_1 + total_fee_msat;
4039 let (route_1, our_payment_hash_1, our_payment_preimage_1) = get_route_and_payment_hash!(recv_value_1);
4040 let payment_event_1 = {
4041 nodes[0].node.send_payment(route_1, our_payment_hash_1).unwrap();
4042 check_added_monitors!(nodes[0], 1);
4044 let mut events = nodes[0].node.get_and_clear_pending_events();
4045 assert_eq!(events.len(), 1);
4046 SendEvent::from_event(events.remove(0))
4048 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]).unwrap();
4050 // channel reserve test with htlc pending output > 0
4051 let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat;
4053 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
4054 match nodes[0].node.send_payment(route, our_payment_hash).err().unwrap() {
4055 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over our reserve value"),
4056 _ => panic!("Unknown error variants"),
4061 // test channel_reserve test on nodes[1] side
4062 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
4064 // Need to manually create update_add_htlc message to go around the channel reserve check in send_htlc()
4065 let secp_ctx = Secp256k1::new();
4066 let session_priv = SecretKey::from_slice(&secp_ctx, &{
4067 let mut session_key = [0; 32];
4068 rng::fill_bytes(&mut session_key);
4070 }).expect("RNG is bad!");
4072 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
4073 let onion_keys = ChannelManager::construct_onion_keys(&secp_ctx, &route, &session_priv).unwrap();
4074 let (onion_payloads, htlc_msat, htlc_cltv) = ChannelManager::build_onion_payloads(&route, cur_height).unwrap();
4075 let onion_packet = ChannelManager::construct_onion_packet(onion_payloads, onion_keys, &our_payment_hash);
4076 let msg = msgs::UpdateAddHTLC {
4077 channel_id: chan_1.2,
4079 amount_msat: htlc_msat,
4080 payment_hash: our_payment_hash,
4081 cltv_expiry: htlc_cltv,
4082 onion_routing_packet: onion_packet,
4085 let err = nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg).err().unwrap();
4087 HandleError{err, .. } => assert_eq!(err, "Remote HTLC add would put them over their reserve value"),
4091 // split the rest to test holding cell
4092 let recv_value_21 = recv_value_2/2;
4093 let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat;
4095 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
4096 assert_eq!(stat.value_to_self_msat - (stat.pending_outbound_htlcs_amount_msat + recv_value_21 + recv_value_22 + total_fee_msat + total_fee_msat), stat.channel_reserve_msat);
4099 // now see if they go through on both sides
4100 let (route_21, our_payment_hash_21, our_payment_preimage_21) = get_route_and_payment_hash!(recv_value_21);
4101 // but this will stuck in the holding cell
4102 nodes[0].node.send_payment(route_21, our_payment_hash_21).unwrap();
4103 check_added_monitors!(nodes[0], 0);
4104 let events = nodes[0].node.get_and_clear_pending_events();
4105 assert_eq!(events.len(), 0);
4107 // test with outbound holding cell amount > 0
4109 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_22+1);
4110 match nodes[0].node.send_payment(route, our_payment_hash).err().unwrap() {
4111 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over our reserve value"),
4112 _ => panic!("Unknown error variants"),
4116 let (route_22, our_payment_hash_22, our_payment_preimage_22) = get_route_and_payment_hash!(recv_value_22);
4117 // this will also stuck in the holding cell
4118 nodes[0].node.send_payment(route_22, our_payment_hash_22).unwrap();
4119 check_added_monitors!(nodes[0], 0);
4120 let events = nodes[0].node.get_and_clear_pending_events();
4121 assert_eq!(events.len(), 0);
4123 // flush the pending htlc
4124 let (as_revoke_and_ack, as_commitment_signed) = nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg).unwrap();
4125 check_added_monitors!(nodes[1], 1);
4127 let commitment_update_2 = nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack).unwrap().unwrap();
4128 check_added_monitors!(nodes[0], 1);
4129 let (bs_revoke_and_ack, bs_none) = nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed.unwrap()).unwrap();
4130 assert!(bs_none.is_none());
4131 check_added_monitors!(nodes[0], 1);
4132 assert!(nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack).unwrap().is_none());
4133 check_added_monitors!(nodes[1], 1);
4135 expect_pending_htlcs_forwardable!(nodes[1]);
4137 let ref payment_event_11 = expect_forward!(nodes[1]);
4138 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]).unwrap();
4139 commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
4141 expect_pending_htlcs_forwardable!(nodes[2]);
4142 expect_payment_received!(nodes[2], our_payment_hash_1, recv_value_1);
4144 // flush the htlcs in the holding cell
4145 assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
4146 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]).unwrap();
4147 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]).unwrap();
4148 commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
4149 expect_pending_htlcs_forwardable!(nodes[1]);
4151 let ref payment_event_3 = expect_forward!(nodes[1]);
4152 assert_eq!(payment_event_3.msgs.len(), 2);
4153 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]).unwrap();
4154 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]).unwrap();
4156 commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
4157 expect_pending_htlcs_forwardable!(nodes[2]);
4159 let events = nodes[2].node.get_and_clear_pending_events();
4160 assert_eq!(events.len(), 2);
4162 Event::PaymentReceived { ref payment_hash, amt } => {
4163 assert_eq!(our_payment_hash_21, *payment_hash);
4164 assert_eq!(recv_value_21, amt);
4166 _ => panic!("Unexpected event"),
4169 Event::PaymentReceived { ref payment_hash, amt } => {
4170 assert_eq!(our_payment_hash_22, *payment_hash);
4171 assert_eq!(recv_value_22, amt);
4173 _ => panic!("Unexpected event"),
4176 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1);
4177 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21);
4178 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22);
4180 let expected_value_to_self = stat01.value_to_self_msat - (recv_value_1 + total_fee_msat) - (recv_value_21 + total_fee_msat) - (recv_value_22 + total_fee_msat);
4181 let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
4182 assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
4183 assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat);
4185 let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
4186 assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22);
4190 fn channel_monitor_network_test() {
4191 // Simple test which builds a network of ChannelManagers, connects them to each other, and
4192 // tests that ChannelMonitor is able to recover from various states.
4193 let nodes = create_network(5);
4195 // Create some initial channels
4196 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
4197 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
4198 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3);
4199 let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4);
4201 // Rebalance the network a bit by relaying one payment through all the channels...
4202 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
4203 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
4204 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
4205 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
4207 // Simple case with no pending HTLCs:
4208 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
4210 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
4211 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4212 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
4213 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
4215 get_announce_close_broadcast_events(&nodes, 0, 1);
4216 assert_eq!(nodes[0].node.list_channels().len(), 0);
4217 assert_eq!(nodes[1].node.list_channels().len(), 1);
4219 // One pending HTLC is discarded by the force-close:
4220 let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
4222 // Simple case of one pending HTLC to HTLC-Timeout
4223 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
4225 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
4226 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4227 nodes[2].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
4228 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
4230 get_announce_close_broadcast_events(&nodes, 1, 2);
4231 assert_eq!(nodes[1].node.list_channels().len(), 0);
4232 assert_eq!(nodes[2].node.list_channels().len(), 1);
4234 macro_rules! claim_funds {
4235 ($node: expr, $prev_node: expr, $preimage: expr) => {
4237 assert!($node.node.claim_funds($preimage));
4238 check_added_monitors!($node, 1);
4240 let events = $node.node.get_and_clear_pending_events();
4241 assert_eq!(events.len(), 1);
4243 Event::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
4244 assert!(update_add_htlcs.is_empty());
4245 assert!(update_fail_htlcs.is_empty());
4246 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
4248 _ => panic!("Unexpected event"),
4254 // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
4255 // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
4256 nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
4258 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
4260 // Claim the payment on nodes[3], giving it knowledge of the preimage
4261 claim_funds!(nodes[3], nodes[2], payment_preimage_1);
4263 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4264 nodes[3].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[0].clone()] }, 1);
4266 check_preimage_claim(&nodes[3], &node_txn);
4268 get_announce_close_broadcast_events(&nodes, 2, 3);
4269 assert_eq!(nodes[2].node.list_channels().len(), 0);
4270 assert_eq!(nodes[3].node.list_channels().len(), 1);
4272 // One pending HTLC to time out:
4273 let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
4276 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4277 nodes[3].chain_monitor.block_connected_checked(&header, 1, &Vec::new()[..], &[0; 0]);
4278 for i in 2..TEST_FINAL_CLTV - 3 {
4279 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4280 nodes[3].chain_monitor.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
4283 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
4285 // Claim the payment on nodes[4], giving it knowledge of the preimage
4286 claim_funds!(nodes[4], nodes[3], payment_preimage_2);
4288 header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4289 nodes[4].chain_monitor.block_connected_checked(&header, 1, &Vec::new()[..], &[0; 0]);
4290 for i in 2..TEST_FINAL_CLTV - 3 {
4291 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4292 nodes[4].chain_monitor.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
4295 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
4297 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4298 nodes[4].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[0].clone()] }, TEST_FINAL_CLTV - 5);
4300 check_preimage_claim(&nodes[4], &node_txn);
4302 get_announce_close_broadcast_events(&nodes, 3, 4);
4303 assert_eq!(nodes[3].node.list_channels().len(), 0);
4304 assert_eq!(nodes[4].node.list_channels().len(), 0);
4306 // Create some new channels:
4307 let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1);
4309 // A pending HTLC which will be revoked:
4310 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4311 // Get the will-be-revoked local txn from nodes[0]
4312 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.iter().next().unwrap().1.last_local_commitment_txn.clone();
4313 assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
4314 assert_eq!(revoked_local_txn[0].input.len(), 1);
4315 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
4316 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
4317 assert_eq!(revoked_local_txn[1].input.len(), 1);
4318 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
4319 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), 133); // HTLC-Timeout
4320 // Revoke the old state
4321 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
4324 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4325 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4327 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4328 assert_eq!(node_txn.len(), 3);
4329 assert_eq!(node_txn.pop().unwrap(), node_txn[0]); // An outpoint registration will result in a 2nd block_connected
4330 assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
4332 check_spends!(node_txn[0], revoked_local_txn[0].clone());
4333 node_txn.swap_remove(0);
4335 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
4337 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4338 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
4339 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4340 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
4341 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone());
4343 get_announce_close_broadcast_events(&nodes, 0, 1);
4344 assert_eq!(nodes[0].node.list_channels().len(), 0);
4345 assert_eq!(nodes[1].node.list_channels().len(), 0);
4349 fn revoked_output_claim() {
4350 // Simple test to ensure a node will claim a revoked output when a stale remote commitment
4351 // transaction is broadcast by its counterparty
4352 let nodes = create_network(2);
4353 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
4354 // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
4355 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
4356 assert_eq!(revoked_local_txn.len(), 1);
4357 // Only output is the full channel value back to nodes[0]:
4358 assert_eq!(revoked_local_txn[0].output.len(), 1);
4359 // Send a payment through, updating everyone's latest commitment txn
4360 send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000);
4362 // Inform nodes[1] that nodes[0] broadcast a stale tx
4363 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4364 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4365 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4366 assert_eq!(node_txn.len(), 3); // nodes[1] will broadcast justice tx twice, and its own local state once
4368 assert_eq!(node_txn[0], node_txn[2]);
4370 check_spends!(node_txn[0], revoked_local_txn[0].clone());
4371 check_spends!(node_txn[1], chan_1.3.clone());
4373 // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
4374 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4375 get_announce_close_broadcast_events(&nodes, 0, 1);
4379 fn claim_htlc_outputs_shared_tx() {
4380 // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
4381 let nodes = create_network(2);
4383 // Create some new channel:
4384 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
4386 // Rebalance the network to generate htlc in the two directions
4387 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
4388 // node[0] is gonna to revoke an old state thus node[1] should be able to claim both offered/received HTLC outputs on top of commitment tx
4389 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4390 let _payment_preimage_2 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
4392 // Get the will-be-revoked local txn from node[0]
4393 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
4394 assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
4395 assert_eq!(revoked_local_txn[0].input.len(), 1);
4396 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4397 assert_eq!(revoked_local_txn[1].input.len(), 1);
4398 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
4399 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), 133); // HTLC-Timeout
4400 check_spends!(revoked_local_txn[1], revoked_local_txn[0].clone());
4402 //Revoke the old state
4403 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
4406 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4408 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4410 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4411 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4412 assert_eq!(node_txn.len(), 4);
4414 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
4415 check_spends!(node_txn[0], revoked_local_txn[0].clone());
4417 assert_eq!(node_txn[0], node_txn[3]); // justice tx is duplicated due to block re-scanning
4419 let mut witness_lens = BTreeSet::new();
4420 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
4421 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
4422 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
4423 assert_eq!(witness_lens.len(), 3);
4424 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
4425 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), 133); // revoked offered HTLC
4426 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), 138); // revoked received HTLC
4428 // Next nodes[1] broadcasts its current local tx state:
4429 assert_eq!(node_txn[1].input.len(), 1);
4430 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
4432 assert_eq!(node_txn[2].input.len(), 1);
4433 let witness_script = node_txn[2].clone().input[0].witness.pop().unwrap();
4434 assert_eq!(witness_script.len(), 133); //Spending an offered htlc output
4435 assert_eq!(node_txn[2].input[0].previous_output.txid, node_txn[1].txid());
4436 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
4437 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[1].previous_output.txid);
4439 get_announce_close_broadcast_events(&nodes, 0, 1);
4440 assert_eq!(nodes[0].node.list_channels().len(), 0);
4441 assert_eq!(nodes[1].node.list_channels().len(), 0);
4445 fn claim_htlc_outputs_single_tx() {
4446 // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
4447 let nodes = create_network(2);
4449 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
4451 // Rebalance the network to generate htlc in the two directions
4452 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
4453 // node[0] is gonna to revoke an old state thus node[1] should be able to claim both offered/received HTLC outputs on top of commitment tx, but this
4454 // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
4455 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4456 let _payment_preimage_2 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
4458 // Get the will-be-revoked local txn from node[0]
4459 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
4461 //Revoke the old state
4462 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
4465 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4467 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
4469 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
4470 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4471 assert_eq!(node_txn.len(), 12); // ChannelManager : 2, ChannelMontitor: 8 (1 standard revoked output, 2 revocation htlc tx, 1 local commitment tx + 1 htlc timeout tx) * 2 (block-rescan)
4473 assert_eq!(node_txn[0], node_txn[7]);
4474 assert_eq!(node_txn[1], node_txn[8]);
4475 assert_eq!(node_txn[2], node_txn[9]);
4476 assert_eq!(node_txn[3], node_txn[10]);
4477 assert_eq!(node_txn[4], node_txn[11]);
4478 assert_eq!(node_txn[3], node_txn[5]); //local commitment tx + htlc timeout tx broadcated by ChannelManger
4479 assert_eq!(node_txn[4], node_txn[6]);
4481 assert_eq!(node_txn[0].input.len(), 1);
4482 assert_eq!(node_txn[1].input.len(), 1);
4483 assert_eq!(node_txn[2].input.len(), 1);
4485 let mut revoked_tx_map = HashMap::new();
4486 revoked_tx_map.insert(revoked_local_txn[0].txid(), revoked_local_txn[0].clone());
4487 node_txn[0].verify(&revoked_tx_map).unwrap();
4488 node_txn[1].verify(&revoked_tx_map).unwrap();
4489 node_txn[2].verify(&revoked_tx_map).unwrap();
4491 let mut witness_lens = BTreeSet::new();
4492 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
4493 witness_lens.insert(node_txn[1].input[0].witness.last().unwrap().len());
4494 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
4495 assert_eq!(witness_lens.len(), 3);
4496 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
4497 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), 133); // revoked offered HTLC
4498 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), 138); // revoked received HTLC
4500 assert_eq!(node_txn[3].input.len(), 1);
4501 check_spends!(node_txn[3], chan_1.3.clone());
4503 assert_eq!(node_txn[4].input.len(), 1);
4504 let witness_script = node_txn[4].input[0].witness.last().unwrap();
4505 assert_eq!(witness_script.len(), 133); //Spending an offered htlc output
4506 assert_eq!(node_txn[4].input[0].previous_output.txid, node_txn[3].txid());
4507 assert_ne!(node_txn[4].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
4508 assert_ne!(node_txn[4].input[0].previous_output.txid, node_txn[1].input[0].previous_output.txid);
4510 get_announce_close_broadcast_events(&nodes, 0, 1);
4511 assert_eq!(nodes[0].node.list_channels().len(), 0);
4512 assert_eq!(nodes[1].node.list_channels().len(), 0);
4516 fn test_htlc_ignore_latest_remote_commitment() {
4517 // Test that HTLC transactions spending the latest remote commitment transaction are simply
4518 // ignored if we cannot claim them. This originally tickled an invalid unwrap().
4519 let nodes = create_network(2);
4520 create_announced_chan_between_nodes(&nodes, 0, 1);
4522 route_payment(&nodes[0], &[&nodes[1]], 10000000);
4523 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id);
4525 let events = nodes[0].node.get_and_clear_pending_events();
4526 assert_eq!(events.len(), 1);
4528 Event::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { contents: msgs::UnsignedChannelUpdate { flags, .. }, .. } } => {
4529 assert_eq!(flags & 0b10, 0b10);
4531 _ => panic!("Unexpected event"),
4535 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4536 assert_eq!(node_txn.len(), 2);
4538 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4539 nodes[1].chain_monitor.block_connected_checked(&header, 1, &[&node_txn[0], &node_txn[1]], &[1; 2]);
4542 let events = nodes[1].node.get_and_clear_pending_events();
4543 assert_eq!(events.len(), 1);
4545 Event::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { contents: msgs::UnsignedChannelUpdate { flags, .. }, .. } } => {
4546 assert_eq!(flags & 0b10, 0b10);
4548 _ => panic!("Unexpected event"),
4552 // Duplicate the block_connected call since this may happen due to other listeners
4553 // registering new transactions
4554 nodes[1].chain_monitor.block_connected_checked(&header, 1, &[&node_txn[0], &node_txn[1]], &[1; 2]);
4558 fn test_force_close_fail_back() {
4559 // Check which HTLCs are failed-backwards on channel force-closure
4560 let mut nodes = create_network(3);
4561 create_announced_chan_between_nodes(&nodes, 0, 1);
4562 create_announced_chan_between_nodes(&nodes, 1, 2);
4564 let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, 42).unwrap();
4566 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4568 let mut payment_event = {
4569 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
4570 check_added_monitors!(nodes[0], 1);
4572 let mut events = nodes[0].node.get_and_clear_pending_events();
4573 assert_eq!(events.len(), 1);
4574 SendEvent::from_event(events.remove(0))
4577 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
4578 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
4580 let events_1 = nodes[1].node.get_and_clear_pending_events();
4581 assert_eq!(events_1.len(), 1);
4583 Event::PendingHTLCsForwardable { .. } => { },
4584 _ => panic!("Unexpected event"),
4587 nodes[1].node.channel_state.lock().unwrap().next_forward = Instant::now();
4588 nodes[1].node.process_pending_htlc_forwards();
4590 let mut events_2 = nodes[1].node.get_and_clear_pending_events();
4591 assert_eq!(events_2.len(), 1);
4592 payment_event = SendEvent::from_event(events_2.remove(0));
4593 assert_eq!(payment_event.msgs.len(), 1);
4595 check_added_monitors!(nodes[1], 1);
4596 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
4597 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg).unwrap();
4598 check_added_monitors!(nodes[2], 1);
4600 // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
4601 // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
4602 // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
4604 nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id);
4605 let events_3 = nodes[2].node.get_and_clear_pending_events();
4606 assert_eq!(events_3.len(), 1);
4608 Event::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { contents: msgs::UnsignedChannelUpdate { flags, .. }, .. } } => {
4609 assert_eq!(flags & 0b10, 0b10);
4611 _ => panic!("Unexpected event"),
4615 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
4616 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
4617 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
4618 // back to nodes[1] upon timeout otherwise.
4619 assert_eq!(node_txn.len(), 1);
4623 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4624 nodes[1].chain_monitor.block_connected_checked(&header, 1, &[&tx], &[1]);
4626 let events_4 = nodes[1].node.get_and_clear_pending_events();
4627 // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
4628 assert_eq!(events_4.len(), 1);
4630 Event::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { contents: msgs::UnsignedChannelUpdate { flags, .. }, .. } } => {
4631 assert_eq!(flags & 0b10, 0b10);
4633 _ => panic!("Unexpected event"),
4636 // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
4638 let mut monitors = nodes[2].chan_monitor.simple_monitor.monitors.lock().unwrap();
4639 monitors.get_mut(&OutPoint::new(Sha256dHash::from(&payment_event.commitment_msg.channel_id[..]), 0)).unwrap()
4640 .provide_payment_preimage(&our_payment_hash, &our_payment_preimage);
4642 nodes[2].chain_monitor.block_connected_checked(&header, 1, &[&tx], &[1]);
4643 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
4644 assert_eq!(node_txn.len(), 1);
4645 assert_eq!(node_txn[0].input.len(), 1);
4646 assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
4647 assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
4648 assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
4650 check_spends!(node_txn[0], tx);
4654 fn test_unconf_chan() {
4655 // After creating a chan between nodes, we disconnect all blocks previously seen to force a channel close on nodes[0] side
4656 let nodes = create_network(2);
4657 create_announced_chan_between_nodes(&nodes, 0, 1);
4659 let channel_state = nodes[0].node.channel_state.lock().unwrap();
4660 assert_eq!(channel_state.by_id.len(), 1);
4661 assert_eq!(channel_state.short_to_id.len(), 1);
4662 mem::drop(channel_state);
4664 let mut headers = Vec::new();
4665 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4666 headers.push(header.clone());
4668 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4669 headers.push(header.clone());
4671 while !headers.is_empty() {
4672 nodes[0].node.block_disconnected(&headers.pop().unwrap());
4675 let events = nodes[0].node.get_and_clear_pending_events();
4676 assert_eq!(events.len(), 1);
4678 Event::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { contents: msgs::UnsignedChannelUpdate { flags, .. }, .. } } => {
4679 assert_eq!(flags & 0b10, 0b10);
4681 _ => panic!("Unexpected event"),
4684 let channel_state = nodes[0].node.channel_state.lock().unwrap();
4685 assert_eq!(channel_state.by_id.len(), 0);
4686 assert_eq!(channel_state.short_to_id.len(), 0);
4689 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
4690 /// for claims/fails they are separated out.
4691 fn reconnect_nodes(node_a: &Node, node_b: &Node, pre_all_htlcs: bool, pending_htlc_adds: (i64, i64), pending_htlc_claims: (usize, usize), pending_cell_htlc_claims: (usize, usize), pending_cell_htlc_fails: (usize, usize), pending_raa: (bool, bool)) {
4692 let reestablish_1 = node_a.node.peer_connected(&node_b.node.get_our_node_id());
4693 let reestablish_2 = node_b.node.peer_connected(&node_a.node.get_our_node_id());
4695 let mut resp_1 = Vec::new();
4696 for msg in reestablish_1 {
4697 resp_1.push(node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg).unwrap());
4699 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
4700 check_added_monitors!(node_b, 1);
4702 check_added_monitors!(node_b, 0);
4705 let mut resp_2 = Vec::new();
4706 for msg in reestablish_2 {
4707 resp_2.push(node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg).unwrap());
4709 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
4710 check_added_monitors!(node_a, 1);
4712 check_added_monitors!(node_a, 0);
4715 // We dont yet support both needing updates, as that would require a different commitment dance:
4716 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
4717 (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
4719 for chan_msgs in resp_1.drain(..) {
4721 let a = node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
4722 let _announcement_sigs_opt = a.unwrap();
4723 //TODO: Test announcement_sigs re-sending when we've implemented it
4725 assert!(chan_msgs.0.is_none());
4728 assert!(node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap()).unwrap().is_none());
4729 check_added_monitors!(node_a, 1);
4731 assert!(chan_msgs.1.is_none());
4733 if pending_htlc_adds.0 != 0 || pending_htlc_claims.0 != 0 || pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
4734 let commitment_update = chan_msgs.2.unwrap();
4735 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
4736 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
4738 assert!(commitment_update.update_add_htlcs.is_empty());
4740 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
4741 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
4742 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
4743 for update_add in commitment_update.update_add_htlcs {
4744 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add).unwrap();
4746 for update_fulfill in commitment_update.update_fulfill_htlcs {
4747 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill).unwrap();
4749 for update_fail in commitment_update.update_fail_htlcs {
4750 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail).unwrap();
4753 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
4754 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
4756 let (as_revoke_and_ack, as_commitment_signed) = node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed).unwrap();
4757 check_added_monitors!(node_a, 1);
4758 assert!(as_commitment_signed.is_none());
4759 assert!(node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack).unwrap().is_none());
4760 check_added_monitors!(node_b, 1);
4763 assert!(chan_msgs.2.is_none());
4767 for chan_msgs in resp_2.drain(..) {
4769 let _announcement_sigs_opt = node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap()).unwrap();
4770 //TODO: Test announcement_sigs re-sending when we've implemented it
4772 assert!(chan_msgs.0.is_none());
4775 assert!(node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap()).unwrap().is_none());
4776 check_added_monitors!(node_b, 1);
4778 assert!(chan_msgs.1.is_none());
4780 if pending_htlc_adds.1 != 0 || pending_htlc_claims.1 != 0 || pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
4781 let commitment_update = chan_msgs.2.unwrap();
4782 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
4783 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
4785 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
4786 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
4787 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
4788 for update_add in commitment_update.update_add_htlcs {
4789 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add).unwrap();
4791 for update_fulfill in commitment_update.update_fulfill_htlcs {
4792 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill).unwrap();
4794 for update_fail in commitment_update.update_fail_htlcs {
4795 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail).unwrap();
4798 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
4799 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
4801 let (bs_revoke_and_ack, bs_commitment_signed) = node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed).unwrap();
4802 check_added_monitors!(node_b, 1);
4803 assert!(bs_commitment_signed.is_none());
4804 assert!(node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack).unwrap().is_none());
4805 check_added_monitors!(node_a, 1);
4808 assert!(chan_msgs.2.is_none());
4814 fn test_simple_peer_disconnect() {
4815 // Test that we can reconnect when there are no lost messages
4816 let nodes = create_network(3);
4817 create_announced_chan_between_nodes(&nodes, 0, 1);
4818 create_announced_chan_between_nodes(&nodes, 1, 2);
4820 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4821 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4822 reconnect_nodes(&nodes[0], &nodes[1], true, (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4824 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
4825 let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
4826 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
4827 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1);
4829 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4830 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4831 reconnect_nodes(&nodes[0], &nodes[1], false, (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4833 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
4834 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
4835 let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
4836 let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
4838 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4839 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4841 claim_payment_along_route(&nodes[0], &vec!(&nodes[1], &nodes[2]), true, payment_preimage_3);
4842 fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
4844 reconnect_nodes(&nodes[0], &nodes[1], false, (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
4846 let events = nodes[0].node.get_and_clear_pending_events();
4847 assert_eq!(events.len(), 2);
4849 Event::PaymentSent { payment_preimage } => {
4850 assert_eq!(payment_preimage, payment_preimage_3);
4852 _ => panic!("Unexpected event"),
4855 Event::PaymentFailed { payment_hash } => {
4856 assert_eq!(payment_hash, payment_hash_5);
4858 _ => panic!("Unexpected event"),
4862 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4);
4863 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
4866 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
4867 // Test that we can reconnect when in-flight HTLC updates get dropped
4868 let mut nodes = create_network(2);
4869 if messages_delivered == 0 {
4870 create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001);
4871 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
4873 create_announced_chan_between_nodes(&nodes, 0, 1);
4876 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), Some(&nodes[0].node.list_usable_channels()), &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4877 let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
4879 let payment_event = {
4880 nodes[0].node.send_payment(route.clone(), payment_hash_1).unwrap();
4881 check_added_monitors!(nodes[0], 1);
4883 let mut events = nodes[0].node.get_and_clear_pending_events();
4884 assert_eq!(events.len(), 1);
4885 SendEvent::from_event(events.remove(0))
4887 assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
4889 if messages_delivered < 2 {
4890 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
4892 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
4893 let (bs_revoke_and_ack, bs_commitment_signed) = nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg).unwrap();
4894 check_added_monitors!(nodes[1], 1);
4896 if messages_delivered >= 3 {
4897 assert!(nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap().is_none());
4898 check_added_monitors!(nodes[0], 1);
4900 if messages_delivered >= 4 {
4901 let (as_revoke_and_ack, as_commitment_signed) = nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed.unwrap()).unwrap();
4902 assert!(as_commitment_signed.is_none());
4903 check_added_monitors!(nodes[0], 1);
4905 if messages_delivered >= 5 {
4906 assert!(nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap().is_none());
4907 check_added_monitors!(nodes[1], 1);
4913 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4914 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4915 if messages_delivered < 2 {
4916 // Even if the funding_locked messages get exchanged, as long as nothing further was
4917 // received on either side, both sides will need to resend them.
4918 reconnect_nodes(&nodes[0], &nodes[1], true, (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
4919 } else if messages_delivered == 2 {
4920 // nodes[0] still wants its RAA + commitment_signed
4921 reconnect_nodes(&nodes[0], &nodes[1], false, (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
4922 } else if messages_delivered == 3 {
4923 // nodes[0] still wants its commitment_signed
4924 reconnect_nodes(&nodes[0], &nodes[1], false, (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
4925 } else if messages_delivered == 4 {
4926 // nodes[1] still wants its final RAA
4927 reconnect_nodes(&nodes[0], &nodes[1], false, (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
4928 } else if messages_delivered == 5 {
4929 // Everything was delivered...
4930 reconnect_nodes(&nodes[0], &nodes[1], false, (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4933 let events_1 = nodes[1].node.get_and_clear_pending_events();
4934 assert_eq!(events_1.len(), 1);
4936 Event::PendingHTLCsForwardable { .. } => { },
4937 _ => panic!("Unexpected event"),
4940 nodes[1].node.channel_state.lock().unwrap().next_forward = Instant::now();
4941 nodes[1].node.process_pending_htlc_forwards();
4943 let events_2 = nodes[1].node.get_and_clear_pending_events();
4944 assert_eq!(events_2.len(), 1);
4946 Event::PaymentReceived { ref payment_hash, amt } => {
4947 assert_eq!(payment_hash_1, *payment_hash);
4948 assert_eq!(amt, 1000000);
4950 _ => panic!("Unexpected event"),
4953 nodes[1].node.claim_funds(payment_preimage_1);
4954 check_added_monitors!(nodes[1], 1);
4956 let events_3 = nodes[1].node.get_and_clear_pending_events();
4957 assert_eq!(events_3.len(), 1);
4958 let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
4959 Event::UpdateHTLCs { ref node_id, ref updates } => {
4960 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
4961 assert!(updates.update_add_htlcs.is_empty());
4962 assert!(updates.update_fail_htlcs.is_empty());
4963 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4964 assert!(updates.update_fail_malformed_htlcs.is_empty());
4965 assert!(updates.update_fee.is_none());
4966 (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
4968 _ => panic!("Unexpected event"),
4971 if messages_delivered >= 1 {
4972 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc).unwrap();
4974 let events_4 = nodes[0].node.get_and_clear_pending_events();
4975 assert_eq!(events_4.len(), 1);
4977 Event::PaymentSent { ref payment_preimage } => {
4978 assert_eq!(payment_preimage_1, *payment_preimage);
4980 _ => panic!("Unexpected event"),
4983 if messages_delivered >= 2 {
4984 let (as_revoke_and_ack, as_commitment_signed) = nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed).unwrap();
4985 check_added_monitors!(nodes[0], 1);
4987 if messages_delivered >= 3 {
4988 assert!(nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap().is_none());
4989 check_added_monitors!(nodes[1], 1);
4991 if messages_delivered >= 4 {
4992 let (bs_revoke_and_ack, bs_commitment_signed) = nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.unwrap()).unwrap();
4993 assert!(bs_commitment_signed.is_none());
4994 check_added_monitors!(nodes[1], 1);
4996 if messages_delivered >= 5 {
4997 assert!(nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap().is_none());
4998 check_added_monitors!(nodes[0], 1);
5005 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5006 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5007 if messages_delivered < 2 {
5008 reconnect_nodes(&nodes[0], &nodes[1], false, (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
5009 //TODO: Deduplicate PaymentSent events, then enable this if:
5010 //if messages_delivered < 1 {
5011 let events_4 = nodes[0].node.get_and_clear_pending_events();
5012 assert_eq!(events_4.len(), 1);
5014 Event::PaymentSent { ref payment_preimage } => {
5015 assert_eq!(payment_preimage_1, *payment_preimage);
5017 _ => panic!("Unexpected event"),
5020 } else if messages_delivered == 2 {
5021 // nodes[0] still wants its RAA + commitment_signed
5022 reconnect_nodes(&nodes[0], &nodes[1], false, (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
5023 } else if messages_delivered == 3 {
5024 // nodes[0] still wants its commitment_signed
5025 reconnect_nodes(&nodes[0], &nodes[1], false, (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
5026 } else if messages_delivered == 4 {
5027 // nodes[1] still wants its final RAA
5028 reconnect_nodes(&nodes[0], &nodes[1], false, (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
5029 } else if messages_delivered == 5 {
5030 // Everything was delivered...
5031 reconnect_nodes(&nodes[0], &nodes[1], false, (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
5034 // Channel should still work fine...
5035 let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
5036 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
5040 fn test_drop_messages_peer_disconnect_a() {
5041 do_test_drop_messages_peer_disconnect(0);
5042 do_test_drop_messages_peer_disconnect(1);
5043 do_test_drop_messages_peer_disconnect(2);
5047 fn test_drop_messages_peer_disconnect_b() {
5048 do_test_drop_messages_peer_disconnect(3);
5049 do_test_drop_messages_peer_disconnect(4);
5050 do_test_drop_messages_peer_disconnect(5);
5054 fn test_funding_peer_disconnect() {
5055 // Test that we can lock in our funding tx while disconnected
5056 let nodes = create_network(2);
5057 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001);
5059 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5060 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5062 confirm_transaction(&nodes[0].chain_monitor, &tx, tx.version);
5063 let events_1 = nodes[0].node.get_and_clear_pending_events();
5064 assert_eq!(events_1.len(), 1);
5066 Event::SendFundingLocked { ref node_id, msg: _, ref announcement_sigs } => {
5067 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
5068 assert!(announcement_sigs.is_none());
5070 _ => panic!("Unexpected event"),
5073 confirm_transaction(&nodes[1].chain_monitor, &tx, tx.version);
5074 let events_2 = nodes[1].node.get_and_clear_pending_events();
5075 assert_eq!(events_2.len(), 1);
5077 Event::SendFundingLocked { ref node_id, msg: _, ref announcement_sigs } => {
5078 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
5079 assert!(announcement_sigs.is_none());
5081 _ => panic!("Unexpected event"),
5084 reconnect_nodes(&nodes[0], &nodes[1], true, (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
5086 // TODO: We shouldn't need to manually pass list_usable_chanels here once we support
5087 // rebroadcasting announcement_signatures upon reconnect.
5089 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), Some(&nodes[0].node.list_usable_channels()), &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
5090 let (payment_preimage, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
5091 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
5095 fn test_invalid_channel_announcement() {
5096 //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
5097 let secp_ctx = Secp256k1::new();
5098 let nodes = create_network(2);
5100 let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1]);
5102 let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
5103 let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
5104 let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
5105 let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
5107 let _ = nodes[0].router.handle_htlc_fail_channel_update(&msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id : as_chan.get_short_channel_id().unwrap() } );
5109 let as_bitcoin_key = PublicKey::from_secret_key(&secp_ctx, &as_chan.get_local_keys().funding_key);
5110 let bs_bitcoin_key = PublicKey::from_secret_key(&secp_ctx, &bs_chan.get_local_keys().funding_key);
5112 let as_network_key = nodes[0].node.get_our_node_id();
5113 let bs_network_key = nodes[1].node.get_our_node_id();
5115 let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
5117 let mut chan_announcement;
5119 macro_rules! dummy_unsigned_msg {
5121 msgs::UnsignedChannelAnnouncement {
5122 features: msgs::GlobalFeatures::new(),
5123 chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
5124 short_channel_id: as_chan.get_short_channel_id().unwrap(),
5125 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
5126 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
5127 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
5128 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
5129 excess_data: Vec::new(),
5134 macro_rules! sign_msg {
5135 ($unsigned_msg: expr) => {
5136 let msghash = Message::from_slice(&Sha256dHash::from_data(&$unsigned_msg.encode()[..])[..]).unwrap();
5137 let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_local_keys().funding_key);
5138 let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_local_keys().funding_key);
5139 let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].node.our_network_key);
5140 let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].node.our_network_key);
5141 chan_announcement = msgs::ChannelAnnouncement {
5142 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
5143 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
5144 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
5145 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
5146 contents: $unsigned_msg
5151 let unsigned_msg = dummy_unsigned_msg!();
5152 sign_msg!(unsigned_msg);
5153 assert_eq!(nodes[0].router.handle_channel_announcement(&chan_announcement).unwrap(), true);
5154 let _ = nodes[0].router.handle_htlc_fail_channel_update(&msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id : as_chan.get_short_channel_id().unwrap() } );
5156 // Configured with Network::Testnet
5157 let mut unsigned_msg = dummy_unsigned_msg!();
5158 unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.bitcoin_hash();
5159 sign_msg!(unsigned_msg);
5160 assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
5162 let mut unsigned_msg = dummy_unsigned_msg!();
5163 unsigned_msg.chain_hash = Sha256dHash::from_data(&[1,2,3,4,5,6,7,8,9]);
5164 sign_msg!(unsigned_msg);
5165 assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());