Crate breez_sdk_spark

Crate breez_sdk_spark 

Source

Re-exports§

pub use crate::token_conversion::ConversionEstimate;
pub use crate::token_conversion::ConversionInfo;
pub use crate::token_conversion::ConversionOptions;
pub use crate::token_conversion::ConversionPurpose;
pub use crate::token_conversion::ConversionStatus;
pub use crate::token_conversion::ConversionType;
pub use crate::token_conversion::FetchConversionLimitsRequest;
pub use crate::token_conversion::FetchConversionLimitsResponse;

Modules§

payment_observer
signer
sync_storage
token_conversion

Structs§

AesSuccessActionData
Payload of the AES success action, as received from the LNURL endpoint
AesSuccessActionDataDecrypted
Wrapper for the decrypted AesSuccessActionData payload
Bip21Details
Bip21Extra
BitcoinAddressDetails
Bolt11Invoice
Bolt11InvoiceDetails
Bolt11RouteHint
Bolt11RouteHintHop
Bolt12Invoice
Bolt12InvoiceDetails
Bolt12InvoiceRequestDetails
Bolt12Offer
Bolt12OfferBlindedPath
Bolt12OfferDetails
BreezSdk
BreezSDK is a wrapper around SparkSDK that provides a more structured API with request/response objects and comprehensive error handling.
BurnIssuerTokenRequest
BuyBitcoinRequest
Request to buy Bitcoin using an external provider (MoonPay)
BuyBitcoinResponse
Response containing a URL to complete the Bitcoin purchase
CheckLightningAddressRequest
CheckMessageRequest
CheckMessageResponse
ClaimDepositRequest
ClaimDepositResponse
ClaimHtlcPaymentRequest
ClaimHtlcPaymentResponse
Config
ConnectRequest
ConnectWithSignerRequest
Request object for connecting to the Spark network using an external signer.
ConversionDetails
Outlines the steps involved in a conversion
ConversionStep
A single step in a conversion
CreateIssuerTokenRequest
Credentials
CurrencyInfo
Details about a supported currency in the fiat rate feed
DepositInfo
EventEmitter
Event publisher that manages event listeners
ExternalInputParser
Configuration for an external input parser
FiatCurrency
Wrapper around the CurrencyInfo of a fiat currency
FreezeIssuerTokenRequest
FreezeIssuerTokenResponse
GetInfoRequest
Request to get the balance of the wallet
GetInfoResponse
Response containing the balance of the wallet
GetPaymentRequest
GetPaymentResponse
GetTokensMetadataRequest
GetTokensMetadataResponse
KeySet
KeySetConfig
Configuration for key set derivation.
LightningAddressDetails
LightningAddressInfo
ListFiatCurrenciesResponse
Response from listing fiat currencies
ListFiatRatesResponse
Response from listing fiat rates
ListPaymentsRequest
Request to list payments with optional filters and pagination
ListPaymentsResponse
Response from listing payments
ListUnclaimedDepositsRequest
ListUnclaimedDepositsResponse
LnurlAuthRequestDetails
Wrapped in a InputType::LnurlAuth, this is the result of parse when given a LNURL-auth endpoint.
LnurlErrorDetails
LNURL error details
LnurlInfo
LnurlPayInfo
Represents the payment LNURL info
LnurlPayRequest
LnurlPayRequestDetails
LnurlPayResponse
LnurlReceiveMetadata
LnurlWithdrawInfo
Represents the withdraw LNURL info
LnurlWithdrawRequest
LnurlWithdrawRequestDetails
LnurlWithdrawResponse
LocaleOverrides
Locale-specific settings for the representation of a currency
LocalizedName
Localized name of a currency
LogEntry
MessageSuccessActionData
MintIssuerTokenRequest
OptimizationConfig
OptimizationProgress
Payment
Represents a payment (sent or received)
PaymentMetadata
Metadata associated with a payment that cannot be extracted from the Spark operator.
PaymentRequestSource
PrepareLnurlPayRequest
PrepareLnurlPayResponse
PrepareSendPaymentRequest
PrepareSendPaymentResponse
ProvisionalPayment
Rate
Denominator in an exchange rate
ReceivePaymentRequest
ReceivePaymentResponse
RecommendedFees
RefundDepositRequest
RefundDepositResponse
RegisterLightningAddressRequest
RestClientChainService
RestResponse
SdkBuilder
Builder for creating BreezSdk instances with customizable components.
SendOnchainFeeQuote
SendOnchainSpeedFeeQuote
SendPaymentRequest
SendPaymentResponse
SetLnurlMetadataItem
SignMessageRequest
SignMessageResponse
SilentPaymentAddressDetails
SparkAddressDetails
SparkHtlcDetails
SparkHtlcOptions
SparkInvoiceDetails
SparkInvoicePaymentDetails
SparkStatus
The status of the Spark network services relevant to the SDK.
SqliteStorage
SQLite-based storage implementation
StableBalanceConfig
Configuration for automatic conversion of Bitcoin to stable tokens.
StorageListPaymentsRequest
Storage-internal variant of ListPaymentsRequest that uses StoragePaymentDetailsFilter instead of the public PaymentDetailsFilter.
Symbol
Settings for the symbol representation of a currency
SyncWalletRequest
Request to sync the wallet with the Spark network
SyncWalletResponse
Response from synchronizing the wallet
TokenBalance
TokenIssuer
TokenMetadata
TxStatus
UnfreezeIssuerTokenRequest
UnfreezeIssuerTokenResponse
UpdateUserSettingsRequest
UrlSuccessActionData
UserSettings
Utxo

Enums§

AesSuccessActionDataResult
Result of decryption of AesSuccessActionData payload
Amount
AssetFilter
A field of ListPaymentsRequest when listing payments filtered by asset
Bip21Error
BitcoinNetwork
ChainApiType
ChainServiceError
DepositClaimError
Fee
FeePolicy
Specifies how fees are handled in a payment.
InputType
KeySetType
LnurlCallbackStatus
The response from a LNURL-auth callback, indicating success or failure.
LnurlError
MaxFee
Network
OnchainConfirmationSpeed
OptimizationEvent
ParseError
PaymentDetails
PaymentDetailsFilter
PaymentMethod
PaymentObserverError
PaymentStatus
The status of a payment
PaymentType
The type of payment
ProvisionalPaymentDetails
ReceivePaymentMethod
SdkError
Error type for the BreezSdk
SdkEvent
Events emitted by the SDK
Seed
Represents the seed for wallet generation, either as a mnemonic phrase with an optional passphrase or as raw entropy bytes.
SendPaymentMethod
SendPaymentOptions
ServiceConnectivityError
ServiceStatus
The operational status of a Spark service.
SignerError
Error type for signer operations
SparkHtlcStatus
StorageError
Errors that can occur during storage operations
StoragePaymentDetailsFilter
Storage-internal variant of PaymentDetailsFilter that includes the has_lnurl_preimage field on the Lightning variant, which is not exposed in the public API.
SuccessAction
Supported success action types
SuccessActionProcessed
SuccessAction where contents are ready to be consumed by the caller
TokenTransactionType
UpdateDepositPayload

Constants§

DEFAULT_EXTERNAL_INPUT_PARSERS
A list of external input parsers that are used by default. To opt-out, set use_default_external_input_parsers in Config to false.

Traits§

BitcoinChainService
EventListener
Trait for event listeners
FiatService
Trait covering fiat-related functionality
Logger
PaymentObserver
This interface is used to observe outgoing payments before Lightning, Spark and onchain Bitcoin payments. If the implementation returns an error, the payment is cancelled.
RestClient
REST client trait for making HTTP requests.
Storage
Trait for persistent storage

Functions§

connect
Connects to the Spark network using the provided configuration and mnemonic.
connect_with_signer
Connects to the Spark network using an external signer.
default_config
default_external_signer
Creates a default external signer from a mnemonic.
default_storage_path
get_spark_status
Fetches the current status of Spark network services relevant to the SDK.
init_logging
parse_input