Additional closing cleanups post-#3881 #3899
Open
+144
−168
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
👋 Thanks for assigning @wpaulino as a reviewer! |
![graphite-app[bot]](https://avatars.githubusercontent.com/in/158384?s=60&v=4){kind=small}
TheBlueMatt
force-pushed
the
2025-06-close-cleanup
branch
from
0dac107 to
77fabef
Compare
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #3899 +/- ##
==========================================
- Coverage 89.02% 89.01% -0.02%
==========================================
Files 166 166
Lines 119683 119652 -31
Branches 119683 119652 -31
==========================================
- Hits 106546 106506 -40
- Misses 10725 10729 +4
- Partials 2412 2417 +5
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
tnull
reviewed
Jun 30, 2025
|
Yea, realized that but will probably fix after #3881 |
TheBlueMatt
force-pushed
the
2025-06-close-cleanup
branch
2 times, most recently
from
853bdfc to
a099c02
Compare
|
Squashed and fixed rustfmt. |
TheBlueMatt
force-pushed
the
2025-06-close-cleanup
branch
from
a099c02 to
afc42ab
Compare
tnull
previously approved these changes
Jul 15, 2025
|
🔔 1st Reminder Hey @wpaulino! This PR has been waiting for your review. |
TheBlueMatt
force-pushed
the
2025-06-close-cleanup
branch
from
afc42ab to
59bf265
Compare
|
Rebased. |
wpaulino
reviewed
Jul 17, 2025
lightning/src/ln/channelmanager.rs
Outdated
| // We're done with this channel, we've got a signed closing transaction and | ||
| // will send the closing_signed back to the remote peer upon return. This | ||
| // also implies there are no pending HTLCs left on the channel, so we can | ||
| // fully delete it from tracking (the channel monitor is still around to | ||
| // watch for old state broadcasts)! | ||
| locked_close_channel!(self, peer_state, chan, close_res, FUNDED); | ||
| (Some(tx), Some(chan_entry.remove()), Some(close_res)) | ||
| let (_, err) = convert_channel_err!(self, peer_state, close_res, chan, &msg.channel_id, COOP_CLOSED); |
There was a problem hiding this comment.
I find it odd that coop close gets classified as an error when it's something both nodes agreed upon, but I guess it's too late to really do anything about it
There was a problem hiding this comment.
I mean I can add a new, wrapping, macro to give it a new name, or rename convert_channel_err?
TheBlueMatt
force-pushed
the
2025-06-close-cleanup
branch
from
59bf265 to
2d5a81d
Compare
Our coop close methods `Channel::maybe_propose_closing_signed` and `Channel::closing_signed` may return a `Transaction` to broadcast as well as a `ShutdownResult` to provide the post-shutdown handling fields. However, it only does either both of them or neither - we only and always broadcast when we're done closing. Here we tweak the return values to match the possible states, combining the two fields in the return value into a single `Option`.
While most of our closure logic mostly lives in `locked_close_chan`, some important steps happen in `convert_channel_err` and `handle_error` (mostly broadcasting a channel closure `ChannelUpdate` and sending a relevant error message to our peer). In a previous commit we removed most instances of `locked_close_channel` in our closure pipeline, however it was still called in cases where we did a cooperative close. Here we remove the remaining direct references to it, always using `convert_channel_err` instead (now with a new `COOP_CLOSED` macro variant).
The `channel_id` argument to `convert_channel_err` allows us to set a different channel ID in the error message around the funding process. However, its not exactly critical to make sure we get it right, and yet another macro argument is annoying to deal with, so here we simply drop it and use the `Channel` value. This means that when force-closing we sometimes send an `error` with the `temporary_channel_id` rather than the funded `channel_id`, but its not that critical to get right (and we don't in all cases anyway), the peer will eventually figure it out when we reconnect or they try to send more messages about the channel.
Now that we never call `locked_close_channel` directly, the documentation on it should be updated to note that it shouldn't be used, rather relying on `convert_channel_err`, which now gets much of the substantive documentation on closing logic. Similarly, as `finish_close_channel` is now only called from `handle_error` we update the docs on both to note the new semantics.
TheBlueMatt
force-pushed
the
2025-06-close-cleanup
branch
from
2d5a81d to
731657b
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I had really hoped to spend some time moving some of the monitor completion and closure logic out of macros (as I fear they are a nontrivial portion of our compile time), but sadly I just really don't have the time. So instead here's the few additional small things I wanted to get out of the way.