FeeReport

FeeReport allows the caller to obtain a report detailing the current fee schedule enforced by the node globally for each channel.

Source: lightning.proto

gRPC

rpc FeeReport (FeeReportRequest) returns (FeeReportResponse);

REST

HTTP Method	Path
GET	/v1/fees

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', 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 = {};
client.feeReport(request, function(err, response) {
  console.log(response);
});
// Console output:
//  {
//    "channel_fees": <ChannelFeeReport>,
//    "day_fee_sum": <uint64>,
//    "week_fee_sum": <uint64>,
//    "month_fee_sum": <uint64>,
//  }

Python

import codecs, grpc, os
# Generate the following 2 modules by compiling the lightning.proto with the grpcio-tools.
# See https://github.com/lightningnetwork/lnd/blob/master/docs/grpc/python.md for instructions.
import lightning_pb2 as lnrpc, lightning_pb2_grpc as lightningstub

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 = lightningstub.LightningStub(channel)
request = lnrpc.FeeReportRequest()
response = stub.FeeReport(request)
print(response)
# {
#    "channel_fees": <ChannelFeeReport>,
#    "day_fee_sum": <uint64>,
#    "week_fee_sum": <uint64>,
#    "month_fee_sum": <uint64>,
# }

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}/v1/fees`,
  // 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:
//  {
//    "channel_fees": <array>, // <ChannelFeeReport> 
//    "day_fee_sum": <string>, // <uint64> 
//    "week_fee_sum": <string>, // <uint64> 
//    "month_fee_sum": <string>, // <uint64> 
//  }

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}/v1/fees'
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())
# {
#    "channel_fees": <ChannelFeeReport>,
#    "day_fee_sum": <uint64>,
#    "week_fee_sum": <uint64>,
#    "month_fee_sum": <uint64>,
# }

Shell

$ lncli feereport --help

NAME:
   lncli feereport - Display the current fee policies of all active channels.

USAGE:
   lncli feereport [arguments...]

CATEGORY:
   Channels

DESCRIPTION:
   
  Returns the current fee policies of all active channels.
  Fee policies can be updated using the updatechanpolicy command.

Messages

lnrpc.FeeReportRequest

Source: lightning.proto

note

This request has no parameters.

lnrpc.FeeReportResponse

Source: lightning.proto

Field	gRPC Type	REST Type
channel_fees An array of channel fee reports which describes the current fee schedule for each channel.	ChannelFeeReport[]	array
day_fee_sum The total amount of fee revenue (in satoshis) the switch has collected over the past 24 hrs.	uint64	string
week_fee_sum The total amount of fee revenue (in satoshis) the switch has collected over the past 1 week.	uint64	string
month_fee_sum The total amount of fee revenue (in satoshis) the switch has collected over the past 1 month.	uint64	string

Nested Messages

lnrpc.ChannelFeeReport

Field	gRPC Type	REST Type
chan_id The short channel id that this fee report belongs to.	uint64	string
channel_point The channel that this fee report belongs to.	string	string
base_fee_msat The base fee charged regardless of the number of milli-satoshis sent.	int64	string
fee_per_mil The amount charged per milli-satoshis transferred expressed in millionths of a satoshi.	int64	string
fee_rate The effective fee rate in milli-satoshis. Computed by dividing the fee_per_mil value by 1 million.	double	number