Skip to main content

Status

Status returns the status of the light client neutrino instance, along with height and hash of the best block, and a list of connected peers.

Source: neutrinorpc/neutrino.proto

gRPC

rpc Status (StatusRequest) returns (StatusResponse);

REST

HTTP MethodPath
GET /v2/neutrino/status

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', 'neutrinorpc/neutrino.proto'], loaderOptions);
const neutrinorpc = grpc.loadPackageDefinition(packageDefinition).neutrinorpc;
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 neutrinorpc.NeutrinoKit(GRPC_HOST, creds);
let request = {};
client.status(request, function(err, response) {
console.log(response);
});
// Console output:
// {
// "active": <bool>,
// "synced": <bool>,
// "block_height": <int32>,
// "block_hash": <string>,
// "peers": <string>,
// }

Messages

neutrinorpc.StatusRequest

Source: neutrinorpc/neutrino.proto

note

This request has no parameters.

neutrinorpc.StatusResponse

Source: neutrinorpc/neutrino.proto

FieldgRPC TypeREST Type
active
boolboolean
synced
boolboolean
block_height
int32integer
block_hash
stringstring
peers
string[]array