lnd: use persisted node announcement settings across restarts #8825

Abdulkbk · 2024-06-10T17:38:42Z

replaces #8690

Change Description

This change allows a node to retain its previously configured node announcement settings after a restart, making it more consistent.

Issue:
As mentioned in the issue description:

If you set your alias using the UpdateNodeAnnouncement RPC call it will only maintain this as an update until a restart. Restarting clears all of the node announcement settings.

This creates additional work for users; for instance, if you have a list of addresses you associated with your node using the updatenodeannouncement RPC, you need to set them again each time your node restarts.

This also applies to all fields that can be updated using the updatenodeannouncement RPC, including: alias, color, addresses, and feature bit.

Solution:
This update checks for existing node announcement settings and reuses them during startup.

Since the node announcement settings can be set either through the node's config (specified in lnd.conf or passed as command line args) or using the updatenodeannouncement RPC, the hierarchy of precedence for these settings is as follows:

We check for what's set in config (args or lnd.conf)
We check for persistent settings (from graphDB)
We resolve to defaults

Steps to Test

Install LND with the peersrpc tag: make install tags="peersrpc".

Test for precedence:

Set one of the fields in the lnd.conf file, for example, alias=alice.
Start LND and update the alias by running: lncli peers updatenodeannouncement -alias=bob.
Verify that the alias has been updated using the lncli getinfo command.
Restart LND, then run lncli getinfo again to confirm that the alias is now set to alice.

Test for persistence

Start LND without configuring one of the fields in the lnd.conf file.
Use the command lncli peers updatenodeannouncement -color=#000000 to update the node's color, and verify the change by running lncli getinfo.
Restart LND, and then execute lncli getinfo again to ensure that the color value remains the same after the restart.

Alternatively*

make build-itest # to build itest

make make itest-only  icase="node announcement persistence" # to run only the integration test

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 · 2024-06-10T17:38:47Z

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.

Abdulkbk · 2024-06-10T17:45:14Z

@ellemouton, this pull request replaces #8690 as per your suggestion here. Please review when you have time. Thanks

ellemouton · 2024-06-10T17:48:58Z

@Abdulkbk - thanks! Although I think you could have just updated the commits in the original PR - no need for a new PR :)

Abdulkbk · 2024-06-10T19:20:12Z

@Abdulkbk - thanks! Although I think you could have just updated the commits in the original PR - no need for a new PR :)

At first, I thought about doing that, but then I ended up creating a new PR. Thanks for the feedback; I'm really learning a lot.

Abdulkbk · 2024-06-11T17:18:05Z

Hi @alexbosworth, I've opened this PR to fix the issue #7123 you reported. Could you spare some time to review it? Your input will help me improve the solution.

alexbosworth

utconcept ack

Chinwendu20

Nice work. Left some suggestions. I think the commit message does not follow guideline (i.e. length of the message):
https://github.com/lightningnetwork/lnd/blob/master/docs/code_contribution_guidelines.md#model-git-commit-messages

Here 6ebec6148ef072bd5cddc7, I do not think this is necessary:
'''
lnd: refactor code to elliminate duplicate nill check

lnd: fix comment
'''

Also I think this needs a release note? Maybe add here: https://github.com/lightningnetwork/lnd/blob/7065b6462edf48f3c86a58f2fd215cb0db2c0474/docs/release-notes/release-notes-0.18.1.md

server.go

Abdulkbk · 2024-06-23T20:38:03Z

Also I think this needs a release note? Maybe add here: https://github.com/lightningnetwork/lnd/blob/7065b6462edf48f3c86a58f2fd215cb0db2c0474/docs/release-notes/release-notes-0.18.1.md

Since this PR persists whatever was previously updated with the updatenodeannouncement lncli command, it means I should add a bullet point to explain that, right? @Chinwendu20

Chinwendu20 · 2024-06-25T20:45:32Z

I think you can add a bullet point to talk about what the change actually is and maybe a short explanation. Maybe under functional updates

Abdulkbk · 2024-06-26T10:45:24Z

I think you can add a bullet point to talk about what the change actually is and maybe a short explanation. Maybe under functional updates

I just noticed that the issue this PR is addressing is under milestone 0.19.0. Shouldn't the milestone version and release notes version be the same?

Chinwendu20 · 2024-06-26T13:04:16Z

I think it makes sense that it should be the same.

server.go

Abdulkbk · 2024-07-11T21:44:16Z

Hi @yyforyongyu , I noticed that you are one of the code owners of netann. This PR touches nodeannouncement, which I think falls under that. Would you mind reviewing it? It is required before I can get the tests to run.

yyforyongyu

Approved CI run.

server.go

Abdulkbk · 2024-11-04T20:28:31Z

Could you help approve the CI, @yyforyongyu?

Abdulkbk · 2025-06-02T20:45:08Z

Hmmm can't seem to figure out why the entire itests keep failing, will need to dig in a little deeper...

guggero · 2025-06-03T07:44:37Z

Carol fails to start back up:

    --- FAIL: TestLightningNetworkDaemon/tranche00/02-of-297/btcd/route_blinding_dummy_hops (57.55s)
        harness_node.go:403: Starting node (name=Alice) with PID=5933
        harness_node.go:403: Starting node (name=Bob) with PID=6045
        harness_node.go:403: Starting node (name=carol) with PID=6090
        harness_node.go:403: Starting node (name=dave) with PID=6150
        harness_node.go:403: Starting node (name=carol) with PID=6498
        harness.go:568: 
            	Error Trace:	/home/runner/work/lnd/lnd/lntest/harness.go:568
            	            				/home/runner/work/lnd/lnd/lntest/harness.go:607
            	            				/home/runner/work/lnd/lnd/itest/lnd_route_blinding_test.go:1138
            	            				/home/runner/work/lnd/lnd/lntest/harness.go:303
            	            				/home/runner/work/lnd/lnd/itest/lnd_test.go:130
            	Error:      	Received unexpected error:
            	            	ConnectRPC err: context deadline exceeded
            	Test:       	TestLightningNetworkDaemon/tranche00/02-of-297/btcd/route_blinding_dummy_hops
            	Messages:   	failed to restart node carol

With the following error in Carol's log:

unable to create server: can't unset feature bit 25 (route-blinding): feature is used in standard protocol set

Abdulkbk · 2025-06-03T14:57:51Z

With the following error in Carol's log:

unable to create server: can't unset feature bit 25 (route-blinding): feature is used in standard protocol set

Thanks for pointing that out. This made me realize I could download and view a particular node's logs from the CI, very helpful.

I was initially updating the feature manager with the feature sets that were persisted in the previous run, something like:

        prevFeatures := map[feature.Set]*lnwire.RawFeatureVector{
		feature.SetNodeAnn: sourceNode.Features.RawFeatureVector,
	}
	err = s.featureMgr.UpdateFeatureSets(prevFeatures)
	if err != nil {
		srvrLog.Errorf("unable to update feature sets: %v", err)

		return err
	}

This ensures that when you add an unknown feature bit (2, for example) before restarting, you get to see it in lncli getinfo response even after a restart.

...
 "2":  {
            "name":  "unknown",
            "is_required":  true,
            "is_known":  false
        },
...

The issue arises when we start a node carol in this case with --protocol.no-route-blinding and later restart it with route blinding support, as is done in the itest here, the initial implementation will try to unset the feature bit (since it was not used in the last run).

Abdulkbk · 2025-06-04T21:14:12Z

@saubyk could you add this to the review board?

ellemouton

Nice work! Will be great to get this in as it is closely tied to #9999 (where we also will need to start fetching our SourceNode from the DB on startup

ellemouton · 2025-06-29T14:59:30Z

server.go

+		srvrLog.Debugf("Unable to get source node from graphDB to "+
+			"construct initial node announcement: %v", err)
+


we should distinguish between if this error is ErrSourceNodeNotSet, in which case we dont need to log an error, or is it some other error in which case we should be erroring out.

ellemouton · 2025-06-29T15:01:36Z

itest/lnd_channel_graph_test.go

+		Alias: "alice",
+		Color: "#eeeeee",
+		AddressUpdates: []*peersrpc.UpdateAddressAction{
+			{


it would be good to test that we can still remove an address too

Now testing for this behaviour

ellemouton · 2025-06-29T15:03:55Z

server.go

+func getNodeAnnouncementFields(ctx context.Context, cfg *Config, s *server,
+	serializedPubKey [33]byte) (color.RGBA, string, []net.Addr, error) {


rather make a method on server

ie:

func (s *server) getNodeAnnFields(ctx context.Context, serializedPubKey route.Vertex) ...

Nice, looks cleaner!

ellemouton · 2025-06-29T15:04:40Z

server.go

+		srvrLog.Errorf("unable to parse color: %v\n", err)
+
+		return color, "", nil, err


rather just return a decorated error - it will get logged higher up

Now returning a decorated err

ellemouton · 2025-06-29T15:05:41Z

server.go

-	alias := cfg.Alias
-	if alias == "" {
-		alias = hex.EncodeToString(serializedPubKey[:10])
+	// Create a map to track existing addresses for quick lookup. This is


can probs move this logic into the getNodeAnnFields method and just pass it selfNodes and then used the returned addresses as the new selfNodes

You mean selfAddrs right? Done

Abdulkbk · 2025-06-29T22:38:13Z

Thanks for the review @ellemouton I've addressed the feedback you left.

Abdulkbk · 2025-06-29T22:56:44Z

I noticed some of the itests are failing particulary with this error from here

[ERR] LTND lnd.go:169: Shutting down due to error in main method err="unable to fetch source node: unable to fetch V1 source node: source node does not exist"

will investigate more...

ellemouton · 2025-06-30T07:34:15Z

@Abdulkbk - that is fixed in #9999

I think it's better to build this PR on top of that one since that one will probably be merged first

Abdulkbk · 2025-06-30T09:34:20Z

@Abdulkbk - that is fixed in #9999

I think it's better to build this PR on top of that one since that one will probably be merged first

Alright, I will rebase on top of that once it lands.

ellemouton · 2025-06-30T12:41:46Z

cool - it has been merged now @Abdulkbk

This commit ensures that we start with the alias, node color, addresses, and features as advertised in the node's previous runtime. This approach maintains consistency in the node's advertised information across restarts.

This commit adds an itest that verify the behaviour of correctly reusing persisted node ann configs across restarts. It also ensures that the node ann configs are applied using the correct hierarchy.

alexbosworth approved these changes Jun 11, 2024

View reviewed changes

Chinwendu20 reviewed Jun 13, 2024

View reviewed changes

server.go Outdated Show resolved Hide resolved

server.go Outdated Show resolved Hide resolved

server.go Outdated Show resolved Hide resolved

Abdulkbk force-pushed the restore-node-announcement branch from e2a4aa2 to b1e6571 Compare June 13, 2024 22:17

saubyk assigned Abdulkbk Jun 27, 2024

alexbosworth reviewed Jul 3, 2024

View reviewed changes

server.go Outdated Show resolved Hide resolved

Abdulkbk force-pushed the restore-node-announcement branch from b1e6571 to 5acc286 Compare July 9, 2024 14:33

saubyk added this to the v0.19.0 milestone Jul 12, 2024

yyforyongyu reviewed Jul 16, 2024

View reviewed changes

server.go Outdated Show resolved Hide resolved

Abdulkbk force-pushed the restore-node-announcement branch 2 times, most recently from 19d2ab7 to 367fbb7 Compare July 29, 2024 21:41

Abdulkbk force-pushed the restore-node-announcement branch 2 times, most recently from 61d4c75 to e43254e Compare August 6, 2024 22:41

Abdulkbk requested review from yyforyongyu and Chinwendu20 August 6, 2024 22:42

Abdulkbk force-pushed the restore-node-announcement branch from e43254e to 59462a5 Compare October 26, 2024 21:41

Abdulkbk force-pushed the restore-node-announcement branch from 59462a5 to d3fa798 Compare December 19, 2024 18:04

Abdulkbk force-pushed the restore-node-announcement branch 2 times, most recently from 0c08783 to 26b09ed Compare January 3, 2025 23:16

Abdulkbk changed the title ~~lnd: use persisted node announcement data from previous runtime~~ lnd: use persisted node announcement settings across restarts Jan 4, 2025

saubyk added this to lnd v0.20 May 15, 2025

saubyk moved this to In progress in lnd v0.20 May 15, 2025

Abdulkbk force-pushed the restore-node-announcement branch 5 times, most recently from 10c860f to 472a245 Compare June 2, 2025 19:43

Abdulkbk force-pushed the restore-node-announcement branch from 472a245 to d54a487 Compare June 3, 2025 10:54

saubyk removed the request for review from Chinwendu20 June 5, 2025 00:55

saubyk added this to PR Review Priority Jun 5, 2025

saubyk moved this to Medium Priority in PR Review Priority Jun 5, 2025

Abdulkbk force-pushed the restore-node-announcement branch 2 times, most recently from 4d17282 to 89cb0bd Compare June 26, 2025 11:26

ellemouton reviewed Jun 29, 2025

View reviewed changes

ellemouton mentioned this pull request Jun 29, 2025

multi: use "errors" pkg everywhere and ensure newer node announcement timestamp #10004

Merged

Abdulkbk force-pushed the restore-node-announcement branch from 89cb0bd to b3542ec Compare June 29, 2025 21:33

Abdulkbk added 3 commits June 30, 2025 15:51

lnd: use saved node ann config from previous run

9a9359f

This commit ensures that we start with the alias, node color, addresses, and features as advertised in the node's previous runtime. This approach maintains consistency in the node's advertised information across restarts.

itest: test for node ann persistence

0559cac

This commit adds an itest that verify the behaviour of correctly reusing persisted node ann configs across restarts. It also ensures that the node ann configs are applied using the correct hierarchy.

docs: add release note

aa2d6f9

Abdulkbk force-pushed the restore-node-announcement branch from b3542ec to aa2d6f9 Compare June 30, 2025 14:52

Abdulkbk requested a review from ellemouton June 30, 2025 18:22

		srvrLog.Debugf("Unable to get source node from graphDB to "+
		"construct initial node announcement: %v", err)

		func getNodeAnnouncementFields(ctx context.Context, cfg Config, s server,
		serializedPubKey [33]byte) (color.RGBA, string, []net.Addr, error) {

		srvrLog.Errorf("unable to parse color: %v\n", err)

		return color, "", nil, err

lnd: use persisted node announcement settings across restarts #8825

Are you sure you want to change the base?

lnd: use persisted node announcement settings across restarts #8825

Uh oh!

Conversation

Abdulkbk commented Jun 10, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Change Description

Steps to Test

Pull Request Checklist

Testing

Code Style and Documentation

Uh oh!

coderabbitai bot commented Jun 10, 2024 • 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!

Abdulkbk commented Jun 10, 2024

Uh oh!

ellemouton commented Jun 10, 2024

Uh oh!

Abdulkbk commented Jun 10, 2024

Uh oh!

Abdulkbk commented Jun 11, 2024

Uh oh!

alexbosworth left a comment

Choose a reason for hiding this comment

Uh oh!

Chinwendu20 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Abdulkbk commented Jun 23, 2024

Uh oh!

Chinwendu20 commented Jun 25, 2024

Uh oh!

Abdulkbk commented Jun 26, 2024

Uh oh!

Chinwendu20 commented Jun 26, 2024

Uh oh!

Uh oh!

Abdulkbk commented Jul 11, 2024

Uh oh!

yyforyongyu left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Abdulkbk commented Nov 4, 2024

Uh oh!

Abdulkbk commented Jun 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

guggero commented Jun 3, 2025

Uh oh!

Abdulkbk commented Jun 3, 2025

Uh oh!

Abdulkbk commented Jun 4, 2025

Uh oh!

ellemouton 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!

Abdulkbk commented Jun 10, 2024 •

edited

Loading

coderabbitai bot commented Jun 10, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

Chinwendu20 left a comment •

edited

Loading

Abdulkbk commented Jun 2, 2025 •

edited

Loading

Abdulkbk Jun 29, 2025 •

edited

Loading