ListReservations

ListReservations returns a list of all reservations the server opened to us.

Source: looprpc/client.proto

gRPC

rpc ListReservations (ListReservationsRequest) returns (ListReservationsResponse);

Code Samples

gRPC

Javascript

const fs = require('fs');
const grpc = require('@grpc/grpc-js');
const protoLoader = require('@grpc/proto-loader');

const GRPC_HOST = 'localhost:11010'
const MACAROON_PATH = 'LOOP_DIR/regtest/loop.macaroon'
const TLS_PATH = 'LOOP_DIR/tls.cert'

const loaderOptions = {
  keepCase: true,
  longs: String,
  enums: String,
  defaults: true,
  oneofs: true,
};
const packageDefinition = protoLoader.loadSync('looprpc/client.proto', loaderOptions);
const looprpc = grpc.loadPackageDefinition(packageDefinition).looprpc;
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 looprpc.SwapClient(GRPC_HOST, creds);
let request = {};
client.listReservations(request, function(err, response) {
  console.log(response);
});
// Console output:
//  {
//    "reservations": <ClientReservation>,
//  }

Python

import codecs, grpc, os
# Generate the following 2 modules by compiling the looprpc/client.proto with the grpcio-tools.
# See https://github.com/lightningnetwork/lnd/blob/master/docs/grpc/python.md for instructions.
import client_pb2 as looprpc, client_pb2_grpc as clientstub

GRPC_HOST = 'localhost:11010'
MACAROON_PATH = 'LOOP_DIR/regtest/loop.macaroon'
TLS_PATH = 'LOOP_DIR/tls.cert'

# create macaroon credentials
macaroon = codecs.encode(open(MACAROON_PATH, 'rb').read(), 'hex')
def metadata_callback(context, callback):
  callback([('macaroon', macaroon)], None)
auth_creds = grpc.metadata_call_credentials(metadata_callback)
# create SSL credentials
os.environ['GRPC_SSL_CIPHER_SUITES'] = 'HIGH+ECDSA'
cert = open(TLS_PATH, 'rb').read()
ssl_creds = grpc.ssl_channel_credentials(cert)
# combine macaroon and SSL credentials
combined_creds = grpc.composite_channel_credentials(ssl_creds, auth_creds)
# make the request
channel = grpc.secure_channel(GRPC_HOST, combined_creds)
stub = clientstub.SwapClientStub(channel)
request = looprpc.ListReservationsRequest()
response = stub.ListReservations(request)
print(response)
# {
#    "reservations": <ClientReservation>,
# }

Shell

# There is no CLI command for this RPC

Messages

looprpc.ListReservationsRequest

Source: looprpc/client.proto

note

This request has no parameters.

looprpc.ListReservationsResponse

Source: looprpc/client.proto

Field	gRPC Type	REST Type
reservations The list of all currently known reservations and their status.	ClientReservation[]	array

Nested Messages

looprpc.ClientReservation

Field	gRPC Type	REST Type
reservation_id The reservation id that identifies this reservation.	bytes	string
state The state the reservation is in.	string	string
amount The amount that the reservation is for.	uint64	string
tx_id The transaction id of the reservation.	string	string
vout The vout of the reservation.	uint32	integer
expiry The expiry of the reservation.	uint32	integer