Make MaxWaitNumBlocksFundingConf Configurable for itest #9562

NishantBansal2003 · 2025-02-27T18:00:12Z

Change Description

Fixes: #9511
This PR introduces a configurable parameter for the constant MaxWaitNumBlocksFundingConf used in funding manager. The change allows developers and integration environments to override the default value (2016 blocks) via a build tag, enabling the mining of fewer blocks to trigger timeout scenarios during testing. In production builds, the default value remains unchanged to ensure stability.

Key Changes:

Configurable Timeout Constant:
- Added MaxWaitNumBlocksFundingConf to DevConfig so that its value can be modified.
Production Safety:
- Retains the default value of 2016 blocks for production, ensuring no impact on production behavior.
Improved Testing Flexibility:
- Allows tests to simulate timeout conditions more efficiently by reducing the number of blocks that need to be mined during integration testing.

Steps to Test

Added itest to confirm that timeout conditions are triggered as expected with the modified constant.

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 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-02-27T18:00:19Z

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

Crypt-iQ

Did a quick pass: needs proper formatting, lines go to 80 chars. I think the style guide in the repo can help you fix most of these issues. Otherwise, the core change looks good

Crypt-iQ · 2025-02-27T18:12:55Z

funding/manager.go

+	// For the maxWaitNumBlocksFundingConf different values are set
+	// in case we are in a dev environment so enhance test
+	// capabilities.
+	maxWaitNumBlocksFundingConf := MaxWaitNumBlocksFundingConf


variable name should not be reused, a bit confusing

Crypt-iQ · 2025-02-27T18:13:25Z

funding/manager.go

+	// MaxWaitNumBlocksFundingConf is the maximum number of blocks
+	// to wait for the funding transaction to be confirmed before forgetting
+	// channels that aren't initiated by us.
+	MaxWaitNumBlocksFundingConf int


nit: can we uint32 this so we don't need the cast below? fine if not

I can do that, but in that case, I need to update const MaxWaitNumBlocksFundingConf = 2016 to const MaxWaitNumBlocksFundingConf uint32 = 2016. However, I'm not sure if this might cause any compatibility issues.

It's not a big deal, just a nit so feel free to leave as-is

Constants don't have a type, if you don't explicitly set one. So it can be determined at compile time. So you can easily make this uint32 and then below just do: var waitBlocksForFundingConf uint32 = MaxWaitNumBlocksFundingConf.

Crypt-iQ · 2025-02-27T18:13:44Z

funding/manager.go

+	// Get the maxWaitNumBlocksFundingConf. If we are not in
+	// development mode, this would be nil.
+	if lncfg.IsDevBuild() {
+		maxWaitNumBlocksFundingConf = f.cfg.Dev.


nit: one line

NishantBansal2003 · 2025-02-28T06:53:44Z

needs proper formatting, lines go to 80 chars.

Hey @Crypt-iQ, I checked my code and believe I've already adhered to the 80-character limit. Could you let me know where the issue might be? (In some cases, more than 80 characters is necessary—such as in description) Also, should I add release notes for 0.19.0?

guggero · 2025-02-28T07:38:15Z

needs proper formatting, lines go to 80 chars.

Hey @Crypt-iQ, I checked my code and believe I've already adhered to the 80-character limit. Could you let me know where the issue might be? (In some cases, more than 80 characters is necessary—such as in description) Also, should I add release notes for 0.19.0?

You need to configure your IDE to use 8 chars for the tab character, otherwise the 80 character limit is hard to adhere to.
Yes, you can add 0.19 release notes.

Crypt-iQ · 2025-02-28T15:46:40Z

funding/manager.go

@@ -339,6 +340,11 @@ type DevConfig struct {
 	// remote node's channel ready message once the channel as been marked
 	// as `channelReadySent`.
 	ProcessChannelReadyWait time.Duration
+
+	// MaxWaitNumBlocksFundingConf is the maximum number of blocks


For example, here the comment can go up to 80 characters but then you wrap-around

Thanks, it's fixed. PTAL.

guggero

Thanks for the PR.

guggero · 2025-03-01T08:24:41Z

funding/manager.go

+	// MaxWaitNumBlocksFundingConf is the maximum number of blocks
+	// to wait for the funding transaction to be confirmed before forgetting
+	// channels that aren't initiated by us.
+	MaxWaitNumBlocksFundingConf int


Constants don't have a type, if you don't explicitly set one. So it can be determined at compile time. So you can easily make this uint32 and then below just do: var waitBlocksForFundingConf uint32 = MaxWaitNumBlocksFundingConf.

guggero · 2025-03-01T08:25:03Z

funding/manager.go

+	waitBlocksForFundingConf := MaxWaitNumBlocksFundingConf
+
+	// Get the waitBlocksForFundingConf. If we are not in development mode,
+	// this would be nil.


The default value of an int type is actually 0, not nil.

guggero · 2025-03-01T08:26:40Z

itest/lnd_open_channel_test.go

+	ht.OpenChannelAssertPending(alice, bob,
+		lntest.OpenChannelParams{
+			Amt:     500000,
+			PushAmt: 0,
+		})


nit: inconsistent formatting. Should either be:

ht.OpenChannelAssertPending(alice, bob, lntest.OpenChannelParams{ Amt: 500000, PushAmt: 0, })

or

ht.OpenChannelAssertPending( alice, bob, lntest.OpenChannelParams{ Amt: 500000, PushAmt: 0, }, )

depending on what fits with the line length limit.

guggero · 2025-03-01T08:27:55Z

lncfg/config.go

+	// DefaultMaxWaitNumBlocksFundingConf is the maximum number of blocks to
+	// wait for the funding transaction to confirm before forgetting
+	// channels that aren't initiated by us. 2016 blocks is ~2 weeks.
+	DefaultMaxWaitNumBlocksFundingConf = 2016


Isn't this defined twice now? I think we should just use this value everywhere now and remove the one in funding. Unless that will cause a circular package dependency, in which case we need to find a good place for it.

This commit adds an integration test that verifies the funding timeout behavior in the funding manager, in dev/integration test. Signed-off-by: Nishant Bansal <[email protected]>

Signed-off-by: Nishant Bansal <[email protected]>

saubyk assigned NishantBansal2003 Feb 27, 2025

Crypt-iQ reviewed Feb 27, 2025

View reviewed changes

NishantBansal2003 force-pushed the test-num-block-fund branch from 9e4b8e1 to 98e91b7 Compare February 28, 2025 06:47

NishantBansal2003 requested a review from Crypt-iQ February 28, 2025 09:51

Crypt-iQ reviewed Feb 28, 2025

View reviewed changes

saubyk added this to the v0.19.0 milestone Feb 28, 2025

NishantBansal2003 force-pushed the test-num-block-fund branch from 9752395 to a8efc7e Compare March 1, 2025 07:18

guggero reviewed Mar 1, 2025

View reviewed changes

NishantBansal2003 added 2 commits March 1, 2025 23:47

multi: Add itest for funding timeout

49d3fcf

This commit adds an integration test that verifies the funding timeout behavior in the funding manager, in dev/integration test. Signed-off-by: Nishant Bansal <[email protected]>

docs: add release notes.

f06f0aa

Signed-off-by: Nishant Bansal <[email protected]>

NishantBansal2003 force-pushed the test-num-block-fund branch from a8efc7e to f06f0aa Compare March 1, 2025 18:18

NishantBansal2003 requested review from guggero and Crypt-iQ March 1, 2025 18:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make MaxWaitNumBlocksFundingConf Configurable for itest #9562

Make MaxWaitNumBlocksFundingConf Configurable for itest #9562

NishantBansal2003 commented Feb 27, 2025

coderabbitai bot commented Feb 27, 2025

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Crypt-iQ left a comment

Crypt-iQ Feb 27, 2025

Crypt-iQ Feb 27, 2025

NishantBansal2003 Feb 27, 2025

Crypt-iQ Feb 28, 2025

guggero Mar 1, 2025

Crypt-iQ Feb 27, 2025

NishantBansal2003 commented Feb 28, 2025

guggero commented Feb 28, 2025 •

edited

Loading

Crypt-iQ Feb 28, 2025

NishantBansal2003 Mar 1, 2025

guggero left a comment

guggero Mar 1, 2025

guggero Mar 1, 2025

guggero Mar 1, 2025

guggero Mar 1, 2025

Make MaxWaitNumBlocksFundingConf Configurable for itest #9562

Are you sure you want to change the base?

Make MaxWaitNumBlocksFundingConf Configurable for itest #9562

Conversation

NishantBansal2003 commented Feb 27, 2025

Change Description

Key Changes:

Steps to Test

Pull Request Checklist

Testing

Code Style and Documentation

coderabbitai bot commented Feb 27, 2025

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Crypt-iQ left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

NishantBansal2003 commented Feb 28, 2025

guggero commented Feb 28, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

guggero left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

CodeRabbit Configuration File (`.coderabbit.yaml`)

guggero commented Feb 28, 2025 •

edited

Loading