QueryScores

QueryScores queries all available autopilot heuristics, in addition to any active combination of these heruristics, for the scores they would give to the given nodes.

Source: autopilotrpc/autopilot.proto

gRPC

rpc QueryScores (QueryScoresRequest) returns (QueryScoresResponse);

REST

HTTP Method	Path
GET	/v2/autopilot/scores

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', 'autopilotrpc/autopilot.proto'], loaderOptions);
const autopilotrpc = grpc.loadPackageDefinition(packageDefinition).autopilotrpc;
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 autopilotrpc.Autopilot(GRPC_HOST, creds);
let request = {
  pubkeys: <string>,
  ignore_local_state: <bool>,
};
client.queryScores(request, function(err, response) {
  console.log(response);
});
// Console output:
//  {
//    "results": <HeuristicResult>,
//  }

Python

import codecs, grpc, os
# Generate the following 2 modules by compiling the autopilotrpc/autopilot.proto with the grpcio-tools.
# See https://github.com/lightningnetwork/lnd/blob/master/docs/grpc/python.md for instructions.
import autopilot_pb2 as autopilotrpc, autopilot_pb2_grpc as autopilotstub

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 = autopilotstub.AutopilotStub(channel)
request = autopilotrpc.QueryScoresRequest(
  pubkeys=<string>,
  ignore_local_state=<bool>,
)
response = stub.QueryScores(request)
print(response)
# {
#    "results": <HeuristicResult>,
# }

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/autopilot/scores`,
  // 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:
//  {
//    "results": <array>, // <HeuristicResult> 
//  }

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/autopilot/scores'
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())
# {
#    "results": <HeuristicResult>,
# }

Shell

$ lncli autopilot query --help

NAME:
   lncli autopilot query - Query the autopilot heuristics for nodes' scores.

USAGE:
   lncli autopilot query [command options] [flags] <pubkey> <pubkey> <pubkey> ...

OPTIONS:
   --ignorelocalstate, -i  Ignore local channel state when calculating scores.
   

Messages

autopilotrpc.QueryScoresRequest

Source: autopilotrpc/autopilot.proto

Field	gRPC Type	REST Type	REST Placement
pubkeys	string[]	array	query
ignore_local_state If set, we will ignore the local channel state when calculating scores.	bool	boolean	query

autopilotrpc.QueryScoresResponse

Source: autopilotrpc/autopilot.proto

Field	gRPC Type	REST Type
results	HeuristicResult[]	array

Nested Messages

autopilotrpc.QueryScoresResponse.HeuristicResult

Field	gRPC Type	REST Type
heuristic	string	unknown
scores	ScoresEntry[]	unknown

autopilotrpc.QueryScoresResponse.HeuristicResult.ScoresEntry

Field	gRPC Type	REST Type
key	string	unknown
value	double	unknown