Struct BreezSdk 

pub struct BreezSdk { /* private fields */ }

BreezSDK is a wrapper around SparkSDK that provides a more structured API with request/response objects and comprehensive error handling.

Implementations

impl BreezSdk

pub async fn add_event_listener( &self, listener: Box<dyn EventListener>, ) -> String

Registers a listener to receive SDK events

Arguments

• listener - An implementation of the EventListener trait

Returns

A unique identifier for the listener, which can be used to remove it later

pub async fn remove_event_listener(&self, id: &str) -> bool

Removes a previously registered event listener

Arguments

• id - The listener ID returned from add_event_listener

Returns

true if the listener was found and removed, false otherwise

pub async fn disconnect(&self) -> Result<(), SdkError>

Stops the SDK’s background tasks

This method stops the background tasks started by the start() method. It should be called before your application terminates to ensure proper cleanup.

Returns

Result containing either success or an SdkError if the background task couldn’t be stopped

pub async fn parse(&self, input: &str) -> Result<InputType, SdkError>

pub async fn get_info( &self, request: GetInfoRequest, ) -> Result<GetInfoResponse, SdkError>

Returns the balance of the wallet in satoshis

pub async fn receive_payment( &self, request: ReceivePaymentRequest, ) -> Result<ReceivePaymentResponse, SdkError>

pub async fn prepare_lnurl_pay( &self, request: PrepareLnurlPayRequest, ) -> Result<PrepareLnurlPayResponse, SdkError>

pub async fn lnurl_pay( &self, request: LnurlPayRequest, ) -> Result<LnurlPayResponse, SdkError>

pub async fn lnurl_withdraw( &self, request: LnurlWithdrawRequest, ) -> Result<LnurlWithdrawResponse, SdkError>

Performs an LNURL withdraw operation for the amount of satoshis to withdraw and the LNURL withdraw request details. The LNURL withdraw request details can be obtained from calling BreezSdk::parse.

The method generates a Lightning invoice for the withdraw amount, stores the LNURL withdraw metadata, and performs the LNURL withdraw using the generated invoice.

If the completion_timeout_secs parameter is provided and greater than 0, the method will wait for the payment to be completed within that period. If the withdraw is completed within the timeout, the payment field in the response will be set with the payment details. If the completion_timeout_secs parameter is not provided or set to 0, the method will not wait for the payment to be completed. If the withdraw is not completed within the timeout, the payment field will be empty.

Arguments

• request - The LNURL withdraw request

Returns

Result containing either:

• LnurlWithdrawResponse - The payment details if the withdraw request was successful
• SdkError - If there was an error during the withdraw process

pub async fn prepare_send_payment( &self, request: PrepareSendPaymentRequest, ) -> Result<PrepareSendPaymentResponse, SdkError>

pub async fn send_payment( &self, request: SendPaymentRequest, ) -> Result<SendPaymentResponse, SdkError>

pub async fn sync_wallet( &self, request: SyncWalletRequest, ) -> Result<SyncWalletResponse, SdkError>

Synchronizes the wallet with the Spark network

pub async fn list_payments( &self, request: ListPaymentsRequest, ) -> Result<ListPaymentsResponse, SdkError>

Lists payments from the storage with pagination

This method provides direct access to the payment history stored in the database. It returns payments in reverse chronological order (newest first).

Arguments

• request - Contains pagination parameters (offset and limit)

Returns

• Ok(ListPaymentsResponse) - Contains the list of payments if successful
• Err(SdkError) - If there was an error accessing the storage

pub async fn get_payment( &self, request: GetPaymentRequest, ) -> Result<GetPaymentResponse, SdkError>

pub async fn claim_deposit( &self, request: ClaimDepositRequest, ) -> Result<ClaimDepositResponse, SdkError>

pub async fn refund_deposit( &self, request: RefundDepositRequest, ) -> Result<RefundDepositResponse, SdkError>

pub async fn list_unclaimed_deposits( &self, request: ListUnclaimedDepositsRequest, ) -> Result<ListUnclaimedDepositsResponse, SdkError>

pub async fn check_lightning_address_available( &self, req: CheckLightningAddressRequest, ) -> Result<bool, SdkError>

pub async fn get_lightning_address( &self, ) -> Result<Option<LightningAddressInfo>, SdkError>

pub async fn register_lightning_address( &self, request: RegisterLightningAddressRequest, ) -> Result<LightningAddressInfo, SdkError>

pub async fn delete_lightning_address(&self) -> Result<(), SdkError>

pub async fn list_fiat_currencies( &self, ) -> Result<ListFiatCurrenciesResponse, SdkError>

List fiat currencies for which there is a known exchange rate, sorted by the canonical name of the currency.

pub async fn list_fiat_rates(&self) -> Result<ListFiatRatesResponse, SdkError>

List the latest rates of fiat currencies, sorted by name.

pub async fn wait_for_payment( &self, request: WaitForPaymentRequest, ) -> Result<WaitForPaymentResponse, SdkError>

pub async fn get_tokens_metadata( &self, request: GetTokensMetadataRequest, ) -> Result<GetTokensMetadataResponse, SdkError>

Returns the metadata for the given token identifiers.

Results are not guaranteed to be in the same order as the input token identifiers.

If the metadata is not found locally in cache, it will be queried from the Spark network and then cached.

pub async fn sign_message( &self, request: SignMessageRequest, ) -> Result<SignMessageResponse, SdkError>

Signs a message with the wallet’s identity key. The message is SHA256 hashed before signing. The returned signature will be hex encoded in DER format by default, or compact format if specified.

pub async fn check_message( &self, request: CheckMessageRequest, ) -> Result<CheckMessageResponse, SdkError>

Verifies a message signature against the provided public key. The message is SHA256 hashed before verification. The signature can be hex encoded in either DER or compact format.

pub async fn get_user_settings(&self) -> Result<UserSettings, SdkError>

Returns the user settings for the wallet.

Some settings are fetched from the Spark network so network requests are performed.

pub async fn update_user_settings( &self, request: UpdateUserSettingsRequest, ) -> Result<(), SdkError>

Updates the user settings for the wallet.

Some settings are updated on the Spark network so network requests may be performed.

pub fn get_token_issuer(&self) -> TokenIssuer

Returns an instance of the TokenIssuer for managing token issuance.

Trait Implementations

impl Clone for BreezSdk

fn clone(&self) -> BreezSdk

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.