ChannelInsights

List currently open channel with routing and uptime information.

Example request: http://localhost:8466/v1/faraday/insights

Source: faraday.proto

gRPC

rpc ChannelInsights (ChannelInsightsRequest) returns (ChannelInsightsResponse);

REST

HTTP Method	Path
GET	/v1/faraday/insights

Code Samples

gRPC

Javascript

const fs = require('fs');
const grpc = require('@grpc/grpc-js');
const protoLoader = require('@grpc/proto-loader');

const GRPC_HOST = 'localhost:8465'
const MACAROON_PATH = 'FARADAY_DIR/regtest/faraday.macaroon'
const TLS_PATH = 'FARADAY_DIR/tls.cert'

const loaderOptions = {
  keepCase: true,
  longs: String,
  enums: String,
  defaults: true,
  oneofs: true,
};
const packageDefinition = protoLoader.loadSync('faraday.proto', loaderOptions);
const frdrpc = grpc.loadPackageDefinition(packageDefinition).frdrpc;
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 frdrpc.FaradayServer(GRPC_HOST, creds);
let request = {};
client.channelInsights(request, function(err, response) {
  console.log(response);
});
// Console output:
//  {
//    "channel_insights": <ChannelInsight>,
//  }

Python

import codecs, grpc, os
# Generate the following 2 modules by compiling the faraday.proto with the grpcio-tools.
# See https://github.com/lightningnetwork/lnd/blob/master/docs/grpc/python.md for instructions.
import faraday_pb2 as frdrpc, faraday_pb2_grpc as faradaystub

GRPC_HOST = 'localhost:8465'
MACAROON_PATH = 'FARADAY_DIR/regtest/faraday.macaroon'
TLS_PATH = 'FARADAY_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 = faradaystub.FaradayServerStub(channel)
request = frdrpc.ChannelInsightsRequest()
response = stub.ChannelInsights(request)
print(response)
# {
#    "channel_insights": <ChannelInsight>,
# }

REST

Javascript

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

const REST_HOST = 'localhost:8082'
const MACAROON_PATH = 'FARADAY_DIR/regtest/faraday.macaroon'

let options = {
  url: `https://${REST_HOST}/v1/faraday/insights`,
  // 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:
//  {
//    "channel_insights": <array>, // <ChannelInsight> 
//  }

Python

import base64, codecs, json, requests

REST_HOST = 'localhost:8082'
MACAROON_PATH = 'FARADAY_DIR/regtest/faraday.macaroon'
TLS_PATH = 'FARADAY_DIR/tls.cert'

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

Shell

$ frcli insights --help

NAME:
   frcli insights - List currently open channel with routing and uptime information.

USAGE:
   frcli insights [arguments...]

CATEGORY:
   insights

Messages

frdrpc.ChannelInsightsRequest

Source: faraday.proto

note

This request has no parameters.

frdrpc.ChannelInsightsResponse

Source: faraday.proto

Field	gRPC Type	REST Type
channel_insights Insights for the set of currently open channels.	ChannelInsight[]	array

Nested Messages

frdrpc.ChannelInsight

Field	gRPC Type	REST Type
chan_point The outpoint of the channel's funding transaction.	string	string
monitored_seconds The amount of time in seconds that we have monitored the channel peer's uptime for.	uint64	string
uptime_seconds The amount of time in seconds that the channel peer has been online over the period it has been monitored for.	uint64	string
volume_incoming_msat The volume, in millisatoshis, that has been forwarded with this channel as the incoming channel.	int64	string
volume_outgoing_msat The volume, in millisatoshis, that has been forwarded with this channel as the outgoing channel.	int64	string
fees_earned_msat The total fees earned by this channel for its participation in forwards, expressed in millisatoshis. Note that we attribute fees evenly across incoming and outgoing channels.	int64	string
confirmations The number of confirmations the funding transaction has.	uint32	integer
private True if the channel is private.	bool	boolean