lnurl_pay/
lud16.rs

1// Copyright (c) 2024 Yuki Kishimoto
2// Distributed under the MIT software license
3
4use alloc::format;
5use alloc::string::{String, ToString};
6use core::fmt;
7use core::str::FromStr;
8
9use serde::{Deserialize, Deserializer, Serialize};
10
11use crate::error::Error;
12use crate::lud06::LnUrl;
13
14#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
15pub struct LightningAddress {
16    name: String,
17    domain: String,
18}
19
20impl fmt::Display for LightningAddress {
21    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
22        write!(f, "{}@{}", self.name, self.domain)
23    }
24}
25
26impl LightningAddress {
27    pub fn parse<S>(ln_addr: S) -> Result<Self, Error>
28    where
29        S: AsRef<str>,
30    {
31        let ln_addr: &str = ln_addr.as_ref();
32        let mut splitted = ln_addr.split('@');
33        let name = splitted.next().ok_or(Error::InvalidLightningAddress)?;
34        let domain = splitted.next().ok_or(Error::InvalidLightningAddress)?;
35        Ok(Self {
36            name: name.to_string(),
37            domain: domain.to_string(),
38        })
39    }
40
41    #[inline]
42    pub fn endpoint(&self) -> String {
43        format!("https://{}/.well-known/lnurlp/{}", self.domain, self.name)
44    }
45
46    #[inline]
47    pub fn lnurl(&self) -> LnUrl {
48        LnUrl::new(self.endpoint())
49    }
50}
51
52impl FromStr for LightningAddress {
53    type Err = Error;
54
55    fn from_str(s: &str) -> Result<Self, Self::Err> {
56        LightningAddress::parse(s)
57    }
58}
59
60impl Serialize for LightningAddress {
61    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
62    where
63        S: serde::Serializer,
64    {
65        serializer.serialize_str(&self.to_string())
66    }
67}
68
69impl<'de> Deserialize<'de> for LightningAddress {
70    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
71    where
72        D: Deserializer<'de>,
73    {
74        let addr = String::deserialize(deserializer)?;
75        LightningAddress::parse(addr).map_err(serde::de::Error::custom)
76    }
77}
78
79#[cfg(test)]
80mod tests {
81    use core::str::FromStr;
82
83    use super::*;
84
85    #[test]
86    fn test_parsing() {
87        let address = LightningAddress::parse("ben@opreturnbot.com").unwrap();
88        assert_eq!(
89            address.endpoint(),
90            "https://opreturnbot.com/.well-known/lnurlp/ben"
91        );
92        assert_eq!(address.to_string(), String::from("ben@opreturnbot.com"))
93    }
94
95    #[test]
96    fn test_invalid_parsing() {
97        assert!(LightningAddress::from_str("invalid").is_err());
98        assert!(LightningAddress::from_str("####").is_err());
99        assert!(LightningAddress::from_str("LNURL1DP68GURN8GHJ7UM9WFMXJCM99E3K7MF0V9CXJ0M385EKVCENXC6R2C35XVUKXEFCV5MKVV34X5EKZD3EV56NYD3HXQURZEPEXEJXXEPNXSCRVWFNV9NXZCN9XQ6XYEFHVGCXXCMYXYMNSERXFQ5FNS").is_err());
100    }
101
102    #[test]
103    fn test_lnurl() {
104        let address = LightningAddress::from_str("ben@opreturnbot.com").unwrap();
105        let lnurl = LnUrl::from_str("lnurl1dp68gurn8ghj7mmswfjhgatjde3x7apwvdhk6tewwajkcmpdddhx7amw9akxuatjd3cz7cn9dc94s6d4").unwrap();
106        assert_eq!(address.lnurl(), lnurl);
107    }
108}
lnurl_pay/lud16.rs

lnurl_pay/
lud16.rs
