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 Method	Path
GET	/v2/neutrino/status

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

Python

import codecs, grpc, os
# Generate the following 2 modules by compiling the neutrinorpc/neutrino.proto with the grpcio-tools.
# See https://github.com/lightningnetwork/lnd/blob/master/docs/grpc/python.md for instructions.
import neutrino_pb2 as neutrinorpc, neutrino_pb2_grpc as neutrinostub

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 = neutrinostub.NeutrinoKitStub(channel)
request = neutrinorpc.StatusRequest()
response = stub.Status(request)
print(response)
# {
#    "active": <bool>,
#    "synced": <bool>,
#    "block_height": <int32>,
#    "block_hash": <string>,
#    "peers": <string>,
# }

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/neutrino/status`,
  // 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:
//  {
//    "active": <boolean>, // <bool> 
//    "synced": <boolean>, // <bool> 
//    "block_height": <integer>, // <int32> 
//    "block_hash": <string>, // <string> 
//    "peers": <array>, // <string> 
//  }

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/neutrino/status'
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())
# {
#    "active": <bool>,
#    "synced": <bool>,
#    "block_height": <int32>,
#    "block_hash": <string>,
#    "peers": <string>,
# }

Shell

# There is no CLI command for this RPC

Messages

neutrinorpc.StatusRequest

Source: neutrinorpc/neutrino.proto

note

This request has no parameters.

neutrinorpc.StatusResponse

Source: neutrinorpc/neutrino.proto

Field	gRPC Type	REST Type
active Indicates whether the neutrino backend is active or not.	bool	boolean
synced Is fully synced.	bool	boolean
block_height Best block height.	int32	integer
block_hash Best block hash.	string	string
peers Connected peers.	string[]	array