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::Amount;
use enumflags2::{bitflags, BitFlags};
use serde::{Deserialize, Serialize};
use xrpl_types::LedgerTimestamp;

/// The object was placed as a passive offer
pub const LSF_PASSIVE: u32 = 0x00010000;

/// The object was placed as a sell offer
pub const LSF_SELL: u32 = 0x00020000;

/// An offer in the ledger.
///
/// <https://xrpl.org/offer.html>
///
/// {
///     "Account": "rBqb89MRQJnMPq8wTwEbtz4kvxrEDfcYvt",
///     "BookDirectory": "ACC27DE91DBA86FC509069EAF4BC511D73128B780F2E54BF5E07A369E2446000",
///     "BookNode": "0000000000000000",
///     "Flags": 131072,
///     "LedgerEntryType": "Offer",
///     "OwnerNode": "0000000000000000",
///     "PreviousTxnID": "F0AB71E777B2DA54B86231E19B82554EF1F8211F92ECA473121C655BFC5329BF",
///     "PreviousTxnLgrSeq": 14524914,
///     "Sequence": 866,
///     "TakerGets": {
///         "currency": "XAG",
///         "issuer": "r9Dr5xwkeLegBeXq6ujinjSBLQzQ1zQGjH",
///         "value": "37"
///     },
///     "TakerPays": "79550000000",
///     "index": "96F76F27D8A327FC48753167EC04A46AA0E382E6F57F32FD12274144D00F1797"
/// }
#[derive(Debug, Clone, Deserialize, Serialize)]
#[serde(rename_all = "PascalCase")]
pub struct Offer {
    pub account: String,
    pub book_directory: String,
    pub book_node: Option<String>,
    pub expiration: Option<LedgerTimestamp>,
    pub flags: BitFlags<OfferFlags>,
    pub owner_node: String,
    pub sequence: u32,
    pub taker_gets: Amount,
    pub taker_pays: Amount,
    /// 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>,

    /// `owner_funds` is present in offers returned by `book_offers` method, see
    /// <https://xrpl.org/book_offers.html#response-format>.
    #[serde(rename = "owner_funds")]
    pub owner_funds: Option<String>,
    /// `taker_gets_funded` may be present in offers returned by `book_offers` method, see
    /// <https://xrpl.org/book_offers.html#response-format>.
    #[serde(rename = "taker_gets_funded")]
    pub taker_gets_funded: Option<Amount>,
    /// taker_pays_funded may be present in offers returned by `book_offers` method, see
    /// <https://xrpl.org/book_offers.html#response-format>.
    #[serde(rename = "taker_pays_funded")]
    pub taker_pays_funded: Option<Amount>,
    /// `quality` is present in offers returned by `book_offers` method, see
    /// <https://xrpl.org/book_offers.html#response-format>.
    #[serde(rename = "quality")]
    pub quality: Option<String>,
}

#[bitflags]
#[repr(u32)]
#[derive(Debug, Copy, Clone, Eq, PartialEq)]
pub enum OfferFlags {
    Passive = 0x00010000,
    Sell = 0x00020000,
}

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

    #[test]
    fn test_deserialize_offer() {
        let json = r#"
{
    "Account": "rBqb89MRQJnMPq8wTwEbtz4kvxrEDfcYvt",
    "BookDirectory": "ACC27DE91DBA86FC509069EAF4BC511D73128B780F2E54BF5E07A369E2446000",
    "BookNode": "0000000000000000",
    "Flags": 131072,
    "LedgerEntryType": "Offer",
    "OwnerNode": "0000000000000000",
    "PreviousTxnID": "F0AB71E777B2DA54B86231E19B82554EF1F8211F92ECA473121C655BFC5329BF",
    "PreviousTxnLgrSeq": 14524914,
    "Sequence": 866,
    "TakerGets": {
        "currency": "XAG",
        "issuer": "r9Dr5xwkeLegBeXq6ujinjSBLQzQ1zQGjH",
        "value": "37"
    },
    "TakerPays": "79550000000",
    "index": "96F76F27D8A327FC48753167EC04A46AA0E382E6F57F32FD12274144D00F1797"
}
"#;

        let _offer: Offer = serde_json::from_str(json).unwrap();
    }
}