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

use lnbot::{LnBot, LnBotError};

// ---------------------------------------------------------------------------
// Client construction
// ---------------------------------------------------------------------------

#[tokio::test]
async fn new_sends_authorization_header() {
    let mut server = mockito::Server::new_async().await;
    let mock = server
        .mock("GET", "/v1/wallets/wal_1")
        .match_header("authorization", "Bearer key_test")
        .with_status(200)
        .with_header("content-type", "application/json")
        .with_body(r#"{"walletId":"wal_1","name":"Test","balance":0,"onHold":0,"available":0}"#)
        .create_async()
        .await;

    let client = LnBot::new("key_test").with_base_url(server.url());
    client.wallet("wal_1").get().await.unwrap();
    mock.assert_async().await;
}

#[tokio::test]
async fn unauthenticated_omits_authorization() {
    let mut server = mockito::Server::new_async().await;
    let mock = server
        .mock("POST", "/v1/register")
        .match_header("authorization", mockito::Matcher::Missing)
        .with_status(200)
        .with_header("content-type", "application/json")
        .with_body(r#"{"userId":"u1","primaryKey":"uk_1","secondaryKey":"uk_2","recoveryPassphrase":"words"}"#)
        .create_async()
        .await;

    let client = LnBot::unauthenticated().with_base_url(server.url());
    client.register().await.unwrap();
    mock.assert_async().await;
}

#[tokio::test]
async fn sends_accept_json_header() {
    let mut server = mockito::Server::new_async().await;
    let mock = server
        .mock("GET", "/v1/wallets/wal_1")
        .match_header("accept", "application/json")
        .with_status(200)
        .with_header("content-type", "application/json")
        .with_body(r#"{"walletId":"wal_1","name":"Test","balance":0,"onHold":0,"available":0}"#)
        .create_async()
        .await;

    let client = LnBot::new("key_test").with_base_url(server.url());
    client.wallet("wal_1").get().await.unwrap();
    mock.assert_async().await;
}

#[tokio::test]
async fn with_base_url_trims_trailing_slash() {
    let mut server = mockito::Server::new_async().await;
    let mock = server
        .mock("GET", "/v1/wallets/wal_1")
        .with_status(200)
        .with_header("content-type", "application/json")
        .with_body(r#"{"walletId":"wal_1","name":"Test","balance":0,"onHold":0,"available":0}"#)
        .create_async()
        .await;

    let url = format!("{}/", server.url());
    let client = LnBot::new("key_test").with_base_url(url);
    client.wallet("wal_1").get().await.unwrap();
    mock.assert_async().await;
}

// ---------------------------------------------------------------------------
// Register / Me
// ---------------------------------------------------------------------------

#[tokio::test]
async fn register() {
    let mut server = mockito::Server::new_async().await;
    let mock = server
        .mock("POST", "/v1/register")
        .with_status(200)
        .with_header("content-type", "application/json")
        .with_body(r#"{"userId":"u1","primaryKey":"uk_1","secondaryKey":"uk_2","recoveryPassphrase":"word1 word2"}"#)
        .create_async()
        .await;

    let client = LnBot::unauthenticated().with_base_url(server.url());
    let resp = client.register().await.unwrap();
    assert_eq!(resp.user_id, "u1");
    assert_eq!(resp.primary_key, "uk_1");
    assert_eq!(resp.secondary_key, "uk_2");
    assert_eq!(resp.recovery_passphrase, "word1 word2");
    mock.assert_async().await;
}

#[tokio::test]
async fn me() {
    let mut server = mockito::Server::new_async().await;
    let mock = server
        .mock("GET", "/v1/me")
        .with_status(200)
        .with_header("content-type", "application/json")
        .with_body(r#"{"userId":"u1","keyName":"primary","walletId":null}"#)
        .create_async()
        .await;

    let client = LnBot::new("uk_1").with_base_url(server.url());
    let resp = client.me().await.unwrap();
    assert_eq!(resp.user_id, "u1");
    assert_eq!(resp.key_name.as_deref(), Some("primary"));
    assert!(resp.wallet_id.is_none());
    mock.assert_async().await;
}

#[tokio::test]
async fn me_with_wallet_key() {
    let mut server = mockito::Server::new_async().await;
    let mock = server
        .mock("GET", "/v1/me")
        .with_status(200)
        .with_header("content-type", "application/json")
        .with_body(r#"{"userId":"u1","keyName":"wallet","walletId":"wal_1"}"#)
        .create_async()
        .await;

    let client = LnBot::new("wk_1").with_base_url(server.url());
    let resp = client.me().await.unwrap();
    assert_eq!(resp.wallet_id.as_deref(), Some("wal_1"));
    mock.assert_async().await;
}

// ---------------------------------------------------------------------------
// Wallet factory
// ---------------------------------------------------------------------------

#[test]
#[should_panic(expected = "wallet_id must not be empty")]
fn wallet_rejects_empty_id() {
    let client = LnBot::new("key_test");
    client.wallet("");
}

#[tokio::test]
async fn wallet_get() {
    let mut server = mockito::Server::new_async().await;
    let mock = server
        .mock("GET", "/v1/wallets/wal_1")
        .with_status(200)
        .with_header("content-type", "application/json")
        .with_body(r#"{"walletId":"wal_1","name":"My Wallet","balance":1000,"onHold":100,"available":900}"#)
        .create_async()
        .await;

    let client = LnBot::new("key_test").with_base_url(server.url());
    let w = client.wallet("wal_1").get().await.unwrap();
    assert_eq!(w.wallet_id, "wal_1");
    assert_eq!(w.balance, 1000);
    assert_eq!(w.available, 900);
    mock.assert_async().await;
}

#[tokio::test]
async fn wallet_update() {
    let mut server = mockito::Server::new_async().await;
    let mock = server
        .mock("PATCH", "/v1/wallets/wal_1")
        .match_body(mockito::Matcher::Json(serde_json::json!({"name": "Renamed"})))
        .with_status(200)
        .with_header("content-type", "application/json")
        .with_body(r#"{"walletId":"wal_1","name":"Renamed","balance":0,"onHold":0,"available":0}"#)
        .create_async()
        .await;

    let client = LnBot::new("key_test").with_base_url(server.url());
    let w = client
        .wallet("wal_1")
        .update(&lnbot::UpdateWalletRequest::new("Renamed"))
        .await
        .unwrap();
    assert_eq!(w.name, "Renamed");
    mock.assert_async().await;
}

// ---------------------------------------------------------------------------
// Error mapping from HTTP status codes
// ---------------------------------------------------------------------------

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

    let client = LnBot::new("k").with_base_url(server.url());
    let err = client.wallet("wal_1").get().await.unwrap_err();
    assert!(matches!(err, LnBotError::BadRequest { .. }));
}

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

    let client = LnBot::new("k").with_base_url(server.url());
    let err = client.wallet("wal_1").get().await.unwrap_err();
    assert!(matches!(err, LnBotError::Unauthorized { .. }));
}

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

    let client = LnBot::new("k").with_base_url(server.url());
    let err = client.wallet("wal_1").get().await.unwrap_err();
    assert!(matches!(err, LnBotError::Forbidden { .. }));
}

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

    let client = LnBot::new("k").with_base_url(server.url());
    let err = client.wallet("wal_1").get().await.unwrap_err();
    assert!(matches!(err, LnBotError::NotFound { .. }));
}

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

    let client = LnBot::new("k").with_base_url(server.url());
    let err = client.wallet("wal_1").get().await.unwrap_err();
    assert!(matches!(err, LnBotError::Conflict { .. }));
}

#[tokio::test]
async fn maps_500_to_api_error() {
    let mut server = mockito::Server::new_async().await;
    server
        .mock("GET", "/v1/wallets/wal_1")
        .with_status(500)
        .with_body("internal error")
        .create_async()
        .await;

    let client = LnBot::new("k").with_base_url(server.url());
    let err = client.wallet("wal_1").get().await.unwrap_err();
    match err {
        LnBotError::Api { status, body } => {
            assert_eq!(status, 500);
            assert_eq!(body, "internal error");
        }
        other => panic!("expected Api, got {:?}", other),
    }
}

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

    let client = LnBot::new("k").with_base_url(server.url());
    let err = client.wallet("wal_1").get().await.unwrap_err();
    let msg = err.to_string();
    assert!(msg.contains("401"));
    assert!(msg.contains("invalid key"));
}

// ---------------------------------------------------------------------------
// JSON deserialization error
// ---------------------------------------------------------------------------

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

    let client = LnBot::new("k").with_base_url(server.url());
    let err = client.wallet("wal_1").get().await.unwrap_err();
    assert!(matches!(err, LnBotError::Http(_)));
}