Skip to main content

Policy

Policy returns the active watchtower client policy configuration.

Source: wtclientrpc/wtclient.proto

gRPC

rpc Policy (PolicyRequest) returns (PolicyResponse);

REST

HTTP MethodPath
GET /v2/watchtower/client/policy

Code Samples

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>,
// }

Messages

wtclientrpc.PolicyRequest

Source: wtclientrpc/wtclient.proto

FieldgRPC TypeREST TypeREST Placement
policy_type
PolicyTypeobjectquery

wtclientrpc.PolicyResponse

Source: wtclientrpc/wtclient.proto

FieldgRPC TypeREST Type
max_updates
uint32integer
sweep_sat_per_byte
uint32integer
sweep_sat_per_vbyte
uint32integer

Enums

wtclientrpc.PolicyType

NameNumber
LEGACY
0
ANCHOR
1