tari_comms 5.3.0-pre.10

// Copyright 2019, The Tari Project
//
// Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
// following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following
// disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
// following disclaimer in the documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote
// products derived from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
// INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
// USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

use std::fmt;

use bitflags::bitflags;
use serde::{Deserialize, Serialize};

bitflags! {
    /// Peer feature flags. These advertised the capabilities of peer nodes.
    #[derive(Serialize, Deserialize, Clone, Copy, Debug, Eq, PartialEq)]
    pub struct PeerFeatures: u32 {
        /// No capabilities
        const NONE = 0b0000_0000;
        /// Node is able to propagate messages
        const MESSAGE_PROPAGATION = 0b0000_0001;
        /// Legacy compatibility for nodes that used to offer store and forward functionality; this is no longer used,
        /// but it will change the node's public key if it is not present.
        const DHT_STORE_FORWARD = 0b0000_0010;
        /// Node is a communication node (typically a base layer node)
        const COMMUNICATION_NODE = Self::MESSAGE_PROPAGATION.bits() | Self::DHT_STORE_FORWARD.bits();
        /// Node is a network client
        const COMMUNICATION_CLIENT = Self::NONE.bits();
    }
}

const UNKNOWN_PEER_FEATURE: i32 = -1;

impl PeerFeatures {
    /// Returns true if these flags represent a COMMUNICATION_CLIENT.
    #[inline]
    pub fn is_client(self) -> bool {
        self == PeerFeatures::COMMUNICATION_CLIENT
    }

    /// Returns true if these flags represent a COMMUNICATION_NODE.
    #[inline]
    pub fn is_node(self) -> bool {
        self == PeerFeatures::COMMUNICATION_NODE
    }

    /// Returns a human-readable string that represents these flags.
    pub fn as_role_str(self) -> &'static str {
        match self {
            PeerFeatures::COMMUNICATION_NODE => "node",
            PeerFeatures::COMMUNICATION_CLIENT => "client",
            _ => "unknown",
        }
    }

    /// Returns the bits of the PeerFeatures as an i32
    pub fn to_i32(&self) -> i32 {
        match *self {
            PeerFeatures::MESSAGE_PROPAGATION => 1,
            PeerFeatures::DHT_STORE_FORWARD => 2,
            PeerFeatures::COMMUNICATION_NODE => 3,
            PeerFeatures::COMMUNICATION_CLIENT => 0,
            _ => UNKNOWN_PEER_FEATURE, // All cases must be handled explicitly,
        }
    }
}

impl Default for PeerFeatures {
    fn default() -> Self {
        PeerFeatures::NONE
    }
}

impl fmt::Display for PeerFeatures {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{self:?}")
    }
}

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

    #[test]
    fn test_to_i32_conversion() {
        for feature in PeerFeatures::all() {
            assert_ne!(
                feature.to_i32(),
                UNKNOWN_PEER_FEATURE,
                "Failed for feature: {feature:?}",
            );
            match feature {
                PeerFeatures::NONE => assert_eq!(feature.to_i32(), 0),
                PeerFeatures::MESSAGE_PROPAGATION => assert_eq!(feature.to_i32(), 1),
                PeerFeatures::DHT_STORE_FORWARD => assert_eq!(feature.to_i32(), 2),
                PeerFeatures::COMMUNICATION_NODE => assert_eq!(feature.to_i32(), 3),
                _ => panic!("Unexpected feature: {feature:?}"),
            }
        }
    }
}