Skip to main content

EstimateFee

EstimateFee asks the chain backend to estimate the fee rate and total fees for a transaction that pays to multiple specified outputs.

When using REST, the AddrToAmount map type can be set by appending &AddrToAmount[<address>]=<amount_to_send> to the URL. Unfortunately this map type doesn't appear in the REST API documentation because of a bug in the grpc-gateway library.

Source: lightning.proto

gRPC

rpc EstimateFee (EstimateFeeRequest) returns (EstimateFeeResponse);

REST

HTTP MethodPath
GET /v1/transactions/fee

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', loaderOptions);
const lnrpc = grpc.loadPackageDefinition(packageDefinition).lnrpc;
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 lnrpc.Lightning(GRPC_HOST, creds);
let request = {
AddrToAmount: <AddrToAmountEntry>,
target_conf: <int32>,
min_confs: <int32>,
spend_unconfirmed: <bool>,
};
client.estimateFee(request, function(err, response) {
console.log(response);
});
// Console output:
// {
// "fee_sat": <int64>,
// "feerate_sat_per_byte": <int64>,
// "sat_per_vbyte": <uint64>,
// }

Messages

lnrpc.EstimateFeeRequest

Source: lightning.proto

FieldgRPC TypeREST TypeREST Placement
AddrToAmount
AddrToAmountEntry[]objectunknown
target_conf
int32integerquery
min_confs
int32integerquery
spend_unconfirmed
boolbooleanquery

lnrpc.EstimateFeeResponse

Source: lightning.proto

FieldgRPC TypeREST Type
fee_sat
int64string
feerate_sat_per_byte
int64string
sat_per_vbyte
uint64string

Nested Messages

lnrpc.EstimateFeeRequest.AddrToAmountEntry

FieldgRPC TypeREST Type
key
stringunknown
value
int64unknown