Skip to main content

ListLeases

ListLeases lists all currently locked utxos.

Source: walletrpc/walletkit.proto

gRPC

rpc ListLeases (ListLeasesRequest) returns (ListLeasesResponse);

REST

HTTP MethodPath
POST /v2/wallet/utxos/leases

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

Messages

walletrpc.ListLeasesRequest

Source: walletrpc/walletkit.proto

note

This request has no parameters.

walletrpc.ListLeasesResponse

Source: walletrpc/walletkit.proto

FieldgRPC TypeREST Type
locked_utxos
UtxoLease[]array

Nested Messages

walletrpc.UtxoLease

FieldgRPC TypeREST Type
id
bytesstring
outpoint
OutPointobject
expiration
uint64string
pk_script
bytesstring
value
uint64string

lnrpc.OutPoint

FieldgRPC TypeREST Type
txid_bytes
bytesstring
txid_str
stringstring
output_index
uint32integer