Skip to main content

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 MethodPath
GET /v2/autopilot/scores

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

Messages

autopilotrpc.QueryScoresRequest

Source: autopilotrpc/autopilot.proto

FieldgRPC TypeREST TypeREST Placement
pubkeys
string[]arrayquery
ignore_local_state
boolbooleanquery

autopilotrpc.QueryScoresResponse

Source: autopilotrpc/autopilot.proto

FieldgRPC TypeREST Type
results
HeuristicResult[]array

Nested Messages

autopilotrpc.QueryScoresResponse.HeuristicResult

FieldgRPC TypeREST Type
heuristic
stringunknown
scores
ScoresEntry[]unknown

autopilotrpc.QueryScoresResponse.HeuristicResult.ScoresEntry

FieldgRPC TypeREST Type
key
stringunknown
value
doubleunknown