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

lnwallet: respect local dust limit in cooperative close #8767

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

JssDWt
Copy link
Contributor

@JssDWt JssDWt commented May 17, 2024

Change Description

When the remote dustlimit is lower than the local one, a cooperative closure could create an output that doesn't respect the local dustlimit. By comparing the remote balance to the local dustlimit we're protected against creating invalid cooperative close transactions according to the local standards.

This requirement is part of the BOLTs: https://github.com/lightning/bolts/blob/5f8fea8dc3c8c612167dd9645c4a21fe9de2f147/03-transactions.md?plain=1#L373

Unfortunately this now leads to failure to close the channel. But that's better than crafting invalid transactions in my opinion.

Next steps will be

  • allowing the remote peer to eliminate its own output (spec).
  • potentially having a ruleset to in some circumstances eliminate the local output if it's small enough.

Steps to Test

  • Create a channel with Alice and Bob
  • Alice has dustlimit 10000
  • Bob has dustlimit 2000
  • Bob's balance is 2500
  • Attempt to cooperatively close the channel
  • Alice should not include Bob's output in the closing transaction

Pull Request Checklist

Testing

  • Your PR passes all CI checks.
  • Tests covering the positive and negative (error paths) are included.
  • Bug fixes contain tests triggering the bug to prevent regressions.

Code Style and Documentation

📝 Please see our Contribution Guidelines for further guidance.

When the remote dustlimit is lower than the local one, a cooperative closure
could create an output that doesn't respect the local dustlimit. By comparing
the remote balance to the local dustlimit we're protected against creating
invalid cooperative close transactions according to the local standards.
Copy link
Contributor

coderabbitai bot commented May 17, 2024

Important

Auto Review Skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@yyforyongyu
Copy link
Member

It's probably better to have an agreed value on dust_limit_satoshis during the channel opening - the funder proposes dust_limit_satoshis via open_channel msg, and the fundee should set it to the same value in accept_channel msg. Otherwise we'd always end up using max(local_dust_limit, remote_dust_limit) since we'd also need to make sure ourBalance >= remoteDust?

@JssDWt
Copy link
Contributor Author

JssDWt commented May 21, 2024

Otherwise we'd always end up using max(local_dust_limit, remote_dust_limit) since we'd also need to make sure ourBalance >= remoteDust?

That's a decision you can make. To either fail the closing procedure, because you have in invalid signature according to the remote party, or to omit your own output. Probably a good reasoning to decide whether you should omit your own output is:

  • is my output below the remote dust limit? If yes, would it cost me more if I would force close the channel?

For now, this PR only ensures you never create a transaction below your own dust limit in the first place. Deciding to omit your own output can be future improvements.

@Crypt-iQ
Copy link
Collaborator

The reason we haven't done this is because iirc each implementation does something slightly different. I'd defer work on this PR until we can all agree on the logic here. Additionally, changing this now will result in incompatibility with older LND nodes.

@JssDWt
Copy link
Contributor Author

JssDWt commented May 22, 2024

Additionally, changing this now will result in incompatibility with older LND nodes.

I agree there will be an incompatibility with older LND nodes. In fact, there will be an incompatibility between upgraded LND nodes too. If one party omits the peers output, but the peer doesn't, there's an incompatibility. But it also doesn't ever make sense to construct a closing transaction with an output below your own dustlimit. So the incompatibility already exists. This change just makes it more obvious.

@@ -8616,7 +8616,7 @@ func CreateCooperativeCloseTx(fundingTxIn wire.TxIn,
Value: int64(ourBalance),
})
}
if theirBalance >= remoteDust {
if theirBalance >= remoteDust && theirBalance >= localDust {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

technically, the wording of the spec means this should be if theirBalance >= localDust. I think some clarification in the spec meeting would be helpful here. You're right an incompatibility exists even with this change which is why I think it's important to nail down the specifics and see if we can get rid of that incompatibility for coop close v1. I don't think a partial fix is worth doing. When coop close v2 is deployed (slated for 0.18.1 but may get pushed to 0.19), this logic is likely to get superseded but may be toggle-able at first.

@Roasbeef
Copy link
Member

FWIW rbf-coop close will make this explicit, as the ender of a signature states which outputs is does/doesn't cover: #8453

@lightninglabs-deploy
Copy link

@JssDWt, remember to re-request review from reviewers when ready

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants