Struct Lightning

pub struct Lightning { /* private fields */ }

Implementations

impl Lightning

pub fn bolt11(&self) -> Arc<Bolt11>

pub fn lnurl(&self) -> Arc<Lnurl>

pub fn determine_max_routing_fee_mode( &self, amount_sat: u64, ) -> MaxRoutingFeeMode

Determine the max routing fee mode that will be employed to restrict the fees for paying a given amount in sats.

Requires network: no

pub fn determine_payment_affordability( &self, amount_sat: u64, ) -> Result<PaymentAffordability>

Checks if the given amount could be spent on a payment.

Parameters:

• amount - The to be spent amount.

Requires network: no

pub fn determine_receive_amount_limits(&self) -> Result<ReceiveAmountLimits>

Get the current limits for the amount that can be transferred in a single payment. Currently there are only limits for receiving payments. The limits (partly) depend on the channel situation of the node, so it should be called again every time the user is about to receive a payment. The limits stay the same regardless of what amount wants to receive (= no changes while he’s typing the amount)

Requires network: no

pub fn calculate_lsp_fee_for_amount( &self, amount_sat: u64, ) -> Result<CalculateLspFeeResponseV2>

Calculate the actual LSP fee for the given amount of an incoming payment. If the already existing inbound capacity is enough, no new channel is required.

Parameters:

• amount_sat - amount in sats to compute LSP fee for

For the returned fees to be guaranteed to be accurate, the returned lsp_fee_params must be provided to Bolt11::create

For swaps, use Swap::calculate_lsp_fee_for_amount instead, which uses fee offer from the LSP that is valid for a longer time period

Requires network: yes

pub fn get_lsp_fee(&self) -> Result<LspFee>

When receiving payments, a new channel MAY be required. A fee will be charged to the user. This does NOT impact sending payments. Get information about the fee charged by the LSP for opening new channels

Requires network: no