Skip to content

Commit e721025

Browse files
committed
Rename Channel::pending_monitor_updates to blocked
To differentiate between in-flight pending completion and blocked updates.
1 parent c182b27 commit e721025

File tree

1 file changed

+21
-23
lines changed

1 file changed

+21
-23
lines changed

lightning/src/ln/channel.rs

+21-23
Original file line numberDiff line numberDiff line change
@@ -859,11 +859,9 @@ pub(super) struct ChannelContext<Signer: ChannelSigner> {
859859
/// [`SignerProvider::derive_channel_signer`].
860860
channel_keys_id: [u8; 32],
861861

862-
/// When we generate [`ChannelMonitorUpdate`]s to persist, they may not be persisted immediately.
863-
/// If we then persist the [`channelmanager::ChannelManager`] and crash before the persistence
864-
/// completes we still need to be able to complete the persistence. Thus, we have to keep a
865-
/// copy of the [`ChannelMonitorUpdate`] here until it is complete.
866-
pending_monitor_updates: Vec<PendingChannelMonitorUpdate>,
862+
/// If we can't release a [`ChannelMonitorUpdate`] until some external action completes, we
863+
/// store it here and only release it to [`ChannelManager`] once it asks for it.
864+
blocked_monitor_updates: Vec<PendingChannelMonitorUpdate>,
867865
}
868866

869867
impl<Signer: ChannelSigner> ChannelContext<Signer> {
@@ -2254,7 +2252,7 @@ impl<Signer: WriteableEcdsaChannelSigner> Channel<Signer> {
22542252
}
22552253

22562254
pub fn get_update_fulfill_htlc_and_commit<L: Deref>(&mut self, htlc_id: u64, payment_preimage: PaymentPreimage, logger: &L) -> UpdateFulfillCommitFetch where L::Target: Logger {
2257-
let release_cs_monitor = self.context.pending_monitor_updates.is_empty();
2255+
let release_cs_monitor = self.context.blocked_monitor_updates.is_empty();
22582256
match self.get_update_fulfill_htlc(htlc_id, payment_preimage, logger) {
22592257
UpdateFulfillFetch::NewClaim { mut monitor_update, htlc_value_msat, msg } => {
22602258
// Even if we aren't supposed to let new monitor updates with commitment state
@@ -2269,16 +2267,16 @@ impl<Signer: WriteableEcdsaChannelSigner> Channel<Signer> {
22692267
self.context.latest_monitor_update_id = monitor_update.update_id;
22702268
monitor_update.updates.append(&mut additional_update.updates);
22712269
} else {
2272-
let new_mon_id = self.context.pending_monitor_updates.get(0)
2270+
let new_mon_id = self.context.blocked_monitor_updates.get(0)
22732271
.map(|upd| upd.update.update_id).unwrap_or(monitor_update.update_id);
22742272
monitor_update.update_id = new_mon_id;
2275-
for held_update in self.context.pending_monitor_updates.iter_mut() {
2273+
for held_update in self.context.blocked_monitor_updates.iter_mut() {
22762274
held_update.update.update_id += 1;
22772275
}
22782276
if msg.is_some() {
22792277
debug_assert!(false, "If there is a pending blocked monitor we should have MonitorUpdateInProgress set");
22802278
let update = self.build_commitment_no_status_check(logger);
2281-
self.context.pending_monitor_updates.push(PendingChannelMonitorUpdate {
2279+
self.context.blocked_monitor_updates.push(PendingChannelMonitorUpdate {
22822280
update,
22832281
});
22842282
}
@@ -4397,25 +4395,25 @@ impl<Signer: WriteableEcdsaChannelSigner> Channel<Signer> {
43974395

43984396
/// Gets the latest [`ChannelMonitorUpdate`] ID which has been released and is in-flight.
43994397
pub fn get_latest_unblocked_monitor_update_id(&self) -> u64 {
4400-
if self.context.pending_monitor_updates.is_empty() { return self.context.get_latest_monitor_update_id(); }
4401-
self.context.pending_monitor_updates[0].update.update_id - 1
4398+
if self.context.blocked_monitor_updates.is_empty() { return self.context.get_latest_monitor_update_id(); }
4399+
self.context.blocked_monitor_updates[0].update.update_id - 1
44024400
}
44034401

44044402
/// Returns the next blocked monitor update, if one exists, and a bool which indicates a
44054403
/// further blocked monitor update exists after the next.
44064404
pub fn unblock_next_blocked_monitor_update(&mut self) -> Option<(ChannelMonitorUpdate, bool)> {
4407-
if self.context.pending_monitor_updates.is_empty() { return None; }
4408-
Some((self.context.pending_monitor_updates.remove(0).update,
4409-
!self.context.pending_monitor_updates.is_empty()))
4405+
if self.context.blocked_monitor_updates.is_empty() { return None; }
4406+
Some((self.context.blocked_monitor_updates.remove(0).update,
4407+
!self.context.blocked_monitor_updates.is_empty()))
44104408
}
44114409

44124410
/// Pushes a new monitor update into our monitor update queue, returning it if it should be
44134411
/// immediately given to the user for persisting or `None` if it should be held as blocked.
44144412
fn push_ret_blockable_mon_update(&mut self, update: ChannelMonitorUpdate)
44154413
-> Option<ChannelMonitorUpdate> {
4416-
let release_monitor = self.context.pending_monitor_updates.is_empty();
4414+
let release_monitor = self.context.blocked_monitor_updates.is_empty();
44174415
if !release_monitor {
4418-
self.context.pending_monitor_updates.push(PendingChannelMonitorUpdate {
4416+
self.context.blocked_monitor_updates.push(PendingChannelMonitorUpdate {
44194417
update,
44204418
});
44214419
None
@@ -4425,7 +4423,7 @@ impl<Signer: WriteableEcdsaChannelSigner> Channel<Signer> {
44254423
}
44264424

44274425
pub fn blocked_monitor_updates_pending(&self) -> usize {
4428-
self.context.pending_monitor_updates.len()
4426+
self.context.blocked_monitor_updates.len()
44294427
}
44304428

44314429
/// Returns true if the channel is awaiting the persistence of the initial ChannelMonitor.
@@ -5570,7 +5568,7 @@ impl<Signer: WriteableEcdsaChannelSigner> OutboundV1Channel<Signer> {
55705568
channel_type,
55715569
channel_keys_id,
55725570

5573-
pending_monitor_updates: Vec::new(),
5571+
blocked_monitor_updates: Vec::new(),
55745572
}
55755573
})
55765574
}
@@ -6200,7 +6198,7 @@ impl<Signer: WriteableEcdsaChannelSigner> InboundV1Channel<Signer> {
62006198
channel_type,
62016199
channel_keys_id,
62026200

6203-
pending_monitor_updates: Vec::new(),
6201+
blocked_monitor_updates: Vec::new(),
62046202
}
62056203
};
62066204

@@ -6766,7 +6764,7 @@ impl<Signer: WriteableEcdsaChannelSigner> Writeable for Channel<Signer> {
67666764
(28, holder_max_accepted_htlcs, option),
67676765
(29, self.context.temporary_channel_id, option),
67686766
(31, channel_pending_event_emitted, option),
6769-
(33, self.context.pending_monitor_updates, vec_type),
6767+
(33, self.context.blocked_monitor_updates, vec_type),
67706768
});
67716769

67726770
Ok(())
@@ -7043,7 +7041,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
70437041
let mut temporary_channel_id: Option<[u8; 32]> = None;
70447042
let mut holder_max_accepted_htlcs: Option<u16> = None;
70457043

7046-
let mut pending_monitor_updates = Some(Vec::new());
7044+
let mut blocked_monitor_updates = Some(Vec::new());
70477045

70487046
read_tlv_fields!(reader, {
70497047
(0, announcement_sigs, option),
@@ -7067,7 +7065,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
70677065
(28, holder_max_accepted_htlcs, option),
70687066
(29, temporary_channel_id, option),
70697067
(31, channel_pending_event_emitted, option),
7070-
(33, pending_monitor_updates, vec_type),
7068+
(33, blocked_monitor_updates, vec_type),
70717069
});
70727070

70737071
let (channel_keys_id, holder_signer) = if let Some(channel_keys_id) = channel_keys_id {
@@ -7239,7 +7237,7 @@ impl<'a, 'b, 'c, ES: Deref, SP: Deref> ReadableArgs<(&'a ES, &'b SP, u32, &'c Ch
72397237
channel_type: channel_type.unwrap(),
72407238
channel_keys_id,
72417239

7242-
pending_monitor_updates: pending_monitor_updates.unwrap(),
7240+
blocked_monitor_updates: blocked_monitor_updates.unwrap(),
72437241
}
72447242
})
72457243
}

0 commit comments

Comments
 (0)