grapevine 1.0.0

A modern, asynchronous peer-to-peer gossip protocol library and application
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
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
//! Core gossip protocol engine.

use std::collections::HashMap;
use std::net::SocketAddr;
use std::sync::Arc;
use std::time::{Duration, Instant};

use bytes::Bytes;
use dashmap::DashMap;
use rand::seq::SliceRandom;
use tokio::sync::{RwLock, broadcast};
use tokio::time::{self, sleep};
use tracing::{debug, info, trace, warn};

use crate::{
    AntiEntropy, EpidemicConfig, Error, Message, MessageEntry, MessageId, NodeConfig, Payload,
    Peer, PeerId, PeerState, Result, Tcp,
};

/// Shutdown broadcast channel capacity.
const SHUTDOWN_CHANNEL_CAPACITY: usize = 16;

/// Grace period for in-flight messages during shutdown (milliseconds).
const SHUTDOWN_GRACE_PERIOD_MS: u64 = 500;

/// Peer maintenance check interval (seconds).
const PEER_MAINTENANCE_INTERVAL_SECS: u64 = 10;

/// Message deduplication cleanup interval (seconds).
const MESSAGE_CLEANUP_INTERVAL_SECS: u64 = 30;

/// Main gossip protocol engine.
pub struct Gossip {
    /// Node configuration
    config: NodeConfig,

    /// TCP transport
    transport: Arc<RwLock<Tcp>>,

    /// Connected peers
    peers: Arc<DashMap<PeerId, Peer>>,

    /// Seen messages with full message data and metadata
    seen_messages: Arc<DashMap<MessageId, MessageEntry>>,

    /// Maps canonical peer addresses (listening addresses) to connection addresses (ephemeral ports).
    /// When peer A connects to peer B, B sees the connection from an ephemeral port, but messages
    /// contain A's listening address in message.id.origin. This map allows us to look up the
    /// correct connection to use when sending direct messages.
    canonical_addrs: Arc<DashMap<SocketAddr, SocketAddr>>,

    /// Application message handler
    message_handler: Option<Arc<dyn Fn(SocketAddr, Bytes) + Send + Sync>>,

    /// Shutdown signal broadcaster
    shutdown_tx: broadcast::Sender<()>,

    /// Anti-entropy engine
    anti_entropy: Option<Arc<AntiEntropy>>,

    /// Epidemic broadcast config
    epidemic_config: EpidemicConfig,
}

impl Gossip {
    /// Create a new gossip protocol instance.
    pub fn new(config: NodeConfig) -> Self {
        let (shutdown_tx, _) = broadcast::channel(SHUTDOWN_CHANNEL_CAPACITY);

        let mut transport = Tcp::with_max_message_size(config.max_message_size);
        if config.rate_limit.enabled {
            transport =
                transport.set_rate_limit(config.rate_limit.capacity, config.rate_limit.refill_rate);
        }
        let transport = Arc::new(RwLock::new(transport));
        let seen_messages = Arc::new(DashMap::new());
        let epidemic_config = config.epidemic.clone();

        let anti_entropy = if config.anti_entropy.enabled {
            Some(Arc::new(AntiEntropy::new(
                config.anti_entropy.clone(),
                Arc::clone(&transport),
                Arc::clone(&seen_messages),
            )))
        } else {
            None
        };

        Self {
            config,
            transport,
            peers: Arc::new(DashMap::new()),
            seen_messages,
            canonical_addrs: Arc::new(DashMap::new()),
            message_handler: None,
            shutdown_tx,
            anti_entropy,
            epidemic_config,
        }
    }

    /// Set the application message handler.
    pub fn set_message_handler<F>(&mut self, handler: F)
    where
        F: Fn(SocketAddr, Bytes) + Send + Sync + 'static,
    {
        self.message_handler = Some(Arc::new(handler));
    }

    /// Start the gossip protocol.
    pub async fn start(&mut self) -> Result<()> {
        {
            let mut transport = self.transport.write().await;
            transport.listen(self.config.bind_addr).await?;
            let local_addr = transport
                .local_addr()
                .ok_or_else(|| Error::internal("Transport has no local address after listening"))?;
            info!("Gossip node started on {local_addr}");
        }

        for peer in &self.config.bootstrap_peers {
            if let Err(e) = self.connect_to_peer(*peer).await {
                warn!("Failed to connect to bootstrap peer {peer}: {e}");
            }
        }

        self.spawn_message_receiver();
        self.spawn_gossip_loop();
        self.spawn_peer_maintenance();
        self.spawn_message_cleanup();

        if let Some(ref anti_entropy) = self.anti_entropy {
            anti_entropy.start().await?;
        }

        Ok(())
    }

    /// Connect to a peer.
    pub async fn connect_to_peer(&self, addr: SocketAddr) -> Result<()> {
        let transport = self.transport.read().await;
        transport.connect(addr).await?;

        let local_addr = transport
            .local_addr()
            .ok_or_else(|| Error::internal("No local address"))?;

        // Send immediate heartbeat to establish canonical address mapping
        let heartbeat = Message::new(local_addr, Payload::Heartbeat { from: local_addr });
        transport.send(addr, heartbeat).await?;

        // Request peer list
        let message = Message::new(local_addr, Payload::PeerListRequest);
        transport.send(addr, message).await?;

        info!("Connected to peer {addr}");
        Ok(())
    }

    /// Broadcast a message to the network.
    pub async fn broadcast(&self, data: Bytes) -> Result<()> {
        let local_addr = self
            .transport
            .read()
            .await
            .local_addr()
            .ok_or_else(|| Error::internal("No local address"))?;

        let message = Message::new(local_addr, Payload::Application(data));

        self.seen_messages.insert(
            message.id,
            MessageEntry {
                message: message.clone(),
                first_seen: Instant::now(),
                forward_count: 0,
            },
        );

        self.gossip_message(message).await
    }

    /// Send a direct message to a specific peer.
    ///
    /// The `peer` parameter should be the peer's canonical listening address.
    /// This method will automatically resolve it to the actual connection address.
    pub async fn send_to_peer(&self, peer: SocketAddr, data: Bytes) -> Result<()> {
        let local_addr = {
            let transport = self.transport.read().await;
            transport
                .local_addr()
                .ok_or_else(|| Error::internal("No local address"))?
        };

        // Resolve canonical address to connection address.
        // If the peer is us (we're listening on `peer`), use peer directly.
        // Otherwise, look up the connection address from our canonical mapping.
        let connection_addr = self
            .canonical_addrs
            .get(&peer)
            .map(|entry| *entry.value())
            .unwrap_or(peer);

        // Check if peer is connected using the transport's peer list
        {
            let transport = self.transport.read().await;
            let connected_peers = transport.peers();
            if !connected_peers.contains(&connection_addr) {
                return Err(Error::PeerNotFound(peer));
            }
        }

        let message = Message::new(
            local_addr,
            Payload::DirectMessage {
                recipient: peer,
                data,
            },
        );

        // Mark as seen to avoid processing it if it comes back
        self.seen_messages.insert(
            message.id,
            MessageEntry {
                message: message.clone(),
                first_seen: Instant::now(),
                forward_count: 0,
            },
        );

        // Send to the connection address, not the canonical address
        let transport = self.transport.read().await;
        transport.send(connection_addr, message).await
    }

    /// Get local address.
    pub async fn local_addr(&self) -> Option<SocketAddr> {
        self.transport.read().await.local_addr()
    }

    /// Get list of connected peers using their canonical (listening) addresses.
    ///
    /// This returns the peers' actual listening addresses rather than the ephemeral
    /// connection ports. Use these addresses for sending direct messages.
    pub async fn peer_list(&self) -> Vec<SocketAddr> {
        let connection_addrs = self.transport.read().await.peers();

        // Build reverse mapping: connection_addr -> canonical_addr
        let mut reverse_map: HashMap<SocketAddr, SocketAddr> = HashMap::new();

        for entry in self.canonical_addrs.iter() {
            let (canonical, connection) = (*entry.key(), *entry.value());
            reverse_map.insert(connection, canonical);
        }

        // Return canonical addresses where available, connection addresses otherwise
        connection_addrs
            .into_iter()
            .map(|conn_addr| reverse_map.get(&conn_addr).copied().unwrap_or(conn_addr))
            .collect()
    }

    /// Shutdown the node gracefully.
    pub async fn shutdown(&self) -> Result<()> {
        info!("Initiating graceful shutdown");

        let local_addr = self.transport.read().await.local_addr();
        if let Some(addr) = local_addr {
            let goodbye = Message::new(
                addr,
                Payload::Goodbye {
                    reason: "Normal shutdown".to_string(),
                },
            );

            let peer_addrs = self.transport.read().await.peers();
            debug!("Sending goodbye to {} peers", peer_addrs.len());

            let transport_guard = self.transport.read().await;
            for peer_addr in peer_addrs {
                if let Err(e) = transport_guard.send(peer_addr, goodbye.clone()).await {
                    debug!("Failed to send goodbye to {peer_addr}: {e}");
                }
            }
        }

        debug!("Broadcasting shutdown signal");
        let _ = self.shutdown_tx.send(());

        sleep(Duration::from_millis(SHUTDOWN_GRACE_PERIOD_MS)).await;

        debug!("Clearing peer list");
        self.peers.clear();

        debug!("Clearing message cache");
        self.seen_messages.clear();

        info!("Graceful shutdown complete");
        Ok(())
    }

    fn spawn_message_receiver(&self) {
        let transport = Arc::clone(&self.transport);
        let peers = Arc::clone(&self.peers);
        let seen_messages = Arc::clone(&self.seen_messages);
        let canonical_addrs = Arc::clone(&self.canonical_addrs);
        let message_handler = self.message_handler.clone();
        let config = self.config.clone();
        let epidemic_config = self.epidemic_config.clone();
        let mut shutdown_rx = self.shutdown_tx.subscribe();

        tokio::spawn(async move {
            loop {
                let recv_fut = async { transport.read().await.recv().await };

                let result = tokio::select! {
                    _ = shutdown_rx.recv() => {
                        debug!("Message receiver shutting down");
                        return;
                    }
                    result = recv_fut => result,
                };

                let (peer_addr, message) = match result {
                    Ok(msg) => msg,
                    Err(e) => {
                        warn!("Error receiving message: {e}");
                        continue;
                    }
                };

                let local_addr = match transport.read().await.local_addr() {
                    Some(addr) => addr,
                    None => continue,
                };

                // Map the canonical address (from message.id.origin) to the connection address (peer_addr).
                // This allows us to send direct messages using the peer's listening address.
                // We always create the mapping, even if addresses match (outbound connections).
                let canonical_addr = message.id.origin;
                canonical_addrs.insert(canonical_addr, peer_addr);
                if canonical_addr != peer_addr {
                    debug!("Mapped canonical {canonical_addr} -> connection {peer_addr}");
                } else {
                    debug!("Mapped canonical {canonical_addr} -> self (outbound connection)");
                }

                trace!("Received message from {peer_addr}: {:?}", message.id);

                match &message.payload {
                    Payload::PeerListRequest => {
                        Self::handle_peer_list_request(&transport, peer_addr).await;
                    }
                    Payload::PeerListResponse { peers: peer_list } => {
                        Self::handle_peer_list_response(&transport, peer_list).await;
                    }
                    Payload::AntiEntropyDigest { message_ids } => {
                        let _ = AntiEntropy::handle_digest(
                            local_addr,
                            peer_addr,
                            message_ids.clone(),
                            &transport,
                            &seen_messages,
                        )
                        .await;
                    }
                    Payload::MessageRequest { ids } => {
                        let _ = AntiEntropy::handle_message_request(
                            local_addr,
                            peer_addr,
                            ids.clone(),
                            &transport,
                            &seen_messages,
                        )
                        .await;
                    }
                    Payload::MessageResponse { messages: msgs } => {
                        AntiEntropy::handle_message_response(
                            msgs.clone(),
                            &seen_messages,
                            &message_handler,
                        );
                    }
                    Payload::Goodbye { reason } => {
                        // Use canonical address (listening address) in logs instead of connection address
                        let canonical_addr = message.id.origin;
                        info!("Peer {canonical_addr} is leaving: {reason}");
                        if let Some(peer_id) = peers
                            .iter()
                            .find(|p| p.value().id().0 == peer_addr)
                            .map(|p| *p.key())
                        {
                            peers.remove(&peer_id);
                            debug!("Removed peer {canonical_addr} from peer list");
                        }
                    }
                    Payload::DirectMessage { recipient, data } => {
                        // Direct messages are only delivered to the intended recipient
                        // and are not gossiped to other peers
                        if seen_messages.contains_key(&message.id) {
                            trace!("Duplicate direct message {}, ignoring", message.id);
                            continue;
                        }

                        // Check if we are the intended recipient
                        if *recipient == local_addr {
                            seen_messages.insert(
                                message.id,
                                MessageEntry {
                                    message: message.clone(),
                                    first_seen: Instant::now(),
                                    forward_count: 0,
                                },
                            );

                            if let Some(ref handler) = message_handler {
                                handler(message.id.origin, data.clone());
                            }
                            debug!("Received direct message from {}", message.id.origin);
                        } else {
                            // Not for us, drop immediately without storing to prevent DOS attacks.
                            // Direct messages are point-to-point and should not be relayed,
                            // so there's no need to track them if they're misdirected.
                            trace!(
                                "Direct message {} not for us (intended for {}), dropping",
                                message.id, recipient
                            );
                        }
                    }
                    Payload::Application(data) => {
                        if seen_messages.contains_key(&message.id) {
                            trace!("Duplicate message {}, ignoring", message.id);
                            continue;
                        }

                        seen_messages.insert(
                            message.id,
                            MessageEntry {
                                message: message.clone(),
                                first_seen: Instant::now(),
                                forward_count: 0,
                            },
                        );

                        if let Some(ref handler) = message_handler {
                            handler(message.id.origin, data.clone());
                        }

                        if message.ttl > 1 {
                            if !epidemic_config.should_forward() {
                                trace!("Epidemic broadcast: not forwarding message {}", message.id);
                                continue;
                            }

                            if let Some(mut entry) = seen_messages.get_mut(&message.id) {
                                if entry.forward_count >= epidemic_config.max_forwards {
                                    trace!(
                                        "Message {} reached max forwards ({})",
                                        message.id, epidemic_config.max_forwards
                                    );
                                    continue;
                                }
                                entry.forward_count += 1;
                            }

                            let mut new_message = message.clone();
                            new_message.decrement_ttl();
                            let _ = Self::gossip_to_fanout(
                                &transport,
                                &peers,
                                new_message,
                                config.fanout,
                            )
                            .await;
                        }
                    }
                    _ => {}
                }
            }
        });
    }

    fn spawn_gossip_loop(&self) {
        let interval = self.config.gossip_interval;
        let transport = Arc::clone(&self.transport);
        let mut shutdown_rx = self.shutdown_tx.subscribe();

        tokio::spawn(async move {
            let mut ticker = time::interval(interval);
            loop {
                tokio::select! {
                    _ = shutdown_rx.recv() => {
                        debug!("Gossip loop shutting down");
                        break;
                    }
                    _ = ticker.tick() => {
                        let transport_guard = transport.read().await;
                        let local_addr = match transport_guard.local_addr() {
                            Some(addr) => addr,
                            None => continue,
                        };

                        let heartbeat = Message::new(local_addr, Payload::Heartbeat { from: local_addr });
                        let peer_addrs = transport_guard.peers();

                        for peer_addr in peer_addrs {
                            if let Err(e) = transport_guard.send(peer_addr, heartbeat.clone()).await {
                                debug!("Failed to send heartbeat to {peer_addr}: {e}");
                            }
                        }
                    }
                }
            }
        });
    }

    fn spawn_peer_maintenance(&self) {
        let peers = Arc::clone(&self.peers);
        let timeout = self.config.peer_timeout;
        let mut shutdown_rx = self.shutdown_tx.subscribe();

        tokio::spawn(async move {
            let mut ticker = time::interval(Duration::from_secs(PEER_MAINTENANCE_INTERVAL_SECS));
            loop {
                tokio::select! {
                    _ = shutdown_rx.recv() => {
                        debug!("Peer maintenance shutting down");
                        break;
                    }
                    _ = ticker.tick() => {
                        let mut peers_to_mark_stale = Vec::new();
                        let mut peers_to_disconnect = Vec::new();

                        for entry in peers.iter() {
                            let peer_info = &entry.value().info;

                            if peer_info.should_disconnect() {
                                peers_to_disconnect.push(*entry.key());
                            } else if peer_info.is_stale(timeout) && peer_info.state != PeerState::Stale {
                                peers_to_mark_stale.push(*entry.key());
                            }
                        }

                        for peer_id in peers_to_mark_stale {
                            if let Some(mut peer) = peers.get_mut(&peer_id) {
                                peer.info.mark_stale();
                                debug!("Marked peer {peer_id} as stale");
                            }
                        }

                        for peer_id in peers_to_disconnect {
                            info!("Disconnecting unhealthy peer {peer_id}");
                            peers.remove(&peer_id);
                        }
                    }
                }
            }
        });
    }

    fn spawn_message_cleanup(&self) {
        let seen_messages = Arc::clone(&self.seen_messages);
        let ttl = self.config.message_dedup_ttl;
        let mut shutdown_rx = self.shutdown_tx.subscribe();

        tokio::spawn(async move {
            let mut ticker = time::interval(Duration::from_secs(MESSAGE_CLEANUP_INTERVAL_SECS));
            loop {
                tokio::select! {
                    _ = shutdown_rx.recv() => {
                        debug!("Message cleanup shutting down");
                        break;
                    }
                    _ = ticker.tick() => {
                        let now = Instant::now();
                        let stale_messages: Vec<MessageId> = seen_messages
                            .iter()
                            .filter(|entry| now.duration_since(entry.value().first_seen) > ttl)
                            .map(|entry| *entry.key())
                            .collect();

                        let count = stale_messages.len();
                        for message_id in stale_messages {
                            seen_messages.remove(&message_id);
                        }

                        if count > 0 {
                            debug!("Cleaned up {count} stale message IDs");
                        }
                    }
                }
            }
        });
    }

    async fn gossip_message(&self, message: Message) -> Result<()> {
        Self::gossip_to_fanout(&self.transport, &self.peers, message, self.config.fanout).await
    }

    async fn gossip_to_fanout(
        transport: &Arc<RwLock<Tcp>>,
        _peers: &Arc<DashMap<PeerId, Peer>>,
        message: Message,
        fanout: usize,
    ) -> Result<()> {
        let transport_guard = transport.read().await;
        let mut peer_addrs = transport_guard.peers();

        if peer_addrs.is_empty() {
            return Ok(());
        }

        let selected: Vec<_> = {
            let mut rng = rand::rng();
            peer_addrs.shuffle(&mut rng);
            peer_addrs.into_iter().take(fanout).collect()
        };

        for addr in selected {
            if let Err(e) = transport_guard.send(addr, message.clone()).await {
                warn!("Failed to gossip to {addr}: {e}");
            }
        }

        Ok(())
    }

    async fn handle_peer_list_request(transport: &Arc<RwLock<Tcp>>, sender: SocketAddr) {
        let transport_guard = transport.read().await;
        let peer_list = transport_guard.peers();

        let local_addr = match transport_guard.local_addr() {
            Some(addr) => addr,
            None => return,
        };

        let response = Message::new(local_addr, Payload::PeerListResponse { peers: peer_list });
        if let Err(e) = transport_guard.send(sender, response).await {
            warn!("Failed to send peer list to {sender}: {e}");
        }
    }

    async fn handle_peer_list_response(transport: &Arc<RwLock<Tcp>>, peer_list: &[SocketAddr]) {
        for &peer_addr in peer_list {
            if let Err(e) = transport.read().await.connect(peer_addr).await {
                debug!("Failed to connect to peer {peer_addr}: {e}");
            }
        }
    }
}