Add WatchtowerClient interface #235

Jontified · 2025-08-01T14:29:35Z

Pull Request Checklist

PR is opened against correct version branch.
Version compatibility matrix in the README and minimal required version
in lnd_services.go are updated.
Update macaroon_recipes.go if your PR adds a new method that is called
differently than the RPC method it invokes.

This PR adds the WatchtowerClient interface. The reason for adding this is so that it can be used in lndmon in a way described here: lightninglabs/lndmon#118

Jontified · 2025-08-19T12:42:05Z

This PR should be ready for review now. This lndmon PR uses the changes in this PR, check if out to get some context if needed.

bitromortac · 2025-08-20T12:17:30Z

This PR should be ready for review now. This lndmon PR uses the changes in this PR, check if out to get some context if needed.

Thank you for this contribution 👍. I took an initial look and the approach looks good. Could you please change your commit structure such that it complies with the dev guidelines (see https://github.com/lightningnetwork/lnd/blob/master/docs/development_guidelines.md)? Specifically, squashing your commits to only contain the essential operations (1. adding the interface/implementation, 2. change of the server name parsing, 3. adding the service). I'd take another look afterwards.

Jontified · 2025-08-21T10:31:31Z

This PR should be ready for review now. This lndmon PR uses the changes in this PR, check if out to get some context if needed.

Thank you for this contribution 👍. I took an initial look and the approach looks good. Could you please change your commit structure such that it complies with the dev guidelines (see https://github.com/lightningnetwork/lnd/blob/master/docs/development_guidelines.md)? Specifically, squashing your commits to only contain the essential operations (1. adding the interface/implementation, 2. change of the server name parsing, 3. adding the service). I'd take another look afterwards.

OK! Commit structure should be good now!

bitromortac

Thank you for the changes! There are still some style nits left. I have also added some rules that we require to the linter. Could you rebase your PR onto #238 such that the linter can give hints?

wtclient_client.go

Jontified · 2025-08-26T12:50:45Z

Thank you for the changes! There are still some style nits left. I have also added some rules that we require to the linter. Could you rebase your PR onto #238 such that the linter can give hints?

Rebased and fixed the various linter complaints relevant to this PR.

bitromortac

Thank you for the updates, this looks close. I'll test the dependent PR in lndmon next once you have this feedback in.

wtclient_client.go

bitromortac

Thank you, I still have some minor suggestions, but after that it looks good to go 🙏

wtclient_client.go

bitromortac · 2025-08-28T09:20:37Z

wtclient_client.go

+	timeout     time.Duration
+}
+
+// A compile time check to ensure that  wtClientClient implements the


nit: double space before wtClientClient

final nit: wtClientClient wasn't updated in the comment, you can address this after the other reviewer's feedback

Use strings.TrimSuffix instead of strings.ReplaceAll in the macaroon recipe code. This is necessary because the WtClient macaroon name contains the word "client" and would be malformed in the old code. New code just removes the last "client". Signed-off-by: Jonathan <[email protected]>

Add the wtclient_client.go file which contains the lnd watchtower client interface. Signed-off-by: Jonathan <[email protected]>

Add the watchtower client service to the macaroon recipe and to the main lnd services.

bitromortac

LGTM 🎉. Thank you for addressing the feedback so quickly 👍

Edit: there are still some linter errors left to be fixed

hieblmi

Great effort, thank you for your contribution!

The linter is currently failing due to lll issues and I flagged some minor nits.
Once CI is green this LGTM!

hieblmi · 2025-09-02T09:39:00Z

wtclient_client.go

+	Stats(ctx context.Context) (*wtclientrpc.StatsResponse, error)
+
+	// TerminateSession terminates the given session and marks it to not be
+	// used for backups anymore. Returns a human readable status string.


nit: human-readable

hieblmi · 2025-09-02T09:40:47Z

wtclient_client.go

+
+// newClientClient creates a new watchtower client interface.
+func newWtClient(conn grpc.ClientConnInterface,
+	wtClientMac serializedMacaroon, timeout time.Duration) *wtClient {


nit: wtClientMac fits in line before.

hieblmi · 2025-09-02T09:48:15Z

wtclient_client.go

+}
+
+// Stats returns the in-memory statistics of the client since startup.
+func (m *wtClient) Stats(ctx context.Context) (*wtclientrpc.StatsResponse, error) {


nit: break line

hieblmi · 2025-09-02T09:48:44Z

wtclient_client.go

+
+// Policy returns the active watchtower client policy configuration.
+func (m *wtClient) Policy(ctx context.Context,
+	policyType wtclientrpc.PolicyType) (*wtclientrpc.PolicyResponse, error) {


nit: break line

hieblmi · 2025-09-02T09:49:32Z

wtclient_client.go

+
+// WatchtowerClientClient implements the watchtower client interface
+// https://lightning.engineering/api-docs/category/watchtowerclient-service/
+// NOTE: For the macaroon code to work correctly this needs to be named


nit: correctly,

Jontified marked this pull request as draft August 4, 2025 07:00

This was referenced Aug 19, 2025

Add watchtower client number of backup metrics Jontified/lndmon#1

Merged

Add watchtower client number of backup metrics lightninglabs/lndmon#120

Open

Jontified force-pushed the master branch 2 times, most recently from f11e493 to 4a32fb0 Compare August 19, 2025 12:39

Jontified marked this pull request as ready for review August 19, 2025 12:40

Jontified force-pushed the master branch from 4a32fb0 to c89ce69 Compare August 21, 2025 10:30

Jontified force-pushed the master branch 2 times, most recently from 1d132d1 to cbfd3b6 Compare August 21, 2025 15:04

bitromortac self-requested a review August 21, 2025 16:20

bitromortac reviewed Aug 25, 2025

View reviewed changes

wtclient_client.go Show resolved Hide resolved

Jontified force-pushed the master branch 2 times, most recently from e9158a1 to ebe05a0 Compare August 26, 2025 12:49

bitromortac self-requested a review August 26, 2025 13:07

bitromortac reviewed Aug 27, 2025

View reviewed changes

wtclient_client.go Outdated Show resolved Hide resolved

wtclient_client.go Outdated Show resolved Hide resolved

Jontified force-pushed the master branch from ebe05a0 to 87b9bb7 Compare August 27, 2025 12:21

bitromortac reviewed Aug 28, 2025

View reviewed changes

Jontified added 3 commits August 28, 2025 14:07

lndclient: Add watchtower client interface

dc0908d

Add the wtclient_client.go file which contains the lnd watchtower client interface. Signed-off-by: Jonathan <[email protected]>

lndclient: Add the watchtower client service

c3f10fc

Add the watchtower client service to the macaroon recipe and to the main lnd services.

Jontified force-pushed the master branch from 87b9bb7 to c3f10fc Compare August 28, 2025 12:08

hieblmi self-requested a review August 29, 2025 09:57

bitromortac approved these changes Aug 29, 2025

View reviewed changes

hieblmi reviewed Sep 2, 2025

View reviewed changes

Add WatchtowerClient interface #235

Are you sure you want to change the base?

Add WatchtowerClient interface #235

Conversation

Jontified commented Aug 1, 2025

Pull Request Checklist

Uh oh!

Jontified commented Aug 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bitromortac commented Aug 20, 2025

Uh oh!

Jontified commented Aug 21, 2025

Uh oh!

bitromortac left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Jontified commented Aug 26, 2025

Uh oh!

bitromortac left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

bitromortac left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

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!

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

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

Jontified commented Aug 19, 2025 •

edited

Loading

bitromortac left a comment •

edited

Loading