nostr 0.45.0-alpha.2

Rust implementation of 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

// Copyright (c) 2022-2023 Yuki Kishimoto
// Copyright (c) 2023-2025 Rust Nostr Developers
// Distributed under the MIT software license

//! NIP-40: Expiration Timestamp
//!
//! <https://github.com/nostr-protocol/nips/blob/master/40.md>

use alloc::string::{String, ToString};
use alloc::vec;
use alloc::vec::Vec;

use crate::error::Error;
use crate::event::{Tag, TagCodec, impl_tag_codec_conversions};
use crate::nips::util::{missing_tag_kind, take_timestamp, unknown_tag};
use crate::types::time::Timestamp;

const EXPIRATION: &str = "expiration";

/// Standardized NIP-40 tags
///
/// <https://github.com/nostr-protocol/nips/blob/master/40.md>
#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub enum Nip40Tag {
    /// Expiration timestamp
    Expiration(Timestamp),
}

impl TagCodec for Nip40Tag {
    type Error = Error;

    fn parse<I, S>(tag: I) -> Result<Self, Self::Error>
    where
        I: IntoIterator<Item = S>,
        S: AsRef<str>,
    {
        // Take iterator
        let mut iter = tag.into_iter();

        // Extract first value
        let kind: S = iter.next().ok_or(missing_tag_kind())?;

        // Match kind
        match kind.as_ref() {
            EXPIRATION => {
                let timestamp: Timestamp = take_timestamp(&mut iter)?;
                Ok(Self::Expiration(timestamp))
            }
            _ => Err(unknown_tag()),
        }
    }

    fn to_tag(&self) -> Tag {
        let Self::Expiration(timestamp) = self;
        let tag: Vec<String> = vec![String::from(EXPIRATION), timestamp.to_string()];
        Tag::new(tag)
    }
}

impl_tag_codec_conversions!(Nip40Tag);

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

    #[test]
    fn test_parse_empty_tag() {
        let tag: Vec<String> = Vec::new();
        let err = Nip40Tag::parse(&tag).unwrap_err();
        assert_eq!(err.kind(), ErrorKind::Missing);
    }

    #[test]
    fn test_non_existing_tag() {
        let tag = vec!["hello"];
        let err = Nip40Tag::parse(&tag).unwrap_err();
        assert_eq!(err.kind(), ErrorKind::Malformed);
    }

    #[test]
    fn test_standardized_expiration_tag() {
        let raw = 1600000000;
        let timestamp = Timestamp::from_secs(raw);

        // Simple
        let tag = vec!["expiration".to_string(), raw.to_string()];
        let parsed = Nip40Tag::parse(&tag).unwrap();
        assert_eq!(parsed, Nip40Tag::Expiration(timestamp));
        assert_eq!(parsed.to_tag(), Tag::parse(tag).unwrap());

        // Invalid timestamp
        let tag = vec!["expiration", "hello"];
        let err = Nip40Tag::parse(&tag).unwrap_err();
        assert_eq!(err.kind(), ErrorKind::Malformed);

        // Missing timestamp
        let tag = vec!["expiration"];
        let err = Nip40Tag::parse(&tag).unwrap_err();
        assert_eq!(err.kind(), ErrorKind::Missing);
    }
}