Skip to content

Commit 1cc210d

Browse files
TheBlueMattTheBlueMatt
committed
f rename fn
1 parent 5d98e82 commit 1cc210d

File tree

6 files changed

+34
-32
lines changed

6 files changed

+34
-32
lines changed

‎lightning/src/chain/chainmonitor.rs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,9 @@ where C::Target: chain::Filter,
237237

238238
/// Gets the [`LockedChannelMonitor`] for a given funding outpoint, returning an `Err` if no
239239
/// such [`ChannelMonitor`] is currently being monitored for.
240-
pub fn get_current_monitor(&self, funding_txo: OutPoint) -> Result<LockedChannelMonitor<'_, ChannelSigner>, ()> {
240+
///
241+
/// Note that the result holds a mutex our monitor state, and should not be held indefinitely.
242+
pub fn get_monitor(&self, funding_txo: OutPoint) -> Result<LockedChannelMonitor<'_, ChannelSigner>, ()> {
241243
let lock = self.monitors.read().unwrap();
242244
if lock.get(&funding_txo).is_some() {
243245
Ok(LockedChannelMonitor { lock, funding_txo })

‎lightning/src/ln/chanmon_update_fail_tests.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ fn test_monitor_and_persister_update_fail() {
118118
blocks: Arc::new(Mutex::new(vec![(genesis_block(Network::Testnet).header, 200); 200])),
119119
};
120120
let chain_mon = {
121-
let monitor = nodes[0].chain_monitor.chain_monitor.get_current_monitor(outpoint).unwrap();
121+
let monitor = nodes[0].chain_monitor.chain_monitor.get_monitor(outpoint).unwrap();
122122
let mut w = test_utils::TestVecWriter(Vec::new());
123123
monitor.write(&mut w).unwrap();
124124
let new_monitor = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(

‎lightning/src/ln/functional_test_utils.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -276,7 +276,7 @@ impl<'a, 'b, 'c> Drop for Node<'a, 'b, 'c> {
276276
{
277277
for outpoint in self.chain_monitor.chain_monitor.list_current_monitors() {
278278
let mut w = test_utils::TestVecWriter(Vec::new());
279-
self.chain_monitor.chain_monitor.get_current_monitor(outpoint).unwrap().write(&mut w).unwrap();
279+
self.chain_monitor.chain_monitor.get_monitor(outpoint).unwrap().write(&mut w).unwrap();
280280
let (_, deserialized_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
281281
&mut io::Cursor::new(&w.0), self.keys_manager).unwrap();
282282
deserialized_monitors.push(deserialized_monitor);
@@ -445,7 +445,7 @@ macro_rules! get_monitor {
445445
let mut monitor = None;
446446
// Assume funding vout is either 0 or 1 blindly
447447
for index in 0..2 {
448-
if let Ok(mon) = $node.chain_monitor.chain_monitor.get_current_monitor(
448+
if let Ok(mon) = $node.chain_monitor.chain_monitor.get_monitor(
449449
$crate::chain::transaction::OutPoint {
450450
txid: bitcoin::Txid::from_slice(&$channel_id[..]).unwrap(), index
451451
})

‎lightning/src/ln/functional_tests.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8163,7 +8163,7 @@ fn test_bump_txn_sanitize_tracking_maps() {
81638163
connect_block(&nodes[0], &Block { header: header_130, txdata: penalty_txn });
81648164
connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
81658165
{
8166-
let monitor = nodes[0].chain_monitor.chain_monitor.get_current_monitor(OutPoint { txid: chan.3.txid(), index: 0 }).unwrap();
8166+
let monitor = nodes[0].chain_monitor.chain_monitor.get_monitor(OutPoint { txid: chan.3.txid(), index: 0 }).unwrap();
81678167
assert!(monitor.inner.lock().unwrap().onchain_tx_handler.pending_claim_requests.is_empty());
81688168
assert!(monitor.inner.lock().unwrap().onchain_tx_handler.claimable_outpoints.is_empty());
81698169
}
@@ -8441,7 +8441,7 @@ fn test_update_err_monitor_lockdown() {
84418441
let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
84428442
let persister = test_utils::TestPersister::new();
84438443
let watchtower = {
8444-
let monitor = nodes[0].chain_monitor.chain_monitor.get_current_monitor(outpoint).unwrap();
8444+
let monitor = nodes[0].chain_monitor.chain_monitor.get_monitor(outpoint).unwrap();
84458445
let mut w = test_utils::TestVecWriter(Vec::new());
84468446
monitor.write(&mut w).unwrap();
84478447
let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
@@ -8502,7 +8502,7 @@ fn test_concurrent_monitor_claim() {
85028502
let logger = test_utils::TestLogger::with_id(format!("node {}", "Alice"));
85038503
let persister = test_utils::TestPersister::new();
85048504
let watchtower_alice = {
8505-
let monitor = nodes[0].chain_monitor.chain_monitor.get_current_monitor(outpoint).unwrap();
8505+
let monitor = nodes[0].chain_monitor.chain_monitor.get_monitor(outpoint).unwrap();
85068506
let mut w = test_utils::TestVecWriter(Vec::new());
85078507
monitor.write(&mut w).unwrap();
85088508
let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
@@ -8530,7 +8530,7 @@ fn test_concurrent_monitor_claim() {
85308530
let logger = test_utils::TestLogger::with_id(format!("node {}", "Bob"));
85318531
let persister = test_utils::TestPersister::new();
85328532
let watchtower_bob = {
8533-
let monitor = nodes[0].chain_monitor.chain_monitor.get_current_monitor(outpoint).unwrap();
8533+
let monitor = nodes[0].chain_monitor.chain_monitor.get_monitor(outpoint).unwrap();
85348534
let mut w = test_utils::TestVecWriter(Vec::new());
85358535
monitor.write(&mut w).unwrap();
85368536
let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(

‎lightning/src/ln/monitor_tests.rs

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -108,9 +108,9 @@ fn chanmon_claim_value_coop_close() {
108108
assert_eq!(vec![Balance::ClaimableOnChannelClose {
109109
claimable_amount_satoshis: 1_000_000 - 1_000 - chan_feerate * channel::COMMITMENT_TX_BASE_WEIGHT / 1000
110110
}],
111-
nodes[0].chain_monitor.chain_monitor.get_current_monitor(funding_outpoint).unwrap().get_claimable_balances());
111+
nodes[0].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances());
112112
assert_eq!(vec![Balance::ClaimableOnChannelClose { claimable_amount_satoshis: 1_000, }],
113-
nodes[1].chain_monitor.chain_monitor.get_current_monitor(funding_outpoint).unwrap().get_claimable_balances());
113+
nodes[1].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances());
114114

115115
nodes[0].node.close_channel(&chan_id).unwrap();
116116
let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
@@ -144,20 +144,20 @@ fn chanmon_claim_value_coop_close() {
144144
claimable_amount_satoshis: 1_000_000 - 1_000 - chan_feerate * channel::COMMITMENT_TX_BASE_WEIGHT / 1000,
145145
confirmation_height: nodes[0].best_block_info().1 + ANTI_REORG_DELAY - 1,
146146
}],
147-
nodes[0].chain_monitor.chain_monitor.get_current_monitor(funding_outpoint).unwrap().get_claimable_balances());
147+
nodes[0].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances());
148148
assert_eq!(vec![Balance::ClaimableAwaitingConfirmations {
149149
claimable_amount_satoshis: 1000,
150150
confirmation_height: nodes[1].best_block_info().1 + ANTI_REORG_DELAY - 1,
151151
}],
152-
nodes[1].chain_monitor.chain_monitor.get_current_monitor(funding_outpoint).unwrap().get_claimable_balances());
152+
nodes[1].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances());
153153

154154
connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
155155
connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
156156

157157
assert_eq!(Vec::<Balance>::new(),
158-
nodes[0].chain_monitor.chain_monitor.get_current_monitor(funding_outpoint).unwrap().get_claimable_balances());
158+
nodes[0].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances());
159159
assert_eq!(Vec::<Balance>::new(),
160-
nodes[1].chain_monitor.chain_monitor.get_current_monitor(funding_outpoint).unwrap().get_claimable_balances());
160+
nodes[1].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances());
161161

162162
let mut node_a_spendable = nodes[0].chain_monitor.chain_monitor.get_and_clear_pending_events();
163163
assert_eq!(node_a_spendable.len(), 1);
@@ -231,11 +231,11 @@ fn do_test_claim_value_force_close(prev_commitment_tx: bool) {
231231
claimable_amount_satoshis: 4_000,
232232
claimable_height: htlc_cltv_timeout,
233233
}]),
234-
sorted_vec(nodes[0].chain_monitor.chain_monitor.get_current_monitor(funding_outpoint).unwrap().get_claimable_balances()));
234+
sorted_vec(nodes[0].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances()));
235235
assert_eq!(vec![Balance::ClaimableOnChannelClose {
236236
claimable_amount_satoshis: 1_000,
237237
}],
238-
nodes[1].chain_monitor.chain_monitor.get_current_monitor(funding_outpoint).unwrap().get_claimable_balances());
238+
nodes[1].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances());
239239

240240
nodes[1].node.claim_funds(payment_preimage);
241241
check_added_monitors!(nodes[1], 1);
@@ -285,11 +285,11 @@ fn do_test_claim_value_force_close(prev_commitment_tx: bool) {
285285
});
286286
}
287287
assert_eq!(sorted_vec(a_expected_balances),
288-
sorted_vec(nodes[0].chain_monitor.chain_monitor.get_current_monitor(funding_outpoint).unwrap().get_claimable_balances()));
288+
sorted_vec(nodes[0].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances()));
289289
assert_eq!(vec![Balance::ClaimableOnChannelClose {
290290
claimable_amount_satoshis: 1_000 + 3_000 + 4_000,
291291
}],
292-
nodes[1].chain_monitor.chain_monitor.get_current_monitor(funding_outpoint).unwrap().get_claimable_balances());
292+
nodes[1].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances());
293293

294294
// Broadcast the closing transaction (which has both pending HTLCs in it) and get B's
295295
// broadcasted HTLC claim transaction with preimage.
@@ -343,7 +343,7 @@ fn do_test_claim_value_force_close(prev_commitment_tx: bool) {
343343
claimable_amount_satoshis: 4_000,
344344
claimable_height: htlc_cltv_timeout,
345345
}]),
346-
sorted_vec(nodes[0].chain_monitor.chain_monitor.get_current_monitor(funding_outpoint).unwrap().get_claimable_balances()));
346+
sorted_vec(nodes[0].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances()));
347347
// The main non-HTLC balance is just awaiting confirmations, but the claimable height is the
348348
// CSV delay, not ANTI_REORG_DELAY.
349349
assert_eq!(sorted_vec(vec![Balance::ClaimableAwaitingConfirmations {
@@ -359,7 +359,7 @@ fn do_test_claim_value_force_close(prev_commitment_tx: bool) {
359359
claimable_amount_satoshis: 4_000,
360360
timeout_height: htlc_cltv_timeout,
361361
}]),
362-
sorted_vec(nodes[1].chain_monitor.chain_monitor.get_current_monitor(funding_outpoint).unwrap().get_claimable_balances()));
362+
sorted_vec(nodes[1].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances()));
363363

364364
connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
365365
expect_payment_failed!(nodes[0], dust_payment_hash, true);
@@ -374,7 +374,7 @@ fn do_test_claim_value_force_close(prev_commitment_tx: bool) {
374374
claimable_amount_satoshis: 4_000,
375375
claimable_height: htlc_cltv_timeout,
376376
}]),
377-
sorted_vec(nodes[0].chain_monitor.chain_monitor.get_current_monitor(funding_outpoint).unwrap().get_claimable_balances()));
377+
sorted_vec(nodes[0].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances()));
378378
assert_eq!(sorted_vec(vec![Balance::ClaimableAwaitingConfirmations {
379379
claimable_amount_satoshis: 1_000,
380380
confirmation_height: node_b_commitment_claimable,
@@ -385,7 +385,7 @@ fn do_test_claim_value_force_close(prev_commitment_tx: bool) {
385385
claimable_amount_satoshis: 4_000,
386386
timeout_height: htlc_cltv_timeout,
387387
}]),
388-
sorted_vec(nodes[1].chain_monitor.chain_monitor.get_current_monitor(funding_outpoint).unwrap().get_claimable_balances()));
388+
sorted_vec(nodes[1].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances()));
389389

390390
let mut node_a_spendable = nodes[0].chain_monitor.chain_monitor.get_and_clear_pending_events();
391391
assert_eq!(node_a_spendable.len(), 1);
@@ -411,13 +411,13 @@ fn do_test_claim_value_force_close(prev_commitment_tx: bool) {
411411
claimable_amount_satoshis: 4_000,
412412
claimable_height: htlc_cltv_timeout,
413413
}]),
414-
sorted_vec(nodes[0].chain_monitor.chain_monitor.get_current_monitor(funding_outpoint).unwrap().get_claimable_balances()));
414+
sorted_vec(nodes[0].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances()));
415415
connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
416416
assert_eq!(vec![Balance::MaybeClaimableHTLCAwaitingTimeout {
417417
claimable_amount_satoshis: 4_000,
418418
claimable_height: htlc_cltv_timeout,
419419
}],
420-
nodes[0].chain_monitor.chain_monitor.get_current_monitor(funding_outpoint).unwrap().get_claimable_balances());
420+
nodes[0].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances());
421421

422422
// When the HTLC timeout output is spendable in the next block, A should broadcast it
423423
connect_blocks(&nodes[0], htlc_cltv_timeout - nodes[0].best_block_info().1 - 1);
@@ -442,12 +442,12 @@ fn do_test_claim_value_force_close(prev_commitment_tx: bool) {
442442
claimable_amount_satoshis: 4_000,
443443
confirmation_height: nodes[0].best_block_info().1 + ANTI_REORG_DELAY - 1,
444444
}],
445-
nodes[0].chain_monitor.chain_monitor.get_current_monitor(funding_outpoint).unwrap().get_claimable_balances());
445+
nodes[0].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances());
446446
// After ANTI_REORG_DELAY, A will generate a SpendableOutputs event and drop the claimable
447447
// balance entry.
448448
connect_blocks(&nodes[0], ANTI_REORG_DELAY - 1);
449449
assert_eq!(Vec::<Balance>::new(),
450-
nodes[0].chain_monitor.chain_monitor.get_current_monitor(funding_outpoint).unwrap().get_claimable_balances());
450+
nodes[0].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances());
451451
expect_payment_failed!(nodes[0], timeout_payment_hash, true);
452452

453453
let mut node_a_spendable = nodes[0].chain_monitor.chain_monitor.get_and_clear_pending_events();
@@ -475,7 +475,7 @@ fn do_test_claim_value_force_close(prev_commitment_tx: bool) {
475475
claimable_amount_satoshis: 4_000,
476476
timeout_height: htlc_cltv_timeout,
477477
}]),
478-
sorted_vec(nodes[1].chain_monitor.chain_monitor.get_current_monitor(funding_outpoint).unwrap().get_claimable_balances()));
478+
sorted_vec(nodes[1].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances()));
479479

480480
// After reaching the commitment output CSV, we'll get a SpendableOutputs event for it and have
481481
// only the HTLCs claimable on node B.
@@ -497,7 +497,7 @@ fn do_test_claim_value_force_close(prev_commitment_tx: bool) {
497497
claimable_amount_satoshis: 4_000,
498498
timeout_height: htlc_cltv_timeout,
499499
}]),
500-
sorted_vec(nodes[1].chain_monitor.chain_monitor.get_current_monitor(funding_outpoint).unwrap().get_claimable_balances()));
500+
sorted_vec(nodes[1].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances()));
501501

502502
// After reaching the claimed HTLC output CSV, we'll get a SpendableOutptus event for it and
503503
// have only one HTLC output left spendable.
@@ -516,7 +516,7 @@ fn do_test_claim_value_force_close(prev_commitment_tx: bool) {
516516
claimable_amount_satoshis: 4_000,
517517
timeout_height: htlc_cltv_timeout,
518518
}],
519-
nodes[1].chain_monitor.chain_monitor.get_current_monitor(funding_outpoint).unwrap().get_claimable_balances());
519+
nodes[1].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances());
520520

521521
// Finally, mine the HTLC timeout transaction that A broadcasted (even though B should be able
522522
// to claim this HTLC with the preimage it knows!). It will remain listed as a claimable HTLC
@@ -526,10 +526,10 @@ fn do_test_claim_value_force_close(prev_commitment_tx: bool) {
526526
claimable_amount_satoshis: 4_000,
527527
timeout_height: htlc_cltv_timeout,
528528
}],
529-
nodes[1].chain_monitor.chain_monitor.get_current_monitor(funding_outpoint).unwrap().get_claimable_balances());
529+
nodes[1].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances());
530530
connect_blocks(&nodes[1], ANTI_REORG_DELAY - 1);
531531
assert_eq!(Vec::<Balance>::new(),
532-
nodes[1].chain_monitor.chain_monitor.get_current_monitor(funding_outpoint).unwrap().get_claimable_balances());
532+
nodes[1].chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances());
533533
}
534534

535535
#[test]

‎lightning/src/util/test_utils.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ impl<'a> chain::Watch<EnforcingSigner> for TestChainMonitor<'a> {
156156
let update_res = self.chain_monitor.update_channel(funding_txo, update);
157157
// At every point where we get a monitor update, we should be able to send a useful monitor
158158
// to a watchtower and disk...
159-
let monitor = self.chain_monitor.get_current_monitor(funding_txo).unwrap();
159+
let monitor = self.chain_monitor.get_monitor(funding_txo).unwrap();
160160
w.0.clear();
161161
monitor.write(&mut w).unwrap();
162162
let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(

0 commit comments

Comments
 (0)