cmd/commands: add validation for MPP parameters #9238

anibilthare · 2024-10-31T05:45:17Z

Fixes 8916

Change Description

Adds validation to ensure that the combination of max_parts and max_shard_size_msat parameters can accommodate the full payment amount before attempting the payment. This prevents payments from entering a path finding loop that would eventually timeout when parameters are incompatible.

Steps to Test

coderabbitai · 2024-10-31T05:45:24Z

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

ellemouton

Thanks for the contribution @anibilthare 🙏

I think this validation should be the routerrpc though so that it can be applied no matter the interface being used :)

ellemouton · 2024-10-31T05:55:12Z

cmd/commands/cmd_payments.go

+	// Validate maxShardSize
+	if maxShardSize <= 0 {
+		return fmt.Errorf("max_shard_size must be positive, got %v", maxShardSize)
+	}
+
+	// Validate maxParts
+	if maxParts <= 0 {
+		return fmt.Errorf("max_parts must be positive, got %v", maxParts)
+	}


these are both unsigned integers. So they cannot be negative

also note that we treat 0 for maxParts as just the "default" which will later be replaced by 16. So 0 does not mean that MPP is not being used. Only not setting maxShardSize (ie, leaving it at 0) results in MPP not being used.

ellemouton · 2024-10-31T06:03:48Z

cmd/commands/cmd_payments.go

+		if err != nil {
+			return status.Errorf(codes.InvalidArgument,
+				"invalid MPP parameters: %v", err)
+		}


note that this only applies validation if used via the CLI. I think we want the validation to apply regardless of how SendPayment is being called. I think a better place for this validation is thus here:

lnd/lnrpc/routerrpc/router_backend.go

Lines 851 to 867 in 684041b

// Attempt to parse the max parts value set by the user, if this value

// isn't set, then we'll use the current default value for this

// setting.

maxParts := rpcPayReq.MaxParts

if maxParts == 0 {

maxParts = DefaultMaxParts

}

payIntent.MaxParts = maxParts

// If this payment had a max shard amount specified, then we'll apply

// that now, which'll force us to always make payment splits smaller

// than this.

if rpcPayReq.MaxShardSizeMsat > 0 {

shardAmtMsat := lnwire.MilliSatoshi(rpcPayReq.MaxShardSizeMsat)

payIntent.MaxShardAmt = &shardAmtMsat

}

Adds validation to ensure that the combination of max_parts and max_shard_size_msat parameters can accommodate the full payment amount before attempting the payment. This prevents payments from entering a path finding loop that would eventually timeout when parameters are incompatible.

anibilthare · 2024-11-01T06:28:30Z

Thanks @ellemouton !

Done

ellemouton

thanks @anibilthare 🙏

note that the commit title is now out of date. Also, see the failing linter CI check & missing release notes check

ellemouton · 2024-11-01T07:06:25Z

lnrpc/routerrpc/router_backend.go

+// payment amount. It returns an error if the parameters don't allow the full
+// payment amount to be sent.
+// maybeValidateMPPParams could be enhanced with additional checks
+func maybeValidateMPPParams(amt lnwire.MilliSatoshi, maxParts uint32,


i think you can just call it validateMPPParams

also, i think it may be worth adding a test for this. Perhaps there is an itest we can expand on just to make sure the call to SendPaymentV2 fails as expected

ellemouton · 2024-11-01T07:07:38Z

lnrpc/routerrpc/router_backend.go

@@ -1174,7 +1198,11 @@ func (r *RouterBackend) extractIntentFromSendRequest(

 		payIntent.DestFeatures = features
 	}
-
+	err = maybeValidateMPPParams(
+		payIntent.Amount, maxParts, lnwire.MilliSatoshi(rpcPayReq.MaxShardSizeMsat))


nit: formatting

ellemouton · 2024-11-01T07:07:46Z

lnrpc/routerrpc/router_backend.go

+	err = maybeValidateMPPParams(
+		payIntent.Amount, maxParts, lnwire.MilliSatoshi(rpcPayReq.MaxShardSizeMsat))
+	if err != nil {
+		return nil, fmt.Errorf("invalid MPP parameters: %v", err)


ellemouton · 2024-11-01T07:09:14Z

lnrpc/routerrpc/router_backend.go

+// maybeValidateMPPParams validates that the MPP parameters are compatible with the
+// payment amount. It returns an error if the parameters don't allow the full
+// payment amount to be sent.
+// maybeValidateMPPParams could be enhanced with additional checks


i dont think we need this last line. Validation functions can always be enhanced - this is implied

lightninglabs-deploy · 2024-12-13T10:02:30Z

@anibilthare, remember to re-request review from reviewers when ready

ellemouton self-requested a review October 31, 2024 05:50

ellemouton requested changes Oct 31, 2024

View reviewed changes

anibilthare force-pushed the issue_8916_invalid_mpp_params branch from d630dcc to 2de5713 Compare November 1, 2024 06:27

ellemouton reviewed Nov 1, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

cmd/commands: add validation for MPP parameters #9238

cmd/commands: add validation for MPP parameters #9238

anibilthare commented Oct 31, 2024 •

edited

Loading

coderabbitai bot commented Oct 31, 2024

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

ellemouton left a comment

ellemouton Oct 31, 2024 •

edited

Loading

ellemouton Oct 31, 2024

ellemouton Oct 31, 2024

anibilthare commented Nov 1, 2024

ellemouton left a comment •

edited

Loading

ellemouton Nov 1, 2024

ellemouton Nov 1, 2024

ellemouton Nov 1, 2024

ellemouton Nov 1, 2024

ellemouton Nov 1, 2024

lightninglabs-deploy commented Dec 13, 2024


	// Attempt to parse the max parts value set by the user, if this value
	// isn't set, then we'll use the current default value for this
	// setting.
	maxParts := rpcPayReq.MaxParts
	if maxParts == 0 {
	maxParts = DefaultMaxParts
	}
	payIntent.MaxParts = maxParts

	// If this payment had a max shard amount specified, then we'll apply
	// that now, which'll force us to always make payment splits smaller
	// than this.
	if rpcPayReq.MaxShardSizeMsat > 0 {
	shardAmtMsat := lnwire.MilliSatoshi(rpcPayReq.MaxShardSizeMsat)
	payIntent.MaxShardAmt = &shardAmtMsat
	}

cmd/commands: add validation for MPP parameters #9238

Are you sure you want to change the base?

cmd/commands: add validation for MPP parameters #9238

Conversation

anibilthare commented Oct 31, 2024 • edited Loading

Change Description

Steps to Test

coderabbitai bot commented Oct 31, 2024

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

ellemouton left a comment

Choose a reason for hiding this comment

ellemouton Oct 31, 2024 • edited Loading

Choose a reason for hiding this comment

ellemouton Oct 31, 2024

Choose a reason for hiding this comment

ellemouton Oct 31, 2024

Choose a reason for hiding this comment

anibilthare commented Nov 1, 2024

ellemouton left a comment • edited Loading

Choose a reason for hiding this comment

ellemouton Nov 1, 2024

Choose a reason for hiding this comment

ellemouton Nov 1, 2024

Choose a reason for hiding this comment

ellemouton Nov 1, 2024

Choose a reason for hiding this comment

ellemouton Nov 1, 2024

Choose a reason for hiding this comment

ellemouton Nov 1, 2024

Choose a reason for hiding this comment

lightninglabs-deploy commented Dec 13, 2024

anibilthare commented Oct 31, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

ellemouton Oct 31, 2024 •

edited

Loading

ellemouton left a comment •

edited

Loading