Skip to main content

ListAliases

ListAliases returns the set of all aliases that have ever existed with their confirmed SCID (if it exists) and/or the base SCID (in the case of zero conf).

Source: lightning.proto

gRPC

rpc ListAliases (ListAliasesRequest) returns (ListAliasesResponse);

REST

HTTP MethodPath
GET /v1/aliases/list

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 = {};
client.listAliases(request, function(err, response) {
console.log(response);
});
// Console output:
// {
// "alias_maps": <AliasMap>,
// }

Messages

lnrpc.ListAliasesRequest

Source: lightning.proto

note

This request has no parameters.

lnrpc.ListAliasesResponse

Source: lightning.proto

FieldgRPC TypeREST Type
alias_maps
AliasMap[]array

Nested Messages

lnrpc.AliasMap

FieldgRPC TypeREST Type
base_scid
uint64string
aliases
uint64[]array