Expand description
Payments types and newtypes.
Structs§
- Basic
Payment V1 - The old version of
BasicPaymentV2; seeBasicPaymentV2for docs. - Basic
Payment V2 - User-facing payment details for any kind of payment, as displayed in the Lexe app and returned by Lexe APIs.
- Client
Payment Id - A unique, client-generated id for payment types (onchain send, ln spontaneous send) that need an extra id for idempotency.
- DbPayment
Metadata - An encrypted payment metadata, as represented in the DB.
- DbPayment
V1 - An encrypted payment, as represented in the DB. V1 has an extremely inefficient JSON encoding, so we’re migrating from it.
- DbPayment
V2 - An encrypted payment, as represented in the DB.
- LnClaim
Id - Newtype for LDK’s
lightning::ln::channelmanager::PaymentIdbut used specifically for inbound lightning payment idempotency. - Maybe
Basic Payment V2 - An upgradeable version of
Option<BasicPaymentV2>. - Maybe
DbPayment Metadata - An upgradeable version of
Option<DbPaymentMetadata>. - Maybe
DbPayment V1 - An upgradeable version of
Option<DbPaymentV1>. - Maybe
DbPayment V2 - An upgradeable version of
Option<DbPaymentV2>. - OfferId
- Newtype for LDK’s
OfferIdwhich implsSerialize/Deserialize. - Payment
Created Index - A unique, ordered payment identifier:
(created_at, payment_id). - Payment
Hash - The payment hash of a Lightning payment. Serialized as a 64-character hex string.
- Payment
Preimage - Newtype for LDK’s
PaymentPreimagewhich implsSerialize/Deserialize. - Payment
Secret - The payment secret of a Lightning invoice, used to authenticate the payer. Serialized as a 64-character hex string.
- Payment
Updated Index - A unique, ordered payment identifier:
(updated_at, payment_id). - VecBasic
Payment V1 - An upgradeable version of
Vec<BasicPaymentV1>. - VecBasic
Payment V2 - An upgradeable version of
Vec<BasicPaymentV2>. - VecDb
Payment Metadata - An upgradeable version of
Vec<DbPaymentMetadata>. - VecDb
Payment V1 - An upgradeable version of
Vec<DbPaymentV1>. - VecDb
Payment V2 - An upgradeable version of
Vec<DbPaymentV2>.
Enums§
- Payment
Direction - The direction of a payment:
"inbound","outbound", or"info". - Payment
Id - A globally unique identifier for any payment (Lightning or on-chain).
Serialized as
"<prefix>_<hex>", e.g."ln_3ddc..."or"os_0a19...". - Payment
Kind - A fine-grained category for a payment. Useful for filtering payment history and analytics (e.g. regular Lightning payments vs. waived channel fees).
- Payment
Rail - The protocol used to fulfill a payment:
"onchain","invoice","offer","spontaneous", etc. - Payment
Status - The status of a payment:
"pending","completed", or"failed".