fedimint-ln-client 0.8.0

fedimint-ln is a lightning payment service module.
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

use fedimint_core::config::FederationId;
use fedimint_core::util::{FmtCompactErrorAnyhow, SafeUrl};
use lightning_invoice::Bolt11Invoice;
use serde::{Deserialize, Serialize};
use thiserror::Error;

use crate::recurring::{PaymentCodeRootKey, RecurringPaymentProtocol};

pub struct RecurringdClient {
    client: reqwest::Client,
    base_url: SafeUrl,
}

impl RecurringdClient {
    pub fn new(base_url: &SafeUrl) -> Self {
        Self {
            client: reqwest::Client::new(),
            base_url: SafeUrl::parse(&format!("{base_url}lnv1/"))
                .expect("failed to parse extended base url"),
        }
    }

    pub async fn register_recurring_payment_code(
        &self,
        federation_id: FederationId,
        protocol: RecurringPaymentProtocol,
        payment_code_root_key: PaymentCodeRootKey,
        meta: &str,
    ) -> Result<RecurringPaymentRegistrationResponse, RecurringdApiError> {
        // TODO: validate decoding works like this and maybe figure out a cleaner way to
        // communicate errors
        let request = RecurringPaymentRegistrationRequest {
            federation_id,
            protocol,
            payment_code_root_key,
            meta: meta.to_owned(),
        };

        let response = self
            .client
            .put(format!("{}paycodes", self.base_url))
            .json(&request)
            .send()
            .await
            .map_err(RecurringdApiError::NetworkError)?;

        response
            .json::<ApiResult<RecurringPaymentRegistrationResponse>>()
            .await
            .map_err(|e| RecurringdApiError::DecodingError(e.into()))?
            .into_result()
    }

    pub async fn await_new_invoice(
        &self,
        payment_code_root_key: PaymentCodeRootKey,
        invoice_index: u64,
    ) -> Result<Bolt11Invoice, RecurringdApiError> {
        let response = self
            .client
            .get(format!(
                "{}paycodes/recipient/{}/generated/{}",
                self.base_url, payment_code_root_key, invoice_index
            ))
            .send()
            .await
            .map_err(RecurringdApiError::NetworkError)?;
        response
            .json::<ApiResult<Bolt11Invoice>>()
            .await
            .map_err(|e| RecurringdApiError::DecodingError(e.into()))?
            .into_result()
    }
}

#[derive(Debug, Error)]
pub enum RecurringdApiError {
    #[error("Recurring payment server error: {0}")]
    ApiError(String),
    #[error("Invalid response: {}", FmtCompactErrorAnyhow(.0))]
    DecodingError(anyhow::Error),
    #[error("Network error: {0}")]
    NetworkError(#[from] reqwest::Error),
}

#[derive(Debug, Clone, PartialOrd, PartialEq, Hash, Serialize, Deserialize)]
pub struct RecurringPaymentRegistrationRequest {
    /// Federation ID in which the invoices should be generated
    pub federation_id: FederationId,
    /// Recurring payment protocol to use
    pub protocol: RecurringPaymentProtocol,
    /// Public key from which other keys will be derived for each generated
    /// invoice
    pub payment_code_root_key: PaymentCodeRootKey,
    /// LNURL meta data, see LUD-06 for more details on the format
    pub meta: String,
}

#[derive(Debug, Clone, PartialOrd, PartialEq, Hash, Serialize, Deserialize)]
pub struct RecurringPaymentRegistrationResponse {
    /// Either a BOLT12 offer or LNURL
    pub recurring_payment_code: String,
}

#[derive(Debug, Deserialize)]
#[serde(untagged)]
enum ApiResult<T> {
    Ok(T),
    Err { error: String },
}

impl<T> ApiResult<T> {
    pub fn into_result(self) -> Result<T, RecurringdApiError> {
        match self {
            ApiResult::Ok(result) => Ok(result),
            ApiResult::Err { error } => Err(RecurringdApiError::ApiError(error)),
        }
    }
}