GetTowerInfo

GetTowerInfo retrieves information for a registered watchtower.

Source: wtclientrpc/wtclient.proto

gRPC

rpc GetTowerInfo (GetTowerInfoRequest) returns (Tower);

REST

HTTP Method	Path
GET	/v2/watchtower/client/info/{pubkey}

Code Samples

gRPC

Javascript

const fs = require('fs');
const grpc = require('@grpc/grpc-js');
const protoLoader = require('@grpc/proto-loader');

const GRPC_HOST = 'localhost:10009'
const MACAROON_PATH = 'LND_DIR/data/chain/bitcoin/regtest/admin.macaroon'
const TLS_PATH = 'LND_DIR/tls.cert'

const loaderOptions = {
  keepCase: true,
  longs: String,
  enums: String,
  defaults: true,
  oneofs: true,
};
const packageDefinition = protoLoader.loadSync(['lightning.proto', 'wtclientrpc/wtclient.proto'], loaderOptions);
const wtclientrpc = grpc.loadPackageDefinition(packageDefinition).wtclientrpc;
process.env.GRPC_SSL_CIPHER_SUITES = 'HIGH+ECDSA';
const tlsCert = fs.readFileSync(TLS_PATH);
const sslCreds = grpc.credentials.createSsl(tlsCert);
const macaroon = fs.readFileSync(MACAROON_PATH).toString('hex');
const macaroonCreds = grpc.credentials.createFromMetadataGenerator(function(args, callback) {
  let metadata = new grpc.Metadata();
  metadata.add('macaroon', macaroon);
  callback(null, metadata);
});
let creds = grpc.credentials.combineChannelCredentials(sslCreds, macaroonCreds);
let client = new wtclientrpc.WatchtowerClient(GRPC_HOST, creds);
let request = {
  pubkey: <bytes>,
  include_sessions: <bool>,
  exclude_exhausted_sessions: <bool>,
};
client.getTowerInfo(request, function(err, response) {
  console.log(response);
});
// Console output:
//  {
//    "pubkey": <bytes>,
//    "addresses": <string>,
//    "active_session_candidate": <bool>,
//    "num_sessions": <uint32>,
//    "sessions": <TowerSession>,
//    "session_info": <TowerSessionInfo>,
//  }

Python

import codecs, grpc, os
# Generate the following 2 modules by compiling the wtclientrpc/wtclient.proto with the grpcio-tools.
# See https://github.com/lightningnetwork/lnd/blob/master/docs/grpc/python.md for instructions.
import wtclient_pb2 as wtclientrpc, wtclient_pb2_grpc as wtclientstub

GRPC_HOST = 'localhost:10009'
MACAROON_PATH = 'LND_DIR/data/chain/bitcoin/regtest/admin.macaroon'
TLS_PATH = 'LND_DIR/tls.cert'

# create macaroon credentials
macaroon = codecs.encode(open(MACAROON_PATH, 'rb').read(), 'hex')
def metadata_callback(context, callback):
  callback([('macaroon', macaroon)], None)
auth_creds = grpc.metadata_call_credentials(metadata_callback)
# create SSL credentials
os.environ['GRPC_SSL_CIPHER_SUITES'] = 'HIGH+ECDSA'
cert = open(TLS_PATH, 'rb').read()
ssl_creds = grpc.ssl_channel_credentials(cert)
# combine macaroon and SSL credentials
combined_creds = grpc.composite_channel_credentials(ssl_creds, auth_creds)
# make the request
channel = grpc.secure_channel(GRPC_HOST, combined_creds)
stub = wtclientstub.WatchtowerClientStub(channel)
request = wtclientrpc.GetTowerInfoRequest(
  pubkey=<bytes>,
  include_sessions=<bool>,
  exclude_exhausted_sessions=<bool>,
)
response = stub.GetTowerInfo(request)
print(response)
# {
#    "pubkey": <bytes>,
#    "addresses": <string>,
#    "active_session_candidate": <bool>,
#    "num_sessions": <uint32>,
#    "sessions": <TowerSession>,
#    "session_info": <TowerSessionInfo>,
# }

REST

Javascript

const fs = require('fs');
const request = require('request');

const REST_HOST = 'localhost:8080'
const MACAROON_PATH = 'LND_DIR/data/chain/bitcoin/regtest/admin.macaroon'

let options = {
  url: `https://${REST_HOST}/v2/watchtower/client/info/{pubkey}`,
  // Work-around for self-signed certificates.
  rejectUnauthorized: false,
  json: true,
  headers: {
    'Grpc-Metadata-macaroon': fs.readFileSync(MACAROON_PATH).toString('hex'),
  },
}
request.get(options, function(error, response, body) {
  console.log(body);
});
// Console output:
//  {
//    "pubkey": <string>, // <bytes> 
//    "addresses": <array>, // <string> 
//    "active_session_candidate": <boolean>, // <bool> 
//    "num_sessions": <integer>, // <uint32> 
//    "sessions": <array>, // <TowerSession> 
//    "session_info": <array>, // <TowerSessionInfo> 
//  }

Python

import base64, codecs, json, requests

REST_HOST = 'localhost:8080'
MACAROON_PATH = 'LND_DIR/data/chain/bitcoin/regtest/admin.macaroon'
TLS_PATH = 'LND_DIR/tls.cert'

url = f'https://{REST_HOST}/v2/watchtower/client/info/{pubkey}'
macaroon = codecs.encode(open(MACAROON_PATH, 'rb').read(), 'hex')
headers = {'Grpc-Metadata-macaroon': macaroon}
r = requests.get(url, headers=headers, verify=TLS_PATH)
print(r.json())
# {
#    "pubkey": <bytes>,
#    "addresses": <string>,
#    "active_session_candidate": <bool>,
#    "num_sessions": <uint32>,
#    "sessions": <TowerSession>,
#    "session_info": <TowerSessionInfo>,
# }

Shell

$ lncli wtclient tower --help

NAME:
   lncli wtclient tower - Display information about a specific registered watchtower.

USAGE:
   lncli wtclient tower [command options] pubkey

OPTIONS:
   --include_sessions            include sessions with the watchtower in the response
   --exclude_exhausted_sessions  Whether to exclude exhausted sessions in the response info. This option is only meaningful if include_sessions is true
   

Messages

wtclientrpc.GetTowerInfoRequest

Source: wtclientrpc/wtclient.proto

Field	gRPC Type	REST Type	REST Placement
pubkey The identifying public key of the watchtower to retrieve information for.	bytes	string	path
include_sessions Whether we should include sessions with the watchtower in the response.	bool	boolean	query
exclude_exhausted_sessions Whether to exclude exhausted sessions in the response info. This option is only meaningful if include_sessions is true.	bool	boolean	query

wtclientrpc.Tower

Source: wtclientrpc/wtclient.proto

Field	gRPC Type	REST Type
pubkey The identifying public key of the watchtower.	bytes	string
addresses The list of addresses the watchtower is reachable over.	string[]	array
active_session_candidatedeprecated Deprecated, use the active_session_candidate field under the correct identifier in the client_type map. Whether the watchtower is currently a candidate for new sessions.	bool	boolean
num_sessionsdeprecated Deprecated, use the num_sessions field under the correct identifier in the client_type map. The number of sessions that have been negotiated with the watchtower.	uint32	integer
sessionsdeprecated Deprecated, use the sessions field under the correct identifier in the client_type map. The list of sessions that have been negotiated with the watchtower.	TowerSession[]	array
session_info A list sessions held with the tower.	TowerSessionInfo[]	array

Nested Messages

wtclientrpc.TowerSession

Field	gRPC Type	REST Type
num_backups The total number of successful backups that have been made to the watchtower session.	uint32	integer
num_pending_backups The total number of backups in the session that are currently pending to be acknowledged by the watchtower.	uint32	integer
max_backups The maximum number of backups allowed by the watchtower session.	uint32	integer
sweep_sat_per_bytedeprecated Deprecated, use sweep_sat_per_vbyte. The fee rate, in satoshis per vbyte, that will be used by the watchtower for the justice transaction in the event of a channel breach.	uint32	integer
sweep_sat_per_vbyte The fee rate, in satoshis per vbyte, that will be used by the watchtower for the justice transaction in the event of a channel breach.	uint32	integer
id The ID of the session.	bytes	string

wtclientrpc.TowerSessionInfo

Field	gRPC Type	REST Type
active_session_candidate Whether the watchtower is currently a candidate for new sessions.	bool	boolean
num_sessions The number of sessions that have been negotiated with the watchtower.	uint32	integer
sessions The list of sessions that have been negotiated with the watchtower.	TowerSession[]	array
policy_type The session's policy type.	PolicyType	string

Enums

wtclientrpc.PolicyType

Name	Number
LEGACY Selects the policy from the legacy tower client.	0
ANCHOR Selects the policy from the anchor tower client.	1
TAPROOT Selects the policy from the taproot tower client.	2