Skip to content

Commit 685b08d

Browse files
committed
Use the new monitor persistence flow for funding_created handling
Building on the previous commits, this finishes our transition to doing all message-sending in the monitor update completion pipeline, unifying our immediate- and async- `ChannelMonitor` update and persistence flows.
1 parent c35253d commit 685b08d

File tree

3 files changed

+47
-53
lines changed

3 files changed

+47
-53
lines changed

lightning/src/ln/channel.rs

+12-7
Original file line numberDiff line numberDiff line change
@@ -2268,9 +2268,9 @@ impl<Signer: WriteableEcdsaChannelSigner> Channel<Signer> {
22682268

22692269
pub fn funding_created<SP: Deref, L: Deref>(
22702270
&mut self, msg: &msgs::FundingCreated, best_block: BestBlock, signer_provider: &SP, logger: &L
2271-
) -> Result<(msgs::FundingSigned, ChannelMonitor<<SP::Target as SignerProvider>::Signer>, Option<msgs::ChannelReady>), ChannelError>
2271+
) -> Result<(msgs::FundingSigned, ChannelMonitor<Signer>), ChannelError>
22722272
where
2273-
SP::Target: SignerProvider,
2273+
SP::Target: SignerProvider<Signer = Signer>,
22742274
L::Target: Logger
22752275
{
22762276
if self.is_outbound() {
@@ -2346,10 +2346,13 @@ impl<Signer: WriteableEcdsaChannelSigner> Channel<Signer> {
23462346

23472347
log_info!(logger, "Generated funding_signed for peer for channel {}", log_bytes!(self.channel_id()));
23482348

2349+
let need_channel_ready = self.check_get_channel_ready(0).is_some();
2350+
self.monitor_updating_paused(false, false, need_channel_ready, Vec::new(), Vec::new(), Vec::new());
2351+
23492352
Ok((msgs::FundingSigned {
23502353
channel_id: self.channel_id,
23512354
signature
2352-
}, channel_monitor, self.check_get_channel_ready(0)))
2355+
}, channel_monitor))
23532356
}
23542357

23552358
/// Handles a funding_signed message from the remote end.
@@ -3740,15 +3743,17 @@ impl<Signer: WriteableEcdsaChannelSigner> Channel<Signer> {
37403743
}
37413744

37423745
/// Indicates that a ChannelMonitor update is in progress and has not yet been fully persisted.
3743-
/// This must be called immediately after the [`chain::Watch`] call which returned
3744-
/// [`ChannelMonitorUpdateStatus::InProgress`].
3746+
/// This must be called before we return the [`ChannelMonitorUpdate`] back to the
3747+
/// [`ChannelManager`], which will call [`Self::monitor_updating_restored`] once the monitor
3748+
/// update completes (potentially immediately).
37453749
/// The messages which were generated with the monitor update must *not* have been sent to the
37463750
/// remote end, and must instead have been dropped. They will be regenerated when
37473751
/// [`Self::monitor_updating_restored`] is called.
37483752
///
3753+
/// [`ChannelManager`]: super::channelmanager::ChannelManager
37493754
/// [`chain::Watch`]: crate::chain::Watch
37503755
/// [`ChannelMonitorUpdateStatus::InProgress`]: crate::chain::ChannelMonitorUpdateStatus::InProgress
3751-
pub fn monitor_updating_paused(&mut self, resend_raa: bool, resend_commitment: bool,
3756+
fn monitor_updating_paused(&mut self, resend_raa: bool, resend_commitment: bool,
37523757
resend_channel_ready: bool, mut pending_forwards: Vec<(PendingHTLCInfo, u64)>,
37533758
mut pending_fails: Vec<(HTLCSource, PaymentHash, HTLCFailReason)>,
37543759
mut pending_finalized_claimed_htlcs: Vec<HTLCSource>
@@ -7189,7 +7194,7 @@ mod tests {
71897194
}]};
71907195
let funding_outpoint = OutPoint{ txid: tx.txid(), index: 0 };
71917196
let funding_created_msg = node_a_chan.get_outbound_funding_created(tx.clone(), funding_outpoint, &&logger).unwrap();
7192-
let (funding_signed_msg, _, _) = node_b_chan.funding_created(&funding_created_msg, best_block, &&keys_provider, &&logger).unwrap();
7197+
let (funding_signed_msg, _) = node_b_chan.funding_created(&funding_created_msg, best_block, &&keys_provider, &&logger).unwrap();
71937198

71947199
// Node B --> Node A: funding signed
71957200
let _ = node_a_chan.funding_signed(&funding_signed_msg, best_block, &&keys_provider, &&logger);

lightning/src/ln/channelmanager.rs

+32-43
Original file line numberDiff line numberDiff line change
@@ -4352,60 +4352,31 @@ where
43524352
}
43534353

43544354
fn internal_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), MsgHandleErrInternal> {
4355+
let best_block = *self.best_block.read().unwrap();
4356+
43554357
let per_peer_state = self.per_peer_state.read().unwrap();
43564358
let peer_state_mutex = per_peer_state.get(counterparty_node_id)
43574359
.ok_or_else(|| {
43584360
debug_assert!(false);
43594361
MsgHandleErrInternal::send_err_msg_no_close(format!("Can't find a peer matching the passed counterparty node_id {}", counterparty_node_id), msg.temporary_channel_id)
43604362
})?;
4361-
let ((funding_msg, monitor, mut channel_ready), mut chan) = {
4362-
let best_block = *self.best_block.read().unwrap();
4363-
let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4364-
let peer_state = &mut *peer_state_lock;
4363+
4364+
let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4365+
let peer_state = &mut *peer_state_lock;
4366+
let ((funding_msg, monitor), chan) =
43654367
match peer_state.channel_by_id.entry(msg.temporary_channel_id) {
43664368
hash_map::Entry::Occupied(mut chan) => {
43674369
(try_chan_entry!(self, chan.get_mut().funding_created(msg, best_block, &self.signer_provider, &self.logger), chan), chan.remove())
43684370
},
43694371
hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close(format!("Got a message for a channel from the wrong node! No such channel for the passed counterparty_node_id {}", counterparty_node_id), msg.temporary_channel_id))
4370-
}
4371-
};
4372-
// Because we have exclusive ownership of the channel here we can release the peer_state
4373-
// lock before watch_channel
4374-
match self.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor) {
4375-
ChannelMonitorUpdateStatus::Completed => {},
4376-
ChannelMonitorUpdateStatus::PermanentFailure => {
4377-
// Note that we reply with the new channel_id in error messages if we gave up on the
4378-
// channel, not the temporary_channel_id. This is compatible with ourselves, but the
4379-
// spec is somewhat ambiguous here. Not a huge deal since we'll send error messages for
4380-
// any messages referencing a previously-closed channel anyway.
4381-
// We do not propagate the monitor update to the user as it would be for a monitor
4382-
// that we didn't manage to store (and that we don't care about - we don't respond
4383-
// with the funding_signed so the channel can never go on chain).
4384-
let (_monitor_update, failed_htlcs) = chan.force_shutdown(false);
4385-
assert!(failed_htlcs.is_empty());
4386-
return Err(MsgHandleErrInternal::send_err_msg_no_close("ChannelMonitor storage failure".to_owned(), funding_msg.channel_id));
4387-
},
4388-
ChannelMonitorUpdateStatus::InProgress => {
4389-
// There's no problem signing a counterparty's funding transaction if our monitor
4390-
// hasn't persisted to disk yet - we can't lose money on a transaction that we haven't
4391-
// accepted payment from yet. We do, however, need to wait to send our channel_ready
4392-
// until we have persisted our monitor.
4393-
chan.monitor_updating_paused(false, false, channel_ready.is_some(), Vec::new(), Vec::new(), Vec::new());
4394-
channel_ready = None; // Don't send the channel_ready now
4395-
},
4396-
}
4397-
// It's safe to unwrap as we've held the `per_peer_state` read lock since checking that the
4398-
// peer exists, despite the inner PeerState potentially having no channels after removing
4399-
// the channel above.
4400-
let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4401-
let peer_state = &mut *peer_state_lock;
4372+
};
4373+
44024374
match peer_state.channel_by_id.entry(funding_msg.channel_id) {
44034375
hash_map::Entry::Occupied(_) => {
4404-
return Err(MsgHandleErrInternal::send_err_msg_no_close("Already had channel with the new channel_id".to_owned(), funding_msg.channel_id))
4376+
Err(MsgHandleErrInternal::send_err_msg_no_close("Already had channel with the new channel_id".to_owned(), funding_msg.channel_id))
44054377
},
44064378
hash_map::Entry::Vacant(e) => {
4407-
let mut id_to_peer = self.id_to_peer.lock().unwrap();
4408-
match id_to_peer.entry(chan.channel_id()) {
4379+
match self.id_to_peer.lock().unwrap().entry(chan.channel_id()) {
44094380
hash_map::Entry::Occupied(_) => {
44104381
return Err(MsgHandleErrInternal::send_err_msg_no_close(
44114382
"The funding_created message had the same funding_txid as an existing channel - funding is not possible".to_owned(),
@@ -4415,17 +4386,35 @@ where
44154386
i_e.insert(chan.get_counterparty_node_id());
44164387
}
44174388
}
4389+
4390+
// There's no problem signing a counterparty's funding transaction if our monitor
4391+
// hasn't persisted to disk yet - we can't lose money on a transaction that we haven't
4392+
// accepted payment from yet. We do, however, need to wait to send our channel_ready
4393+
// until we have persisted our monitor.
4394+
let new_channel_id = funding_msg.channel_id;
44184395
peer_state.pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
44194396
node_id: counterparty_node_id.clone(),
44204397
msg: funding_msg,
44214398
});
4422-
if let Some(msg) = channel_ready {
4423-
send_channel_ready!(self, peer_state.pending_msg_events, chan, msg);
4399+
4400+
let monitor_res = self.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor);
4401+
4402+
let chan = e.insert(chan);
4403+
let mut res = handle_new_monitor_update!(self, monitor_res, 0, peer_state_lock, peer_state, chan, MANUALLY_REMOVING, { peer_state.channel_by_id.remove(&new_channel_id) });
4404+
4405+
// Note that we reply with the new channel_id in error messages if we gave up on the
4406+
// channel, not the temporary_channel_id. This is compatible with ourselves, but the
4407+
// spec is somewhat ambiguous here. Not a huge deal since we'll send error messages for
4408+
// any messages referencing a previously-closed channel anyway.
4409+
// We do not propagate the monitor update to the user as it would be for a monitor
4410+
// that we didn't manage to store (and that we don't care about - we don't respond
4411+
// with the funding_signed so the channel can never go on chain).
4412+
if let Err(MsgHandleErrInternal { shutdown_finish: Some((res, _)), .. }) = &mut res {
4413+
res.0 = None;
44244414
}
4425-
e.insert(chan);
4415+
res
44264416
}
44274417
}
4428-
Ok(())
44294418
}
44304419

44314420
fn internal_funding_signed(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), MsgHandleErrInternal> {

lightning/src/ln/functional_tests.rs

+3-3
Original file line numberDiff line numberDiff line change
@@ -8736,9 +8736,9 @@ fn test_duplicate_chan_id() {
87368736
};
87378737
check_added_monitors!(nodes[0], 0);
87388738
nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
8739-
// At this point we'll try to add a duplicate channel monitor, which will be rejected, but
8740-
// still needs to be cleared here.
8741-
check_added_monitors!(nodes[1], 1);
8739+
// At this point we'll look up if the channel_id is present and immediately fail the channel
8740+
// without trying to persist the `ChannelMonitor`.
8741+
check_added_monitors!(nodes[1], 0);
87428742

87438743
// ...still, nodes[1] will reject the duplicate channel.
87448744
{

0 commit comments

Comments
 (0)