Modules§
Structs§
- AesSuccess
Action Data - Payload of the AES success action, as received from the LNURL endpoint
- AesSuccess
Action Data Decrypted - Wrapper for the decrypted
AesSuccessActionDatapayload - Bip21
Details - Bip21
Extra - Bitcoin
Address Details - Bolt11
Invoice - Bolt11
Invoice Details - Bolt11
Route Hint - Bolt11
Route Hint Hop - Bolt12
Invoice - Bolt12
Invoice Details - Bolt12
Invoice Request Details - Bolt12
Offer - Bolt12
Offer Blinded Path - Bolt12
Offer Details - Breez
Sdk BreezSDKis a wrapper aroundSparkSDKthat provides a more structured API with request/response objects and comprehensive error handling.- Burn
Issuer Token Request - Check
Lightning Address Request - Check
Message Request - Check
Message Response - Claim
Deposit Request - Claim
Deposit Response - Config
- Connect
Request - Create
Issuer Token Request - Credentials
- Currency
Info - Details about a supported currency in the fiat rate feed
- Deposit
Info - Event
Emitter - Event publisher that manages event listeners
- External
Input Parser - Configuration for an external input parser
- Fiat
Currency - Wrapper around the
CurrencyInfoof a fiat currency - Freeze
Issuer Token Request - Freeze
Issuer Token Response - GetInfo
Request - Request to get the balance of the wallet
- GetInfo
Response - Response containing the balance of the wallet
- GetPayment
Request - GetPayment
Response - GetTokens
Metadata Request - GetTokens
Metadata Response - Lightning
Address Details - Lightning
Address Info - List
Fiat Currencies Response - Response from listing fiat currencies
- List
Fiat Rates Response - Response from listing fiat rates
- List
Payments Request - Request to list payments with optional filters and pagination
- List
Payments Response - Response from listing payments
- List
Unclaimed Deposits Request - List
Unclaimed Deposits Response - Lnurl
Auth Request Details - Wrapped in a [
LnurlAuth], this is the result of [parse] when given a LNURL-auth endpoint. - Lnurl
PayInfo - Represents the payment LNURL info
- Lnurl
PayRequest - Lnurl
PayRequest Details - Lnurl
PayResponse - Lnurl
Withdraw Info - Represents the withdraw LNURL info
- Lnurl
Withdraw Request - Lnurl
Withdraw Request Details - Lnurl
Withdraw Response - Locale
Overrides - Locale-specific settings for the representation of a currency
- Localized
Name - Localized name of a currency
- LogEntry
- Message
Success Action Data - Mint
Issuer Token Request - Payment
- Represents a payment (sent or received)
- Payment
Metadata - Metadata associated with a payment that cannot be extracted from the Spark operator.
- Payment
Request Source - Prepare
Lnurl PayRequest - Prepare
Lnurl PayResponse - Prepare
Send Payment Request - Prepare
Send Payment Response - Provisional
Payment - Rate
- Denominator in an exchange rate
- Receive
Payment Request - Receive
Payment Response - Refund
Deposit Request - Refund
Deposit Response - Register
Lightning Address Request - Rest
Client Chain Service - Rest
Response - SdkBuilder
- Builder for creating
BreezSdkinstances with customizable components. - Send
Onchain FeeQuote - Send
Onchain Speed FeeQuote - Send
Payment Request - Send
Payment Response - Sign
Message Request - Sign
Message Response - Silent
Payment Address Details - Spark
Address Details - Spark
Invoice Details - Spark
Invoice Payment Details - Sqlite
Storage - SQLite-based storage implementation
- Symbol
- Settings for the symbol representation of a currency
- Sync
Wallet Request - Request to sync the wallet with the Spark network
- Sync
Wallet Response - Response from synchronizing the wallet
- Token
Balance - Token
Issuer - Token
Metadata - TxStatus
- Unfreeze
Issuer Token Request - Unfreeze
Issuer Token Response - Update
User Settings Request - UrlSuccess
Action Data - User
Settings - Utxo
- Wait
ForPayment Request - Wait
ForPayment Response
Enums§
- AesSuccess
Action Data Result - Result of decryption of
AesSuccessActionDatapayload - Amount
- Asset
Filter - A field of
ListPaymentsRequestwhen listing payments filtered by asset - Bip21
Error - Bitcoin
Network - Chain
Service Error - Deposit
Claim Error - Fee
- Input
Type - KeySet
Type - Lnurl
Error - Network
- Onchain
Confirmation Speed - Parse
Error - Payment
Details - Payment
Method - Payment
Observer Error - Payment
Status - The status of a payment
- Payment
Type - The type of payment
- Provisional
Payment Details - Receive
Payment Method - 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.
- Send
Payment Method - Send
Payment Options - Service
Connectivity Error - Storage
Error - Errors that can occur during storage operations
- Success
Action - Supported success action types
- Success
Action Processed SuccessActionwhere contents are ready to be consumed by the caller- Update
Deposit Payload - Wait
ForPayment Identifier
Constants§
- DEFAULT_
EXTERNAL_ INPUT_ PARSERS - A list of external input parsers that are used by default.
To opt-out, set
use_default_external_input_parsersin Config to false.
Traits§
- Bitcoin
Chain Service - Event
Listener - Trait for event listeners
- Fiat
Service - Trait covering fiat-related functionality
- Logger
- Payment
Observer - 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.
- Rest
Client - Storage
- Trait for persistent storage
Functions§
- connect
- Connects to the Spark network using the provided configuration and mnemonic.
- default_
config - default_
storage_ path - init_
logging - parse_
input