Struct breez_sdk_core::BreezServer

pub struct BreezServer { /* private fields */ }

Implementations

impl BreezServer

pub fn new( server_url: String, api_key: Option<String>, ) -> Result<BreezServer, Error>

pub async fn get_channel_opener_client( &self, ) -> Result<ChannelOpenerClient<InterceptedService<Channel, ApiKeyInterceptor>>, ServiceConnectivityError>

pub async fn get_payment_notifier_client( &self, ) -> PaymentNotifierClient<Channel>

pub async fn get_information_client(&self) -> InformationClient<Channel>

pub async fn get_signer_client(&self) -> SignerClient<Channel>

pub async fn get_support_client( &self, ) -> Result<SupportClient<InterceptedService<Channel, ApiKeyInterceptor>>, ServiceConnectivityError>

pub async fn get_swapper_client(&self) -> SwapperClient<Channel>

pub async fn ping(&self) -> Result<String, Error>

pub async fn fetch_mempoolspace_urls( &self, ) -> Result<Vec<String>, ServiceConnectivityError>

pub async fn fetch_boltz_swapper_urls( &self, ) -> Result<Vec<String>, ServiceConnectivityError>

Trait Implementations

impl FiatAPI for BreezServer

fn list_fiat_currencies<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<FiatCurrency>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, BreezServer: 'async_trait,

List all supported fiat currencies for which there is a known exchange rate.

fn fetch_fiat_rates<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<Rate>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, BreezServer: 'async_trait,

Get the live rates from the server.

impl LspAPI for BreezServer

fn list_lsps<'life0, 'async_trait>( &'life0 self, pubkey: String, ) -> Pin<Box<dyn Future<Output = SdkResult<Vec<LspInformation>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

List LSPs available to the given pubkey

fn list_used_lsps<'life0, 'async_trait>( &'life0 self, pubkey: String, ) -> Pin<Box<dyn Future<Output = SdkResult<Vec<LspInformation>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

List all LSPs, active and historical, used by the given pubkey

fn register_payment_notifications<'life0, 'async_trait>( &'life0 self, lsp_id: String, lsp_pubkey: Vec<u8>, webhook_url: String, webhook_url_signature: String, ) -> Pin<Box<dyn Future<Output = SdkResult<RegisterPaymentNotificationResponse>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Register for webhook callbacks at the given webhook_url whenever a new payment is received

fn unregister_payment_notifications<'life0, 'async_trait>( &'life0 self, lsp_id: String, lsp_pubkey: Vec<u8>, webhook_url: String, webhook_url_signature: String, ) -> Pin<Box<dyn Future<Output = SdkResult<RemovePaymentNotificationResponse>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Unregister for webhook callbacks for the given webhook_url

fn register_payment<'life0, 'async_trait>( &'life0 self, lsp_id: String, lsp_pubkey: Vec<u8>, payment_info: PaymentInformation, ) -> Pin<Box<dyn Future<Output = SdkResult<RegisterPaymentReply>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Register a payment to open a new channel with the LSP

impl SupportAPI for BreezServer

fn service_health_check<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = SdkResult<ServiceHealthCheckResponse>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

fn report_payment_failure<'life0, 'async_trait>( &'life0 self, node_state: NodeState, payment: Payment, lsp_id: Option<String>, comment: Option<String>, ) -> Pin<Box<dyn Future<Output = SdkResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

impl SwapperAPI for BreezServer

fn create_swap<'life0, 'async_trait>( &'life0 self, hash: Vec<u8>, payer_pubkey: Vec<u8>, node_id: String, ) -> Pin<Box<dyn Future<Output = Result<Swap, SwapError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

fn complete_swap<'life0, 'async_trait>( &'life0 self, bolt11: String, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,