lightning/lnd_methods/offchain/get_routing_fee_estimate.d.ts

Lightning Network client library

import {AuthenticatedLnd} from '../../lnd_grpc';
import {
    AuthenticatedLightningArgs,
    AuthenticatedLightningMethod
} from '../../typescript';

export type GetRoutingFeeEstimateRequest = AuthenticatedLightningArgs<{
    lnd: AuthenticatedLnd;
    /** BOLT 11 Encoded Payment Request */
    request: string;
    /** Optional Timeout in Milliseconds */
    timeout?: number;
}>;

export type GetRoutingFeeEstimateResponse = {
    /** (Minimum Routing Fee Millitokens) */
    fee_mtokens: string;
    /** Timeout (Time Lock Delay) */
    timeout: number;
};

/**
 * Estimate routing fees based on an invoice.
 *
 * Requires `offchain:read` permission
 *
 * This method is not supported before LND 0.18.4
 */
export const getRoutingFeeEstimate: AuthenticatedLightningMethod<
  GetRoutingFeeEstimateRequest,
  GetRoutingFeeEstimateResponse
>;