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

//! `nevent` — TLV-encoded `(event_id, [relays], author?, kind?)`.

use crate::event::{EventId, Kind};
use crate::key::PublicKey;
use crate::types::RelayUrl;

/// Event reference: an event id plus optional relay hints, author, and kind.
///
/// Wire form is `bech32("nevent", TLV[(0, id), (1, relay)*, (2, author)?, (3, kind)?])`.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct Nip19Event {
    /// SHA-256 event id being referenced.
    pub event_id: EventId,
    /// Optional author hint.
    pub author: Option<PublicKey>,
    /// Optional kind hint.
    pub kind: Option<Kind>,
    /// Hints of relays that store the event.
    pub relays: Vec<RelayUrl>,
}

impl Nip19Event {
    /// Construct an event reference with no hints.
    #[must_use]
    pub const fn new(event_id: EventId) -> Self {
        Self {
            event_id,
            author: None,
            kind: None,
            relays: Vec::new(),
        }
    }

    /// Add an author hint.
    #[must_use]
    pub const fn with_author(mut self, author: PublicKey) -> Self {
        self.author = Some(author);
        self
    }

    /// Add a kind hint.
    #[must_use]
    pub const fn with_kind(mut self, kind: Kind) -> Self {
        self.kind = Some(kind);
        self
    }

    /// Add relay hints.
    #[must_use]
    pub fn with_relays(mut self, relays: impl IntoIterator<Item = RelayUrl>) -> Self {
        self.relays.extend(relays);
        self
    }
}