Skip to main content

ListPeers

ListPeers returns a verbose listing of all currently active peers.

Source: lightning.proto

gRPC

rpc ListPeers (ListPeersRequest) returns (ListPeersResponse);

REST

HTTP MethodPath
GET /v1/peers

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', loaderOptions);
const lnrpc = grpc.loadPackageDefinition(packageDefinition).lnrpc;
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 lnrpc.Lightning(GRPC_HOST, creds);
let request = {
latest_error: <bool>,
};
client.listPeers(request, function(err, response) {
console.log(response);
});
// Console output:
// {
// "peers": <Peer>,
// }

Messages

lnrpc.ListPeersRequest

Source: lightning.proto

FieldgRPC TypeREST TypeREST Placement
latest_error
boolbooleanquery

lnrpc.ListPeersResponse

Source: lightning.proto

FieldgRPC TypeREST Type
peers
Peer[]array

Nested Messages

lnrpc.Peer

FieldgRPC TypeREST Type
pub_key
stringstring
address
stringstring
bytes_sent
uint64string
bytes_recv
uint64string
sat_sent
int64string
sat_recv
int64string
inbound
boolboolean
ping_time
int64string
sync_type
SyncTypestring
features
FeaturesEntry[]object
errors
TimestampedError[]array
flap_count
int32integer
last_flap_ns
int64string
last_ping_payload
bytesstring

lnrpc.Peer.FeaturesEntry

FieldgRPC TypeREST Type
key
uint32unknown
value
Featureunknown

lnrpc.Feature

FieldgRPC TypeREST Type
name
stringstring
is_required
boolboolean
is_known
boolboolean

lnrpc.TimestampedError

FieldgRPC TypeREST Type
timestamp
uint64string
error
stringstring

Enums

lnrpc.Peer.SyncType

NameNumber
UNKNOWN_SYNC
0
ACTIVE_SYNC
1
PASSIVE_SYNC
2
PINNED_SYNC
3