Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement option_simple_close #2967

Draft
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

t-bast
Copy link
Member

@t-bast t-bast commented Dec 17, 2024

Implement option_simple_close as defined in the last update to lightning/bolts#1096

Hopefully this is the last time we change the mutual close protocol! And at some point that will let us entirely remove all the code supporting the two previous mutual close protocols (this is why I kept the code as separate as possible instead of trying to fit into the existing NEGOTIATING state).

Note that this is a prerequisite for taproot channels: this protocol allows nodes to safely exchange nonces in shutdown, closing_complete and closing_sig to spend a musig2 channel output.

This forks off #2747 (which we currently keep in case the final version of the spec chosen matches one of its commits).

@t-bast t-bast changed the title Implement option_simple_close (simpler variant) Implement option_simple_close Jan 17, 2025
@t-bast t-bast force-pushed the option-simple-close-no-state-machine branch from 67aa29f to 420298c Compare January 21, 2025 09:52
@codecov-commenter
Copy link

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

Attention: Patch coverage is 85.71429% with 33 lines in your changes missing coverage. Please review.

Project coverage is 85.94%. Comparing base (8827a04) to head (420298c).
Report is 1 commits behind head on master.

Files with missing lines Patch % Lines
...in/scala/fr/acinq/eclair/channel/fsm/Channel.scala 80.00% 17 Missing ⚠️
...c/main/scala/fr/acinq/eclair/channel/Helpers.scala 88.46% 6 Missing ⚠️
...la/fr/acinq/eclair/channel/fsm/ErrorHandlers.scala 40.00% 6 Missing ⚠️
...la/fr/acinq/eclair/transactions/Transactions.scala 94.87% 2 Missing ⚠️
...n/scala/fr/acinq/eclair/balance/CheckBalance.scala 0.00% 1 Missing ⚠️
...la/fr/acinq/eclair/io/OpenChannelInterceptor.scala 0.00% 1 Missing ⚠️

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2967      +/-   ##
==========================================
- Coverage   86.02%   85.94%   -0.09%     
==========================================
  Files         227      227              
  Lines       20340    20556     +216     
  Branches      834      841       +7     
==========================================
+ Hits        17498    17666     +168     
- Misses       2842     2890      +48     
Files with missing lines Coverage Δ
...core/src/main/scala/fr/acinq/eclair/Features.scala 100.00% <100.00%> (ø)
...in/scala/fr/acinq/eclair/channel/ChannelData.scala 100.00% <100.00%> (ø)
...in/scala/fr/acinq/eclair/channel/Commitments.scala 96.49% <100.00%> (+0.01%) ⬆️
...a/fr/acinq/eclair/channel/fsm/CommonHandlers.scala 88.88% <100.00%> (+3.59%) ⬆️
...inq/eclair/channel/fund/InteractiveTxBuilder.scala 93.03% <100.00%> (ø)
...n/scala/fr/acinq/eclair/io/PeerReadyNotifier.scala 71.75% <100.00%> (+0.21%) ⬆️
...n/scala/fr/acinq/eclair/json/JsonSerializers.scala 96.42% <ø> (ø)
...ire/internal/channel/version4/ChannelCodecs4.scala 98.49% <100.00%> (+0.02%) ⬆️
...ala/fr/acinq/eclair/wire/protocol/ChannelTlv.scala 100.00% <100.00%> (ø)
.../eclair/wire/protocol/LightningMessageCodecs.scala 99.49% <100.00%> (+0.01%) ⬆️
... and 7 more

... and 5 files with indirect coverage changes

@t-bast t-bast force-pushed the option-simple-close-no-state-machine branch from 420298c to d57c3a7 Compare January 21, 2025 16:28
This feature adds two new messages:

- `closing_complete` sent after exchanging `shutdown`
- `closing_sig` sent in response to `closing_complete`
The spec allows the closer to use an OP_RETURN output if their amount is
too low when using `option_simple_close`.
We introduce a new `NEGOTIATING_SIMPLE` state where we exchange the
`closing_complete` and `closing_sig` messages, and allow RBF-ing previous
transactions and updating our closing script.

We stay in that state until one of the transactions confirms, or a force
close is detected. This is important to ensure we're able to correctly
reconnect and negotiate RBF candidates.

We keep this separate from the previous `NEGOTIATING` state to make it
easier to remove support for the older mutual close protocols once we're
confident the network has been upgraded.
@t-bast t-bast force-pushed the option-simple-close-no-state-machine branch from d57c3a7 to d5c6021 Compare January 30, 2025 15:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants