cdk 0.16.0

Core Cashu Development Kit library implementing the Cashu protocol
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

//! Invoice and offer decoding utilities
//!
//! Provides standalone functions to decode bolt11 invoices and bolt12 offers
//! without requiring a wallet instance or creating melt quotes.

use std::str::FromStr;

use lightning::offers::offer::Offer;
use lightning_invoice::Bolt11Invoice;

use crate::error::Error;

/// Type of Lightning payment request
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum PaymentType {
    /// Bolt11 invoice
    Bolt11,
    /// Bolt12 offer
    Bolt12,
}

/// Decoded invoice or offer information
#[derive(Debug, Clone)]
pub struct DecodedInvoice {
    /// Type of payment request (Bolt11 or Bolt12)
    pub payment_type: PaymentType,
    /// Amount in millisatoshis, if specified
    pub amount_msat: Option<u64>,
    /// Expiry timestamp (Unix timestamp), if specified
    pub expiry: Option<u64>,
    /// Description or offer description, if specified
    pub description: Option<String>,
}

/// Decode a bolt11 invoice or bolt12 offer from a string
///
/// This function attempts to parse the input as a bolt11 invoice first,
/// then as a bolt12 offer if bolt11 parsing fails.
///
/// # Arguments
///
/// * `invoice_str` - The invoice or offer string to decode
///
/// # Returns
///
/// * `Ok(DecodedInvoice)` - Successfully decoded invoice/offer information
/// * `Err(Error)` - Failed to parse as either bolt11 or bolt12
///
/// # Example
///
/// ```ignore
/// let decoded = decode_invoice("lnbc...")?;
/// match decoded.payment_type {
///     PaymentType::Bolt11 => println!("Bolt11 invoice"),
///     PaymentType::Bolt12 => println!("Bolt12 offer"),
/// }
/// ```
pub fn decode_invoice(invoice_str: &str) -> Result<DecodedInvoice, Error> {
    // Try to parse as Bolt11 first
    if let Ok(invoice) = Bolt11Invoice::from_str(invoice_str) {
        let amount_msat = invoice.amount_milli_satoshis();

        let expiry = invoice.expires_at().map(|duration| duration.as_secs());

        let description = match invoice.description() {
            lightning_invoice::Bolt11InvoiceDescriptionRef::Direct(desc) => Some(desc.to_string()),
            lightning_invoice::Bolt11InvoiceDescriptionRef::Hash(hash) => {
                Some(format!("Hash: {}", hash.0))
            }
        };

        return Ok(DecodedInvoice {
            payment_type: PaymentType::Bolt11,
            amount_msat,
            expiry,
            description,
        });
    }

    // Try to parse as Bolt12
    if let Ok(offer) = Offer::from_str(invoice_str) {
        let amount_msat = offer.amount().and_then(|amount| {
            // Bolt12 amounts can be in different currencies
            // For now, we only extract if it's in Bitcoin (millisatoshis)
            match amount {
                lightning::offers::offer::Amount::Bitcoin { amount_msats } => Some(amount_msats),
                _ => None,
            }
        });

        let expiry = offer.absolute_expiry().map(|duration| duration.as_secs());

        let description = offer.description().map(|d| d.to_string());

        return Ok(DecodedInvoice {
            payment_type: PaymentType::Bolt12,
            amount_msat,
            expiry,
            description,
        });
    }

    // If both parsing attempts failed
    Err(Error::InvalidInvoice)
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_decode_bolt11() {
        // This is a valid bolt11 invoice for 100 sats
        let bolt11 = "lnbc1u1p53kkd9pp5ve8pd9zr60yjyvs6tn77mndavzrl5lwd2gx5hk934f6q8jwguzgsdqqcqzzsxqyz5vqrzjqvueefmrckfdwyyu39m0lf24sqzcr9vcrmxrvgfn6empxz7phrjxvrttncqq0lcqqyqqqqlgqqqqqqgq2qsp5482y73fxmlvg4t66nupdaph93h7dcmfsg2ud72wajf0cpk3a96rq9qxpqysgqujexd0l89u5dutn8hxnsec0c7jrt8wz0z67rut0eah0g7p6zhycn2vff0ts5vwn2h93kx8zzqy3tzu4gfhkya2zpdmqelg0ceqnjztcqma65pr";

        let result = decode_invoice(bolt11);
        assert!(result.is_ok());

        let decoded = result.unwrap();
        assert_eq!(decoded.payment_type, PaymentType::Bolt11);
        assert_eq!(decoded.amount_msat, Some(100000));
    }

    #[test]
    fn test_invalid_invoice() {
        let result = decode_invoice("invalid_string");
        assert!(result.is_err());
    }
}