SubServerStatus

Source: lit-status.proto

gRPC

rpc SubServerStatus (SubServerStatusReq) returns (SubServerStatusResp);

REST

HTTP Method	Path
GET	/v1/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:8443'
const MACAROON_PATH = 'LIT_DIR/regtest/lit.macaroon'
const TLS_PATH = 'LIT_DIR/tls.cert'

const loaderOptions = {
  keepCase: true,
  longs: String,
  enums: String,
  defaults: true,
  oneofs: true,
};
const packageDefinition = protoLoader.loadSync('lit-status.proto', loaderOptions);
const litrpc = grpc.loadPackageDefinition(packageDefinition).litrpc;
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 litrpc.Status(GRPC_HOST, creds);
let request = {};
client.subServerStatus(request, function(err, response) {
  console.log(response);
});
// Console output:
//  {
//    "sub_servers": <SubServersEntry>,
//  }

Python

import codecs, grpc, os
# Generate the following 2 modules by compiling the lit-status.proto with the grpcio-tools.
# See https://github.com/lightningnetwork/lnd/blob/master/docs/grpc/python.md for instructions.
import lit-status_pb2 as litrpc, lit-status_pb2_grpc as lit-statusstub

GRPC_HOST = 'localhost:8443'
MACAROON_PATH = 'LIT_DIR/regtest/lit.macaroon'
TLS_PATH = 'LIT_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 = lit-statusstub.StatusStub(channel)
request = litrpc.SubServerStatusReq()
response = stub.SubServerStatus(request)
print(response)
# {
#    "sub_servers": <SubServersEntry>,
# }

REST

Javascript

const fs = require('fs');
const request = require('request');

const REST_HOST = 'localhost:8443'
const MACAROON_PATH = 'LIT_DIR/regtest/lit.macaroon'

let options = {
  url: `https://${REST_HOST}/v1/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:
//  {
//    "sub_servers": <object>, // <SubServersEntry> 
//  }

Python

import base64, codecs, json, requests

REST_HOST = 'localhost:8443'
MACAROON_PATH = 'LIT_DIR/regtest/lit.macaroon'
TLS_PATH = 'LIT_DIR/tls.cert'

url = f'https://{REST_HOST}/v1/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())
# {
#    "sub_servers": <SubServersEntry>,
# }

Shell

# There is no CLI command for this RPC

Messages

litrpc.SubServerStatusReq

Source: lit-status.proto

note

This request has no parameters.

litrpc.SubServerStatusResp

Source: lit-status.proto

Field	gRPC Type	REST Type
sub_servers A map of sub-server names to their status.	SubServersEntry[]	object

Nested Messages

litrpc.SubServerStatus

Field	gRPC Type	REST Type
disabled disabled is true if the sub-server is available in the LiT package but has explicitly been disabled.	bool	boolean
running running is true if the sub-server is currently running.	bool	boolean
error error describes an error that might have resulted in the sub-server not starting up properly.	string	string
custom_status custom_status details a custom state that the sub-server has entered, which is unique to the sub-server, and which is not the standard disabled, running or errored state.	string	string

litrpc.SubServerStatusResp.SubServersEntry

Field	gRPC Type	REST Type
key	string	unknown
value	SubServerStatus	unknown