ReservationNotificationStream

ReservationNotificationStream is a server side stream that sends notifications if the server wants to open a reservation to the client.

Source: reservation.proto

gRPC

info

This is a server-streaming RPC

rpc ReservationNotificationStream (ReservationNotificationRequest) returns (stream ServerReservationNotification);

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('reservation.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.ReservationService(GRPC_HOST, creds);
let request = {
  protocol_version: <ReservationProtocolVersion>,
};
let call = client.reservationNotificationStream(request);
call.on('data', function(response) {
  // A response was received from the server.
  console.log(response);
});
call.on('status', function(status) {
  // The current status of the stream.
});
call.on('end', function() {
  // The server has closed the stream.
});
// Console output:
//  {
//    "reservation_id": <bytes>,
//    "value": <uint64>,
//    "server_key": <bytes>,
//    "expiry": <uint32>,
//    "protocol_version": <ReservationProtocolVersion>,
//  }

Python

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

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 = reservationstub.ReservationServiceStub(channel)
request = looprpc.ReservationNotificationRequest(
  protocol_version=<ReservationProtocolVersion>,
)
for response in stub.ReservationNotificationStream(request):
  print(response)
# {
#    "reservation_id": <bytes>,
#    "value": <uint64>,
#    "server_key": <bytes>,
#    "expiry": <uint32>,
#    "protocol_version": <ReservationProtocolVersion>,
# }

Shell

# There is no CLI command for this RPC

Messages

looprpc.ReservationNotificationRequest

Source: reservation.proto

Field	gRPC Type	REST Type	REST Placement
protocol_version protocol_version is the maximum version the client supports.	ReservationProtocolVersion	unknown	unknown

looprpc.ServerReservationNotification

Source: reservation.proto

Field	gRPC Type	REST Type
reservation_id reservation_id is the id of the reservation.	bytes	unknown
value value is the value of the reservation in satoshis.	uint64	unknown
server_key server_key is the public key of the server.	bytes	unknown
expiry expiry is the absolute expiry of the reservation.	uint32	unknown
protocol_version protocol_version is the version of the reservation protocol.	ReservationProtocolVersion	unknown

Enums

looprpc.ReservationProtocolVersion

Name	Number
RESERVATION_NONE RESERVATION_NONE is the default value and means that the reservation protocol version is not set.	0
RESERVATION_SERVER_NOTIFY RESERVATION_SERVER_NOTIFY is the first version of the reservation protocol where the server notifies the client about a reservation.	1