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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
// Copyright 2015-2020 nostr-proto Developers
// Licensed under the MIT license <LICENSE-MIT or http://opensource.org/licenses/MIT>
// This file may not be copied, modified, or distributed except according to those terms.

//! This crate provides types for nostr protocol handling.

#![deny(
    missing_debug_implementations,
    trivial_casts,
    trivial_numeric_casts,
    unused_import_braces,
    //unused_qualifications,
    unused_results,
    unused_lifetimes,
    unused_labels,
    unused_extern_crates,
    non_ascii_idents,
    keyword_idents,
    deprecated_in_future,
    unstable_features,
    single_use_lifetimes,
    //unsafe_code,
    unreachable_pub,
    missing_docs,
    missing_copy_implementations
)]
#![deny(clippy::string_slice)]

mod error;
pub use error::Error;

#[cfg(test)]
macro_rules! test_serde {
    ($t:ty, $fnname:ident) => {
        #[test]
        fn $fnname() {
            let a = <$t>::mock();
            let x = serde_json::to_string(&a).unwrap();
            println!("{}", x);
            let b = serde_json::from_str(&x).unwrap();
            assert_eq!(a, b);
        }
    };
}

mod types;
pub use types::{
    find_nostr_bech32_pos, find_nostr_url_pos, ClientMessage, ContentEncryptionAlgorithm,
    ContentSegment, DelegationConditions, EncryptedPrivateKey, Event, EventDelegation, EventKind,
    EventKindIterator, EventKindOrRange, EventReference, Fee, FileMetadata, Filter, Id, IdHex,
    Identity, KeySecurity, KeySigner, Metadata, MilliSatoshi, NAddr, NEvent, Nip05, NostrBech32,
    NostrUrl, PayRequestData, PreEvent, PrivateKey, Profile, PublicKey, PublicKeyHex, RelayFees,
    RelayInformationDocument, RelayLimitation, RelayList, RelayListUsage, RelayMessage,
    RelayOrigin, RelayRetention, RelayUrl, RelayUsage, RelayUsageSet, Rumor, ShatteredContent,
    Signature, SignatureHex, Signer, SimpleRelayList, SimpleRelayUsage, Span, SubscriptionId, Tag,
    UncheckedUrl, Unixtime, Url, XOnlyPublicKey, ZapData,
};

mod versioned;
pub use versioned::{
    ClientMessageV1, ClientMessageV2, ClientMessageV3, EventV1, EventV2, EventV3, FeeV1,
    MetadataV1, Nip05V1, PreEventV1, PreEventV2, PreEventV3, RelayFeesV1,
    RelayInformationDocumentV1, RelayInformationDocumentV2, RelayLimitationV1, RelayLimitationV2,
    RelayMessageV1, RelayMessageV2, RelayMessageV3, RelayMessageV4, RelayMessageV5,
    RelayRetentionV1, RumorV1, RumorV2, RumorV3, TagV1, TagV2, TagV3, Why, ZapDataV1, ZapDataV2,
};

#[inline]
pub(crate) fn get_leading_zero_bits(bytes: &[u8]) -> u8 {
    let mut res = 0_u8;
    for b in bytes {
        if *b == 0 {
            res += 8;
        } else {
            res += b.leading_zeros() as u8;
            return res;
        }
    }
    res
}

trait IntoVec<T> {
    fn into_vec(self) -> Vec<T>;
}

impl<T> IntoVec<T> for Option<T> {
    fn into_vec(self) -> Vec<T> {
        match self {
            None => vec![],
            Some(t) => vec![t],
        }
    }
}

use bech32::Hrp;
lazy_static::lazy_static! {
    static ref HRP_LNURL: Hrp = Hrp::parse("lnurl").expect("HRP error on lnurl");
    static ref HRP_NADDR: Hrp = Hrp::parse("naddr").expect("HRP error on naddr");
    static ref HRP_NCRYPTSEC: Hrp = Hrp::parse("ncryptsec").expect("HRP error on ncryptsec");
    static ref HRP_NEVENT: Hrp = Hrp::parse("nevent").expect("HRP error on nevent");
    static ref HRP_NOTE: Hrp = Hrp::parse("note").expect("HRP error on note");
    static ref HRP_NPROFILE: Hrp = Hrp::parse("nprofile").expect("HRP error on nprofile");
    static ref HRP_NPUB: Hrp = Hrp::parse("npub").expect("HRP error on npub");
    static ref HRP_NRELAY: Hrp = Hrp::parse("nrelay").expect("HRP error on nrelay");
    static ref HRP_NSEC: Hrp = Hrp::parse("nsec").expect("HRP error on nsec");
}

/// Add a 'p' pubkey tag to a set of tags if it doesn't already exist
pub fn add_pubkey_to_tags(
    existing_tags: &mut Vec<Tag>,
    new_pubkey: PublicKey,
    new_hint: Option<UncheckedUrl>,
) -> usize {
    let index = existing_tags.iter().position(|existing_tag| {
        if let Ok((pubkey, _, __)) = existing_tag.parse_pubkey() {
            pubkey == new_pubkey
        } else {
            false
        }
    });

    if let Some(idx) = index {
        // force additional data to match
        existing_tags[idx].set_index(
            2,
            match new_hint {
                Some(u) => u.as_str().to_owned(),
                None => "".to_owned(),
            },
        );
        existing_tags[idx].trim();
        idx
    } else {
        existing_tags.push(Tag::new_pubkey(new_pubkey, new_hint, None));
        existing_tags.len() - 1
    }
}

/// Add an 'e' id tag to a set of tags if it doesn't already exist
pub fn add_event_to_tags(
    existing_tags: &mut Vec<Tag>,
    new_id: Id,
    new_hint: Option<UncheckedUrl>,
    new_marker: &str,
    new_pubkey: Option<PublicKey>,
    use_quote: bool,
) -> usize {
    // NIP-18: "Quote reposts are kind 1 events with an embedded q tag..."
    if new_marker == "mention" && use_quote {
        let index = existing_tags.iter().position(|existing_tag| {
            if let Ok((id, _rurl, _optpk)) = existing_tag.parse_quote() {
                id == new_id
            } else {
                false
            }
        });

        if let Some(idx) = index {
            // force additional data to match
            existing_tags[idx].set_index(
                2,
                match new_hint {
                    Some(u) => u.as_str().to_owned(),
                    None => "".to_owned(),
                },
            );
            existing_tags[idx].set_index(
                3,
                match new_pubkey {
                    Some(pk) => pk.as_hex_string(),
                    None => "".to_owned(),
                },
            );
            existing_tags[idx].trim();
            idx
        } else {
            let newtag = Tag::new_quote(new_id, new_hint, new_pubkey);
            existing_tags.push(newtag);
            existing_tags.len() - 1
        }
    } else {
        let index = existing_tags.iter().position(|existing_tag| {
            if let Ok((id, _rurl, _optmarker, _optpk)) = existing_tag.parse_event() {
                id == new_id
            } else {
                false
            }
        });

        if let Some(idx) = index {
            // force additional data to match
            existing_tags[idx].set_index(
                2,
                match new_hint {
                    Some(u) => u.as_str().to_owned(),
                    None => "".to_owned(),
                },
            );
            existing_tags[idx].set_index(3, new_marker.to_owned());
            existing_tags[idx].set_index(
                4,
                match new_pubkey {
                    Some(pk) => pk.as_hex_string(),
                    None => "".to_owned(),
                },
            );
            existing_tags[idx].trim();
            idx
        } else {
            let newtag = Tag::new_event(new_id, new_hint, Some(new_marker.to_string()), new_pubkey);
            existing_tags.push(newtag);
            existing_tags.len() - 1
        }
    }
}

/// Add an 'a' addr tag to a set of tags if it doesn't already exist
pub fn add_addr_to_tags(
    existing_tags: &mut Vec<Tag>,
    new_addr: &NAddr,
    new_marker: Option<String>,
) -> usize {
    let index = existing_tags.iter().position(|existing_tag| {
        if let Ok((ea, _optmarker)) = existing_tag.parse_address() {
            ea.kind == new_addr.kind && ea.author == new_addr.author && ea.d == new_addr.d
        } else {
            false
        }
    });

    if let Some(idx) = index {
        // force additional data to match
        existing_tags[idx].set_index(
            2,
            match new_marker {
                Some(s) => s,
                None => "".to_owned(),
            },
        );
        existing_tags[idx].trim();
        idx
    } else {
        existing_tags.push(Tag::new_address(new_addr, new_marker));
        existing_tags.len() - 1
    }
}

/// Add an 'subject' tag to a set of tags if it doesn't already exist
pub fn add_subject_to_tags_if_missing(existing_tags: &mut Vec<Tag>, subject: String) {
    if !existing_tags.iter().any(|t| t.tagname() == "subject") {
        existing_tags.push(Tag::new_subject(subject));
    }
}