antelope 0.2.0

Antelope Standard Library
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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215

use crate::{Name, ParseError, Symbol};
use std::cmp::{Ord, PartialEq, PartialOrd};
use std::convert::From;
use std::fmt::{Display, Formatter};
use std::str::FromStr;

/// The `ExtendedSymbol` struct represents an extended symbol
///
/// Reference: <https://github.com/AntelopeIO/cdt/blob/main/libraries/eosiolib/core/eosio/symbol.hpp>
///
/// # Examples
///
/// ```
/// use antelope::ExtendedSymbol;
///
/// let ext_sym = ExtendedSymbol::from("4,FOO@token");
/// assert_eq!("4,FOO", ext_sym.get_symbol().to_string());
/// assert_eq!("token", ext_sym.get_contract().to_string());
/// ```
#[derive(Eq, Copy, Clone, Debug, PartialEq, PartialOrd, Ord, Default)]
pub struct ExtendedSymbol {
    contract: Name,
    sym: Symbol,
}

impl ExtendedSymbol {
    #[inline]
    #[must_use]
    pub fn new() -> Self {
        Self {
            contract: Name::new(),
            sym: Symbol::new(),
        }
    }

    #[inline]
    #[must_use]
    pub fn get_contract(&self) -> Name {
        self.contract
    }

    #[inline]
    #[must_use]
    pub fn get_symbol(&self) -> Symbol {
        self.sym
    }

    #[inline]
    #[must_use]
    pub fn from_extended(sym: Symbol, contract: Name) -> Self {
        ExtendedSymbol { sym, contract }
    }

    #[inline]
    #[must_use]
    pub fn from_symbol(sym: Symbol) -> Self {
        ExtendedSymbol {
            sym,
            contract: Name::new(),
        }
    }
}

impl Display for ExtendedSymbol {
    #[inline]
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        f.write_str(format!("{}@{}", self.sym, self.contract).as_str())
    }
}

impl FromStr for ExtendedSymbol {
    type Err = ParseError;

    /**
     * Parse ExtendedSymbol from string formatted as "4,SYM@contract"
     *
     */
    fn from_str(s: &str) -> Result<Self, Self::Err> {
        let parts: Vec<&str> = s.split('@').collect();
        if parts.len() != 2 {
            return Err(ParseError::BadFormat);
        }

        let symbol = match Symbol::from_str(parts[0]) {
            Ok(asset) => asset,
            Err(_) => return Err(ParseError::BadSymbol(parts[0].to_string())),
        };
        let contract = match Name::from_str(parts[1]) {
            Ok(name) => name,
            Err(_) => return Err(ParseError::BadName(parts[1].to_string())),
        };

        Ok(ExtendedSymbol::from_extended(symbol, contract))
    }
}

impl From<&str> for ExtendedSymbol {
    fn from(s: &str) -> Self {
        Self::from_str(s).unwrap_or_else(|e| panic!("failed to parse extended symbol: {}", e))
    }
}

impl AsRef<ExtendedSymbol> for ExtendedSymbol {
    #[inline]
    #[must_use]
    fn as_ref(&self) -> &ExtendedSymbol {
        self
    }
}

impl From<ExtendedSymbol> for bool {
    #[inline]
    #[must_use]
    fn from(ext_sym: ExtendedSymbol) -> Self {
        ext_sym.contract.raw() != 0 && ext_sym.sym.raw() != 0
    }
}

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

    #[test]
    fn test_cdt_1() {
        //// constexpr ExtendedSymbol::from_extended()
        // constexpr name get_symbol()
        // constexpr name get_contract()
        assert_eq!(ExtendedSymbol::new().get_symbol().raw(), 0);
        assert_eq!(ExtendedSymbol::new().get_contract().value, 0);
    }

    #[test]
    fn test_cdt_2() {
        let n0 = Name::from("1");
        let n1 = Name::from("5");
        let n2 = Name::from("a");
        let n3 = Name::from("z");
        let n4 = Name::from("111111111111j");
        let n5 = Name::from("555555555555j");
        let n6 = Name::from("aaaaaaaaaaaaj");
        let n7 = Name::from("zzzzzzzzzzzzj");

        let s0 = Symbol::from_precision(SymbolCode::from("A"), 0);
        let s1 = Symbol::from_precision(SymbolCode::from("Z"), 0);
        let s2 = Symbol::from_precision(SymbolCode::from("AAAAAAA"), 255);
        let s3 = Symbol::from_precision(SymbolCode::from("ZZZZZZZ"), 255);

        //// constexpr ExtendedSymbol::from_extended(symbol, name)
        assert_eq!(ExtendedSymbol::from_extended(s0, n0).get_symbol().raw(), 16640);
        assert_eq!(ExtendedSymbol::from_extended(s0, n1).get_symbol().code().raw(), 65);
        assert_eq!(ExtendedSymbol::from_extended(s1, n2).get_symbol().raw(), 23040);
        assert_eq!(ExtendedSymbol::from_extended(s1, n3).get_symbol().code().raw(), 90);
        assert_eq!(ExtendedSymbol::from_extended(s0, n0).get_contract().value, 576460752303423488);
        assert_eq!(ExtendedSymbol::from_extended(s0, n1).get_contract().value, 2882303761517117440);
        assert_eq!(ExtendedSymbol::from_extended(s1, n2).get_contract().value, 3458764513820540928);
        assert_eq!(ExtendedSymbol::from_extended(s1, n3).get_contract().value, 17870283321406128128);
        assert_eq!(ExtendedSymbol::from_extended(s2, n4).get_symbol().raw(), 4702111234474983935);
        assert_eq!(ExtendedSymbol::from_extended(s2, n5).get_symbol().code().raw(), 18367622009667905);
        assert_eq!(ExtendedSymbol::from_extended(s3, n6).get_symbol().raw(), 6510615555426900735);
        assert_eq!(ExtendedSymbol::from_extended(s3, n7).get_symbol().code().raw(), 25432092013386330);
        assert_eq!(ExtendedSymbol::from_extended(s2, n4).get_contract().value, 595056260442243615);
        assert_eq!(ExtendedSymbol::from_extended(s2, n5).get_contract().value, 2975281302211218015);
        assert_eq!(ExtendedSymbol::from_extended(s3, n6).get_contract().value, 3570337562653461615);
        assert_eq!(ExtendedSymbol::from_extended(s3, n7).get_contract().value, u64::MAX);
    }

    #[test]
    fn test_cdt_3() {
        let n0 = Name::from("1");
        let n3 = Name::from("z");
        let n4 = Name::from("111111111111j");
        let n7 = Name::from("zzzzzzzzzzzzj");

        let s0 = Symbol::from_precision(SymbolCode::from("A"), 0);
        let s1 = Symbol::from_precision(SymbolCode::from("Z"), 0);
        let s2 = Symbol::from_precision(SymbolCode::from("AAAAAAA"), 255);
        let s3 = Symbol::from_precision(SymbolCode::from("ZZZZZZZ"), 255);

        // -------------------------------------------------------------------------------
        // friend constexpr bool operator==(const ExtendedSymbol::from_extended(, const ExtendedSymbol::from_extended()
        assert_eq!(ExtendedSymbol::from_extended(s0, n0) == ExtendedSymbol::from_extended(s0, n0), true);
        assert_eq!(ExtendedSymbol::from_extended(s1, n3) == ExtendedSymbol::from_extended(s1, n3), true);
        assert_eq!(ExtendedSymbol::from_extended(s2, n4) == ExtendedSymbol::from_extended(s2, n4), true);
        assert_eq!(ExtendedSymbol::from_extended(s3, n7) == ExtendedSymbol::from_extended(s3, n7), true);
    }

    #[test]
    fn test_cdt_4() {
        let s0 = Symbol::from_precision(SymbolCode::from("A"), 0);
        let s1 = Symbol::from_precision(SymbolCode::from("Z"), 0);
        let s2 = Symbol::from_precision(SymbolCode::from("AAAAAAA"), 255);
        let s3 = Symbol::from_precision(SymbolCode::from("ZZZZZZZ"), 255);

        // friend constexpr bool operator!=(const ExtendedSymbol::from_extended(, const ExtendedSymbol::from_extended();
        assert_eq!(ExtendedSymbol::from_symbol(Symbol::new()) != ExtendedSymbol::from_symbol(s0), true);
        assert_eq!(ExtendedSymbol::from_symbol(s0) != ExtendedSymbol::from_symbol(s1), true);
        assert_eq!(ExtendedSymbol::from_symbol(s1) != ExtendedSymbol::from_symbol(s2), true);
        assert_eq!(ExtendedSymbol::from_symbol(s2) != ExtendedSymbol::from_symbol(s3), true);
    }

    #[test]
    fn test_cdt_5() {
        let s0 = Symbol::from_precision(SymbolCode::from("A"), 0);
        let s1 = Symbol::from_precision(SymbolCode::from("Z"), 0);
        let s2 = Symbol::from_precision(SymbolCode::from("AAAAAAA"), 255);
        let s3 = Symbol::from_precision(SymbolCode::from("ZZZZZZZ"), 255);

        // friend constexpr bool operator<(const ExtendedSymbol::from_extended(, const ExtendedSymbol::from_extended();
        assert_eq!(ExtendedSymbol::new() < ExtendedSymbol::from_symbol(s0), true);
        assert_eq!(ExtendedSymbol::new() < ExtendedSymbol::from_symbol(s1), true);
        assert_eq!(ExtendedSymbol::new() < ExtendedSymbol::from_symbol(s2), true);
        assert_eq!(ExtendedSymbol::new() < ExtendedSymbol::from_symbol(s3), true);
    }
}