Struct webln::WebLN

pub struct WebLN { /* private fields */ }

WebLN instance

Implementations

impl WebLN

pub fn new() -> Result<Self, Error>

Compose new WebLN instance

pub async fn is_enabled(&self) -> Result<bool, Error>

Check if webln is enabled without explicitly enabling it through webln.enable() (which may cause a confirmation popup in some providers)

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

To begin interacting with WebLN APIs you’ll first need to enable the provider. Calling webln.enable() will prompt the user for permission to use the WebLN capabilities of the browser. After that you are free to call any of the other API methods.

pub async fn get_info(&self) -> Result<GetInfoResponse, Error>

Get information about the connected node and what WebLN methods it supports.

pub async fn keysend( &self, args: &KeysendArgs ) -> Result<SendPaymentResponse, Error>

Request the user to send a keysend payment. This is a spontaneous payment that does not require an invoice and only needs a destination public key and and amount.

pub async fn make_invoice( &self, args: &RequestInvoiceArgs ) -> Result<RequestInvoiceResponse, Error>

Request that the user creates an invoice to be used by the web app

pub async fn send_payment( &self, invoice: &str ) -> Result<SendPaymentResponse, Error>

Request that the user sends a payment for an invoice.

pub async fn send_multi_payment<I, S>( &self, invoices: I ) -> Result<SendMultiPaymentResponse, Error>

where I: IntoIterator<Item = S>, S: AsRef<str>,

Request that the user sends multiple payments.

pub async fn send_payment_async(&self, invoice: &str) -> Result<(), Error>

Request that the user sends a payment for an invoice. The payment will only be initiated and will not wait for a preimage to be returned. This is useful when paying HOLD Invoices. There is no guarantee that the payment will be successfully sent to the receiver. It’s up to the receiver to check whether or not the invoice has been paid.

pub async fn sign_message( &self, message: &str ) -> Result<SignMessageResponse, Error>

Request that the user signs an arbitrary string message.

pub async fn get_balance(&self) -> Result<BalanceResponse, Error>

Fetch the balance of the current account.

Trait Implementations

impl Clone for WebLN

fn clone(&self) -> WebLN

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WebLN

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.