Structs§
- 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.- Claim
Deposit Request - Claim
Deposit Response - Config
- Connect
Request - Credentials
- Deposit
Info - Event
Emitter - Event publisher that manages event listeners
- GetInfo
Request - Request to get the balance of the wallet
- GetInfo
Response - Response containing the balance of the wallet
- GetPayment
Request - GetPayment
Response - Lightning
Address Details - List
Payments Request - Request to list payments with pagination
- List
Payments Response - Response from listing payments
- List
Unclaimed Deposits Request - List
Unclaimed Deposits Response - Lnurl
PayInfo - Represents the payment LNURL info
- Lnurl
PayRequest - Lnurl
PayResponse - Lnurl
Withdraw Request Details - LogEntry
- 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 - Receive
Payment Request - Receive
Payment Response - Refund
Deposit Request - Refund
Deposit Response - Rest
Client Chain Service - SdkBuilder
- Builder for creating
BreezSdkinstances with customizable components. - Send
Onchain FeeQuote - Send
Onchain Speed FeeQuote - Send
Payment Request - Send
Payment Response - Silent
Payment Address Details - Sqlite
Storage - SQLite-based storage implementation
- Sync
Wallet Request - Request to sync the wallet with the Spark network
- Sync
Wallet Response - Response from synchronizing the wallet
Enums§
- Amount
- Chain
Service Error - Deposit
Claim Error - Fee
- Input
Type - Network
- Onchain
Confirmation Speed - Parse
Error - Payment
Details - Payment
Method - Payment
Status - The status of a payment
- Payment
Type - The type of payment
- Receive
Payment Method - SdkError
- Error type for the
BreezSdk - SdkEvent
- Events emitted by the SDK
- Send
Payment Method - Send
Payment Options - Storage
Error - Errors that can occur during storage operations
- Update
Deposit Payload
Traits§
- Bitcoin
Chain Service - Event
Listener - Trait for event listeners
- Logger
- Storage
- Trait for persistent storage