nula-core 0.2.2

Nostr protocol core: events, filters, keys, messages, NIP primitives.
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

//! NIP-11 fee schedule (`fees` object).

use serde::{Deserialize, Serialize};

use crate::event::Kind;

/// Per-class fee structure (admission, subscription, publication).
#[derive(Debug, Default, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(default)]
pub struct RelayFees {
    /// Fees collected once when a client first joins the relay.
    #[serde(skip_serializing_if = "Vec::is_empty")]
    pub admission: Vec<RelayFee>,
    /// Periodic subscription fees.
    #[serde(skip_serializing_if = "Vec::is_empty")]
    pub subscription: Vec<RelayFee>,
    /// Per-event publication fees.
    #[serde(skip_serializing_if = "Vec::is_empty")]
    pub publication: Vec<RelayFee>,
}

/// A single line item in a [`RelayFees`] schedule.
#[derive(Debug, Default, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct RelayFee {
    /// Numeric amount (NIP-11 leaves the meaning to the relay).
    pub amount: u64,
    /// Currency / accounting unit (e.g. `"msats"`).
    pub unit: String,
    /// Optional billing period in seconds (subscription fees only).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub period: Option<u64>,
    /// Restrict this entry to specific event kinds (publication fees only).
    #[serde(skip_serializing_if = "Option::is_none")]
    pub kinds: Option<Vec<Kind>>,
}

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

    #[test]
    fn fees_round_trip() {
        let fees = RelayFees {
            admission: vec![RelayFee {
                amount: 1000,
                unit: "msats".into(),
                period: None,
                kinds: None,
            }],
            subscription: vec![RelayFee {
                amount: 5000,
                unit: "msats".into(),
                period: Some(2_592_000),
                kinds: None,
            }],
            publication: vec![RelayFee {
                amount: 100,
                unit: "msats".into(),
                period: None,
                kinds: Some(vec![Kind::TEXT_NOTE]),
            }],
        };
        let json = serde_json::to_string(&fees).unwrap();
        let parsed: RelayFees = serde_json::from_str(&json).unwrap();
        assert_eq!(parsed, fees);
    }

    #[test]
    fn empty_arrays_omitted() {
        let fees = RelayFees::default();
        let json = serde_json::to_string(&fees).unwrap();
        assert_eq!(json, "{}");
    }
}