nostr 0.44.3

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
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

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

//! NIP09: Event Deletion Request
//!
//! <https://github.com/nostr-protocol/nips/blob/master/09.md>

use alloc::string::String;
use alloc::vec::Vec;

use super::nip01::Coordinate;
use crate::event::id::EventId;
use crate::{EventBuilder, Kind, Tag};

/// Event deletion request
#[derive(Debug, Clone, Default, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct EventDeletionRequest {
    /// Event IDs
    pub ids: Vec<EventId>,
    /// Event coordinates
    pub coordinates: Vec<Coordinate>,
    /// Optional reason
    pub reason: Option<String>,
}

impl EventDeletionRequest {
    /// New **empty** deletion request
    #[inline]
    pub fn new() -> Self {
        Self::default()
    }

    /// Add single event ID
    #[inline]
    pub fn id(mut self, id: EventId) -> Self {
        self.ids.push(id);
        self
    }

    /// Add event IDs
    #[inline]
    pub fn ids<I>(mut self, ids: I) -> Self
    where
        I: IntoIterator<Item = EventId>,
    {
        self.ids.extend(ids);
        self
    }

    /// Add single event coordinate
    #[inline]
    pub fn coordinate(mut self, coordinate: Coordinate) -> Self {
        self.coordinates.push(coordinate);
        self
    }

    /// Add event coordinates
    #[inline]
    pub fn coordinates<I>(mut self, coordinates: I) -> Self
    where
        I: IntoIterator<Item = Coordinate>,
    {
        self.coordinates.extend(coordinates);
        self
    }

    /// Add deletion reason
    #[inline]
    pub fn reason<S>(mut self, reason: S) -> Self
    where
        S: Into<String>,
    {
        self.reason = Some(reason.into());
        self
    }

    #[allow(clippy::wrong_self_convention)]
    pub(crate) fn to_event_builder(self) -> EventBuilder {
        let mut tags: Vec<Tag> = Vec::with_capacity(self.ids.len() + self.coordinates.len());

        for id in self.ids.into_iter() {
            tags.push(Tag::event(id));
        }

        for coordinate in self.coordinates.into_iter() {
            tags.push(Tag::coordinate(coordinate, None));
        }

        EventBuilder::new(Kind::EventDeletion, self.reason.unwrap_or_default())
            .tags(tags)
            .dedup_tags()
    }
}

#[cfg(all(test, feature = "std"))]
mod tests {
    use super::*;
    use crate::{Event, Keys, Tags};

    #[test]
    fn test_event_deletion_request() {
        let keys = Keys::generate();

        let event_id =
            EventId::from_hex("7469af3be8c8e06e1b50ef1caceba30392ddc0b6614507398b7d7daa4c218e96")
                .unwrap();
        let coordinate = Coordinate::parse(
            "30023:aa4fc8665f5696e33db7e1a572e3b0f5b3d615837b0f362dcb1c8068b098c7b4:ipsum",
        )
        .unwrap();

        // Event ID, coordinate and reason
        let request = EventDeletionRequest::new()
            .id(event_id)
            .coordinate(coordinate)
            .reason("these posts were published by accident");

        let event: Event = request.to_event_builder().sign_with_keys(&keys).unwrap();

        assert_eq!(event.kind, Kind::EventDeletion);
        assert_eq!(event.content, "these posts were published by accident");

        let tags = Tags::parse([
            vec![
                "e",
                "7469af3be8c8e06e1b50ef1caceba30392ddc0b6614507398b7d7daa4c218e96",
            ],
            vec![
                "a",
                "30023:aa4fc8665f5696e33db7e1a572e3b0f5b3d615837b0f362dcb1c8068b098c7b4:ipsum",
            ],
        ])
        .unwrap();
        assert_eq!(event.tags, tags);

        // Event ID without reason
        let request = EventDeletionRequest::new().id(event_id);

        let event: Event = request.to_event_builder().sign_with_keys(&keys).unwrap();

        assert_eq!(event.kind, Kind::EventDeletion);
        assert!(event.content.is_empty());

        let tags = Tags::parse([vec![
            "e",
            "7469af3be8c8e06e1b50ef1caceba30392ddc0b6614507398b7d7daa4c218e96",
        ]])
        .unwrap();
        assert_eq!(event.tags, tags);
    }
}