Crate uniffi_lipalightninglib

lipa-lightning-lib (aka 3L)

This crate implements all the main business logic of the lipa wallet.

Most functionality can be accessed by creating an instance of LightningNode and using its methods.

Structs

• ActionsRequired
• Activities
• Amount
  A sat amount accompanied by its fiat value in a specific fiat currency
• Bolt11
• BreezSdkConfig
• CalculateLspFeeResponseDeprecated
  The type returned by LightningNode::calculate_lsp_fee.
• CalculateLspFeeResponseV2
  The type returned by Swap::calculate_lsp_fee_for_amount and Lightning::calculate_lsp_fee_for_amount .
• ChannelClose
• ChannelCloseInfo
  Information about a closed channel.
• ChannelsInfo
  Information about the channels of the node
• ClearWalletInfo
  Information about a wallet clearance operation as returned by LightningNode::prepare_clear_wallet.
• Config
• ExchangeRate
  Exchange rate as sats per major unit accompanied by the specific currency code and time the rate was updated at.
• FailedSwapInfo
  Information about a failed swap
• FiatTopup
• FiatTopupSetupInfo
  Information about a fiat top-up registration
• FiatValue
  A fiat value accompanied by the exchange rate that was used to get it.
• IncomingPaymentInfo
  Information about an incoming payment.
• InvoiceCreationMetadata
  Includes metadata about an invoice the user created.
• InvoiceDetails
  Information embedded in an invoice
• Lightning
• LightningAddress
• LightningNode
  The main class/struct of this library. Constructing an instance will initiate the Lightning node and run it in the background. As long as an instance of LightningNode is held, the node will continue to run in the background. Dropping the instance will start a deinit process.
• LightningNodeConfig
  An object that holds all configuration needed to start a LightningNode instance.
• ListActivitiesResponse
  Information about all pending and only requested completed activities.
• LnUrlPayDetails
  Information about an LNURL-pay.
• LnUrlWithdrawDetails
  Information about an LNURL-withdraw.
• Lnurl
• LspFee
  The fee charged by the Lightning Service Provider (LSP) for opening a channel with the node. This fee is being charged at the time of the channel creation. The LSP simply subtracts this fee from an incoming payment (if this incoming payment leads to a channel creation).
• MaxRoutingFeeConfig
• NodeInfo
  Information about the Lightning node running in the background
• NotificationToggles
  A configuration struct used to enable/disable processing of different payloads in handle_notification.
• OfferInfo
  Information on a funds offer that can be claimed using crate::LightningNode::request_offer_collection.
• Onchain
• OnchainResolvingFees
  Contains the fee information for the options to resolve funds that have moved on-chain.
• OutgoingPaymentInfo
  Information about an outgoing payment.
• PaymentAmountLimits
  Information on the limits imposed on the next receiving payment
• PaymentInfo
  Information about a payment.
• PaymentMetadata
  Includes metadata about a payment the client received in any way.
• PhoneNumber
• PhoneNumberRecipient
• ReceiveAmountLimits
  Information on the limits imposed on the next receiving payment
• ReceiveLimitsConfig
• RemoteServicesConfig
• ResolveFailedSwapInfo
  Information the resolution of a failed swap.
• ReverseSwap
• ReverseSwapInfo
  Information about a successful reverse swap.
• Secret
  An object that holds necessary secrets. Should be dealt with carefully and never be logged.
• Swap
• SwapAddressInfo
  Information about a generated swap address
• SwapInfo
  Information about a pending or successful swap.
• SwapToLightningFees
  Information about fees related to swap of own on-chain funds back to lightning.
• SweepChannelCloseInfo
• SweepFailedSwapInfo
  Information the resolution of a failed swap.
• SweepInfo
• TermsAndConditionsStatus
• TzConfig
  An object that holds timezone configuration values necessary for 3L to do timestamp annotation. These values get tied together with every timestamp persisted in the local payment database.
• TzTime
  A UTC timestamp accompanied by the ID of the timezone on which it was recorded and the respective UTC offset.
• Util

Enums

• ActionRequiredItem
• Activity
• AnalyticsConfig
• BreezHealthCheckStatus
  Indicates the different service health check statuses.
• ChannelCloseState
• DecodeDataError
• DecodedData
  Decoded data that can be obtained using LightningNode::decode_data.
• FeatureFlag
• InvoiceAffordability
  Invoice affordability returned by LightningNode::get_invoice_affordability.
• LiquidityLimit
• LnUrlPayErrorCode
  A code that specifies the LnUrlPayError that occurred.
• MaxRoutingFeeMode
  Indicates the max routing fee mode used to restrict fees of a payment of a given size
• MnemonicError
• Notification
  A notification to be displayed to the user.
• NotificationHandlingErrorCode
  A code that specifies the NotificationHandlingError that occurred.
• OfferKind
• OfferStatus
• ParseError
  Enum representing possible errors why parsing could fail.
• ParsePhoneNumberError
• ParsePhoneNumberPrefixError
• PayErrorCode
  A code that specifies the PayError that occurred.
• PaymentAffordability
  Payment affordability returned by Lightning::determine_payment_affordability.
• PaymentSource
• PaymentState
• PermanentFailureCode
• RangeHit
  Represent the result of comparision of a value with a given range.
• Recipient
  User-friendly representation of an outgoing payment’s recipient.
• ReverseSwapStatus
  The possible statuses of a reverse swap, from the Breez SDK perspective.
• RuntimeErrorCode
  A code that specifies the RuntimeError that occurred
• SimpleError
• SwapError
  Error returned by [crate::breez_services::BreezServices::receive_onchain] and [crate::breez_services::BreezServices::buy_bitcoin]
• SweepError
• TemporaryFailureCode
• TermsAndConditions
• UnsupportedDataType

Traits

• EventsCallback
  Asynchronous events that the consumer of this library might be interested in handling are delivered through this interface. These callbacks will only be called once per event.

Functions

• accept_terms_and_conditions
  Accept lipa’s terms and conditions. Should be called before instantiating a LightningNode for the first time.
• generate_secret
  Generate a new mnemonic with an optional passphrase. Provide an empty string to use no passphrase.
• get_terms_and_conditions_status
  Allows checking if certain terms and conditions have been accepted by the user.
• handle_notification
  Handles a notification.
• mnemonic_to_secret
  Generate a Secret object (containing the seed). Provide an empty string to use no passphrase.
• parse_lightning_address
  Try to parse the provided string as a lightning address, return ParseError precisely indicating why parsing failed.
• recover_lightning_node
  Performs a recovery procedure by fetching necessary data from remote storage. It should and can only be called on a fresh install of the app, if the user wants to recover a previously created wallet.
• words_by_prefix
  Return a list of valid BIP-39 English words starting with the prefix. Calling this function with empty prefix will return the full list of BIP-39 words.

Type Aliases

• LnError
• LnUrlPayError
• LnUrlPayResult
• NotificationHandlingError
• PayError
• PayResult
• PocketOfferError
  An error associated with a specific PocketOffer. Can be temporary, indicating there was an issue with a previous withdrawal attempt and it can be retried, or it can be permanent.
• Result