xrpl_types 0.12.0

Core types and related functions for the XRP Ledger
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

use crate::Currency;
use serde::{Deserialize, Serialize};

/// Amount of XRP or issued token. See <https://xrpl.org/currency-formats.html#specifying-currency-amounts>
#[derive(Debug, Eq, PartialEq, Serialize, Deserialize, Clone)]
#[serde(untagged)]
pub enum Amount {
    Issued(IssuedAmount),
    Drops(String),
}

impl Default for Amount {
    fn default() -> Self {
        Amount::drops(0)
    }
}

impl Amount {
    pub fn issued(
        value: impl Into<String>,
        currency: impl Into<String>,
        issuer: impl Into<String>,
    ) -> Self {
        Self::Issued(IssuedAmount::new(value, currency, issuer))
    }

    pub fn xrp(value: &str) -> Self {
        let value: f64 = value.parse().unwrap();
        Self::Drops(((value * 1_000_000.0) as u64).to_string())
    }

    pub fn drops(value: u64) -> Self {
        Self::Drops(value.to_string())
    }

    pub fn with_currency(value: &str, currency: &Currency) -> Self {
        match currency {
            Currency::Issued { currency, issuer } => Self::issued(value, currency, issuer),
            Currency::Xrp => Self::xrp(value),
        }
    }

    pub fn size(&self) -> f64 {
        match self {
            Amount::Drops(value) => value.parse::<f64>().unwrap() / 1_000_000.0,
            Amount::Issued(IssuedAmount { value, .. }) => value.parse::<f64>().unwrap(),
        }
    }
}

/// Amount of issued token. See <https://xrpl.org/currency-formats.html#token-amounts>
#[derive(Debug, Eq, PartialEq, Serialize, Deserialize, Clone)]
pub struct IssuedAmount {
    /// Decimal representation of token amount, see <https://xrpl.org/currency-formats.html#token-amounts>
    pub value: String,
    /// Currency code, see <https://xrpl.org/currency-formats.html#currency-codes>
    pub currency: String,
    /// Issuer of token, see <https://xrpl.org/currency-formats.html#token-amounts>
    pub issuer: String,
}

impl IssuedAmount {
    pub fn new(
        value: impl Into<String>,
        currency: impl Into<String>,
        issuer: impl Into<String>,
    ) -> Self {
        Self {
            value: value.into(),
            currency: currency.into(),
            issuer: issuer.into(),
        }
    }
}

#[cfg(test)]
mod test {
    use super::*;
    use crate::Amount;
    use assert_matches::assert_matches;
    use serde::Serialize;

    #[test]
    fn test_serialize_drops() {
        let amount = Amount::drops(100);

        let mut v = Vec::new();
        let mut serializer = serde_json::Serializer::new(&mut v);
        amount.serialize(&mut serializer).unwrap();
        assert_eq!(r#""100""#, String::from_utf8(v).unwrap());
    }

    #[test]
    fn test_serialize_issued_amount() {
        let amount = Amount::issued("12.34", "USD", "rhub8VRN55s94qWKDv6jmDy1pUykJzF3wq");

        let mut v = Vec::new();
        let mut serializer = serde_json::Serializer::new(&mut v);
        amount.serialize(&mut serializer).unwrap();
        assert_eq!(
            r#"{"value":"12.34","currency":"USD","issuer":"rhub8VRN55s94qWKDv6jmDy1pUykJzF3wq"}"#,
            String::from_utf8(v).unwrap()
        );
    }

    #[test]
    fn test_deserialize_drops() {
        let amount = serde_json::from_str(r#""100""#).unwrap();
        assert_matches!(amount, Amount::Drops(drops) => {
            assert_eq!(drops, "100");
        });
    }

    #[test]
    fn test_deserialize_issued_amount() {
        let amount = serde_json::from_str(
            r#"{"value":"12.34","currency":"USD","issuer":"rhub8VRN55s94qWKDv6jmDy1pUykJzF3wq"}"#,
        )
        .unwrap();
        assert_matches!(amount, Amount::Issued(IssuedAmount{value, currency, issuer}) => {
            assert_eq!(value, "12.34");
            assert_eq!(currency, "USD");
            assert_eq!(issuer, "rhub8VRN55s94qWKDv6jmDy1pUykJzF3wq");
        });
    }
}