Skip to main content

LoopOutQuote

LoopOutQuote returns a quote for a loop out swap with the provided parameters.

Source: looprpc/client.proto

gRPC

rpc LoopOutQuote (QuoteRequest) returns (OutQuoteResponse);

REST

HTTP MethodPath
GET /v1/loop/out/quote/{amt}

Code Samples

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 = {
amt: <int64>,
conf_target: <int32>,
external_htlc: <bool>,
swap_publication_deadline: <uint64>,
loop_in_last_hop: <bytes>,
loop_in_route_hints: <RouteHint>,
private: <bool>,
};
client.loopOutQuote(request, function(err, response) {
console.log(response);
});
// Console output:
// {
// "swap_fee_sat": <int64>,
// "prepay_amt_sat": <int64>,
// "htlc_sweep_fee_sat": <int64>,
// "swap_payment_dest": <bytes>,
// "cltv_delta": <int32>,
// "conf_target": <int32>,
// }

Messages

looprpc.QuoteRequest

Source: looprpc/client.proto

FieldgRPC TypeREST TypeREST Placement
amt
int64stringpath
conf_target
int32integerquery
external_htlc
boolbooleanquery
swap_publication_deadline
uint64stringquery
loop_in_last_hop
bytesstringquery
loop_in_route_hints
RouteHint[]objectunknown
private
boolbooleanquery

looprpc.OutQuoteResponse

Source: looprpc/client.proto

FieldgRPC TypeREST Type
swap_fee_sat
int64string
prepay_amt_sat
int64string
htlc_sweep_fee_sat
int64string
swap_payment_dest
bytesstring
cltv_delta
int32integer
conf_target
int32integer