near-kit 0.7.2

A clean, ergonomic Rust client for NEAR Protocol
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
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

//! Chain identification for NEAR Protocol.

use std::fmt;

/// Identifies the NEAR chain the client is connected to.
///
/// This is a string-based newtype that replaces the former `Network` enum,
/// allowing any chain identifier (not just the hardcoded variants).
///
/// Use the named constructors for well-known chains, or [`ChainId::new`]
/// for custom ones.
///
/// # Examples
///
/// ```
/// use near_kit::ChainId;
///
/// let mainnet = ChainId::mainnet();
/// assert!(mainnet.is_mainnet());
/// assert_eq!(mainnet.as_str(), "mainnet");
///
/// let custom = ChainId::new("localnet");
/// assert_eq!(custom.as_str(), "localnet");
/// ```
#[derive(Clone, Debug, PartialEq, Eq, Hash)]
pub struct ChainId(String);

impl ChainId {
    /// Create a chain ID from any string.
    pub fn new(id: impl Into<String>) -> Self {
        Self(id.into())
    }

    /// NEAR mainnet.
    pub fn mainnet() -> Self {
        Self("mainnet".to_string())
    }

    /// NEAR testnet.
    pub fn testnet() -> Self {
        Self("testnet".to_string())
    }

    /// Returns true if this is mainnet.
    pub fn is_mainnet(&self) -> bool {
        self.0 == "mainnet"
    }

    /// Returns true if this is testnet.
    pub fn is_testnet(&self) -> bool {
        self.0 == "testnet"
    }

    /// Returns the chain identifier as a string slice.
    pub fn as_str(&self) -> &str {
        &self.0
    }
}

impl Default for ChainId {
    fn default() -> Self {
        Self::mainnet()
    }
}

impl AsRef<str> for ChainId {
    fn as_ref(&self) -> &str {
        &self.0
    }
}

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

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

    #[test]
    fn test_chain_id_display() {
        assert_eq!(ChainId::mainnet().to_string(), "mainnet");
        assert_eq!(ChainId::testnet().to_string(), "testnet");
        assert_eq!(ChainId::new("custom").to_string(), "custom");
    }

    #[test]
    fn test_chain_id_predicates() {
        assert!(ChainId::mainnet().is_mainnet());
        assert!(!ChainId::mainnet().is_testnet());

        assert!(ChainId::testnet().is_testnet());
        assert!(!ChainId::testnet().is_mainnet());
    }

    #[test]
    fn test_default_is_mainnet() {
        assert_eq!(ChainId::default(), ChainId::mainnet());
    }

    #[test]
    fn test_as_str() {
        assert_eq!(ChainId::mainnet().as_str(), "mainnet");
        assert_eq!(ChainId::new("localnet").as_str(), "localnet");
    }

    #[test]
    fn test_as_ref_str() {
        let chain_id = ChainId::mainnet();
        let s: &str = chain_id.as_ref();
        assert_eq!(s, "mainnet");
    }

    #[test]
    fn test_custom_chain_id() {
        let chain_id = ChainId::new("my-custom-network");
        assert_eq!(chain_id.as_str(), "my-custom-network");
        assert!(!chain_id.is_mainnet());
        assert!(!chain_id.is_testnet());
    }
}