Stats

Stats returns the in-memory statistics of the client since startup.

Source: wtclientrpc/wtclient.proto

gRPC

rpc Stats (StatsRequest) returns (StatsResponse);

REST

HTTP Method	Path
GET	/v2/watchtower/client/stats

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 = {};
client.stats(request, function(err, response) {
  console.log(response);
});
// Console output:
//  {
//    "num_backups": <uint32>,
//    "num_pending_backups": <uint32>,
//    "num_failed_backups": <uint32>,
//    "num_sessions_acquired": <uint32>,
//    "num_sessions_exhausted": <uint32>,
//  }

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.StatsRequest()
response = stub.Stats(request)
print(response)
# {
#    "num_backups": <uint32>,
#    "num_pending_backups": <uint32>,
#    "num_failed_backups": <uint32>,
#    "num_sessions_acquired": <uint32>,
#    "num_sessions_exhausted": <uint32>,
# }

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/stats`,
  // 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:
//  {
//    "num_backups": <integer>, // <uint32> 
//    "num_pending_backups": <integer>, // <uint32> 
//    "num_failed_backups": <integer>, // <uint32> 
//    "num_sessions_acquired": <integer>, // <uint32> 
//    "num_sessions_exhausted": <integer>, // <uint32> 
//  }

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/stats'
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())
# {
#    "num_backups": <uint32>,
#    "num_pending_backups": <uint32>,
#    "num_failed_backups": <uint32>,
#    "num_sessions_acquired": <uint32>,
#    "num_sessions_exhausted": <uint32>,
# }

Shell

# There is no CLI command for this RPC

Messages

wtclientrpc.StatsRequest

Source: wtclientrpc/wtclient.proto

note

This request has no parameters.

wtclientrpc.StatsResponse

Source: wtclientrpc/wtclient.proto

Field	gRPC Type	REST Type
num_backups The total number of backups made to all active and exhausted watchtower sessions.	uint32	integer
num_pending_backups The total number of backups that are pending to be acknowledged by all active and exhausted watchtower sessions.	uint32	integer
num_failed_backups The total number of backups that all active and exhausted watchtower sessions have failed to acknowledge.	uint32	integer
num_sessions_acquired The total number of new sessions made to watchtowers.	uint32	integer
num_sessions_exhausted The total number of watchtower sessions that have been exhausted.	uint32	integer