sweep, rpcserver: optimize SendAll cost wise

[starius]

Change Description

If there is a coin of value equal to the amount reserved for anchor bumping (e.g. 100k sats), SendAll used to spend it and to create another coin of such size. Now it just does not touch the coin in this scenario.

To achieve this, added argument skipInputAmount to fn sweep.CraftSweepAllTx. If it is not 0, it looks for an input of that value and skips it. If it can't find an input, it skips locking UTXOs and returns ErrMissingInputToSkip.

Added unit test for new functionality of CraftSweepAllTx.

Added itest to test the optimization in SendAll.

SendAll is used by lncli sendcoins --sweepall.

Steps to Test

• Run LND node built from this PR
• Open few channels
• Fund node's wallet with with 0.01 BTC
• Run lncli sendcoins --sweepall moving all the funds to an external address
• That tx should have a change output of value equal to reserved funds (e.g. 100k if there are 10+ channels)
• Fund node's wallet again with 0.01 BTC
• Run lncli sendcoins --sweepall again moving all the funds to an external address
• The tx should be 1-to-1, not 2-to-2, as it would be before this PR

Pull Request Checklist

Testing

• [ ] Your PR passes all CI checks.
• [x] Tests covering the positive and negative (error paths) are included.

Code Style and Documentation

• [x] The change obeys the Code Documentation and Commenting guidelines, and lines wrap at 80.
• [x] Commits follow the Ideal Git Commit Structure.
• [x] Any new logging statements use an appropriate subsystem and logging level.
• [ ] There is a change description in the release notes, or [skip ci] in the commit message for small changes.

Example transaction

lncli sendcoins --sweepall

If this PR was applied, the transaction wouldn't include its last input and first output (0.001 BTC each).

[coderabbitai[bot]]

[!IMPORTANT]

Review skipped

Auto reviews are limited to specific labels.

Labels to auto review (1)

• llm-review

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

• X
• Mastodon
• Reddit
• LinkedIn

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.
  • @coderabbitai help me debug CodeRabbit configuration file.

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 an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

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

CodeRabbit Configuration 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]

An example tx.

[starius]

Superseded by https://github.com/lightningnetwork/lnd/pull/8955

[baldbull69]

Change Description

If there is a coin of value equal to the amount reserved for anchor bumping (e.g. 100k sats), SendAll used to spend it and to create another coin of such size. Now it just does not touch the coin in this scenario.

To achieve this, added argument skipInputAmount to fn sweep.CraftSweepAllTx. If it is not 0, it looks for an input of that value and skips it. If it can't find an input, it skips locking UTXOs and returns ErrMissingInputToSkip.

Added unit test for new functionality of CraftSweepAllTx.

Added itest to test the optimization in SendAll.

SendAll is used by lncli sendcoins --sweepall.

Steps to Test

• Run LND node built from this PR

• Open few channels

• Fund node's wallet with with 0.01 BTC

• Run lncli sendcoins --sweepall moving all the funds to an external address

• That tx should have a change output of value equal to reserved funds (e.g. 100k if there are 10+ channels)

• Fund node's wallet again with 0.01 BTC

• Run lncli sendcoins --sweepall again moving all the funds to an external address

• The tx should be 1-to-1, not 2-to-2, as it would be before this PR

Pull Request Checklist

Testing

• [ ] Your PR passes all CI checks.

• [x] Tests covering the positive and negative (error paths) are included.

Code Style and Documentation

• [x] The change obeys the Code Documentation and Commenting guidelines, and lines wrap at 80.

• [x] Commits follow the Ideal Git Commit Structure.

• [x] Any new logging statements use an appropriate subsystem and logging level.

• [ ] There is a change description in the release notes, or [skip ci] in the commit message for small changes.

Example transaction

lncli sendcoins --sweepall

If this PR was applied, the transaction wouldn't include its last input and first output (0.001 BTC each).