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

use crate::interfaces::{
    AnnounceBandwidthCap, BitrateBps, ConfiguredInterfacePolicy, EffectiveInterfacePolicy,
    EgressCapability, IngressCapability, InterfaceCapabilities, InterfaceDefaults,
    InterfaceDescriptor, InterfaceId, InterfaceMode, MtuPolicy, TransportCapability,
};

pub const I2P_BITRATE_ESTIMATE: BitrateBps = BitrateBps::guess(256_000);
pub const I2P_HW_MTU: usize = 1_064;

pub const DEFAULTS: InterfaceDefaults = InterfaceDefaults {
    capabilities: InterfaceCapabilities {
        ingress: IngressCapability::Enabled,
        egress: EgressCapability::Enabled(TransportCapability::CrossInterfaceOnly),
    },
    mode: InterfaceMode::Full,
    gravity: crate::interfaces::InterfaceGravity::ZERO,
    bitrate: I2P_BITRATE_ESTIMATE,
    mtu: MtuPolicy::fixed(I2P_HW_MTU),
    announce_rate_limit: None,
    announce_bandwidth_cap: AnnounceBandwidthCap::RNS_DEFAULT,
    airtime_duty_cycle: None,
};

#[must_use]
pub fn configured_policy(configured: ConfiguredInterfacePolicy) -> EffectiveInterfacePolicy {
    DEFAULTS.configured(configured)
}

pub fn descriptor(id: InterfaceId, policy: EffectiveInterfacePolicy) -> InterfaceDescriptor {
    policy.descriptor(id)
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn defaults_match_rns_i2p_medium_policy() {
        let policy = configured_policy(ConfiguredInterfacePolicy::default());
        assert_eq!(policy.bitrate, BitrateBps::guess(256_000));
        assert_eq!(policy.mode, InterfaceMode::Full);
        assert_eq!(policy.mtu.resolve(policy.bitrate), Some(1_064));
    }

    #[test]
    fn configured_bitrate_does_not_change_the_fixed_i2p_mtu() {
        let policy = configured_policy(ConfiguredInterfacePolicy {
            bitrate: Some(BitrateBps::guess(1_000_000_000)),
            ..ConfiguredInterfacePolicy::default()
        });
        assert_eq!(policy.bitrate, BitrateBps::guess(1_000_000_000));
        assert_eq!(policy.mtu.resolve(policy.bitrate), Some(1_064));
    }
}