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 #2747

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

Implement option_simple_close #2747

wants to merge 5 commits into from

Conversation

t-bast
Copy link
Member

@t-bast t-bast commented Sep 20, 2023

Implement option_simple_close as defined in 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).

@codecov-commenter
Copy link

codecov-commenter commented Sep 20, 2023

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

Codecov Report

Attention: Patch coverage is 83.11111% with 38 lines in your changes missing coverage. Please review.

Project coverage is 85.88%. Comparing base (14a4ea4) to head (7fda599).
Report is 13 commits behind head on master.

Files with missing lines Patch % Lines
...in/scala/fr/acinq/eclair/channel/fsm/Channel.scala 76.28% 23 Missing ⚠️
...c/main/scala/fr/acinq/eclair/channel/Helpers.scala 88.88% 6 Missing ⚠️
...la/fr/acinq/eclair/channel/fsm/ErrorHandlers.scala 40.00% 6 Missing ⚠️
...la/fr/acinq/eclair/transactions/Transactions.scala 93.33% 2 Missing ⚠️
...n/scala/fr/acinq/eclair/balance/CheckBalance.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    #2747      +/-   ##
==========================================
- Coverage   85.98%   85.88%   -0.10%     
==========================================
  Files         219      219              
  Lines       18538    18912     +374     
  Branches      786      783       -3     
==========================================
+ Hits        15939    16243     +304     
- Misses       2599     2669      +70     
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.84% <100.00%> (+0.01%) ⬆️
...a/fr/acinq/eclair/channel/fsm/CommonHandlers.scala 85.71% <100.00%> (+0.42%) ⬆️
...inq/eclair/channel/fund/InteractiveTxBuilder.scala 91.66% <100.00%> (ø)
...n/scala/fr/acinq/eclair/io/PeerReadyNotifier.scala 71.75% <100.00%> (+2.52%) ⬆️
...n/scala/fr/acinq/eclair/json/JsonSerializers.scala 96.42% <ø> (ø)
...ire/internal/channel/version4/ChannelCodecs4.scala 98.44% <100.00%> (+0.02%) ⬆️
...ala/fr/acinq/eclair/wire/protocol/ChannelTlv.scala 100.00% <100.00%> (ø)
.../eclair/wire/protocol/LightningMessageCodecs.scala 99.41% <100.00%> (+0.02%) ⬆️
... and 6 more

... and 7 files with indirect coverage changes

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.
We add `nLocktime` to `closing_complete`, to allow the initiator to
decide what value to use to provide better anonymity and protection
against fee sniping.
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