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::util::hash::{BitcoinHash, Sha256dHash};
17 use secp256k1::key::{SecretKey,PublicKey};
18 use secp256k1::{Secp256k1,Message};
19 use secp256k1::ecdh::SharedSecret;
22 use chain::chaininterface::{BroadcasterInterface,ChainListener,ChainWatchInterface,FeeEstimator};
23 use chain::transaction::OutPoint;
24 use ln::channel::{Channel, ChannelError};
25 use ln::channelmonitor::{ChannelMonitor, ChannelMonitorUpdateErr, ManyChannelMonitor, CLTV_CLAIM_BUFFER, HTLC_FAIL_TIMEOUT_BLOCKS};
26 use ln::router::{Route,RouteHop};
28 use ln::msgs::{ChannelMessageHandler, DecodeError, HandleError};
29 use chain::keysinterface::KeysInterface;
30 use util::config::UserConfig;
31 use util::{byte_utils, events, internal_traits, rng};
32 use util::sha2::Sha256;
33 use util::ser::{Readable, ReadableArgs, Writeable, Writer};
34 use util::chacha20poly1305rfc::ChaCha20;
35 use util::logger::Logger;
36 use util::errors::APIError;
39 use crypto::mac::{Mac,MacResult};
40 use crypto::hmac::Hmac;
41 use crypto::digest::Digest;
42 use crypto::symmetriccipher::SynchronousStreamCipher;
44 use std::{cmp, ptr, mem};
45 use std::collections::{HashMap, hash_map, HashSet};
47 use std::sync::{Arc, Mutex, MutexGuard, RwLock};
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;
68 /// Stores the info we will need to send when we want to forward an HTLC onwards
69 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
70 pub struct PendingForwardHTLCInfo {
71 pub(super) onion_packet: Option<msgs::OnionPacket>,
72 pub(super) incoming_shared_secret: [u8; 32],
73 pub(super) payment_hash: [u8; 32],
74 pub(super) short_channel_id: u64,
75 pub(super) amt_to_forward: u64,
76 pub(super) outgoing_cltv_value: u32,
79 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
80 pub enum HTLCFailureMsg {
81 Relay(msgs::UpdateFailHTLC),
82 Malformed(msgs::UpdateFailMalformedHTLC),
85 /// Stores whether we can't forward an HTLC or relevant forwarding info
86 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
87 pub enum PendingHTLCStatus {
88 Forward(PendingForwardHTLCInfo),
92 /// Tracks the inbound corresponding to an outbound HTLC
94 pub struct HTLCPreviousHopData {
95 pub(super) short_channel_id: u64,
96 pub(super) htlc_id: u64,
97 pub(super) incoming_packet_shared_secret: [u8; 32],
100 /// Tracks the inbound corresponding to an outbound HTLC
102 pub enum HTLCSource {
103 PreviousHopData(HTLCPreviousHopData),
106 session_priv: SecretKey,
107 /// Technically we can recalculate this from the route, but we cache it here to avoid
108 /// doing a double-pass on route when we get a failure back
109 first_hop_htlc_msat: u64,
114 pub fn dummy() -> Self {
115 HTLCSource::OutboundRoute {
116 route: Route { hops: Vec::new() },
117 session_priv: SecretKey::from_slice(&::secp256k1::Secp256k1::without_caps(), &[1; 32]).unwrap(),
118 first_hop_htlc_msat: 0,
123 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
124 pub(crate) enum HTLCFailReason {
126 err: msgs::OnionErrorPacket,
134 pub(super) use self::channel_held_info::*;
136 struct MsgHandleErrInternal {
137 err: msgs::HandleError,
138 needs_channel_force_close: bool,
140 impl MsgHandleErrInternal {
142 fn send_err_msg_no_close(err: &'static str, channel_id: [u8; 32]) -> Self {
146 action: Some(msgs::ErrorAction::SendErrorMessage {
147 msg: msgs::ErrorMessage {
149 data: err.to_string()
153 needs_channel_force_close: false,
157 fn send_err_msg_close_chan(err: &'static str, channel_id: [u8; 32]) -> Self {
161 action: Some(msgs::ErrorAction::SendErrorMessage {
162 msg: msgs::ErrorMessage {
164 data: err.to_string()
168 needs_channel_force_close: true,
172 fn from_maybe_close(err: msgs::HandleError) -> Self {
173 Self { err, needs_channel_force_close: true }
176 fn from_no_close(err: msgs::HandleError) -> Self {
177 Self { err, needs_channel_force_close: false }
180 fn from_chan_no_close(err: ChannelError, channel_id: [u8; 32]) -> Self {
183 ChannelError::Ignore(msg) => HandleError {
185 action: Some(msgs::ErrorAction::IgnoreError),
187 ChannelError::Close(msg) => HandleError {
189 action: Some(msgs::ErrorAction::SendErrorMessage {
190 msg: msgs::ErrorMessage {
192 data: msg.to_string()
197 needs_channel_force_close: false,
201 fn from_chan_maybe_close(err: ChannelError, channel_id: [u8; 32]) -> Self {
204 ChannelError::Ignore(msg) => HandleError {
206 action: Some(msgs::ErrorAction::IgnoreError),
208 ChannelError::Close(msg) => HandleError {
210 action: Some(msgs::ErrorAction::SendErrorMessage {
211 msg: msgs::ErrorMessage {
213 data: msg.to_string()
218 needs_channel_force_close: true,
223 /// Pass to fail_htlc_backwwards to indicate the reason to fail the payment
224 /// after a PaymentReceived event.
226 pub enum PaymentFailReason {
227 /// Indicate the preimage for payment_hash is not known after a PaymentReceived event
229 /// Indicate the payment amount is incorrect ( received is < expected or > 2*expected ) after a PaymentReceived event
233 /// We hold back HTLCs we intend to relay for a random interval in the range (this, 5*this). This
234 /// provides some limited amount of privacy. Ideally this would range from somewhere like 1 second
235 /// to 30 seconds, but people expect lightning to be, you know, kinda fast, sadly. We could
236 /// probably increase this significantly.
237 const MIN_HTLC_RELAY_HOLDING_CELL_MILLIS: u32 = 50;
239 struct HTLCForwardInfo {
240 prev_short_channel_id: u64,
242 forward_info: PendingForwardHTLCInfo,
245 /// For events which result in both a RevokeAndACK and a CommitmentUpdate, by default they should
246 /// be sent in the order they appear in the return value, however sometimes the order needs to be
247 /// variable at runtime (eg Channel::channel_reestablish needs to re-send messages in the order
248 /// they were originally sent). In those cases, this enum is also returned.
249 #[derive(Clone, PartialEq)]
250 pub(super) enum RAACommitmentOrder {
251 /// Send the CommitmentUpdate messages first
253 /// Send the RevokeAndACK message first
257 struct ChannelHolder {
258 by_id: HashMap<[u8; 32], Channel>,
259 short_to_id: HashMap<u64, [u8; 32]>,
260 next_forward: Instant,
261 /// short channel id -> forward infos. Key of 0 means payments received
262 /// Note that while this is held in the same mutex as the channels themselves, no consistency
263 /// guarantees are made about there existing a channel with the short id here, nor the short
264 /// ids in the PendingForwardHTLCInfo!
265 forward_htlcs: HashMap<u64, Vec<HTLCForwardInfo>>,
266 /// Note that while this is held in the same mutex as the channels themselves, no consistency
267 /// guarantees are made about the channels given here actually existing anymore by the time you
269 claimable_htlcs: HashMap<[u8; 32], Vec<HTLCPreviousHopData>>,
270 /// Messages to send to peers - pushed to in the same lock that they are generated in (except
271 /// for broadcast messages, where ordering isn't as strict).
272 pending_msg_events: Vec<events::MessageSendEvent>,
274 struct MutChannelHolder<'a> {
275 by_id: &'a mut HashMap<[u8; 32], Channel>,
276 short_to_id: &'a mut HashMap<u64, [u8; 32]>,
277 next_forward: &'a mut Instant,
278 forward_htlcs: &'a mut HashMap<u64, Vec<HTLCForwardInfo>>,
279 claimable_htlcs: &'a mut HashMap<[u8; 32], Vec<HTLCPreviousHopData>>,
280 pending_msg_events: &'a mut Vec<events::MessageSendEvent>,
283 fn borrow_parts(&mut self) -> MutChannelHolder {
285 by_id: &mut self.by_id,
286 short_to_id: &mut self.short_to_id,
287 next_forward: &mut self.next_forward,
288 forward_htlcs: &mut self.forward_htlcs,
289 claimable_htlcs: &mut self.claimable_htlcs,
290 pending_msg_events: &mut self.pending_msg_events,
295 #[cfg(not(any(target_pointer_width = "32", target_pointer_width = "64")))]
296 const ERR: () = "You need at least 32 bit pointers (well, usize, but we'll assume they're the same) for ChannelManager::latest_block_height";
298 /// Manager which keeps track of a number of channels and sends messages to the appropriate
299 /// channel, also tracking HTLC preimages and forwarding onion packets appropriately.
301 /// Implements ChannelMessageHandler, handling the multi-channel parts and passing things through
302 /// to individual Channels.
304 /// Implements Writeable to write out all channel state to disk. Implies peer_disconnected() for
305 /// all peers during write/read (though does not modify this instance, only the instance being
306 /// serialized). This will result in any channels which have not yet exchanged funding_created (ie
307 /// called funding_transaction_generated for outbound channels).
309 /// Note that you can be a bit lazier about writing out ChannelManager than you can be with
310 /// ChannelMonitors. With ChannelMonitors you MUST write each monitor update out to disk before
311 /// returning from ManyChannelMonitor::add_update_monitor, with ChannelManagers, writing updates
312 /// happens out-of-band (and will prevent any other ChannelManager operations from occurring during
313 /// the serialization process). If the deserialized version is out-of-date compared to the
314 /// ChannelMonitors passed by reference to read(), those channels will be force-closed based on the
315 /// ChannelMonitor state and no funds will be lost (mod on-chain transaction fees).
317 /// Note that the deserializer is only implemented for (Sha256dHash, ChannelManager), which
318 /// tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
319 /// the "reorg path" (ie call block_disconnected() until you get to a common block and then call
320 /// block_connected() to step towards your best block) upon deserialization before using the
322 pub struct ChannelManager {
323 default_configuration: UserConfig,
324 genesis_hash: Sha256dHash,
325 fee_estimator: Arc<FeeEstimator>,
326 monitor: Arc<ManyChannelMonitor>,
327 chain_monitor: Arc<ChainWatchInterface>,
328 tx_broadcaster: Arc<BroadcasterInterface>,
330 latest_block_height: AtomicUsize,
331 last_block_hash: Mutex<Sha256dHash>,
332 secp_ctx: Secp256k1<secp256k1::All>,
334 channel_state: Mutex<ChannelHolder>,
335 our_network_key: SecretKey,
337 pending_events: Mutex<Vec<events::Event>>,
338 /// Used when we have to take a BIG lock to make sure everything is self-consistent.
339 /// Essentially just when we're serializing ourselves out.
340 /// Taken first everywhere where we are making changes before any other locks.
341 total_consistency_lock: RwLock<()>,
343 keys_manager: Arc<KeysInterface>,
348 /// The minimum number of blocks between an inbound HTLC's CLTV and the corresponding outbound
349 /// HTLC's CLTV. This should always be a few blocks greater than channelmonitor::CLTV_CLAIM_BUFFER,
350 /// ie the node we forwarded the payment on to should always have enough room to reliably time out
351 /// the HTLC via a full update_fail_htlc/commitment_signed dance before we hit the
352 /// CLTV_CLAIM_BUFFER point (we static assert that its at least 3 blocks more).
353 const CLTV_EXPIRY_DELTA: u16 = 6 * 24 * 2; //TODO?
354 const CLTV_FAR_FAR_AWAY: u32 = 6 * 24 * 7; //TODO?
356 // Check that our CLTV_EXPIRY is at least CLTV_CLAIM_BUFFER + 2*HTLC_FAIL_TIMEOUT_BLOCKS, ie that
357 // if the next-hop peer fails the HTLC within HTLC_FAIL_TIMEOUT_BLOCKS then we'll still have
358 // HTLC_FAIL_TIMEOUT_BLOCKS left to fail it backwards ourselves before hitting the
359 // CLTV_CLAIM_BUFFER point and failing the channel on-chain to time out the HTLC.
362 const CHECK_CLTV_EXPIRY_SANITY: u32 = CLTV_EXPIRY_DELTA as u32 - 2*HTLC_FAIL_TIMEOUT_BLOCKS - CLTV_CLAIM_BUFFER;
364 // Check for ability of an attacker to make us fail on-chain by delaying inbound claim. See
365 // ChannelMontior::would_broadcast_at_height for a description of why this is needed.
368 const CHECK_CLTV_EXPIRY_SANITY_2: u32 = CLTV_EXPIRY_DELTA as u32 - HTLC_FAIL_TIMEOUT_BLOCKS - 2*CLTV_CLAIM_BUFFER;
370 macro_rules! secp_call {
371 ( $res: expr, $err: expr ) => {
374 Err(_) => return Err($err),
381 shared_secret: SharedSecret,
383 blinding_factor: [u8; 32],
384 ephemeral_pubkey: PublicKey,
389 /// Details of a channel, as returned by ChannelManager::list_channels and ChannelManager::list_usable_channels
390 pub struct ChannelDetails {
391 /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
392 /// thereafter this is the txid of the funding transaction xor the funding transaction output).
393 /// Note that this means this value is *not* persistent - it can change once during the
394 /// lifetime of the channel.
395 pub channel_id: [u8; 32],
396 /// The position of the funding transaction in the chain. None if the funding transaction has
397 /// not yet been confirmed and the channel fully opened.
398 pub short_channel_id: Option<u64>,
399 /// The node_id of our counterparty
400 pub remote_network_id: PublicKey,
401 /// The value, in satoshis, of this channel as appears in the funding output
402 pub channel_value_satoshis: u64,
403 /// The user_id passed in to create_channel, or 0 if the channel was inbound.
407 macro_rules! handle_error {
408 ($self: ident, $internal: expr, $their_node_id: expr) => {
411 Err(MsgHandleErrInternal { err, needs_channel_force_close }) => {
412 if needs_channel_force_close {
414 &Some(msgs::ErrorAction::DisconnectPeer { msg: Some(ref msg) }) => {
415 if msg.channel_id == [0; 32] {
416 $self.peer_disconnected(&$their_node_id, true);
418 $self.force_close_channel(&msg.channel_id);
421 &Some(msgs::ErrorAction::DisconnectPeer { msg: None }) => {},
422 &Some(msgs::ErrorAction::IgnoreError) => {},
423 &Some(msgs::ErrorAction::SendErrorMessage { ref msg }) => {
424 if msg.channel_id == [0; 32] {
425 $self.peer_disconnected(&$their_node_id, true);
427 $self.force_close_channel(&msg.channel_id);
439 impl ChannelManager {
440 /// Constructs a new ChannelManager to hold several channels and route between them.
442 /// This is the main "logic hub" for all channel-related actions, and implements
443 /// ChannelMessageHandler.
445 /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
447 /// panics if channel_value_satoshis is >= `MAX_FUNDING_SATOSHIS`!
448 pub fn new(network: Network, feeest: Arc<FeeEstimator>, monitor: Arc<ManyChannelMonitor>, chain_monitor: Arc<ChainWatchInterface>, tx_broadcaster: Arc<BroadcasterInterface>, logger: Arc<Logger>,keys_manager: Arc<KeysInterface>, config: UserConfig) -> Result<Arc<ChannelManager>, secp256k1::Error> {
449 let secp_ctx = Secp256k1::new();
451 let res = Arc::new(ChannelManager {
452 default_configuration: config.clone(),
453 genesis_hash: genesis_block(network).header.bitcoin_hash(),
454 fee_estimator: feeest.clone(),
455 monitor: monitor.clone(),
459 latest_block_height: AtomicUsize::new(0), //TODO: Get an init value
460 last_block_hash: Mutex::new(Default::default()),
463 channel_state: Mutex::new(ChannelHolder{
464 by_id: HashMap::new(),
465 short_to_id: HashMap::new(),
466 next_forward: Instant::now(),
467 forward_htlcs: HashMap::new(),
468 claimable_htlcs: HashMap::new(),
469 pending_msg_events: Vec::new(),
471 our_network_key: keys_manager.get_node_secret(),
473 pending_events: Mutex::new(Vec::new()),
474 total_consistency_lock: RwLock::new(()),
480 let weak_res = Arc::downgrade(&res);
481 res.chain_monitor.register_listener(weak_res);
485 /// Creates a new outbound channel to the given remote node and with the given value.
487 /// user_id will be provided back as user_channel_id in FundingGenerationReady and
488 /// FundingBroadcastSafe events to allow tracking of which events correspond with which
489 /// create_channel call. Note that user_channel_id defaults to 0 for inbound channels, so you
490 /// may wish to avoid using 0 for user_id here.
492 /// If successful, will generate a SendOpenChannel message event, so you should probably poll
493 /// PeerManager::process_events afterwards.
495 /// Raises APIError::APIMisuseError when channel_value_satoshis > 2**24 or push_msat is
496 /// greater than channel_value_satoshis * 1k or channel_value_satoshis is < 1000.
497 pub fn create_channel(&self, their_network_key: PublicKey, channel_value_satoshis: u64, push_msat: u64, user_id: u64) -> Result<(), APIError> {
498 if channel_value_satoshis < 1000 {
499 return Err(APIError::APIMisuseError { err: "channel_value must be at least 1000 satoshis" });
502 let channel = Channel::new_outbound(&*self.fee_estimator, &self.keys_manager, their_network_key, channel_value_satoshis, push_msat, user_id, Arc::clone(&self.logger), &self.default_configuration)?;
503 let res = channel.get_open_channel(self.genesis_hash.clone(), &*self.fee_estimator);
505 let _ = self.total_consistency_lock.read().unwrap();
506 let mut channel_state = self.channel_state.lock().unwrap();
507 match channel_state.by_id.entry(channel.channel_id()) {
508 hash_map::Entry::Occupied(_) => {
509 if cfg!(feature = "fuzztarget") {
510 return Err(APIError::APIMisuseError { err: "Fuzzy bad RNG" });
512 panic!("RNG is bad???");
515 hash_map::Entry::Vacant(entry) => { entry.insert(channel); }
517 channel_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
518 node_id: their_network_key,
524 /// Gets the list of open channels, in random order. See ChannelDetail field documentation for
525 /// more information.
526 pub fn list_channels(&self) -> Vec<ChannelDetails> {
527 let channel_state = self.channel_state.lock().unwrap();
528 let mut res = Vec::with_capacity(channel_state.by_id.len());
529 for (channel_id, channel) in channel_state.by_id.iter() {
530 res.push(ChannelDetails {
531 channel_id: (*channel_id).clone(),
532 short_channel_id: channel.get_short_channel_id(),
533 remote_network_id: channel.get_their_node_id(),
534 channel_value_satoshis: channel.get_value_satoshis(),
535 user_id: channel.get_user_id(),
541 /// Gets the list of usable channels, in random order. Useful as an argument to
542 /// Router::get_route to ensure non-announced channels are used.
543 pub fn list_usable_channels(&self) -> Vec<ChannelDetails> {
544 let channel_state = self.channel_state.lock().unwrap();
545 let mut res = Vec::with_capacity(channel_state.by_id.len());
546 for (channel_id, channel) in channel_state.by_id.iter() {
547 // Note we use is_live here instead of usable which leads to somewhat confused
548 // internal/external nomenclature, but that's ok cause that's probably what the user
549 // really wanted anyway.
550 if channel.is_live() {
551 res.push(ChannelDetails {
552 channel_id: (*channel_id).clone(),
553 short_channel_id: channel.get_short_channel_id(),
554 remote_network_id: channel.get_their_node_id(),
555 channel_value_satoshis: channel.get_value_satoshis(),
556 user_id: channel.get_user_id(),
563 /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
564 /// will be accepted on the given channel, and after additional timeout/the closing of all
565 /// pending HTLCs, the channel will be closed on chain.
567 /// May generate a SendShutdown message event on success, which should be relayed.
568 pub fn close_channel(&self, channel_id: &[u8; 32]) -> Result<(), APIError> {
569 let _ = self.total_consistency_lock.read().unwrap();
571 let (mut failed_htlcs, chan_option) = {
572 let mut channel_state_lock = self.channel_state.lock().unwrap();
573 let channel_state = channel_state_lock.borrow_parts();
574 match channel_state.by_id.entry(channel_id.clone()) {
575 hash_map::Entry::Occupied(mut chan_entry) => {
576 let (shutdown_msg, failed_htlcs) = chan_entry.get_mut().get_shutdown()?;
577 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
578 node_id: chan_entry.get().get_their_node_id(),
581 if chan_entry.get().is_shutdown() {
582 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
583 channel_state.short_to_id.remove(&short_id);
585 (failed_htlcs, Some(chan_entry.remove_entry().1))
586 } else { (failed_htlcs, None) }
588 hash_map::Entry::Vacant(_) => return Err(APIError::ChannelUnavailable{err: "No such channel"})
591 for htlc_source in failed_htlcs.drain(..) {
592 // unknown_next_peer...I dunno who that is anymore....
593 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() });
595 let chan_update = if let Some(chan) = chan_option {
596 if let Ok(update) = self.get_channel_update(&chan) {
601 if let Some(update) = chan_update {
602 let mut channel_state = self.channel_state.lock().unwrap();
603 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
612 fn finish_force_close_channel(&self, shutdown_res: (Vec<Transaction>, Vec<(HTLCSource, [u8; 32])>)) {
613 let (local_txn, mut failed_htlcs) = shutdown_res;
614 for htlc_source in failed_htlcs.drain(..) {
615 // unknown_next_peer...I dunno who that is anymore....
616 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() });
618 for tx in local_txn {
619 self.tx_broadcaster.broadcast_transaction(&tx);
621 //TODO: We need to have a way where outbound HTLC claims can result in us claiming the
622 //now-on-chain HTLC output for ourselves (and, thereafter, passing the HTLC backwards).
623 //TODO: We need to handle monitoring of pending offered HTLCs which just hit the chain and
624 //may be claimed, resulting in us claiming the inbound HTLCs (and back-failing after
625 //timeouts are hit and our claims confirm).
626 //TODO: In any case, we need to make sure we remove any pending htlc tracking (via
627 //fail_backwards or claim_funds) eventually for all HTLCs that were in the channel
630 /// Force closes a channel, immediately broadcasting the latest local commitment transaction to
631 /// the chain and rejecting new HTLCs on the given channel.
632 pub fn force_close_channel(&self, channel_id: &[u8; 32]) {
633 let _ = self.total_consistency_lock.read().unwrap();
636 let mut channel_state_lock = self.channel_state.lock().unwrap();
637 let channel_state = channel_state_lock.borrow_parts();
638 if let Some(chan) = channel_state.by_id.remove(channel_id) {
639 if let Some(short_id) = chan.get_short_channel_id() {
640 channel_state.short_to_id.remove(&short_id);
647 self.finish_force_close_channel(chan.force_shutdown());
648 if let Ok(update) = self.get_channel_update(&chan) {
649 let mut channel_state = self.channel_state.lock().unwrap();
650 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
656 /// Force close all channels, immediately broadcasting the latest local commitment transaction
657 /// for each to the chain and rejecting new HTLCs on each.
658 pub fn force_close_all_channels(&self) {
659 for chan in self.list_channels() {
660 self.force_close_channel(&chan.channel_id);
664 fn handle_monitor_update_fail(&self, mut channel_state_lock: MutexGuard<ChannelHolder>, channel_id: &[u8; 32], err: ChannelMonitorUpdateErr, reason: RAACommitmentOrder) {
666 ChannelMonitorUpdateErr::PermanentFailure => {
668 let channel_state = channel_state_lock.borrow_parts();
669 let chan = channel_state.by_id.remove(channel_id).expect("monitor_update_failed must be called within the same lock as the channel get!");
670 if let Some(short_id) = chan.get_short_channel_id() {
671 channel_state.short_to_id.remove(&short_id);
675 mem::drop(channel_state_lock);
676 self.finish_force_close_channel(chan.force_shutdown());
677 if let Ok(update) = self.get_channel_update(&chan) {
678 let mut channel_state = self.channel_state.lock().unwrap();
679 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
684 ChannelMonitorUpdateErr::TemporaryFailure => {
685 let channel = channel_state_lock.by_id.get_mut(channel_id).expect("monitor_update_failed must be called within the same lock as the channel get!");
686 channel.monitor_update_failed(reason);
692 fn gen_rho_mu_from_shared_secret(shared_secret: &[u8]) -> ([u8; 32], [u8; 32]) {
693 assert_eq!(shared_secret.len(), 32);
695 let mut hmac = Hmac::new(Sha256::new(), &[0x72, 0x68, 0x6f]); // rho
696 hmac.input(&shared_secret[..]);
697 let mut res = [0; 32];
698 hmac.raw_result(&mut res);
702 let mut hmac = Hmac::new(Sha256::new(), &[0x6d, 0x75]); // mu
703 hmac.input(&shared_secret[..]);
704 let mut res = [0; 32];
705 hmac.raw_result(&mut res);
711 fn gen_um_from_shared_secret(shared_secret: &[u8]) -> [u8; 32] {
712 assert_eq!(shared_secret.len(), 32);
713 let mut hmac = Hmac::new(Sha256::new(), &[0x75, 0x6d]); // um
714 hmac.input(&shared_secret[..]);
715 let mut res = [0; 32];
716 hmac.raw_result(&mut res);
721 fn gen_ammag_from_shared_secret(shared_secret: &[u8]) -> [u8; 32] {
722 assert_eq!(shared_secret.len(), 32);
723 let mut hmac = Hmac::new(Sha256::new(), &[0x61, 0x6d, 0x6d, 0x61, 0x67]); // ammag
724 hmac.input(&shared_secret[..]);
725 let mut res = [0; 32];
726 hmac.raw_result(&mut res);
730 // can only fail if an intermediary hop has an invalid public key or session_priv is invalid
732 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> {
733 let mut blinded_priv = session_priv.clone();
734 let mut blinded_pub = PublicKey::from_secret_key(secp_ctx, &blinded_priv);
736 for hop in route.hops.iter() {
737 let shared_secret = SharedSecret::new(secp_ctx, &hop.pubkey, &blinded_priv);
739 let mut sha = Sha256::new();
740 sha.input(&blinded_pub.serialize()[..]);
741 sha.input(&shared_secret[..]);
742 let mut blinding_factor = [0u8; 32];
743 sha.result(&mut blinding_factor);
745 let ephemeral_pubkey = blinded_pub;
747 blinded_priv.mul_assign(secp_ctx, &SecretKey::from_slice(secp_ctx, &blinding_factor)?)?;
748 blinded_pub = PublicKey::from_secret_key(secp_ctx, &blinded_priv);
750 callback(shared_secret, blinding_factor, ephemeral_pubkey, hop);
756 // can only fail if an intermediary hop has an invalid public key or session_priv is invalid
757 fn construct_onion_keys<T: secp256k1::Signing>(secp_ctx: &Secp256k1<T>, route: &Route, session_priv: &SecretKey) -> Result<Vec<OnionKeys>, secp256k1::Error> {
758 let mut res = Vec::with_capacity(route.hops.len());
760 Self::construct_onion_keys_callback(secp_ctx, route, session_priv, |shared_secret, _blinding_factor, ephemeral_pubkey, _| {
761 let (rho, mu) = ChannelManager::gen_rho_mu_from_shared_secret(&shared_secret[..]);
767 blinding_factor: _blinding_factor,
777 /// returns the hop data, as well as the first-hop value_msat and CLTV value we should send.
778 fn build_onion_payloads(route: &Route, starting_htlc_offset: u32) -> Result<(Vec<msgs::OnionHopData>, u64, u32), APIError> {
779 let mut cur_value_msat = 0u64;
780 let mut cur_cltv = starting_htlc_offset;
781 let mut last_short_channel_id = 0;
782 let mut res: Vec<msgs::OnionHopData> = Vec::with_capacity(route.hops.len());
783 internal_traits::test_no_dealloc::<msgs::OnionHopData>(None);
784 unsafe { res.set_len(route.hops.len()); }
786 for (idx, hop) in route.hops.iter().enumerate().rev() {
787 // First hop gets special values so that it can check, on receipt, that everything is
788 // exactly as it should be (and the next hop isn't trying to probe to find out if we're
789 // the intended recipient).
790 let value_msat = if cur_value_msat == 0 { hop.fee_msat } else { cur_value_msat };
791 let cltv = if cur_cltv == starting_htlc_offset { hop.cltv_expiry_delta + starting_htlc_offset } else { cur_cltv };
792 res[idx] = msgs::OnionHopData {
794 data: msgs::OnionRealm0HopData {
795 short_channel_id: last_short_channel_id,
796 amt_to_forward: value_msat,
797 outgoing_cltv_value: cltv,
801 cur_value_msat += hop.fee_msat;
802 if cur_value_msat >= 21000000 * 100000000 * 1000 {
803 return Err(APIError::RouteError{err: "Channel fees overflowed?!"});
805 cur_cltv += hop.cltv_expiry_delta as u32;
806 if cur_cltv >= 500000000 {
807 return Err(APIError::RouteError{err: "Channel CLTV overflowed?!"});
809 last_short_channel_id = hop.short_channel_id;
811 Ok((res, cur_value_msat, cur_cltv))
815 fn shift_arr_right(arr: &mut [u8; 20*65]) {
817 ptr::copy(arr[0..].as_ptr(), arr[65..].as_mut_ptr(), 19*65);
825 fn xor_bufs(dst: &mut[u8], src: &[u8]) {
826 assert_eq!(dst.len(), src.len());
828 for i in 0..dst.len() {
833 const ZERO:[u8; 21*65] = [0; 21*65];
834 fn construct_onion_packet(mut payloads: Vec<msgs::OnionHopData>, onion_keys: Vec<OnionKeys>, associated_data: &[u8; 32]) -> msgs::OnionPacket {
835 let mut buf = Vec::with_capacity(21*65);
836 buf.resize(21*65, 0);
839 let iters = payloads.len() - 1;
840 let end_len = iters * 65;
841 let mut res = Vec::with_capacity(end_len);
842 res.resize(end_len, 0);
844 for (i, keys) in onion_keys.iter().enumerate() {
845 if i == payloads.len() - 1 { continue; }
846 let mut chacha = ChaCha20::new(&keys.rho, &[0u8; 8]);
847 chacha.process(&ChannelManager::ZERO, &mut buf); // We don't have a seek function :(
848 ChannelManager::xor_bufs(&mut res[0..(i + 1)*65], &buf[(20 - i)*65..21*65]);
853 let mut packet_data = [0; 20*65];
854 let mut hmac_res = [0; 32];
856 for (i, (payload, keys)) in payloads.iter_mut().zip(onion_keys.iter()).rev().enumerate() {
857 ChannelManager::shift_arr_right(&mut packet_data);
858 payload.hmac = hmac_res;
859 packet_data[0..65].copy_from_slice(&payload.encode()[..]);
861 let mut chacha = ChaCha20::new(&keys.rho, &[0u8; 8]);
862 chacha.process(&packet_data, &mut buf[0..20*65]);
863 packet_data[..].copy_from_slice(&buf[0..20*65]);
866 packet_data[20*65 - filler.len()..20*65].copy_from_slice(&filler[..]);
869 let mut hmac = Hmac::new(Sha256::new(), &keys.mu);
870 hmac.input(&packet_data);
871 hmac.input(&associated_data[..]);
872 hmac.raw_result(&mut hmac_res);
877 public_key: Ok(onion_keys.first().unwrap().ephemeral_pubkey),
878 hop_data: packet_data,
883 /// Encrypts a failure packet. raw_packet can either be a
884 /// msgs::DecodedOnionErrorPacket.encode() result or a msgs::OnionErrorPacket.data element.
885 fn encrypt_failure_packet(shared_secret: &[u8], raw_packet: &[u8]) -> msgs::OnionErrorPacket {
886 let ammag = ChannelManager::gen_ammag_from_shared_secret(&shared_secret);
888 let mut packet_crypted = Vec::with_capacity(raw_packet.len());
889 packet_crypted.resize(raw_packet.len(), 0);
890 let mut chacha = ChaCha20::new(&ammag, &[0u8; 8]);
891 chacha.process(&raw_packet, &mut packet_crypted[..]);
892 msgs::OnionErrorPacket {
893 data: packet_crypted,
897 fn build_failure_packet(shared_secret: &[u8], failure_type: u16, failure_data: &[u8]) -> msgs::DecodedOnionErrorPacket {
898 assert_eq!(shared_secret.len(), 32);
899 assert!(failure_data.len() <= 256 - 2);
901 let um = ChannelManager::gen_um_from_shared_secret(&shared_secret);
904 let mut res = Vec::with_capacity(2 + failure_data.len());
905 res.push(((failure_type >> 8) & 0xff) as u8);
906 res.push(((failure_type >> 0) & 0xff) as u8);
907 res.extend_from_slice(&failure_data[..]);
911 let mut res = Vec::with_capacity(256 - 2 - failure_data.len());
912 res.resize(256 - 2 - failure_data.len(), 0);
915 let mut packet = msgs::DecodedOnionErrorPacket {
917 failuremsg: failuremsg,
921 let mut hmac = Hmac::new(Sha256::new(), &um);
922 hmac.input(&packet.encode()[32..]);
923 hmac.raw_result(&mut packet.hmac);
929 fn build_first_hop_failure_packet(shared_secret: &[u8], failure_type: u16, failure_data: &[u8]) -> msgs::OnionErrorPacket {
930 let failure_packet = ChannelManager::build_failure_packet(shared_secret, failure_type, failure_data);
931 ChannelManager::encrypt_failure_packet(shared_secret, &failure_packet.encode()[..])
934 fn decode_update_add_htlc_onion(&self, msg: &msgs::UpdateAddHTLC) -> (PendingHTLCStatus, MutexGuard<ChannelHolder>) {
935 macro_rules! get_onion_hash {
938 let mut sha = Sha256::new();
939 sha.input(&msg.onion_routing_packet.hop_data);
940 let mut onion_hash = [0; 32];
941 sha.result(&mut onion_hash);
947 if let Err(_) = msg.onion_routing_packet.public_key {
948 log_info!(self, "Failed to accept/forward incoming HTLC with invalid ephemeral pubkey");
949 return (PendingHTLCStatus::Fail(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
950 channel_id: msg.channel_id,
951 htlc_id: msg.htlc_id,
952 sha256_of_onion: get_onion_hash!(),
953 failure_code: 0x8000 | 0x4000 | 6,
954 })), self.channel_state.lock().unwrap());
957 let shared_secret = {
958 let mut arr = [0; 32];
959 arr.copy_from_slice(&SharedSecret::new(&self.secp_ctx, &msg.onion_routing_packet.public_key.unwrap(), &self.our_network_key)[..]);
962 let (rho, mu) = ChannelManager::gen_rho_mu_from_shared_secret(&shared_secret);
964 let mut channel_state = None;
965 macro_rules! return_err {
966 ($msg: expr, $err_code: expr, $data: expr) => {
968 log_info!(self, "Failed to accept/forward incoming HTLC: {}", $msg);
969 if channel_state.is_none() {
970 channel_state = Some(self.channel_state.lock().unwrap());
972 return (PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
973 channel_id: msg.channel_id,
974 htlc_id: msg.htlc_id,
975 reason: ChannelManager::build_first_hop_failure_packet(&shared_secret, $err_code, $data),
976 })), channel_state.unwrap());
981 if msg.onion_routing_packet.version != 0 {
982 //TODO: Spec doesn't indicate if we should only hash hop_data here (and in other
983 //sha256_of_onion error data packets), or the entire onion_routing_packet. Either way,
984 //the hash doesn't really serve any purpuse - in the case of hashing all data, the
985 //receiving node would have to brute force to figure out which version was put in the
986 //packet by the node that send us the message, in the case of hashing the hop_data, the
987 //node knows the HMAC matched, so they already know what is there...
988 return_err!("Unknown onion packet version", 0x8000 | 0x4000 | 4, &get_onion_hash!());
991 let mut hmac = Hmac::new(Sha256::new(), &mu);
992 hmac.input(&msg.onion_routing_packet.hop_data);
993 hmac.input(&msg.payment_hash);
994 if hmac.result() != MacResult::new(&msg.onion_routing_packet.hmac) {
995 return_err!("HMAC Check failed", 0x8000 | 0x4000 | 5, &get_onion_hash!());
998 let mut chacha = ChaCha20::new(&rho, &[0u8; 8]);
999 let next_hop_data = {
1000 let mut decoded = [0; 65];
1001 chacha.process(&msg.onion_routing_packet.hop_data[0..65], &mut decoded);
1002 match msgs::OnionHopData::read(&mut Cursor::new(&decoded[..])) {
1004 let error_code = match err {
1005 msgs::DecodeError::UnknownVersion => 0x4000 | 1, // unknown realm byte
1006 _ => 0x2000 | 2, // Should never happen
1008 return_err!("Unable to decode our hop data", error_code, &[0;0]);
1014 let pending_forward_info = if next_hop_data.hmac == [0; 32] {
1016 // final_expiry_too_soon
1017 if (msg.cltv_expiry as u64) < self.latest_block_height.load(Ordering::Acquire) as u64 + (CLTV_CLAIM_BUFFER + HTLC_FAIL_TIMEOUT_BLOCKS) as u64 {
1018 return_err!("The final CLTV expiry is too soon to handle", 17, &[0;0]);
1020 // final_incorrect_htlc_amount
1021 if next_hop_data.data.amt_to_forward > msg.amount_msat {
1022 return_err!("Upstream node sent less than we were supposed to receive in payment", 19, &byte_utils::be64_to_array(msg.amount_msat));
1024 // final_incorrect_cltv_expiry
1025 if next_hop_data.data.outgoing_cltv_value != msg.cltv_expiry {
1026 return_err!("Upstream node set CLTV to the wrong value", 18, &byte_utils::be32_to_array(msg.cltv_expiry));
1029 // Note that we could obviously respond immediately with an update_fulfill_htlc
1030 // message, however that would leak that we are the recipient of this payment, so
1031 // instead we stay symmetric with the forwarding case, only responding (after a
1032 // delay) once they've send us a commitment_signed!
1034 PendingHTLCStatus::Forward(PendingForwardHTLCInfo {
1036 payment_hash: msg.payment_hash.clone(),
1037 short_channel_id: 0,
1038 incoming_shared_secret: shared_secret,
1039 amt_to_forward: next_hop_data.data.amt_to_forward,
1040 outgoing_cltv_value: next_hop_data.data.outgoing_cltv_value,
1043 let mut new_packet_data = [0; 20*65];
1044 chacha.process(&msg.onion_routing_packet.hop_data[65..], &mut new_packet_data[0..19*65]);
1045 chacha.process(&ChannelManager::ZERO[0..65], &mut new_packet_data[19*65..]);
1047 let mut new_pubkey = msg.onion_routing_packet.public_key.unwrap();
1049 let blinding_factor = {
1050 let mut sha = Sha256::new();
1051 sha.input(&new_pubkey.serialize()[..]);
1052 sha.input(&shared_secret);
1053 let mut res = [0u8; 32];
1054 sha.result(&mut res);
1055 match SecretKey::from_slice(&self.secp_ctx, &res) {
1057 return_err!("Blinding factor is an invalid private key", 0x8000 | 0x4000 | 6, &get_onion_hash!());
1063 if let Err(_) = new_pubkey.mul_assign(&self.secp_ctx, &blinding_factor) {
1064 return_err!("New blinding factor is an invalid private key", 0x8000 | 0x4000 | 6, &get_onion_hash!());
1067 let outgoing_packet = msgs::OnionPacket {
1069 public_key: Ok(new_pubkey),
1070 hop_data: new_packet_data,
1071 hmac: next_hop_data.hmac.clone(),
1074 PendingHTLCStatus::Forward(PendingForwardHTLCInfo {
1075 onion_packet: Some(outgoing_packet),
1076 payment_hash: msg.payment_hash.clone(),
1077 short_channel_id: next_hop_data.data.short_channel_id,
1078 incoming_shared_secret: shared_secret,
1079 amt_to_forward: next_hop_data.data.amt_to_forward,
1080 outgoing_cltv_value: next_hop_data.data.outgoing_cltv_value,
1084 channel_state = Some(self.channel_state.lock().unwrap());
1085 if let &PendingHTLCStatus::Forward(PendingForwardHTLCInfo { ref onion_packet, ref short_channel_id, ref amt_to_forward, ref outgoing_cltv_value, .. }) = &pending_forward_info {
1086 if onion_packet.is_some() { // If short_channel_id is 0 here, we'll reject them in the body here
1087 let id_option = channel_state.as_ref().unwrap().short_to_id.get(&short_channel_id).cloned();
1088 let forwarding_id = match id_option {
1089 None => { // unknown_next_peer
1090 return_err!("Don't have available channel for forwarding as requested.", 0x4000 | 10, &[0;0]);
1092 Some(id) => id.clone(),
1094 if let Some((err, code, chan_update)) = loop {
1095 let chan = channel_state.as_mut().unwrap().by_id.get_mut(&forwarding_id).unwrap();
1097 // Note that we could technically not return an error yet here and just hope
1098 // that the connection is reestablished or monitor updated by the time we get
1099 // around to doing the actual forward, but better to fail early if we can and
1100 // hopefully an attacker trying to path-trace payments cannot make this occur
1101 // on a small/per-node/per-channel scale.
1102 if !chan.is_live() { // channel_disabled
1103 break Some(("Forwarding channel is not in a ready state.", 0x1000 | 20, Some(self.get_channel_update(chan).unwrap())));
1105 if *amt_to_forward < chan.get_their_htlc_minimum_msat() { // amount_below_minimum
1106 break Some(("HTLC amount was below the htlc_minimum_msat", 0x1000 | 11, Some(self.get_channel_update(chan).unwrap())));
1108 let fee = amt_to_forward.checked_mul(chan.get_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) });
1109 if fee.is_none() || msg.amount_msat < fee.unwrap() || (msg.amount_msat - fee.unwrap()) < *amt_to_forward { // fee_insufficient
1110 break Some(("Prior hop has deviated from specified fees parameters or origin node has obsolete ones", 0x1000 | 12, Some(self.get_channel_update(chan).unwrap())));
1112 if (msg.cltv_expiry as u64) < (*outgoing_cltv_value) as u64 + CLTV_EXPIRY_DELTA as u64 { // incorrect_cltv_expiry
1113 break Some(("Forwarding node has tampered with the intended HTLC values or origin node has an obsolete cltv_expiry_delta", 0x1000 | 13, Some(self.get_channel_update(chan).unwrap())));
1115 let cur_height = self.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1116 // We want to have at least HTLC_FAIL_TIMEOUT_BLOCKS to fail prior to going on chain CLAIM_BUFFER blocks before expiration
1117 if msg.cltv_expiry <= cur_height + CLTV_CLAIM_BUFFER + HTLC_FAIL_TIMEOUT_BLOCKS as u32 { // expiry_too_soon
1118 break Some(("CLTV expiry is too close", 0x1000 | 14, Some(self.get_channel_update(chan).unwrap())));
1120 if msg.cltv_expiry > cur_height + CLTV_FAR_FAR_AWAY as u32 { // expiry_too_far
1121 break Some(("CLTV expiry is too far in the future", 21, None));
1126 let mut res = Vec::with_capacity(8 + 128);
1127 if code == 0x1000 | 11 || code == 0x1000 | 12 {
1128 res.extend_from_slice(&byte_utils::be64_to_array(msg.amount_msat));
1130 else if code == 0x1000 | 13 {
1131 res.extend_from_slice(&byte_utils::be32_to_array(msg.cltv_expiry));
1133 if let Some(chan_update) = chan_update {
1134 res.extend_from_slice(&chan_update.encode_with_len()[..]);
1136 return_err!(err, code, &res[..]);
1141 (pending_forward_info, channel_state.unwrap())
1144 /// only fails if the channel does not yet have an assigned short_id
1145 /// May be called with channel_state already locked!
1146 fn get_channel_update(&self, chan: &Channel) -> Result<msgs::ChannelUpdate, HandleError> {
1147 let short_channel_id = match chan.get_short_channel_id() {
1148 None => return Err(HandleError{err: "Channel not yet established", action: None}),
1152 let were_node_one = PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key).serialize()[..] < chan.get_their_node_id().serialize()[..];
1154 let unsigned = msgs::UnsignedChannelUpdate {
1155 chain_hash: self.genesis_hash,
1156 short_channel_id: short_channel_id,
1157 timestamp: chan.get_channel_update_count(),
1158 flags: (!were_node_one) as u16 | ((!chan.is_live() as u16) << 1),
1159 cltv_expiry_delta: CLTV_EXPIRY_DELTA,
1160 htlc_minimum_msat: chan.get_our_htlc_minimum_msat(),
1161 fee_base_msat: chan.get_our_fee_base_msat(&*self.fee_estimator),
1162 fee_proportional_millionths: chan.get_fee_proportional_millionths(),
1163 excess_data: Vec::new(),
1166 let msg_hash = Sha256dHash::from_data(&unsigned.encode()[..]);
1167 let sig = self.secp_ctx.sign(&Message::from_slice(&msg_hash[..]).unwrap(), &self.our_network_key);
1169 Ok(msgs::ChannelUpdate {
1175 /// Sends a payment along a given route.
1177 /// Value parameters are provided via the last hop in route, see documentation for RouteHop
1178 /// fields for more info.
1180 /// Note that if the payment_hash already exists elsewhere (eg you're sending a duplicative
1181 /// payment), we don't do anything to stop you! We always try to ensure that if the provided
1182 /// next hop knows the preimage to payment_hash they can claim an additional amount as
1183 /// specified in the last hop in the route! Thus, you should probably do your own
1184 /// payment_preimage tracking (which you should already be doing as they represent "proof of
1185 /// payment") and prevent double-sends yourself.
1187 /// May generate a SendHTLCs message event on success, which should be relayed.
1189 /// Raises APIError::RoutError when invalid route or forward parameter
1190 /// (cltv_delta, fee, node public key) is specified
1191 pub fn send_payment(&self, route: Route, payment_hash: [u8; 32]) -> Result<(), APIError> {
1192 if route.hops.len() < 1 || route.hops.len() > 20 {
1193 return Err(APIError::RouteError{err: "Route didn't go anywhere/had bogus size"});
1195 let our_node_id = self.get_our_node_id();
1196 for (idx, hop) in route.hops.iter().enumerate() {
1197 if idx != route.hops.len() - 1 && hop.pubkey == our_node_id {
1198 return Err(APIError::RouteError{err: "Route went through us but wasn't a simple rebalance loop to us"});
1202 let session_priv = SecretKey::from_slice(&self.secp_ctx, &{
1203 let mut session_key = [0; 32];
1204 rng::fill_bytes(&mut session_key);
1206 }).expect("RNG is bad!");
1208 let cur_height = self.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1210 let onion_keys = secp_call!(ChannelManager::construct_onion_keys(&self.secp_ctx, &route, &session_priv),
1211 APIError::RouteError{err: "Pubkey along hop was maliciously selected"});
1212 let (onion_payloads, htlc_msat, htlc_cltv) = ChannelManager::build_onion_payloads(&route, cur_height)?;
1213 let onion_packet = ChannelManager::construct_onion_packet(onion_payloads, onion_keys, &payment_hash);
1215 let _ = self.total_consistency_lock.read().unwrap();
1216 let mut channel_state = self.channel_state.lock().unwrap();
1218 let id = match channel_state.short_to_id.get(&route.hops.first().unwrap().short_channel_id) {
1219 None => return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!"}),
1220 Some(id) => id.clone(),
1224 let chan = channel_state.by_id.get_mut(&id).unwrap();
1225 if chan.get_their_node_id() != route.hops.first().unwrap().pubkey {
1226 return Err(APIError::RouteError{err: "Node ID mismatch on first hop!"});
1228 if chan.is_awaiting_monitor_update() {
1229 return Err(APIError::MonitorUpdateFailed);
1231 if !chan.is_live() {
1232 return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected!"});
1234 chan.send_htlc_and_commit(htlc_msat, payment_hash.clone(), htlc_cltv, HTLCSource::OutboundRoute {
1235 route: route.clone(),
1236 session_priv: session_priv.clone(),
1237 first_hop_htlc_msat: htlc_msat,
1238 }, onion_packet).map_err(|he|
1240 ChannelError::Close(err) => {
1241 // TODO: We need to close the channel here, but for that to be safe we have
1242 // to do all channel closure inside the channel_state lock which is a
1243 // somewhat-larger refactor, so we leave that for later.
1244 APIError::ChannelUnavailable { err }
1246 ChannelError::Ignore(err) => APIError::ChannelUnavailable { err },
1251 Some((update_add, commitment_signed, chan_monitor)) => {
1252 if let Err(e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1253 self.handle_monitor_update_fail(channel_state, &id, e, RAACommitmentOrder::CommitmentFirst);
1254 return Err(APIError::MonitorUpdateFailed);
1257 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1258 node_id: route.hops.first().unwrap().pubkey,
1259 updates: msgs::CommitmentUpdate {
1260 update_add_htlcs: vec![update_add],
1261 update_fulfill_htlcs: Vec::new(),
1262 update_fail_htlcs: Vec::new(),
1263 update_fail_malformed_htlcs: Vec::new(),
1275 /// Call this upon creation of a funding transaction for the given channel.
1277 /// Note that ALL inputs in the transaction pointed to by funding_txo MUST spend SegWit outputs
1278 /// or your counterparty can steal your funds!
1280 /// Panics if a funding transaction has already been provided for this channel.
1282 /// May panic if the funding_txo is duplicative with some other channel (note that this should
1283 /// be trivially prevented by using unique funding transaction keys per-channel).
1284 pub fn funding_transaction_generated(&self, temporary_channel_id: &[u8; 32], funding_txo: OutPoint) {
1285 let _ = self.total_consistency_lock.read().unwrap();
1287 let (chan, msg, chan_monitor) = {
1289 let mut channel_state = self.channel_state.lock().unwrap();
1290 match channel_state.by_id.remove(temporary_channel_id) {
1292 (chan.get_outbound_funding_created(funding_txo)
1293 .map_err(|e| MsgHandleErrInternal::from_chan_maybe_close(e, chan.channel_id()))
1299 match handle_error!(self, res, chan.get_their_node_id()) {
1300 Ok(funding_msg) => {
1301 (chan, funding_msg.0, funding_msg.1)
1304 log_error!(self, "Got bad signatures: {}!", e.err);
1305 let mut channel_state = self.channel_state.lock().unwrap();
1306 channel_state.pending_msg_events.push(events::MessageSendEvent::HandleError {
1307 node_id: chan.get_their_node_id(),
1314 // Because we have exclusive ownership of the channel here we can release the channel_state
1315 // lock before add_update_monitor
1316 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1320 let mut channel_state = self.channel_state.lock().unwrap();
1321 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
1322 node_id: chan.get_their_node_id(),
1325 match channel_state.by_id.entry(chan.channel_id()) {
1326 hash_map::Entry::Occupied(_) => {
1327 panic!("Generated duplicate funding txid?");
1329 hash_map::Entry::Vacant(e) => {
1335 fn get_announcement_sigs(&self, chan: &Channel) -> Option<msgs::AnnouncementSignatures> {
1336 if !chan.should_announce() { return None }
1338 let (announcement, our_bitcoin_sig) = match chan.get_channel_announcement(self.get_our_node_id(), self.genesis_hash.clone()) {
1340 Err(_) => return None, // Only in case of state precondition violations eg channel is closing
1342 let msghash = Message::from_slice(&Sha256dHash::from_data(&announcement.encode()[..])[..]).unwrap();
1343 let our_node_sig = self.secp_ctx.sign(&msghash, &self.our_network_key);
1345 Some(msgs::AnnouncementSignatures {
1346 channel_id: chan.channel_id(),
1347 short_channel_id: chan.get_short_channel_id().unwrap(),
1348 node_signature: our_node_sig,
1349 bitcoin_signature: our_bitcoin_sig,
1353 /// Processes HTLCs which are pending waiting on random forward delay.
1355 /// Should only really ever be called in response to an PendingHTLCsForwardable event.
1356 /// Will likely generate further events.
1357 pub fn process_pending_htlc_forwards(&self) {
1358 let _ = self.total_consistency_lock.read().unwrap();
1360 let mut new_events = Vec::new();
1361 let mut failed_forwards = Vec::new();
1363 let mut channel_state_lock = self.channel_state.lock().unwrap();
1364 let channel_state = channel_state_lock.borrow_parts();
1366 if cfg!(not(feature = "fuzztarget")) && Instant::now() < *channel_state.next_forward {
1370 for (short_chan_id, mut pending_forwards) in channel_state.forward_htlcs.drain() {
1371 if short_chan_id != 0 {
1372 let forward_chan_id = match channel_state.short_to_id.get(&short_chan_id) {
1373 Some(chan_id) => chan_id.clone(),
1375 failed_forwards.reserve(pending_forwards.len());
1376 for HTLCForwardInfo { prev_short_channel_id, prev_htlc_id, forward_info } in pending_forwards.drain(..) {
1377 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
1378 short_channel_id: prev_short_channel_id,
1379 htlc_id: prev_htlc_id,
1380 incoming_packet_shared_secret: forward_info.incoming_shared_secret,
1382 failed_forwards.push((htlc_source, forward_info.payment_hash, 0x4000 | 10, None));
1387 let forward_chan = &mut channel_state.by_id.get_mut(&forward_chan_id).unwrap();
1389 let mut add_htlc_msgs = Vec::new();
1390 for HTLCForwardInfo { prev_short_channel_id, prev_htlc_id, forward_info } in pending_forwards.drain(..) {
1391 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
1392 short_channel_id: prev_short_channel_id,
1393 htlc_id: prev_htlc_id,
1394 incoming_packet_shared_secret: forward_info.incoming_shared_secret,
1396 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()) {
1398 let chan_update = self.get_channel_update(forward_chan).unwrap();
1399 failed_forwards.push((htlc_source, forward_info.payment_hash, 0x1000 | 7, Some(chan_update)));
1404 Some(msg) => { add_htlc_msgs.push(msg); },
1406 // Nothing to do here...we're waiting on a remote
1407 // revoke_and_ack before we can add anymore HTLCs. The Channel
1408 // will automatically handle building the update_add_htlc and
1409 // commitment_signed messages when we can.
1410 // TODO: Do some kind of timer to set the channel as !is_live()
1411 // as we don't really want others relying on us relaying through
1412 // this channel currently :/.
1419 if !add_htlc_msgs.is_empty() {
1420 let (commitment_msg, monitor) = match forward_chan.send_commitment() {
1423 if let ChannelError::Ignore(_) = e {
1424 panic!("Stated return value requirements in send_commitment() were not met");
1426 //TODO: Handle...this is bad!
1430 if let Err(_e) = self.monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor) {
1431 unimplemented!();// but def dont push the event...
1433 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1434 node_id: forward_chan.get_their_node_id(),
1435 updates: msgs::CommitmentUpdate {
1436 update_add_htlcs: add_htlc_msgs,
1437 update_fulfill_htlcs: Vec::new(),
1438 update_fail_htlcs: Vec::new(),
1439 update_fail_malformed_htlcs: Vec::new(),
1441 commitment_signed: commitment_msg,
1446 for HTLCForwardInfo { prev_short_channel_id, prev_htlc_id, forward_info } in pending_forwards.drain(..) {
1447 let prev_hop_data = HTLCPreviousHopData {
1448 short_channel_id: prev_short_channel_id,
1449 htlc_id: prev_htlc_id,
1450 incoming_packet_shared_secret: forward_info.incoming_shared_secret,
1452 match channel_state.claimable_htlcs.entry(forward_info.payment_hash) {
1453 hash_map::Entry::Occupied(mut entry) => entry.get_mut().push(prev_hop_data),
1454 hash_map::Entry::Vacant(entry) => { entry.insert(vec![prev_hop_data]); },
1456 new_events.push(events::Event::PaymentReceived {
1457 payment_hash: forward_info.payment_hash,
1458 amt: forward_info.amt_to_forward,
1465 for (htlc_source, payment_hash, failure_code, update) in failed_forwards.drain(..) {
1467 None => self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source, &payment_hash, HTLCFailReason::Reason { failure_code, data: Vec::new() }),
1468 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() }),
1472 if new_events.is_empty() { return }
1473 let mut events = self.pending_events.lock().unwrap();
1474 events.append(&mut new_events);
1477 /// Indicates that the preimage for payment_hash is unknown or the received amount is incorrect after a PaymentReceived event.
1478 pub fn fail_htlc_backwards(&self, payment_hash: &[u8; 32], reason: PaymentFailReason) -> bool {
1479 let _ = self.total_consistency_lock.read().unwrap();
1481 let mut channel_state = Some(self.channel_state.lock().unwrap());
1482 let removed_source = channel_state.as_mut().unwrap().claimable_htlcs.remove(payment_hash);
1483 if let Some(mut sources) = removed_source {
1484 for htlc_with_hash in sources.drain(..) {
1485 if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
1486 self.fail_htlc_backwards_internal(channel_state.take().unwrap(), HTLCSource::PreviousHopData(htlc_with_hash), payment_hash, HTLCFailReason::Reason { failure_code: if reason == PaymentFailReason::PreimageUnknown {0x4000 | 15} else {0x4000 | 16}, data: Vec::new() });
1492 /// Fails an HTLC backwards to the sender of it to us.
1493 /// Note that while we take a channel_state lock as input, we do *not* assume consistency here.
1494 /// There are several callsites that do stupid things like loop over a list of payment_hashes
1495 /// to fail and take the channel_state lock for each iteration (as we take ownership and may
1496 /// drop it). In other words, no assumptions are made that entries in claimable_htlcs point to
1497 /// still-available channels.
1498 fn fail_htlc_backwards_internal(&self, mut channel_state_lock: MutexGuard<ChannelHolder>, source: HTLCSource, payment_hash: &[u8; 32], onion_error: HTLCFailReason) {
1500 HTLCSource::OutboundRoute { .. } => {
1501 mem::drop(channel_state_lock);
1502 if let &HTLCFailReason::ErrorPacket { ref err } = &onion_error {
1503 let (channel_update, payment_retryable) = self.process_onion_failure(&source, err.data.clone());
1504 if let Some(update) = channel_update {
1505 self.channel_state.lock().unwrap().pending_msg_events.push(
1506 events::MessageSendEvent::PaymentFailureNetworkUpdate {
1511 self.pending_events.lock().unwrap().push(events::Event::PaymentFailed {
1512 payment_hash: payment_hash.clone(),
1513 rejected_by_dest: !payment_retryable,
1516 panic!("should have onion error packet here");
1519 HTLCSource::PreviousHopData(HTLCPreviousHopData { short_channel_id, htlc_id, incoming_packet_shared_secret }) => {
1520 let err_packet = match onion_error {
1521 HTLCFailReason::Reason { failure_code, data } => {
1522 let packet = ChannelManager::build_failure_packet(&incoming_packet_shared_secret, failure_code, &data[..]).encode();
1523 ChannelManager::encrypt_failure_packet(&incoming_packet_shared_secret, &packet)
1525 HTLCFailReason::ErrorPacket { err } => {
1526 ChannelManager::encrypt_failure_packet(&incoming_packet_shared_secret, &err.data)
1530 let channel_state = channel_state_lock.borrow_parts();
1532 let chan_id = match channel_state.short_to_id.get(&short_channel_id) {
1533 Some(chan_id) => chan_id.clone(),
1537 let chan = channel_state.by_id.get_mut(&chan_id).unwrap();
1538 match chan.get_update_fail_htlc_and_commit(htlc_id, err_packet) {
1539 Ok(Some((msg, commitment_msg, chan_monitor))) => {
1540 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1543 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1544 node_id: chan.get_their_node_id(),
1545 updates: msgs::CommitmentUpdate {
1546 update_add_htlcs: Vec::new(),
1547 update_fulfill_htlcs: Vec::new(),
1548 update_fail_htlcs: vec![msg],
1549 update_fail_malformed_htlcs: Vec::new(),
1551 commitment_signed: commitment_msg,
1557 //TODO: Do something with e?
1565 /// Provides a payment preimage in response to a PaymentReceived event, returning true and
1566 /// generating message events for the net layer to claim the payment, if possible. Thus, you
1567 /// should probably kick the net layer to go send messages if this returns true!
1569 /// May panic if called except in response to a PaymentReceived event.
1570 pub fn claim_funds(&self, payment_preimage: [u8; 32]) -> bool {
1571 let mut sha = Sha256::new();
1572 sha.input(&payment_preimage);
1573 let mut payment_hash = [0; 32];
1574 sha.result(&mut payment_hash);
1576 let _ = self.total_consistency_lock.read().unwrap();
1578 let mut channel_state = Some(self.channel_state.lock().unwrap());
1579 let removed_source = channel_state.as_mut().unwrap().claimable_htlcs.remove(&payment_hash);
1580 if let Some(mut sources) = removed_source {
1581 for htlc_with_hash in sources.drain(..) {
1582 if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
1583 self.claim_funds_internal(channel_state.take().unwrap(), HTLCSource::PreviousHopData(htlc_with_hash), payment_preimage);
1588 fn claim_funds_internal(&self, mut channel_state_lock: MutexGuard<ChannelHolder>, source: HTLCSource, payment_preimage: [u8; 32]) {
1590 HTLCSource::OutboundRoute { .. } => {
1591 mem::drop(channel_state_lock);
1592 let mut pending_events = self.pending_events.lock().unwrap();
1593 pending_events.push(events::Event::PaymentSent {
1597 HTLCSource::PreviousHopData(HTLCPreviousHopData { short_channel_id, htlc_id, .. }) => {
1598 //TODO: Delay the claimed_funds relaying just like we do outbound relay!
1599 let channel_state = channel_state_lock.borrow_parts();
1601 let chan_id = match channel_state.short_to_id.get(&short_channel_id) {
1602 Some(chan_id) => chan_id.clone(),
1604 // TODO: There is probably a channel manager somewhere that needs to
1605 // learn the preimage as the channel already hit the chain and that's
1611 let chan = channel_state.by_id.get_mut(&chan_id).unwrap();
1612 match chan.get_update_fulfill_htlc_and_commit(htlc_id, payment_preimage) {
1613 Ok((msgs, monitor_option)) => {
1614 if let Some(chan_monitor) = monitor_option {
1615 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1616 unimplemented!();// but def dont push the event...
1619 if let Some((msg, commitment_signed)) = msgs {
1620 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1621 node_id: chan.get_their_node_id(),
1622 updates: msgs::CommitmentUpdate {
1623 update_add_htlcs: Vec::new(),
1624 update_fulfill_htlcs: vec![msg],
1625 update_fail_htlcs: Vec::new(),
1626 update_fail_malformed_htlcs: Vec::new(),
1634 // TODO: There is probably a channel manager somewhere that needs to
1635 // learn the preimage as the channel may be about to hit the chain.
1636 //TODO: Do something with e?
1644 /// Gets the node_id held by this ChannelManager
1645 pub fn get_our_node_id(&self) -> PublicKey {
1646 PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key)
1649 /// Used to restore channels to normal operation after a
1650 /// ChannelMonitorUpdateErr::TemporaryFailure was returned from a channel monitor update
1652 pub fn test_restore_channel_monitor(&self) {
1653 let mut close_results = Vec::new();
1654 let mut htlc_forwards = Vec::new();
1655 let mut htlc_failures = Vec::new();
1656 let _ = self.total_consistency_lock.read().unwrap();
1659 let mut channel_lock = self.channel_state.lock().unwrap();
1660 let channel_state = channel_lock.borrow_parts();
1661 let short_to_id = channel_state.short_to_id;
1662 let pending_msg_events = channel_state.pending_msg_events;
1663 channel_state.by_id.retain(|_, channel| {
1664 if channel.is_awaiting_monitor_update() {
1665 let chan_monitor = channel.channel_monitor();
1666 if let Err(e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1668 ChannelMonitorUpdateErr::PermanentFailure => {
1669 if let Some(short_id) = channel.get_short_channel_id() {
1670 short_to_id.remove(&short_id);
1672 close_results.push(channel.force_shutdown());
1673 if let Ok(update) = self.get_channel_update(&channel) {
1674 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1680 ChannelMonitorUpdateErr::TemporaryFailure => true,
1683 let (raa, commitment_update, order, pending_forwards, mut pending_failures) = channel.monitor_updating_restored();
1684 if !pending_forwards.is_empty() {
1685 htlc_forwards.push((channel.get_short_channel_id().expect("We can't have pending forwards before funding confirmation"), pending_forwards));
1687 htlc_failures.append(&mut pending_failures);
1689 macro_rules! handle_cs { () => {
1690 if let Some(update) = commitment_update {
1691 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1692 node_id: channel.get_their_node_id(),
1697 macro_rules! handle_raa { () => {
1698 if let Some(revoke_and_ack) = raa {
1699 pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
1700 node_id: channel.get_their_node_id(),
1701 msg: revoke_and_ack,
1706 RAACommitmentOrder::CommitmentFirst => {
1710 RAACommitmentOrder::RevokeAndACKFirst => {
1721 for failure in htlc_failures.drain(..) {
1722 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), failure.0, &failure.1, failure.2);
1724 self.forward_htlcs(&mut htlc_forwards[..]);
1726 for res in close_results.drain(..) {
1727 self.finish_force_close_channel(res);
1731 fn internal_open_channel(&self, their_node_id: &PublicKey, msg: &msgs::OpenChannel) -> Result<(), MsgHandleErrInternal> {
1732 if msg.chain_hash != self.genesis_hash {
1733 return Err(MsgHandleErrInternal::send_err_msg_no_close("Unknown genesis block hash", msg.temporary_channel_id.clone()));
1736 let channel = Channel::new_from_req(&*self.fee_estimator, &self.keys_manager, their_node_id.clone(), msg, 0, Arc::clone(&self.logger), &self.default_configuration)
1737 .map_err(|e| MsgHandleErrInternal::from_chan_no_close(e, msg.temporary_channel_id))?;
1738 let mut channel_state_lock = self.channel_state.lock().unwrap();
1739 let channel_state = channel_state_lock.borrow_parts();
1740 match channel_state.by_id.entry(channel.channel_id()) {
1741 hash_map::Entry::Occupied(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("temporary_channel_id collision!", msg.temporary_channel_id.clone())),
1742 hash_map::Entry::Vacant(entry) => {
1743 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
1744 node_id: their_node_id.clone(),
1745 msg: channel.get_accept_channel(),
1747 entry.insert(channel);
1753 fn internal_accept_channel(&self, their_node_id: &PublicKey, msg: &msgs::AcceptChannel) -> Result<(), MsgHandleErrInternal> {
1754 let (value, output_script, user_id) = {
1755 let mut channel_state = self.channel_state.lock().unwrap();
1756 match channel_state.by_id.get_mut(&msg.temporary_channel_id) {
1758 if chan.get_their_node_id() != *their_node_id {
1759 //TODO: see issue #153, need a consistent behavior on obnoxious behavior from random node
1760 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.temporary_channel_id));
1762 chan.accept_channel(&msg, &self.default_configuration)
1763 .map_err(|e| MsgHandleErrInternal::from_chan_maybe_close(e, msg.temporary_channel_id))?;
1764 (chan.get_value_satoshis(), chan.get_funding_redeemscript().to_v0_p2wsh(), chan.get_user_id())
1766 //TODO: same as above
1767 None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.temporary_channel_id))
1770 let mut pending_events = self.pending_events.lock().unwrap();
1771 pending_events.push(events::Event::FundingGenerationReady {
1772 temporary_channel_id: msg.temporary_channel_id,
1773 channel_value_satoshis: value,
1774 output_script: output_script,
1775 user_channel_id: user_id,
1780 fn internal_funding_created(&self, their_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), MsgHandleErrInternal> {
1781 let (chan, funding_msg, monitor_update) = {
1782 let mut channel_state = self.channel_state.lock().unwrap();
1783 match channel_state.by_id.entry(msg.temporary_channel_id.clone()) {
1784 hash_map::Entry::Occupied(mut chan) => {
1785 if chan.get().get_their_node_id() != *their_node_id {
1786 //TODO: here and below MsgHandleErrInternal, #153 case
1787 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.temporary_channel_id));
1789 match chan.get_mut().funding_created(msg) {
1790 Ok((funding_msg, monitor_update)) => {
1791 (chan.remove(), funding_msg, monitor_update)
1794 return Err(e).map_err(|e| MsgHandleErrInternal::from_chan_maybe_close(e, msg.temporary_channel_id))
1798 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.temporary_channel_id))
1801 // Because we have exclusive ownership of the channel here we can release the channel_state
1802 // lock before add_update_monitor
1803 if let Err(_e) = self.monitor.add_update_monitor(monitor_update.get_funding_txo().unwrap(), monitor_update) {
1806 let mut channel_state_lock = self.channel_state.lock().unwrap();
1807 let channel_state = channel_state_lock.borrow_parts();
1808 match channel_state.by_id.entry(funding_msg.channel_id) {
1809 hash_map::Entry::Occupied(_) => {
1810 return Err(MsgHandleErrInternal::send_err_msg_no_close("Already had channel with the new channel_id", funding_msg.channel_id))
1812 hash_map::Entry::Vacant(e) => {
1813 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
1814 node_id: their_node_id.clone(),
1823 fn internal_funding_signed(&self, their_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), MsgHandleErrInternal> {
1824 let (funding_txo, user_id) = {
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 let chan_monitor = chan.funding_signed(&msg).map_err(|e| MsgHandleErrInternal::from_chan_maybe_close(e, msg.channel_id))?;
1833 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1836 (chan.get_funding_txo().unwrap(), chan.get_user_id())
1838 None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
1841 let mut pending_events = self.pending_events.lock().unwrap();
1842 pending_events.push(events::Event::FundingBroadcastSafe {
1843 funding_txo: funding_txo,
1844 user_channel_id: user_id,
1849 fn internal_funding_locked(&self, their_node_id: &PublicKey, msg: &msgs::FundingLocked) -> Result<(), MsgHandleErrInternal> {
1850 let mut channel_state_lock = self.channel_state.lock().unwrap();
1851 let channel_state = channel_state_lock.borrow_parts();
1852 match channel_state.by_id.get_mut(&msg.channel_id) {
1854 if chan.get_their_node_id() != *their_node_id {
1855 //TODO: here and below MsgHandleErrInternal, #153 case
1856 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1858 chan.funding_locked(&msg)
1859 .map_err(|e| MsgHandleErrInternal::from_chan_maybe_close(e, msg.channel_id))?;
1860 if let Some(announcement_sigs) = self.get_announcement_sigs(chan) {
1861 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
1862 node_id: their_node_id.clone(),
1863 msg: announcement_sigs,
1868 None => Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
1872 fn internal_shutdown(&self, their_node_id: &PublicKey, msg: &msgs::Shutdown) -> Result<(), MsgHandleErrInternal> {
1873 let (mut dropped_htlcs, chan_option) = {
1874 let mut channel_state_lock = self.channel_state.lock().unwrap();
1875 let channel_state = channel_state_lock.borrow_parts();
1877 match channel_state.by_id.entry(msg.channel_id.clone()) {
1878 hash_map::Entry::Occupied(mut chan_entry) => {
1879 if chan_entry.get().get_their_node_id() != *their_node_id {
1880 //TODO: here and below MsgHandleErrInternal, #153 case
1881 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1883 let (shutdown, closing_signed, dropped_htlcs) = chan_entry.get_mut().shutdown(&*self.fee_estimator, &msg).map_err(|e| MsgHandleErrInternal::from_chan_maybe_close(e, msg.channel_id))?;
1884 if let Some(msg) = shutdown {
1885 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
1886 node_id: their_node_id.clone(),
1890 if let Some(msg) = closing_signed {
1891 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
1892 node_id: their_node_id.clone(),
1896 if chan_entry.get().is_shutdown() {
1897 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
1898 channel_state.short_to_id.remove(&short_id);
1900 (dropped_htlcs, Some(chan_entry.remove_entry().1))
1901 } else { (dropped_htlcs, None) }
1903 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
1906 for htlc_source in dropped_htlcs.drain(..) {
1907 // unknown_next_peer...I dunno who that is anymore....
1908 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() });
1910 if let Some(chan) = chan_option {
1911 if let Ok(update) = self.get_channel_update(&chan) {
1912 let mut channel_state = self.channel_state.lock().unwrap();
1913 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1921 fn internal_closing_signed(&self, their_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<(), MsgHandleErrInternal> {
1922 let (tx, chan_option) = {
1923 let mut channel_state_lock = self.channel_state.lock().unwrap();
1924 let channel_state = channel_state_lock.borrow_parts();
1925 match channel_state.by_id.entry(msg.channel_id.clone()) {
1926 hash_map::Entry::Occupied(mut chan_entry) => {
1927 if chan_entry.get().get_their_node_id() != *their_node_id {
1928 //TODO: here and below MsgHandleErrInternal, #153 case
1929 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1931 let (closing_signed, tx) = chan_entry.get_mut().closing_signed(&*self.fee_estimator, &msg).map_err(|e| MsgHandleErrInternal::from_maybe_close(e))?;
1932 if let Some(msg) = closing_signed {
1933 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
1934 node_id: their_node_id.clone(),
1939 // We're done with this channel, we've got a signed closing transaction and
1940 // will send the closing_signed back to the remote peer upon return. This
1941 // also implies there are no pending HTLCs left on the channel, so we can
1942 // fully delete it from tracking (the channel monitor is still around to
1943 // watch for old state broadcasts)!
1944 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
1945 channel_state.short_to_id.remove(&short_id);
1947 (tx, Some(chan_entry.remove_entry().1))
1948 } else { (tx, None) }
1950 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
1953 if let Some(broadcast_tx) = tx {
1954 self.tx_broadcaster.broadcast_transaction(&broadcast_tx);
1956 if let Some(chan) = chan_option {
1957 if let Ok(update) = self.get_channel_update(&chan) {
1958 let mut channel_state = self.channel_state.lock().unwrap();
1959 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1967 fn internal_update_add_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), MsgHandleErrInternal> {
1968 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
1969 //determine the state of the payment based on our response/if we forward anything/the time
1970 //we take to respond. We should take care to avoid allowing such an attack.
1972 //TODO: There exists a further attack where a node may garble the onion data, forward it to
1973 //us repeatedly garbled in different ways, and compare our error messages, which are
1974 //encrypted with the same key. Its not immediately obvious how to usefully exploit that,
1975 //but we should prevent it anyway.
1977 let (mut pending_forward_info, mut channel_state_lock) = self.decode_update_add_htlc_onion(msg);
1978 let channel_state = channel_state_lock.borrow_parts();
1980 match channel_state.by_id.get_mut(&msg.channel_id) {
1982 if chan.get_their_node_id() != *their_node_id {
1983 //TODO: here MsgHandleErrInternal, #153 case
1984 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1986 if !chan.is_usable() {
1987 // If the update_add is completely bogus, the call will Err and we will close,
1988 // but if we've sent a shutdown and they haven't acknowledged it yet, we just
1989 // want to reject the new HTLC and fail it backwards instead of forwarding.
1990 if let PendingHTLCStatus::Forward(PendingForwardHTLCInfo { incoming_shared_secret, .. }) = pending_forward_info {
1991 pending_forward_info = PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
1992 channel_id: msg.channel_id,
1993 htlc_id: msg.htlc_id,
1994 reason: ChannelManager::build_first_hop_failure_packet(&incoming_shared_secret, 0x1000|20, &self.get_channel_update(chan).unwrap().encode_with_len()[..]),
1998 chan.update_add_htlc(&msg, pending_forward_info).map_err(|e| MsgHandleErrInternal::from_maybe_close(e))
2000 None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2004 fn internal_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), MsgHandleErrInternal> {
2005 let mut channel_state = self.channel_state.lock().unwrap();
2006 let htlc_source = match channel_state.by_id.get_mut(&msg.channel_id) {
2008 if chan.get_their_node_id() != *their_node_id {
2009 //TODO: here and below MsgHandleErrInternal, #153 case
2010 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2012 chan.update_fulfill_htlc(&msg)
2013 .map_err(|e| MsgHandleErrInternal::from_chan_maybe_close(e, msg.channel_id))?.clone()
2015 None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2017 self.claim_funds_internal(channel_state, htlc_source, msg.payment_preimage.clone());
2021 // Process failure we got back from upstream on a payment we sent. Returns update and a boolean
2022 // indicating that the payment itself failed
2023 fn process_onion_failure(&self, htlc_source: &HTLCSource, mut packet_decrypted: Vec<u8>) -> (Option<msgs::HTLCFailChannelUpdate>, bool) {
2024 if let &HTLCSource::OutboundRoute { ref route, ref session_priv, ref first_hop_htlc_msat } = htlc_source {
2025 macro_rules! onion_failure_log {
2026 ( $error_code_textual: expr, $error_code: expr, $reported_name: expr, $reported_value: expr ) => {
2027 log_trace!(self, "{}({:#x}) {}({})", $error_code_textual, $error_code, $reported_name, $reported_value);
2029 ( $error_code_textual: expr, $error_code: expr ) => {
2030 log_trace!(self, "{}({})", $error_code_textual, $error_code);
2034 const BADONION: u16 = 0x8000;
2035 const PERM: u16 = 0x4000;
2036 const UPDATE: u16 = 0x1000;
2039 let mut htlc_msat = *first_hop_htlc_msat;
2041 // Handle packed channel/node updates for passing back for the route handler
2042 Self::construct_onion_keys_callback(&self.secp_ctx, route, session_priv, |shared_secret, _, _, route_hop| {
2043 if res.is_some() { return; }
2045 let incoming_htlc_msat = htlc_msat;
2046 let amt_to_forward = htlc_msat - route_hop.fee_msat;
2047 htlc_msat = amt_to_forward;
2049 let ammag = ChannelManager::gen_ammag_from_shared_secret(&shared_secret[..]);
2051 let mut decryption_tmp = Vec::with_capacity(packet_decrypted.len());
2052 decryption_tmp.resize(packet_decrypted.len(), 0);
2053 let mut chacha = ChaCha20::new(&ammag, &[0u8; 8]);
2054 chacha.process(&packet_decrypted, &mut decryption_tmp[..]);
2055 packet_decrypted = decryption_tmp;
2057 let is_from_final_node = route.hops.last().unwrap().pubkey == route_hop.pubkey;
2059 if let Ok(err_packet) = msgs::DecodedOnionErrorPacket::read(&mut Cursor::new(&packet_decrypted)) {
2060 let um = ChannelManager::gen_um_from_shared_secret(&shared_secret[..]);
2061 let mut hmac = Hmac::new(Sha256::new(), &um);
2062 hmac.input(&err_packet.encode()[32..]);
2063 let mut calc_tag = [0u8; 32];
2064 hmac.raw_result(&mut calc_tag);
2066 if crypto::util::fixed_time_eq(&calc_tag, &err_packet.hmac) {
2067 if err_packet.failuremsg.len() < 2 {
2068 // Useless packet that we can't use but it passed HMAC, so it
2069 // definitely came from the peer in question
2070 res = Some((None, !is_from_final_node));
2072 let error_code = byte_utils::slice_to_be16(&err_packet.failuremsg[0..2]);
2074 match error_code & 0xff {
2076 // either from an intermediate or final node
2077 // invalid_realm(PERM|1),
2078 // temporary_node_failure(NODE|2)
2079 // permanent_node_failure(PERM|NODE|2)
2080 // required_node_feature_mssing(PERM|NODE|3)
2081 res = Some((Some(msgs::HTLCFailChannelUpdate::NodeFailure {
2082 node_id: route_hop.pubkey,
2083 is_permanent: error_code & PERM == PERM,
2084 }), !(error_code & PERM == PERM && is_from_final_node)));
2085 // node returning invalid_realm is removed from network_map,
2086 // although NODE flag is not set, TODO: or remove channel only?
2087 // retry payment when removed node is not a final node
2093 if is_from_final_node {
2094 let payment_retryable = match error_code {
2095 c if c == PERM|15 => false, // unknown_payment_hash
2096 c if c == PERM|16 => false, // incorrect_payment_amount
2097 17 => true, // final_expiry_too_soon
2098 18 if err_packet.failuremsg.len() == 6 => { // final_incorrect_cltv_expiry
2099 let _reported_cltv_expiry = byte_utils::slice_to_be32(&err_packet.failuremsg[2..2+4]);
2102 19 if err_packet.failuremsg.len() == 10 => { // final_incorrect_htlc_amount
2103 let _reported_incoming_htlc_msat = byte_utils::slice_to_be64(&err_packet.failuremsg[2..2+8]);
2107 // A final node has sent us either an invalid code or an error_code that
2108 // MUST be sent from the processing node, or the formmat of failuremsg
2109 // does not coform to the spec.
2110 // Remove it from the network map and don't may retry payment
2111 res = Some((Some(msgs::HTLCFailChannelUpdate::NodeFailure {
2112 node_id: route_hop.pubkey,
2118 res = Some((None, payment_retryable));
2122 // now, error_code should be only from the intermediate nodes
2124 _c if error_code & PERM == PERM => {
2125 res = Some((Some(msgs::HTLCFailChannelUpdate::ChannelClosed {
2126 short_channel_id: route_hop.short_channel_id,
2130 _c if error_code & UPDATE == UPDATE => {
2131 let offset = match error_code {
2132 c if c == UPDATE|7 => 0, // temporary_channel_failure
2133 c if c == UPDATE|11 => 8, // amount_below_minimum
2134 c if c == UPDATE|12 => 8, // fee_insufficient
2135 c if c == UPDATE|13 => 4, // incorrect_cltv_expiry
2136 c if c == UPDATE|14 => 0, // expiry_too_soon
2137 c if c == UPDATE|20 => 2, // channel_disabled
2139 // node sending unknown code
2140 res = Some((Some(msgs::HTLCFailChannelUpdate::NodeFailure {
2141 node_id: route_hop.pubkey,
2148 if err_packet.failuremsg.len() >= offset + 2 {
2149 let update_len = byte_utils::slice_to_be16(&err_packet.failuremsg[offset+2..offset+4]) as usize;
2150 if err_packet.failuremsg.len() >= offset + 4 + update_len {
2151 if let Ok(chan_update) = msgs::ChannelUpdate::read(&mut Cursor::new(&err_packet.failuremsg[offset + 4..offset + 4 + update_len])) {
2152 // if channel_update should NOT have caused the failure:
2153 // MAY treat the channel_update as invalid.
2154 let is_chan_update_invalid = match error_code {
2155 c if c == UPDATE|7 => { // temporary_channel_failure
2158 c if c == UPDATE|11 => { // amount_below_minimum
2159 let reported_htlc_msat = byte_utils::slice_to_be64(&err_packet.failuremsg[2..2+8]);
2160 onion_failure_log!("amount_below_minimum", UPDATE|11, "htlc_msat", reported_htlc_msat);
2161 incoming_htlc_msat > chan_update.contents.htlc_minimum_msat
2163 c if c == UPDATE|12 => { // fee_insufficient
2164 let reported_htlc_msat = byte_utils::slice_to_be64(&err_packet.failuremsg[2..2+8]);
2165 let new_fee = amt_to_forward.checked_mul(chan_update.contents.fee_proportional_millionths as u64).and_then(|prop_fee| { (prop_fee / 1000000).checked_add(chan_update.contents.fee_base_msat as u64) });
2166 onion_failure_log!("fee_insufficient", UPDATE|12, "htlc_msat", reported_htlc_msat);
2167 new_fee.is_none() || incoming_htlc_msat >= new_fee.unwrap() && incoming_htlc_msat >= amt_to_forward + new_fee.unwrap()
2169 c if c == UPDATE|13 => { // incorrect_cltv_expiry
2170 let reported_cltv_expiry = byte_utils::slice_to_be32(&err_packet.failuremsg[2..2+4]);
2171 onion_failure_log!("incorrect_cltv_expiry", UPDATE|13, "cltv_expiry", reported_cltv_expiry);
2172 route_hop.cltv_expiry_delta as u16 >= chan_update.contents.cltv_expiry_delta
2174 c if c == UPDATE|20 => { // channel_disabled
2175 let reported_flags = byte_utils::slice_to_be16(&err_packet.failuremsg[2..2+2]);
2176 onion_failure_log!("channel_disabled", UPDATE|20, "flags", reported_flags);
2177 chan_update.contents.flags & 0x01 == 0x01
2179 c if c == UPDATE|21 => true, // expiry_too_far
2180 _ => { unreachable!(); },
2183 let msg = if is_chan_update_invalid { None } else {
2184 Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage {
2188 res = Some((msg, true));
2194 _c if error_code & BADONION == BADONION => {
2197 14 => { // expiry_too_soon
2198 res = Some((None, true));
2202 // node sending unknown code
2203 res = Some((Some(msgs::HTLCFailChannelUpdate::NodeFailure {
2204 node_id: route_hop.pubkey,
2213 }).expect("Route that we sent via spontaneously grew invalid keys in the middle of it?");
2214 res.unwrap_or((None, true))
2215 } else { ((None, true)) }
2218 fn internal_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), MsgHandleErrInternal> {
2219 let mut channel_state = self.channel_state.lock().unwrap();
2220 match channel_state.by_id.get_mut(&msg.channel_id) {
2222 if chan.get_their_node_id() != *their_node_id {
2223 //TODO: here and below MsgHandleErrInternal, #153 case
2224 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2226 chan.update_fail_htlc(&msg, HTLCFailReason::ErrorPacket { err: msg.reason.clone() })
2227 .map_err(|e| MsgHandleErrInternal::from_chan_maybe_close(e, msg.channel_id))
2229 None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2234 fn internal_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), MsgHandleErrInternal> {
2235 let mut channel_state = self.channel_state.lock().unwrap();
2236 match channel_state.by_id.get_mut(&msg.channel_id) {
2238 if chan.get_their_node_id() != *their_node_id {
2239 //TODO: here and below MsgHandleErrInternal, #153 case
2240 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2242 if (msg.failure_code & 0x8000) == 0 {
2243 return Err(MsgHandleErrInternal::send_err_msg_close_chan("Got update_fail_malformed_htlc with BADONION not set", msg.channel_id));
2245 chan.update_fail_malformed_htlc(&msg, HTLCFailReason::Reason { failure_code: msg.failure_code, data: Vec::new() })
2246 .map_err(|e| MsgHandleErrInternal::from_chan_maybe_close(e, msg.channel_id))?;
2249 None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2253 fn internal_commitment_signed(&self, their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), MsgHandleErrInternal> {
2254 let mut channel_state_lock = self.channel_state.lock().unwrap();
2255 let channel_state = channel_state_lock.borrow_parts();
2256 match channel_state.by_id.get_mut(&msg.channel_id) {
2258 if chan.get_their_node_id() != *their_node_id {
2259 //TODO: here and below MsgHandleErrInternal, #153 case
2260 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2262 let (revoke_and_ack, commitment_signed, closing_signed, chan_monitor) = chan.commitment_signed(&msg, &*self.fee_estimator)
2263 .map_err(|e| MsgHandleErrInternal::from_chan_maybe_close(e, msg.channel_id))?;
2264 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
2267 channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
2268 node_id: their_node_id.clone(),
2269 msg: revoke_and_ack,
2271 if let Some(msg) = commitment_signed {
2272 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2273 node_id: their_node_id.clone(),
2274 updates: msgs::CommitmentUpdate {
2275 update_add_htlcs: Vec::new(),
2276 update_fulfill_htlcs: Vec::new(),
2277 update_fail_htlcs: Vec::new(),
2278 update_fail_malformed_htlcs: Vec::new(),
2280 commitment_signed: msg,
2284 if let Some(msg) = closing_signed {
2285 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
2286 node_id: their_node_id.clone(),
2292 None => Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2297 fn forward_htlcs(&self, per_source_pending_forwards: &mut [(u64, Vec<(PendingForwardHTLCInfo, u64)>)]) {
2298 for &mut (prev_short_channel_id, ref mut pending_forwards) in per_source_pending_forwards {
2299 let mut forward_event = None;
2300 if !pending_forwards.is_empty() {
2301 let mut channel_state = self.channel_state.lock().unwrap();
2302 if channel_state.forward_htlcs.is_empty() {
2303 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));
2304 channel_state.next_forward = forward_event.unwrap();
2306 for (forward_info, prev_htlc_id) in pending_forwards.drain(..) {
2307 match channel_state.forward_htlcs.entry(forward_info.short_channel_id) {
2308 hash_map::Entry::Occupied(mut entry) => {
2309 entry.get_mut().push(HTLCForwardInfo { prev_short_channel_id, prev_htlc_id, forward_info });
2311 hash_map::Entry::Vacant(entry) => {
2312 entry.insert(vec!(HTLCForwardInfo { prev_short_channel_id, prev_htlc_id, forward_info }));
2317 match forward_event {
2319 let mut pending_events = self.pending_events.lock().unwrap();
2320 pending_events.push(events::Event::PendingHTLCsForwardable {
2321 time_forwardable: time
2329 fn internal_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), MsgHandleErrInternal> {
2330 let (pending_forwards, mut pending_failures, short_channel_id) = {
2331 let mut channel_state_lock = self.channel_state.lock().unwrap();
2332 let channel_state = channel_state_lock.borrow_parts();
2333 match channel_state.by_id.get_mut(&msg.channel_id) {
2335 if chan.get_their_node_id() != *their_node_id {
2336 //TODO: here and below MsgHandleErrInternal, #153 case
2337 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2339 let (commitment_update, pending_forwards, pending_failures, closing_signed, chan_monitor) = chan.revoke_and_ack(&msg, &*self.fee_estimator)
2340 .map_err(|e| MsgHandleErrInternal::from_chan_maybe_close(e, msg.channel_id))?;
2341 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
2344 if let Some(updates) = commitment_update {
2345 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2346 node_id: their_node_id.clone(),
2350 if let Some(msg) = closing_signed {
2351 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
2352 node_id: their_node_id.clone(),
2356 (pending_forwards, pending_failures, chan.get_short_channel_id().expect("RAA should only work on a short-id-available channel"))
2358 None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2361 for failure in pending_failures.drain(..) {
2362 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), failure.0, &failure.1, failure.2);
2364 self.forward_htlcs(&mut [(short_channel_id, pending_forwards)]);
2369 fn internal_update_fee(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), MsgHandleErrInternal> {
2370 let mut channel_state = self.channel_state.lock().unwrap();
2371 match channel_state.by_id.get_mut(&msg.channel_id) {
2373 if chan.get_their_node_id() != *their_node_id {
2374 //TODO: here and below MsgHandleErrInternal, #153 case
2375 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2377 chan.update_fee(&*self.fee_estimator, &msg).map_err(|e| MsgHandleErrInternal::from_chan_maybe_close(e, msg.channel_id))
2379 None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2383 fn internal_announcement_signatures(&self, their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), MsgHandleErrInternal> {
2384 let mut channel_state_lock = self.channel_state.lock().unwrap();
2385 let channel_state = channel_state_lock.borrow_parts();
2387 match channel_state.by_id.get_mut(&msg.channel_id) {
2389 if chan.get_their_node_id() != *their_node_id {
2390 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2392 if !chan.is_usable() {
2393 return Err(MsgHandleErrInternal::from_no_close(HandleError{err: "Got an announcement_signatures before we were ready for it", action: Some(msgs::ErrorAction::IgnoreError)}));
2396 let our_node_id = self.get_our_node_id();
2397 let (announcement, our_bitcoin_sig) = chan.get_channel_announcement(our_node_id.clone(), self.genesis_hash.clone())
2398 .map_err(|e| MsgHandleErrInternal::from_chan_maybe_close(e, msg.channel_id))?;
2400 let were_node_one = announcement.node_id_1 == our_node_id;
2401 let msghash = Message::from_slice(&Sha256dHash::from_data(&announcement.encode()[..])[..]).unwrap();
2402 let bad_sig_action = MsgHandleErrInternal::send_err_msg_close_chan("Bad announcement_signatures node_signature", msg.channel_id);
2403 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);
2404 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);
2406 let our_node_sig = self.secp_ctx.sign(&msghash, &self.our_network_key);
2408 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
2409 msg: msgs::ChannelAnnouncement {
2410 node_signature_1: if were_node_one { our_node_sig } else { msg.node_signature },
2411 node_signature_2: if were_node_one { msg.node_signature } else { our_node_sig },
2412 bitcoin_signature_1: if were_node_one { our_bitcoin_sig } else { msg.bitcoin_signature },
2413 bitcoin_signature_2: if were_node_one { msg.bitcoin_signature } else { our_bitcoin_sig },
2414 contents: announcement,
2416 update_msg: self.get_channel_update(chan).unwrap(), // can only fail if we're not in a ready state
2419 None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2424 fn internal_channel_reestablish(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<(), MsgHandleErrInternal> {
2425 let mut channel_state_lock = self.channel_state.lock().unwrap();
2426 let channel_state = channel_state_lock.borrow_parts();
2428 match channel_state.by_id.get_mut(&msg.channel_id) {
2430 if chan.get_their_node_id() != *their_node_id {
2431 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2433 let (funding_locked, revoke_and_ack, commitment_update, channel_monitor, order, shutdown) = chan.channel_reestablish(msg)
2434 .map_err(|e| MsgHandleErrInternal::from_chan_maybe_close(e, msg.channel_id))?;
2435 if let Some(monitor) = channel_monitor {
2436 if let Err(_e) = self.monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor) {
2440 if let Some(msg) = funding_locked {
2441 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingLocked {
2442 node_id: their_node_id.clone(),
2446 macro_rules! send_raa { () => {
2447 if let Some(msg) = revoke_and_ack {
2448 channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
2449 node_id: their_node_id.clone(),
2454 macro_rules! send_cu { () => {
2455 if let Some(updates) = commitment_update {
2456 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2457 node_id: their_node_id.clone(),
2463 RAACommitmentOrder::RevokeAndACKFirst => {
2467 RAACommitmentOrder::CommitmentFirst => {
2472 if let Some(msg) = shutdown {
2473 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
2474 node_id: their_node_id.clone(),
2480 None => Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2484 /// Begin Update fee process. Allowed only on an outbound channel.
2485 /// If successful, will generate a UpdateHTLCs event, so you should probably poll
2486 /// PeerManager::process_events afterwards.
2487 /// Note: This API is likely to change!
2489 pub fn update_fee(&self, channel_id: [u8;32], feerate_per_kw: u64) -> Result<(), APIError> {
2490 let _ = self.total_consistency_lock.read().unwrap();
2491 let mut channel_state_lock = self.channel_state.lock().unwrap();
2492 let channel_state = channel_state_lock.borrow_parts();
2494 match channel_state.by_id.get_mut(&channel_id) {
2495 None => return Err(APIError::APIMisuseError{err: "Failed to find corresponding channel"}),
2497 if !chan.is_outbound() {
2498 return Err(APIError::APIMisuseError{err: "update_fee cannot be sent for an inbound channel"});
2500 if chan.is_awaiting_monitor_update() {
2501 return Err(APIError::MonitorUpdateFailed);
2503 if !chan.is_live() {
2504 return Err(APIError::ChannelUnavailable{err: "Channel is either not yet fully established or peer is currently disconnected"});
2506 if let Some((update_fee, commitment_signed, chan_monitor)) = chan.send_update_fee_and_commit(feerate_per_kw)
2507 .map_err(|e| match e {
2508 ChannelError::Ignore(err) => APIError::APIMisuseError{err},
2509 ChannelError::Close(err) => {
2510 // TODO: We need to close the channel here, but for that to be safe we have
2511 // to do all channel closure inside the channel_state lock which is a
2512 // somewhat-larger refactor, so we leave that for later.
2513 APIError::APIMisuseError{err}
2516 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
2519 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2520 node_id: chan.get_their_node_id(),
2521 updates: msgs::CommitmentUpdate {
2522 update_add_htlcs: Vec::new(),
2523 update_fulfill_htlcs: Vec::new(),
2524 update_fail_htlcs: Vec::new(),
2525 update_fail_malformed_htlcs: Vec::new(),
2526 update_fee: Some(update_fee),
2537 impl events::MessageSendEventsProvider for ChannelManager {
2538 fn get_and_clear_pending_msg_events(&self) -> Vec<events::MessageSendEvent> {
2539 let mut ret = Vec::new();
2540 let mut channel_state = self.channel_state.lock().unwrap();
2541 mem::swap(&mut ret, &mut channel_state.pending_msg_events);
2546 impl events::EventsProvider for ChannelManager {
2547 fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
2548 let mut ret = Vec::new();
2549 let mut pending_events = self.pending_events.lock().unwrap();
2550 mem::swap(&mut ret, &mut *pending_events);
2555 impl ChainListener for ChannelManager {
2556 fn block_connected(&self, header: &BlockHeader, height: u32, txn_matched: &[&Transaction], indexes_of_txn_matched: &[u32]) {
2557 let _ = self.total_consistency_lock.read().unwrap();
2558 let mut failed_channels = Vec::new();
2560 let mut channel_lock = self.channel_state.lock().unwrap();
2561 let channel_state = channel_lock.borrow_parts();
2562 let short_to_id = channel_state.short_to_id;
2563 let pending_msg_events = channel_state.pending_msg_events;
2564 channel_state.by_id.retain(|_, channel| {
2565 let chan_res = channel.block_connected(header, height, txn_matched, indexes_of_txn_matched);
2566 if let Ok(Some(funding_locked)) = chan_res {
2567 pending_msg_events.push(events::MessageSendEvent::SendFundingLocked {
2568 node_id: channel.get_their_node_id(),
2569 msg: funding_locked,
2571 if let Some(announcement_sigs) = self.get_announcement_sigs(channel) {
2572 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
2573 node_id: channel.get_their_node_id(),
2574 msg: announcement_sigs,
2577 short_to_id.insert(channel.get_short_channel_id().unwrap(), channel.channel_id());
2578 } else if let Err(e) = chan_res {
2579 pending_msg_events.push(events::MessageSendEvent::HandleError {
2580 node_id: channel.get_their_node_id(),
2583 if channel.is_shutdown() {
2587 if let Some(funding_txo) = channel.get_funding_txo() {
2588 for tx in txn_matched {
2589 for inp in tx.input.iter() {
2590 if inp.previous_output == funding_txo.into_bitcoin_outpoint() {
2591 if let Some(short_id) = channel.get_short_channel_id() {
2592 short_to_id.remove(&short_id);
2594 // It looks like our counterparty went on-chain. We go ahead and
2595 // broadcast our latest local state as well here, just in case its
2596 // some kind of SPV attack, though we expect these to be dropped.
2597 failed_channels.push(channel.force_shutdown());
2598 if let Ok(update) = self.get_channel_update(&channel) {
2599 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2608 if channel.is_funding_initiated() && channel.channel_monitor().would_broadcast_at_height(height) {
2609 if let Some(short_id) = channel.get_short_channel_id() {
2610 short_to_id.remove(&short_id);
2612 failed_channels.push(channel.force_shutdown());
2613 // If would_broadcast_at_height() is true, the channel_monitor will broadcast
2614 // the latest local tx for us, so we should skip that here (it doesn't really
2615 // hurt anything, but does make tests a bit simpler).
2616 failed_channels.last_mut().unwrap().0 = Vec::new();
2617 if let Ok(update) = self.get_channel_update(&channel) {
2618 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2627 for failure in failed_channels.drain(..) {
2628 self.finish_force_close_channel(failure);
2630 self.latest_block_height.store(height as usize, Ordering::Release);
2631 *self.last_block_hash.try_lock().expect("block_(dis)connected must not be called in parallel") = header.bitcoin_hash();
2634 /// We force-close the channel without letting our counterparty participate in the shutdown
2635 fn block_disconnected(&self, header: &BlockHeader) {
2636 let _ = self.total_consistency_lock.read().unwrap();
2637 let mut failed_channels = Vec::new();
2639 let mut channel_lock = self.channel_state.lock().unwrap();
2640 let channel_state = channel_lock.borrow_parts();
2641 let short_to_id = channel_state.short_to_id;
2642 let pending_msg_events = channel_state.pending_msg_events;
2643 channel_state.by_id.retain(|_, v| {
2644 if v.block_disconnected(header) {
2645 if let Some(short_id) = v.get_short_channel_id() {
2646 short_to_id.remove(&short_id);
2648 failed_channels.push(v.force_shutdown());
2649 if let Ok(update) = self.get_channel_update(&v) {
2650 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2660 for failure in failed_channels.drain(..) {
2661 self.finish_force_close_channel(failure);
2663 self.latest_block_height.fetch_sub(1, Ordering::AcqRel);
2664 *self.last_block_hash.try_lock().expect("block_(dis)connected must not be called in parallel") = header.bitcoin_hash();
2668 impl ChannelMessageHandler for ChannelManager {
2669 //TODO: Handle errors and close channel (or so)
2670 fn handle_open_channel(&self, their_node_id: &PublicKey, msg: &msgs::OpenChannel) -> Result<(), HandleError> {
2671 let _ = self.total_consistency_lock.read().unwrap();
2672 handle_error!(self, self.internal_open_channel(their_node_id, msg), their_node_id)
2675 fn handle_accept_channel(&self, their_node_id: &PublicKey, msg: &msgs::AcceptChannel) -> Result<(), HandleError> {
2676 let _ = self.total_consistency_lock.read().unwrap();
2677 handle_error!(self, self.internal_accept_channel(their_node_id, msg), their_node_id)
2680 fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), HandleError> {
2681 let _ = self.total_consistency_lock.read().unwrap();
2682 handle_error!(self, self.internal_funding_created(their_node_id, msg), their_node_id)
2685 fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), HandleError> {
2686 let _ = self.total_consistency_lock.read().unwrap();
2687 handle_error!(self, self.internal_funding_signed(their_node_id, msg), their_node_id)
2690 fn handle_funding_locked(&self, their_node_id: &PublicKey, msg: &msgs::FundingLocked) -> Result<(), HandleError> {
2691 let _ = self.total_consistency_lock.read().unwrap();
2692 handle_error!(self, self.internal_funding_locked(their_node_id, msg), their_node_id)
2695 fn handle_shutdown(&self, their_node_id: &PublicKey, msg: &msgs::Shutdown) -> Result<(), HandleError> {
2696 let _ = self.total_consistency_lock.read().unwrap();
2697 handle_error!(self, self.internal_shutdown(their_node_id, msg), their_node_id)
2700 fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<(), HandleError> {
2701 let _ = self.total_consistency_lock.read().unwrap();
2702 handle_error!(self, self.internal_closing_signed(their_node_id, msg), their_node_id)
2705 fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), msgs::HandleError> {
2706 let _ = self.total_consistency_lock.read().unwrap();
2707 handle_error!(self, self.internal_update_add_htlc(their_node_id, msg), their_node_id)
2710 fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), HandleError> {
2711 let _ = self.total_consistency_lock.read().unwrap();
2712 handle_error!(self, self.internal_update_fulfill_htlc(their_node_id, msg), their_node_id)
2715 fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), HandleError> {
2716 let _ = self.total_consistency_lock.read().unwrap();
2717 handle_error!(self, self.internal_update_fail_htlc(their_node_id, msg), their_node_id)
2720 fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), HandleError> {
2721 let _ = self.total_consistency_lock.read().unwrap();
2722 handle_error!(self, self.internal_update_fail_malformed_htlc(their_node_id, msg), their_node_id)
2725 fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), HandleError> {
2726 let _ = self.total_consistency_lock.read().unwrap();
2727 handle_error!(self, self.internal_commitment_signed(their_node_id, msg), their_node_id)
2730 fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), HandleError> {
2731 let _ = self.total_consistency_lock.read().unwrap();
2732 handle_error!(self, self.internal_revoke_and_ack(their_node_id, msg), their_node_id)
2735 fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), HandleError> {
2736 let _ = self.total_consistency_lock.read().unwrap();
2737 handle_error!(self, self.internal_update_fee(their_node_id, msg), their_node_id)
2740 fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), HandleError> {
2741 let _ = self.total_consistency_lock.read().unwrap();
2742 handle_error!(self, self.internal_announcement_signatures(their_node_id, msg), their_node_id)
2745 fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<(), HandleError> {
2746 let _ = self.total_consistency_lock.read().unwrap();
2747 handle_error!(self, self.internal_channel_reestablish(their_node_id, msg), their_node_id)
2750 fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool) {
2751 let _ = self.total_consistency_lock.read().unwrap();
2752 let mut failed_channels = Vec::new();
2753 let mut failed_payments = Vec::new();
2755 let mut channel_state_lock = self.channel_state.lock().unwrap();
2756 let channel_state = channel_state_lock.borrow_parts();
2757 let short_to_id = channel_state.short_to_id;
2758 let pending_msg_events = channel_state.pending_msg_events;
2759 if no_connection_possible {
2760 log_debug!(self, "Failing all channels with {} due to no_connection_possible", log_pubkey!(their_node_id));
2761 channel_state.by_id.retain(|_, chan| {
2762 if chan.get_their_node_id() == *their_node_id {
2763 if let Some(short_id) = chan.get_short_channel_id() {
2764 short_to_id.remove(&short_id);
2766 failed_channels.push(chan.force_shutdown());
2767 if let Ok(update) = self.get_channel_update(&chan) {
2768 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2778 log_debug!(self, "Marking channels with {} disconnected and generating channel_updates", log_pubkey!(their_node_id));
2779 channel_state.by_id.retain(|_, chan| {
2780 if chan.get_their_node_id() == *their_node_id {
2781 //TODO: mark channel disabled (and maybe announce such after a timeout).
2782 let failed_adds = chan.remove_uncommitted_htlcs_and_mark_paused();
2783 if !failed_adds.is_empty() {
2784 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
2785 failed_payments.push((chan_update, failed_adds));
2787 if chan.is_shutdown() {
2788 if let Some(short_id) = chan.get_short_channel_id() {
2789 short_to_id.remove(&short_id);
2798 for failure in failed_channels.drain(..) {
2799 self.finish_force_close_channel(failure);
2801 for (chan_update, mut htlc_sources) in failed_payments {
2802 for (htlc_source, payment_hash) in htlc_sources.drain(..) {
2803 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source, &payment_hash, HTLCFailReason::Reason { failure_code: 0x1000 | 7, data: chan_update.clone() });
2808 fn peer_connected(&self, their_node_id: &PublicKey) {
2809 log_debug!(self, "Generating channel_reestablish events for {}", log_pubkey!(their_node_id));
2811 let _ = self.total_consistency_lock.read().unwrap();
2812 let mut channel_state_lock = self.channel_state.lock().unwrap();
2813 let channel_state = channel_state_lock.borrow_parts();
2814 let pending_msg_events = channel_state.pending_msg_events;
2815 channel_state.by_id.retain(|_, chan| {
2816 if chan.get_their_node_id() == *their_node_id {
2817 if !chan.have_received_message() {
2818 // If we created this (outbound) channel while we were disconnected from the
2819 // peer we probably failed to send the open_channel message, which is now
2820 // lost. We can't have had anything pending related to this channel, so we just
2824 pending_msg_events.push(events::MessageSendEvent::SendChannelReestablish {
2825 node_id: chan.get_their_node_id(),
2826 msg: chan.get_channel_reestablish(),
2832 //TODO: Also re-broadcast announcement_signatures
2835 fn handle_error(&self, their_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
2836 let _ = self.total_consistency_lock.read().unwrap();
2838 if msg.channel_id == [0; 32] {
2839 for chan in self.list_channels() {
2840 if chan.remote_network_id == *their_node_id {
2841 self.force_close_channel(&chan.channel_id);
2845 self.force_close_channel(&msg.channel_id);
2850 const SERIALIZATION_VERSION: u8 = 1;
2851 const MIN_SERIALIZATION_VERSION: u8 = 1;
2853 impl Writeable for PendingForwardHTLCInfo {
2854 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
2855 if let &Some(ref onion) = &self.onion_packet {
2857 onion.write(writer)?;
2861 self.incoming_shared_secret.write(writer)?;
2862 self.payment_hash.write(writer)?;
2863 self.short_channel_id.write(writer)?;
2864 self.amt_to_forward.write(writer)?;
2865 self.outgoing_cltv_value.write(writer)?;
2870 impl<R: ::std::io::Read> Readable<R> for PendingForwardHTLCInfo {
2871 fn read(reader: &mut R) -> Result<PendingForwardHTLCInfo, DecodeError> {
2872 let onion_packet = match <u8 as Readable<R>>::read(reader)? {
2874 1 => Some(msgs::OnionPacket::read(reader)?),
2875 _ => return Err(DecodeError::InvalidValue),
2877 Ok(PendingForwardHTLCInfo {
2879 incoming_shared_secret: Readable::read(reader)?,
2880 payment_hash: Readable::read(reader)?,
2881 short_channel_id: Readable::read(reader)?,
2882 amt_to_forward: Readable::read(reader)?,
2883 outgoing_cltv_value: Readable::read(reader)?,
2888 impl Writeable for HTLCFailureMsg {
2889 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
2891 &HTLCFailureMsg::Relay(ref fail_msg) => {
2893 fail_msg.write(writer)?;
2895 &HTLCFailureMsg::Malformed(ref fail_msg) => {
2897 fail_msg.write(writer)?;
2904 impl<R: ::std::io::Read> Readable<R> for HTLCFailureMsg {
2905 fn read(reader: &mut R) -> Result<HTLCFailureMsg, DecodeError> {
2906 match <u8 as Readable<R>>::read(reader)? {
2907 0 => Ok(HTLCFailureMsg::Relay(Readable::read(reader)?)),
2908 1 => Ok(HTLCFailureMsg::Malformed(Readable::read(reader)?)),
2909 _ => Err(DecodeError::InvalidValue),
2914 impl Writeable for PendingHTLCStatus {
2915 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
2917 &PendingHTLCStatus::Forward(ref forward_info) => {
2919 forward_info.write(writer)?;
2921 &PendingHTLCStatus::Fail(ref fail_msg) => {
2923 fail_msg.write(writer)?;
2930 impl<R: ::std::io::Read> Readable<R> for PendingHTLCStatus {
2931 fn read(reader: &mut R) -> Result<PendingHTLCStatus, DecodeError> {
2932 match <u8 as Readable<R>>::read(reader)? {
2933 0 => Ok(PendingHTLCStatus::Forward(Readable::read(reader)?)),
2934 1 => Ok(PendingHTLCStatus::Fail(Readable::read(reader)?)),
2935 _ => Err(DecodeError::InvalidValue),
2940 impl_writeable!(HTLCPreviousHopData, 0, {
2943 incoming_packet_shared_secret
2946 impl Writeable for HTLCSource {
2947 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
2949 &HTLCSource::PreviousHopData(ref hop_data) => {
2951 hop_data.write(writer)?;
2953 &HTLCSource::OutboundRoute { ref route, ref session_priv, ref first_hop_htlc_msat } => {
2955 route.write(writer)?;
2956 session_priv.write(writer)?;
2957 first_hop_htlc_msat.write(writer)?;
2964 impl<R: ::std::io::Read> Readable<R> for HTLCSource {
2965 fn read(reader: &mut R) -> Result<HTLCSource, DecodeError> {
2966 match <u8 as Readable<R>>::read(reader)? {
2967 0 => Ok(HTLCSource::PreviousHopData(Readable::read(reader)?)),
2968 1 => Ok(HTLCSource::OutboundRoute {
2969 route: Readable::read(reader)?,
2970 session_priv: Readable::read(reader)?,
2971 first_hop_htlc_msat: Readable::read(reader)?,
2973 _ => Err(DecodeError::InvalidValue),
2978 impl Writeable for HTLCFailReason {
2979 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
2981 &HTLCFailReason::ErrorPacket { ref err } => {
2985 &HTLCFailReason::Reason { ref failure_code, ref data } => {
2987 failure_code.write(writer)?;
2988 data.write(writer)?;
2995 impl<R: ::std::io::Read> Readable<R> for HTLCFailReason {
2996 fn read(reader: &mut R) -> Result<HTLCFailReason, DecodeError> {
2997 match <u8 as Readable<R>>::read(reader)? {
2998 0 => Ok(HTLCFailReason::ErrorPacket { err: Readable::read(reader)? }),
2999 1 => Ok(HTLCFailReason::Reason {
3000 failure_code: Readable::read(reader)?,
3001 data: Readable::read(reader)?,
3003 _ => Err(DecodeError::InvalidValue),
3008 impl_writeable!(HTLCForwardInfo, 0, {
3009 prev_short_channel_id,
3014 impl Writeable for ChannelManager {
3015 fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3016 let _ = self.total_consistency_lock.write().unwrap();
3018 writer.write_all(&[SERIALIZATION_VERSION; 1])?;
3019 writer.write_all(&[MIN_SERIALIZATION_VERSION; 1])?;
3021 self.genesis_hash.write(writer)?;
3022 (self.latest_block_height.load(Ordering::Acquire) as u32).write(writer)?;
3023 self.last_block_hash.lock().unwrap().write(writer)?;
3025 let channel_state = self.channel_state.lock().unwrap();
3026 let mut unfunded_channels = 0;
3027 for (_, channel) in channel_state.by_id.iter() {
3028 if !channel.is_funding_initiated() {
3029 unfunded_channels += 1;
3032 ((channel_state.by_id.len() - unfunded_channels) as u64).write(writer)?;
3033 for (_, channel) in channel_state.by_id.iter() {
3034 if channel.is_funding_initiated() {
3035 channel.write(writer)?;
3039 (channel_state.forward_htlcs.len() as u64).write(writer)?;
3040 for (short_channel_id, pending_forwards) in channel_state.forward_htlcs.iter() {
3041 short_channel_id.write(writer)?;
3042 (pending_forwards.len() as u64).write(writer)?;
3043 for forward in pending_forwards {
3044 forward.write(writer)?;
3048 (channel_state.claimable_htlcs.len() as u64).write(writer)?;
3049 for (payment_hash, previous_hops) in channel_state.claimable_htlcs.iter() {
3050 payment_hash.write(writer)?;
3051 (previous_hops.len() as u64).write(writer)?;
3052 for previous_hop in previous_hops {
3053 previous_hop.write(writer)?;
3061 /// Arguments for the creation of a ChannelManager that are not deserialized.
3063 /// At a high-level, the process for deserializing a ChannelManager and resuming normal operation
3065 /// 1) Deserialize all stored ChannelMonitors.
3066 /// 2) Deserialize the ChannelManager by filling in this struct and calling <(Sha256dHash,
3067 /// ChannelManager)>::read(reader, args).
3068 /// This may result in closing some Channels if the ChannelMonitor is newer than the stored
3069 /// ChannelManager state to ensure no loss of funds. Thus, transactions may be broadcasted.
3070 /// 3) Register all relevant ChannelMonitor outpoints with your chain watch mechanism using
3071 /// ChannelMonitor::get_monitored_outpoints and ChannelMonitor::get_funding_txo().
3072 /// 4) Reconnect blocks on your ChannelMonitors.
3073 /// 5) Move the ChannelMonitors into your local ManyChannelMonitor.
3074 /// 6) Disconnect/connect blocks on the ChannelManager.
3075 /// 7) Register the new ChannelManager with your ChainWatchInterface (this does not happen
3076 /// automatically as it does in ChannelManager::new()).
3077 pub struct ChannelManagerReadArgs<'a> {
3078 /// The keys provider which will give us relevant keys. Some keys will be loaded during
3079 /// deserialization.
3080 pub keys_manager: Arc<KeysInterface>,
3082 /// The fee_estimator for use in the ChannelManager in the future.
3084 /// No calls to the FeeEstimator will be made during deserialization.
3085 pub fee_estimator: Arc<FeeEstimator>,
3086 /// The ManyChannelMonitor for use in the ChannelManager in the future.
3088 /// No calls to the ManyChannelMonitor will be made during deserialization. It is assumed that
3089 /// you have deserialized ChannelMonitors separately and will add them to your
3090 /// ManyChannelMonitor after deserializing this ChannelManager.
3091 pub monitor: Arc<ManyChannelMonitor>,
3092 /// The ChainWatchInterface for use in the ChannelManager in the future.
3094 /// No calls to the ChainWatchInterface will be made during deserialization.
3095 pub chain_monitor: Arc<ChainWatchInterface>,
3096 /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
3097 /// used to broadcast the latest local commitment transactions of channels which must be
3098 /// force-closed during deserialization.
3099 pub tx_broadcaster: Arc<BroadcasterInterface>,
3100 /// The Logger for use in the ChannelManager and which may be used to log information during
3101 /// deserialization.
3102 pub logger: Arc<Logger>,
3103 /// Default settings used for new channels. Any existing channels will continue to use the
3104 /// runtime settings which were stored when the ChannelManager was serialized.
3105 pub default_config: UserConfig,
3107 /// A map from channel funding outpoints to ChannelMonitors for those channels (ie
3108 /// value.get_funding_txo() should be the key).
3110 /// If a monitor is inconsistent with the channel state during deserialization the channel will
3111 /// be force-closed using the data in the channelmonitor and the Channel will be dropped. This
3112 /// is true for missing channels as well. If there is a monitor missing for which we find
3113 /// channel data Err(DecodeError::InvalidValue) will be returned.
3115 /// In such cases the latest local transactions will be sent to the tx_broadcaster included in
3117 pub channel_monitors: &'a HashMap<OutPoint, &'a ChannelMonitor>,
3120 impl<'a, R : ::std::io::Read> ReadableArgs<R, ChannelManagerReadArgs<'a>> for (Sha256dHash, ChannelManager) {
3121 fn read(reader: &mut R, args: ChannelManagerReadArgs<'a>) -> Result<Self, DecodeError> {
3122 let _ver: u8 = Readable::read(reader)?;
3123 let min_ver: u8 = Readable::read(reader)?;
3124 if min_ver > SERIALIZATION_VERSION {
3125 return Err(DecodeError::UnknownVersion);
3128 let genesis_hash: Sha256dHash = Readable::read(reader)?;
3129 let latest_block_height: u32 = Readable::read(reader)?;
3130 let last_block_hash: Sha256dHash = Readable::read(reader)?;
3132 let mut closed_channels = Vec::new();
3134 let channel_count: u64 = Readable::read(reader)?;
3135 let mut funding_txo_set = HashSet::with_capacity(cmp::min(channel_count as usize, 128));
3136 let mut by_id = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
3137 let mut short_to_id = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
3138 for _ in 0..channel_count {
3139 let mut channel: Channel = ReadableArgs::read(reader, args.logger.clone())?;
3140 if channel.last_block_connected != last_block_hash {
3141 return Err(DecodeError::InvalidValue);
3144 let funding_txo = channel.channel_monitor().get_funding_txo().ok_or(DecodeError::InvalidValue)?;
3145 funding_txo_set.insert(funding_txo.clone());
3146 if let Some(monitor) = args.channel_monitors.get(&funding_txo) {
3147 if channel.get_cur_local_commitment_transaction_number() != monitor.get_cur_local_commitment_number() ||
3148 channel.get_revoked_remote_commitment_transaction_number() != monitor.get_min_seen_secret() ||
3149 channel.get_cur_remote_commitment_transaction_number() != monitor.get_cur_remote_commitment_number() {
3150 let mut force_close_res = channel.force_shutdown();
3151 force_close_res.0 = monitor.get_latest_local_commitment_txn();
3152 closed_channels.push(force_close_res);
3154 if let Some(short_channel_id) = channel.get_short_channel_id() {
3155 short_to_id.insert(short_channel_id, channel.channel_id());
3157 by_id.insert(channel.channel_id(), channel);
3160 return Err(DecodeError::InvalidValue);
3164 for (ref funding_txo, ref monitor) in args.channel_monitors.iter() {
3165 if !funding_txo_set.contains(funding_txo) {
3166 closed_channels.push((monitor.get_latest_local_commitment_txn(), Vec::new()));
3170 let forward_htlcs_count: u64 = Readable::read(reader)?;
3171 let mut forward_htlcs = HashMap::with_capacity(cmp::min(forward_htlcs_count as usize, 128));
3172 for _ in 0..forward_htlcs_count {
3173 let short_channel_id = Readable::read(reader)?;
3174 let pending_forwards_count: u64 = Readable::read(reader)?;
3175 let mut pending_forwards = Vec::with_capacity(cmp::min(pending_forwards_count as usize, 128));
3176 for _ in 0..pending_forwards_count {
3177 pending_forwards.push(Readable::read(reader)?);
3179 forward_htlcs.insert(short_channel_id, pending_forwards);
3182 let claimable_htlcs_count: u64 = Readable::read(reader)?;
3183 let mut claimable_htlcs = HashMap::with_capacity(cmp::min(claimable_htlcs_count as usize, 128));
3184 for _ in 0..claimable_htlcs_count {
3185 let payment_hash = Readable::read(reader)?;
3186 let previous_hops_len: u64 = Readable::read(reader)?;
3187 let mut previous_hops = Vec::with_capacity(cmp::min(previous_hops_len as usize, 2));
3188 for _ in 0..previous_hops_len {
3189 previous_hops.push(Readable::read(reader)?);
3191 claimable_htlcs.insert(payment_hash, previous_hops);
3194 let channel_manager = ChannelManager {
3196 fee_estimator: args.fee_estimator,
3197 monitor: args.monitor,
3198 chain_monitor: args.chain_monitor,
3199 tx_broadcaster: args.tx_broadcaster,
3201 latest_block_height: AtomicUsize::new(latest_block_height as usize),
3202 last_block_hash: Mutex::new(last_block_hash),
3203 secp_ctx: Secp256k1::new(),
3205 channel_state: Mutex::new(ChannelHolder {
3208 next_forward: Instant::now(),
3211 pending_msg_events: Vec::new(),
3213 our_network_key: args.keys_manager.get_node_secret(),
3215 pending_events: Mutex::new(Vec::new()),
3216 total_consistency_lock: RwLock::new(()),
3217 keys_manager: args.keys_manager,
3218 logger: args.logger,
3219 default_configuration: args.default_config,
3222 for close_res in closed_channels.drain(..) {
3223 channel_manager.finish_force_close_channel(close_res);
3224 //TODO: Broadcast channel update for closed channels, but only after we've made a
3225 //connection or two.
3228 Ok((last_block_hash.clone(), channel_manager))
3234 use chain::chaininterface;
3235 use chain::transaction::OutPoint;
3236 use chain::chaininterface::{ChainListener, ChainWatchInterface};
3237 use chain::keysinterface::{KeysInterface, SpendableOutputDescriptor};
3238 use chain::keysinterface;
3239 use ln::channel::{COMMITMENT_TX_BASE_WEIGHT, COMMITMENT_TX_WEIGHT_PER_HTLC};
3240 use ln::channelmanager::{ChannelManager,ChannelManagerReadArgs,OnionKeys,PaymentFailReason,RAACommitmentOrder};
3241 use ln::channelmonitor::{ChannelMonitor, ChannelMonitorUpdateErr, CLTV_CLAIM_BUFFER, HTLC_FAIL_TIMEOUT_BLOCKS, ManyChannelMonitor};
3242 use ln::router::{Route, RouteHop, Router};
3244 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler};
3245 use util::test_utils;
3246 use util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
3247 use util::errors::APIError;
3248 use util::logger::Logger;
3249 use util::ser::{Writeable, Writer, ReadableArgs};
3250 use util::config::UserConfig;
3252 use bitcoin::util::hash::{BitcoinHash, Sha256dHash};
3253 use bitcoin::util::bip143;
3254 use bitcoin::util::address::Address;
3255 use bitcoin::util::bip32::{ChildNumber, ExtendedPubKey, ExtendedPrivKey};
3256 use bitcoin::blockdata::block::{Block, BlockHeader};
3257 use bitcoin::blockdata::transaction::{Transaction, TxOut, TxIn, SigHashType};
3258 use bitcoin::blockdata::script::{Builder, Script};
3259 use bitcoin::blockdata::opcodes;
3260 use bitcoin::blockdata::constants::genesis_block;
3261 use bitcoin::network::constants::Network;
3265 use secp256k1::{Secp256k1, Message};
3266 use secp256k1::key::{PublicKey,SecretKey};
3268 use crypto::sha2::Sha256;
3269 use crypto::digest::Digest;
3271 use rand::{thread_rng,Rng};
3273 use std::cell::RefCell;
3274 use std::collections::{BTreeSet, HashMap};
3275 use std::default::Default;
3277 use std::sync::{Arc, Mutex};
3278 use std::sync::atomic::Ordering;
3279 use std::time::Instant;
3282 fn build_test_onion_keys() -> Vec<OnionKeys> {
3283 // Keys from BOLT 4, used in both test vector tests
3284 let secp_ctx = Secp256k1::new();
3289 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("02eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619").unwrap()[..]).unwrap(),
3290 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
3293 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("0324653eac434488002cc06bbfb7f10fe18991e35f9fe4302dbea6d2353dc0ab1c").unwrap()[..]).unwrap(),
3294 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
3297 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("027f31ebc5462c1fdce1b737ecff52d37d75dea43ce11c74d25aa297165faa2007").unwrap()[..]).unwrap(),
3298 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
3301 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]).unwrap(),
3302 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
3305 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("02edabbd16b41c8371b92ef2f04c1185b4f03b6dcd52ba9b78d9d7c89c8f221145").unwrap()[..]).unwrap(),
3306 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
3311 let session_priv = SecretKey::from_slice(&secp_ctx, &hex::decode("4141414141414141414141414141414141414141414141414141414141414141").unwrap()[..]).unwrap();
3313 let onion_keys = ChannelManager::construct_onion_keys(&secp_ctx, &route, &session_priv).unwrap();
3314 assert_eq!(onion_keys.len(), route.hops.len());
3319 fn onion_vectors() {
3320 // Packet creation test vectors from BOLT 4
3321 let onion_keys = build_test_onion_keys();
3323 assert_eq!(onion_keys[0].shared_secret[..], hex::decode("53eb63ea8a3fec3b3cd433b85cd62a4b145e1dda09391b348c4e1cd36a03ea66").unwrap()[..]);
3324 assert_eq!(onion_keys[0].blinding_factor[..], hex::decode("2ec2e5da605776054187180343287683aa6a51b4b1c04d6dd49c45d8cffb3c36").unwrap()[..]);
3325 assert_eq!(onion_keys[0].ephemeral_pubkey.serialize()[..], hex::decode("02eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619").unwrap()[..]);
3326 assert_eq!(onion_keys[0].rho, hex::decode("ce496ec94def95aadd4bec15cdb41a740c9f2b62347c4917325fcc6fb0453986").unwrap()[..]);
3327 assert_eq!(onion_keys[0].mu, hex::decode("b57061dc6d0a2b9f261ac410c8b26d64ac5506cbba30267a649c28c179400eba").unwrap()[..]);
3329 assert_eq!(onion_keys[1].shared_secret[..], hex::decode("a6519e98832a0b179f62123b3567c106db99ee37bef036e783263602f3488fae").unwrap()[..]);
3330 assert_eq!(onion_keys[1].blinding_factor[..], hex::decode("bf66c28bc22e598cfd574a1931a2bafbca09163df2261e6d0056b2610dab938f").unwrap()[..]);
3331 assert_eq!(onion_keys[1].ephemeral_pubkey.serialize()[..], hex::decode("028f9438bfbf7feac2e108d677e3a82da596be706cc1cf342b75c7b7e22bf4e6e2").unwrap()[..]);
3332 assert_eq!(onion_keys[1].rho, hex::decode("450ffcabc6449094918ebe13d4f03e433d20a3d28a768203337bc40b6e4b2c59").unwrap()[..]);
3333 assert_eq!(onion_keys[1].mu, hex::decode("05ed2b4a3fb023c2ff5dd6ed4b9b6ea7383f5cfe9d59c11d121ec2c81ca2eea9").unwrap()[..]);
3335 assert_eq!(onion_keys[2].shared_secret[..], hex::decode("3a6b412548762f0dbccce5c7ae7bb8147d1caf9b5471c34120b30bc9c04891cc").unwrap()[..]);
3336 assert_eq!(onion_keys[2].blinding_factor[..], hex::decode("a1f2dadd184eb1627049673f18c6325814384facdee5bfd935d9cb031a1698a5").unwrap()[..]);
3337 assert_eq!(onion_keys[2].ephemeral_pubkey.serialize()[..], hex::decode("03bfd8225241ea71cd0843db7709f4c222f62ff2d4516fd38b39914ab6b83e0da0").unwrap()[..]);
3338 assert_eq!(onion_keys[2].rho, hex::decode("11bf5c4f960239cb37833936aa3d02cea82c0f39fd35f566109c41f9eac8deea").unwrap()[..]);
3339 assert_eq!(onion_keys[2].mu, hex::decode("caafe2820fa00eb2eeb78695ae452eba38f5a53ed6d53518c5c6edf76f3f5b78").unwrap()[..]);
3341 assert_eq!(onion_keys[3].shared_secret[..], hex::decode("21e13c2d7cfe7e18836df50872466117a295783ab8aab0e7ecc8c725503ad02d").unwrap()[..]);
3342 assert_eq!(onion_keys[3].blinding_factor[..], hex::decode("7cfe0b699f35525029ae0fa437c69d0f20f7ed4e3916133f9cacbb13c82ff262").unwrap()[..]);
3343 assert_eq!(onion_keys[3].ephemeral_pubkey.serialize()[..], hex::decode("031dde6926381289671300239ea8e57ffaf9bebd05b9a5b95beaf07af05cd43595").unwrap()[..]);
3344 assert_eq!(onion_keys[3].rho, hex::decode("cbe784ab745c13ff5cffc2fbe3e84424aa0fd669b8ead4ee562901a4a4e89e9e").unwrap()[..]);
3345 assert_eq!(onion_keys[3].mu, hex::decode("5052aa1b3d9f0655a0932e50d42f0c9ba0705142c25d225515c45f47c0036ee9").unwrap()[..]);
3347 assert_eq!(onion_keys[4].shared_secret[..], hex::decode("b5756b9b542727dbafc6765a49488b023a725d631af688fc031217e90770c328").unwrap()[..]);
3348 assert_eq!(onion_keys[4].blinding_factor[..], hex::decode("c96e00dddaf57e7edcd4fb5954be5b65b09f17cb6d20651b4e90315be5779205").unwrap()[..]);
3349 assert_eq!(onion_keys[4].ephemeral_pubkey.serialize()[..], hex::decode("03a214ebd875aab6ddfd77f22c5e7311d7f77f17a169e599f157bbcdae8bf071f4").unwrap()[..]);
3350 assert_eq!(onion_keys[4].rho, hex::decode("034e18b8cc718e8af6339106e706c52d8df89e2b1f7e9142d996acf88df8799b").unwrap()[..]);
3351 assert_eq!(onion_keys[4].mu, hex::decode("8e45e5c61c2b24cb6382444db6698727afb063adecd72aada233d4bf273d975a").unwrap()[..]);
3353 // Test vectors below are flat-out wrong: they claim to set outgoing_cltv_value to non-0 :/
3354 let payloads = vec!(
3355 msgs::OnionHopData {
3357 data: msgs::OnionRealm0HopData {
3358 short_channel_id: 0,
3360 outgoing_cltv_value: 0,
3364 msgs::OnionHopData {
3366 data: msgs::OnionRealm0HopData {
3367 short_channel_id: 0x0101010101010101,
3368 amt_to_forward: 0x0100000001,
3369 outgoing_cltv_value: 0,
3373 msgs::OnionHopData {
3375 data: msgs::OnionRealm0HopData {
3376 short_channel_id: 0x0202020202020202,
3377 amt_to_forward: 0x0200000002,
3378 outgoing_cltv_value: 0,
3382 msgs::OnionHopData {
3384 data: msgs::OnionRealm0HopData {
3385 short_channel_id: 0x0303030303030303,
3386 amt_to_forward: 0x0300000003,
3387 outgoing_cltv_value: 0,
3391 msgs::OnionHopData {
3393 data: msgs::OnionRealm0HopData {
3394 short_channel_id: 0x0404040404040404,
3395 amt_to_forward: 0x0400000004,
3396 outgoing_cltv_value: 0,
3402 let packet = ChannelManager::construct_onion_packet(payloads, onion_keys, &[0x42; 32]);
3403 // Just check the final packet encoding, as it includes all the per-hop vectors in it
3405 assert_eq!(packet.encode(), hex::decode("0002eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619e5f14350c2a76fc232b5e46d421e9615471ab9e0bc887beff8c95fdb878f7b3a716a996c7845c93d90e4ecbb9bde4ece2f69425c99e4bc820e44485455f135edc0d10f7d61ab590531cf08000179a333a347f8b4072f216400406bdf3bf038659793d4a1fd7b246979e3150a0a4cb052c9ec69acf0f48c3d39cd55675fe717cb7d80ce721caad69320c3a469a202f1e468c67eaf7a7cd8226d0fd32f7b48084dca885d56047694762b67021713ca673929c163ec36e04e40ca8e1c6d17569419d3039d9a1ec866abe044a9ad635778b961fc0776dc832b3a451bd5d35072d2269cf9b040f6b7a7dad84fb114ed413b1426cb96ceaf83825665ed5a1d002c1687f92465b49ed4c7f0218ff8c6c7dd7221d589c65b3b9aaa71a41484b122846c7c7b57e02e679ea8469b70e14fe4f70fee4d87b910cf144be6fe48eef24da475c0b0bcc6565ae82cd3f4e3b24c76eaa5616c6111343306ab35c1fe5ca4a77c0e314ed7dba39d6f1e0de791719c241a939cc493bea2bae1c1e932679ea94d29084278513c77b899cc98059d06a27d171b0dbdf6bee13ddc4fc17a0c4d2827d488436b57baa167544138ca2e64a11b43ac8a06cd0c2fba2d4d900ed2d9205305e2d7383cc98dacb078133de5f6fb6bed2ef26ba92cea28aafc3b9948dd9ae5559e8bd6920b8cea462aa445ca6a95e0e7ba52961b181c79e73bd581821df2b10173727a810c92b83b5ba4a0403eb710d2ca10689a35bec6c3a708e9e92f7d78ff3c5d9989574b00c6736f84c199256e76e19e78f0c98a9d580b4a658c84fc8f2096c2fbea8f5f8c59d0fdacb3be2802ef802abbecb3aba4acaac69a0e965abd8981e9896b1f6ef9d60f7a164b371af869fd0e48073742825e9434fc54da837e120266d53302954843538ea7c6c3dbfb4ff3b2fdbe244437f2a153ccf7bdb4c92aa08102d4f3cff2ae5ef86fab4653595e6a5837fa2f3e29f27a9cde5966843fb847a4a61f1e76c281fe8bb2b0a181d096100db5a1a5ce7a910238251a43ca556712eaadea167fb4d7d75825e440f3ecd782036d7574df8bceacb397abefc5f5254d2722215c53ff54af8299aaaad642c6d72a14d27882d9bbd539e1cc7a527526ba89b8c037ad09120e98ab042d3e8652b31ae0e478516bfaf88efca9f3676ffe99d2819dcaeb7610a626695f53117665d267d3f7abebd6bbd6733f645c72c389f03855bdf1e4b8075b516569b118233a0f0971d24b83113c0b096f5216a207ca99a7cddc81c130923fe3d91e7508c9ac5f2e914ff5dccab9e558566fa14efb34ac98d878580814b94b73acbfde9072f30b881f7f0fff42d4045d1ace6322d86a97d164aa84d93a60498065cc7c20e636f5862dc81531a88c60305a2e59a985be327a6902e4bed986dbf4a0b50c217af0ea7fdf9ab37f9ea1a1aaa72f54cf40154ea9b269f1a7c09f9f43245109431a175d50e2db0132337baa0ef97eed0fcf20489da36b79a1172faccc2f7ded7c60e00694282d93359c4682135642bc81f433574aa8ef0c97b4ade7ca372c5ffc23c7eddd839bab4e0f14d6df15c9dbeab176bec8b5701cf054eb3072f6dadc98f88819042bf10c407516ee58bce33fbe3b3d86a54255e577db4598e30a135361528c101683a5fcde7e8ba53f3456254be8f45fe3a56120ae96ea3773631fcb3873aa3abd91bcff00bd38bd43697a2e789e00da6077482e7b1b1a677b5afae4c54e6cbdf7377b694eb7d7a5b913476a5be923322d3de06060fd5e819635232a2cf4f0731da13b8546d1d6d4f8d75b9fce6c2341a71b0ea6f780df54bfdb0dd5cd9855179f602f9172307c7268724c3618e6817abd793adc214a0dc0bc616816632f27ea336fb56dfd").unwrap());
3409 fn test_failure_packet_onion() {
3410 // Returning Errors test vectors from BOLT 4
3412 let onion_keys = build_test_onion_keys();
3413 let onion_error = ChannelManager::build_failure_packet(&onion_keys[4].shared_secret[..], 0x2002, &[0; 0]);
3414 assert_eq!(onion_error.encode(), hex::decode("4c2fc8bc08510334b6833ad9c3e79cd1b52ae59dfe5c2a4b23ead50f09f7ee0b0002200200fe0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap());
3416 let onion_packet_1 = ChannelManager::encrypt_failure_packet(&onion_keys[4].shared_secret[..], &onion_error.encode()[..]);
3417 assert_eq!(onion_packet_1.data, hex::decode("a5e6bd0c74cb347f10cce367f949098f2457d14c046fd8a22cb96efb30b0fdcda8cb9168b50f2fd45edd73c1b0c8b33002df376801ff58aaa94000bf8a86f92620f343baef38a580102395ae3abf9128d1047a0736ff9b83d456740ebbb4aeb3aa9737f18fb4afb4aa074fb26c4d702f42968888550a3bded8c05247e045b866baef0499f079fdaeef6538f31d44deafffdfd3afa2fb4ca9082b8f1c465371a9894dd8c243fb4847e004f5256b3e90e2edde4c9fb3082ddfe4d1e734cacd96ef0706bf63c9984e22dc98851bcccd1c3494351feb458c9c6af41c0044bea3c47552b1d992ae542b17a2d0bba1a096c78d169034ecb55b6e3a7263c26017f033031228833c1daefc0dedb8cf7c3e37c9c37ebfe42f3225c326e8bcfd338804c145b16e34e4").unwrap());
3419 let onion_packet_2 = ChannelManager::encrypt_failure_packet(&onion_keys[3].shared_secret[..], &onion_packet_1.data[..]);
3420 assert_eq!(onion_packet_2.data, hex::decode("c49a1ce81680f78f5f2000cda36268de34a3f0a0662f55b4e837c83a8773c22aa081bab1616a0011585323930fa5b9fae0c85770a2279ff59ec427ad1bbff9001c0cd1497004bd2a0f68b50704cf6d6a4bf3c8b6a0833399a24b3456961ba00736785112594f65b6b2d44d9f5ea4e49b5e1ec2af978cbe31c67114440ac51a62081df0ed46d4a3df295da0b0fe25c0115019f03f15ec86fabb4c852f83449e812f141a9395b3f70b766ebbd4ec2fae2b6955bd8f32684c15abfe8fd3a6261e52650e8807a92158d9f1463261a925e4bfba44bd20b166d532f0017185c3a6ac7957adefe45559e3072c8dc35abeba835a8cb01a71a15c736911126f27d46a36168ca5ef7dccd4e2886212602b181463e0dd30185c96348f9743a02aca8ec27c0b90dca270").unwrap());
3422 let onion_packet_3 = ChannelManager::encrypt_failure_packet(&onion_keys[2].shared_secret[..], &onion_packet_2.data[..]);
3423 assert_eq!(onion_packet_3.data, hex::decode("a5d3e8634cfe78b2307d87c6d90be6fe7855b4f2cc9b1dfb19e92e4b79103f61ff9ac25f412ddfb7466e74f81b3e545563cdd8f5524dae873de61d7bdfccd496af2584930d2b566b4f8d3881f8c043df92224f38cf094cfc09d92655989531524593ec6d6caec1863bdfaa79229b5020acc034cd6deeea1021c50586947b9b8e6faa83b81fbfa6133c0af5d6b07c017f7158fa94f0d206baf12dda6b68f785b773b360fd0497e16cc402d779c8d48d0fa6315536ef0660f3f4e1865f5b38ea49c7da4fd959de4e83ff3ab686f059a45c65ba2af4a6a79166aa0f496bf04d06987b6d2ea205bdb0d347718b9aeff5b61dfff344993a275b79717cd815b6ad4c0beb568c4ac9c36ff1c315ec1119a1993c4b61e6eaa0375e0aaf738ac691abd3263bf937e3").unwrap());
3425 let onion_packet_4 = ChannelManager::encrypt_failure_packet(&onion_keys[1].shared_secret[..], &onion_packet_3.data[..]);
3426 assert_eq!(onion_packet_4.data, hex::decode("aac3200c4968f56b21f53e5e374e3a2383ad2b1b6501bbcc45abc31e59b26881b7dfadbb56ec8dae8857add94e6702fb4c3a4de22e2e669e1ed926b04447fc73034bb730f4932acd62727b75348a648a1128744657ca6a4e713b9b646c3ca66cac02cdab44dd3439890ef3aaf61708714f7375349b8da541b2548d452d84de7084bb95b3ac2345201d624d31f4d52078aa0fa05a88b4e20202bd2b86ac5b52919ea305a8949de95e935eed0319cf3cf19ebea61d76ba92532497fcdc9411d06bcd4275094d0a4a3c5d3a945e43305a5a9256e333e1f64dbca5fcd4e03a39b9012d197506e06f29339dfee3331995b21615337ae060233d39befea925cc262873e0530408e6990f1cbd233a150ef7b004ff6166c70c68d9f8c853c1abca640b8660db2921").unwrap());
3428 let onion_packet_5 = ChannelManager::encrypt_failure_packet(&onion_keys[0].shared_secret[..], &onion_packet_4.data[..]);
3429 assert_eq!(onion_packet_5.data, hex::decode("9c5add3963fc7f6ed7f148623c84134b5647e1306419dbe2174e523fa9e2fbed3a06a19f899145610741c83ad40b7712aefaddec8c6baf7325d92ea4ca4d1df8bce517f7e54554608bf2bd8071a4f52a7a2f7ffbb1413edad81eeea5785aa9d990f2865dc23b4bc3c301a94eec4eabebca66be5cf638f693ec256aec514620cc28ee4a94bd9565bc4d4962b9d3641d4278fb319ed2b84de5b665f307a2db0f7fbb757366067d88c50f7e829138fde4f78d39b5b5802f1b92a8a820865af5cc79f9f30bc3f461c66af95d13e5e1f0381c184572a91dee1c849048a647a1158cf884064deddbf1b0b88dfe2f791428d0ba0f6fb2f04e14081f69165ae66d9297c118f0907705c9c4954a199bae0bb96fad763d690e7daa6cfda59ba7f2c8d11448b604d12d").unwrap());
3432 fn confirm_transaction(chain: &chaininterface::ChainWatchInterfaceUtil, tx: &Transaction, chan_id: u32) {
3433 assert!(chain.does_match_tx(tx));
3434 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3435 chain.block_connected_checked(&header, 1, &[tx; 1], &[chan_id; 1]);
3437 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3438 chain.block_connected_checked(&header, i, &[tx; 0], &[0; 0]);
3443 chain_monitor: Arc<chaininterface::ChainWatchInterfaceUtil>,
3444 tx_broadcaster: Arc<test_utils::TestBroadcaster>,
3445 chan_monitor: Arc<test_utils::TestChannelMonitor>,
3446 node: Arc<ChannelManager>,
3448 node_seed: [u8; 32],
3449 network_payment_count: Rc<RefCell<u8>>,
3450 network_chan_count: Rc<RefCell<u32>>,
3452 impl Drop for Node {
3453 fn drop(&mut self) {
3454 if !::std::thread::panicking() {
3455 // Check that we processed all pending events
3456 assert_eq!(self.node.get_and_clear_pending_msg_events().len(), 0);
3457 assert_eq!(self.node.get_and_clear_pending_events().len(), 0);
3458 assert_eq!(self.chan_monitor.added_monitors.lock().unwrap().len(), 0);
3463 fn create_chan_between_nodes(node_a: &Node, node_b: &Node) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
3464 create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001)
3467 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) {
3468 let (funding_locked, channel_id, tx) = create_chan_between_nodes_with_value_a(node_a, node_b, channel_value, push_msat);
3469 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &funding_locked);
3470 (announcement, as_update, bs_update, channel_id, tx)
3473 macro_rules! get_revoke_commit_msgs {
3474 ($node: expr, $node_id: expr) => {
3476 let events = $node.node.get_and_clear_pending_msg_events();
3477 assert_eq!(events.len(), 2);
3479 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
3480 assert_eq!(*node_id, $node_id);
3483 _ => panic!("Unexpected event"),
3484 }, match events[1] {
3485 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3486 assert_eq!(*node_id, $node_id);
3487 assert!(updates.update_add_htlcs.is_empty());
3488 assert!(updates.update_fulfill_htlcs.is_empty());
3489 assert!(updates.update_fail_htlcs.is_empty());
3490 assert!(updates.update_fail_malformed_htlcs.is_empty());
3491 assert!(updates.update_fee.is_none());
3492 updates.commitment_signed.clone()
3494 _ => panic!("Unexpected event"),
3500 macro_rules! get_event_msg {
3501 ($node: expr, $event_type: path, $node_id: expr) => {
3503 let events = $node.node.get_and_clear_pending_msg_events();
3504 assert_eq!(events.len(), 1);
3506 $event_type { ref node_id, ref msg } => {
3507 assert_eq!(*node_id, $node_id);
3510 _ => panic!("Unexpected event"),
3516 macro_rules! get_htlc_update_msgs {
3517 ($node: expr, $node_id: expr) => {
3519 let events = $node.node.get_and_clear_pending_msg_events();
3520 assert_eq!(events.len(), 1);
3522 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3523 assert_eq!(*node_id, $node_id);
3526 _ => panic!("Unexpected event"),
3532 macro_rules! get_feerate {
3533 ($node: expr, $channel_id: expr) => {
3535 let chan_lock = $node.node.channel_state.lock().unwrap();
3536 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
3543 fn create_chan_between_nodes_with_value_init(node_a: &Node, node_b: &Node, channel_value: u64, push_msat: u64) -> Transaction {
3544 node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42).unwrap();
3545 node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), &get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id())).unwrap();
3546 node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), &get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id())).unwrap();
3548 let chan_id = *node_a.network_chan_count.borrow();
3552 let events_2 = node_a.node.get_and_clear_pending_events();
3553 assert_eq!(events_2.len(), 1);
3555 Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
3556 assert_eq!(*channel_value_satoshis, channel_value);
3557 assert_eq!(user_channel_id, 42);
3559 tx = Transaction { version: chan_id as u32, lock_time: 0, input: Vec::new(), output: vec![TxOut {
3560 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
3562 funding_output = OutPoint::new(tx.txid(), 0);
3564 node_a.node.funding_transaction_generated(&temporary_channel_id, funding_output);
3565 let mut added_monitors = node_a.chan_monitor.added_monitors.lock().unwrap();
3566 assert_eq!(added_monitors.len(), 1);
3567 assert_eq!(added_monitors[0].0, funding_output);
3568 added_monitors.clear();
3570 _ => panic!("Unexpected event"),
3573 node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), &get_event_msg!(node_a, MessageSendEvent::SendFundingCreated, node_b.node.get_our_node_id())).unwrap();
3575 let mut added_monitors = node_b.chan_monitor.added_monitors.lock().unwrap();
3576 assert_eq!(added_monitors.len(), 1);
3577 assert_eq!(added_monitors[0].0, funding_output);
3578 added_monitors.clear();
3581 node_a.node.handle_funding_signed(&node_b.node.get_our_node_id(), &get_event_msg!(node_b, MessageSendEvent::SendFundingSigned, node_a.node.get_our_node_id())).unwrap();
3583 let mut added_monitors = node_a.chan_monitor.added_monitors.lock().unwrap();
3584 assert_eq!(added_monitors.len(), 1);
3585 assert_eq!(added_monitors[0].0, funding_output);
3586 added_monitors.clear();
3589 let events_4 = node_a.node.get_and_clear_pending_events();
3590 assert_eq!(events_4.len(), 1);
3592 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
3593 assert_eq!(user_channel_id, 42);
3594 assert_eq!(*funding_txo, funding_output);
3596 _ => panic!("Unexpected event"),
3602 fn create_chan_between_nodes_with_value_confirm(node_a: &Node, node_b: &Node, tx: &Transaction) -> ((msgs::FundingLocked, msgs::AnnouncementSignatures), [u8; 32]) {
3603 confirm_transaction(&node_b.chain_monitor, &tx, tx.version);
3604 node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), &get_event_msg!(node_b, MessageSendEvent::SendFundingLocked, node_a.node.get_our_node_id())).unwrap();
3608 confirm_transaction(&node_a.chain_monitor, &tx, tx.version);
3609 let events_6 = node_a.node.get_and_clear_pending_msg_events();
3610 assert_eq!(events_6.len(), 2);
3611 ((match events_6[0] {
3612 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3613 channel_id = msg.channel_id.clone();
3614 assert_eq!(*node_id, node_b.node.get_our_node_id());
3617 _ => panic!("Unexpected event"),
3618 }, match events_6[1] {
3619 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3620 assert_eq!(*node_id, node_b.node.get_our_node_id());
3623 _ => panic!("Unexpected event"),
3627 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) {
3628 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat);
3629 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
3633 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) {
3634 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &as_funding_msgs.0).unwrap();
3635 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
3636 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1).unwrap();
3638 let events_7 = node_b.node.get_and_clear_pending_msg_events();
3639 assert_eq!(events_7.len(), 1);
3640 let (announcement, bs_update) = match events_7[0] {
3641 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3644 _ => panic!("Unexpected event"),
3647 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs).unwrap();
3648 let events_8 = node_a.node.get_and_clear_pending_msg_events();
3649 assert_eq!(events_8.len(), 1);
3650 let as_update = match events_8[0] {
3651 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3652 assert!(*announcement == *msg);
3655 _ => panic!("Unexpected event"),
3658 *node_a.network_chan_count.borrow_mut() += 1;
3660 ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone())
3663 fn create_announced_chan_between_nodes(nodes: &Vec<Node>, a: usize, b: usize) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
3664 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001)
3667 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) {
3668 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat);
3670 assert!(node.router.handle_channel_announcement(&chan_announcement.0).unwrap());
3671 node.router.handle_channel_update(&chan_announcement.1).unwrap();
3672 node.router.handle_channel_update(&chan_announcement.2).unwrap();
3674 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
3677 macro_rules! check_spends {
3678 ($tx: expr, $spends_tx: expr) => {
3680 let mut funding_tx_map = HashMap::new();
3681 let spends_tx = $spends_tx;
3682 funding_tx_map.insert(spends_tx.txid(), spends_tx);
3683 $tx.verify(&funding_tx_map).unwrap();
3688 macro_rules! get_closing_signed_broadcast {
3689 ($node: expr, $dest_pubkey: expr) => {
3691 let events = $node.get_and_clear_pending_msg_events();
3692 assert!(events.len() == 1 || events.len() == 2);
3693 (match events[events.len() - 1] {
3694 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
3695 assert_eq!(msg.contents.flags & 2, 2);
3698 _ => panic!("Unexpected event"),
3699 }, if events.len() == 2 {
3701 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
3702 assert_eq!(*node_id, $dest_pubkey);
3705 _ => panic!("Unexpected event"),
3712 fn close_channel(outbound_node: &Node, inbound_node: &Node, channel_id: &[u8; 32], funding_tx: Transaction, close_inbound_first: bool) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, Transaction) {
3713 let (node_a, broadcaster_a, struct_a) = if close_inbound_first { (&inbound_node.node, &inbound_node.tx_broadcaster, inbound_node) } else { (&outbound_node.node, &outbound_node.tx_broadcaster, outbound_node) };
3714 let (node_b, broadcaster_b) = if close_inbound_first { (&outbound_node.node, &outbound_node.tx_broadcaster) } else { (&inbound_node.node, &inbound_node.tx_broadcaster) };
3717 node_a.close_channel(channel_id).unwrap();
3718 node_b.handle_shutdown(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendShutdown, node_b.get_our_node_id())).unwrap();
3720 let events_1 = node_b.get_and_clear_pending_msg_events();
3721 assert!(events_1.len() >= 1);
3722 let shutdown_b = match events_1[0] {
3723 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
3724 assert_eq!(node_id, &node_a.get_our_node_id());
3727 _ => panic!("Unexpected event"),
3730 let closing_signed_b = if !close_inbound_first {
3731 assert_eq!(events_1.len(), 1);
3734 Some(match events_1[1] {
3735 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
3736 assert_eq!(node_id, &node_a.get_our_node_id());
3739 _ => panic!("Unexpected event"),
3743 node_a.handle_shutdown(&node_b.get_our_node_id(), &shutdown_b).unwrap();
3744 let (as_update, bs_update) = if close_inbound_first {
3745 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
3746 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap()).unwrap();
3747 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
3748 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
3749 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
3751 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap()).unwrap();
3752 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
3753 assert!(none_b.is_none());
3754 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
3755 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
3756 (as_update, bs_update)
3758 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
3760 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a).unwrap();
3761 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
3762 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
3763 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
3765 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap()).unwrap();
3766 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
3767 assert!(none_a.is_none());
3768 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
3769 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
3770 (as_update, bs_update)
3772 assert_eq!(tx_a, tx_b);
3773 check_spends!(tx_a, funding_tx);
3775 (as_update, bs_update, tx_a)
3780 msgs: Vec<msgs::UpdateAddHTLC>,
3781 commitment_msg: msgs::CommitmentSigned,
3784 fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
3785 assert!(updates.update_fulfill_htlcs.is_empty());
3786 assert!(updates.update_fail_htlcs.is_empty());
3787 assert!(updates.update_fail_malformed_htlcs.is_empty());
3788 assert!(updates.update_fee.is_none());
3789 SendEvent { node_id: node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
3792 fn from_event(event: MessageSendEvent) -> SendEvent {
3794 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
3795 _ => panic!("Unexpected event type!"),
3800 macro_rules! check_added_monitors {
3801 ($node: expr, $count: expr) => {
3803 let mut added_monitors = $node.chan_monitor.added_monitors.lock().unwrap();
3804 assert_eq!(added_monitors.len(), $count);
3805 added_monitors.clear();
3810 macro_rules! commitment_signed_dance {
3811 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
3813 check_added_monitors!($node_a, 0);
3814 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
3815 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed).unwrap();
3816 check_added_monitors!($node_a, 1);
3817 commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, false);
3820 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
3822 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!($node_a, $node_b.node.get_our_node_id());
3823 check_added_monitors!($node_b, 0);
3824 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
3825 $node_b.node.handle_revoke_and_ack(&$node_a.node.get_our_node_id(), &as_revoke_and_ack).unwrap();
3826 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
3827 check_added_monitors!($node_b, 1);
3828 $node_b.node.handle_commitment_signed(&$node_a.node.get_our_node_id(), &as_commitment_signed).unwrap();
3829 let (bs_revoke_and_ack, extra_msg_option) = {
3830 let events = $node_b.node.get_and_clear_pending_msg_events();
3831 assert!(events.len() <= 2);
3833 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
3834 assert_eq!(*node_id, $node_a.node.get_our_node_id());
3837 _ => panic!("Unexpected event"),
3838 }, events.get(1).map(|e| e.clone()))
3840 check_added_monitors!($node_b, 1);
3841 if $fail_backwards {
3842 assert!($node_a.node.get_and_clear_pending_events().is_empty());
3843 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
3845 $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
3847 let mut added_monitors = $node_a.chan_monitor.added_monitors.lock().unwrap();
3848 if $fail_backwards {
3849 assert_eq!(added_monitors.len(), 2);
3850 assert!(added_monitors[0].0 != added_monitors[1].0);
3852 assert_eq!(added_monitors.len(), 1);
3854 added_monitors.clear();
3859 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
3861 assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
3864 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
3866 commitment_signed_dance!($node_a, $node_b, $commitment_signed, $fail_backwards, true);
3867 if $fail_backwards {
3868 let channel_state = $node_a.node.channel_state.lock().unwrap();
3869 assert_eq!(channel_state.pending_msg_events.len(), 1);
3870 if let MessageSendEvent::UpdateHTLCs { ref node_id, .. } = channel_state.pending_msg_events[0] {
3871 assert_ne!(*node_id, $node_b.node.get_our_node_id());
3872 } else { panic!("Unexpected event"); }
3874 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
3880 macro_rules! get_payment_preimage_hash {
3883 let payment_preimage = [*$node.network_payment_count.borrow(); 32];
3884 *$node.network_payment_count.borrow_mut() += 1;
3885 let mut payment_hash = [0; 32];
3886 let mut sha = Sha256::new();
3887 sha.input(&payment_preimage[..]);
3888 sha.result(&mut payment_hash);
3889 (payment_preimage, payment_hash)
3894 fn send_along_route(origin_node: &Node, route: Route, expected_route: &[&Node], recv_value: u64) -> ([u8; 32], [u8; 32]) {
3895 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(origin_node);
3897 let mut payment_event = {
3898 origin_node.node.send_payment(route, our_payment_hash).unwrap();
3899 check_added_monitors!(origin_node, 1);
3901 let mut events = origin_node.node.get_and_clear_pending_msg_events();
3902 assert_eq!(events.len(), 1);
3903 SendEvent::from_event(events.remove(0))
3905 let mut prev_node = origin_node;
3907 for (idx, &node) in expected_route.iter().enumerate() {
3908 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
3910 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
3911 check_added_monitors!(node, 0);
3912 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
3914 let events_1 = node.node.get_and_clear_pending_events();
3915 assert_eq!(events_1.len(), 1);
3917 Event::PendingHTLCsForwardable { .. } => { },
3918 _ => panic!("Unexpected event"),
3921 node.node.channel_state.lock().unwrap().next_forward = Instant::now();
3922 node.node.process_pending_htlc_forwards();
3924 if idx == expected_route.len() - 1 {
3925 let events_2 = node.node.get_and_clear_pending_events();
3926 assert_eq!(events_2.len(), 1);
3928 Event::PaymentReceived { ref payment_hash, amt } => {
3929 assert_eq!(our_payment_hash, *payment_hash);
3930 assert_eq!(amt, recv_value);
3932 _ => panic!("Unexpected event"),
3935 let mut events_2 = node.node.get_and_clear_pending_msg_events();
3936 assert_eq!(events_2.len(), 1);
3937 check_added_monitors!(node, 1);
3938 payment_event = SendEvent::from_event(events_2.remove(0));
3939 assert_eq!(payment_event.msgs.len(), 1);
3945 (our_payment_preimage, our_payment_hash)
3948 fn claim_payment_along_route(origin_node: &Node, expected_route: &[&Node], skip_last: bool, our_payment_preimage: [u8; 32]) {
3949 assert!(expected_route.last().unwrap().node.claim_funds(our_payment_preimage));
3950 check_added_monitors!(expected_route.last().unwrap(), 1);
3952 let mut next_msgs: Option<(msgs::UpdateFulfillHTLC, msgs::CommitmentSigned)> = None;
3953 let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
3954 macro_rules! get_next_msgs {
3957 let events = $node.node.get_and_clear_pending_msg_events();
3958 assert_eq!(events.len(), 1);
3960 MessageSendEvent::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 } } => {
3961 assert!(update_add_htlcs.is_empty());
3962 assert_eq!(update_fulfill_htlcs.len(), 1);
3963 assert!(update_fail_htlcs.is_empty());
3964 assert!(update_fail_malformed_htlcs.is_empty());
3965 assert!(update_fee.is_none());
3966 expected_next_node = node_id.clone();
3967 Some((update_fulfill_htlcs[0].clone(), commitment_signed.clone()))
3969 _ => panic!("Unexpected event"),
3975 macro_rules! last_update_fulfill_dance {
3976 ($node: expr, $prev_node: expr) => {
3978 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0).unwrap();
3979 check_added_monitors!($node, 0);
3980 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
3981 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
3985 macro_rules! mid_update_fulfill_dance {
3986 ($node: expr, $prev_node: expr, $new_msgs: expr) => {
3988 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0).unwrap();
3989 check_added_monitors!($node, 1);
3990 let new_next_msgs = if $new_msgs {
3991 get_next_msgs!($node)
3993 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
3996 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
3997 next_msgs = new_next_msgs;
4002 let mut prev_node = expected_route.last().unwrap();
4003 for (idx, node) in expected_route.iter().rev().enumerate() {
4004 assert_eq!(expected_next_node, node.node.get_our_node_id());
4005 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
4006 if next_msgs.is_some() {
4007 mid_update_fulfill_dance!(node, prev_node, update_next_msgs);
4008 } else if update_next_msgs {
4009 next_msgs = get_next_msgs!(node);
4011 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
4013 if !skip_last && idx == expected_route.len() - 1 {
4014 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
4021 last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
4022 let events = origin_node.node.get_and_clear_pending_events();
4023 assert_eq!(events.len(), 1);
4025 Event::PaymentSent { payment_preimage } => {
4026 assert_eq!(payment_preimage, our_payment_preimage);
4028 _ => panic!("Unexpected event"),
4033 fn claim_payment(origin_node: &Node, expected_route: &[&Node], our_payment_preimage: [u8; 32]) {
4034 claim_payment_along_route(origin_node, expected_route, false, our_payment_preimage);
4037 const TEST_FINAL_CLTV: u32 = 32;
4039 fn route_payment(origin_node: &Node, expected_route: &[&Node], recv_value: u64) -> ([u8; 32], [u8; 32]) {
4040 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();
4041 assert_eq!(route.hops.len(), expected_route.len());
4042 for (node, hop) in expected_route.iter().zip(route.hops.iter()) {
4043 assert_eq!(hop.pubkey, node.node.get_our_node_id());
4046 send_along_route(origin_node, route, expected_route, recv_value)
4049 fn route_over_limit(origin_node: &Node, expected_route: &[&Node], recv_value: u64) {
4050 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();
4051 assert_eq!(route.hops.len(), expected_route.len());
4052 for (node, hop) in expected_route.iter().zip(route.hops.iter()) {
4053 assert_eq!(hop.pubkey, node.node.get_our_node_id());
4056 let (_, our_payment_hash) = get_payment_preimage_hash!(origin_node);
4058 let err = origin_node.node.send_payment(route, our_payment_hash).err().unwrap();
4060 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over our max HTLC value in flight"),
4061 _ => panic!("Unknown error variants"),
4065 fn send_payment(origin: &Node, expected_route: &[&Node], recv_value: u64) {
4066 let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
4067 claim_payment(&origin, expected_route, our_payment_preimage);
4070 fn fail_payment_along_route(origin_node: &Node, expected_route: &[&Node], skip_last: bool, our_payment_hash: [u8; 32]) {
4071 assert!(expected_route.last().unwrap().node.fail_htlc_backwards(&our_payment_hash, PaymentFailReason::PreimageUnknown));
4072 check_added_monitors!(expected_route.last().unwrap(), 1);
4074 let mut next_msgs: Option<(msgs::UpdateFailHTLC, msgs::CommitmentSigned)> = None;
4075 macro_rules! update_fail_dance {
4076 ($node: expr, $prev_node: expr, $last_node: expr) => {
4078 $node.node.handle_update_fail_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0).unwrap();
4079 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, !$last_node);
4084 let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
4085 let mut prev_node = expected_route.last().unwrap();
4086 for (idx, node) in expected_route.iter().rev().enumerate() {
4087 assert_eq!(expected_next_node, node.node.get_our_node_id());
4088 if next_msgs.is_some() {
4089 // We may be the "last node" for the purpose of the commitment dance if we're
4090 // skipping the last node (implying it is disconnected) and we're the
4091 // second-to-last node!
4092 update_fail_dance!(node, prev_node, skip_last && idx == expected_route.len() - 1);
4095 let events = node.node.get_and_clear_pending_msg_events();
4096 if !skip_last || idx != expected_route.len() - 1 {
4097 assert_eq!(events.len(), 1);
4099 MessageSendEvent::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 } } => {
4100 assert!(update_add_htlcs.is_empty());
4101 assert!(update_fulfill_htlcs.is_empty());
4102 assert_eq!(update_fail_htlcs.len(), 1);
4103 assert!(update_fail_malformed_htlcs.is_empty());
4104 assert!(update_fee.is_none());
4105 expected_next_node = node_id.clone();
4106 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
4108 _ => panic!("Unexpected event"),
4111 assert!(events.is_empty());
4113 if !skip_last && idx == expected_route.len() - 1 {
4114 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
4121 update_fail_dance!(origin_node, expected_route.first().unwrap(), true);
4123 let events = origin_node.node.get_and_clear_pending_events();
4124 assert_eq!(events.len(), 1);
4126 Event::PaymentFailed { payment_hash, rejected_by_dest } => {
4127 assert_eq!(payment_hash, our_payment_hash);
4128 assert!(rejected_by_dest);
4130 _ => panic!("Unexpected event"),
4135 fn fail_payment(origin_node: &Node, expected_route: &[&Node], our_payment_hash: [u8; 32]) {
4136 fail_payment_along_route(origin_node, expected_route, false, our_payment_hash);
4139 fn create_network(node_count: usize) -> Vec<Node> {
4140 let mut nodes = Vec::new();
4141 let mut rng = thread_rng();
4142 let secp_ctx = Secp256k1::new();
4143 let logger: Arc<Logger> = Arc::new(test_utils::TestLogger::new());
4145 let chan_count = Rc::new(RefCell::new(0));
4146 let payment_count = Rc::new(RefCell::new(0));
4148 for _ in 0..node_count {
4149 let feeest = Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 });
4150 let chain_monitor = Arc::new(chaininterface::ChainWatchInterfaceUtil::new(Network::Testnet, Arc::clone(&logger)));
4151 let tx_broadcaster = Arc::new(test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())});
4152 let mut seed = [0; 32];
4153 rng.fill_bytes(&mut seed);
4154 let keys_manager = Arc::new(keysinterface::KeysManager::new(&seed, Network::Testnet, Arc::clone(&logger)));
4155 let chan_monitor = Arc::new(test_utils::TestChannelMonitor::new(chain_monitor.clone(), tx_broadcaster.clone(), logger.clone()));
4156 let mut config = UserConfig::new();
4157 config.channel_options.announced_channel = true;
4158 config.channel_limits.force_announced_channel_preference = false;
4159 let node = ChannelManager::new(Network::Testnet, feeest.clone(), chan_monitor.clone(), chain_monitor.clone(), tx_broadcaster.clone(), Arc::clone(&logger), keys_manager.clone(), config).unwrap();
4160 let router = Router::new(PublicKey::from_secret_key(&secp_ctx, &keys_manager.get_node_secret()), chain_monitor.clone(), Arc::clone(&logger));
4161 nodes.push(Node { chain_monitor, tx_broadcaster, chan_monitor, node, router, node_seed: seed,
4162 network_payment_count: payment_count.clone(),
4163 network_chan_count: chan_count.clone(),
4171 fn test_async_inbound_update_fee() {
4172 let mut nodes = create_network(2);
4173 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
4174 let channel_id = chan.2;
4177 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
4181 // send (1) commitment_signed -.
4182 // <- update_add_htlc/commitment_signed
4183 // send (2) RAA (awaiting remote revoke) -.
4184 // (1) commitment_signed is delivered ->
4185 // .- send (3) RAA (awaiting remote revoke)
4186 // (2) RAA is delivered ->
4187 // .- send (4) commitment_signed
4188 // <- (3) RAA is delivered
4189 // send (5) commitment_signed -.
4190 // <- (4) commitment_signed is delivered
4192 // (5) commitment_signed is delivered ->
4194 // (6) RAA is delivered ->
4196 // First nodes[0] generates an update_fee
4197 nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
4198 check_added_monitors!(nodes[0], 1);
4200 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
4201 assert_eq!(events_0.len(), 1);
4202 let (update_msg, commitment_signed) = match events_0[0] { // (1)
4203 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
4204 (update_fee.as_ref(), commitment_signed)
4206 _ => panic!("Unexpected event"),
4209 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
4211 // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
4212 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4213 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();
4214 check_added_monitors!(nodes[1], 1);
4216 let payment_event = {
4217 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
4218 assert_eq!(events_1.len(), 1);
4219 SendEvent::from_event(events_1.remove(0))
4221 assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
4222 assert_eq!(payment_event.msgs.len(), 1);
4224 // ...now when the messages get delivered everyone should be happy
4225 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
4226 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg).unwrap(); // (2)
4227 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4228 // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
4229 check_added_monitors!(nodes[0], 1);
4231 // deliver(1), generate (3):
4232 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
4233 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4234 // nodes[1] is awaiting nodes[0] revoke_and_ack so get_event_msg's assert(len == 1) passes
4235 check_added_monitors!(nodes[1], 1);
4237 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap(); // deliver (2)
4238 let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4239 assert!(bs_update.update_add_htlcs.is_empty()); // (4)
4240 assert!(bs_update.update_fulfill_htlcs.is_empty()); // (4)
4241 assert!(bs_update.update_fail_htlcs.is_empty()); // (4)
4242 assert!(bs_update.update_fail_malformed_htlcs.is_empty()); // (4)
4243 assert!(bs_update.update_fee.is_none()); // (4)
4244 check_added_monitors!(nodes[1], 1);
4246 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap(); // deliver (3)
4247 let as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4248 assert!(as_update.update_add_htlcs.is_empty()); // (5)
4249 assert!(as_update.update_fulfill_htlcs.is_empty()); // (5)
4250 assert!(as_update.update_fail_htlcs.is_empty()); // (5)
4251 assert!(as_update.update_fail_malformed_htlcs.is_empty()); // (5)
4252 assert!(as_update.update_fee.is_none()); // (5)
4253 check_added_monitors!(nodes[0], 1);
4255 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed).unwrap(); // deliver (4)
4256 let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4257 // only (6) so get_event_msg's assert(len == 1) passes
4258 check_added_monitors!(nodes[0], 1);
4260 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.commitment_signed).unwrap(); // deliver (5)
4261 let bs_second_revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4262 check_added_monitors!(nodes[1], 1);
4264 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke).unwrap();
4265 check_added_monitors!(nodes[0], 1);
4267 let events_2 = nodes[0].node.get_and_clear_pending_events();
4268 assert_eq!(events_2.len(), 1);
4270 Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
4271 _ => panic!("Unexpected event"),
4274 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke).unwrap(); // deliver (6)
4275 check_added_monitors!(nodes[1], 1);
4279 fn test_update_fee_unordered_raa() {
4280 // Just the intro to the previous test followed by an out-of-order RAA (which caused a
4281 // crash in an earlier version of the update_fee patch)
4282 let mut nodes = create_network(2);
4283 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
4284 let channel_id = chan.2;
4287 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
4289 // First nodes[0] generates an update_fee
4290 nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
4291 check_added_monitors!(nodes[0], 1);
4293 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
4294 assert_eq!(events_0.len(), 1);
4295 let update_msg = match events_0[0] { // (1)
4296 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
4299 _ => panic!("Unexpected event"),
4302 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
4304 // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
4305 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4306 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();
4307 check_added_monitors!(nodes[1], 1);
4309 let payment_event = {
4310 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
4311 assert_eq!(events_1.len(), 1);
4312 SendEvent::from_event(events_1.remove(0))
4314 assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
4315 assert_eq!(payment_event.msgs.len(), 1);
4317 // ...now when the messages get delivered everyone should be happy
4318 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
4319 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg).unwrap(); // (2)
4320 let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4321 // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
4322 check_added_monitors!(nodes[0], 1);
4324 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg).unwrap(); // deliver (2)
4325 check_added_monitors!(nodes[1], 1);
4327 // We can't continue, sadly, because our (1) now has a bogus signature
4331 fn test_multi_flight_update_fee() {
4332 let nodes = create_network(2);
4333 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
4334 let channel_id = chan.2;
4337 // update_fee/commitment_signed ->
4338 // .- send (1) RAA and (2) commitment_signed
4339 // update_fee (never committed) ->
4340 // (3) update_fee ->
4341 // We have to manually generate the above update_fee, it is allowed by the protocol but we
4342 // don't track which updates correspond to which revoke_and_ack responses so we're in
4343 // AwaitingRAA mode and will not generate the update_fee yet.
4344 // <- (1) RAA delivered
4345 // (3) is generated and send (4) CS -.
4346 // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
4347 // know the per_commitment_point to use for it.
4348 // <- (2) commitment_signed delivered
4349 // revoke_and_ack ->
4350 // B should send no response here
4351 // (4) commitment_signed delivered ->
4352 // <- RAA/commitment_signed delivered
4353 // revoke_and_ack ->
4355 // First nodes[0] generates an update_fee
4356 let initial_feerate = get_feerate!(nodes[0], channel_id);
4357 nodes[0].node.update_fee(channel_id, initial_feerate + 20).unwrap();
4358 check_added_monitors!(nodes[0], 1);
4360 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
4361 assert_eq!(events_0.len(), 1);
4362 let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
4363 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
4364 (update_fee.as_ref().unwrap(), commitment_signed)
4366 _ => panic!("Unexpected event"),
4369 // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
4370 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1).unwrap();
4371 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1).unwrap();
4372 let (bs_revoke_msg, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4373 check_added_monitors!(nodes[1], 1);
4375 // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
4377 nodes[0].node.update_fee(channel_id, initial_feerate + 40).unwrap();
4378 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
4379 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4381 // Create the (3) update_fee message that nodes[0] will generate before it does...
4382 let mut update_msg_2 = msgs::UpdateFee {
4383 channel_id: update_msg_1.channel_id.clone(),
4384 feerate_per_kw: (initial_feerate + 30) as u32,
4387 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2).unwrap();
4389 update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
4391 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2).unwrap();
4393 // Deliver (1), generating (3) and (4)
4394 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg).unwrap();
4395 let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4396 check_added_monitors!(nodes[0], 1);
4397 assert!(as_second_update.update_add_htlcs.is_empty());
4398 assert!(as_second_update.update_fulfill_htlcs.is_empty());
4399 assert!(as_second_update.update_fail_htlcs.is_empty());
4400 assert!(as_second_update.update_fail_malformed_htlcs.is_empty());
4401 // Check that the update_fee newly generated matches what we delivered:
4402 assert_eq!(as_second_update.update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
4403 assert_eq!(as_second_update.update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
4405 // Deliver (2) commitment_signed
4406 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed).unwrap();
4407 let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4408 check_added_monitors!(nodes[0], 1);
4409 // No commitment_signed so get_event_msg's assert(len == 1) passes
4411 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg).unwrap();
4412 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4413 check_added_monitors!(nodes[1], 1);
4416 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed).unwrap();
4417 let (bs_second_revoke, bs_second_commitment) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4418 check_added_monitors!(nodes[1], 1);
4420 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke).unwrap();
4421 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4422 check_added_monitors!(nodes[0], 1);
4424 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment).unwrap();
4425 let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4426 // No commitment_signed so get_event_msg's assert(len == 1) passes
4427 check_added_monitors!(nodes[0], 1);
4429 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke).unwrap();
4430 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4431 check_added_monitors!(nodes[1], 1);
4435 fn test_update_fee_vanilla() {
4436 let nodes = create_network(2);
4437 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
4438 let channel_id = chan.2;
4440 let feerate = get_feerate!(nodes[0], channel_id);
4441 nodes[0].node.update_fee(channel_id, feerate+25).unwrap();
4442 check_added_monitors!(nodes[0], 1);
4444 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
4445 assert_eq!(events_0.len(), 1);
4446 let (update_msg, commitment_signed) = match events_0[0] {
4447 MessageSendEvent::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 } } => {
4448 (update_fee.as_ref(), commitment_signed)
4450 _ => panic!("Unexpected event"),
4452 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
4454 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
4455 let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4456 check_added_monitors!(nodes[1], 1);
4458 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg).unwrap();
4459 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4460 check_added_monitors!(nodes[0], 1);
4462 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed).unwrap();
4463 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4464 // No commitment_signed so get_event_msg's assert(len == 1) passes
4465 check_added_monitors!(nodes[0], 1);
4467 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg).unwrap();
4468 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4469 check_added_monitors!(nodes[1], 1);
4473 fn test_update_fee_that_funder_cannot_afford() {
4474 let nodes = create_network(2);
4475 let channel_value = 1888;
4476 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 700000);
4477 let channel_id = chan.2;
4480 nodes[0].node.update_fee(channel_id, feerate).unwrap();
4481 check_added_monitors!(nodes[0], 1);
4482 let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4484 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap()).unwrap();
4486 commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
4488 //Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate of 260 set above.
4489 //This value results in a fee that is exactly what the funder can afford (277 sat + 1000 sat channel reserve)
4491 let chan_lock = nodes[1].node.channel_state.lock().unwrap();
4492 let chan = chan_lock.by_id.get(&channel_id).unwrap();
4494 //We made sure neither party's funds are below the dust limit so -2 non-HTLC txns from number of outputs
4495 let num_htlcs = chan.last_local_commitment_txn[0].output.len() - 2;
4496 let total_fee: u64 = feerate * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
4497 let mut actual_fee = chan.last_local_commitment_txn[0].output.iter().fold(0, |acc, output| acc + output.value);
4498 actual_fee = channel_value - actual_fee;
4499 assert_eq!(total_fee, actual_fee);
4502 //Add 2 to the previous fee rate to the final fee increases by 1 (with no HTLCs the fee is essentially
4503 //fee_rate*(724/1000) so the increment of 1*0.724 is rounded back down)
4504 nodes[0].node.update_fee(channel_id, feerate+2).unwrap();
4505 check_added_monitors!(nodes[0], 1);
4507 let update2_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4509 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update2_msg.update_fee.unwrap()).unwrap();
4511 //While producing the commitment_signed response after handling a received update_fee request the
4512 //check to see if the funder, who sent the update_fee request, can afford the new fee (funder_balance >= fee+channel_reserve)
4513 //Should produce and error.
4514 let err = nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update2_msg.commitment_signed).unwrap_err();
4516 assert!(match err.err {
4517 "Funding remote cannot afford proposed new fee" => true,
4521 //clear the message we could not handle
4522 nodes[1].node.get_and_clear_pending_msg_events();
4526 fn test_update_fee_with_fundee_update_add_htlc() {
4527 let mut nodes = create_network(2);
4528 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
4529 let channel_id = chan.2;
4532 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
4534 let feerate = get_feerate!(nodes[0], channel_id);
4535 nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
4536 check_added_monitors!(nodes[0], 1);
4538 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
4539 assert_eq!(events_0.len(), 1);
4540 let (update_msg, commitment_signed) = match events_0[0] {
4541 MessageSendEvent::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 } } => {
4542 (update_fee.as_ref(), commitment_signed)
4544 _ => panic!("Unexpected event"),
4546 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
4547 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
4548 let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4549 check_added_monitors!(nodes[1], 1);
4551 let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 800000, TEST_FINAL_CLTV).unwrap();
4553 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[1]);
4555 // nothing happens since node[1] is in AwaitingRemoteRevoke
4556 nodes[1].node.send_payment(route, our_payment_hash).unwrap();
4558 let mut added_monitors = nodes[0].chan_monitor.added_monitors.lock().unwrap();
4559 assert_eq!(added_monitors.len(), 0);
4560 added_monitors.clear();
4562 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
4563 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4564 // node[1] has nothing to do
4566 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg).unwrap();
4567 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4568 check_added_monitors!(nodes[0], 1);
4570 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed).unwrap();
4571 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4572 // No commitment_signed so get_event_msg's assert(len == 1) passes
4573 check_added_monitors!(nodes[0], 1);
4574 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg).unwrap();
4575 check_added_monitors!(nodes[1], 1);
4576 // AwaitingRemoteRevoke ends here
4578 let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4579 assert_eq!(commitment_update.update_add_htlcs.len(), 1);
4580 assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
4581 assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
4582 assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
4583 assert_eq!(commitment_update.update_fee.is_none(), true);
4585 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]).unwrap();
4586 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed).unwrap();
4587 check_added_monitors!(nodes[0], 1);
4588 let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4590 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke).unwrap();
4591 check_added_monitors!(nodes[1], 1);
4592 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4594 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed).unwrap();
4595 check_added_monitors!(nodes[1], 1);
4596 let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4597 // No commitment_signed so get_event_msg's assert(len == 1) passes
4599 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke).unwrap();
4600 check_added_monitors!(nodes[0], 1);
4601 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4603 let events = nodes[0].node.get_and_clear_pending_events();
4604 assert_eq!(events.len(), 1);
4606 Event::PendingHTLCsForwardable { .. } => { },
4607 _ => panic!("Unexpected event"),
4609 nodes[0].node.channel_state.lock().unwrap().next_forward = Instant::now();
4610 nodes[0].node.process_pending_htlc_forwards();
4612 let events = nodes[0].node.get_and_clear_pending_events();
4613 assert_eq!(events.len(), 1);
4615 Event::PaymentReceived { .. } => { },
4616 _ => panic!("Unexpected event"),
4619 claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage);
4621 send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000);
4622 send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000);
4623 close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
4627 fn test_update_fee() {
4628 let nodes = create_network(2);
4629 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
4630 let channel_id = chan.2;
4633 // (1) update_fee/commitment_signed ->
4634 // <- (2) revoke_and_ack
4635 // .- send (3) commitment_signed
4636 // (4) update_fee/commitment_signed ->
4637 // .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
4638 // <- (3) commitment_signed delivered
4639 // send (6) revoke_and_ack -.
4640 // <- (5) deliver revoke_and_ack
4641 // (6) deliver revoke_and_ack ->
4642 // .- send (7) commitment_signed in response to (4)
4643 // <- (7) deliver commitment_signed
4644 // revoke_and_ack ->
4646 // Create and deliver (1)...
4647 let feerate = get_feerate!(nodes[0], channel_id);
4648 nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
4649 check_added_monitors!(nodes[0], 1);
4651 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
4652 assert_eq!(events_0.len(), 1);
4653 let (update_msg, commitment_signed) = match events_0[0] {
4654 MessageSendEvent::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 } } => {
4655 (update_fee.as_ref(), commitment_signed)
4657 _ => panic!("Unexpected event"),
4659 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
4661 // Generate (2) and (3):
4662 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
4663 let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4664 check_added_monitors!(nodes[1], 1);
4667 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg).unwrap();
4668 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4669 check_added_monitors!(nodes[0], 1);
4671 // Create and deliver (4)...
4672 nodes[0].node.update_fee(channel_id, feerate+30).unwrap();
4673 check_added_monitors!(nodes[0], 1);
4674 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
4675 assert_eq!(events_0.len(), 1);
4676 let (update_msg, commitment_signed) = match events_0[0] {
4677 MessageSendEvent::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 } } => {
4678 (update_fee.as_ref(), commitment_signed)
4680 _ => panic!("Unexpected event"),
4683 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
4684 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
4685 check_added_monitors!(nodes[1], 1);
4687 let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4688 // No commitment_signed so get_event_msg's assert(len == 1) passes
4690 // Handle (3), creating (6):
4691 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0).unwrap();
4692 check_added_monitors!(nodes[0], 1);
4693 let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4694 // No commitment_signed so get_event_msg's assert(len == 1) passes
4697 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg).unwrap();
4698 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4699 check_added_monitors!(nodes[0], 1);
4701 // Deliver (6), creating (7):
4702 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0).unwrap();
4703 let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4704 assert!(commitment_update.update_add_htlcs.is_empty());
4705 assert!(commitment_update.update_fulfill_htlcs.is_empty());
4706 assert!(commitment_update.update_fail_htlcs.is_empty());
4707 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
4708 assert!(commitment_update.update_fee.is_none());
4709 check_added_monitors!(nodes[1], 1);
4712 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed).unwrap();
4713 check_added_monitors!(nodes[0], 1);
4714 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4715 // No commitment_signed so get_event_msg's assert(len == 1) passes
4717 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg).unwrap();
4718 check_added_monitors!(nodes[1], 1);
4719 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4721 assert_eq!(get_feerate!(nodes[0], channel_id), feerate + 30);
4722 assert_eq!(get_feerate!(nodes[1], channel_id), feerate + 30);
4723 close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
4727 fn pre_funding_lock_shutdown_test() {
4728 // Test sending a shutdown prior to funding_locked after funding generation
4729 let nodes = create_network(2);
4730 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0);
4731 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4732 nodes[0].chain_monitor.block_connected_checked(&header, 1, &[&tx; 1], &[1; 1]);
4733 nodes[1].chain_monitor.block_connected_checked(&header, 1, &[&tx; 1], &[1; 1]);
4735 nodes[0].node.close_channel(&OutPoint::new(tx.txid(), 0).to_channel_id()).unwrap();
4736 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
4737 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown).unwrap();
4738 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
4739 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown).unwrap();
4741 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
4742 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed).unwrap();
4743 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
4744 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap()).unwrap();
4745 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
4746 assert!(node_0_none.is_none());
4748 assert!(nodes[0].node.list_channels().is_empty());
4749 assert!(nodes[1].node.list_channels().is_empty());
4753 fn updates_shutdown_wait() {
4754 // Test sending a shutdown with outstanding updates pending
4755 let mut nodes = create_network(3);
4756 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
4757 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
4758 let route_1 = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
4759 let route_2 = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
4761 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
4763 nodes[0].node.close_channel(&chan_1.2).unwrap();
4764 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
4765 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown).unwrap();
4766 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
4767 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown).unwrap();
4769 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4770 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4772 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
4773 if let Err(APIError::ChannelUnavailable {..}) = nodes[0].node.send_payment(route_1, payment_hash) {}
4774 else { panic!("New sends should fail!") };
4775 if let Err(APIError::ChannelUnavailable {..}) = nodes[1].node.send_payment(route_2, payment_hash) {}
4776 else { panic!("New sends should fail!") };
4778 assert!(nodes[2].node.claim_funds(our_payment_preimage));
4779 check_added_monitors!(nodes[2], 1);
4780 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
4781 assert!(updates.update_add_htlcs.is_empty());
4782 assert!(updates.update_fail_htlcs.is_empty());
4783 assert!(updates.update_fail_malformed_htlcs.is_empty());
4784 assert!(updates.update_fee.is_none());
4785 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4786 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]).unwrap();
4787 check_added_monitors!(nodes[1], 1);
4788 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4789 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
4791 assert!(updates_2.update_add_htlcs.is_empty());
4792 assert!(updates_2.update_fail_htlcs.is_empty());
4793 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
4794 assert!(updates_2.update_fee.is_none());
4795 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
4796 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]).unwrap();
4797 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
4799 let events = nodes[0].node.get_and_clear_pending_events();
4800 assert_eq!(events.len(), 1);
4802 Event::PaymentSent { ref payment_preimage } => {
4803 assert_eq!(our_payment_preimage, *payment_preimage);
4805 _ => panic!("Unexpected event"),
4808 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
4809 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed).unwrap();
4810 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
4811 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap()).unwrap();
4812 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
4813 assert!(node_0_none.is_none());
4815 assert!(nodes[0].node.list_channels().is_empty());
4817 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
4818 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
4819 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
4820 assert!(nodes[1].node.list_channels().is_empty());
4821 assert!(nodes[2].node.list_channels().is_empty());
4825 fn htlc_fail_async_shutdown() {
4826 // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
4827 let mut nodes = create_network(3);
4828 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
4829 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
4831 let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
4832 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4833 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
4834 check_added_monitors!(nodes[0], 1);
4835 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4836 assert_eq!(updates.update_add_htlcs.len(), 1);
4837 assert!(updates.update_fulfill_htlcs.is_empty());
4838 assert!(updates.update_fail_htlcs.is_empty());
4839 assert!(updates.update_fail_malformed_htlcs.is_empty());
4840 assert!(updates.update_fee.is_none());
4842 nodes[1].node.close_channel(&chan_1.2).unwrap();
4843 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
4844 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown).unwrap();
4845 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
4847 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]).unwrap();
4848 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed).unwrap();
4849 check_added_monitors!(nodes[1], 1);
4850 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown).unwrap();
4851 commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
4853 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4854 assert!(updates_2.update_add_htlcs.is_empty());
4855 assert!(updates_2.update_fulfill_htlcs.is_empty());
4856 assert_eq!(updates_2.update_fail_htlcs.len(), 1);
4857 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
4858 assert!(updates_2.update_fee.is_none());
4860 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]).unwrap();
4861 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
4863 let events = nodes[0].node.get_and_clear_pending_events();
4864 assert_eq!(events.len(), 1);
4866 Event::PaymentFailed { ref payment_hash, ref rejected_by_dest } => {
4867 assert_eq!(our_payment_hash, *payment_hash);
4868 assert!(!rejected_by_dest);
4870 _ => panic!("Unexpected event"),
4873 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4874 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
4875 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed).unwrap();
4876 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
4877 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap()).unwrap();
4878 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
4879 assert!(node_0_none.is_none());
4881 assert!(nodes[0].node.list_channels().is_empty());
4883 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
4884 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
4885 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
4886 assert!(nodes[1].node.list_channels().is_empty());
4887 assert!(nodes[2].node.list_channels().is_empty());
4891 fn update_fee_async_shutdown() {
4892 // Test update_fee works after shutdown start if messages are delivered out-of-order
4893 let nodes = create_network(2);
4894 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
4896 let starting_feerate = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().get_feerate();
4897 nodes[0].node.update_fee(chan_1.2.clone(), starting_feerate + 20).unwrap();
4898 check_added_monitors!(nodes[0], 1);
4899 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4900 assert!(updates.update_add_htlcs.is_empty());
4901 assert!(updates.update_fulfill_htlcs.is_empty());
4902 assert!(updates.update_fail_htlcs.is_empty());
4903 assert!(updates.update_fail_malformed_htlcs.is_empty());
4904 assert!(updates.update_fee.is_some());
4906 nodes[1].node.close_channel(&chan_1.2).unwrap();
4907 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
4908 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown).unwrap();
4909 // Note that we don't actually test normative behavior here. The spec indicates we could
4910 // actually send a closing_signed here, but is kinda unclear and could possibly be amended
4911 // to require waiting on the full commitment dance before doing so (see
4912 // https://github.com/lightningnetwork/lightning-rfc/issues/499). In any case, to avoid
4913 // ambiguity, we should wait until after the full commitment dance to send closing_signed.
4914 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
4916 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &updates.update_fee.unwrap()).unwrap();
4917 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed).unwrap();
4918 check_added_monitors!(nodes[1], 1);
4919 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown).unwrap();
4920 let node_0_closing_signed = commitment_signed_dance!(nodes[1], nodes[0], (), false, true, true);
4922 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4923 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), match node_0_closing_signed.unwrap() {
4924 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
4925 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
4928 _ => panic!("Unexpected event"),
4930 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
4931 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap()).unwrap();
4932 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
4933 assert!(node_0_none.is_none());
4936 fn do_test_shutdown_rebroadcast(recv_count: u8) {
4937 // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
4938 // messages delivered prior to disconnect
4939 let nodes = create_network(3);
4940 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
4941 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
4943 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
4945 nodes[1].node.close_channel(&chan_1.2).unwrap();
4946 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
4948 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown).unwrap();
4949 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
4951 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown).unwrap();
4955 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4956 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4958 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
4959 let node_0_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
4960 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
4961 let node_1_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
4963 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish).unwrap();
4964 let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
4965 assert!(node_1_shutdown == node_1_2nd_shutdown);
4967 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish).unwrap();
4968 let node_0_2nd_shutdown = if recv_count > 0 {
4969 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
4970 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown).unwrap();
4973 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4974 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown).unwrap();
4975 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
4977 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_2nd_shutdown).unwrap();
4979 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4980 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4982 assert!(nodes[2].node.claim_funds(our_payment_preimage));
4983 check_added_monitors!(nodes[2], 1);
4984 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
4985 assert!(updates.update_add_htlcs.is_empty());
4986 assert!(updates.update_fail_htlcs.is_empty());
4987 assert!(updates.update_fail_malformed_htlcs.is_empty());
4988 assert!(updates.update_fee.is_none());
4989 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4990 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]).unwrap();
4991 check_added_monitors!(nodes[1], 1);
4992 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4993 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
4995 assert!(updates_2.update_add_htlcs.is_empty());
4996 assert!(updates_2.update_fail_htlcs.is_empty());
4997 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
4998 assert!(updates_2.update_fee.is_none());
4999 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
5000 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]).unwrap();
5001 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
5003 let events = nodes[0].node.get_and_clear_pending_events();
5004 assert_eq!(events.len(), 1);
5006 Event::PaymentSent { ref payment_preimage } => {
5007 assert_eq!(our_payment_preimage, *payment_preimage);
5009 _ => panic!("Unexpected event"),
5012 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
5014 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed).unwrap();
5015 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
5016 assert!(node_1_closing_signed.is_some());
5019 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5020 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5022 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
5023 let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
5024 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
5025 if recv_count == 0 {
5026 // If all closing_signeds weren't delivered we can just resume where we left off...
5027 let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
5029 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish).unwrap();
5030 let node_0_3rd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
5031 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
5033 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish).unwrap();
5034 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
5035 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
5037 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_3rd_shutdown).unwrap();
5038 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
5040 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_3rd_shutdown).unwrap();
5041 let node_0_2nd_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
5042 assert!(node_0_closing_signed == node_0_2nd_closing_signed);
5044 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed).unwrap();
5045 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
5046 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap()).unwrap();
5047 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
5048 assert!(node_0_none.is_none());
5050 // If one node, however, received + responded with an identical closing_signed we end
5051 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
5052 // There isn't really anything better we can do simply, but in the future we might
5053 // explore storing a set of recently-closed channels that got disconnected during
5054 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
5055 // give our counterparty enough time to (potentially) broadcast a cooperative closing
5057 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
5059 if let Err(msgs::HandleError{action: Some(msgs::ErrorAction::SendErrorMessage{msg}), ..}) =
5060 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish) {
5061 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msg);
5062 let msgs::ErrorMessage {ref channel_id, ..} = msg;
5063 assert_eq!(*channel_id, chan_1.2);
5064 } else { panic!("Needed SendErrorMessage close"); }
5066 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
5067 // checks it, but in this case nodes[0] didn't ever get a chance to receive a
5068 // closing_signed so we do it ourselves
5069 let events = nodes[0].node.get_and_clear_pending_msg_events();
5070 assert_eq!(events.len(), 1);
5072 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
5073 assert_eq!(msg.contents.flags & 2, 2);
5075 _ => panic!("Unexpected event"),
5079 assert!(nodes[0].node.list_channels().is_empty());
5081 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
5082 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
5083 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
5084 assert!(nodes[1].node.list_channels().is_empty());
5085 assert!(nodes[2].node.list_channels().is_empty());
5089 fn test_shutdown_rebroadcast() {
5090 do_test_shutdown_rebroadcast(0);
5091 do_test_shutdown_rebroadcast(1);
5092 do_test_shutdown_rebroadcast(2);
5096 fn fake_network_test() {
5097 // Simple test which builds a network of ChannelManagers, connects them to each other, and
5098 // tests that payments get routed and transactions broadcast in semi-reasonable ways.
5099 let nodes = create_network(4);
5101 // Create some initial channels
5102 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
5103 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
5104 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3);
5106 // Rebalance the network a bit by relaying one payment through all the channels...
5107 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
5108 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
5109 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
5110 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
5112 // Send some more payments
5113 send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000);
5114 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000);
5115 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000);
5117 // Test failure packets
5118 let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
5119 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
5121 // Add a new channel that skips 3
5122 let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3);
5124 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000);
5125 send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000);
5126 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
5127 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
5128 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
5129 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
5130 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
5132 // Do some rebalance loop payments, simultaneously
5133 let mut hops = Vec::with_capacity(3);
5134 hops.push(RouteHop {
5135 pubkey: nodes[2].node.get_our_node_id(),
5136 short_channel_id: chan_2.0.contents.short_channel_id,
5138 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
5140 hops.push(RouteHop {
5141 pubkey: nodes[3].node.get_our_node_id(),
5142 short_channel_id: chan_3.0.contents.short_channel_id,
5144 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
5146 hops.push(RouteHop {
5147 pubkey: nodes[1].node.get_our_node_id(),
5148 short_channel_id: chan_4.0.contents.short_channel_id,
5150 cltv_expiry_delta: TEST_FINAL_CLTV,
5152 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;
5153 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;
5154 let payment_preimage_1 = send_along_route(&nodes[1], Route { hops }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
5156 let mut hops = Vec::with_capacity(3);
5157 hops.push(RouteHop {
5158 pubkey: nodes[3].node.get_our_node_id(),
5159 short_channel_id: chan_4.0.contents.short_channel_id,
5161 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
5163 hops.push(RouteHop {
5164 pubkey: nodes[2].node.get_our_node_id(),
5165 short_channel_id: chan_3.0.contents.short_channel_id,
5167 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
5169 hops.push(RouteHop {
5170 pubkey: nodes[1].node.get_our_node_id(),
5171 short_channel_id: chan_2.0.contents.short_channel_id,
5173 cltv_expiry_delta: TEST_FINAL_CLTV,
5175 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;
5176 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;
5177 let payment_hash_2 = send_along_route(&nodes[1], Route { hops }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
5179 // Claim the rebalances...
5180 fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
5181 claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1);
5183 // Add a duplicate new channel from 2 to 4
5184 let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3);
5186 // Send some payments across both channels
5187 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
5188 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
5189 let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
5191 route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
5193 //TODO: Test that routes work again here as we've been notified that the channel is full
5195 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3);
5196 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4);
5197 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5);
5199 // Close down the channels...
5200 close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
5201 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
5202 close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
5203 close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
5204 close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
5208 fn duplicate_htlc_test() {
5209 // Test that we accept duplicate payment_hash HTLCs across the network and that
5210 // claiming/failing them are all separate and don't effect each other
5211 let mut nodes = create_network(6);
5213 // Create some initial channels to route via 3 to 4/5 from 0/1/2
5214 create_announced_chan_between_nodes(&nodes, 0, 3);
5215 create_announced_chan_between_nodes(&nodes, 1, 3);
5216 create_announced_chan_between_nodes(&nodes, 2, 3);
5217 create_announced_chan_between_nodes(&nodes, 3, 4);
5218 create_announced_chan_between_nodes(&nodes, 3, 5);
5220 let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
5222 *nodes[0].network_payment_count.borrow_mut() -= 1;
5223 assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
5225 *nodes[0].network_payment_count.borrow_mut() -= 1;
5226 assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
5228 claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage);
5229 fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
5230 claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage);
5233 #[derive(PartialEq)]
5234 enum HTLCType { NONE, TIMEOUT, SUCCESS }
5235 /// Tests that the given node has broadcast transactions for the given Channel
5237 /// First checks that the latest local commitment tx has been broadcast, unless an explicit
5238 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
5239 /// broadcast and the revoked outputs were claimed.
5241 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
5242 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
5244 /// All broadcast transactions must be accounted for in one of the above three types of we'll
5246 fn test_txn_broadcast(node: &Node, chan: &(msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction), commitment_tx: Option<Transaction>, has_htlc_tx: HTLCType) -> Vec<Transaction> {
5247 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
5248 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
5250 let mut res = Vec::with_capacity(2);
5251 node_txn.retain(|tx| {
5252 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
5253 check_spends!(tx, chan.3.clone());
5254 if commitment_tx.is_none() {
5255 res.push(tx.clone());
5260 if let Some(explicit_tx) = commitment_tx {
5261 res.push(explicit_tx.clone());
5264 assert_eq!(res.len(), 1);
5266 if has_htlc_tx != HTLCType::NONE {
5267 node_txn.retain(|tx| {
5268 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
5269 check_spends!(tx, res[0].clone());
5270 if has_htlc_tx == HTLCType::TIMEOUT {
5271 assert!(tx.lock_time != 0);
5273 assert!(tx.lock_time == 0);
5275 res.push(tx.clone());
5279 assert_eq!(res.len(), 2);
5282 assert!(node_txn.is_empty());
5286 /// Tests that the given node has broadcast a claim transaction against the provided revoked
5287 /// HTLC transaction.
5288 fn test_revoked_htlc_claim_txn_broadcast(node: &Node, revoked_tx: Transaction) {
5289 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
5290 assert_eq!(node_txn.len(), 1);
5291 node_txn.retain(|tx| {
5292 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
5293 check_spends!(tx, revoked_tx.clone());
5297 assert!(node_txn.is_empty());
5300 fn check_preimage_claim(node: &Node, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
5301 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
5303 assert!(node_txn.len() >= 1);
5304 assert_eq!(node_txn[0].input.len(), 1);
5305 let mut found_prev = false;
5307 for tx in prev_txn {
5308 if node_txn[0].input[0].previous_output.txid == tx.txid() {
5309 check_spends!(node_txn[0], tx.clone());
5310 assert!(node_txn[0].input[0].witness[2].len() > 106); // must spend an htlc output
5311 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
5317 assert!(found_prev);
5319 let mut res = Vec::new();
5320 mem::swap(&mut *node_txn, &mut res);
5324 fn get_announce_close_broadcast_events(nodes: &Vec<Node>, a: usize, b: usize) {
5325 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
5326 assert_eq!(events_1.len(), 1);
5327 let as_update = match events_1[0] {
5328 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
5331 _ => panic!("Unexpected event"),
5334 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
5335 assert_eq!(events_2.len(), 1);
5336 let bs_update = match events_2[0] {
5337 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
5340 _ => panic!("Unexpected event"),
5344 node.router.handle_channel_update(&as_update).unwrap();
5345 node.router.handle_channel_update(&bs_update).unwrap();
5349 macro_rules! expect_pending_htlcs_forwardable {
5351 let events = $node.node.get_and_clear_pending_events();
5352 assert_eq!(events.len(), 1);
5354 Event::PendingHTLCsForwardable { .. } => { },
5355 _ => panic!("Unexpected event"),
5357 $node.node.channel_state.lock().unwrap().next_forward = Instant::now();
5358 $node.node.process_pending_htlc_forwards();
5363 fn channel_reserve_test() {
5365 use std::sync::atomic::Ordering;
5366 use ln::msgs::HandleError;
5368 macro_rules! get_channel_value_stat {
5369 ($node: expr, $channel_id: expr) => {{
5370 let chan_lock = $node.node.channel_state.lock().unwrap();
5371 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
5372 chan.get_value_stat()
5376 let mut nodes = create_network(3);
5377 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1900, 1001);
5378 let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1900, 1001);
5380 let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
5381 let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
5383 let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
5384 let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
5386 macro_rules! get_route_and_payment_hash {
5387 ($recv_value: expr) => {{
5388 let route = nodes[0].router.get_route(&nodes.last().unwrap().node.get_our_node_id(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV).unwrap();
5389 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
5390 (route, payment_hash, payment_preimage)
5394 macro_rules! expect_forward {
5396 let mut events = $node.node.get_and_clear_pending_msg_events();
5397 assert_eq!(events.len(), 1);
5398 check_added_monitors!($node, 1);
5399 let payment_event = SendEvent::from_event(events.remove(0));
5404 macro_rules! expect_payment_received {
5405 ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
5406 let events = $node.node.get_and_clear_pending_events();
5407 assert_eq!(events.len(), 1);
5409 Event::PaymentReceived { ref payment_hash, amt } => {
5410 assert_eq!($expected_payment_hash, *payment_hash);
5411 assert_eq!($expected_recv_value, amt);
5413 _ => panic!("Unexpected event"),
5418 let feemsat = 239; // somehow we know?
5419 let total_fee_msat = (nodes.len() - 2) as u64 * 239;
5421 let recv_value_0 = stat01.their_max_htlc_value_in_flight_msat - total_fee_msat;
5423 // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
5425 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_0 + 1);
5426 assert!(route.hops.iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
5427 let err = nodes[0].node.send_payment(route, our_payment_hash).err().unwrap();
5429 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over our max HTLC value in flight"),
5430 _ => panic!("Unknown error variants"),
5434 let mut htlc_id = 0;
5435 // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
5436 // nodes[0]'s wealth
5438 let amt_msat = recv_value_0 + total_fee_msat;
5439 if stat01.value_to_self_msat - amt_msat < stat01.channel_reserve_msat {
5442 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0);
5445 let (stat01_, stat11_, stat12_, stat22_) = (
5446 get_channel_value_stat!(nodes[0], chan_1.2),
5447 get_channel_value_stat!(nodes[1], chan_1.2),
5448 get_channel_value_stat!(nodes[1], chan_2.2),
5449 get_channel_value_stat!(nodes[2], chan_2.2),
5452 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
5453 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
5454 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
5455 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
5456 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
5460 let recv_value = stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat;
5461 // attempt to get channel_reserve violation
5462 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value + 1);
5463 let err = nodes[0].node.send_payment(route.clone(), our_payment_hash).err().unwrap();
5465 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over our reserve value"),
5466 _ => panic!("Unknown error variants"),
5470 // adding pending output
5471 let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat)/2;
5472 let amt_msat_1 = recv_value_1 + total_fee_msat;
5474 let (route_1, our_payment_hash_1, our_payment_preimage_1) = get_route_and_payment_hash!(recv_value_1);
5475 let payment_event_1 = {
5476 nodes[0].node.send_payment(route_1, our_payment_hash_1).unwrap();
5477 check_added_monitors!(nodes[0], 1);
5479 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5480 assert_eq!(events.len(), 1);
5481 SendEvent::from_event(events.remove(0))
5483 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]).unwrap();
5485 // channel reserve test with htlc pending output > 0
5486 let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat;
5488 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
5489 match nodes[0].node.send_payment(route, our_payment_hash).err().unwrap() {
5490 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over our reserve value"),
5491 _ => panic!("Unknown error variants"),
5496 // test channel_reserve test on nodes[1] side
5497 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
5499 // Need to manually create update_add_htlc message to go around the channel reserve check in send_htlc()
5500 let secp_ctx = Secp256k1::new();
5501 let session_priv = SecretKey::from_slice(&secp_ctx, &{
5502 let mut session_key = [0; 32];
5503 rng::fill_bytes(&mut session_key);
5505 }).expect("RNG is bad!");
5507 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5508 let onion_keys = ChannelManager::construct_onion_keys(&secp_ctx, &route, &session_priv).unwrap();
5509 let (onion_payloads, htlc_msat, htlc_cltv) = ChannelManager::build_onion_payloads(&route, cur_height).unwrap();
5510 let onion_packet = ChannelManager::construct_onion_packet(onion_payloads, onion_keys, &our_payment_hash);
5511 let msg = msgs::UpdateAddHTLC {
5512 channel_id: chan_1.2,
5514 amount_msat: htlc_msat,
5515 payment_hash: our_payment_hash,
5516 cltv_expiry: htlc_cltv,
5517 onion_routing_packet: onion_packet,
5520 let err = nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg).err().unwrap();
5522 HandleError{err, .. } => assert_eq!(err, "Remote HTLC add would put them over their reserve value"),
5526 // split the rest to test holding cell
5527 let recv_value_21 = recv_value_2/2;
5528 let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat;
5530 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
5531 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);
5534 // now see if they go through on both sides
5535 let (route_21, our_payment_hash_21, our_payment_preimage_21) = get_route_and_payment_hash!(recv_value_21);
5536 // but this will stuck in the holding cell
5537 nodes[0].node.send_payment(route_21, our_payment_hash_21).unwrap();
5538 check_added_monitors!(nodes[0], 0);
5539 let events = nodes[0].node.get_and_clear_pending_events();
5540 assert_eq!(events.len(), 0);
5542 // test with outbound holding cell amount > 0
5544 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_22+1);
5545 match nodes[0].node.send_payment(route, our_payment_hash).err().unwrap() {
5546 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over our reserve value"),
5547 _ => panic!("Unknown error variants"),
5551 let (route_22, our_payment_hash_22, our_payment_preimage_22) = get_route_and_payment_hash!(recv_value_22);
5552 // this will also stuck in the holding cell
5553 nodes[0].node.send_payment(route_22, our_payment_hash_22).unwrap();
5554 check_added_monitors!(nodes[0], 0);
5555 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
5556 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5558 // flush the pending htlc
5559 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg).unwrap();
5560 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5561 check_added_monitors!(nodes[1], 1);
5563 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
5564 check_added_monitors!(nodes[0], 1);
5565 let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5567 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed).unwrap();
5568 let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
5569 // No commitment_signed so get_event_msg's assert(len == 1) passes
5570 check_added_monitors!(nodes[0], 1);
5572 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
5573 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
5574 check_added_monitors!(nodes[1], 1);
5576 expect_pending_htlcs_forwardable!(nodes[1]);
5578 let ref payment_event_11 = expect_forward!(nodes[1]);
5579 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]).unwrap();
5580 commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
5582 expect_pending_htlcs_forwardable!(nodes[2]);
5583 expect_payment_received!(nodes[2], our_payment_hash_1, recv_value_1);
5585 // flush the htlcs in the holding cell
5586 assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
5587 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]).unwrap();
5588 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]).unwrap();
5589 commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
5590 expect_pending_htlcs_forwardable!(nodes[1]);
5592 let ref payment_event_3 = expect_forward!(nodes[1]);
5593 assert_eq!(payment_event_3.msgs.len(), 2);
5594 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]).unwrap();
5595 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]).unwrap();
5597 commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
5598 expect_pending_htlcs_forwardable!(nodes[2]);
5600 let events = nodes[2].node.get_and_clear_pending_events();
5601 assert_eq!(events.len(), 2);
5603 Event::PaymentReceived { ref payment_hash, amt } => {
5604 assert_eq!(our_payment_hash_21, *payment_hash);
5605 assert_eq!(recv_value_21, amt);
5607 _ => panic!("Unexpected event"),
5610 Event::PaymentReceived { ref payment_hash, amt } => {
5611 assert_eq!(our_payment_hash_22, *payment_hash);
5612 assert_eq!(recv_value_22, amt);
5614 _ => panic!("Unexpected event"),
5617 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1);
5618 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21);
5619 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22);
5621 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);
5622 let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
5623 assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
5624 assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat);
5626 let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
5627 assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22);
5631 fn channel_monitor_network_test() {
5632 // Simple test which builds a network of ChannelManagers, connects them to each other, and
5633 // tests that ChannelMonitor is able to recover from various states.
5634 let nodes = create_network(5);
5636 // Create some initial channels
5637 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
5638 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
5639 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3);
5640 let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4);
5642 // Rebalance the network a bit by relaying one payment through all the channels...
5643 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
5644 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
5645 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
5646 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
5648 // Simple case with no pending HTLCs:
5649 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
5651 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
5652 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5653 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
5654 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
5656 get_announce_close_broadcast_events(&nodes, 0, 1);
5657 assert_eq!(nodes[0].node.list_channels().len(), 0);
5658 assert_eq!(nodes[1].node.list_channels().len(), 1);
5660 // One pending HTLC is discarded by the force-close:
5661 let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
5663 // Simple case of one pending HTLC to HTLC-Timeout
5664 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
5666 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
5667 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5668 nodes[2].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
5669 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
5671 get_announce_close_broadcast_events(&nodes, 1, 2);
5672 assert_eq!(nodes[1].node.list_channels().len(), 0);
5673 assert_eq!(nodes[2].node.list_channels().len(), 1);
5675 macro_rules! claim_funds {
5676 ($node: expr, $prev_node: expr, $preimage: expr) => {
5678 assert!($node.node.claim_funds($preimage));
5679 check_added_monitors!($node, 1);
5681 let events = $node.node.get_and_clear_pending_msg_events();
5682 assert_eq!(events.len(), 1);
5684 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
5685 assert!(update_add_htlcs.is_empty());
5686 assert!(update_fail_htlcs.is_empty());
5687 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
5689 _ => panic!("Unexpected event"),
5695 // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
5696 // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
5697 nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
5699 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
5701 // Claim the payment on nodes[3], giving it knowledge of the preimage
5702 claim_funds!(nodes[3], nodes[2], payment_preimage_1);
5704 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5705 nodes[3].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[0].clone()] }, 1);
5707 check_preimage_claim(&nodes[3], &node_txn);
5709 get_announce_close_broadcast_events(&nodes, 2, 3);
5710 assert_eq!(nodes[2].node.list_channels().len(), 0);
5711 assert_eq!(nodes[3].node.list_channels().len(), 1);
5713 { // Cheat and reset nodes[4]'s height to 1
5714 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5715 nodes[4].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![] }, 1);
5718 assert_eq!(nodes[3].node.latest_block_height.load(Ordering::Acquire), 1);
5719 assert_eq!(nodes[4].node.latest_block_height.load(Ordering::Acquire), 1);
5720 // One pending HTLC to time out:
5721 let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
5722 // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
5726 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5727 nodes[3].chain_monitor.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
5728 for i in 3..TEST_FINAL_CLTV + 2 + HTLC_FAIL_TIMEOUT_BLOCKS + 1 {
5729 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5730 nodes[3].chain_monitor.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
5733 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
5735 // Claim the payment on nodes[4], giving it knowledge of the preimage
5736 claim_funds!(nodes[4], nodes[3], payment_preimage_2);
5738 header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5739 nodes[4].chain_monitor.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
5740 for i in 3..TEST_FINAL_CLTV + 2 - CLTV_CLAIM_BUFFER + 1 {
5741 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5742 nodes[4].chain_monitor.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
5745 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
5747 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5748 nodes[4].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[0].clone()] }, TEST_FINAL_CLTV - 5);
5750 check_preimage_claim(&nodes[4], &node_txn);
5752 get_announce_close_broadcast_events(&nodes, 3, 4);
5753 assert_eq!(nodes[3].node.list_channels().len(), 0);
5754 assert_eq!(nodes[4].node.list_channels().len(), 0);
5758 fn test_justice_tx() {
5759 // Test justice txn built on revoked HTLC-Success tx, against both sides
5761 let nodes = create_network(2);
5762 // Create some new channels:
5763 let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1);
5765 // A pending HTLC which will be revoked:
5766 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5767 // Get the will-be-revoked local txn from nodes[0]
5768 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.iter().next().unwrap().1.last_local_commitment_txn.clone();
5769 assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
5770 assert_eq!(revoked_local_txn[0].input.len(), 1);
5771 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
5772 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
5773 assert_eq!(revoked_local_txn[1].input.len(), 1);
5774 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
5775 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), 133); // HTLC-Timeout
5776 // Revoke the old state
5777 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
5780 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5781 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5783 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5784 assert_eq!(node_txn.len(), 3);
5785 assert_eq!(node_txn.pop().unwrap(), node_txn[0]); // An outpoint registration will result in a 2nd block_connected
5786 assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
5788 check_spends!(node_txn[0], revoked_local_txn[0].clone());
5789 node_txn.swap_remove(0);
5791 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
5793 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5794 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
5795 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5796 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
5797 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone());
5799 get_announce_close_broadcast_events(&nodes, 0, 1);
5801 assert_eq!(nodes[0].node.list_channels().len(), 0);
5802 assert_eq!(nodes[1].node.list_channels().len(), 0);
5804 // We test justice_tx build by A on B's revoked HTLC-Success tx
5805 // Create some new channels:
5806 let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1);
5808 // A pending HTLC which will be revoked:
5809 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5810 // Get the will-be-revoked local txn from B
5811 let revoked_local_txn = nodes[1].node.channel_state.lock().unwrap().by_id.iter().next().unwrap().1.last_local_commitment_txn.clone();
5812 assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
5813 assert_eq!(revoked_local_txn[0].input.len(), 1);
5814 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
5815 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
5816 // Revoke the old state
5817 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4);
5819 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5820 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5822 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5823 assert_eq!(node_txn.len(), 3);
5824 assert_eq!(node_txn.pop().unwrap(), node_txn[0]); // An outpoint registration will result in a 2nd block_connected
5825 assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
5827 check_spends!(node_txn[0], revoked_local_txn[0].clone());
5828 node_txn.swap_remove(0);
5830 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
5832 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5833 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
5834 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5835 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
5836 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone());
5838 get_announce_close_broadcast_events(&nodes, 0, 1);
5839 assert_eq!(nodes[0].node.list_channels().len(), 0);
5840 assert_eq!(nodes[1].node.list_channels().len(), 0);
5844 fn revoked_output_claim() {
5845 // Simple test to ensure a node will claim a revoked output when a stale remote commitment
5846 // transaction is broadcast by its counterparty
5847 let nodes = create_network(2);
5848 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
5849 // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
5850 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
5851 assert_eq!(revoked_local_txn.len(), 1);
5852 // Only output is the full channel value back to nodes[0]:
5853 assert_eq!(revoked_local_txn[0].output.len(), 1);
5854 // Send a payment through, updating everyone's latest commitment txn
5855 send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000);
5857 // Inform nodes[1] that nodes[0] broadcast a stale tx
5858 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5859 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5860 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5861 assert_eq!(node_txn.len(), 3); // nodes[1] will broadcast justice tx twice, and its own local state once
5863 assert_eq!(node_txn[0], node_txn[2]);
5865 check_spends!(node_txn[0], revoked_local_txn[0].clone());
5866 check_spends!(node_txn[1], chan_1.3.clone());
5868 // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
5869 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5870 get_announce_close_broadcast_events(&nodes, 0, 1);
5874 fn claim_htlc_outputs_shared_tx() {
5875 // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
5876 let nodes = create_network(2);
5878 // Create some new channel:
5879 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
5881 // Rebalance the network to generate htlc in the two directions
5882 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5883 // 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
5884 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5885 let _payment_preimage_2 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
5887 // Get the will-be-revoked local txn from node[0]
5888 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
5889 assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
5890 assert_eq!(revoked_local_txn[0].input.len(), 1);
5891 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5892 assert_eq!(revoked_local_txn[1].input.len(), 1);
5893 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
5894 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), 133); // HTLC-Timeout
5895 check_spends!(revoked_local_txn[1], revoked_local_txn[0].clone());
5897 //Revoke the old state
5898 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
5901 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5903 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5905 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5906 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5907 assert_eq!(node_txn.len(), 4);
5909 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
5910 check_spends!(node_txn[0], revoked_local_txn[0].clone());
5912 assert_eq!(node_txn[0], node_txn[3]); // justice tx is duplicated due to block re-scanning
5914 let mut witness_lens = BTreeSet::new();
5915 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
5916 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
5917 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
5918 assert_eq!(witness_lens.len(), 3);
5919 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
5920 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), 133); // revoked offered HTLC
5921 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), 138); // revoked received HTLC
5923 // Next nodes[1] broadcasts its current local tx state:
5924 assert_eq!(node_txn[1].input.len(), 1);
5925 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
5927 assert_eq!(node_txn[2].input.len(), 1);
5928 let witness_script = node_txn[2].clone().input[0].witness.pop().unwrap();
5929 assert_eq!(witness_script.len(), 133); //Spending an offered htlc output
5930 assert_eq!(node_txn[2].input[0].previous_output.txid, node_txn[1].txid());
5931 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
5932 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[1].previous_output.txid);
5934 get_announce_close_broadcast_events(&nodes, 0, 1);
5935 assert_eq!(nodes[0].node.list_channels().len(), 0);
5936 assert_eq!(nodes[1].node.list_channels().len(), 0);
5940 fn claim_htlc_outputs_single_tx() {
5941 // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
5942 let nodes = create_network(2);
5944 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
5946 // Rebalance the network to generate htlc in the two directions
5947 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5948 // 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
5949 // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
5950 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5951 let _payment_preimage_2 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
5953 // Get the will-be-revoked local txn from node[0]
5954 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
5956 //Revoke the old state
5957 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
5960 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5962 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
5964 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
5965 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5966 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)
5968 assert_eq!(node_txn[0], node_txn[7]);
5969 assert_eq!(node_txn[1], node_txn[8]);
5970 assert_eq!(node_txn[2], node_txn[9]);
5971 assert_eq!(node_txn[3], node_txn[10]);
5972 assert_eq!(node_txn[4], node_txn[11]);
5973 assert_eq!(node_txn[3], node_txn[5]); //local commitment tx + htlc timeout tx broadcated by ChannelManger
5974 assert_eq!(node_txn[4], node_txn[6]);
5976 assert_eq!(node_txn[0].input.len(), 1);
5977 assert_eq!(node_txn[1].input.len(), 1);
5978 assert_eq!(node_txn[2].input.len(), 1);
5980 let mut revoked_tx_map = HashMap::new();
5981 revoked_tx_map.insert(revoked_local_txn[0].txid(), revoked_local_txn[0].clone());
5982 node_txn[0].verify(&revoked_tx_map).unwrap();
5983 node_txn[1].verify(&revoked_tx_map).unwrap();
5984 node_txn[2].verify(&revoked_tx_map).unwrap();
5986 let mut witness_lens = BTreeSet::new();
5987 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
5988 witness_lens.insert(node_txn[1].input[0].witness.last().unwrap().len());
5989 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
5990 assert_eq!(witness_lens.len(), 3);
5991 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
5992 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), 133); // revoked offered HTLC
5993 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), 138); // revoked received HTLC
5995 assert_eq!(node_txn[3].input.len(), 1);
5996 check_spends!(node_txn[3], chan_1.3.clone());
5998 assert_eq!(node_txn[4].input.len(), 1);
5999 let witness_script = node_txn[4].input[0].witness.last().unwrap();
6000 assert_eq!(witness_script.len(), 133); //Spending an offered htlc output
6001 assert_eq!(node_txn[4].input[0].previous_output.txid, node_txn[3].txid());
6002 assert_ne!(node_txn[4].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
6003 assert_ne!(node_txn[4].input[0].previous_output.txid, node_txn[1].input[0].previous_output.txid);
6005 get_announce_close_broadcast_events(&nodes, 0, 1);
6006 assert_eq!(nodes[0].node.list_channels().len(), 0);
6007 assert_eq!(nodes[1].node.list_channels().len(), 0);
6011 fn test_htlc_ignore_latest_remote_commitment() {
6012 // Test that HTLC transactions spending the latest remote commitment transaction are simply
6013 // ignored if we cannot claim them. This originally tickled an invalid unwrap().
6014 let nodes = create_network(2);
6015 create_announced_chan_between_nodes(&nodes, 0, 1);
6017 route_payment(&nodes[0], &[&nodes[1]], 10000000);
6018 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id);
6020 let events = nodes[0].node.get_and_clear_pending_msg_events();
6021 assert_eq!(events.len(), 1);
6023 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { contents: msgs::UnsignedChannelUpdate { flags, .. }, .. } } => {
6024 assert_eq!(flags & 0b10, 0b10);
6026 _ => panic!("Unexpected event"),
6030 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6031 assert_eq!(node_txn.len(), 2);
6033 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6034 nodes[1].chain_monitor.block_connected_checked(&header, 1, &[&node_txn[0], &node_txn[1]], &[1; 2]);
6037 let events = nodes[1].node.get_and_clear_pending_msg_events();
6038 assert_eq!(events.len(), 1);
6040 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { contents: msgs::UnsignedChannelUpdate { flags, .. }, .. } } => {
6041 assert_eq!(flags & 0b10, 0b10);
6043 _ => panic!("Unexpected event"),
6047 // Duplicate the block_connected call since this may happen due to other listeners
6048 // registering new transactions
6049 nodes[1].chain_monitor.block_connected_checked(&header, 1, &[&node_txn[0], &node_txn[1]], &[1; 2]);
6053 fn test_force_close_fail_back() {
6054 // Check which HTLCs are failed-backwards on channel force-closure
6055 let mut nodes = create_network(3);
6056 create_announced_chan_between_nodes(&nodes, 0, 1);
6057 create_announced_chan_between_nodes(&nodes, 1, 2);
6059 let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, 42).unwrap();
6061 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6063 let mut payment_event = {
6064 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
6065 check_added_monitors!(nodes[0], 1);
6067 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6068 assert_eq!(events.len(), 1);
6069 SendEvent::from_event(events.remove(0))
6072 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
6073 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6075 let events_1 = nodes[1].node.get_and_clear_pending_events();
6076 assert_eq!(events_1.len(), 1);
6078 Event::PendingHTLCsForwardable { .. } => { },
6079 _ => panic!("Unexpected event"),
6082 nodes[1].node.channel_state.lock().unwrap().next_forward = Instant::now();
6083 nodes[1].node.process_pending_htlc_forwards();
6085 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
6086 assert_eq!(events_2.len(), 1);
6087 payment_event = SendEvent::from_event(events_2.remove(0));
6088 assert_eq!(payment_event.msgs.len(), 1);
6090 check_added_monitors!(nodes[1], 1);
6091 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
6092 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg).unwrap();
6093 check_added_monitors!(nodes[2], 1);
6094 let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
6096 // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
6097 // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
6098 // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
6100 nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id);
6101 let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
6102 assert_eq!(events_3.len(), 1);
6104 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { contents: msgs::UnsignedChannelUpdate { flags, .. }, .. } } => {
6105 assert_eq!(flags & 0b10, 0b10);
6107 _ => panic!("Unexpected event"),
6111 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
6112 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
6113 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
6114 // back to nodes[1] upon timeout otherwise.
6115 assert_eq!(node_txn.len(), 1);
6119 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6120 nodes[1].chain_monitor.block_connected_checked(&header, 1, &[&tx], &[1]);
6122 let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
6123 // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
6124 assert_eq!(events_4.len(), 1);
6126 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { contents: msgs::UnsignedChannelUpdate { flags, .. }, .. } } => {
6127 assert_eq!(flags & 0b10, 0b10);
6129 _ => panic!("Unexpected event"),
6132 // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
6134 let mut monitors = nodes[2].chan_monitor.simple_monitor.monitors.lock().unwrap();
6135 monitors.get_mut(&OutPoint::new(Sha256dHash::from(&payment_event.commitment_msg.channel_id[..]), 0)).unwrap()
6136 .provide_payment_preimage(&our_payment_hash, &our_payment_preimage);
6138 nodes[2].chain_monitor.block_connected_checked(&header, 1, &[&tx], &[1]);
6139 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
6140 assert_eq!(node_txn.len(), 1);
6141 assert_eq!(node_txn[0].input.len(), 1);
6142 assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
6143 assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
6144 assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
6146 check_spends!(node_txn[0], tx);
6150 fn test_unconf_chan() {
6151 // After creating a chan between nodes, we disconnect all blocks previously seen to force a channel close on nodes[0] side
6152 let nodes = create_network(2);
6153 create_announced_chan_between_nodes(&nodes, 0, 1);
6155 let channel_state = nodes[0].node.channel_state.lock().unwrap();
6156 assert_eq!(channel_state.by_id.len(), 1);
6157 assert_eq!(channel_state.short_to_id.len(), 1);
6158 mem::drop(channel_state);
6160 let mut headers = Vec::new();
6161 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6162 headers.push(header.clone());
6164 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6165 headers.push(header.clone());
6167 while !headers.is_empty() {
6168 nodes[0].node.block_disconnected(&headers.pop().unwrap());
6171 let events = nodes[0].node.get_and_clear_pending_msg_events();
6172 assert_eq!(events.len(), 1);
6174 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { contents: msgs::UnsignedChannelUpdate { flags, .. }, .. } } => {
6175 assert_eq!(flags & 0b10, 0b10);
6177 _ => panic!("Unexpected event"),
6180 let channel_state = nodes[0].node.channel_state.lock().unwrap();
6181 assert_eq!(channel_state.by_id.len(), 0);
6182 assert_eq!(channel_state.short_to_id.len(), 0);
6185 macro_rules! get_chan_reestablish_msgs {
6186 ($src_node: expr, $dst_node: expr) => {
6188 let mut res = Vec::with_capacity(1);
6189 for msg in $src_node.node.get_and_clear_pending_msg_events() {
6190 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
6191 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
6192 res.push(msg.clone());
6194 panic!("Unexpected event")
6202 macro_rules! handle_chan_reestablish_msgs {
6203 ($src_node: expr, $dst_node: expr) => {
6205 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
6207 let funding_locked = if let Some(&MessageSendEvent::SendFundingLocked { ref node_id, ref msg }) = msg_events.get(0) {
6209 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
6215 let mut revoke_and_ack = None;
6216 let mut commitment_update = None;
6217 let order = if let Some(ev) = msg_events.get(idx) {
6220 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
6221 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
6222 revoke_and_ack = Some(msg.clone());
6223 RAACommitmentOrder::RevokeAndACKFirst
6225 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
6226 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
6227 commitment_update = Some(updates.clone());
6228 RAACommitmentOrder::CommitmentFirst
6230 _ => panic!("Unexpected event"),
6233 RAACommitmentOrder::CommitmentFirst
6236 if let Some(ev) = msg_events.get(idx) {
6238 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
6239 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
6240 assert!(revoke_and_ack.is_none());
6241 revoke_and_ack = Some(msg.clone());
6243 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
6244 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
6245 assert!(commitment_update.is_none());
6246 commitment_update = Some(updates.clone());
6248 _ => panic!("Unexpected event"),
6252 (funding_locked, revoke_and_ack, commitment_update, order)
6257 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
6258 /// for claims/fails they are separated out.
6259 fn reconnect_nodes(node_a: &Node, node_b: &Node, send_funding_locked: (bool, 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)) {
6260 node_a.node.peer_connected(&node_b.node.get_our_node_id());
6261 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
6262 node_b.node.peer_connected(&node_a.node.get_our_node_id());
6263 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
6265 let mut resp_1 = Vec::new();
6266 for msg in reestablish_1 {
6267 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg).unwrap();
6268 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
6270 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
6271 check_added_monitors!(node_b, 1);
6273 check_added_monitors!(node_b, 0);
6276 let mut resp_2 = Vec::new();
6277 for msg in reestablish_2 {
6278 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg).unwrap();
6279 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
6281 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
6282 check_added_monitors!(node_a, 1);
6284 check_added_monitors!(node_a, 0);
6287 // We dont yet support both needing updates, as that would require a different commitment dance:
6288 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
6289 (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
6291 for chan_msgs in resp_1.drain(..) {
6292 if send_funding_locked.0 {
6293 node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap()).unwrap();
6294 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
6295 if !announcement_event.is_empty() {
6296 assert_eq!(announcement_event.len(), 1);
6297 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
6298 //TODO: Test announcement_sigs re-sending
6299 } else { panic!("Unexpected event!"); }
6302 assert!(chan_msgs.0.is_none());
6305 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
6306 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap()).unwrap();
6307 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
6308 check_added_monitors!(node_a, 1);
6310 assert!(chan_msgs.1.is_none());
6312 if pending_htlc_adds.0 != 0 || pending_htlc_claims.0 != 0 || pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
6313 let commitment_update = chan_msgs.2.unwrap();
6314 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
6315 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
6317 assert!(commitment_update.update_add_htlcs.is_empty());
6319 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
6320 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
6321 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
6322 for update_add in commitment_update.update_add_htlcs {
6323 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add).unwrap();
6325 for update_fulfill in commitment_update.update_fulfill_htlcs {
6326 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill).unwrap();
6328 for update_fail in commitment_update.update_fail_htlcs {
6329 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail).unwrap();
6332 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
6333 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
6335 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed).unwrap();
6336 check_added_monitors!(node_a, 1);
6337 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
6338 // No commitment_signed so get_event_msg's assert(len == 1) passes
6339 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack).unwrap();
6340 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
6341 check_added_monitors!(node_b, 1);
6344 assert!(chan_msgs.2.is_none());
6348 for chan_msgs in resp_2.drain(..) {
6349 if send_funding_locked.1 {
6350 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap()).unwrap();
6351 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
6352 if !announcement_event.is_empty() {
6353 assert_eq!(announcement_event.len(), 1);
6354 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
6355 //TODO: Test announcement_sigs re-sending
6356 } else { panic!("Unexpected event!"); }
6359 assert!(chan_msgs.0.is_none());
6362 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
6363 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap()).unwrap();
6364 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
6365 check_added_monitors!(node_b, 1);
6367 assert!(chan_msgs.1.is_none());
6369 if pending_htlc_adds.1 != 0 || pending_htlc_claims.1 != 0 || pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
6370 let commitment_update = chan_msgs.2.unwrap();
6371 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
6372 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
6374 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
6375 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
6376 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
6377 for update_add in commitment_update.update_add_htlcs {
6378 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add).unwrap();
6380 for update_fulfill in commitment_update.update_fulfill_htlcs {
6381 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill).unwrap();
6383 for update_fail in commitment_update.update_fail_htlcs {
6384 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail).unwrap();
6387 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
6388 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
6390 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed).unwrap();
6391 check_added_monitors!(node_b, 1);
6392 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
6393 // No commitment_signed so get_event_msg's assert(len == 1) passes
6394 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
6395 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
6396 check_added_monitors!(node_a, 1);
6399 assert!(chan_msgs.2.is_none());
6405 fn test_simple_peer_disconnect() {
6406 // Test that we can reconnect when there are no lost messages
6407 let nodes = create_network(3);
6408 create_announced_chan_between_nodes(&nodes, 0, 1);
6409 create_announced_chan_between_nodes(&nodes, 1, 2);
6411 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6412 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6413 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
6415 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
6416 let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
6417 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
6418 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1);
6420 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6421 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6422 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
6424 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
6425 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
6426 let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
6427 let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
6429 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6430 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6432 claim_payment_along_route(&nodes[0], &vec!(&nodes[1], &nodes[2]), true, payment_preimage_3);
6433 fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
6435 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
6437 let events = nodes[0].node.get_and_clear_pending_events();
6438 assert_eq!(events.len(), 2);
6440 Event::PaymentSent { payment_preimage } => {
6441 assert_eq!(payment_preimage, payment_preimage_3);
6443 _ => panic!("Unexpected event"),
6446 Event::PaymentFailed { payment_hash, rejected_by_dest } => {
6447 assert_eq!(payment_hash, payment_hash_5);
6448 assert!(rejected_by_dest);
6450 _ => panic!("Unexpected event"),
6454 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4);
6455 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
6458 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
6459 // Test that we can reconnect when in-flight HTLC updates get dropped
6460 let mut nodes = create_network(2);
6461 if messages_delivered == 0 {
6462 create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001);
6463 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
6465 create_announced_chan_between_nodes(&nodes, 0, 1);
6468 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();
6469 let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
6471 let payment_event = {
6472 nodes[0].node.send_payment(route.clone(), payment_hash_1).unwrap();
6473 check_added_monitors!(nodes[0], 1);
6475 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6476 assert_eq!(events.len(), 1);
6477 SendEvent::from_event(events.remove(0))
6479 assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
6481 if messages_delivered < 2 {
6482 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
6484 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
6485 if messages_delivered >= 3 {
6486 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg).unwrap();
6487 check_added_monitors!(nodes[1], 1);
6488 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6490 if messages_delivered >= 4 {
6491 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
6492 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6493 check_added_monitors!(nodes[0], 1);
6495 if messages_delivered >= 5 {
6496 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed).unwrap();
6497 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
6498 // No commitment_signed so get_event_msg's assert(len == 1) passes
6499 check_added_monitors!(nodes[0], 1);
6501 if messages_delivered >= 6 {
6502 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
6503 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
6504 check_added_monitors!(nodes[1], 1);
6511 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6512 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6513 if messages_delivered < 3 {
6514 // Even if the funding_locked messages get exchanged, as long as nothing further was
6515 // received on either side, both sides will need to resend them.
6516 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
6517 } else if messages_delivered == 3 {
6518 // nodes[0] still wants its RAA + commitment_signed
6519 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
6520 } else if messages_delivered == 4 {
6521 // nodes[0] still wants its commitment_signed
6522 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
6523 } else if messages_delivered == 5 {
6524 // nodes[1] still wants its final RAA
6525 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
6526 } else if messages_delivered == 6 {
6527 // Everything was delivered...
6528 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
6531 let events_1 = nodes[1].node.get_and_clear_pending_events();
6532 assert_eq!(events_1.len(), 1);
6534 Event::PendingHTLCsForwardable { .. } => { },
6535 _ => panic!("Unexpected event"),
6538 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6539 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6540 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
6542 nodes[1].node.channel_state.lock().unwrap().next_forward = Instant::now();
6543 nodes[1].node.process_pending_htlc_forwards();
6545 let events_2 = nodes[1].node.get_and_clear_pending_events();
6546 assert_eq!(events_2.len(), 1);
6548 Event::PaymentReceived { ref payment_hash, amt } => {
6549 assert_eq!(payment_hash_1, *payment_hash);
6550 assert_eq!(amt, 1000000);
6552 _ => panic!("Unexpected event"),
6555 nodes[1].node.claim_funds(payment_preimage_1);
6556 check_added_monitors!(nodes[1], 1);
6558 let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
6559 assert_eq!(events_3.len(), 1);
6560 let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
6561 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
6562 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
6563 assert!(updates.update_add_htlcs.is_empty());
6564 assert!(updates.update_fail_htlcs.is_empty());
6565 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
6566 assert!(updates.update_fail_malformed_htlcs.is_empty());
6567 assert!(updates.update_fee.is_none());
6568 (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
6570 _ => panic!("Unexpected event"),
6573 if messages_delivered >= 1 {
6574 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc).unwrap();
6576 let events_4 = nodes[0].node.get_and_clear_pending_events();
6577 assert_eq!(events_4.len(), 1);
6579 Event::PaymentSent { ref payment_preimage } => {
6580 assert_eq!(payment_preimage_1, *payment_preimage);
6582 _ => panic!("Unexpected event"),
6585 if messages_delivered >= 2 {
6586 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed).unwrap();
6587 check_added_monitors!(nodes[0], 1);
6588 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6590 if messages_delivered >= 3 {
6591 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
6592 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
6593 check_added_monitors!(nodes[1], 1);
6595 if messages_delivered >= 4 {
6596 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed).unwrap();
6597 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
6598 // No commitment_signed so get_event_msg's assert(len == 1) passes
6599 check_added_monitors!(nodes[1], 1);
6601 if messages_delivered >= 5 {
6602 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
6603 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6604 check_added_monitors!(nodes[0], 1);
6611 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6612 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6613 if messages_delivered < 2 {
6614 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
6615 //TODO: Deduplicate PaymentSent events, then enable this if:
6616 //if messages_delivered < 1 {
6617 let events_4 = nodes[0].node.get_and_clear_pending_events();
6618 assert_eq!(events_4.len(), 1);
6620 Event::PaymentSent { ref payment_preimage } => {
6621 assert_eq!(payment_preimage_1, *payment_preimage);
6623 _ => panic!("Unexpected event"),
6626 } else if messages_delivered == 2 {
6627 // nodes[0] still wants its RAA + commitment_signed
6628 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
6629 } else if messages_delivered == 3 {
6630 // nodes[0] still wants its commitment_signed
6631 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
6632 } else if messages_delivered == 4 {
6633 // nodes[1] still wants its final RAA
6634 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
6635 } else if messages_delivered == 5 {
6636 // Everything was delivered...
6637 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
6640 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6641 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6642 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
6644 // Channel should still work fine...
6645 let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
6646 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
6650 fn test_drop_messages_peer_disconnect_a() {
6651 do_test_drop_messages_peer_disconnect(0);
6652 do_test_drop_messages_peer_disconnect(1);
6653 do_test_drop_messages_peer_disconnect(2);
6654 do_test_drop_messages_peer_disconnect(3);
6658 fn test_drop_messages_peer_disconnect_b() {
6659 do_test_drop_messages_peer_disconnect(4);
6660 do_test_drop_messages_peer_disconnect(5);
6661 do_test_drop_messages_peer_disconnect(6);
6665 fn test_funding_peer_disconnect() {
6666 // Test that we can lock in our funding tx while disconnected
6667 let nodes = create_network(2);
6668 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001);
6670 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6671 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6673 confirm_transaction(&nodes[0].chain_monitor, &tx, tx.version);
6674 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
6675 assert_eq!(events_1.len(), 1);
6677 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
6678 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
6680 _ => panic!("Unexpected event"),
6683 reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
6685 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6686 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6688 confirm_transaction(&nodes[1].chain_monitor, &tx, tx.version);
6689 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
6690 assert_eq!(events_2.len(), 2);
6692 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
6693 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
6695 _ => panic!("Unexpected event"),
6698 MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ } => {
6699 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
6701 _ => panic!("Unexpected event"),
6704 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
6706 // TODO: We shouldn't need to manually pass list_usable_chanels here once we support
6707 // rebroadcasting announcement_signatures upon reconnect.
6709 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();
6710 let (payment_preimage, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
6711 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
6715 fn test_drop_messages_peer_disconnect_dual_htlc() {
6716 // Test that we can handle reconnecting when both sides of a channel have pending
6717 // commitment_updates when we disconnect.
6718 let mut nodes = create_network(2);
6719 create_announced_chan_between_nodes(&nodes, 0, 1);
6721 let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
6723 // Now try to send a second payment which will fail to send
6724 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
6725 let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
6727 nodes[0].node.send_payment(route.clone(), payment_hash_2).unwrap();
6728 check_added_monitors!(nodes[0], 1);
6730 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
6731 assert_eq!(events_1.len(), 1);
6733 MessageSendEvent::UpdateHTLCs { .. } => {},
6734 _ => panic!("Unexpected event"),
6737 assert!(nodes[1].node.claim_funds(payment_preimage_1));
6738 check_added_monitors!(nodes[1], 1);
6740 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
6741 assert_eq!(events_2.len(), 1);
6743 MessageSendEvent::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 } } => {
6744 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
6745 assert!(update_add_htlcs.is_empty());
6746 assert_eq!(update_fulfill_htlcs.len(), 1);
6747 assert!(update_fail_htlcs.is_empty());
6748 assert!(update_fail_malformed_htlcs.is_empty());
6749 assert!(update_fee.is_none());
6751 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]).unwrap();
6752 let events_3 = nodes[0].node.get_and_clear_pending_events();
6753 assert_eq!(events_3.len(), 1);
6755 Event::PaymentSent { ref payment_preimage } => {
6756 assert_eq!(*payment_preimage, payment_preimage_1);
6758 _ => panic!("Unexpected event"),
6761 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed).unwrap();
6762 let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
6763 // No commitment_signed so get_event_msg's assert(len == 1) passes
6764 check_added_monitors!(nodes[0], 1);
6766 _ => panic!("Unexpected event"),
6769 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6770 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6772 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
6773 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6774 assert_eq!(reestablish_1.len(), 1);
6775 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
6776 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6777 assert_eq!(reestablish_2.len(), 1);
6779 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]).unwrap();
6780 let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6781 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]).unwrap();
6782 let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6784 assert!(as_resp.0.is_none());
6785 assert!(bs_resp.0.is_none());
6787 assert!(bs_resp.1.is_none());
6788 assert!(bs_resp.2.is_none());
6790 assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
6792 assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
6793 assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
6794 assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
6795 assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
6796 assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
6797 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]).unwrap();
6798 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed).unwrap();
6799 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
6800 // No commitment_signed so get_event_msg's assert(len == 1) passes
6801 check_added_monitors!(nodes[1], 1);
6803 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap()).unwrap();
6804 let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6805 assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
6806 assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
6807 assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
6808 assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
6809 assert!(bs_second_commitment_signed.update_fee.is_none());
6810 check_added_monitors!(nodes[1], 1);
6812 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
6813 let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6814 assert!(as_commitment_signed.update_add_htlcs.is_empty());
6815 assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
6816 assert!(as_commitment_signed.update_fail_htlcs.is_empty());
6817 assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
6818 assert!(as_commitment_signed.update_fee.is_none());
6819 check_added_monitors!(nodes[0], 1);
6821 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed).unwrap();
6822 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
6823 // No commitment_signed so get_event_msg's assert(len == 1) passes
6824 check_added_monitors!(nodes[0], 1);
6826 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed).unwrap();
6827 let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
6828 // No commitment_signed so get_event_msg's assert(len == 1) passes
6829 check_added_monitors!(nodes[1], 1);
6831 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
6832 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
6833 check_added_monitors!(nodes[1], 1);
6835 let events_4 = nodes[1].node.get_and_clear_pending_events();
6836 assert_eq!(events_4.len(), 1);
6838 Event::PendingHTLCsForwardable { .. } => { },
6839 _ => panic!("Unexpected event"),
6842 nodes[1].node.channel_state.lock().unwrap().next_forward = Instant::now();
6843 nodes[1].node.process_pending_htlc_forwards();
6845 let events_5 = nodes[1].node.get_and_clear_pending_events();
6846 assert_eq!(events_5.len(), 1);
6848 Event::PaymentReceived { ref payment_hash, amt: _ } => {
6849 assert_eq!(payment_hash_2, *payment_hash);
6851 _ => panic!("Unexpected event"),
6854 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack).unwrap();
6855 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6856 check_added_monitors!(nodes[0], 1);
6858 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
6862 fn test_simple_monitor_permanent_update_fail() {
6863 // Test that we handle a simple permanent monitor update failure
6864 let mut nodes = create_network(2);
6865 create_announced_chan_between_nodes(&nodes, 0, 1);
6867 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
6868 let (_, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
6870 *nodes[0].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::PermanentFailure);
6871 if let Err(APIError::MonitorUpdateFailed) = nodes[0].node.send_payment(route, payment_hash_1) {} else { panic!(); }
6872 check_added_monitors!(nodes[0], 1);
6874 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
6875 assert_eq!(events_1.len(), 1);
6877 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
6878 _ => panic!("Unexpected event"),
6881 // TODO: Once we hit the chain with the failure transaction we should check that we get a
6882 // PaymentFailed event
6884 assert_eq!(nodes[0].node.list_channels().len(), 0);
6887 fn do_test_simple_monitor_temporary_update_fail(disconnect: bool) {
6888 // Test that we can recover from a simple temporary monitor update failure optionally with
6889 // a disconnect in between
6890 let mut nodes = create_network(2);
6891 create_announced_chan_between_nodes(&nodes, 0, 1);
6893 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
6894 let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
6896 *nodes[0].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure);
6897 if let Err(APIError::MonitorUpdateFailed) = nodes[0].node.send_payment(route.clone(), payment_hash_1) {} else { panic!(); }
6898 check_added_monitors!(nodes[0], 1);
6900 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
6901 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6902 assert_eq!(nodes[0].node.list_channels().len(), 1);
6905 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6906 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6907 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
6910 *nodes[0].chan_monitor.update_ret.lock().unwrap() = Ok(());
6911 nodes[0].node.test_restore_channel_monitor();
6912 check_added_monitors!(nodes[0], 1);
6914 let mut events_2 = nodes[0].node.get_and_clear_pending_msg_events();
6915 assert_eq!(events_2.len(), 1);
6916 let payment_event = SendEvent::from_event(events_2.pop().unwrap());
6917 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
6918 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
6919 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6921 expect_pending_htlcs_forwardable!(nodes[1]);
6923 let events_3 = nodes[1].node.get_and_clear_pending_events();
6924 assert_eq!(events_3.len(), 1);
6926 Event::PaymentReceived { ref payment_hash, amt } => {
6927 assert_eq!(payment_hash_1, *payment_hash);
6928 assert_eq!(amt, 1000000);
6930 _ => panic!("Unexpected event"),
6933 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
6935 // Now set it to failed again...
6936 let (_, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
6937 *nodes[0].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure);
6938 if let Err(APIError::MonitorUpdateFailed) = nodes[0].node.send_payment(route, payment_hash_2) {} else { panic!(); }
6939 check_added_monitors!(nodes[0], 1);
6941 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
6942 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6943 assert_eq!(nodes[0].node.list_channels().len(), 1);
6946 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6947 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6948 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
6951 // ...and make sure we can force-close a TemporaryFailure channel with a PermanentFailure
6952 *nodes[0].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::PermanentFailure);
6953 nodes[0].node.test_restore_channel_monitor();
6954 check_added_monitors!(nodes[0], 1);
6956 let events_5 = nodes[0].node.get_and_clear_pending_msg_events();
6957 assert_eq!(events_5.len(), 1);
6959 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
6960 _ => panic!("Unexpected event"),
6963 // TODO: Once we hit the chain with the failure transaction we should check that we get a
6964 // PaymentFailed event
6966 assert_eq!(nodes[0].node.list_channels().len(), 0);
6970 fn test_simple_monitor_temporary_update_fail() {
6971 do_test_simple_monitor_temporary_update_fail(false);
6972 do_test_simple_monitor_temporary_update_fail(true);
6975 fn do_test_monitor_temporary_update_fail(disconnect_count: usize) {
6976 let disconnect_flags = 8 | 16;
6978 // Test that we can recover from a temporary monitor update failure with some in-flight
6979 // HTLCs going on at the same time potentially with some disconnection thrown in.
6980 // * First we route a payment, then get a temporary monitor update failure when trying to
6981 // route a second payment. We then claim the first payment.
6982 // * If disconnect_count is set, we will disconnect at this point (which is likely as
6983 // TemporaryFailure likely indicates net disconnect which resulted in failing to update
6984 // the ChannelMonitor on a watchtower).
6985 // * If !(disconnect_count & 16) we deliver a update_fulfill_htlc/CS for the first payment
6986 // immediately, otherwise we wait sconnect and deliver them via the reconnect
6987 // channel_reestablish processing (ie disconnect_count & 16 makes no sense if
6988 // disconnect_count & !disconnect_flags is 0).
6989 // * We then update the channel monitor, reconnecting if disconnect_count is set and walk
6990 // through message sending, potentially disconnect/reconnecting multiple times based on
6991 // disconnect_count, to get the update_fulfill_htlc through.
6992 // * We then walk through more message exchanges to get the original update_add_htlc
6993 // through, swapping message ordering based on disconnect_count & 8 and optionally
6994 // disconnect/reconnecting based on disconnect_count.
6995 let mut nodes = create_network(2);
6996 create_announced_chan_between_nodes(&nodes, 0, 1);
6998 let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7000 // Now try to send a second payment which will fail to send
7001 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
7002 let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
7004 *nodes[0].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure);
7005 if let Err(APIError::MonitorUpdateFailed) = nodes[0].node.send_payment(route.clone(), payment_hash_2) {} else { panic!(); }
7006 check_added_monitors!(nodes[0], 1);
7008 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
7009 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7010 assert_eq!(nodes[0].node.list_channels().len(), 1);
7012 // Claim the previous payment, which will result in a update_fulfill_htlc/CS from nodes[1]
7013 // but nodes[0] won't respond since it is frozen.
7014 assert!(nodes[1].node.claim_funds(payment_preimage_1));
7015 check_added_monitors!(nodes[1], 1);
7016 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
7017 assert_eq!(events_2.len(), 1);
7018 let (bs_initial_fulfill, bs_initial_commitment_signed) = match events_2[0] {
7019 MessageSendEvent::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 } } => {
7020 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
7021 assert!(update_add_htlcs.is_empty());
7022 assert_eq!(update_fulfill_htlcs.len(), 1);
7023 assert!(update_fail_htlcs.is_empty());
7024 assert!(update_fail_malformed_htlcs.is_empty());
7025 assert!(update_fee.is_none());
7027 if (disconnect_count & 16) == 0 {
7028 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]).unwrap();
7029 let events_3 = nodes[0].node.get_and_clear_pending_events();
7030 assert_eq!(events_3.len(), 1);
7032 Event::PaymentSent { ref payment_preimage } => {
7033 assert_eq!(*payment_preimage, payment_preimage_1);
7035 _ => panic!("Unexpected event"),
7038 if let Err(msgs::HandleError{err, action: Some(msgs::ErrorAction::IgnoreError) }) = nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed) {
7039 assert_eq!(err, "Previous monitor update failure prevented generation of RAA");
7040 } else { panic!(); }
7043 (update_fulfill_htlcs[0].clone(), commitment_signed.clone())
7045 _ => panic!("Unexpected event"),
7048 if disconnect_count & !disconnect_flags > 0 {
7049 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7050 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7053 // Now fix monitor updating...
7054 *nodes[0].chan_monitor.update_ret.lock().unwrap() = Ok(());
7055 nodes[0].node.test_restore_channel_monitor();
7056 check_added_monitors!(nodes[0], 1);
7058 macro_rules! disconnect_reconnect_peers { () => { {
7059 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7060 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7062 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
7063 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7064 assert_eq!(reestablish_1.len(), 1);
7065 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
7066 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7067 assert_eq!(reestablish_2.len(), 1);
7069 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]).unwrap();
7070 let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7071 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]).unwrap();
7072 let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7074 assert!(as_resp.0.is_none());
7075 assert!(bs_resp.0.is_none());
7077 (reestablish_1, reestablish_2, as_resp, bs_resp)
7080 let (payment_event, initial_revoke_and_ack) = if disconnect_count & !disconnect_flags > 0 {
7081 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
7082 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7084 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
7085 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7086 assert_eq!(reestablish_1.len(), 1);
7087 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
7088 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7089 assert_eq!(reestablish_2.len(), 1);
7091 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]).unwrap();
7092 check_added_monitors!(nodes[0], 0);
7093 let mut as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7094 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]).unwrap();
7095 check_added_monitors!(nodes[1], 0);
7096 let mut bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7098 assert!(as_resp.0.is_none());
7099 assert!(bs_resp.0.is_none());
7101 assert!(bs_resp.1.is_none());
7102 if (disconnect_count & 16) == 0 {
7103 assert!(bs_resp.2.is_none());
7105 assert!(as_resp.1.is_some());
7106 assert!(as_resp.2.is_some());
7107 assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
7109 assert!(bs_resp.2.as_ref().unwrap().update_add_htlcs.is_empty());
7110 assert!(bs_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
7111 assert!(bs_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
7112 assert!(bs_resp.2.as_ref().unwrap().update_fee.is_none());
7113 assert!(bs_resp.2.as_ref().unwrap().update_fulfill_htlcs == vec![bs_initial_fulfill]);
7114 assert!(bs_resp.2.as_ref().unwrap().commitment_signed == bs_initial_commitment_signed);
7116 assert!(as_resp.1.is_none());
7118 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_resp.2.as_ref().unwrap().update_fulfill_htlcs[0]).unwrap();
7119 let events_3 = nodes[0].node.get_and_clear_pending_events();
7120 assert_eq!(events_3.len(), 1);
7122 Event::PaymentSent { ref payment_preimage } => {
7123 assert_eq!(*payment_preimage, payment_preimage_1);
7125 _ => panic!("Unexpected event"),
7128 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_resp.2.as_ref().unwrap().commitment_signed).unwrap();
7129 let as_resp_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
7130 // No commitment_signed so get_event_msg's assert(len == 1) passes
7131 check_added_monitors!(nodes[0], 1);
7133 as_resp.1 = Some(as_resp_raa);
7137 if disconnect_count & !disconnect_flags > 1 {
7138 let (second_reestablish_1, second_reestablish_2, second_as_resp, second_bs_resp) = disconnect_reconnect_peers!();
7140 if (disconnect_count & 16) == 0 {
7141 assert!(reestablish_1 == second_reestablish_1);
7142 assert!(reestablish_2 == second_reestablish_2);
7144 assert!(as_resp == second_as_resp);
7145 assert!(bs_resp == second_bs_resp);
7148 (SendEvent::from_commitment_update(nodes[1].node.get_our_node_id(), as_resp.2.unwrap()), as_resp.1.unwrap())
7150 let mut events_4 = nodes[0].node.get_and_clear_pending_msg_events();
7151 assert_eq!(events_4.len(), 2);
7152 (SendEvent::from_event(events_4.remove(0)), match events_4[0] {
7153 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
7154 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
7157 _ => panic!("Unexpected event"),
7161 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
7163 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
7164 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg).unwrap();
7165 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
7166 // nodes[1] is awaiting an RAA from nodes[0] still so get_event_msg's assert(len == 1) passes
7167 check_added_monitors!(nodes[1], 1);
7169 if disconnect_count & !disconnect_flags > 2 {
7170 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
7172 assert!(as_resp.1.unwrap() == initial_revoke_and_ack);
7173 assert!(bs_resp.1.unwrap() == bs_revoke_and_ack);
7175 assert!(as_resp.2.is_none());
7176 assert!(bs_resp.2.is_none());
7179 let as_commitment_update;
7180 let bs_second_commitment_update;
7182 macro_rules! handle_bs_raa { () => {
7183 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
7184 as_commitment_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7185 assert!(as_commitment_update.update_add_htlcs.is_empty());
7186 assert!(as_commitment_update.update_fulfill_htlcs.is_empty());
7187 assert!(as_commitment_update.update_fail_htlcs.is_empty());
7188 assert!(as_commitment_update.update_fail_malformed_htlcs.is_empty());
7189 assert!(as_commitment_update.update_fee.is_none());
7190 check_added_monitors!(nodes[0], 1);
7193 macro_rules! handle_initial_raa { () => {
7194 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &initial_revoke_and_ack).unwrap();
7195 bs_second_commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7196 assert!(bs_second_commitment_update.update_add_htlcs.is_empty());
7197 assert!(bs_second_commitment_update.update_fulfill_htlcs.is_empty());
7198 assert!(bs_second_commitment_update.update_fail_htlcs.is_empty());
7199 assert!(bs_second_commitment_update.update_fail_malformed_htlcs.is_empty());
7200 assert!(bs_second_commitment_update.update_fee.is_none());
7201 check_added_monitors!(nodes[1], 1);
7204 if (disconnect_count & 8) == 0 {
7207 if disconnect_count & !disconnect_flags > 3 {
7208 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
7210 assert!(as_resp.1.unwrap() == initial_revoke_and_ack);
7211 assert!(bs_resp.1.is_none());
7213 assert!(as_resp.2.unwrap() == as_commitment_update);
7214 assert!(bs_resp.2.is_none());
7216 assert!(as_resp.3 == RAACommitmentOrder::RevokeAndACKFirst);
7219 handle_initial_raa!();
7221 if disconnect_count & !disconnect_flags > 4 {
7222 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
7224 assert!(as_resp.1.is_none());
7225 assert!(bs_resp.1.is_none());
7227 assert!(as_resp.2.unwrap() == as_commitment_update);
7228 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
7231 handle_initial_raa!();
7233 if disconnect_count & !disconnect_flags > 3 {
7234 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
7236 assert!(as_resp.1.is_none());
7237 assert!(bs_resp.1.unwrap() == bs_revoke_and_ack);
7239 assert!(as_resp.2.is_none());
7240 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
7242 assert!(bs_resp.3 == RAACommitmentOrder::RevokeAndACKFirst);
7247 if disconnect_count & !disconnect_flags > 4 {
7248 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
7250 assert!(as_resp.1.is_none());
7251 assert!(bs_resp.1.is_none());
7253 assert!(as_resp.2.unwrap() == as_commitment_update);
7254 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
7258 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_update.commitment_signed).unwrap();
7259 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
7260 // No commitment_signed so get_event_msg's assert(len == 1) passes
7261 check_added_monitors!(nodes[0], 1);
7263 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_update.commitment_signed).unwrap();
7264 let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
7265 // No commitment_signed so get_event_msg's assert(len == 1) passes
7266 check_added_monitors!(nodes[1], 1);
7268 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
7269 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
7270 check_added_monitors!(nodes[1], 1);
7272 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack).unwrap();
7273 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7274 check_added_monitors!(nodes[0], 1);
7276 expect_pending_htlcs_forwardable!(nodes[1]);
7278 let events_5 = nodes[1].node.get_and_clear_pending_events();
7279 assert_eq!(events_5.len(), 1);
7281 Event::PaymentReceived { ref payment_hash, amt } => {
7282 assert_eq!(payment_hash_2, *payment_hash);
7283 assert_eq!(amt, 1000000);
7285 _ => panic!("Unexpected event"),
7288 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
7292 fn test_monitor_temporary_update_fail_a() {
7293 do_test_monitor_temporary_update_fail(0);
7294 do_test_monitor_temporary_update_fail(1);
7295 do_test_monitor_temporary_update_fail(2);
7296 do_test_monitor_temporary_update_fail(3);
7297 do_test_monitor_temporary_update_fail(4);
7298 do_test_monitor_temporary_update_fail(5);
7302 fn test_monitor_temporary_update_fail_b() {
7303 do_test_monitor_temporary_update_fail(2 | 8);
7304 do_test_monitor_temporary_update_fail(3 | 8);
7305 do_test_monitor_temporary_update_fail(4 | 8);
7306 do_test_monitor_temporary_update_fail(5 | 8);
7310 fn test_monitor_temporary_update_fail_c() {
7311 do_test_monitor_temporary_update_fail(1 | 16);
7312 do_test_monitor_temporary_update_fail(2 | 16);
7313 do_test_monitor_temporary_update_fail(3 | 16);
7314 do_test_monitor_temporary_update_fail(2 | 8 | 16);
7315 do_test_monitor_temporary_update_fail(3 | 8 | 16);
7319 fn test_invalid_channel_announcement() {
7320 //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
7321 let secp_ctx = Secp256k1::new();
7322 let nodes = create_network(2);
7324 let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1]);
7326 let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
7327 let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
7328 let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
7329 let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
7331 let _ = nodes[0].router.handle_htlc_fail_channel_update(&msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id : as_chan.get_short_channel_id().unwrap(), is_permanent: false } );
7333 let as_bitcoin_key = PublicKey::from_secret_key(&secp_ctx, &as_chan.get_local_keys().funding_key);
7334 let bs_bitcoin_key = PublicKey::from_secret_key(&secp_ctx, &bs_chan.get_local_keys().funding_key);
7336 let as_network_key = nodes[0].node.get_our_node_id();
7337 let bs_network_key = nodes[1].node.get_our_node_id();
7339 let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
7341 let mut chan_announcement;
7343 macro_rules! dummy_unsigned_msg {
7345 msgs::UnsignedChannelAnnouncement {
7346 features: msgs::GlobalFeatures::new(),
7347 chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
7348 short_channel_id: as_chan.get_short_channel_id().unwrap(),
7349 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
7350 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
7351 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
7352 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
7353 excess_data: Vec::new(),
7358 macro_rules! sign_msg {
7359 ($unsigned_msg: expr) => {
7360 let msghash = Message::from_slice(&Sha256dHash::from_data(&$unsigned_msg.encode()[..])[..]).unwrap();
7361 let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_local_keys().funding_key);
7362 let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_local_keys().funding_key);
7363 let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].node.our_network_key);
7364 let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].node.our_network_key);
7365 chan_announcement = msgs::ChannelAnnouncement {
7366 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
7367 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
7368 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
7369 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
7370 contents: $unsigned_msg
7375 let unsigned_msg = dummy_unsigned_msg!();
7376 sign_msg!(unsigned_msg);
7377 assert_eq!(nodes[0].router.handle_channel_announcement(&chan_announcement).unwrap(), true);
7378 let _ = nodes[0].router.handle_htlc_fail_channel_update(&msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id : as_chan.get_short_channel_id().unwrap(), is_permanent: false } );
7380 // Configured with Network::Testnet
7381 let mut unsigned_msg = dummy_unsigned_msg!();
7382 unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.bitcoin_hash();
7383 sign_msg!(unsigned_msg);
7384 assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
7386 let mut unsigned_msg = dummy_unsigned_msg!();
7387 unsigned_msg.chain_hash = Sha256dHash::from_data(&[1,2,3,4,5,6,7,8,9]);
7388 sign_msg!(unsigned_msg);
7389 assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
7392 struct VecWriter(Vec<u8>);
7393 impl Writer for VecWriter {
7394 fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> {
7395 self.0.extend_from_slice(buf);
7398 fn size_hint(&mut self, size: usize) {
7399 self.0.reserve_exact(size);
7404 fn test_no_txn_manager_serialize_deserialize() {
7405 let mut nodes = create_network(2);
7407 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001);
7409 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7411 let nodes_0_serialized = nodes[0].node.encode();
7412 let mut chan_0_monitor_serialized = VecWriter(Vec::new());
7413 nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
7415 nodes[0].chan_monitor = Arc::new(test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), Arc::new(test_utils::TestLogger::new())));
7416 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
7417 let (_, chan_0_monitor) = <(Sha256dHash, ChannelMonitor)>::read(&mut chan_0_monitor_read, Arc::new(test_utils::TestLogger::new())).unwrap();
7418 assert!(chan_0_monitor_read.is_empty());
7420 let mut nodes_0_read = &nodes_0_serialized[..];
7421 let config = UserConfig::new();
7422 let keys_manager = Arc::new(keysinterface::KeysManager::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
7423 let (_, nodes_0_deserialized) = {
7424 let mut channel_monitors = HashMap::new();
7425 channel_monitors.insert(chan_0_monitor.get_funding_txo().unwrap(), &chan_0_monitor);
7426 <(Sha256dHash, ChannelManager)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
7427 default_config: config,
7429 fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
7430 monitor: nodes[0].chan_monitor.clone(),
7431 chain_monitor: nodes[0].chain_monitor.clone(),
7432 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
7433 logger: Arc::new(test_utils::TestLogger::new()),
7434 channel_monitors: &channel_monitors,
7437 assert!(nodes_0_read.is_empty());
7439 assert!(nodes[0].chan_monitor.add_update_monitor(chan_0_monitor.get_funding_txo().unwrap(), chan_0_monitor).is_ok());
7440 nodes[0].node = Arc::new(nodes_0_deserialized);
7441 let nodes_0_as_listener: Arc<ChainListener> = nodes[0].node.clone();
7442 nodes[0].chain_monitor.register_listener(Arc::downgrade(&nodes_0_as_listener));
7443 assert_eq!(nodes[0].node.list_channels().len(), 1);
7444 check_added_monitors!(nodes[0], 1);
7446 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
7447 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7448 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
7449 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7451 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]).unwrap();
7452 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
7453 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]).unwrap();
7454 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7456 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
7457 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
7458 for node in nodes.iter() {
7459 assert!(node.router.handle_channel_announcement(&announcement).unwrap());
7460 node.router.handle_channel_update(&as_update).unwrap();
7461 node.router.handle_channel_update(&bs_update).unwrap();
7464 send_payment(&nodes[0], &[&nodes[1]], 1000000);
7468 fn test_simple_manager_serialize_deserialize() {
7469 let mut nodes = create_network(2);
7470 create_announced_chan_between_nodes(&nodes, 0, 1);
7472 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7473 let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7475 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7477 let nodes_0_serialized = nodes[0].node.encode();
7478 let mut chan_0_monitor_serialized = VecWriter(Vec::new());
7479 nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
7481 nodes[0].chan_monitor = Arc::new(test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), Arc::new(test_utils::TestLogger::new())));
7482 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
7483 let (_, chan_0_monitor) = <(Sha256dHash, ChannelMonitor)>::read(&mut chan_0_monitor_read, Arc::new(test_utils::TestLogger::new())).unwrap();
7484 assert!(chan_0_monitor_read.is_empty());
7486 let mut nodes_0_read = &nodes_0_serialized[..];
7487 let keys_manager = Arc::new(keysinterface::KeysManager::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
7488 let (_, nodes_0_deserialized) = {
7489 let mut channel_monitors = HashMap::new();
7490 channel_monitors.insert(chan_0_monitor.get_funding_txo().unwrap(), &chan_0_monitor);
7491 <(Sha256dHash, ChannelManager)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
7492 default_config: UserConfig::new(),
7494 fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
7495 monitor: nodes[0].chan_monitor.clone(),
7496 chain_monitor: nodes[0].chain_monitor.clone(),
7497 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
7498 logger: Arc::new(test_utils::TestLogger::new()),
7499 channel_monitors: &channel_monitors,
7502 assert!(nodes_0_read.is_empty());
7504 assert!(nodes[0].chan_monitor.add_update_monitor(chan_0_monitor.get_funding_txo().unwrap(), chan_0_monitor).is_ok());
7505 nodes[0].node = Arc::new(nodes_0_deserialized);
7506 check_added_monitors!(nodes[0], 1);
7508 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
7510 fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
7511 claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage);
7515 fn test_manager_serialize_deserialize_inconsistent_monitor() {
7516 // Test deserializing a ChannelManager with a out-of-date ChannelMonitor
7517 let mut nodes = create_network(4);
7518 create_announced_chan_between_nodes(&nodes, 0, 1);
7519 create_announced_chan_between_nodes(&nodes, 2, 0);
7520 let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3);
7522 let (our_payment_preimage, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
7524 // Serialize the ChannelManager here, but the monitor we keep up-to-date
7525 let nodes_0_serialized = nodes[0].node.encode();
7527 route_payment(&nodes[0], &[&nodes[3]], 1000000);
7528 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7529 nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7530 nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7532 // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
7534 let mut node_0_monitors_serialized = Vec::new();
7535 for monitor in nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter() {
7536 let mut writer = VecWriter(Vec::new());
7537 monitor.1.write_for_disk(&mut writer).unwrap();
7538 node_0_monitors_serialized.push(writer.0);
7541 nodes[0].chan_monitor = Arc::new(test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), Arc::new(test_utils::TestLogger::new())));
7542 let mut node_0_monitors = Vec::new();
7543 for serialized in node_0_monitors_serialized.iter() {
7544 let mut read = &serialized[..];
7545 let (_, monitor) = <(Sha256dHash, ChannelMonitor)>::read(&mut read, Arc::new(test_utils::TestLogger::new())).unwrap();
7546 assert!(read.is_empty());
7547 node_0_monitors.push(monitor);
7550 let mut nodes_0_read = &nodes_0_serialized[..];
7551 let keys_manager = Arc::new(keysinterface::KeysManager::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
7552 let (_, nodes_0_deserialized) = <(Sha256dHash, ChannelManager)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
7553 default_config: UserConfig::new(),
7555 fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
7556 monitor: nodes[0].chan_monitor.clone(),
7557 chain_monitor: nodes[0].chain_monitor.clone(),
7558 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
7559 logger: Arc::new(test_utils::TestLogger::new()),
7560 channel_monitors: &node_0_monitors.iter().map(|monitor| { (monitor.get_funding_txo().unwrap(), monitor) }).collect(),
7562 assert!(nodes_0_read.is_empty());
7564 { // Channel close should result in a commitment tx and an HTLC tx
7565 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7566 assert_eq!(txn.len(), 2);
7567 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
7568 assert_eq!(txn[1].input[0].previous_output.txid, txn[0].txid());
7571 for monitor in node_0_monitors.drain(..) {
7572 assert!(nodes[0].chan_monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor).is_ok());
7573 check_added_monitors!(nodes[0], 1);
7575 nodes[0].node = Arc::new(nodes_0_deserialized);
7577 // nodes[1] and nodes[2] have no lost state with nodes[0]...
7578 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
7579 reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
7580 //... and we can even still claim the payment!
7581 claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage);
7583 nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id());
7584 let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
7585 nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id());
7586 if let Err(msgs::HandleError { action: Some(msgs::ErrorAction::SendErrorMessage { msg }), .. }) = nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish) {
7587 assert_eq!(msg.channel_id, channel_id);
7588 } else { panic!("Unexpected result"); }
7591 macro_rules! check_dynamic_output_p2wsh {
7594 let events = $node.chan_monitor.simple_monitor.get_and_clear_pending_events();
7595 let mut txn = Vec::new();
7596 for event in events {
7598 Event::SpendableOutputs { ref outputs } => {
7599 for outp in outputs {
7601 SpendableOutputDescriptor::DynamicOutputP2WSH { ref outpoint, ref key, ref witness_script, ref to_self_delay, ref output } => {
7603 previous_output: outpoint.clone(),
7604 script_sig: Script::new(),
7605 sequence: *to_self_delay as u32,
7606 witness: Vec::new(),
7609 script_pubkey: Builder::new().push_opcode(opcodes::All::OP_RETURN).into_script(),
7610 value: output.value,
7612 let mut spend_tx = Transaction {
7618 let secp_ctx = Secp256k1::new();
7619 let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], witness_script, output.value)[..]).unwrap();
7620 let local_delaysig = secp_ctx.sign(&sighash, key);
7621 spend_tx.input[0].witness.push(local_delaysig.serialize_der(&secp_ctx).to_vec());
7622 spend_tx.input[0].witness[0].push(SigHashType::All as u8);
7623 spend_tx.input[0].witness.push(vec!(0));
7624 spend_tx.input[0].witness.push(witness_script.clone().into_bytes());
7627 _ => panic!("Unexpected event"),
7631 _ => panic!("Unexpected event"),
7639 macro_rules! check_dynamic_output_p2wpkh {
7642 let events = $node.chan_monitor.simple_monitor.get_and_clear_pending_events();
7643 let mut txn = Vec::new();
7644 for event in events {
7646 Event::SpendableOutputs { ref outputs } => {
7647 for outp in outputs {
7649 SpendableOutputDescriptor::DynamicOutputP2WPKH { ref outpoint, ref key, ref output } => {
7651 previous_output: outpoint.clone(),
7652 script_sig: Script::new(),
7654 witness: Vec::new(),
7657 script_pubkey: Builder::new().push_opcode(opcodes::All::OP_RETURN).into_script(),
7658 value: output.value,
7660 let mut spend_tx = Transaction {
7666 let secp_ctx = Secp256k1::new();
7667 let remotepubkey = PublicKey::from_secret_key(&secp_ctx, &key);
7668 let witness_script = Address::p2pkh(&remotepubkey, Network::Testnet).script_pubkey();
7669 let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
7670 let remotesig = secp_ctx.sign(&sighash, key);
7671 spend_tx.input[0].witness.push(remotesig.serialize_der(&secp_ctx).to_vec());
7672 spend_tx.input[0].witness[0].push(SigHashType::All as u8);
7673 spend_tx.input[0].witness.push(remotepubkey.serialize().to_vec());
7676 _ => panic!("Unexpected event"),
7680 _ => panic!("Unexpected event"),
7688 macro_rules! check_static_output {
7689 ($event: expr, $node: expr, $event_idx: expr, $output_idx: expr, $der_idx: expr, $idx_node: expr) => {
7690 match $event[$event_idx] {
7691 Event::SpendableOutputs { ref outputs } => {
7692 match outputs[$output_idx] {
7693 SpendableOutputDescriptor::StaticOutput { ref outpoint, ref output } => {
7694 let secp_ctx = Secp256k1::new();
7696 previous_output: outpoint.clone(),
7697 script_sig: Script::new(),
7699 witness: Vec::new(),
7702 script_pubkey: Builder::new().push_opcode(opcodes::All::OP_RETURN).into_script(),
7703 value: output.value,
7705 let mut spend_tx = Transaction {
7709 output: vec![outp.clone()],
7712 match ExtendedPrivKey::new_master(&secp_ctx, Network::Testnet, &$node[$idx_node].node_seed) {
7714 match master_key.ckd_priv(&secp_ctx, ChildNumber::from_hardened_idx($der_idx)) {
7716 Err(_) => panic!("Your RNG is busted"),
7719 Err(_) => panic!("Your rng is busted"),
7722 let pubkey = ExtendedPubKey::from_private(&secp_ctx, &secret).public_key;
7723 let witness_script = Address::p2pkh(&pubkey, Network::Testnet).script_pubkey();
7724 let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
7725 let sig = secp_ctx.sign(&sighash, &secret.secret_key);
7726 spend_tx.input[0].witness.push(sig.serialize_der(&secp_ctx).to_vec());
7727 spend_tx.input[0].witness[0].push(SigHashType::All as u8);
7728 spend_tx.input[0].witness.push(pubkey.serialize().to_vec());
7731 _ => panic!("Unexpected event !"),
7734 _ => panic!("Unexpected event !"),
7740 fn test_claim_sizeable_push_msat() {
7741 // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
7742 let nodes = create_network(2);
7744 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000);
7745 nodes[1].node.force_close_channel(&chan.2);
7746 let events = nodes[1].node.get_and_clear_pending_msg_events();
7748 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
7749 _ => panic!("Unexpected event"),
7751 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7752 assert_eq!(node_txn.len(), 1);
7753 check_spends!(node_txn[0], chan.3.clone());
7754 assert_eq!(node_txn[0].output.len(), 2); // We can't force trimming of to_remote output as channel_reserve_satoshis block us to do so at channel opening
7756 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7757 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
7758 let spend_txn = check_dynamic_output_p2wsh!(nodes[1]);
7759 assert_eq!(spend_txn.len(), 1);
7760 check_spends!(spend_txn[0], node_txn[0].clone());
7764 fn test_claim_on_remote_sizeable_push_msat() {
7765 // Same test as precedent, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
7766 // to_remote output is encumbered by a P2WPKH
7768 let nodes = create_network(2);
7770 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000);
7771 nodes[0].node.force_close_channel(&chan.2);
7772 let events = nodes[0].node.get_and_clear_pending_msg_events();
7774 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
7775 _ => panic!("Unexpected event"),
7777 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7778 assert_eq!(node_txn.len(), 1);
7779 check_spends!(node_txn[0], chan.3.clone());
7780 assert_eq!(node_txn[0].output.len(), 2); // We can't force trimming of to_remote output as channel_reserve_satoshis block us to do so at channel opening
7782 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7783 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
7784 let events = nodes[1].node.get_and_clear_pending_msg_events();
7786 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
7787 _ => panic!("Unexpected event"),
7789 let spend_txn = check_dynamic_output_p2wpkh!(nodes[1]);
7790 assert_eq!(spend_txn.len(), 2);
7791 assert_eq!(spend_txn[0], spend_txn[1]);
7792 check_spends!(spend_txn[0], node_txn[0].clone());
7796 fn test_static_spendable_outputs_preimage_tx() {
7797 let nodes = create_network(2);
7799 // Create some initial channels
7800 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
7802 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7804 let commitment_tx = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
7805 assert_eq!(commitment_tx[0].input.len(), 1);
7806 assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
7808 // Settle A's commitment tx on B's chain
7809 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7810 assert!(nodes[1].node.claim_funds(payment_preimage));
7811 check_added_monitors!(nodes[1], 1);
7812 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone()] }, 1);
7813 let events = nodes[1].node.get_and_clear_pending_msg_events();
7815 MessageSendEvent::UpdateHTLCs { .. } => {},
7816 _ => panic!("Unexpected event"),
7819 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
7820 _ => panic!("Unexepected event"),
7823 // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
7824 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 1 (local commitment tx), ChannelMonitor: 2 (1 preimage tx) * 2 (block-rescan)
7825 check_spends!(node_txn[0], commitment_tx[0].clone());
7826 assert_eq!(node_txn[0], node_txn[2]);
7827 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 133);
7828 check_spends!(node_txn[1], chan_1.3.clone());
7830 let events = nodes[1].chan_monitor.simple_monitor.get_and_clear_pending_events();
7831 let spend_tx = check_static_output!(events, nodes, 0, 0, 1, 1);
7832 check_spends!(spend_tx, node_txn[0].clone());
7836 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
7837 let nodes = create_network(2);
7839 // Create some initial channels
7840 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
7842 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7843 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.iter().next().unwrap().1.last_local_commitment_txn.clone();
7844 assert_eq!(revoked_local_txn[0].input.len(), 1);
7845 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
7847 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
7849 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7850 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
7851 let events = nodes[1].node.get_and_clear_pending_msg_events();
7853 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
7854 _ => panic!("Unexpected event"),
7856 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7857 assert_eq!(node_txn.len(), 3);
7858 assert_eq!(node_txn.pop().unwrap(), node_txn[0]);
7859 assert_eq!(node_txn[0].input.len(), 2);
7860 check_spends!(node_txn[0], revoked_local_txn[0].clone());
7862 let events = nodes[1].chan_monitor.simple_monitor.get_and_clear_pending_events();
7863 let spend_tx = check_static_output!(events, nodes, 0, 0, 1, 1);
7864 check_spends!(spend_tx, node_txn[0].clone());
7868 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
7869 let nodes = create_network(2);
7871 // Create some initial channels
7872 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
7874 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7875 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
7876 assert_eq!(revoked_local_txn[0].input.len(), 1);
7877 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
7879 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
7881 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7882 // A will generate HTLC-Timeout from revoked commitment tx
7883 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
7884 let events = nodes[0].node.get_and_clear_pending_msg_events();
7886 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
7887 _ => panic!("Unexpected event"),
7889 let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7890 assert_eq!(revoked_htlc_txn.len(), 2);
7891 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7892 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), 133);
7893 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0].clone());
7895 // B will generate justice tx from A's revoked commitment/HTLC tx
7896 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
7897 let events = nodes[1].node.get_and_clear_pending_msg_events();
7899 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
7900 _ => panic!("Unexpected event"),
7903 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7904 assert_eq!(node_txn.len(), 4);
7905 assert_eq!(node_txn[3].input.len(), 1);
7906 check_spends!(node_txn[3], revoked_htlc_txn[0].clone());
7908 let events = nodes[1].chan_monitor.simple_monitor.get_and_clear_pending_events();
7909 // Check B's ChannelMonitor was able to generate the right spendable output descriptor
7910 let spend_tx = check_static_output!(events, nodes, 1, 1, 1, 1);
7911 check_spends!(spend_tx, node_txn[3].clone());
7915 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
7916 let nodes = create_network(2);
7918 // Create some initial channels
7919 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
7921 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7922 let revoked_local_txn = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
7923 assert_eq!(revoked_local_txn[0].input.len(), 1);
7924 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
7926 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
7928 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7929 // B will generate HTLC-Success from revoked commitment tx
7930 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
7931 let events = nodes[1].node.get_and_clear_pending_msg_events();
7933 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
7934 _ => panic!("Unexpected event"),
7936 let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7938 assert_eq!(revoked_htlc_txn.len(), 2);
7939 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7940 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), 138);
7941 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0].clone());
7943 // A will generate justice tx from B's revoked commitment/HTLC tx
7944 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
7945 let events = nodes[0].node.get_and_clear_pending_msg_events();
7947 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
7948 _ => panic!("Unexpected event"),
7951 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7952 assert_eq!(node_txn.len(), 4);
7953 assert_eq!(node_txn[3].input.len(), 1);
7954 check_spends!(node_txn[3], revoked_htlc_txn[0].clone());
7956 let events = nodes[0].chan_monitor.simple_monitor.get_and_clear_pending_events();
7957 // Check A's ChannelMonitor was able to generate the right spendable output descriptor
7958 let spend_tx = check_static_output!(events, nodes, 1, 2, 1, 0);
7959 check_spends!(spend_tx, node_txn[3].clone());
7963 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
7964 let nodes = create_network(2);
7966 // Create some initial channels
7967 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
7969 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
7970 let local_txn = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
7971 assert_eq!(local_txn[0].input.len(), 1);
7972 check_spends!(local_txn[0], chan_1.3.clone());
7974 // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
7975 nodes[1].node.claim_funds(payment_preimage);
7976 check_added_monitors!(nodes[1], 1);
7977 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7978 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![local_txn[0].clone()] }, 1);
7979 let events = nodes[1].node.get_and_clear_pending_msg_events();
7981 MessageSendEvent::UpdateHTLCs { .. } => {},
7982 _ => panic!("Unexpected event"),
7985 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
7986 _ => panic!("Unexepected event"),
7988 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7989 assert_eq!(node_txn[0].input.len(), 1);
7990 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 138);
7991 check_spends!(node_txn[0], local_txn[0].clone());
7993 // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
7994 let spend_txn = check_dynamic_output_p2wsh!(nodes[1]);
7995 assert_eq!(spend_txn.len(), 1);
7996 check_spends!(spend_txn[0], node_txn[0].clone());
8000 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
8001 let nodes = create_network(2);
8003 // Create some initial channels
8004 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
8006 route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
8007 let local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
8008 assert_eq!(local_txn[0].input.len(), 1);
8009 check_spends!(local_txn[0], chan_1.3.clone());
8011 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
8012 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8013 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![local_txn[0].clone()] }, 200);
8014 let events = nodes[0].node.get_and_clear_pending_msg_events();
8016 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
8017 _ => panic!("Unexepected event"),
8019 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8020 assert_eq!(node_txn[0].input.len(), 1);
8021 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 133);
8022 check_spends!(node_txn[0], local_txn[0].clone());
8024 // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
8025 let spend_txn = check_dynamic_output_p2wsh!(nodes[0]);
8026 assert_eq!(spend_txn.len(), 4);
8027 assert_eq!(spend_txn[0], spend_txn[2]);
8028 assert_eq!(spend_txn[1], spend_txn[3]);
8029 check_spends!(spend_txn[0], local_txn[0].clone());
8030 check_spends!(spend_txn[1], node_txn[0].clone());
8034 fn test_static_output_closing_tx() {
8035 let nodes = create_network(2);
8037 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
8039 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
8040 let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
8042 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8043 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![closing_tx.clone()] }, 1);
8044 let events = nodes[0].chan_monitor.simple_monitor.get_and_clear_pending_events();
8045 let spend_tx = check_static_output!(events, nodes, 0, 0, 2, 0);
8046 check_spends!(spend_tx, closing_tx.clone());
8048 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![closing_tx.clone()] }, 1);
8049 let events = nodes[1].chan_monitor.simple_monitor.get_and_clear_pending_events();
8050 let spend_tx = check_static_output!(events, nodes, 0, 0, 2, 1);
8051 check_spends!(spend_tx, closing_tx);