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
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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
use futures_util::StreamExt;
use lnbot::*;

// ---------------------------------------------------------------------------
// Invoice watch (wallet-scoped)
// ---------------------------------------------------------------------------

#[tokio::test]
async fn invoice_watch_yields_event() {
    let mut server = mockito::Server::new_async().await;
    server
        .mock("GET", "/v1/wallets/wal_1/invoices/1/events")
        .with_status(200)
        .with_header("content-type", "text/event-stream")
        .with_body("event: settled\ndata: {\"number\":1,\"status\":\"settled\",\"amount\":100,\"bolt11\":\"lnbc1...\",\"reference\":null,\"memo\":null,\"preimage\":\"abc\",\"txNumber\":null,\"createdAt\":null,\"settledAt\":null,\"expiresAt\":null}\n\n")
        .create_async()
        .await;

    let client = LnBot::new("key_test").with_base_url(server.url());
    let events: Vec<_> = client
        .wallet("wal_1")
        .invoices()
        .watch(1, None)
        .collect::<Vec<_>>()
        .await
        .into_iter()
        .collect::<Result<Vec<_>, _>>()
        .unwrap();

    assert_eq!(events.len(), 1);
    assert_eq!(events[0].event, InvoiceEventType::Settled);
    assert_eq!(events[0].data.number, 1);
    assert_eq!(events[0].data.amount, 100);
}

#[tokio::test]
async fn invoice_watch_multiple_events() {
    let body = "\
        event: pending\n\
        data: {\"number\":1,\"status\":\"pending\",\"amount\":50,\"bolt11\":\"lnbc1...\",\"reference\":null,\"memo\":null,\"preimage\":null,\"txNumber\":null,\"createdAt\":null,\"settledAt\":null,\"expiresAt\":null}\n\
        \n\
        event: settled\n\
        data: {\"number\":1,\"status\":\"settled\",\"amount\":50,\"bolt11\":\"lnbc1...\",\"reference\":null,\"memo\":null,\"preimage\":\"abc\",\"txNumber\":null,\"createdAt\":null,\"settledAt\":null,\"expiresAt\":null}\n\
        \n";

    let mut server = mockito::Server::new_async().await;
    server
        .mock("GET", "/v1/wallets/wal_1/invoices/1/events")
        .with_status(200)
        .with_header("content-type", "text/event-stream")
        .with_body(body)
        .create_async()
        .await;

    let client = LnBot::new("key_test").with_base_url(server.url());
    let events: Vec<InvoiceEvent> = client
        .wallet("wal_1")
        .invoices()
        .watch(1, None)
        .collect::<Vec<_>>()
        .await
        .into_iter()
        .collect::<Result<Vec<_>, _>>()
        .unwrap();

    assert_eq!(events.len(), 2);
    assert_eq!(events[0].event, InvoiceEventType::from("pending"));
    assert_eq!(events[1].event, InvoiceEventType::Settled);
}

#[tokio::test]
async fn invoice_watch_skips_comments() {
    let body = "\
        : keepalive\n\
        \n\
        event: settled\n\
        data: {\"number\":1,\"status\":\"settled\",\"amount\":100,\"bolt11\":\"lnbc1...\",\"reference\":null,\"memo\":null,\"preimage\":null,\"txNumber\":null,\"createdAt\":null,\"settledAt\":null,\"expiresAt\":null}\n\
        \n";

    let mut server = mockito::Server::new_async().await;
    server
        .mock("GET", "/v1/wallets/wal_1/invoices/1/events")
        .with_status(200)
        .with_header("content-type", "text/event-stream")
        .with_body(body)
        .create_async()
        .await;

    let client = LnBot::new("key_test").with_base_url(server.url());
    let events: Vec<InvoiceEvent> = client
        .wallet("wal_1")
        .invoices()
        .watch(1, None)
        .collect::<Vec<_>>()
        .await
        .into_iter()
        .collect::<Result<Vec<_>, _>>()
        .unwrap();

    assert_eq!(events.len(), 1);
}

#[tokio::test]
async fn invoice_watch_empty_stream() {
    let mut server = mockito::Server::new_async().await;
    server
        .mock("GET", "/v1/wallets/wal_1/invoices/1/events")
        .with_status(200)
        .with_header("content-type", "text/event-stream")
        .with_body("")
        .create_async()
        .await;

    let client = LnBot::new("key_test").with_base_url(server.url());
    let events: Vec<_> = client
        .wallet("wal_1")
        .invoices()
        .watch(1, None)
        .collect::<Vec<_>>()
        .await
        .into_iter()
        .collect::<Result<Vec<_>, _>>()
        .unwrap();

    assert!(events.is_empty());
}

#[tokio::test]
async fn invoice_watch_with_timeout() {
    let mut server = mockito::Server::new_async().await;
    let mock = server
        .mock("GET", "/v1/wallets/wal_1/invoices/42/events?timeout=120")
        .with_status(200)
        .with_header("content-type", "text/event-stream")
        .with_body("")
        .create_async()
        .await;

    let client = LnBot::new("key_test").with_base_url(server.url());
    let _: Vec<_> = client
        .wallet("wal_1")
        .invoices()
        .watch(42, Some(120))
        .collect()
        .await;
    mock.assert_async().await;
}

#[tokio::test]
async fn invoice_watch_sends_sse_accept_header() {
    let mut server = mockito::Server::new_async().await;
    let mock = server
        .mock("GET", "/v1/wallets/wal_1/invoices/1/events")
        .match_header("accept", "text/event-stream")
        .with_status(200)
        .with_header("content-type", "text/event-stream")
        .with_body("")
        .create_async()
        .await;

    let client = LnBot::new("key_test").with_base_url(server.url());
    let _: Vec<_> = client
        .wallet("wal_1")
        .invoices()
        .watch(1, None)
        .collect()
        .await;
    mock.assert_async().await;
}

#[tokio::test]
async fn invoice_watch_sends_authorization() {
    let mut server = mockito::Server::new_async().await;
    let mock = server
        .mock("GET", "/v1/wallets/wal_1/invoices/1/events")
        .match_header("authorization", "Bearer key_test")
        .with_status(200)
        .with_header("content-type", "text/event-stream")
        .with_body("")
        .create_async()
        .await;

    let client = LnBot::new("key_test").with_base_url(server.url());
    let _: Vec<_> = client
        .wallet("wal_1")
        .invoices()
        .watch(1, None)
        .collect()
        .await;
    mock.assert_async().await;
}

#[tokio::test]
async fn invoice_watch_by_hash() {
    let mut server = mockito::Server::new_async().await;
    let mock = server
        .mock("GET", "/v1/wallets/wal_1/invoices/abc123/events")
        .with_status(200)
        .with_header("content-type", "text/event-stream")
        .with_body("")
        .create_async()
        .await;

    let client = LnBot::new("key_test").with_base_url(server.url());
    let _: Vec<_> = client
        .wallet("wal_1")
        .invoices()
        .watch_by_hash("abc123", None)
        .collect()
        .await;
    mock.assert_async().await;
}

#[tokio::test]
async fn invoice_watch_http_error() {
    let mut server = mockito::Server::new_async().await;
    server
        .mock("GET", "/v1/wallets/wal_1/invoices/1/events")
        .with_status(401)
        .with_body(r#"{"message":"unauthorized"}"#)
        .create_async()
        .await;

    let client = LnBot::new("bad_key").with_base_url(server.url());
    let results: Vec<_> = client
        .wallet("wal_1")
        .invoices()
        .watch(1, None)
        .collect()
        .await;
    assert_eq!(results.len(), 1);
    let err = results[0].as_ref().unwrap_err();
    assert!(matches!(err, LnBotError::Unauthorized { .. }));
}

// ---------------------------------------------------------------------------
// Payment watch (wallet-scoped)
// ---------------------------------------------------------------------------

#[tokio::test]
async fn payment_watch_yields_event() {
    let mut server = mockito::Server::new_async().await;
    server
        .mock("GET", "/v1/wallets/wal_1/payments/1/events")
        .with_status(200)
        .with_header("content-type", "text/event-stream")
        .with_body("event: settled\ndata: {\"number\":1,\"status\":\"settled\",\"amount\":50,\"maxFee\":10,\"serviceFee\":0,\"actualFee\":1,\"address\":\"user@ln.bot\",\"reference\":null,\"preimage\":null,\"txNumber\":null,\"failureReason\":null,\"createdAt\":null,\"settledAt\":null}\n\n")
        .create_async()
        .await;

    let client = LnBot::new("key_test").with_base_url(server.url());
    let events: Vec<PaymentEvent> = client
        .wallet("wal_1")
        .payments()
        .watch(1, None)
        .collect::<Vec<_>>()
        .await
        .into_iter()
        .collect::<Result<Vec<_>, _>>()
        .unwrap();

    assert_eq!(events.len(), 1);
    assert_eq!(events[0].event, PaymentEventType::Settled);
    assert_eq!(events[0].data.amount, 50);
}

#[tokio::test]
async fn payment_watch_with_timeout() {
    let mut server = mockito::Server::new_async().await;
    let mock = server
        .mock("GET", "/v1/wallets/wal_1/payments/7/events?timeout=60")
        .with_status(200)
        .with_header("content-type", "text/event-stream")
        .with_body("")
        .create_async()
        .await;

    let client = LnBot::new("key_test").with_base_url(server.url());
    let _: Vec<_> = client
        .wallet("wal_1")
        .payments()
        .watch(7, Some(60))
        .collect()
        .await;
    mock.assert_async().await;
}

#[tokio::test]
async fn payment_watch_by_hash() {
    let mut server = mockito::Server::new_async().await;
    let mock = server
        .mock("GET", "/v1/wallets/wal_1/payments/hash123/events")
        .with_status(200)
        .with_header("content-type", "text/event-stream")
        .with_body("")
        .create_async()
        .await;

    let client = LnBot::new("key_test").with_base_url(server.url());
    let _: Vec<_> = client
        .wallet("wal_1")
        .payments()
        .watch_by_hash("hash123", None)
        .collect()
        .await;
    mock.assert_async().await;
}

#[tokio::test]
async fn payment_watch_http_error() {
    let mut server = mockito::Server::new_async().await;
    server
        .mock("GET", "/v1/wallets/wal_1/payments/1/events")
        .with_status(403)
        .with_body(r#"{"message":"forbidden"}"#)
        .create_async()
        .await;

    let client = LnBot::new("key_test").with_base_url(server.url());
    let results: Vec<_> = client
        .wallet("wal_1")
        .payments()
        .watch(1, None)
        .collect()
        .await;
    assert_eq!(results.len(), 1);
    let err = results[0].as_ref().unwrap_err();
    assert!(matches!(err, LnBotError::Forbidden { .. }));
}

// ---------------------------------------------------------------------------
// Events stream (wallet-scoped)
// ---------------------------------------------------------------------------

#[tokio::test]
async fn events_stream_yields_event() {
    let mut server = mockito::Server::new_async().await;
    server
        .mock("GET", "/v1/wallets/wal_1/events")
        .with_status(200)
        .with_header("content-type", "text/event-stream")
        .with_body("data: {\"event\":\"invoice.settled\",\"createdAt\":\"2024-01-01T00:00:00Z\",\"data\":{\"number\":1}}\n")
        .create_async()
        .await;

    let client = LnBot::new("key_test").with_base_url(server.url());
    let events: Vec<WalletEvent> = client
        .wallet("wal_1")
        .events()
        .stream()
        .collect::<Vec<_>>()
        .await
        .into_iter()
        .collect::<Result<Vec<_>, _>>()
        .unwrap();

    assert_eq!(events.len(), 1);
    assert_eq!(events[0].event, "invoice.settled");
    assert_eq!(events[0].data["number"], 1);
}

#[tokio::test]
async fn events_stream_multiple() {
    let body = "\
        data: {\"event\":\"invoice.settled\",\"createdAt\":\"2024-01-01T00:00:00Z\",\"data\":{\"number\":1}}\n\
        data: {\"event\":\"payment.settled\",\"createdAt\":\"2024-01-01T00:00:00Z\",\"data\":{\"number\":2}}\n";

    let mut server = mockito::Server::new_async().await;
    server
        .mock("GET", "/v1/wallets/wal_1/events")
        .with_status(200)
        .with_header("content-type", "text/event-stream")
        .with_body(body)
        .create_async()
        .await;

    let client = LnBot::new("key_test").with_base_url(server.url());
    let events: Vec<WalletEvent> = client
        .wallet("wal_1")
        .events()
        .stream()
        .collect::<Vec<_>>()
        .await
        .into_iter()
        .collect::<Result<Vec<_>, _>>()
        .unwrap();

    assert_eq!(events.len(), 2);
    assert_eq!(events[0].event, "invoice.settled");
    assert_eq!(events[1].event, "payment.settled");
}

#[tokio::test]
async fn events_stream_skips_non_data_lines() {
    let body = "\
        : keepalive\n\
        event: ignored\n\
        data: {\"event\":\"payment.settled\",\"createdAt\":\"2024-01-01T00:00:00Z\",\"data\":{\"number\":1}}\n";

    let mut server = mockito::Server::new_async().await;
    server
        .mock("GET", "/v1/wallets/wal_1/events")
        .with_status(200)
        .with_header("content-type", "text/event-stream")
        .with_body(body)
        .create_async()
        .await;

    let client = LnBot::new("key_test").with_base_url(server.url());
    let events: Vec<WalletEvent> = client
        .wallet("wal_1")
        .events()
        .stream()
        .collect::<Vec<_>>()
        .await
        .into_iter()
        .collect::<Result<Vec<_>, _>>()
        .unwrap();

    assert_eq!(events.len(), 1);
    assert_eq!(events[0].event, "payment.settled");
}

#[tokio::test]
async fn events_stream_sends_sse_headers() {
    let mut server = mockito::Server::new_async().await;
    let mock = server
        .mock("GET", "/v1/wallets/wal_1/events")
        .match_header("accept", "text/event-stream")
        .with_status(200)
        .with_header("content-type", "text/event-stream")
        .with_body("")
        .create_async()
        .await;

    let client = LnBot::new("key_test").with_base_url(server.url());
    let _: Vec<_> = client.wallet("wal_1").events().stream().collect().await;
    mock.assert_async().await;
}

#[tokio::test]
async fn events_stream_empty() {
    let mut server = mockito::Server::new_async().await;
    server
        .mock("GET", "/v1/wallets/wal_1/events")
        .with_status(200)
        .with_header("content-type", "text/event-stream")
        .with_body("")
        .create_async()
        .await;

    let client = LnBot::new("key_test").with_base_url(server.url());
    let events: Vec<_> = client
        .wallet("wal_1")
        .events()
        .stream()
        .collect::<Vec<_>>()
        .await
        .into_iter()
        .collect::<Result<Vec<_>, _>>()
        .unwrap();

    assert!(events.is_empty());
}

#[tokio::test]
async fn events_stream_http_error() {
    let mut server = mockito::Server::new_async().await;
    server
        .mock("GET", "/v1/wallets/wal_1/events")
        .with_status(403)
        .with_body(r#"{"message":"forbidden"}"#)
        .create_async()
        .await;

    let client = LnBot::new("key_test").with_base_url(server.url());
    let results: Vec<_> = client.wallet("wal_1").events().stream().collect().await;
    assert_eq!(results.len(), 1);
    let err = results[0].as_ref().unwrap_err();
    assert!(matches!(err, LnBotError::Forbidden { .. }));
}