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 connect(request: ConnectRequest) -> Result<Self, SdkError>

Connects to the Spark network using the provided configuration and mnemonic.

Arguments

• request - The connection request object

Returns

Result containing either the initialized BreezSdk or an SdkError

impl BreezSdk

pub 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 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 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 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 prepare_send_payment( &self, request: PrepareSendPaymentRequest, ) -> Result<PrepareSendPaymentResponse, SdkError>

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

pub 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>

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.