Skip to content

Commit 8ae3617

Browse files
TheBlueMattTheBlueMatt
committed
Move test_dup_htlc_onchain_fails_on_reload to payment_tests
test_dup_htlc_onchain_fails_on_reload is now more of a payment_test than a functional_test, testing for handling of pending payments.
1 parent 6cd3256 commit 8ae3617

File tree

2 files changed

+174
-172
lines changed

2 files changed

+174
-172
lines changed

‎lightning/src/ln/functional_tests.rs

Lines changed: 1 addition & 168 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
//! claim outputs on-chain.
1313
1414
use chain;
15-
use chain::{Confirm, Listen, Watch, ChannelMonitorUpdateErr};
15+
use chain::{Confirm, Listen, Watch};
1616
use chain::channelmonitor;
1717
use chain::channelmonitor::{ChannelMonitor, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY};
1818
use chain::transaction::OutPoint;
@@ -4100,173 +4100,6 @@ fn test_no_txn_manager_serialize_deserialize() {
41004100
send_payment(&nodes[0], &[&nodes[1]], 1000000);
41014101
}
41024102

4103-
fn do_test_dup_htlc_onchain_fails_on_reload(persist_manager_post_event: bool, confirm_commitment_tx: bool, payment_timeout: bool) {
4104-
// When a Channel is closed, any outbound HTLCs which were relayed through it are simply
4105-
// dropped when the Channel is. From there, the ChannelManager relies on the ChannelMonitor
4106-
// having a copy of the relevant fail-/claim-back data and processes the HTLC fail/claim when
4107-
// the ChannelMonitor tells it to.
4108-
//
4109-
// If, due to an on-chain event, an HTLC is failed/claimed, we should avoid providing the
4110-
// ChannelManager the HTLC event until after the monitor is re-persisted. This should prevent a
4111-
// duplicate HTLC fail/claim (e.g. via a PaymentPathFailed event).
4112-
let chanmon_cfgs = create_chanmon_cfgs(2);
4113-
let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4114-
let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4115-
let persister: test_utils::TestPersister;
4116-
let new_chain_monitor: test_utils::TestChainMonitor;
4117-
let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4118-
let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4119-
4120-
let (_, _, chan_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4121-
4122-
// Route a payment, but force-close the channel before the HTLC fulfill message arrives at
4123-
// nodes[0].
4124-
let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 10000000);
4125-
nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
4126-
check_closed_broadcast!(nodes[0], true);
4127-
check_added_monitors!(nodes[0], 1);
4128-
check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed);
4129-
4130-
nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4131-
nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4132-
4133-
// Connect blocks until the CLTV timeout is up so that we get an HTLC-Timeout transaction
4134-
connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
4135-
let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4136-
assert_eq!(node_txn.len(), 3);
4137-
assert_eq!(node_txn[0], node_txn[1]);
4138-
check_spends!(node_txn[1], funding_tx);
4139-
check_spends!(node_txn[2], node_txn[1]);
4140-
let timeout_txn = vec![node_txn[2].clone()];
4141-
4142-
assert!(nodes[1].node.claim_funds(payment_preimage));
4143-
check_added_monitors!(nodes[1], 1);
4144-
4145-
let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4146-
connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[1].clone()]});
4147-
check_closed_broadcast!(nodes[1], true);
4148-
check_added_monitors!(nodes[1], 1);
4149-
check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
4150-
let claim_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
4151-
4152-
header.prev_blockhash = nodes[0].best_block_hash();
4153-
connect_block(&nodes[0], &Block { header, txdata: vec![node_txn[1].clone()]});
4154-
4155-
if confirm_commitment_tx {
4156-
connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
4157-
}
4158-
4159-
header.prev_blockhash = nodes[0].best_block_hash();
4160-
let claim_block = Block { header, txdata: if payment_timeout { timeout_txn } else { claim_txn } };
4161-
4162-
if payment_timeout {
4163-
assert!(confirm_commitment_tx); // Otherwise we're spending below our CSV!
4164-
connect_block(&nodes[0], &claim_block);
4165-
connect_blocks(&nodes[0], ANTI_REORG_DELAY - 2);
4166-
}
4167-
4168-
// Now connect the HTLC claim transaction with the ChainMonitor-generated ChannelMonitor update
4169-
// returning TemporaryFailure. This should cause the claim event to never make its way to the
4170-
// ChannelManager.
4171-
chanmon_cfgs[0].persister.chain_sync_monitor_persistences.lock().unwrap().clear();
4172-
chanmon_cfgs[0].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
4173-
4174-
if payment_timeout {
4175-
connect_blocks(&nodes[0], 1);
4176-
} else {
4177-
connect_block(&nodes[0], &claim_block);
4178-
}
4179-
4180-
let funding_txo = OutPoint { txid: funding_tx.txid(), index: 0 };
4181-
let mon_updates: Vec<_> = chanmon_cfgs[0].persister.chain_sync_monitor_persistences.lock().unwrap()
4182-
.get_mut(&funding_txo).unwrap().drain().collect();
4183-
assert_eq!(mon_updates.len(), 1);
4184-
assert!(nodes[0].chain_monitor.release_pending_monitor_events().is_empty());
4185-
assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
4186-
4187-
// If we persist the ChannelManager here, we should get the PaymentSent event after
4188-
// deserialization.
4189-
let mut chan_manager_serialized = test_utils::TestVecWriter(Vec::new());
4190-
if !persist_manager_post_event {
4191-
nodes[0].node.write(&mut chan_manager_serialized).unwrap();
4192-
}
4193-
4194-
// Now persist the ChannelMonitor and inform the ChainMonitor that we're done, generating the
4195-
// payment sent event.
4196-
chanmon_cfgs[0].persister.set_update_ret(Ok(()));
4197-
let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4198-
get_monitor!(nodes[0], chan_id).write(&mut chan_0_monitor_serialized).unwrap();
4199-
nodes[0].chain_monitor.chain_monitor.channel_monitor_updated(funding_txo, mon_updates[0]).unwrap();
4200-
if payment_timeout {
4201-
expect_payment_failed!(nodes[0], payment_hash, true);
4202-
} else {
4203-
expect_payment_sent!(nodes[0], payment_preimage);
4204-
}
4205-
4206-
// If we persist the ChannelManager after we get the PaymentSent event, we shouldn't get it
4207-
// twice.
4208-
if persist_manager_post_event {
4209-
nodes[0].node.write(&mut chan_manager_serialized).unwrap();
4210-
}
4211-
4212-
// Now reload nodes[0]...
4213-
persister = test_utils::TestPersister::new();
4214-
let keys_manager = &chanmon_cfgs[0].keys_manager;
4215-
new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), nodes[0].logger, node_cfgs[0].fee_estimator, &persister, keys_manager);
4216-
nodes[0].chain_monitor = &new_chain_monitor;
4217-
let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4218-
let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
4219-
&mut chan_0_monitor_read, keys_manager).unwrap();
4220-
assert!(chan_0_monitor_read.is_empty());
4221-
4222-
let (_, nodes_0_deserialized_tmp) = {
4223-
let mut channel_monitors = HashMap::new();
4224-
channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4225-
<(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>
4226-
::read(&mut io::Cursor::new(&chan_manager_serialized.0[..]), ChannelManagerReadArgs {
4227-
default_config: Default::default(),
4228-
keys_manager,
4229-
fee_estimator: node_cfgs[0].fee_estimator,
4230-
chain_monitor: nodes[0].chain_monitor,
4231-
tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4232-
logger: nodes[0].logger,
4233-
channel_monitors,
4234-
}).unwrap()
4235-
};
4236-
nodes_0_deserialized = nodes_0_deserialized_tmp;
4237-
4238-
assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4239-
check_added_monitors!(nodes[0], 1);
4240-
nodes[0].node = &nodes_0_deserialized;
4241-
4242-
if persist_manager_post_event {
4243-
assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
4244-
} else {
4245-
if payment_timeout {
4246-
expect_payment_failed!(nodes[0], payment_hash, true);
4247-
} else {
4248-
expect_payment_sent!(nodes[0], payment_preimage);
4249-
}
4250-
}
4251-
4252-
// Note that if we re-connect the block which exposed nodes[0] to the payment preimage (but
4253-
// which the current ChannelMonitor has not seen), the ChannelManager's de-duplication of
4254-
// payment events should kick in, leaving us with no pending events here.
4255-
let height = nodes[0].blocks.lock().unwrap().len() as u32 - 1;
4256-
nodes[0].chain_monitor.chain_monitor.block_connected(&claim_block, height);
4257-
assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
4258-
}
4259-
4260-
#[test]
4261-
fn test_dup_htlc_onchain_fails_on_reload() {
4262-
do_test_dup_htlc_onchain_fails_on_reload(true, true, true);
4263-
do_test_dup_htlc_onchain_fails_on_reload(true, true, false);
4264-
do_test_dup_htlc_onchain_fails_on_reload(true, false, false);
4265-
do_test_dup_htlc_onchain_fails_on_reload(false, true, true);
4266-
do_test_dup_htlc_onchain_fails_on_reload(false, true, false);
4267-
do_test_dup_htlc_onchain_fails_on_reload(false, false, false);
4268-
}
4269-
42704103
#[test]
42714104
fn test_manager_serialize_deserialize_events() {
42724105
// This test makes sure the events field in ChannelManager survives de/serialization

‎lightning/src/ln/payment_tests.rs

Lines changed: 173 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,11 @@
1111
//! serialization ordering between ChannelManager/ChannelMonitors and ensuring we can still retry
1212
//! payments thereafter.
1313
14-
use chain::{Confirm, Watch};
15-
use chain::channelmonitor::ChannelMonitor;
14+
use chain::{ChannelMonitorUpdateErr, Confirm, Listen, Watch};
15+
use chain::channelmonitor::{ANTI_REORG_DELAY, ChannelMonitor, LATENCY_GRACE_PERIOD_BLOCKS};
16+
use chain::transaction::OutPoint;
1617
use ln::{PaymentPreimage, PaymentHash};
17-
use ln::channelmanager::{ChannelManager, ChannelManagerReadArgs, PaymentId, PaymentSendFailure};
18+
use ln::channelmanager::{BREAKDOWN_TIMEOUT, ChannelManager, ChannelManagerReadArgs, PaymentId, PaymentSendFailure};
1819
use ln::features::InitFeatures;
1920
use ln::msgs;
2021
use ln::msgs::{ChannelMessageHandler, ErrorAction};
@@ -23,10 +24,11 @@ use util::test_utils;
2324
use util::errors::APIError;
2425
use util::enforcing_trait_impls::EnforcingSigner;
2526
use util::ser::{ReadableArgs, Writeable};
27+
use io;
2628

2729
use bitcoin::hashes::sha256::Hash as Sha256;
2830
use bitcoin::hashes::Hash;
29-
use bitcoin::BlockHash;
31+
use bitcoin::{Block, BlockHeader, BlockHash};
3032

3133
use prelude::*;
3234

@@ -454,3 +456,170 @@ fn retry_with_no_persist() {
454456
do_retry_with_no_persist(true);
455457
do_retry_with_no_persist(false);
456458
}
459+
460+
fn do_test_dup_htlc_onchain_fails_on_reload(persist_manager_post_event: bool, confirm_commitment_tx: bool, payment_timeout: bool) {
461+
// When a Channel is closed, any outbound HTLCs which were relayed through it are simply
462+
// dropped when the Channel is. From there, the ChannelManager relies on the ChannelMonitor
463+
// having a copy of the relevant fail-/claim-back data and processes the HTLC fail/claim when
464+
// the ChannelMonitor tells it to.
465+
//
466+
// If, due to an on-chain event, an HTLC is failed/claimed, we should avoid providing the
467+
// ChannelManager the HTLC event until after the monitor is re-persisted. This should prevent a
468+
// duplicate HTLC fail/claim (e.g. via a PaymentPathFailed event).
469+
let chanmon_cfgs = create_chanmon_cfgs(2);
470+
let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
471+
let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
472+
let persister: test_utils::TestPersister;
473+
let new_chain_monitor: test_utils::TestChainMonitor;
474+
let nodes_0_deserialized: ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
475+
let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
476+
477+
let (_, _, chan_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
478+
479+
// Route a payment, but force-close the channel before the HTLC fulfill message arrives at
480+
// nodes[0].
481+
let (payment_preimage, payment_hash, _) = route_payment(&nodes[0], &[&nodes[1]], 10000000);
482+
nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
483+
check_closed_broadcast!(nodes[0], true);
484+
check_added_monitors!(nodes[0], 1);
485+
check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed);
486+
487+
nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
488+
nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
489+
490+
// Connect blocks until the CLTV timeout is up so that we get an HTLC-Timeout transaction
491+
connect_blocks(&nodes[0], TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + 1);
492+
let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
493+
assert_eq!(node_txn.len(), 3);
494+
assert_eq!(node_txn[0], node_txn[1]);
495+
check_spends!(node_txn[1], funding_tx);
496+
check_spends!(node_txn[2], node_txn[1]);
497+
let timeout_txn = vec![node_txn[2].clone()];
498+
499+
assert!(nodes[1].node.claim_funds(payment_preimage));
500+
check_added_monitors!(nodes[1], 1);
501+
502+
let mut header = BlockHeader { version: 0x20000000, prev_blockhash: nodes[1].best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
503+
connect_block(&nodes[1], &Block { header, txdata: vec![node_txn[1].clone()]});
504+
check_closed_broadcast!(nodes[1], true);
505+
check_added_monitors!(nodes[1], 1);
506+
check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed);
507+
let claim_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0);
508+
509+
header.prev_blockhash = nodes[0].best_block_hash();
510+
connect_block(&nodes[0], &Block { header, txdata: vec![node_txn[1].clone()]});
511+
512+
if confirm_commitment_tx {
513+
connect_blocks(&nodes[0], BREAKDOWN_TIMEOUT as u32 - 1);
514+
}
515+
516+
header.prev_blockhash = nodes[0].best_block_hash();
517+
let claim_block = Block { header, txdata: if payment_timeout { timeout_txn } else { claim_txn } };
518+
519+
if payment_timeout {
520+
assert!(confirm_commitment_tx); // Otherwise we're spending below our CSV!
521+
connect_block(&nodes[0], &claim_block);
522+
connect_blocks(&nodes[0], ANTI_REORG_DELAY - 2);
523+
}
524+
525+
// Now connect the HTLC claim transaction with the ChainMonitor-generated ChannelMonitor update
526+
// returning TemporaryFailure. This should cause the claim event to never make its way to the
527+
// ChannelManager.
528+
chanmon_cfgs[0].persister.chain_sync_monitor_persistences.lock().unwrap().clear();
529+
chanmon_cfgs[0].persister.set_update_ret(Err(ChannelMonitorUpdateErr::TemporaryFailure));
530+
531+
if payment_timeout {
532+
connect_blocks(&nodes[0], 1);
533+
} else {
534+
connect_block(&nodes[0], &claim_block);
535+
}
536+
537+
let funding_txo = OutPoint { txid: funding_tx.txid(), index: 0 };
538+
let mon_updates: Vec<_> = chanmon_cfgs[0].persister.chain_sync_monitor_persistences.lock().unwrap()
539+
.get_mut(&funding_txo).unwrap().drain().collect();
540+
assert_eq!(mon_updates.len(), 1);
541+
assert!(nodes[0].chain_monitor.release_pending_monitor_events().is_empty());
542+
assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
543+
544+
// If we persist the ChannelManager here, we should get the PaymentSent event after
545+
// deserialization.
546+
let mut chan_manager_serialized = test_utils::TestVecWriter(Vec::new());
547+
if !persist_manager_post_event {
548+
nodes[0].node.write(&mut chan_manager_serialized).unwrap();
549+
}
550+
551+
// Now persist the ChannelMonitor and inform the ChainMonitor that we're done, generating the
552+
// payment sent event.
553+
chanmon_cfgs[0].persister.set_update_ret(Ok(()));
554+
let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
555+
get_monitor!(nodes[0], chan_id).write(&mut chan_0_monitor_serialized).unwrap();
556+
nodes[0].chain_monitor.chain_monitor.channel_monitor_updated(funding_txo, mon_updates[0]).unwrap();
557+
if payment_timeout {
558+
expect_payment_failed!(nodes[0], payment_hash, true);
559+
} else {
560+
expect_payment_sent!(nodes[0], payment_preimage);
561+
}
562+
563+
// If we persist the ChannelManager after we get the PaymentSent event, we shouldn't get it
564+
// twice.
565+
if persist_manager_post_event {
566+
nodes[0].node.write(&mut chan_manager_serialized).unwrap();
567+
}
568+
569+
// Now reload nodes[0]...
570+
persister = test_utils::TestPersister::new();
571+
let keys_manager = &chanmon_cfgs[0].keys_manager;
572+
new_chain_monitor = test_utils::TestChainMonitor::new(Some(nodes[0].chain_source), nodes[0].tx_broadcaster.clone(), nodes[0].logger, node_cfgs[0].fee_estimator, &persister, keys_manager);
573+
nodes[0].chain_monitor = &new_chain_monitor;
574+
let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
575+
let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
576+
&mut chan_0_monitor_read, keys_manager).unwrap();
577+
assert!(chan_0_monitor_read.is_empty());
578+
579+
let (_, nodes_0_deserialized_tmp) = {
580+
let mut channel_monitors = HashMap::new();
581+
channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
582+
<(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>
583+
::read(&mut io::Cursor::new(&chan_manager_serialized.0[..]), ChannelManagerReadArgs {
584+
default_config: Default::default(),
585+
keys_manager,
586+
fee_estimator: node_cfgs[0].fee_estimator,
587+
chain_monitor: nodes[0].chain_monitor,
588+
tx_broadcaster: nodes[0].tx_broadcaster.clone(),
589+
logger: nodes[0].logger,
590+
channel_monitors,
591+
}).unwrap()
592+
};
593+
nodes_0_deserialized = nodes_0_deserialized_tmp;
594+
595+
assert!(nodes[0].chain_monitor.watch_channel(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
596+
check_added_monitors!(nodes[0], 1);
597+
nodes[0].node = &nodes_0_deserialized;
598+
599+
if persist_manager_post_event {
600+
assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
601+
} else {
602+
if payment_timeout {
603+
expect_payment_failed!(nodes[0], payment_hash, true);
604+
} else {
605+
expect_payment_sent!(nodes[0], payment_preimage);
606+
}
607+
}
608+
609+
// Note that if we re-connect the block which exposed nodes[0] to the payment preimage (but
610+
// which the current ChannelMonitor has not seen), the ChannelManager's de-duplication of
611+
// payment events should kick in, leaving us with no pending events here.
612+
let height = nodes[0].blocks.lock().unwrap().len() as u32 - 1;
613+
nodes[0].chain_monitor.chain_monitor.block_connected(&claim_block, height);
614+
assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
615+
}
616+
617+
#[test]
618+
fn test_dup_htlc_onchain_fails_on_reload() {
619+
do_test_dup_htlc_onchain_fails_on_reload(true, true, true);
620+
do_test_dup_htlc_onchain_fails_on_reload(true, true, false);
621+
do_test_dup_htlc_onchain_fails_on_reload(true, false, false);
622+
do_test_dup_htlc_onchain_fails_on_reload(false, true, true);
623+
do_test_dup_htlc_onchain_fails_on_reload(false, true, false);
624+
do_test_dup_htlc_onchain_fails_on_reload(false, false, false);
625+
}

0 commit comments

Comments
 (0)