walletrpc: document that min conf_target is 2 #9611

starius · 2025-03-18T18:54:37Z

Change Description

Without this notice a developer might think that 1 is a valid value, which can result in a rare bug.

Example: lightninglabs/loop#898

Pull Request Checklist

Testing

Your PR passes all CI checks.
Tests covering the positive and negative (error paths) are included.
Bug fixes contain tests triggering the bug to prevent regressions.

Code Style and Documentation

The change is not insubstantial. Typo fixes are not accepted to fight bot spam.
The change obeys the Code Documentation and Commenting guidelines, and lines wrap at 80.
Commits follow the Ideal Git Commit Structure.
Any new logging statements use an appropriate subsystem and logging level.
Any new lncli commands have appropriate tags in the comments for the rpc in the proto file.
There is a change description in the release notes, or [skip ci] in the commit message for small changes.

📝 Please see our Contribution Guidelines for further guidance.

coderabbitai · 2025-03-18T18:54:45Z

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.
- Explain this complex logic.
- 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 explain this code block.
- @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 explain its main purpose.
- @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in 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.

yyforyongyu

I don't think this is correct? I think all implementations allow a conf target of 1, this is also used in the sweeper.

For web API,

lnd/lnwallet/chainfee/estimator.go

Lines 804 to 809 in de1ed93

    
           if numBlocks > MaxBlockTarget { 
        
           	numBlocks = MaxBlockTarget 
        
           } else if numBlocks < minBlockTarget { 
        
           	return 0, fmt.Errorf("conf target of %v is too low, minimum "+ 
        
           		"accepted is %v", numBlocks, minBlockTarget) 
        
           }

For bitcoind it's allowed, not sure the RPC resp returned from btcd tho.

What error did you get?

yyforyongyu

Think it's no longer relevant? cc @starius

starius · 2025-06-28T21:38:11Z

@yyforyongyu Sorry for the delay!

This is still relevant.

The original error was reported here: lightninglabs/loop#898

2025-03-18 12:23:45.308 [ERR] LOOPD: Runtime error in daemon, shutting down: batcher error: failed to fetch min fee rate for 90616ed23c79: fee estimator failed, swapHash=90616ed23c79, confTarget=1: estimate fee: rpc error: code = Unknown desc = confirmation target must be greater than 1

The root-cause is that in the Loop code it was assumed that minimum valid value is 1. Loop was updated in lightninglabs/loop#899 to use 2 as the minimum.

The root-cause on LND side is this code:
https://github.com/lightningnetwork/lnd/blob/v0.19.1-beta/lnrpc/walletrpc/walletkit_server.go#L849-L852

	// A confirmation target of zero doesn't make any sense. Similarly, we
	// reject confirmation targets of 1 as they're unreasonable.
	case req.ConfTarget == 0 || req.ConfTarget == 1:
		return nil, fmt.Errorf("confirmation target must be greater " +
			"than 1")
	}

This code is still there in 0.19.1 and in master.

Without this notice a developer might think that 1 is a valid value, which can result in a rare bug. Example: lightninglabs/loop#898

starius · 2025-06-30T03:02:04Z

Rebased

ziggie1984 · 2025-07-02T17:44:15Z

I think we should allow values of 1, not sure why we mark it as unreasonable tbh.

lightninglabs-deploy · 2025-07-16T18:17:23Z

@yyforyongyu: review reminder

yyforyongyu · 2025-07-17T06:39:08Z

The root-cause on LND side is this code:
https://github.com/lightningnetwork/lnd/blob/v0.19.1-beta/lnrpc/walletrpc/walletkit_server.go#L849-L852

I think that code is a bit old - 1 is a legit value here, although it doesn't really give a good estimate if you are asking for conf=1. So agree with @ziggie1984 here that we should allow 1, unless we have a good reason to reject it.

See lightningnetwork#9611 (comment)

starius · 2025-07-17T14:53:43Z

I sent another PR to allow conf_target 1: #10087
I think we can close this PR.

starius added no-itest no-changelog labels Mar 18, 2025

guggero approved these changes Mar 18, 2025

View reviewed changes

starius marked this pull request as ready for review March 18, 2025 23:12

yyforyongyu requested changes Mar 19, 2025

View reviewed changes

hieblmi added the good first review Pull Requests that are suitable for new contributors that want to learn code review label Mar 28, 2025

yyforyongyu reviewed May 26, 2025

View reviewed changes

starius requested a review from yyforyongyu June 28, 2025 21:38

walletrpc: document that min conf_target is 2

4d4ea02

Without this notice a developer might think that 1 is a valid value, which can result in a rare bug. Example: lightninglabs/loop#898

starius force-pushed the walletkit-docs-target-conf branch from 48b16a1 to 4d4ea02 Compare June 30, 2025 03:01

starius added a commit to starius/lnd that referenced this pull request Jul 17, 2025

walletrpc: allow conf_target=1 in EstimateFee

c85e6f4

See lightningnetwork#9611 (comment)

starius mentioned this pull request Jul 17, 2025

walletrpc: allow conf_target=1 in EstimateFee #10087

Open

9 tasks

starius added a commit to starius/lnd that referenced this pull request Jul 17, 2025

walletrpc: allow conf_target=1 in EstimateFee

7dc6bd6

See lightningnetwork#9611 (comment)

starius closed this Jul 18, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

walletrpc: document that min conf_target is 2 #9611

walletrpc: document that min conf_target is 2 #9611

Uh oh!

starius commented Mar 18, 2025

Uh oh!

coderabbitai bot commented Mar 18, 2025 •

edited

Loading

Review skipped

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

yyforyongyu left a comment

Uh oh!

yyforyongyu left a comment

Uh oh!

starius commented Jun 28, 2025

Uh oh!

starius commented Jun 30, 2025

Uh oh!

ziggie1984 commented Jul 2, 2025

Uh oh!

lightninglabs-deploy commented Jul 16, 2025

Uh oh!

yyforyongyu commented Jul 17, 2025

Uh oh!

starius commented Jul 17, 2025

Uh oh!

Uh oh!

	if numBlocks > MaxBlockTarget {
	numBlocks = MaxBlockTarget
	} else if numBlocks < minBlockTarget {
	return 0, fmt.Errorf("conf target of %v is too low, minimum "+
	"accepted is %v", numBlocks, minBlockTarget)
	}

walletrpc: document that min conf_target is 2 #9611

walletrpc: document that min conf_target is 2 #9611

Uh oh!

Conversation

starius commented Mar 18, 2025

Change Description

Pull Request Checklist

Testing

Code Style and Documentation

Uh oh!

coderabbitai bot commented Mar 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

yyforyongyu left a comment

Choose a reason for hiding this comment

Uh oh!

yyforyongyu left a comment

Choose a reason for hiding this comment

Uh oh!

starius commented Jun 28, 2025

Uh oh!

starius commented Jun 30, 2025

Uh oh!

ziggie1984 commented Jul 2, 2025

Uh oh!

lightninglabs-deploy commented Jul 16, 2025

Uh oh!

yyforyongyu commented Jul 17, 2025

Uh oh!

starius commented Jul 17, 2025

Uh oh!

Uh oh!

coderabbitai bot commented Mar 18, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)