nostro2-nips 0.1.5

Nostro2 is a simple toolset for interacting with the Nostr 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

#[derive(Debug)]
pub enum Nip17Error {
    SigningError(nostro2::errors::NostrErrors),
    Nip44Error(crate::nip_44::Nip44Error),
    ParseError(String),
    Nip59Error(crate::nip_59::Nip59Error),
}
impl std::fmt::Display for Nip17Error {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::Nip44Error(e) => write!(f, "Nip44Error: {e}"),
            Self::ParseError(e) => write!(f, "ParseError: {e}"),
            Self::SigningError(e) => write!(f, "SigningError: {e}"),
            Self::Nip59Error(e) => write!(f, "Nip59Error: {e}"),
        }
    }
}
impl std::error::Error for Nip17Error {}
impl From<crate::nip_44::Nip44Error> for Nip17Error {
    fn from(err: crate::nip_44::Nip44Error) -> Self {
        Self::Nip44Error(err)
    }
}
impl From<crate::nip_59::Nip59Error> for Nip17Error {
    fn from(err: crate::nip_59::Nip59Error) -> Self {
        Self::Nip59Error(err)
    }
}

pub trait Nip17: crate::nip_59::Nip59 {
    /// Creates a sealed and giftwrapped rumor note.
    ///
    /// # Arguments
    ///
    /// * `rumor` - The rumor note to be sealed and giftwrapped.
    /// * `recipient` - The recipient's public key.
    ///
    /// # Errors
    ///
    /// Can fail while sealing or encrypting.
    fn private_dm(&self, dm: &str, recipient: &str) -> Result<nostro2::NostrNote, Nip17Error>
    where
        Self: Sized,
    {
        let mut dm_note = nostro2::NostrNote {
            content: dm.to_string(),
            kind: 14,
            ..Default::default()
        };
        Ok(self.giftwrap(&mut dm_note, recipient)?)
    }
    /// Public relay inbox list
    ///
    /// Creates a note with the kind 10050 and adds the relays as tags.
    /// These relays are where clients should address their messages.
    ///
    /// # Errors
    ///
    /// Can fail while signing the note.
    fn preffered_relays(&self, relays: &[&str]) -> Result<nostro2::NostrNote, Nip17Error> {
        let mut note = nostro2::NostrNote {
            kind: 10050,
            ..Default::default()
        };
        let mut relay_tags = vec![];
        relay_tags.push("relay".to_string());
        for relay in relays {
            relay_tags.push((*relay).to_string());
        }
        note.tags.0.push(relay_tags);
        self.sign_nostr_note(&mut note)
            .map_err(Nip17Error::SigningError)?;
        Ok(note)
    }
}

#[cfg(test)]
mod tests {
    use nostro2::NostrSigner;

    use super::*;
    use crate::{nip_59::Nip59, tests::NipTester};
    #[test]
    fn test_nip_17() {
        let keys = NipTester::generate(false);
        let recipient = NipTester::generate(false);
        let dm = "Hello, world!";
        let sealed_dm = keys.private_dm(dm, &recipient.public_key()).unwrap();
        assert_eq!(sealed_dm.kind, 1059);
        assert_ne!(sealed_dm.content, dm);

        let received_dm = recipient.rumor(&sealed_dm).unwrap();
        assert_eq!(received_dm.content, dm);
        assert_eq!(received_dm.kind, 14);
    }
    #[test]
    fn test_nip_17_preffered_relays() {
        let keys = NipTester::generate(false);
        let relays = vec!["wss://relay1.com", "wss://relay2.com"];
        let note = keys.preffered_relays(&relays).unwrap();
        assert!(note.verify());
        assert_eq!(note.kind, 10050);
        let tags = note.tags.find_tags("relay");
        assert_eq!(tags.len(), relays.len());
        for relay in relays {
            assert!(tags.contains(&relay.to_string()));
        }
    }
}