Skip to content

walletrpc: allow custom lock ID and duration in FundPsbt - #9724

Merged
bhandras merged 4 commits into
lightningnetwork:masterfrom
bhandras:fundpsbt-custom-input-lock
Apr 17, 2025
Merged

walletrpc: allow custom lock ID and duration in FundPsbt#9724
bhandras merged 4 commits into
lightningnetwork:masterfrom
bhandras:fundpsbt-custom-input-lock

Conversation

@bhandras

Copy link
Copy Markdown
Collaborator

Summary

The FundPsbt RPC must lock selected UTXOs to prevent double-use during PSBT construction. Previously, it always applied an internal default lock ID with a fixed 10-minute expiration. This rigid setup limited flexibility and made lease tracking via ListLeases difficult in multi-operation workflows.

What's New
This change adds two optional fields to walletrpc.FundPsbtRequest, enabling explicit control over UTXO locking:

  1. custom_lock_id (bytes)
  • If set, the wallet uses this value as the lease ID for locked UTXOs.

  • If omitted, the wallet continues using its internal default lock ID.

  1. lock_expiration_seconds (uint64)
    If non-zero, the lease expires after the given number of seconds.
  • Enables fine-tuning the lock duration to match the expected PSBT funding window.

  • If omitted or set to 0, the default 10-minute expiration is used.

Compatibility

  • Fully backward-compatible.

  • Existing clients not setting these fields will observe the exact same behavior as before.

@coderabbitai

coderabbitai Bot commented Apr 16, 2025

Copy link
Copy Markdown
Contributor

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.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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 generate docstrings to generate docstrings for this 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

@guggero guggero left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Linter complains, otherwise LGTM 🎉

Comment thread lnrpc/walletrpc/psbt.go
Comment thread lnrpc/walletrpc/psbt.go Outdated
Comment thread lnrpc/walletrpc/walletkit_server.go Outdated
Comment thread itest/lnd_psbt_test.go Outdated

@ziggie1984 ziggie1984 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Looks good, had some nits, apart from that missing release notes.

Comment thread lnrpc/walletrpc/walletkit.proto Outdated
// The max fee to total output amount ratio that this psbt should adhere to.
double max_fee_ratio = 12;

// The custom lock ID to use for the inputs in the funded PSBT. If empty,

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Add a comment that this needs to be 32 bytes ?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

done

Comment thread lnrpc/walletrpc/walletkit_server.go Outdated
Comment thread lnrpc/walletrpc/psbt.go Outdated
Comment thread itest/lnd_psbt_test.go Outdated
Comment thread itest/lnd_psbt_test.go Outdated
@saubyk saubyk added this to the v0.19.0 milestone Apr 17, 2025
Comment thread itest/lnd_psbt_test.go Outdated
Comment thread itest/lnd_psbt_test.go
Comment on lines +1955 to +1952
Fees: &walletrpc.FundPsbtRequest_SatPerVbyte{
SatPerVbyte: 2,
},
MinConfs: 1,

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I think we can use the default and remove these entries.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

These are also the defaults used in the other PSBT tests, so that's why they were chosen. I think we need to set these?

@bhandras
bhandras force-pushed the fundpsbt-custom-input-lock branch from b9713d2 to e86bea3 Compare April 17, 2025 13:25
@bhandras
bhandras requested a review from ziggie1984 April 17, 2025 13:25

@ziggie1984 ziggie1984 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM

@bhandras
bhandras merged commit 579f6f0 into lightningnetwork:master Apr 17, 2025
@bhandras
bhandras deleted the fundpsbt-custom-input-lock branch April 17, 2025 15:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

psbt rpc Related to the RPC interface

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants