Expand description
Request / response types used in APIs for top level commands.
Structs§
- Active
Human Bitcoin Address - The user’s active Human Bitcoin Address, paired with whether they may
currently change it. This is what
get/upsert_*_human_bitcoin_addressserve back to the app. - Backup
Info - Claim
Generated Human Bitcoin Address - Claims a generated human Bitcoin address.
- Close
Channel Request - Create
Invoice Request - Create
Invoice Response - Create
Offer Request - Create
Offer Response - Debug
Info - Diagnostic information for debugging purposes.
- Enclaves
ToProvision ForUser - The gateway→backend form of
EnclavesToProvisionRequest, carrying theuser_pkthat the gateway verified from the app’s bearer auth token. - Enclaves
ToProvision Request - Request to query which node enclaves need provisioning, given the client’s trusted measurements.
- FeeEstimate
- GetAddress
Response - GetGenerated
Username Response - Response for
get_generated_usernameendpoint. - GetHuman
Bitcoin Address Response - Response for
get_human_bitcoin_address. - GetNew
Payments - Sync a batch of new payments to local storage.
Results are returned in ascending
(created_at, payment_id)order. - GetUpdated
Payment Metadata - Get a batch of payment metadata in asc
(updated_at, payment_id)order. - GetUpdated
Payments - Get a batch of payments in ascending
(updated_at, payment_id)order. - Human
Bitcoin Address - The user’s active Human Bitcoin Address: the active (non-expired) primary custom HBA if present, otherwise the generated fallback. Aliases are never returned here.
- Human
Bitcoin Address V1 - The legacy flat HBA shape returned by the deprecated v1
*_human_bitcoin_addressendpoints, built from the v2 types above. - List
Channels Response - Node
Info - Information about the Lexe node.
- Node
Info V1 - Onchain
Descriptors - BIP84 wpkh output descriptors for the on-chain wallet.
- Open
Channel Request - The information required for the user node to open a channel to the LSP.
- Open
Channel Response - PayInvoice
Request - PayInvoice
Response - PayOffer
Request - PayOffer
Response - PayOnchain
Request - PayOnchain
Response - Payment
Created Index Struct - Upgradeable API struct for a payment index.
- Payment
Created Indexes - Upgradeable API struct for a list of
PaymentCreatedIndexs. - Payment
IdStruct - Upgradeable API struct for a
PaymentId. - Preflight
Close Channel Response - Preflight
Open Channel Request - Preflight
Open Channel Response - Preflight
PayInvoice Request - Preflight
PayInvoice Response - Preflight
PayOffer Request - Preflight
PayOffer Response - Preflight
PayOnchain Request - Preflight
PayOnchain Response - Resync
Request - SetupG
Drive - Update
Personal Note - A request to update the personal note on a payment. Pass
Noneto clear. - Upsert
Custom Human Bitcoin Address - Upserts the user’s custom human Bitcoin address.
- Upsert
Human Bitcoin Address Response - Response for
upsert_custom_human_bitcoin_address. - VecPayment
Id - An upgradeable version of
Vec<PaymentId>.