forked from lightningdevkit/ldk-server
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathclient.rs
More file actions
554 lines (491 loc) · 23.7 KB
/
client.rs
File metadata and controls
554 lines (491 loc) · 23.7 KB
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
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
// This file is Copyright its original authors, visible in version control
// history.
//
// This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
// or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
// You may not use this file except in accordance with one or both of these
// licenses.
use std::time::{SystemTime, UNIX_EPOCH};
use bitcoin_hashes::hmac::{Hmac, HmacEngine};
use bitcoin_hashes::{sha256, Hash, HashEngine};
use ldk_server_protos::api::{
Bolt11ClaimForHashRequest, Bolt11ClaimForHashResponse, Bolt11FailForHashRequest,
Bolt11FailForHashResponse, Bolt11ReceiveForHashRequest, Bolt11ReceiveForHashResponse,
Bolt11ReceiveRequest, Bolt11ReceiveResponse, Bolt11ReceiveVariableAmountViaJitChannelRequest,
Bolt11ReceiveVariableAmountViaJitChannelResponse, Bolt11ReceiveViaJitChannelRequest,
Bolt11ReceiveViaJitChannelResponse, Bolt11SendRequest, Bolt11SendResponse,
Bolt12ReceiveRequest, Bolt12ReceiveResponse, Bolt12SendRequest, Bolt12SendResponse,
CloseChannelRequest, CloseChannelResponse, ConnectPeerRequest, ConnectPeerResponse,
DecodeInvoiceRequest, DecodeInvoiceResponse, DecodeOfferRequest, DecodeOfferResponse,
DisconnectPeerRequest, DisconnectPeerResponse, ExportPathfindingScoresRequest,
ExportPathfindingScoresResponse, ForceCloseChannelRequest, ForceCloseChannelResponse,
GetBalancesRequest, GetBalancesResponse, GetNodeInfoRequest, GetNodeInfoResponse,
GetPaymentDetailsRequest, GetPaymentDetailsResponse, GraphGetChannelRequest,
GraphGetChannelResponse, GraphGetNodeRequest, GraphGetNodeResponse, GraphListChannelsRequest,
GraphListChannelsResponse, GraphListNodesRequest, GraphListNodesResponse, ListChannelsRequest,
ListChannelsResponse, ListForwardedPaymentsRequest, ListForwardedPaymentsResponse,
ListPaymentsRequest, ListPaymentsResponse, ListPeersRequest, ListPeersResponse,
OnchainReceiveRequest, OnchainReceiveResponse, OnchainSendRequest, OnchainSendResponse,
OpenChannelRequest, OpenChannelResponse, SignMessageRequest, SignMessageResponse,
SpliceInRequest, SpliceInResponse, SpliceOutRequest, SpliceOutResponse, SpontaneousSendRequest,
SpontaneousSendResponse, UnifiedSendRequest, UnifiedSendResponse, UpdateChannelConfigRequest,
UpdateChannelConfigResponse, VerifySignatureRequest, VerifySignatureResponse,
};
use ldk_server_protos::endpoints::{
BOLT11_CLAIM_FOR_HASH_PATH, BOLT11_FAIL_FOR_HASH_PATH, BOLT11_RECEIVE_FOR_HASH_PATH,
BOLT11_RECEIVE_PATH, BOLT11_RECEIVE_VARIABLE_AMOUNT_VIA_JIT_CHANNEL_PATH,
BOLT11_RECEIVE_VIA_JIT_CHANNEL_PATH, BOLT11_SEND_PATH, BOLT12_RECEIVE_PATH, BOLT12_SEND_PATH,
CLOSE_CHANNEL_PATH, CONNECT_PEER_PATH, DECODE_INVOICE_PATH, DECODE_OFFER_PATH,
DISCONNECT_PEER_PATH, EXPORT_PATHFINDING_SCORES_PATH, FORCE_CLOSE_CHANNEL_PATH,
GET_BALANCES_PATH, GET_METRICS_PATH, GET_NODE_INFO_PATH, GET_PAYMENT_DETAILS_PATH,
GRAPH_GET_CHANNEL_PATH, GRAPH_GET_NODE_PATH, GRAPH_LIST_CHANNELS_PATH, GRAPH_LIST_NODES_PATH,
LIST_CHANNELS_PATH, LIST_FORWARDED_PAYMENTS_PATH, LIST_PAYMENTS_PATH, LIST_PEERS_PATH,
ONCHAIN_RECEIVE_PATH, ONCHAIN_SEND_PATH, OPEN_CHANNEL_PATH, SIGN_MESSAGE_PATH, SPLICE_IN_PATH,
SPLICE_OUT_PATH, SPONTANEOUS_SEND_PATH, UNIFIED_SEND_PATH, UPDATE_CHANNEL_CONFIG_PATH,
VERIFY_SIGNATURE_PATH,
};
use ldk_server_protos::error::{ErrorCode, ErrorResponse};
use prost::bytes::Bytes;
use prost::Message;
use reqwest::header::CONTENT_TYPE;
use reqwest::{Certificate, Client};
use crate::error::LdkServerError;
use crate::error::LdkServerErrorCode::{
AuthError, InternalError, InternalServerError, InvalidRequestError, LightningError,
};
const APPLICATION_OCTET_STREAM: &str = "application/octet-stream";
/// Client to access a hosted instance of LDK Server.
///
/// The client requires the server's TLS certificate to be provided for verification.
/// This certificate can be found at `<server_storage_dir>/tls.crt` after the
/// server generates it on first startup.
#[derive(Clone)]
pub struct LdkServerClient {
base_url: String,
client: Client,
api_key: String,
}
enum RequestType {
Get,
Post,
}
impl LdkServerClient {
/// Constructs a [`LdkServerClient`] using `base_url` as the ldk-server endpoint.
///
/// `base_url` should not include the scheme, e.g., `localhost:3000`.
/// `api_key` is used for HMAC-based authentication.
/// `server_cert_pem` is the server's TLS certificate in PEM format. This can be
/// found at `<server_storage_dir>/tls.crt` after the server starts.
pub fn new(base_url: String, api_key: String, server_cert_pem: &[u8]) -> Result<Self, String> {
let cert = Certificate::from_pem(server_cert_pem)
.map_err(|e| format!("Failed to parse server certificate: {e}"))?;
let client = Client::builder()
.add_root_certificate(cert)
.build()
.map_err(|e| format!("Failed to build HTTP client: {e}"))?;
Ok(Self { base_url, client, api_key })
}
/// Computes the HMAC-SHA256 authentication header value.
/// Format: "HMAC <timestamp>:<hmac_hex>"
fn compute_auth_header(&self, body: &[u8]) -> String {
let timestamp = SystemTime::now()
.duration_since(UNIX_EPOCH)
.expect("System time should be after Unix epoch")
.as_secs();
// Compute HMAC-SHA256(api_key, timestamp_bytes || body)
let mut hmac_engine: HmacEngine<sha256::Hash> = HmacEngine::new(self.api_key.as_bytes());
hmac_engine.input(×tamp.to_be_bytes());
hmac_engine.input(body);
let hmac_result = Hmac::<sha256::Hash>::from_engine(hmac_engine);
format!("HMAC {}:{}", timestamp, hmac_result)
}
/// Retrieve the latest node info like `node_id`, `current_best_block` etc.
/// For API contract/usage, refer to docs for [`GetNodeInfoRequest`] and [`GetNodeInfoResponse`].
pub async fn get_node_info(
&self, request: GetNodeInfoRequest,
) -> Result<GetNodeInfoResponse, LdkServerError> {
let url = format!("https://{}/{GET_NODE_INFO_PATH}", self.base_url);
self.post_request(&request, &url).await
}
/// Retrieve the node metrics in Prometheus format.
pub async fn get_metrics(&self) -> Result<String, LdkServerError> {
self.get_metrics_with_auth(None, None).await
}
/// Retrieve the node metrics in Prometheus format using Basic Auth.
pub async fn get_metrics_with_auth(
&self, username: Option<&str>, password: Option<&str>,
) -> Result<String, LdkServerError> {
let url = format!("https://{}/{GET_METRICS_PATH}", self.base_url);
let payload =
self.make_request(&url, RequestType::Get, None, false, username, password).await?;
String::from_utf8(payload.to_vec()).map_err(|e| {
LdkServerError::new(
InternalError,
format!("Failed to decode metrics response as string: {}", e),
)
})
}
/// Retrieves an overview of all known balances.
/// For API contract/usage, refer to docs for [`GetBalancesRequest`] and [`GetBalancesResponse`].
pub async fn get_balances(
&self, request: GetBalancesRequest,
) -> Result<GetBalancesResponse, LdkServerError> {
let url = format!("https://{}/{GET_BALANCES_PATH}", self.base_url);
self.post_request(&request, &url).await
}
/// Retrieve a new on-chain funding address.
/// For API contract/usage, refer to docs for [`OnchainReceiveRequest`] and [`OnchainReceiveResponse`].
pub async fn onchain_receive(
&self, request: OnchainReceiveRequest,
) -> Result<OnchainReceiveResponse, LdkServerError> {
let url = format!("https://{}/{ONCHAIN_RECEIVE_PATH}", self.base_url);
self.post_request(&request, &url).await
}
/// Send an on-chain payment to the given address.
/// For API contract/usage, refer to docs for [`OnchainSendRequest`] and [`OnchainSendResponse`].
pub async fn onchain_send(
&self, request: OnchainSendRequest,
) -> Result<OnchainSendResponse, LdkServerError> {
let url = format!("https://{}/{ONCHAIN_SEND_PATH}", self.base_url);
self.post_request(&request, &url).await
}
/// Retrieve a new BOLT11 payable invoice.
/// For API contract/usage, refer to docs for [`Bolt11ReceiveRequest`] and [`Bolt11ReceiveResponse`].
pub async fn bolt11_receive(
&self, request: Bolt11ReceiveRequest,
) -> Result<Bolt11ReceiveResponse, LdkServerError> {
let url = format!("https://{}/{BOLT11_RECEIVE_PATH}", self.base_url);
self.post_request(&request, &url).await
}
/// Retrieve a new BOLT11 payable invoice for a given payment hash.
/// The inbound payment will NOT be automatically claimed upon arrival.
/// For API contract/usage, refer to docs for [`Bolt11ReceiveForHashRequest`] and [`Bolt11ReceiveForHashResponse`].
pub async fn bolt11_receive_for_hash(
&self, request: Bolt11ReceiveForHashRequest,
) -> Result<Bolt11ReceiveForHashResponse, LdkServerError> {
let url = format!("https://{}/{BOLT11_RECEIVE_FOR_HASH_PATH}", self.base_url);
self.post_request(&request, &url).await
}
/// Manually claim a payment for a given payment hash with the corresponding preimage.
/// For API contract/usage, refer to docs for [`Bolt11ClaimForHashRequest`] and [`Bolt11ClaimForHashResponse`].
pub async fn bolt11_claim_for_hash(
&self, request: Bolt11ClaimForHashRequest,
) -> Result<Bolt11ClaimForHashResponse, LdkServerError> {
let url = format!("https://{}/{BOLT11_CLAIM_FOR_HASH_PATH}", self.base_url);
self.post_request(&request, &url).await
}
/// Manually fail a payment for a given payment hash.
/// For API contract/usage, refer to docs for [`Bolt11FailForHashRequest`] and [`Bolt11FailForHashResponse`].
pub async fn bolt11_fail_for_hash(
&self, request: Bolt11FailForHashRequest,
) -> Result<Bolt11FailForHashResponse, LdkServerError> {
let url = format!("https://{}/{BOLT11_FAIL_FOR_HASH_PATH}", self.base_url);
self.post_request(&request, &url).await
}
/// Retrieve a new fixed-amount BOLT11 invoice for receiving via an LSPS2 JIT channel.
/// For API contract/usage, refer to docs for [`Bolt11ReceiveViaJitChannelRequest`] and
/// [`Bolt11ReceiveViaJitChannelResponse`].
pub async fn bolt11_receive_via_jit_channel(
&self, request: Bolt11ReceiveViaJitChannelRequest,
) -> Result<Bolt11ReceiveViaJitChannelResponse, LdkServerError> {
let url = format!("https://{}/{BOLT11_RECEIVE_VIA_JIT_CHANNEL_PATH}", self.base_url);
self.post_request(&request, &url).await
}
/// Retrieve a new variable-amount BOLT11 invoice for receiving via an LSPS2 JIT channel.
/// For API contract/usage, refer to docs for
/// [`Bolt11ReceiveVariableAmountViaJitChannelRequest`] and
/// [`Bolt11ReceiveVariableAmountViaJitChannelResponse`].
pub async fn bolt11_receive_variable_amount_via_jit_channel(
&self, request: Bolt11ReceiveVariableAmountViaJitChannelRequest,
) -> Result<Bolt11ReceiveVariableAmountViaJitChannelResponse, LdkServerError> {
let url = format!(
"https://{}/{BOLT11_RECEIVE_VARIABLE_AMOUNT_VIA_JIT_CHANNEL_PATH}",
self.base_url,
);
self.post_request(&request, &url).await
}
/// Send a payment for a BOLT11 invoice.
/// For API contract/usage, refer to docs for [`Bolt11SendRequest`] and [`Bolt11SendResponse`].
pub async fn bolt11_send(
&self, request: Bolt11SendRequest,
) -> Result<Bolt11SendResponse, LdkServerError> {
let url = format!("https://{}/{BOLT11_SEND_PATH}", self.base_url);
self.post_request(&request, &url).await
}
/// Retrieve a new BOLT11 payable offer.
/// For API contract/usage, refer to docs for [`Bolt12ReceiveRequest`] and [`Bolt12ReceiveResponse`].
pub async fn bolt12_receive(
&self, request: Bolt12ReceiveRequest,
) -> Result<Bolt12ReceiveResponse, LdkServerError> {
let url = format!("https://{}/{BOLT12_RECEIVE_PATH}", self.base_url);
self.post_request(&request, &url).await
}
/// Send a payment for a BOLT12 offer.
/// For API contract/usage, refer to docs for [`Bolt12SendRequest`] and [`Bolt12SendResponse`].
pub async fn bolt12_send(
&self, request: Bolt12SendRequest,
) -> Result<Bolt12SendResponse, LdkServerError> {
let url = format!("https://{}/{BOLT12_SEND_PATH}", self.base_url);
self.post_request(&request, &url).await
}
/// Creates a new outbound channel.
/// For API contract/usage, refer to docs for [`OpenChannelRequest`] and [`OpenChannelResponse`].
pub async fn open_channel(
&self, request: OpenChannelRequest,
) -> Result<OpenChannelResponse, LdkServerError> {
let url = format!("https://{}/{OPEN_CHANNEL_PATH}", self.base_url);
self.post_request(&request, &url).await
}
/// Splices funds into the channel specified by given request.
/// For API contract/usage, refer to docs for [`SpliceInRequest`] and [`SpliceInResponse`].
pub async fn splice_in(
&self, request: SpliceInRequest,
) -> Result<SpliceInResponse, LdkServerError> {
let url = format!("https://{}/{SPLICE_IN_PATH}", self.base_url);
self.post_request(&request, &url).await
}
/// Splices funds out of the channel specified by given request.
/// For API contract/usage, refer to docs for [`SpliceOutRequest`] and [`SpliceOutResponse`].
pub async fn splice_out(
&self, request: SpliceOutRequest,
) -> Result<SpliceOutResponse, LdkServerError> {
let url = format!("https://{}/{SPLICE_OUT_PATH}", self.base_url);
self.post_request(&request, &url).await
}
/// Closes the channel specified by given request.
/// For API contract/usage, refer to docs for [`CloseChannelRequest`] and [`CloseChannelResponse`].
pub async fn close_channel(
&self, request: CloseChannelRequest,
) -> Result<CloseChannelResponse, LdkServerError> {
let url = format!("https://{}/{CLOSE_CHANNEL_PATH}", self.base_url);
self.post_request(&request, &url).await
}
/// Force closes the channel specified by given request.
/// For API contract/usage, refer to docs for [`ForceCloseChannelRequest`] and [`ForceCloseChannelResponse`].
pub async fn force_close_channel(
&self, request: ForceCloseChannelRequest,
) -> Result<ForceCloseChannelResponse, LdkServerError> {
let url = format!("https://{}/{FORCE_CLOSE_CHANNEL_PATH}", self.base_url);
self.post_request(&request, &url).await
}
/// Retrieves list of known channels.
/// For API contract/usage, refer to docs for [`ListChannelsRequest`] and [`ListChannelsResponse`].
pub async fn list_channels(
&self, request: ListChannelsRequest,
) -> Result<ListChannelsResponse, LdkServerError> {
let url = format!("https://{}/{LIST_CHANNELS_PATH}", self.base_url);
self.post_request(&request, &url).await
}
/// Retrieves list of all payments sent or received by us.
/// For API contract/usage, refer to docs for [`ListPaymentsRequest`] and [`ListPaymentsResponse`].
pub async fn list_payments(
&self, request: ListPaymentsRequest,
) -> Result<ListPaymentsResponse, LdkServerError> {
let url = format!("https://{}/{LIST_PAYMENTS_PATH}", self.base_url);
self.post_request(&request, &url).await
}
/// Updates the config for a previously opened channel.
/// For API contract/usage, refer to docs for [`UpdateChannelConfigRequest`] and [`UpdateChannelConfigResponse`].
pub async fn update_channel_config(
&self, request: UpdateChannelConfigRequest,
) -> Result<UpdateChannelConfigResponse, LdkServerError> {
let url = format!("https://{}/{UPDATE_CHANNEL_CONFIG_PATH}", self.base_url);
self.post_request(&request, &url).await
}
/// Retrieves payment details for a given payment id.
/// For API contract/usage, refer to docs for [`GetPaymentDetailsRequest`] and [`GetPaymentDetailsResponse`].
pub async fn get_payment_details(
&self, request: GetPaymentDetailsRequest,
) -> Result<GetPaymentDetailsResponse, LdkServerError> {
let url = format!("https://{}/{GET_PAYMENT_DETAILS_PATH}", self.base_url);
self.post_request(&request, &url).await
}
/// Retrieves list of all forwarded payments.
/// For API contract/usage, refer to docs for [`ListForwardedPaymentsRequest`] and [`ListForwardedPaymentsResponse`].
pub async fn list_forwarded_payments(
&self, request: ListForwardedPaymentsRequest,
) -> Result<ListForwardedPaymentsResponse, LdkServerError> {
let url = format!("https://{}/{LIST_FORWARDED_PAYMENTS_PATH}", self.base_url);
self.post_request(&request, &url).await
}
/// Connect to a peer on the Lightning Network.
/// For API contract/usage, refer to docs for [`ConnectPeerRequest`] and [`ConnectPeerResponse`].
pub async fn connect_peer(
&self, request: ConnectPeerRequest,
) -> Result<ConnectPeerResponse, LdkServerError> {
let url = format!("https://{}/{CONNECT_PEER_PATH}", self.base_url);
self.post_request(&request, &url).await
}
/// Disconnect from a peer and remove it from the peer store.
/// For API contract/usage, refer to docs for [`DisconnectPeerRequest`] and [`DisconnectPeerResponse`].
pub async fn disconnect_peer(
&self, request: DisconnectPeerRequest,
) -> Result<DisconnectPeerResponse, LdkServerError> {
let url = format!("https://{}/{DISCONNECT_PEER_PATH}", self.base_url);
self.post_request(&request, &url).await
}
/// Retrieves list of peers.
/// For API contract/usage, refer to docs for [`ListPeersRequest`] and [`ListPeersResponse`].
pub async fn list_peers(
&self, request: ListPeersRequest,
) -> Result<ListPeersResponse, LdkServerError> {
let url = format!("https://{}/{LIST_PEERS_PATH}", self.base_url);
self.post_request(&request, &url).await
}
/// Send a spontaneous payment (keysend) to a node.
/// For API contract/usage, refer to docs for [`SpontaneousSendRequest`] and [`SpontaneousSendResponse`].
pub async fn spontaneous_send(
&self, request: SpontaneousSendRequest,
) -> Result<SpontaneousSendResponse, LdkServerError> {
let url = format!("https://{}/{SPONTANEOUS_SEND_PATH}", self.base_url);
self.post_request(&request, &url).await
}
/// Send a payment given a BIP 21 URI or BIP 353 Human-Readable Name.
/// For API contract/usage, refer to docs for [`UnifiedSendRequest`] and [`UnifiedSendResponse`].
pub async fn unified_send(
&self, request: UnifiedSendRequest,
) -> Result<UnifiedSendResponse, LdkServerError> {
let url = format!("https://{}/{UNIFIED_SEND_PATH}", self.base_url);
self.post_request(&request, &url).await
}
/// Decode a BOLT11 invoice and return its parsed fields.
/// For API contract/usage, refer to docs for [`DecodeInvoiceRequest`] and [`DecodeInvoiceResponse`].
pub async fn decode_invoice(
&self, request: DecodeInvoiceRequest,
) -> Result<DecodeInvoiceResponse, LdkServerError> {
let url = format!("https://{}/{DECODE_INVOICE_PATH}", self.base_url);
self.post_request(&request, &url).await
}
/// Decode a BOLT12 offer and return its parsed fields.
/// For API contract/usage, refer to docs for [`DecodeOfferRequest`] and [`DecodeOfferResponse`].
pub async fn decode_offer(
&self, request: DecodeOfferRequest,
) -> Result<DecodeOfferResponse, LdkServerError> {
let url = format!("https://{}/{DECODE_OFFER_PATH}", self.base_url);
self.post_request(&request, &url).await
}
/// Sign a message with the node's secret key.
/// For API contract/usage, refer to docs for [`SignMessageRequest`] and [`SignMessageResponse`].
pub async fn sign_message(
&self, request: SignMessageRequest,
) -> Result<SignMessageResponse, LdkServerError> {
let url = format!("https://{}/{SIGN_MESSAGE_PATH}", self.base_url);
self.post_request(&request, &url).await
}
/// Verify a signature against a message and public key.
/// For API contract/usage, refer to docs for [`VerifySignatureRequest`] and [`VerifySignatureResponse`].
pub async fn verify_signature(
&self, request: VerifySignatureRequest,
) -> Result<VerifySignatureResponse, LdkServerError> {
let url = format!("https://{}/{VERIFY_SIGNATURE_PATH}", self.base_url);
self.post_request(&request, &url).await
}
/// Export the pathfinding scores used by the router.
/// For API contract/usage, refer to docs for [`ExportPathfindingScoresRequest`] and [`ExportPathfindingScoresResponse`].
pub async fn export_pathfinding_scores(
&self, request: ExportPathfindingScoresRequest,
) -> Result<ExportPathfindingScoresResponse, LdkServerError> {
let url = format!("https://{}/{EXPORT_PATHFINDING_SCORES_PATH}", self.base_url);
self.post_request(&request, &url).await
}
/// Returns a list of all known short channel IDs in the network graph.
/// For API contract/usage, refer to docs for [`GraphListChannelsRequest`] and [`GraphListChannelsResponse`].
pub async fn graph_list_channels(
&self, request: GraphListChannelsRequest,
) -> Result<GraphListChannelsResponse, LdkServerError> {
let url = format!("https://{}/{GRAPH_LIST_CHANNELS_PATH}", self.base_url);
self.post_request(&request, &url).await
}
/// Returns information on a channel with the given short channel ID from the network graph.
/// For API contract/usage, refer to docs for [`GraphGetChannelRequest`] and [`GraphGetChannelResponse`].
pub async fn graph_get_channel(
&self, request: GraphGetChannelRequest,
) -> Result<GraphGetChannelResponse, LdkServerError> {
let url = format!("https://{}/{GRAPH_GET_CHANNEL_PATH}", self.base_url);
self.post_request(&request, &url).await
}
/// Returns a list of all known node IDs in the network graph.
/// For API contract/usage, refer to docs for [`GraphListNodesRequest`] and [`GraphListNodesResponse`].
pub async fn graph_list_nodes(
&self, request: GraphListNodesRequest,
) -> Result<GraphListNodesResponse, LdkServerError> {
let url = format!("https://{}/{GRAPH_LIST_NODES_PATH}", self.base_url);
self.post_request(&request, &url).await
}
/// Returns information on a node with the given ID from the network graph.
/// For API contract/usage, refer to docs for [`GraphGetNodeRequest`] and [`GraphGetNodeResponse`].
pub async fn graph_get_node(
&self, request: GraphGetNodeRequest,
) -> Result<GraphGetNodeResponse, LdkServerError> {
let url = format!("https://{}/{GRAPH_GET_NODE_PATH}", self.base_url);
self.post_request(&request, &url).await
}
async fn post_request<Rq: Message, Rs: Message + Default>(
&self, request: &Rq, url: &str,
) -> Result<Rs, LdkServerError> {
let request_body = request.encode_to_vec();
let payload =
self.make_request(url, RequestType::Post, Some(request_body), true, None, None).await?;
Rs::decode(&payload[..]).map_err(|e| {
LdkServerError::new(InternalError, format!("Failed to decode success response: {}", e))
})
}
async fn make_request(
&self, url: &str, request_type: RequestType, body: Option<Vec<u8>>,
hmac_authenticated: bool, metrics_username: Option<&str>, metrics_password: Option<&str>,
) -> Result<Bytes, LdkServerError> {
let builder = match request_type {
RequestType::Get => self.client.get(url),
RequestType::Post => self.client.post(url),
};
let builder = if hmac_authenticated {
let body_for_auth = body.as_deref().unwrap_or(&[]);
let auth_header = self.compute_auth_header(body_for_auth);
builder.header("X-Auth", auth_header)
} else {
builder
};
let builder = if let Some(body_content) = body {
builder.header(CONTENT_TYPE, APPLICATION_OCTET_STREAM).body(body_content)
} else {
builder
};
let builder = if let (Some(username), Some(password)) = (metrics_username, metrics_password)
{
builder.basic_auth(username, Some(password))
} else {
builder
};
let response_raw = builder.send().await.map_err(|e| {
LdkServerError::new(InternalError, format!("HTTP request failed: {}", e))
})?;
self.handle_response(response_raw).await
}
async fn handle_response(
&self, response_raw: reqwest::Response,
) -> Result<Bytes, LdkServerError> {
let status = response_raw.status();
let payload = response_raw.bytes().await.map_err(|e| {
LdkServerError::new(InternalError, format!("Failed to read response body: {}", e))
})?;
if status.is_success() {
Ok(payload)
} else {
let error_response = ErrorResponse::decode(&payload[..]).map_err(|e| {
LdkServerError::new(
InternalError,
format!("Failed to decode error response (status {}): {}", status, e),
)
})?;
let error_code = match ErrorCode::from_i32(error_response.error_code) {
Some(ErrorCode::InvalidRequestError) => InvalidRequestError,
Some(ErrorCode::AuthError) => AuthError,
Some(ErrorCode::LightningError) => LightningError,
Some(ErrorCode::InternalServerError) => InternalServerError,
Some(ErrorCode::UnknownError) | None => InternalError,
};
Err(LdkServerError::new(error_code, error_response.message))
}
}
}