channeldb: add persist nodeannounment config in db #8690

Abdulkbk · 2024-04-25T12:52:49Z

In this commit, we save the node announcement config in the database so that we can retrieve the config later and use it when a node restarts.

closes #7123

Change Description

Description of change / link to associated issue.
We start by checking the configuration from the configuration file lnd.conf or arguments when the node starts. If the configuration is absent, we check for the ones persisted on disk and use them; otherwise, we resolve to the default settings.

Steps to Test

Steps for reviewers to follow to test the change.

Make sure no alias is not set in your lnd.conf
Use the updatenodeannouncement RPC call and set something as your alias
Verify the alias is set using lncli getinfo
Now stop and start the node again and run lncli getinfo again
You'll see that the alias is set to the first 10 characters of the node's pubkey

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.

In this commit, we save nodeannouncement config in the database so that we will be able to retrieve the config later and use them on retart Signed-off-by: Abdullahi Yunus <abdoollahikbk@gmail.com>

coderabbitai · 2024-04-25T12:52:54Z

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>.
- 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 generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

In this commit, we check for nodeannouncement alias in the db before creating a disk representation of a node. If there none, we default to first 10 characters of our pubkey.

In this commit, we check for alias that are persisted in disk and use them when the node is restarting.

Chinwendu20

Nice work, Left questions and doubts about the architecture

channeldb/db.go

channeldb/node.go

ellemouton

Thanks for the PR,
I think we want things to be more general and not just for the alias. Ie, for any of the fields you can change via UpdateNodeAnnouncement

channeldb/node.go

ellemouton · 2024-05-28T13:46:36Z

channeldb/node.go

+type NodeAnnouncementDB struct {
+	backend kvdb.Backend
+}
+


we already persist our node announcement in the bucket storing all the collected node announcement. Can we not just grab our latest one from there?

I don't know where the collected node announcements are stored. Are you referring to here where all nodes within a channel graph are stored and their node announcements (if they have any)?.

yes - we store our node announcement there too right? if so, then i dont think we need a whole new bucket for it. Let me know if my assumption is incorrect

@ellemouton I explored the code related to graph DB, and it turns out you're right. We're indeed storing our node along with the node announcement, and we can easily retrieve the stored values from this method when lnd starts.

Since this is the case, I will close this PR and open a new one to replace it. Does that make sense?

Abdulkbk · 2024-05-28T21:06:48Z

Nice work, Left questions and doubts about the architecture

Thanks for reviewing @Chinwendu20. I will look at the comments, answer your questions, and address any suggestions you gave me

In this commit, we ensure new configurations are saved whenever node announcement is updated.

Here we try to determine the alias and color source for our node when starting. The hierarchy is config set in lnd.conf take precedence over persisted config and finally the default.

Abdulkbk · 2024-06-03T08:07:37Z

Thanks for the PR, I think we want things to be more general and not just for the alias. Ie, for any of the fields you can change via UpdateNodeAnnouncement

I started with alias and color for the first iteration. I will be working on the next fields (feature bits, and addresses). Thanks for taking the time to review.

In this commit, we save the features and addresses assosciated with a node in the database, and use them when the node restarts.

…addresses

ellemouton · 2024-06-07T15:18:14Z

channeldb/db.go

+			// Create a top level bucket which holds information
+			// about our node announcement.
+			number:    32,
+			migration: mig.CreateTLB(nodeAnnouncementBucket),


you dont need a migration to add a new bucket.

I removed it in another commit.

ellemouton · 2024-06-07T15:19:00Z

channeldb/db.go

@@ -520,9 +526,6 @@ type ChannelStateDB struct {
 	// linkNodeDB separates all DB operations on LinkNodes.
 	linkNodeDB *LinkNodeDB

-	// nodeAnnouncementDB seperates all DB operations on NodeAnnouncements.
-	nodeAnnouncementDb *NodeAnnouncementDB
-


this commit is removing a bunch of the code added in the previous commit - so it makes it very hard to grok what is actually happening in the PR. Maybe take some time to structure the commits in a more story-telling fashion 🙏

Thanks for taking the time to review. I will restructure the commits to facilitate the review process.

ellemouton · 2024-06-07T15:19:22Z

channeldb/db.go

-			// Create a top level bucket which holds information
-			// about our node announcement.
-			number:    32,
-			migration: mig.CreateTLB(nodeAnnouncementBucket),


if we remove this here, then no need to add it in the first place :)

I initially included this, but after @Chinwendu20 's review, I realized it was unnecessary. Therefore, I removed it here.

Good job @Abdulkbk, you can delete the commit then :) You can reach out to me on slack if you need help with it

channeldb: add persist nodeannounment config in db

b0815a1

In this commit, we save nodeannouncement config in the database so that we will be able to retrieve the config later and use them on retart Signed-off-by: Abdullahi Yunus <abdoollahikbk@gmail.com>

channeldb: check for persisted node announcement alias

d7719d8

In this commit, we check for nodeannouncement alias in the db before creating a disk representation of a node. If there none, we default to first 10 characters of our pubkey.

Abdulkbk marked this pull request as ready for review May 12, 2024 06:59

channeldb+lnd: check for persisted alias in disk

815e069

In this commit, we check for alias that are persisted in disk and use them when the node is restarting.

Abdulkbk mentioned this pull request May 26, 2024

[feature]: Allow persisting dynamic configured alias when not set in lnd.conf or arguments #7123

Open

Chinwendu20 reviewed May 28, 2024

View reviewed changes

channeldb/db.go Outdated Show resolved Hide resolved

channeldb/node.go Show resolved Hide resolved

ellemouton requested changes May 28, 2024

View reviewed changes

ellemouton reviewed May 28, 2024

View reviewed changes

Abdulkbk added 3 commits May 31, 2024 09:10

channeldb: remove migration for nodeannouncemnet bucket

75ffcaf

channeldb+peersrpc+lnd: save node announcement config whenever updated

03e2ac6

In this commit, we ensure new configurations are saved whenever node announcement is updated.

lnd: determine source for alias and color

31820dc

Here we try to determine the alias and color source for our node when starting. The hierarchy is config set in lnd.conf take precedence over persisted config and finally the default.

Abdulkbk added 3 commits June 4, 2024 14:42

test: test persisting and retrieving node announcement

9365f95

channeldb+peersrpc+lnd: save features and addresses to disk

371c12e

In this commit, we save the features and addresses assosciated with a node in the database, and use them when the node restarts.

channeldb: add test to compare local and persisted node announcement …

5899f80

…addresses

Abdulkbk requested review from ellemouton and Chinwendu20 June 7, 2024 13:43

ellemouton reviewed Jun 7, 2024

View reviewed changes

Abdulkbk mentioned this pull request Jun 10, 2024

lnd: use persisted node announcement data from previous runtime #8825

Open

8 tasks

Abdulkbk closed this Jun 10, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

channeldb: add persist nodeannounment config in db #8690

channeldb: add persist nodeannounment config in db #8690

Abdulkbk commented Apr 25, 2024 •

edited

coderabbitai bot commented Apr 25, 2024 •

edited

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

Chinwendu20 left a comment

ellemouton left a comment

ellemouton May 28, 2024

Abdulkbk Jun 3, 2024

ellemouton Jun 7, 2024

Abdulkbk Jun 8, 2024

Abdulkbk commented May 28, 2024

Abdulkbk commented Jun 3, 2024

ellemouton Jun 7, 2024

Abdulkbk Jun 7, 2024

ellemouton Jun 7, 2024

Abdulkbk Jun 7, 2024

ellemouton Jun 7, 2024

Abdulkbk Jun 7, 2024

Chinwendu20 Jun 8, 2024 •

edited

channeldb: add persist nodeannounment config in db #8690

channeldb: add persist nodeannounment config in db #8690

Conversation

Abdulkbk commented Apr 25, 2024 • edited

Change Description

Steps to Test

Pull Request Checklist

Testing

Code Style and Documentation

coderabbitai bot commented Apr 25, 2024 • edited

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

Chinwendu20 left a comment

Choose a reason for hiding this comment

ellemouton 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

Abdulkbk commented May 28, 2024

Abdulkbk commented Jun 3, 2024

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

Chinwendu20 Jun 8, 2024 • edited

Choose a reason for hiding this comment

Abdulkbk commented Apr 25, 2024 •

edited

coderabbitai bot commented Apr 25, 2024 •

edited

CodeRabbit Configration File (`.coderabbit.yaml`)

Chinwendu20 Jun 8, 2024 •

edited