Crate breez_sdk_spark Copy item path Source payment_observer signer sync_storage AesSuccessActionData Payload of the AES success action, as received from the LNURL endpoint AesSuccessActionDataDecrypted Wrapper for the decrypted AesSuccessActionData 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 CheckLightningAddressRequest CheckMessageRequest CheckMessageResponse ClaimDepositRequest ClaimDepositResponse ClaimHtlcPaymentRequest ClaimHtlcPaymentResponse Config ConnectRequest ConnectWithSignerRequest Request object for connecting to the Spark network using an external signer. ConversionEstimate Response from estimating a conversion, used when preparing a payment that requires conversion ConversionInfo ConversionOptions Options for conversion when fulfilling a payment. When set, the SDK will
perform a conversion before fulfilling the payment. If not set, the payment
will only be fulfilled if the wallet has sufficient balance of the required asset. 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 FetchConversionLimitsRequest FetchConversionLimitsResponse FiatCurrency Wrapper around the CurrencyInfo 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::LnurlAuthparse 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 SqliteStorage SQLite-based storage implementation 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 AesSuccessActionDataResult Result of decryption of AesSuccessActionData Amount AssetFilter A field of ListPaymentsRequest Bip21Error BitcoinNetwork ChainApiType ChainServiceError ConversionPurpose The purpose of the conversion, which is used to provide context for the conversion
if its related to an ongoing payment or a self-transfer. ConversionStatus The status of the conversion ConversionType DepositClaimError Fee InputType KeySetType 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 SignerError Error type for signer operations SparkHtlcStatus StorageError Errors that can occur during storage operations SuccessAction Supported success action types SuccessActionProcessed SuccessActionUpdateDepositPayload 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. 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 Storage Trait for persistent storage 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 init_logging parse_input