neutrinokitserver: Added unban peer feature #7606

Chinwendu20 · 2023-04-18T06:14:58Z

Change Description

Steps to Test

Connect to a node that does not serve compact filter. To simulate this. Ensure these options in the Bitcoin configuration file of the full node connected to neutrino are commented out or do not exist:

# blockfilterindex=1
# peerblockfilters=1

To confirm that your bitcoin node does not serve compact filters. Run this command:

bitcoin-cli getnetworkinfo

If your full node does not serve compact filter you should see this output:

In the output you should not see "COMPACT_FILTERS" in the "localservicesnames" key

Build lnd with tags, neutrinorpc.
Start lnd server.
You should see the full Bitcoin node gets banned in lnd logs:

Now, enable the full node to start serving compact filters. Change the bitcoin configuration file to start serving compact filters. Uncomment these options below:

blockfilterindex=1
peerblockfilters=1

Stop the bitcoin daemon and start again

bitcoin-cli stop

Then

bitcoind

To confirm that there is support for compact filters. Run this command:

bitcoin-cli getnetworkinfo

If your full node serves compact filters you should see this output:

There should be "COMPACT_FILTERS" in the "localservicesnames" key.

Notice your peer still does not get unbanned even though the full node has started serving compact filters. This is because banned peers wait the full ban duration which by default is currently 24 hrs To confirm that your peer is still banned. Run this command:

lncli --no-macaroons neutrino isbanned <bitcoin node address>

Example of bitcoin address could be 127.0.0.1:8766. Where 127.0.0.1 is the host IP address of your Bitcoin node and 8766 is the port not rpc port (It confused me at first, lol) of your bitcoin node. It is optional and if not specified the default port would be used. If you did not specify a port in your configuration file that is not the default port that should not be a problem.
Expected output:

To test the unbanPeer command. Run this command:

lncli  neutrino unbanPeer <peer address>

You should see the full Bitcoin node gets unbanned in lnd logs:

Notice your peer gets unbanned. To confirm this run this command:

lncli --no-macaroons neutrino isbanned <bitcoin address>

Expected output:

The peer has been unbanned and we do not have to wait for the ban duration period.

Associated PR in neutrino: lightninglabs/neutrino#270

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

ellemouton · 2023-04-20T08:02:43Z

Hi @Chinwendu20 - thanks for the PR

One thing that stands out from the commits is that you are making use off the new RPC endpoints before actually adding the proto definitions. This means that each commit individually will not compile - even though the end product might compile.
So you need to first add the proto definitions, then implement the methods on the server side, and then you can add the client code on the lncli side.

Please also take a closer look at our contribution guidelines for commit titles and messages.
I also see that the last commit fixes a mistake added in a prior commit - this should just be squashed so that the mistake never appears in the first place

Chinwendu20 · 2023-04-20T10:04:42Z

Thank you so much for the review, I would reset the commits and apply them again. I need clarity on the below

Are you asking that I should commit the proto changes first?
I have gone through the guideline for commit message and I think I followed the guideline of including, package first: commit message. Are you asking that I should make the commit message more detailed?

Thank you.

ellemouton · 2023-04-20T10:09:08Z

yes the proto changes should be committed first because otherwise your first commit (the lncli one) does not compile right?

see the detail here. package first, short description for the title (ideally under 50 chars) and then you can add as much detail as you like in the commit body.

Chinwendu20 · 2023-04-22T20:26:10Z

Hello @ellemouton I believe I have worked on review now.

docs/release-notes/release-notes-0.17.0.md

Chinwendu20 · 2023-04-24T10:13:17Z

I can see there are some merge commits as I was trying to update my branch. Would that be a problem? I am trying to figure out how to update my branch without creating merge commits.

ellemouton · 2023-04-24T10:16:39Z

Hi @Chinwendu20 - yes the merge commits need to please be removed. Perhaps take sometime looking into git fixup commits & how to autosquash them

guggero · 2023-04-24T10:17:31Z

I can see there are some merge commits as I was trying to update my branch. Would that be a problem? I am trying to figure out how to update my branch without creating merge commits.

What you are trying to do is called "rebasing". You want to rebase your local branch onto the latest version of master, that removes any merge commits and fixes conflicts. Here's a guide I found that explains rebases: https://www.freecodecamp.org/news/the-ultimate-guide-to-git-merge-and-git-rebase/

Chinwendu20 · 2023-04-24T10:32:55Z

So helpful, thanks a lot @guggero
Thank you @ellemouton

Chinwendu20 · 2023-04-24T11:26:25Z

Is there a command to update the neutrino.yaml? Or I would have to do that manually

guggero · 2023-04-24T11:42:55Z

Is there a command to update the neutrino.yaml? Or I would have to do that manually

That file needs to be edited manually. It will then be used to generate some more code when running make rpc.

My suggestion for the new RPC would be:

    - selector: neutrinorpc.NeutrinoKit.UnBanPeer
      post: "/v2/neutrino/unban/{peer_address}"
      body: "*"

This requires you to change peerAddress to peer_address in UnBanPeerRequest (since we use snake case in protobuf files).

lightninglabs-deploy · 2023-10-30T00:16:05Z

Closing due to inactivity

lightninglabs-deploy · 2023-10-30T01:18:52Z

Closing due to inactivity

lightninglabs-deploy · 2023-10-30T02:22:20Z

Closing due to inactivity

lightninglabs-deploy · 2023-10-30T03:24:02Z

Closing due to inactivity

lightninglabs-deploy · 2023-10-30T04:27:05Z

Closing due to inactivity

lightninglabs-deploy · 2023-10-30T05:30:07Z

Closing due to inactivity

lightninglabs-deploy · 2023-10-30T06:34:30Z

Closing due to inactivity

lightninglabs-deploy · 2023-10-30T07:37:29Z

Closing due to inactivity

lightninglabs-deploy · 2023-10-30T08:38:58Z

Closing due to inactivity

lightninglabs-deploy · 2023-10-30T09:43:20Z

Closing due to inactivity

yyforyongyu · 2023-10-30T09:45:33Z

!lightninglabs-deploy mute

coderabbitai · 2024-05-21T13:35:51Z

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.

ellemouton

Nice and clean! Almost there 👍

ellemouton · 2024-06-10T15:28:11Z

cmd/lncli/neutrino_active.go

@@ -225,6 +225,51 @@ func getCFilter(ctx *cli.Context) error {
 	return nil
 }

+var unbanPeerCommand = cli.Command{
+	Name:        "unbanPeer",


s/unbanPeer/unbanpeer

Thanks just that unban and peer are two separate words so I was following the convention

yeah but see how the other commands are done, for example addpeer

ellemouton · 2024-06-10T15:32:52Z

lnrpc/neutrinorpc/neutrino.proto

+
+    // Indicates if the peer to be unbanned should be connected as a
+    // permanent peer.
+    bool permanent = 2;


can we make the name more descriptive? maybe something like perm_connect? just a suggestion.

ellemouton · 2024-06-10T15:33:33Z

cmd/lncli/neutrino_active.go

+	Action:      actionDecorator(unbanPeer),
+	Flags: []cli.Flag{
+		cli.BoolFlag{
+			Name: "permanent",


maybe permconnect or something to make it more clear this has to do with how we connect to the peer?

I will change to permconnect, thanks.

ellemouton · 2024-06-10T15:37:17Z

cmd/lncli/neutrino_active.go

+	// Display the command's help message if we do not have the expected
+	// number of arguments/flags.
+	if ctx.NArg() != 1 || ctx.NumFlags() > 1 {
+		return cli.ShowCommandHelp(ctx, "unbanpeer")


this doesnt work cause it doesnt match the command name. Suggest changing the command name to this though

Nice catch, thanks!

ellemouton · 2024-06-10T15:38:00Z

cmd/lncli/neutrino_active.go

+	},
+}
+
+func unbanPeer(ctx *cli.Context) error {


suggest: unbanNeutrinoPeer

ellemouton · 2024-06-10T15:39:48Z

cmd/lncli/neutrino_active.go

+			Name: "permanent",
+			Usage: "indicates if the peer to be unbanned should " +
+				"be connected as a permanent peer. If set, " +
+				"it connects as a permanent peer",


nit: the second sentence isnt needed imo. It just repeats the first sentence

ellemouton · 2024-06-10T15:40:07Z

docs/release-notes/release-notes-0.18.0.md

+* [Added unbanPeer command](https://github.com/lightningnetwork/lnd/pull/7606/). 
+  This would enable unbanning and connecting to a previously banned peer using 
+  the lncli command.
+


can move these to 0.18.1 now :)

ellemouton · 2024-06-10T15:40:43Z

go.mod

@@ -208,3 +208,5 @@ replace google.golang.org/protobuf => github.com/lightninglabs/protobuf-go-hex-d
 go 1.21.4

 retract v0.0.2
+
+replace github.com/lightninglabs/neutrino => github.com/Chinwendu20/neutrino v0.0.0-20240514174050-3275e33e5504


can point to the merge commit instead now so that the ci can run against latest version 👍

ellemouton · 2024-06-10T15:44:37Z

lnrpc/neutrinorpc/neutrino.proto

+message UnbanPeerResponse {
+}


i think the general pattern we are aiming towards with responses is to include a string status so that the user sees some sort of success message instead of just an empty JSON struct.

See message BumpFeeResponse { for an example of this

Chinwendu20 · 2024-06-11T22:39:02Z

Hello @ellemouton thanks a lot for the review, dropped a comment here: lightninglabs/neutrino#253 (comment)

Signed-off-by: Ononiwu Maureen <amaka013@gmail.com>

Example usage: lncli neutrino unBanPeer <peer node address> Signed-off-by: Ononiwu Maureen <amaka013@gmail.com>

Signed-off-by: Ononiwu Maureen <59079323+Chinwendu20@users.noreply.github.com>

Chinwendu20 mentioned this pull request Apr 18, 2023

neutrino: Added unban peer feature lightninglabs/neutrino#270

Closed

Chinwendu20 marked this pull request as draft April 18, 2023 06:36

Chinwendu20 force-pushed the addUnBan branch from d04a685 to e1d0f69 Compare April 19, 2023 16:15

Chinwendu20 changed the title ~~[WIP]neutrinokitserver: Added unban peer feature~~ neutrinokitserver: Added unban peer feature Apr 19, 2023

Chinwendu20 marked this pull request as ready for review April 19, 2023 16:32

Chinwendu20 force-pushed the addUnBan branch 2 times, most recently from 98ad4fb to 5c88b17 Compare April 19, 2023 17:42

Chinwendu20 force-pushed the addUnBan branch 2 times, most recently from e8fe58a to 8bfca7e Compare April 22, 2023 20:25

ellemouton reviewed Apr 24, 2023

View reviewed changes

docs/release-notes/release-notes-0.17.0.md Outdated Show resolved Hide resolved

Chinwendu20 force-pushed the addUnBan branch from 8582645 to 77a2fd1 Compare April 24, 2023 09:45

Chinwendu20 requested a review from ellemouton April 24, 2023 10:14

ellemouton removed their request for review April 24, 2023 10:17

Chinwendu20 force-pushed the addUnBan branch from 77a2fd1 to 87175a4 Compare April 24, 2023 10:31

Chinwendu20 force-pushed the addUnBan branch from 87175a4 to c5682e3 Compare April 25, 2023 06:07

Chinwendu20 force-pushed the addUnBan branch from 44100a5 to 9dc4eeb Compare May 21, 2024 13:35

Chinwendu20 force-pushed the addUnBan branch 3 times, most recently from 318b7fd to 37bd866 Compare May 22, 2024 11:05

Chinwendu20 requested a review from ellemouton May 22, 2024 13:29

Chinwendu20 mentioned this pull request May 23, 2024

Added unban peer feature lightninglabs/neutrino#286

Merged

ellemouton reviewed Jun 10, 2024

View reviewed changes

Chinwendu20 force-pushed the addUnBan branch 2 times, most recently from 9b88479 to b4437e8 Compare June 12, 2024 10:41

Chinwendu20 and others added 5 commits June 12, 2024 14:48

mod: bumped neutrino package

24e5897

Signed-off-by: Ononiwu Maureen <amaka013@gmail.com>

lnrpc: UnbanPeer RPC added to neutrino.proto

35c3437

Signed-off-by: Ononiwu Maureen <amaka013@gmail.com>

lnrpc: Implemented UnbanPeer RPC function

74b5110

Signed-off-by: Ononiwu Maureen <amaka013@gmail.com>

cmd: Add "unbanpeer" lncli command.

6fc61e2

Example usage: lncli neutrino unBanPeer <peer node address> Signed-off-by: Ononiwu Maureen <amaka013@gmail.com>

docs: Added release note

71ad555

Signed-off-by: Ononiwu Maureen <59079323+Chinwendu20@users.noreply.github.com>

Chinwendu20 force-pushed the addUnBan branch from b4437e8 to 71ad555 Compare June 12, 2024 13:49

Chinwendu20 requested a review from ellemouton June 12, 2024 15:39

ellemouton removed their request for review August 12, 2024 06:58

neutrinokitserver: Added unban peer feature #7606

Are you sure you want to change the base?

neutrinokitserver: Added unban peer feature #7606

Conversation

Chinwendu20 commented Apr 18, 2023 • edited Loading

Change Description

Steps to Test

Pull Request Checklist

Testing

Code Style and Documentation

ellemouton commented Apr 20, 2023 • edited Loading

Chinwendu20 commented Apr 20, 2023 • edited Loading

ellemouton commented Apr 20, 2023

Chinwendu20 commented Apr 22, 2023

Chinwendu20 commented Apr 24, 2023

ellemouton commented Apr 24, 2023

guggero commented Apr 24, 2023

Chinwendu20 commented Apr 24, 2023

Chinwendu20 commented Apr 24, 2023

guggero commented Apr 24, 2023

lightninglabs-deploy commented Oct 30, 2023

lightninglabs-deploy commented Oct 30, 2023

lightninglabs-deploy commented Oct 30, 2023

lightninglabs-deploy commented Oct 30, 2023

lightninglabs-deploy commented Oct 30, 2023

lightninglabs-deploy commented Oct 30, 2023

lightninglabs-deploy commented Oct 30, 2023

lightninglabs-deploy commented Oct 30, 2023

lightninglabs-deploy commented Oct 30, 2023

lightninglabs-deploy commented Oct 30, 2023

yyforyongyu commented Oct 30, 2023

coderabbitai bot commented May 21, 2024 • edited Loading

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

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

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Chinwendu20 commented Jun 11, 2024

Chinwendu20 commented Apr 18, 2023 •

edited

Loading

ellemouton commented Apr 20, 2023 •

edited

Loading

Chinwendu20 commented Apr 20, 2023 •

edited

Loading

coderabbitai bot commented May 21, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)