nostr-types 0.1.4

Types for nostr protocol handling
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

use serde::{Deserialize, Serialize};

/// Metadata about a user
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub struct Metadata {
    /// User name
    pub name: Option<String>,

    /// About the user
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    pub about: Option<String>,

    /// A url or other string representation of a picture of the user
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    pub picture: Option<String>,

    /// NIP-05
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    pub nip05: Option<String>,

    /// Lightning Network Address (lnurl)
    /// This is not standardized but in common use
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(default)]
    pub lud16: Option<String>,
}

impl Metadata {
    // Mock data for testing
    #[allow(dead_code)]
    pub(crate) fn mock() -> Metadata {
        Metadata {
            name: Some("Mike".to_owned()),
            about: Some("Just some guy".to_owned()),
            picture: None,
            nip05: None,
            lud16: None,
        }
    }
}

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

    test_serde! {Metadata, test_metadata_serde}
}