Re-exports§
pub use crate::error::ClaimIncomingContractError;pub use crate::error::CreateBolt11InvoiceError;pub use crate::error::GatewaySelectionError;pub use crate::error::LnSubscribeError;pub use crate::error::PayBolt11InvoiceError;pub use crate::error::PaymentInfoError;pub use crate::error::ReclaimLnReceiveError;pub use crate::error::SpendableAmountError;pub use fedimint_ln_common as common;
Modules§
- api
- cli
- db
- deprecated_
variant_ 🔒hack - This is a hack to allow us to use the deprecated variant in the database without the serde derived implementation throwing warnings.
- error
- Error types of the lightning client.
- events
- incoming
- Incoming State Machine
- pay
- receive
- recurring
- Implements recurring payment codes (e.g. LNURL, BOLT12)
Structs§
- Create
Bolt11 🔒Invoice ForUser Tweaked Request - Create
Bolt11 🔒Invoice Request - GetGateway
Request 🔒 - Lightning
Client Context - Lightning
Client Init - Lightning
Client Module - Client side lightning module
- Lightning
Operation Meta - Lightning
Operation Meta Pay - Mock
Gateway Connection - Outgoing
Lightning Payment - PayBolt11
Invoice 🔒Request - PayInvoice
Response - PayLightning
Address 🔒Request - Real
Gateway Connection - Reclaim
LnReceive 🔒Request - Scan
Receive 🔒ForUser Tweaked Request - Select
Available Gateway Request - Subscribe
Internal 🔒PayRequest - Subscribe
LnClaim 🔒Request - Subscribe
LnPay 🔒Request - Subscribe
LnReceive 🔒Request
Enums§
- Gateway
Status - Internal
PayState - The high-level state of an pay operation internal to the federation,
started with
LightningClientModule::pay_bolt11_invoice. - Lightning
Child Keys - Lightning
Client State Machines - Lightning
Operation Meta Variant - Lightning
Payment Outcome - LnPay
State - The high-level state of a pay operation over lightning,
started with
LightningClientModule::pay_bolt11_invoice. - LnReceive
State - The high-level state of a reissue operation started with
LightningClientModule::create_bolt11_invoice. - PayType
- Payment
Info - A payment target parsed from user input: either a bolt11 invoice or the pay parameters resolved from an LNURL/lightning address.
- Receiving
Key - Where to receive the payment to, either to ourselves or to another user
- RpcError 🔒
- A failure of an
lnmodule RPC request.
Constants§
- DEFAULT_
INVOICE_ 🔒EXPIRY_ TIME - MAX_
OUTGOING_ 🔒CONTRACT_ TIMELOCK_ DELTA - Largest number of blocks an outgoing contract’s timelock may lie ahead of
the current block count, matching the
EXPIRATION_DELTA_LIMITof thefedimint-lnv2-client. The payee picks part of the delta through the invoice’smin_final_cltv_expiry_delta, so without a bound they could push the payer’s refund out arbitrarily far or overflow the timelock. - OUTGOING_
LN_ 🔒CONTRACT_ TIMELOCK - Number of blocks until outgoing lightning contracts times out and user client can get refund
Traits§
Functions§
- create_
incoming_ contract_ output - fetch_
and_ 🔒validate_ offer - get_
invoice - Get LN invoice with given settings
- invoice_
has_ 🔒internal_ payment_ markers - invoice_
routes_ 🔒back_ to_ federation - set_
payment_ 🔒result - tweak_
user_ key - Tweak a user key with an index, this is used to generate a new key for each invoice. This is done to not be able to link invoices to the same user.
- tweak_
user_ 🔒secret_ key - Tweak a secret key with an index, this is used to claim an unspent incoming contract.