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

Allow selecting coins in sendcoins #8955

Merged

Conversation

yyforyongyu
Copy link
Collaborator

Replaces #8516, fixes #6949

@yyforyongyu yyforyongyu added rpc Related to the RPC interface utxo sweeping labels Jul 30, 2024
@yyforyongyu yyforyongyu added this to the v0.18.3 milestone Jul 30, 2024
Copy link
Contributor

coderabbitai bot commented Jul 30, 2024

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

Copy link
Collaborator

@hieblmi hieblmi left a comment

Choose a reason for hiding this comment

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

Thanks for picking this up @yyforyongyu! I've checked out the test cases you added and left a suggestion. Since the original commits did not change and were already approved I will only aim for a tAck in my next review round.

cmd/lncli/cmd_open_channel.go Show resolved Hide resolved

// Since the first two UTXOs have been sent to an address outside her
// wallet, Alice should see a single UTXO now.
ht.AssertNumUTXOs(alice, 1)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Could we further check that the remaining coin can't be selected and spent in its entirety so that the required reserves are not violated?

On this note, should the API allow to spend the coin up until the required reserve and not return an error unless other constraints like the dust limit of the sending amount are reached? Maybe further tests can document behavior here as well.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

yeah I like it, added a test to show how it behaves atm.

Copy link
Collaborator

@guggero guggero left a comment

Choose a reason for hiding this comment

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

Not too far off I think, mainly some code style changes on the wish list.

rpcserver.go Outdated Show resolved Hide resolved
@@ -260,6 +267,15 @@ func CraftSweepAllTx(feeRate, maxFeeRate chainfee.SatPerKWeight,

log.Trace("[WithCoinSelectLock] finished fetching UTXOs")

// Use select utxos, if provided.
if len(selectUtxos) > 0 {
utxos, err = fetchUtxosFromOutpoints(utxos,
Copy link
Collaborator

Choose a reason for hiding this comment

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

nit: formatting.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

fixed!

sweep/walletsweep.go Show resolved Hide resolved
@yyforyongyu yyforyongyu force-pushed the cr-8516-240729-sendcoins branch 2 times, most recently from 6ccb920 to 0cb2739 Compare August 6, 2024 08:00
Copy link
Collaborator

@hieblmi hieblmi left a comment

Choose a reason for hiding this comment

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

Thanks for the additional itest that documents the utxo selection and channel reserves.

I've tested multiple scenarios in regtest that I also confirmed in the first version of this PR, tACK ✅

EDIT: The test failures seem unrelated to this PR.

// also checks that change outputs will be created automatically if `SendAll`
// flag is set.
func testSendSelectedCoinsChannelReserve(ht *lntest.HarnessTest) {
chanAmt := btcutil.Amount(100000)
Copy link
Collaborator

Choose a reason for hiding this comment

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

nit: 100_000

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

updated

tx := ht.GetNumTxsFromMempool(1)[0]

// Assert the tx has the expected shape. It should have 2 inputs and 2
// output.
Copy link
Collaborator

Choose a reason for hiding this comment

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

nit: outputs

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

fixed

Copy link
Collaborator

@guggero guggero left a comment

Choose a reason for hiding this comment

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

Nice, LGTM 🎉

@guggero guggero merged commit d776174 into lightningnetwork:master Aug 7, 2024
25 of 27 checks passed
@yyforyongyu yyforyongyu deleted the cr-8516-240729-sendcoins branch August 7, 2024 15:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
rpc Related to the RPC interface utxo sweeping
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Simplify coin selection logic for app devs
4 participants