Skip to content

Commit d407227

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 1948a6b commit d407227

File tree

3 files changed

+46
-53
lines changed

3 files changed

+46
-53
lines changed

lightning/src/ln/channel.rs

Lines changed: 11 additions & 7 deletions
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,16 @@ 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
///
37493753
/// [`chain::Watch`]: crate::chain::Watch
37503754
/// [`ChannelMonitorUpdateStatus::InProgress`]: crate::chain::ChannelMonitorUpdateStatus::InProgress
3751-
pub fn monitor_updating_paused(&mut self, resend_raa: bool, resend_commitment: bool,
3755+
fn monitor_updating_paused(&mut self, resend_raa: bool, resend_commitment: bool,
37523756
resend_channel_ready: bool, mut pending_forwards: Vec<(PendingHTLCInfo, u64)>,
37533757
mut pending_fails: Vec<(HTLCSource, PaymentHash, HTLCFailReason)>,
37543758
mut pending_finalized_claimed_htlcs: Vec<HTLCSource>
@@ -7189,7 +7193,7 @@ mod tests {
71897193
}]};
71907194
let funding_outpoint = OutPoint{ txid: tx.txid(), index: 0 };
71917195
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();
7196+
let (funding_signed_msg, _) = node_b_chan.funding_created(&funding_created_msg, best_block, &&keys_provider, &&logger).unwrap();
71937197

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

lightning/src/ln/channelmanager.rs

Lines changed: 32 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -4383,60 +4383,31 @@ where
43834383
}
43844384

43854385
fn internal_funding_created(&self, counterparty_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), MsgHandleErrInternal> {
4386+
let best_block = *self.best_block.read().unwrap();
4387+
43864388
let per_peer_state = self.per_peer_state.read().unwrap();
43874389
let peer_state_mutex = per_peer_state.get(counterparty_node_id)
43884390
.ok_or_else(|| {
43894391
debug_assert!(false);
43904392
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)
43914393
})?;
4392-
let ((funding_msg, monitor, mut channel_ready), mut chan) = {
4393-
let best_block = *self.best_block.read().unwrap();
4394-
let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4395-
let peer_state = &mut *peer_state_lock;
4394+
4395+
let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4396+
let peer_state = &mut *peer_state_lock;
4397+
let ((funding_msg, monitor), chan) =
43964398
match peer_state.channel_by_id.entry(msg.temporary_channel_id) {
43974399
hash_map::Entry::Occupied(mut chan) => {
43984400
(try_chan_entry!(self, chan.get_mut().funding_created(msg, best_block, &self.signer_provider, &self.logger), chan), chan.remove())
43994401
},
44004402
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))
4401-
}
4402-
};
4403-
// Because we have exclusive ownership of the channel here we can release the peer_state
4404-
// lock before watch_channel
4405-
match self.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor) {
4406-
ChannelMonitorUpdateStatus::Completed => {},
4407-
ChannelMonitorUpdateStatus::PermanentFailure => {
4408-
// Note that we reply with the new channel_id in error messages if we gave up on the
4409-
// channel, not the temporary_channel_id. This is compatible with ourselves, but the
4410-
// spec is somewhat ambiguous here. Not a huge deal since we'll send error messages for
4411-
// any messages referencing a previously-closed channel anyway.
4412-
// We do not propagate the monitor update to the user as it would be for a monitor
4413-
// that we didn't manage to store (and that we don't care about - we don't respond
4414-
// with the funding_signed so the channel can never go on chain).
4415-
let (_monitor_update, failed_htlcs) = chan.force_shutdown(false);
4416-
assert!(failed_htlcs.is_empty());
4417-
return Err(MsgHandleErrInternal::send_err_msg_no_close("ChannelMonitor storage failure".to_owned(), funding_msg.channel_id));
4418-
},
4419-
ChannelMonitorUpdateStatus::InProgress => {
4420-
// There's no problem signing a counterparty's funding transaction if our monitor
4421-
// hasn't persisted to disk yet - we can't lose money on a transaction that we haven't
4422-
// accepted payment from yet. We do, however, need to wait to send our channel_ready
4423-
// until we have persisted our monitor.
4424-
chan.monitor_updating_paused(false, false, channel_ready.is_some(), Vec::new(), Vec::new(), Vec::new());
4425-
channel_ready = None; // Don't send the channel_ready now
4426-
},
4427-
}
4428-
// It's safe to unwrap as we've held the `per_peer_state` read lock since checking that the
4429-
// peer exists, despite the inner PeerState potentially having no channels after removing
4430-
// the channel above.
4431-
let mut peer_state_lock = peer_state_mutex.lock().unwrap();
4432-
let peer_state = &mut *peer_state_lock;
4403+
};
4404+
44334405
match peer_state.channel_by_id.entry(funding_msg.channel_id) {
44344406
hash_map::Entry::Occupied(_) => {
4435-
return Err(MsgHandleErrInternal::send_err_msg_no_close("Already had channel with the new channel_id".to_owned(), funding_msg.channel_id))
4407+
Err(MsgHandleErrInternal::send_err_msg_no_close("Already had channel with the new channel_id".to_owned(), funding_msg.channel_id))
44364408
},
44374409
hash_map::Entry::Vacant(e) => {
4438-
let mut id_to_peer = self.id_to_peer.lock().unwrap();
4439-
match id_to_peer.entry(chan.channel_id()) {
4410+
match self.id_to_peer.lock().unwrap().entry(chan.channel_id()) {
44404411
hash_map::Entry::Occupied(_) => {
44414412
return Err(MsgHandleErrInternal::send_err_msg_no_close(
44424413
"The funding_created message had the same funding_txid as an existing channel - funding is not possible".to_owned(),
@@ -4446,17 +4417,35 @@ where
44464417
i_e.insert(chan.get_counterparty_node_id());
44474418
}
44484419
}
4420+
4421+
// There's no problem signing a counterparty's funding transaction if our monitor
4422+
// hasn't persisted to disk yet - we can't lose money on a transaction that we haven't
4423+
// accepted payment from yet. We do, however, need to wait to send our channel_ready
4424+
// until we have persisted our monitor.
4425+
let new_channel_id = funding_msg.channel_id;
44494426
peer_state.pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
44504427
node_id: counterparty_node_id.clone(),
44514428
msg: funding_msg,
44524429
});
4453-
if let Some(msg) = channel_ready {
4454-
send_channel_ready!(self, peer_state.pending_msg_events, chan, msg);
4430+
4431+
let monitor_res = self.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor);
4432+
4433+
let chan = e.insert(chan);
4434+
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) });
4435+
4436+
// Note that we reply with the new channel_id in error messages if we gave up on the
4437+
// channel, not the temporary_channel_id. This is compatible with ourselves, but the
4438+
// spec is somewhat ambiguous here. Not a huge deal since we'll send error messages for
4439+
// any messages referencing a previously-closed channel anyway.
4440+
// We do not propagate the monitor update to the user as it would be for a monitor
4441+
// that we didn't manage to store (and that we don't care about - we don't respond
4442+
// with the funding_signed so the channel can never go on chain).
4443+
if let Err(MsgHandleErrInternal { shutdown_finish: Some((res, _)), .. }) = &mut res {
4444+
res.0 = None;
44554445
}
4456-
e.insert(chan);
4446+
res
44574447
}
44584448
}
4459-
Ok(())
44604449
}
44614450

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

lightning/src/ln/functional_tests.rs

Lines changed: 3 additions & 3 deletions
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)