melnet2 0.3.3

JSON-RPC/nanorpc-based, low-level auto-peering RPC protocol used throughout Themelio for peer-to-peer communciations
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

use std::{convert::Infallible, fmt::Display, str::FromStr};

use async_trait::async_trait;
use nanorpc::nanorpc_derive;
use serde::{Deserialize, Serialize};
use smol_str::SmolStr;

/// This represents a backhaul-specific melnet address. It's essentially an immutable string, and is not guaranteed to be valid in any way.
///
/// [Address] implements the `From<T>` where `T: AsRef<str>`, so any "stringy" type can be converted into an [Address].
#[derive(Clone, Debug, PartialEq, PartialOrd, Ord, Eq, Hash, Serialize, Deserialize)]
pub struct Address(SmolStr);

impl<T: AsRef<str>> From<T> for Address {
    fn from(t: T) -> Self {
        Self(t.into())
    }
}

impl Display for Address {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        self.0.fmt(f)
    }
}

impl FromStr for Address {
    type Err = Infallible;
    fn from_str(s: &str) -> Result<Self, Self::Err> {
        Ok(Self(s.into()))
    }
}

/// This trait defines the melnet *control* protocol
#[nanorpc_derive]
#[async_trait]
pub trait ControlProtocol {
    /// Returns the melnet swarm ID. Used to make sure different P2P networks are not confused with each other, as well as acting as a "ping" method.
    async fn __mn_get_swarm_id(&self) -> String;

    /// Obtains random peers.
    async fn __mn_get_random_peers(&self) -> Vec<Address>;

    /// Attempts to add a peer to the table. Does not return success or failure.
    async fn __mn_advertise_peer(&self, peer: Address) -> bool;
}