Skip to main content

ListAccounts

ListAccounts retrieves all accounts belonging to the wallet by default. A name and key scope filter can be provided to filter through all of the wallet accounts and return only those matching.

Source: walletrpc/walletkit.proto

gRPC

rpc ListAccounts (ListAccountsRequest) returns (ListAccountsResponse);

REST

HTTP MethodPath
GET /v2/wallet/accounts

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', 'walletrpc/walletkit.proto'], loaderOptions);
const walletrpc = grpc.loadPackageDefinition(packageDefinition).walletrpc;
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 walletrpc.WalletKit(GRPC_HOST, creds);
let request = {
name: <string>,
address_type: <AddressType>,
};
client.listAccounts(request, function(err, response) {
console.log(response);
});
// Console output:
// {
// "accounts": <Account>,
// }

Messages

walletrpc.ListAccountsRequest

Source: walletrpc/walletkit.proto

FieldgRPC TypeREST TypeREST Placement
name
stringstringquery
address_type
AddressTypeobjectquery

walletrpc.ListAccountsResponse

Source: walletrpc/walletkit.proto

FieldgRPC TypeREST Type
accounts
Account[]array

Nested Messages

walletrpc.Account

FieldgRPC TypeREST Type
name
stringstring
address_type
AddressTypestring
extended_public_key
stringstring
master_key_fingerprint
bytesstring
derivation_path
stringstring
external_key_count
uint32integer
internal_key_count
uint32integer
watch_only
boolboolean

Enums

walletrpc.AddressType

NameNumber
UNKNOWN
0
WITNESS_PUBKEY_HASH
1
NESTED_WITNESS_PUBKEY_HASH
2
HYBRID_NESTED_WITNESS_PUBKEY_HASH
3
TAPROOT_PUBKEY
4