ritualistic 0.1.1

simple nostr library
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

#[derive(thiserror::Error, Debug)]
pub enum RelayInformationError {
    #[error("HTTP request failed: {0}")]
    Http(#[from] reqwest::Error),

    #[error("JSON parsing error: {0}")]
    Json(#[from] serde_json::Error),

    #[error("URL normalization error")]
    Normalize(#[from] url::ParseError),
}

pub type Result<T> = std::result::Result<T, RelayInformationError>;

/// relay information document
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize, Default)]
pub struct RelayInformationDocument {
    #[serde(skip)]
    pub url: String,
    #[serde(default)]
    pub name: String,
    #[serde(default)]
    pub description: String,
    #[serde(default)]
    pub pubkey: Option<crate::PubKey>,
    #[serde(default)]
    pub icon: String,
}

/// fetch the metadata for a relay
pub async fn fetch(url: &str) -> Result<RelayInformationDocument> {
    let normalized_url = crate::normalize_url(url)?;

    let mut info = RelayInformationDocument {
        url: normalized_url.to_string(),
        name: normalized_url
            .host_str()
            .map(|s| s.to_string())
            .unwrap_or("".to_string()),
        description: String::new(),
        pubkey: None,
        icon: String::new(),
    };

    let client = reqwest::Client::builder()
        .timeout(std::time::Duration::from_secs(7))
        .build()?;

    let response = client
        .get(format!("http{}", &normalized_url.as_str()[2..]))
        .header("Accept", "application/nostr+json")
        .send()
        .await?;

    if response.status().is_success() {
        let received_info: RelayInformationDocument = response.json().await?;
        info.name = received_info.name;
        info.description = received_info.description;
        info.icon = received_info.icon;
        if received_info.pubkey.is_some() {
            info.pubkey = received_info.pubkey;
        }
    }

    if info.icon.is_empty() {
        let mut icon = normalized_url.clone();
        icon.set_path("/favicon.ico");
        info.icon = format!("http{}", &icon.as_str()[2..]);
    }

    Ok(info)
}

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

    #[tokio::test]
    async fn test_fetch() {
        let test_cases = vec![
            ("wss://nostr.wine", false, "wss://nostr.wine/"),
            ("https://nostr.land", false, "wss://nostr.land/"),
            ("nostr.wine", false, "wss://nostr.wine/"),
            ("relay.damus.io", false, "wss://relay.damus.io/"),
            ("https://nos.lol", false, "wss://nos.lol/"),
            ("wss://relay.primal.net", false, "wss://relay.primal.net/"),
            ("wlenwqkeqwe.asjdaskd", true, "wss://wlenwqkeqwe.asjdaskd/"),
            ("bligblag", true, "wss://bligblag/"),
        ];

        for (input_url, expect_error, expected_url) in test_cases {
            let result = fetch(input_url).await;

            if expect_error {
                assert!(result.is_err(), "expected error for URL: {}", input_url);
                // even on error, we should get the URL back
                if let Err(RelayInformationError::Http(_)) = result {
                    // this is expected for invalid domains
                }
            } else {
                match result {
                    Ok(info) => {
                        assert_eq!(info.url, expected_url);
                        // name might be empty for some relays, that's ok
                    }
                    Err(e) => {
                        panic!("warning: failed to fetch {}: {}", input_url, e);
                    }
                }
            }
        }
    }
}