distributed-topic-tracker 0.3.0

automagically find peers interested in a topic + iroh-gossip integration
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

//! Decentralized bootstrap for iroh-gossip topics via DHT auto-discovery.
//!
//! Combines iroh-gossip with mainline DHT to enable automatic peer discovery
//! and topic joining without prior knowledge of peers. Includes bubble detection
//! and message overlap merging for cluster topology optimization.

mod merge;
mod receiver;
mod sender;
mod topic;

pub use merge::{BubbleMerge, MessageOverlapMerge};
pub use receiver::GossipReceiver;
pub use sender::GossipSender;
use serde::{Deserialize, Serialize};
pub use topic::{Bootstrap, Publisher, Topic};

use crate::{MAX_MESSAGE_HASHES, MAX_RECORD_PEERS, RecordPublisher};

/// Record content for peer discovery.
///
/// Stored in DHT records to advertise this node's active peers
/// and recently seen message hashes for cluster merging.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct GossipRecordContent {
    /// Fixed array of MAX_RECORD_PEERS peer node IDs (as 32-byte arrays, empty slots are zero-filled)
    pub active_peers: [[u8; 32]; MAX_RECORD_PEERS],
    /// Fixed array of MAX_MESSAGE_HASHES recent message hashes for overlap detection (empty slots are zero-filled)
    pub last_message_hashes: [[u8; 32]; MAX_MESSAGE_HASHES],
}

/// Extension trait for iroh Gossip enabling auto-discovery.
pub trait AutoDiscoveryGossip {
    /// Subscribe to a topic and bootstrap with DHT peer discovery.
    ///
    /// Starts bootstrap and waits until at least one neighbor connection is established.
    /// Returns a `Topic` for sending/receiving messages.
    #[allow(async_fn_in_trait)]
    async fn subscribe_and_join_with_auto_discovery(
        &self,
        record_publisher: RecordPublisher,
    ) -> anyhow::Result<Topic>;

    /// Subscribe to a topic and bootstrap asynchronously.
    ///
    /// Returns immediately with a `Topic` while bootstrap proceeds in background.
    #[allow(async_fn_in_trait)]
    async fn subscribe_and_join_with_auto_discovery_no_wait(
        &self,
        record_publisher: RecordPublisher,
    ) -> anyhow::Result<Topic>;
}

impl AutoDiscoveryGossip for iroh_gossip::net::Gossip {
    async fn subscribe_and_join_with_auto_discovery(
        &self,
        record_publisher: RecordPublisher,
    ) -> anyhow::Result<Topic> {
        Topic::new(record_publisher, self.clone(), false).await
    }

    async fn subscribe_and_join_with_auto_discovery_no_wait(
        &self,
        record_publisher: RecordPublisher,
    ) -> anyhow::Result<Topic> {
        Topic::new(record_publisher, self.clone(), true).await
    }
}