lncli: add loadmc command #9781

bitromortac · 2025-05-05T10:01:52Z

Change Description

This command lets one import data exported by lncli querymc > mc.json via lncli loadmc --mcdatapath mc.json.

This can be helpful to recover from mission control migration issues (#9770 (comment)) or to bootstrap a new node with another node's mission control data.

I opted to add a new command instead of adding a --mcdatapath flag to importmc, I could change this if needed.

coderabbitai · 2025-05-05T10:02:00Z

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.

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.

bitromortac · 2025-05-05T10:17:40Z

cmd/commands/cmd_import_mission_control.go

+		// It is not allowed to import a zero-amount success to mission
+		// control if a timestamp is set. We unset it in this case.
+		if pair.History.SuccessTime != 0 &&
+			pair.History.SuccessAmtMsat == 0 &&
+			pair.History.SuccessAmtSat == 0 {
+
+			pair.History.SuccessTime = 0
+		}


When testing I've seen entries like that

{ "node_from": "X", "node_to": "Y", "history": { "fail_time": "1746388491", "fail_amt_sat": "0", "fail_amt_msat": "0", "success_time": "1746386085", "success_amt_sat": "0", "success_amt_msat": "0" } },

which is inconsistent with what we allow to import, which is why I've added those clean-ups. See here:

lnd/lnrpc/routerrpc/router_server.go

Lines 1282 to 1286 in 334a7d1

// Return an error if it does have a timestamp without an amount, and

// it's not expected to be a failure.

case !isFailure && timeSet && !amountSet:

return 0, time.Time{}, errors.New("non-zero timestamp " +

"requires non-zero amount for success pairs")

Definitely something we need to think about and potentially removing this validation check on the server side.

bitromortac · 2025-05-05T10:17:43Z

cmd/commands/cmd_import_mission_control.go

+		// If we only deal with a failure, we need to set the failure
+		// amount to a tiny value due to a limitation in the RPC. This
+		// will lead to a similar penalization in pathfinding.
+		if pair.History.SuccessTime == 0 &&
+			pair.History.FailTime != 0 &&
+			pair.History.FailAmtMsat == 0 &&
+			pair.History.FailAmtSat == 0 {
+
+			pair.History.FailAmtMsat = 1
+		}


This is an other check we would violate with the above input.

lnd/lnrpc/routerrpc/router_server.go

Lines 1240 to 1243 in 334a7d1

if successAmt == 0 && failAmt == 0 {

return nil, fmt.Errorf("%v: either success or failure result "+

"required", pairPrefix)

}

guggero

tACK, LGTM 🎉

guggero · 2025-05-05T10:40:54Z

cmd/commands/cmd_import_mission_control.go

+		},
+		cli.StringFlag{
+			Name: "timeoffset",
+			Usage: "Time offset to add to all timestamps. " +


Should we explain what this is useful for?

Right, added an explanation.

guggero · 2025-05-05T10:42:00Z

cmd/commands/cmd_import_mission_control.go

+
+	// We discard mission control data if requested.
+	if ctx.Bool("discard") {
+		if !promptForConfirmation("This will discard mission control " +


nit: add word "current" here as well: This will discard all current mission control data in the database: (yes/no).

makes sense, done!

guggero · 2025-05-05T10:43:22Z

cmd/commands/cmd_import_mission_control.go

+
+	_, err = client.XImportMissionControl(
+		rpcCtx,
+		&routerrpc.XImportMissionControlRequest{


There's also the Force flag, not sure if that's useful to expose?

Yes, good to have API feature completeness

guggero · 2025-05-05T10:48:59Z

cmd/commands/cmd_import_mission_control.go

+
+var loadMissionControlCommand = cli.Command{
+	Name:     "loadmc",
+	Category: "Payments",


This should go into Mission Control. And while we're at it, we should probably move importmc as well to that category.

Nice catch, changed it 👍

This command lets one import data exported by `lncli querymc > mc.json` via `lncli loadmc --mcdatapath mc.json`.

ziggie1984

LGTM,

we defintily need to take a look on the server side to understand why we are creating those 0,0 values tho. => maybe create an issue so we do not forget it.

ziggie1984 · 2025-05-05T17:22:49Z

cmd/commands/cmd_import_mission_control.go

+	Name:     "loadmc",
+	Category: "Mission Control",
+	Usage: "Load mission control results to the internal mission " +
+		"control state from a file produced by querymc with the " +


Micro-Nit: use backticks for the querymc cmd.

ziggie1984 · 2025-05-05T17:25:56Z

cmd/commands/cmd_import_mission_control.go

+				"information decay mechanism. Additionally " +
+				"by setting 0m, this will report the most " +
+				"recent result timestamp, which can be used " +
+				"to find out how old this data is.",


Q: What do you mean by report here? The import mc data rpc does not return any information or ?

ah, I was referring to the stdout text with the new max timestamp

ziggie1984 · 2025-05-05T17:27:50Z

cmd/commands/cmd_import_mission_control.go

+			}
+		}
+
+		fmt.Printf("Adding time offset %v to all timestamps. "+


Nit: Adding => Added ?

ziggie1984 · 2025-05-05T17:29:27Z

cmd/commands/cmd_import_mission_control.go

+		// It is not allowed to import a zero-amount success to mission
+		// control if a timestamp is set. We unset it in this case.
+		if pair.History.SuccessTime != 0 &&
+			pair.History.SuccessAmtMsat == 0 &&
+			pair.History.SuccessAmtSat == 0 {
+
+			pair.History.SuccessTime = 0
+		}


Definitely something we need to think about and potentially removing this validation check on the server side.

calvinrzachman · 2025-06-10T04:35:26Z

cmd/commands/cmd_import_mission_control.go

 var importMissionControlCommand = cli.Command{
 	Name:      "importmc",
-	Category:  "Payments",
+	Category:  "Mission Control",


bitromortac commented May 5, 2025

View reviewed changes

guggero approved these changes May 5, 2025

View reviewed changes

ziggie1984 self-requested a review May 5, 2025 11:15

bitromortac added 3 commits May 5, 2025 15:02

lncli: change importmc category

180f61b

lncli: add loadmc command

8351018

This command lets one import data exported by `lncli querymc > mc.json` via `lncli loadmc --mcdatapath mc.json`.

docs: update release notes

aaccc2b

bitromortac force-pushed the 2505-loadmc branch from e5f3c2b to aaccc2b Compare May 5, 2025 13:06

saubyk assigned bitromortac May 5, 2025

saubyk added mission control lncli labels May 5, 2025

saubyk added this to the v0.19.0 milestone May 5, 2025

ziggie1984 approved these changes May 5, 2025

View reviewed changes

Roasbeef merged commit 7b6c1cf into lightningnetwork:master May 5, 2025
30 of 35 checks passed

calvinrzachman reviewed Jun 10, 2025

View reviewed changes

	// Return an error if it does have a timestamp without an amount, and
	// it's not expected to be a failure.
	case !isFailure && timeSet && !amountSet:
	return 0, time.Time{}, errors.New("non-zero timestamp " +
	"requires non-zero amount for success pairs")

	if successAmt == 0 && failAmt == 0 {
	return nil, fmt.Errorf("%v: either success or failure result "+
	"required", pairPrefix)
	}

lncli: add loadmc command #9781

lncli: add loadmc command #9781

Uh oh!

Conversation

bitromortac commented May 5, 2025

Change Description

Uh oh!

coderabbitai bot commented May 5, 2025

Review skipped

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

guggero left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ziggie1984 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

CodeRabbit Configuration File (`.coderabbit.yaml`)