Skip to main content

SubServerStatus

Source: lit-status.proto

gRPC

rpc SubServerStatus (SubServerStatusReq) returns (SubServerStatusResp);

REST

HTTP MethodPath
GET /v1/status

Code Samples

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

Messages

litrpc.SubServerStatusReq

Source: lit-status.proto

note

This request has no parameters.

litrpc.SubServerStatusResp

Source: lit-status.proto

FieldgRPC TypeREST Type
sub_servers
SubServersEntry[]object

Nested Messages

litrpc.SubServerStatus

FieldgRPC TypeREST Type
disabled
boolboolean
running
boolboolean
error
stringstring
custom_status
stringstring

litrpc.SubServerStatusResp.SubServersEntry

FieldgRPC TypeREST Type
key
stringunknown
value
SubServerStatusunknown