Skip to main content

ListUnspent

ListUnspent returns a list of all utxos spendable by the wallet with a number of confirmations between the specified minimum and maximum. By default, all utxos are listed. To list only the unconfirmed utxos, set the unconfirmed_only to true.

Source: walletrpc/walletkit.proto

gRPC

rpc ListUnspent (ListUnspentRequest) returns (ListUnspentResponse);

REST

HTTP MethodPath
POST /v2/wallet/utxos

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 = {
min_confs: <int32>,
max_confs: <int32>,
account: <string>,
unconfirmed_only: <bool>,
};
client.listUnspent(request, function(err, response) {
console.log(response);
});
// Console output:
// {
// "utxos": <Utxo>,
// }

Messages

walletrpc.ListUnspentRequest

Source: walletrpc/walletkit.proto

FieldgRPC TypeREST TypeREST Placement
min_confs
int32integerbody
max_confs
int32integerbody
account
stringstringbody
unconfirmed_only
boolbooleanbody

walletrpc.ListUnspentResponse

Source: walletrpc/walletkit.proto

FieldgRPC TypeREST Type
utxos
Utxo[]array

Nested Messages

lnrpc.Utxo

FieldgRPC TypeREST Type
address_type
AddressTypestring
address
stringstring
amount_sat
int64string
pk_script
stringstring
outpoint
OutPointobject
confirmations
int64string

lnrpc.OutPoint

FieldgRPC TypeREST Type
txid_bytes
bytesstring
txid_str
stringstring
output_index
uint32integer

Enums

lnrpc.AddressType

NameNumber
WITNESS_PUBKEY_HASH
0
NESTED_PUBKEY_HASH
1
UNUSED_WITNESS_PUBKEY_HASH
2
UNUSED_NESTED_PUBKEY_HASH
3
TAPROOT_PUBKEY
4
UNUSED_TAPROOT_PUBKEY
5