sweep: add docs and remove dead code

[yyforyongyu]

Straightforward PR - removes the dead code, and adds a readme file.

Accidentally closed #8670, think what happened was the based branch was deleted, so the following PR is automatically closed?

[coderabbitai]

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

• 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.

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.

[guggero]

Yayy, I love removing old code.
Also, great doc! Super awesome work on the sweeper all around 💯

[ziggie1984]

Could we describe in the sample.conf that this setting: ; sweeper.budget= should not be set or has no effect and only the settings in the sweeper.budget group should be used ? I think we need to adopt the sample.conf check script so that we don't need to list it in the first place.

[ziggie1984]

Faster than expected so we already have a readme in 18.0 ❤️

[morehouse]

Suggested change

	exception is inputs with `ExclusiveGroup` flag set, which will be swept alone.
	exception is inputs with the `ExclusiveGroup` flag set, which will be swept alone.

[morehouse]

Suggested change

	For instance, when anchor output is swept to perform a CPFP, one or more wallet
	UTXOs are likely to be used to meet the specified budget, which is also the
	case when sweeping second-level HTLC transactions. However, if the sweeping
	transaction also contains other to-be-swept inputs, a wallet UTXO is no longer
	needed if their values can cover the total budget.
	For instance, commitment and HTLC transactions usually have some proportion
	of their outputs timelocked, preventing them from being used to pay fees immediately.
	For these transactions, wallet UTXOs are often needed to get them confirmed in a timely
	manner.