RequestInstantLoopOut

RequestInstantLoopOut initiates an instant loop out swap.

Source: instantout.proto

gRPC

rpc RequestInstantLoopOut (InstantLoopOutRequest) returns (InstantLoopOutResponse);

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('instantout.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.InstantSwapServer(GRPC_HOST, creds);
let request = {
  receiver_key: <bytes>,
  swap_hash: <bytes>,
  expiry: <int32>,
  htlc_fee_rate: <uint64>,
  reservation_ids: <bytes>,
  protocol_version: <InstantOutProtocolVersion>,
};
client.requestInstantLoopOut(request, function(err, response) {
  console.log(response);
});
// Console output:
//  {
//    "swap_invoice": <string>,
//    "sender_key": <bytes>,
//  }

Python

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

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 = instantoutstub.InstantSwapServerStub(channel)
request = looprpc.InstantLoopOutRequest(
  receiver_key=<bytes>,
  swap_hash=<bytes>,
  expiry=<int32>,
  htlc_fee_rate=<uint64>,
  reservation_ids=<bytes>,
  protocol_version=<InstantOutProtocolVersion>,
)
response = stub.RequestInstantLoopOut(request)
print(response)
# {
#    "swap_invoice": <string>,
#    "sender_key": <bytes>,
# }

Shell

# There is no CLI command for this RPC

Messages

looprpc.InstantLoopOutRequest

Source: instantout.proto

Field	gRPC Type	REST Type	REST Placement
receiver_key Htlc related fields: The key for the htlc preimage spending path.	bytes	unknown	unknown
swap_hash The hash of the preimage that will be used to settle the htlc.	bytes	unknown	unknown
expiry The requested absolute block height of the on-chain htlc. This is subjected to min and max constraints as reported in the LoopOutTerms response.	int32	unknown	unknown
htlc_fee_rate The fee rate in sat/kw that should be used for the htlc.	uint64	unknown	unknown
reservation_ids The reservations used as the inputs.	bytes[]	unknown	unknown
protocol_version The protocol version to use for the swap.	InstantOutProtocolVersion	unknown	unknown

looprpc.InstantLoopOutResponse

Source: instantout.proto

Field	gRPC Type	REST Type
swap_invoice The swap invoice that the client should pay.	string	unknown
sender_key the key for the htlc expiry path.	bytes	unknown

Enums

looprpc.InstantOutProtocolVersion

Name	Number
INSTANTOUT_NONE	0
INSTANTOUT_FULL_RESERVATION	1