Skip to main content

EstimateRouteFee

EstimateRouteFee allows callers to obtain a lower bound w.r.t how much it may cost to send an HTLC to the target end destination.

Source: routerrpc/router.proto

gRPC

rpc EstimateRouteFee (RouteFeeRequest) returns (RouteFeeResponse);

REST

HTTP MethodPath
POST /v2/router/route/estimatefee

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', 'routerrpc/router.proto'], loaderOptions);
const routerrpc = grpc.loadPackageDefinition(packageDefinition).routerrpc;
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 routerrpc.Router(GRPC_HOST, creds);
let request = {
dest: <bytes>,
amt_sat: <int64>,
};
client.estimateRouteFee(request, function(err, response) {
console.log(response);
});
// Console output:
// {
// "routing_fee_msat": <int64>,
// "time_lock_delay": <int64>,
// }

Messages

routerrpc.RouteFeeRequest

Source: routerrpc/router.proto

FieldgRPC TypeREST TypeREST Placement
dest
bytesstringbody
amt_sat
int64stringbody

routerrpc.RouteFeeResponse

Source: routerrpc/router.proto

FieldgRPC TypeREST Type
routing_fee_msat
int64string
time_lock_delay
int64string