prns-core 0.3.4

Pure Reticulum engine and wire contract for Personal 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
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

use alloc::string::String;
use alloc::vec::Vec;

use crate::identity::IdentityHash;
use crate::routing::{BlackholeExpiry, BlackholedIdentity};
use crate::units::InstantMillis;

use super::message_pack::MessagePackEncoder;
use super::wire_names::{blackhole, common};
use super::RnsManagementEncodeError;

mod decoder;

pub use decoder::RnsBlackholeDecodeError;

#[derive(Debug, Clone, PartialEq, Eq)]
struct RnsBlackholeEntry {
    identity: IdentityHash,
    source: IdentityHash,
    expiry: BlackholeExpiry,
    reason: Option<String>,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct RnsBlackholeTable {
    entries: Vec<RnsBlackholeEntry>,
}

impl RnsBlackholeTable {
    pub fn from_entries<Reason: AsRef<str>>(
        entries: impl IntoIterator<Item = BlackholedIdentity<Reason>>,
    ) -> Self {
        Self {
            entries: entries.into_iter().map(RnsBlackholeEntry::from).collect(),
        }
    }

    pub fn from_source_entries<Reason: AsRef<str>>(
        source: IdentityHash,
        entries: impl IntoIterator<Item = BlackholedIdentity<Reason>>,
    ) -> Self {
        Self::from_entries(entries.into_iter().filter(|entry| entry.source == source))
    }

    pub fn decode_source_file(
        bytes: &[u8],
        source: IdentityHash,
        now: InstantMillis,
    ) -> Result<Self, RnsBlackholeDecodeError> {
        decoder::decode_source_file(bytes, source, now).map(|entries| Self { entries })
    }

    pub fn decode_published_table(
        bytes: &[u8],
        now: InstantMillis,
    ) -> Result<Self, RnsBlackholeDecodeError> {
        decoder::decode_published_table(bytes, now).map(|entries| Self { entries })
    }

    pub fn into_entries(self) -> Vec<BlackholedIdentity<String>> {
        self.entries
            .into_iter()
            .map(BlackholedIdentity::from)
            .collect()
    }

    pub fn empty() -> Self {
        Self {
            entries: Vec::new(),
        }
    }

    pub fn encode_message_pack(&self) -> Result<Vec<u8>, RnsManagementEncodeError> {
        let mut encoder = MessagePackEncoder::new();
        self.encode_into(&mut encoder)?;
        Ok(encoder.finish())
    }

    pub(crate) fn encode_into(
        &self,
        encoder: &mut MessagePackEncoder,
    ) -> Result<(), RnsManagementEncodeError> {
        encoder.map(self.entries.len())?;
        for entry in &self.entries {
            encoder.binary(entry.identity.as_bytes())?;
            encoder.map(3)?;
            encoder.field(blackhole::SOURCE)?;
            encoder.binary(entry.source.as_bytes())?;
            encoder.field(common::UNTIL)?;
            match entry.expiry {
                BlackholeExpiry::Indefinite => encoder.nil(),
                BlackholeExpiry::At(at) => encoder.float(blackhole_timestamp(at)),
            }
            encoder.field(common::REASON)?;
            match entry.reason.as_deref() {
                Some(reason) => encoder.string(reason)?,
                None => encoder.nil(),
            }
        }
        Ok(())
    }
}

impl<Reason: AsRef<str>> From<BlackholedIdentity<Reason>> for RnsBlackholeEntry {
    fn from(entry: BlackholedIdentity<Reason>) -> Self {
        Self {
            identity: entry.identity,
            source: entry.source,
            expiry: entry.expiry,
            reason: entry.reason.map(|reason| String::from(reason.as_ref())),
        }
    }
}

impl From<RnsBlackholeEntry> for BlackholedIdentity<String> {
    fn from(entry: RnsBlackholeEntry) -> Self {
        Self {
            identity: entry.identity,
            source: entry.source,
            expiry: entry.expiry,
            reason: entry.reason,
        }
    }
}

fn blackhole_timestamp(timestamp: InstantMillis) -> f64 {
    timestamp.0 as f64 / 1_000.0
}

#[cfg(test)]
mod tests;