xrpl_api 0.16.7

XRPL Protocol endpoints and resouces
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

use crate::IssuedAmount;
use enumflags2::{bitflags, BitFlags};
use serde::{Deserialize, Serialize};

/// An ripple state in the ledger.
///
/// <https://xrpl.org/ripplestate.html>
///
/// {
///     "Balance": {
///         "currency": "USD",
///         "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji",
///         "value": "-10"
///     },
///     "Flags": 393216,
///     "HighLimit": {
///         "currency": "USD",
///         "issuer": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
///         "value": "110"
///     },
///     "HighNode": "0000000000000000",
///     "LedgerEntryType": "RippleState",
///     "LowLimit": {
///         "currency": "USD",
///         "issuer": "rsA2LpzuawewSBQXkiju3YQTMzW13pAAdW",
///         "value": "0"
///     },
///     "LowNode": "0000000000000000",
///     "PreviousTxnID": "E3FE6EA3D48F0C2B639448020EA4F03D4F4F8FFDB243A852A0F59177921B4879",
///     "PreviousTxnLgrSeq": 14090896,
///     "index": "9CA88CDEDFF9252B3DE183CE35B038F57282BC9503CDFA1923EF9A95DF0D6F7B"
/// }
#[derive(Debug, Clone, Deserialize, Serialize)]
#[serde(rename_all = "PascalCase")]
pub struct RippleState {
    pub balance: IssuedAmount,
    pub flags: BitFlags<RippleStateFlags>,
    pub high_limit: IssuedAmount,
    /// This field is mandatory on `RippleState` object, but we leave it optional, such
    /// that we can parse the object from `CreateNode` fields where it is not set. See <https://xrpl.org/transaction-metadata.html>
    pub high_node: Option<String>,
    pub high_quality_in: Option<u32>,
    pub high_quality_out: Option<u32>,
    pub low_limit: IssuedAmount,
    /// This field is mandatory on `RippleState` object, but we leave it optional, such
    /// that we can parse the object from `CreateNode` fields where it is not set. See <https://xrpl.org/transaction-metadata.html>
    pub low_node: Option<String>,
    pub low_quality_in: Option<u32>,
    pub low_quality_out: Option<u32>,
    /// Declared optional since it is not part of transaction metadata fields <https://xrpl.org/transaction-metadata.html#modifiednode-fields>
    #[serde(rename = "PreviousTxnID")]
    pub previous_txn_id: Option<String>,
    /// Declared optional since it is not part of transaction metadata fields <https://xrpl.org/transaction-metadata.html#modifiednode-fields>
    pub previous_txn_lgr_seq: Option<u32>,
    #[serde(rename = "index")]
    pub index: Option<String>,
}

#[bitflags]
#[repr(u32)]
#[derive(Debug, Copy, Clone, Eq, PartialEq)]
pub enum RippleStateFlags {
    LowReserve = 0x00010000,
    HighReserve = 0x00020000,
    LowAuth = 0x00040000,
    HighAuth = 0x00080000,
    LowNoRipple = 0x00100000,
    HighNoRipple = 0x00200000,
    LowFreeze = 0x00400000,
    HighFreeze = 0x00800000,
    AMMNode = 0x01000000,
}

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

    #[test]
    fn test_deserialize_ripple_state() {
        let json = r#"
{
    "Balance": {
        "currency": "USD",
        "issuer": "rrrrrrrrrrrrrrrrrrrrBZbvji",
        "value": "-10"
    },
    "Flags": 393216,
    "HighLimit": {
        "currency": "USD",
        "issuer": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
        "value": "110"
    },
    "HighNode": "0000000000000000",
    "LedgerEntryType": "RippleState",
    "LowLimit": {
        "currency": "USD",
        "issuer": "rsA2LpzuawewSBQXkiju3YQTMzW13pAAdW",
        "value": "0"
    },
    "LowNode": "0000000000000000",
    "PreviousTxnID": "E3FE6EA3D48F0C2B639448020EA4F03D4F4F8FFDB243A852A0F59177921B4879",
    "PreviousTxnLgrSeq": 14090896,
    "index": "9CA88CDEDFF9252B3DE183CE35B038F57282BC9503CDFA1923EF9A95DF0D6F7B"
}
"#;

        let _ripple_state: RippleState = serde_json::from_str(json).unwrap();
    }
}