lnbot 1.0.0

Official Rust SDK for LnBot — Bitcoin for AI Agents. Send and receive sats over Lightning.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

use crate::client::LnBot;
use crate::errors::LnBotError;
use crate::types::*;

/// Wallet-scoped Lightning address operations.
pub struct AddressesResource<'a> {
    pub(crate) client: &'a LnBot,
    pub(crate) prefix: &'a str,
}

impl AddressesResource<'_> {
    /// Creates or claims a Lightning address.
    pub async fn create(&self, req: &CreateAddressRequest) -> Result<AddressResponse, LnBotError> {
        self.client
            .post(&format!("{}/addresses", self.prefix), Some(req))
            .await
    }

    /// Lists all Lightning addresses for the wallet.
    pub async fn list(&self) -> Result<Vec<AddressResponse>, LnBotError> {
        self.client
            .get(&format!("{}/addresses", self.prefix))
            .await
    }

    /// Deletes a Lightning address.
    pub async fn delete(&self, address: &str) -> Result<(), LnBotError> {
        self.client
            .delete(&format!(
                "{}/addresses/{}",
                self.prefix,
                urlencoding::encode(address)
            ))
            .await
    }

    /// Transfers a Lightning address to another wallet.
    pub async fn transfer(
        &self,
        address: &str,
        req: &TransferAddressRequest,
    ) -> Result<TransferAddressResponse, LnBotError> {
        self.client
            .post(
                &format!(
                    "{}/addresses/{}/transfer",
                    self.prefix,
                    urlencoding::encode(address)
                ),
                Some(req),
            )
            .await
    }
}