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

Improve the performace of LeaseOutput #8961

Merged
merged 9 commits into from
Aug 21, 2024

Conversation

yyforyongyu
Copy link
Collaborator

@yyforyongyu yyforyongyu commented Jul 31, 2024

There's a wrapper built around btcwallet.LeaseOutput in lnwallet, which additionally calls ListLeasedOutputs to fetch the script and value info, which is rarely used and can be replaced with other queries when needed. More importantly this ListLeasedOutputs is very slow (detailed in btcsuite/btcwallet#943), so we remove this call.

Once removed, we gained roughly 30s back in this test,

make itest icase=sign_psbt/fund_and_sign_psbt backend=bitcoind dbbackend=postgres

On this branch

--- PASS: TestLightningNetworkDaemon (185.49s)
    --- PASS: TestLightningNetworkDaemon/tranche00/74-of-167/bitcoind/sign_psbt (95.03s)
        --- PASS: TestLightningNetworkDaemon/tranche00/74-of-167/bitcoind/sign_psbt/fund_and_sign_psbt (88.34s)

On master,

--- PASS: TestLightningNetworkDaemon (230.91s)
    --- PASS: TestLightningNetworkDaemon/tranche00/74-of-167/bitcoind/sign_psbt (139.04s)
        --- PASS: TestLightningNetworkDaemon/tranche00/74-of-167/bitcoind/sign_psbt/fund_and_sign_psbt (133.73s)

Fix #8809.

@yyforyongyu yyforyongyu added wallet The wallet (lnwallet) which LND uses performance labels Jul 31, 2024
@yyforyongyu yyforyongyu added this to the v0.18.3 milestone Jul 31, 2024
Copy link
Contributor

coderabbitai bot commented Jul 31, 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

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

Solid improvement, thanks for looking into this!
But I think the first commit would break things in certain circumstances...

lnrpc/walletrpc/psbt.go Outdated Show resolved Hide resolved
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.

LGTM pending merge of dependent PR and re-arrangement of commits.

lnrpc/walletrpc/psbt.go Show resolved Hide resolved
This commit replaces the usage of `FetchInputInfo` with
`FetchOutpointInfo` and `FetchDerivationInfo` to remove unncessary
fetching of the derivation path.
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.

LGTM 🎉

rpcserver.go Show resolved Hide resolved
This method is no longer used. In addition, the `Derivation` field on
the `Utxo` is also removed to avoid nil dereference.
This commit prepares the following commit where we change the
`LeaseOutput` to be more efficient.
This commit removes the call toe `ListLeasedOutputs` in `LeaseOutput` -
the returned info from `ListLeasedOutputs` can easily be accessed via
`FetchInputInfo` and this info is only used at one callsite.
`ListLeasedOutputs` then becomes unnecessary here, plus it's very slow
and needs to be refactored in `btcwallet` instead.
This check has already been done when mining blocks.
Copy link
Member

@Roasbeef Roasbeef left a comment

Choose a reason for hiding this comment

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

LGTM 🪖

Nice optimization!

@@ -154,7 +154,7 @@ func (r *RPCKeyRing) SendOutputs(inputs fn.Set[wire.OutPoint],
// watch-only wallet if it can map this outpoint into a coin we
// own. If not, then we can't continue because our wallet state
// is out of sync.
info, err := r.WalletController.FetchInputInfo(
info, err := r.WalletController.FetchOutpointInfo(
Copy link
Member

Choose a reason for hiding this comment

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

Makes sense, FetchInputInfo ends up calling FetchOutpointInfo under the covers: https://github.com/btcsuite/btcwallet/blob/6ecae9c12fde8ed4db9e3c88241a8aeabff37724/wallet/utxos.go#L112-L123

}

lockedBalance += utxoInfo.Value
lockedBalance += btcutil.Amount(leasedOutput.Value)
Copy link
Member

Choose a reason for hiding this comment

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

👍

@Roasbeef Roasbeef merged commit cc9e2b7 into lightningnetwork:master Aug 21, 2024
26 of 34 checks passed
@yyforyongyu yyforyongyu deleted the fix-leaseoutput branch August 22, 2024 13:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
performance wallet The wallet (lnwallet) which LND uses
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

LeaseOutput is slow with postgres backend
4 participants