Policy

Policy returns the active watchtower client policy configuration.

Source: wtclientrpc/wtclient.proto

gRPC

rpc Policy (PolicyRequest) returns (PolicyResponse);

REST

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

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 = {
  policy_type: <PolicyType>,
};
client.policy(request, function(err, response) {
  console.log(response);
});
// Console output:
//  {
//    "max_updates": <uint32>,
//    "sweep_sat_per_byte": <uint32>,
//    "sweep_sat_per_vbyte": <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.PolicyRequest(
  policy_type=<PolicyType>,
)
response = stub.Policy(request)
print(response)
# {
#    "max_updates": <uint32>,
#    "sweep_sat_per_byte": <uint32>,
#    "sweep_sat_per_vbyte": <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/policy`,
  // 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:
//  {
//    "max_updates": <integer>, // <uint32> 
//    "sweep_sat_per_byte": <integer>, // <uint32> 
//    "sweep_sat_per_vbyte": <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/policy'
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())
# {
#    "max_updates": <uint32>,
#    "sweep_sat_per_byte": <uint32>,
#    "sweep_sat_per_vbyte": <uint32>,
# }

Shell

$ lncli wtclient policy --help

NAME:
   lncli wtclient policy - Display the active watchtower client policy configuration.

USAGE:
   lncli wtclient policy [command options] [arguments...]

OPTIONS:
   --legacy   Retrieve the legacy tower client's current policy. (default)
   --anchor   Retrieve the anchor tower client's current policy.
   --taproot  Retrieve the taproot tower client's current policy.
   

Messages

wtclientrpc.PolicyRequest

Source: wtclientrpc/wtclient.proto

Field	gRPC Type	REST Type	REST Placement
policy_type The client type from which to retrieve the active offering policy. Nested REST Parameters policy_type: string in query	PolicyType	object	query

wtclientrpc.PolicyResponse

Source: wtclientrpc/wtclient.proto

Field	gRPC Type	REST Type
max_updates The maximum number of updates each session we negotiate with watchtowers should allow.	uint32	integer
sweep_sat_per_bytedeprecated Deprecated, use sweep_sat_per_vbyte. The fee rate, in satoshis per vbyte, that will be used by watchtowers for justice transactions in response to channel breaches.	uint32	integer
sweep_sat_per_vbyte The fee rate, in satoshis per vbyte, that will be used by watchtowers for justice transactions in response to channel breaches.	uint32	integer

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