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

//! `naddr` — TLV-encoded coordinate `(identifier, author, kind, [relays])`.

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

/// `naddr`-style address: a [`Coordinate`] plus relay hints.
///
/// Wire form is `bech32("naddr", TLV[(0, identifier), (1, relay)*, (2, author), (3, kind)])`.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct Nip19Coordinate {
    /// `(kind, author, identifier)` address of the replaceable event.
    pub coordinate: Coordinate,
    /// Hints of relays that store the event.
    pub relays: Vec<RelayUrl>,
}

impl Nip19Coordinate {
    /// Construct an `naddr` coordinate.
    #[must_use]
    pub fn new(
        identifier: impl Into<String>,
        author: PublicKey,
        kind: Kind,
        relays: impl IntoIterator<Item = RelayUrl>,
    ) -> Self {
        Self {
            coordinate: Coordinate::new(kind, author, identifier),
            relays: relays.into_iter().collect(),
        }
    }

    /// Build from a pre-existing [`Coordinate`] and a list of relay hints.
    #[must_use]
    pub fn from_coordinate(
        coordinate: Coordinate,
        relays: impl IntoIterator<Item = RelayUrl>,
    ) -> Self {
        Self {
            coordinate,
            relays: relays.into_iter().collect(),
        }
    }

    /// Borrow the inner [`Kind`].
    #[must_use]
    pub const fn kind(&self) -> Kind {
        self.coordinate.kind
    }

    /// Borrow the inner author public key.
    #[must_use]
    pub const fn author(&self) -> &PublicKey {
        &self.coordinate.author
    }

    /// Borrow the inner identifier.
    #[must_use]
    pub fn identifier(&self) -> &str {
        &self.coordinate.identifier
    }
}