lexe::types

Module command

Source
Expand description

Request, response, and command types for SDK operations. Lexe SDK API request and response types.

Structs§

AnalyzeRequest
A request to analyze the contents of a Bitcoin or Lightning payment string. Reveals all payment methods encoded in the string, and gives payment-related details on each. See PayableDetails for more info.
AnalyzeResponse
The response to a string analysis request.
CancelPaymentRequest
A request to cancel a pending payment.
CashAppBuyRequest
A request to buy Bitcoin with Cash App.
CashAppBuyResponse
The response to a CashAppBuyRequest.
ChannelDetails
Details about one of this node’s Lightning channels.
ClaimableDetails
Describes basic information for a claimable string.
ClientInfo
Information about a client that can authenticate with a Lexe node.
ClientInfoResponse
A response containing information about a single client.
CloseChannelRequest
A request to close a Lightning channel between this node and Lexe’s LSP.
CreateClientRequest
A request to create a new client and client credentials that can authenticate with a Lexe node.
CreateClientResponse
The response to a request to create a new client.
CreateInvoiceRequest
A request to create a BOLT 11 invoice.
CreateInvoiceResponse
The response to a BOLT 11 invoice request.
CreateOfferRequest
A request to create a BOLT 12 offer to receive Lightning payments.
CreateOfferResponse
The response to a BOLT 12 offer creation request.
CreatePayerProofRequest
A request to prove that an offer was paid. Specifically, it proves that a BOLT 12 invoice was paid.
CreatePayerProofResponse
The response to a CreatePayerProofRequest.
GetClientInfoResponse
The response to a client_info request: how this wallet is authenticated and the authorization associated with those credentials.
GetHumanBitcoinAddressResponse
The user’s Human Bitcoin Address.
GetNextUnusedAddressResponse
The response to a get_next_unused_address request.
GetPaymentRequest
A request to get information about a payment by its index.
GetPaymentResponse
A response to a request to get information about a payment by its index.
GetUpdatedPaymentsRequest
Get a batch of payments in ascending updated_at order, starting from a given updated_at index.
GetUpdatedPaymentsResponse
A response to a GetUpdatedPaymentsRequest.
ListChannelsResponse
The response to a request to list this node’s Lightning channels.
ListClientsResponse
The response to a request listing the active clients on a Lexe node.
ListPaymentsResponse
Response from listing payments.
NodeInfo
Information about a Lexe node.
OpenChannelRequest
A request to open a Lightning channel from this node to Lexe’s LSP.
OpenChannelResponse
The response to a request to open a channel to the LSP.
PayInvoiceRequest
A request to pay a BOLT 11 invoice.
PayLnurlRequest
A request to pay to an LNURL-pay endpoint.
PayOfferRequest
A request to pay a BOLT 12 offer over Lightning.
PayOnchainRequest
A request to send Bitcoin on-chain.
PayRequest
A catch-all request to pay a Bitcoin or Lightning payment string.
PayableDetails
Describes basic information for a payable string.
PayerProofDisclosures
The BOLT12 invoice fields to include in the PayerProof.
PaymentSyncSummary
Summary of changes from a payment sync operation.
RevokeClientRequest
A request to permanently revoke a client, making its credentials invalid for authentication. This cannot be undone.
UpdateClientRequest
A request to update the properties of an existing client.
UpdatePersonalNoteRequest
A request to update the personal note on an existing payment. Pass None to clear the note.
WaitForNextPaymentRequest
A request to wait for the payment information of the next updated payment.
WaitForNextPaymentResponse
A response to a WaitForNextPaymentRequest.
WithdrawLnurlRequest
A request to withdraw from an LNURL-withdraw endpoint.

Enums§

CredentialKind
How a wallet authenticates with its node: root seed or client credentials.