nomadnet-rs 0.1.0

Rust library for NomadNet Node Hosting and browsing over Reticulum
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

pub const DEFAULT_ANNOUNCE_INTERVAL_SECS: u64 = 600;
pub const MAX_DIRECTORY_ENTRIES: usize = 256;

/// Configuration for creating a [`NomadNode`](crate::NomadNode).
pub struct NodeConfig {
    pub identity_prv: [u8; 64],
    pub identity_pub: [u8; 32],
    pub node_name: String,
    pub announce_interval_secs: u64,
}

impl Default for NodeConfig {
    fn default() -> Self {
        Self {
            identity_prv: [0u8; 64],
            identity_pub: [0u8; 32],
            node_name: String::from("Unnamed Node"),
            announce_interval_secs: DEFAULT_ANNOUNCE_INTERVAL_SECS,
        }
    }
}

/// A discovered NomadNet node in the directory.
pub struct DirectoryEntry {
    pub dest_hash: [u8; 16],
    pub identity_hash: [u8; 16],
    pub node_name: Option<String>,
    pub hops: u8,
    pub last_seen: f64,
}

/// Events emitted by [`NomadBrowser`](crate::NomadBrowser).
pub enum BrowseEvent {
    PageReceived {
        dest_hash: [u8; 16],
        path: String,
        content: Vec<u8>,
    },
    LinkEstablished {
        dest_hash: [u8; 16],
        link_id: [u8; 16],
    },
    LinkFailed {
        dest_hash: [u8; 16],
        error: String,
    },
    LinkClosed {
        dest_hash: [u8; 16],
        link_id: [u8; 16],
        reason: Option<String>,
    },
}

#[derive(Debug, thiserror::Error)]
pub enum NomadError {
    #[error("RNS send error")]
    SendFailed(#[from] rns_net::SendError),

    #[error("No path to destination {0}")]
    NoPath(String),

    #[error("Identity not found for destination {0}")]
    IdentityNotFound(String),

    #[error("Link creation failed for destination {0}")]
    LinkFailed(String),

    #[error("Request failed for path {0}")]
    RequestFailed(String),

    #[error("Destination registration failed")]
    DestinationRegistrationFailed,

    #[error(
        "Identity public key mismatch: expected {expected_sig_pub_hex}, got {provided_sig_pub_hex}"
    )]
    IdentityKeyMismatch {
        expected_sig_pub_hex: String,
        provided_sig_pub_hex: String,
    },
}