EstimateFee

EstimateFee attempts to query the internal fee estimator of the wallet to determine the fee (in sat/kw) to attach to a transaction in order to achieve the confirmation target.

Source: walletrpc/walletkit.proto

gRPC

rpc EstimateFee (EstimateFeeRequest) returns (EstimateFeeResponse);

REST

HTTP Method	Path
GET	/v2/wallet/estimatefee/{conf_target}

Code Samples

gRPC

Javascript

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', 'walletrpc/walletkit.proto'], loaderOptions);
const walletrpc = grpc.loadPackageDefinition(packageDefinition).walletrpc;
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 walletrpc.WalletKit(GRPC_HOST, creds);
let request = {
  conf_target: <int32>,
};
client.estimateFee(request, function(err, response) {
  console.log(response);
});
// Console output:
//  {
//    "sat_per_kw": <int64>,
//    "min_relay_fee_sat_per_kw": <int64>,
//  }

Python

import codecs, grpc, os
# Generate the following 2 modules by compiling the walletrpc/walletkit.proto with the grpcio-tools.
# See https://github.com/lightningnetwork/lnd/blob/master/docs/grpc/python.md for instructions.
import walletkit_pb2 as walletrpc, walletkit_pb2_grpc as walletkitstub

GRPC_HOST = 'localhost:10009'
MACAROON_PATH = 'LND_DIR/data/chain/bitcoin/regtest/admin.macaroon'
TLS_PATH = 'LND_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 = walletkitstub.WalletKitStub(channel)
request = walletrpc.EstimateFeeRequest(
  conf_target=<int32>,
)
response = stub.EstimateFee(request)
print(response)
# {
#    "sat_per_kw": <int64>,
#    "min_relay_fee_sat_per_kw": <int64>,
# }

REST

Javascript

const fs = require('fs');
const request = require('request');

const REST_HOST = 'localhost:8080'
const MACAROON_PATH = 'LND_DIR/data/chain/bitcoin/regtest/admin.macaroon'

let options = {
  url: `https://${REST_HOST}/v2/wallet/estimatefee/{conf_target}`,
  // Work-around for self-signed certificates.
  rejectUnauthorized: false,
  json: true,
  headers: {
    'Grpc-Metadata-macaroon': fs.readFileSync(MACAROON_PATH).toString('hex'),
  },
}
request.get(options, function(error, response, body) {
  console.log(body);
});
// Console output:
//  {
//    "sat_per_kw": <string>, // <int64> 
//    "min_relay_fee_sat_per_kw": <string>, // <int64> 
//  }

Python

import base64, codecs, json, requests

REST_HOST = 'localhost:8080'
MACAROON_PATH = 'LND_DIR/data/chain/bitcoin/regtest/admin.macaroon'
TLS_PATH = 'LND_DIR/tls.cert'

url = f'https://{REST_HOST}/v2/wallet/estimatefee/{conf_target}'
macaroon = codecs.encode(open(MACAROON_PATH, 'rb').read(), 'hex')
headers = {'Grpc-Metadata-macaroon': macaroon}
r = requests.get(url, headers=headers, verify=TLS_PATH)
print(r.json())
# {
#    "sat_per_kw": <int64>,
#    "min_relay_fee_sat_per_kw": <int64>,
# }

Shell

$ lncli wallet estimatefeerate --help

NAME:
   lncli wallet estimatefeerate - Estimates the on-chain fee rate to achieve a confirmation target.

USAGE:
   lncli wallet estimatefeerate conf_target

DESCRIPTION:
   
  Returns the fee rate estimate for on-chain transactions in sat/kw and
  sat/vb to achieve a given confirmation target. The source of the fee
  rate depends on the configuration and is either the on-chain backend or
  alternatively an external URL.
  

Messages

walletrpc.EstimateFeeRequest

Source: walletrpc/walletkit.proto

Field	gRPC Type	REST Type	REST Placement
conf_target The number of confirmations to shoot for when estimating the fee.	int32	integer	path

walletrpc.EstimateFeeResponse

Source: walletrpc/walletkit.proto

Field	gRPC Type	REST Type
sat_per_kw The amount of satoshis per kw that should be used in order to reach the confirmation target in the request.	int64	string
min_relay_fee_sat_per_kw The current minimum relay fee based on our chain backend in sat/kw.	int64	string