Update comments for watchtower interface methods

Author: Jontified

wtclient_client.go

@@ -13,22 +13,40 @@ import (
 type WatchtowerClientClient interface {
 	ServiceClient[wtclientrpc.WatchtowerClientClient]
 
+	// AddTower adds a new watchtower reachable at the given address and
+	// considers it for new sessions. If the watchtower already exists, then
+	// any new addresses included will be considered when dialing it for
+	// session negotiations and backups.
 	AddTower(ctx context.Context, pubkey []byte, address string) error
 
-	// Sets the given tower's status to inactive so that it's not considered
-	// for session negotiation. Returns a human readable status string.
+	// DeactivateTower sets the given tower's status to inactive so that it
+	// is not considered for session negotiation. Its sessions will also not
+	// be used while the tower is inactive.
 	DeactivateTower(ctx context.Context, pubkey []byte) (string, error)
 
+	// GetTowerInfo gets information about a watchtower that corresponds to the
+	// given pubkey. The `includeSessions` flag controls whether session information is
+	// included. The `excludeExhaustedSessions` controls whether exhausted sessions
+	// are included in the response.
 	GetTowerInfo(ctx context.Context, pubkey []byte, includeSessions,
 		excludeExhaustedSessions bool) (*wtclientrpc.Tower, error)
 
+	// ListTowers gets information about all registered watchtowers. The
+	// `includeSessions` and `excludeExhaustedSessions` flags serve the same function as
+	// in the `GetTowerInfo` method.
 	ListTowers(ctx context.Context, includeSessions,
 		excludeExhaustedSessions bool) ([]*wtclientrpc.Tower, error)
 
+	// Policy returns the active watchtower client policy configuration.
 	Policy(ctx context.Context, policyType wtclientrpc.PolicyType) (*PolicyResponse, error)
 
+	// RemoveTower removes a watchtower from being considered for future session
+	// negotiations and from being used for any subsequent backups until it's added
+	// again. If an address is provided, then this RPC only serves as a way of
+	// removing the address from the watchtower instead.
 	RemoveTower(ctx context.Context, pubkey []byte, address string) error
 
+	// Stats returns the in-memory statistics of the client since startup.
 	Stats(ctx context.Context) (*StatsResponse, error)
 
 	// Terminates the given session and marks it to not be used for backups
@@ -83,10 +101,10 @@ func (m *wtClientClient) RawClientWithMacAuth(
 	return m.wtClientMac.WithMacaroonAuth(parentCtx), m.timeout, m.client
 }
 
-// AddTower adds a new watchtower reachable at the given address and considers
-// it for new sessions. If the watchtower already exists, then any new addresses
-// included will be considered when dialing it for session negotiations and
-// backups.
+// AddTower adds a new watchtower reachable at the given address and
+// considers it for new sessions. If the watchtower already exists, then
+// any new addresses included will be considered when dialing it for
+// session negotiations and backups.
 func (m *wtClientClient) AddTower(ctx context.Context, pubkey []byte, address string) error {
 	rpcCtx, cancel := context.WithTimeout(ctx, m.timeout)
 	defer cancel()
@@ -105,9 +123,9 @@ func (m *wtClientClient) AddTower(ctx context.Context, pubkey []byte, address st
 	return nil
 }
 
-// DeactivateTower sets the given tower's status to inactive so that it is not
-// considered for session negotiation. Its sessions will also not be used while
-// the tower is inactive.
+// DeactivateTower sets the given tower's status to inactive so that it
+// is not considered for session negotiation. Its sessions will also not
+// be used while the tower is inactive.
 func (m *wtClientClient) DeactivateTower(ctx context.Context, pubkey []byte) (string, error) {
 	rpcCtx, cancel := context.WithTimeout(ctx, m.timeout)
 	defer cancel()
@@ -226,8 +244,8 @@ func (m *wtClientClient) Stats(ctx context.Context) (*StatsResponse, error) {
 	}, nil
 }
 
-// Terminate terminates the given session and marks it as terminal so that it is
-// not used for backups anymore.
+// Terminates the given session and marks it to not be used for backups
+// anymore. Returns a human readable status string.
 func (m *wtClientClient) TerminateSession(ctx context.Context, sessionId []byte) (string, error) {
 	rpcCtx, cancel := context.WithTimeout(ctx, m.timeout)
 	defer cancel()