lnbits_rust 0.1.0

A Rust library for the LNbits API
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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96

# lnbits_rust

[![crates.io](https://img.shields.io/crates/v/lnbits_rust.svg)](https://crates.io/crates/lnbits_rust)
[![Documentation](https://docs.rs/lnbits_rust/badge.svg)](https://docs.rs/lnbits_rust)
[![MIT/Apache-2 licensed](https://img.shields.io/crates/l/lnbits_rust.svg)](./LICENSE.txt)
[![CI](https://github.com/0xtlt/lnbits_rust/actions/workflows/ci.yml/badge.svg)](https://github.com/0xtlt/lnbits_rust/actions/workflows/ci.yml)
[![Issues](https://img.shields.io/github/issues/0xtlt/lnbits_rust)](https://img.shields.io/github/issues/0xtlt/lnbits_rust)

An ergonomic, [LNBits](https://lnbits.com/) API Client for Rust.

- [Changelog](CHANGELOG.md)

## Example

```toml
[dependencies]
tokio = { version = "1.0", features = ["full"] }
lnbits_rust = "0.1"
```

And then the code:

```rust,norun
use lnbits_rust::{api::invoice::CreateInvoiceParams, LNBitsClient};

_wallet_id: String,
        admin_key: String,
        invoice_read_key: String,
        lnbits_url: String,
        tor_socket: Option<String>,

#[tokio::main]
async fn main() {
    let client = LNBitsClient::new(
        "wallet id",
        "admin_key",
        "invoice_read_key",
        "http://lnbits_url",
        None,
    )
    .unwrap();

    // OR with tor

    let client = LNBitsClient::new(
        "wallet id",
        "admin_key",
        "invoice_read_key",
        "http://lnbits_url.onion",
        Some("socks5h://127.0.0.1:9050"),
    )
    .unwrap();

    let wallet_details = client.get_wallet_details().await.unwrap();

    println!("wallet_details: {:?}", wallet_details);

    let invoice = client
        .create_invoice(&CreateInvoiceParams {
            amount: 1,
            unit: "sat".to_string(),
            memo: None,
            webhook: None,
            internal: None,
        })
        .await
        .unwrap();

    println!("invoice: {:?}", i);

    println!(
        "decoded invoice: {:?}",
        client.decode_invoice(&i.payment_request).await.unwrap()
    );

    while !client.check_invoice(&i.payment_hash).await.unwrap() {
        println!("Waiting for payment");
        tokio::time::sleep(tokio::time::Duration::from_secs(1)).await;
    }

    println!("Payment received");
}

```

## Key features

- [x] Create invoices
- [x] Decode invoices
- [x] Pay invoices
- [x] Get wallet details
- [x] Tor support

## License

Licensed under MIT license ([LICENSE-MIT](LICENSE-MIT) or <http://opensource.org/licenses/MIT>)