Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.spark.money/llms.txt

Use this file to discover all available pages before exploring further.

Estimates the fee for sending a Lightning payment via the SparkWallet.

​
Method Signature

interface LightningSendFeeEstimateInput {
  encodedInvoice: string;
  amountSats?: number;
}

async getLightningSendFeeEstimate(params: LightningSendFeeEstimateInput): Promise<number>

​
Parameters

​
encodedInvoice
string
required
The BOLT11-encoded Lightning invoice
​
amountSats
number
Amount in satoshis to send (required for zero-amount invoices)

​
Returns

​
fee
number
required
The estimated fee in satoshis

​
Example

const feeEstimate = await wallet.getLightningSendFeeEstimate({
  encodedInvoice: "lnbc..."
});
console.log("Estimated fee:", feeEstimate, "sats");