iris-chat 0.1.65

Iris Chat command line client and shared encrypted chat core
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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
use super::*;
use futures_util::future::try_join_all;
use nostr::EventId;
use nostr_sdk::prelude::{ClientOptions, Relay, RelayLimits, RelayMessage};

const MAX_FRAME_BYTES: u32 = 128 * 1024;
const MAX_RESULT_BYTES: usize = 16 * 1024 * 1024;
const MAX_RESULT_EVENTS: usize = 16_384;

pub(super) fn client_options() -> ClientOptions {
    let mut limits = RelayLimits::default();
    limits.messages.max_size = Some(super::transport::MAX_MESSAGE_BYTES as u32);
    limits.events.max_size = Some(MAX_FRAME_BYTES);
    for kind in [Kind::ContactList, Kind::MuteList] {
        limits
            .events
            .max_size_per_kind
            .insert(kind, Some(super::transport::MAX_GRAPH_EVENT_BYTES as u32));
        limits
            .events
            .max_num_tags_per_kind
            .insert(kind, Some(10_000));
    }
    ClientOptions::default()
        .relay_limits(limits)
        .verify_subscriptions(true)
}

#[derive(Debug)]
pub(super) enum QueryFailure {
    Limit,
    Transport(String),
}

impl std::fmt::Display for QueryFailure {
    fn fmt(&self, formatter: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::Limit => formatter.write_str("public discovery result exceeds safety bound"),
            Self::Transport(error) => formatter.write_str(error),
        }
    }
}

impl RelayLease {
    pub(super) async fn fetch(
        &self,
        filters: Vec<Filter>,
        timeout: Duration,
    ) -> Result<Vec<Event>, QueryFailure> {
        fetch(&self.pool, &self.pool.client, &self.urls, filters, timeout).await
    }
}

// Use SDK subscriptions with explicit IDs so the byte budget and cancellation
// can close them immediately. The collecting query API applies limits too late;
// SDK stream consumers do not stop their producers when dropped. Connection,
// authentication, signature/filter validation and reconnect remain in the SDK.
// Only one query accumulates results per pool, including foreground recovery.
pub(super) async fn fetch(
    pool: &DiscoveryRelays,
    client: &Client,
    urls: &[RelayUrl],
    filters: Vec<Filter>,
    timeout: Duration,
) -> Result<Vec<Event>, QueryFailure> {
    let _permit = pool
        .queries
        .acquire()
        .await
        .map_err(|error| QueryFailure::Transport(error.to_string()))?;
    fetch_admitted(pool, client, urls, filters, timeout, None)
        .await
        .map(|result| result.events)
}

pub(super) struct QueryResult {
    pub(super) events: Vec<Event>,
    pub(super) complete: bool,
}

pub(super) struct GraphQuery<'a> {
    pub(super) budget: &'a super::graph::GraphBudget,
    pub(super) max_events: usize,
}

// The caller owns the shared query permit. Graph reconciliation keeps that same
// permit from NEG-OPEN through its bounded missing-event download.
pub(super) async fn fetch_admitted(
    pool: &DiscoveryRelays,
    client: &Client,
    urls: &[RelayUrl],
    filters: Vec<Filter>,
    timeout: Duration,
    graph: Option<GraphQuery<'_>>,
) -> Result<QueryResult, QueryFailure> {
    if pool.stopped.load(Ordering::Acquire) {
        return Err(QueryFailure::Transport("public discovery stopped".into()));
    }
    let filters = merge_filters(filters)
        .into_iter()
        .map(|mut filter| {
            filter.limit = Some(
                filter
                    .limit
                    .unwrap_or(MAX_RESULT_EVENTS)
                    .min(MAX_RESULT_EVENTS),
            );
            filter
        })
        .collect::<Vec<_>>();
    if filters.is_empty() || urls.is_empty() {
        return Ok(QueryResult {
            events: Vec::new(),
            complete: true,
        });
    }
    if let Some(graph) = &graph {
        graph.budget.check()?;
    }
    let result = std::sync::Mutex::new(Collection::default());
    let graph = graph.as_ref();
    let queries = urls.iter().map(|url| {
        let result = &result;
        let filters = &filters;
        async move {
            let response = async {
                let relay = client
                    .relay(url.clone())
                    .await
                    .map_err(|error| QueryFailure::Transport(error.to_string()))?;
                if graph.is_some() {
                    relay.wait_for_connection(timeout).await;
                    if !matches!(relay.status(), nostr_sdk::RelayStatus::Connected) {
                        return Err(QueryFailure::Transport(
                            "graph relay did not connect".into(),
                        ));
                    }
                }
                let mut notifications = relay.notifications();
                let subscription = QuerySubscription {
                    relay,
                    id: SubscriptionId::generate(),
                };
                subscription
                    .relay
                    .subscribe_with_id(
                        subscription.id.clone(),
                        filters.clone(),
                        SubscribeOptions::default(),
                    )
                    .await
                    .map_err(|error| QueryFailure::Transport(error.to_string()))?;
                let mut budget_poll = tokio::time::interval(Duration::from_millis(50));
                loop {
                    if let Some(graph) = graph {
                        graph.budget.check()?;
                    }
                    let notification = tokio::select! {
                        notification = notifications.recv() => notification
                            .map_err(|error| QueryFailure::Transport(error.to_string()))?,
                        _ = budget_poll.tick(), if graph.is_some() => { continue; }
                    };
                    if let Some(graph) = graph {
                        graph.budget.check()?;
                    }
                    match notification {
                        RelayNotification::Message { message } => match message {
                            RelayMessage::Event {
                                subscription_id,
                                event,
                            } if subscription_id.as_ref() == &subscription.id => {
                                let event = event.into_owned();
                                if filters.iter().any(|filter| {
                                    filter.match_event(
                                        &event,
                                        nostr::filter::MatchEventOptions::new(),
                                    )
                                }) {
                                    result
                                        .lock()
                                        .map_err(|_| {
                                            QueryFailure::Transport(
                                                "discovery collection unavailable".into(),
                                            )
                                        })?
                                        .insert_bounded(
                                            event,
                                            graph.map_or(MAX_RESULT_EVENTS, |graph| {
                                                graph.max_events
                                            }),
                                            graph.is_some(),
                                        )?;
                                }
                            }
                            RelayMessage::EndOfStoredEvents(id)
                                if id.as_ref() == &subscription.id =>
                            {
                                return Ok(())
                            }
                            RelayMessage::Closed {
                                subscription_id,
                                message,
                            } if subscription_id.as_ref() == &subscription.id
                                && !message.starts_with("auth-required:") =>
                            {
                                return Err(QueryFailure::Transport(message.into_owned()));
                            }
                            _ => {}
                        },
                        RelayNotification::AuthenticationFailed | RelayNotification::Shutdown => {
                            return Err(QueryFailure::Transport(
                                "discovery relay unavailable".into(),
                            ));
                        }
                        _ => {}
                    }
                }
            };
            match response.await {
                Ok(()) => Ok(true),
                // One offline relay must not discard another relay's verified
                // results. Resource rejection always fails the whole query.
                Err(QueryFailure::Transport(_)) => Ok(false),
                Err(QueryFailure::Limit) => Err(QueryFailure::Limit),
            }
        }
    });
    let completed = match tokio::time::timeout(timeout, try_join_all(queries)).await {
        Ok(Ok(completed)) => (
            completed.iter().any(|completed| *completed),
            completed.iter().all(|completed| *completed),
        ),
        Ok(Err(error)) => return Err(error),
        Err(_) => (false, false),
    };
    let mut result = result
        .into_inner()
        .map_err(|_| QueryFailure::Transport("discovery collection unavailable".into()))?;
    if !completed.0 && result.events.is_empty() {
        return Err(QueryFailure::Transport(
            "no relay completed discovery".into(),
        ));
    }
    result.events.sort_by(|left, right| {
        right
            .created_at
            .cmp(&left.created_at)
            .then_with(|| left.id.cmp(&right.id))
    });
    if let Some(graph) = graph {
        graph.budget.check()?;
    }
    Ok(QueryResult {
        events: result.events,
        complete: completed.1,
    })
}

// Construct before the first subscription await: cancellation during setup,
// EOSE, timeout and resource rejection all remove exactly this retained ID.
struct QuerySubscription {
    relay: Relay,
    id: SubscriptionId,
}
impl Drop for QuerySubscription {
    fn drop(&mut self) {
        let relay = self.relay.clone();
        let id = self.id.clone();
        tokio::spawn(async move {
            let _ = relay.unsubscribe(&id).await;
        });
    }
}

#[derive(Default)]
struct Collection {
    events: Vec<Event>,
    ids: HashSet<EventId>,
    bytes: usize,
}

// The account receiver retains its SDK 5 MiB transport allowance for private
// receives. SDK signature verification happens before notifications; do not
// repeat that crypto here. Bound metadata acceptance before retaining it, using
// a counting writer so checking a large event does not allocate another copy.
fn metadata_size(event: &Event) -> Option<usize> {
    event_size(event, MAX_FRAME_BYTES as usize)
}

fn event_size(event: &Event, max_bytes: usize) -> Option<usize> {
    struct Size {
        bytes: usize,
        max: usize,
    }
    impl std::io::Write for Size {
        fn write(&mut self, bytes: &[u8]) -> std::io::Result<usize> {
            if bytes.len() > self.max - self.bytes {
                return Err(std::io::Error::other("metadata size limit"));
            }
            self.bytes += bytes.len();
            Ok(bytes.len())
        }
        fn flush(&mut self) -> std::io::Result<()> {
            Ok(())
        }
    }
    let mut size = Size {
        bytes: 0,
        max: max_bytes,
    };
    serde_json::to_writer(&mut size, event).ok()?;
    Some(size.bytes)
}

impl Collection {
    #[cfg(test)]
    fn insert(&mut self, event: Event) -> Result<(), QueryFailure> {
        self.insert_bounded(event, MAX_RESULT_EVENTS, false)
    }

    fn insert_bounded(
        &mut self,
        event: Event,
        max_events: usize,
        graph: bool,
    ) -> Result<(), QueryFailure> {
        if self.ids.contains(&event.id) {
            return Ok(());
        }
        let size = if graph && matches!(event.kind.as_u16(), 3 | 10000) {
            event_size(&event, super::transport::MAX_GRAPH_EVENT_BYTES)
        } else {
            metadata_size(&event)
        };
        let Some(size) = size else {
            return Ok(());
        };
        if self.bytes.saturating_add(size) > MAX_RESULT_BYTES || self.events.len() >= max_events {
            return Err(QueryFailure::Limit);
        }
        self.bytes += size;
        self.ids.insert(event.id);
        self.events.push(event);
        Ok(())
    }
}

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

    #[test]
    fn metadata_admission_keeps_exact_event_bound_without_allocating_a_copy() {
        let keys = Keys::generate();
        let event = |content: String| {
            EventBuilder::new(Kind::Metadata, content)
                .sign_with_keys(&keys)
                .unwrap()
        };
        let overhead = serde_json::to_vec(&event(String::new())).unwrap().len();
        let maximum = event("x".repeat(MAX_FRAME_BYTES as usize - overhead));
        assert_eq!(metadata_size(&maximum), Some(MAX_FRAME_BYTES as usize));
        let oversized = event("x".repeat(MAX_FRAME_BYTES as usize - overhead + 1));
        assert_eq!(metadata_size(&oversized), None);
        let mut collection = Collection::default();
        collection.insert(oversized).unwrap();
        assert_eq!(collection.bytes, 0);
        assert!(collection.events.is_empty() && collection.ids.is_empty());
        collection.insert(maximum).unwrap();
        assert_eq!(collection.bytes, MAX_FRAME_BYTES as usize);
        assert_eq!(collection.events.len(), 1);
    }

    #[test]
    fn metadata_collection_accepts_exact_bounds_and_rejects_overflow_before_retaining() {
        let event = EventBuilder::new(Kind::Metadata, "bounded")
            .sign_with_keys(&Keys::generate())
            .unwrap();
        let size = serde_json::to_vec(&event).unwrap().len();
        let mut collection = Collection {
            bytes: MAX_RESULT_BYTES - size,
            ..Default::default()
        };
        collection.insert(event.clone()).unwrap();
        assert_eq!(collection.bytes, MAX_RESULT_BYTES);
        collection.insert(event.clone()).unwrap();
        assert_eq!(
            collection.events.len(),
            1,
            "duplicates must not consume the budget"
        );
        let second = EventBuilder::new(Kind::Metadata, "overflow")
            .sign_with_keys(&Keys::generate())
            .unwrap();
        assert!(matches!(
            collection.insert(second.clone()),
            Err(QueryFailure::Limit)
        ));
        assert_eq!(collection.events.len(), 1);
        assert_eq!(collection.bytes, MAX_RESULT_BYTES);

        let mut collection = Collection {
            events: vec![event; MAX_RESULT_EVENTS - 1],
            ..Default::default()
        };
        collection.insert(second).unwrap();
        assert_eq!(collection.events.len(), MAX_RESULT_EVENTS);
        let extra = EventBuilder::new(Kind::Metadata, "extra")
            .sign_with_keys(&Keys::generate())
            .unwrap();
        assert!(matches!(collection.insert(extra), Err(QueryFailure::Limit)));
        assert_eq!(collection.events.len(), MAX_RESULT_EVENTS);
    }
}