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

use crate::{LedgerIndex, LedgerSpec, Request};
use serde::{Deserialize, Serialize};

/// Request that allows specifying ledger index to execute
/// request on. See <https://xrpl.org/basic-data-types.html#specifying-ledgers>.
pub trait WithLedgerSpec: Request {
    fn as_ledger_spec(&self) -> &RetrieveLedgerSpec;
    fn as_ledger_spec_mut(&mut self) -> &mut RetrieveLedgerSpec;

    fn ledger_index(mut self, ledger_index: LedgerIndex) -> Self
    where
        Self: Sized,
    {
        self.as_ledger_spec_mut().ledger_index = Some(ledger_index);
        self
    }

    fn ledger_hash(mut self, ledger_hash: impl Into<String>) -> Self
    where
        Self: Sized,
    {
        self.as_ledger_spec_mut().ledger_hash = Some(ledger_hash.into());
        self
    }

    fn ledger(self, ledger: LedgerSpec) -> Self
    where
        Self: Sized,
    {
        match ledger {
            LedgerSpec::LedgerIndex(ledger_index) => self.ledger_index(ledger_index),
            LedgerSpec::LedgerHash(ledger_hash) => self.ledger_hash(ledger_hash),
        }
    }
}

/// Ledger specification when retrieving data
#[derive(Default, Debug, Clone, Serialize)]
pub struct RetrieveLedgerSpec {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub ledger_hash: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub ledger_index: Option<LedgerIndex>,
}

/// Ledger specification in returned data
#[derive(Default, Debug, Clone, Serialize, Deserialize)]
pub struct ReturnLedgerSpec {
    pub ledger_hash: Option<String>,
    pub ledger_index: Option<u32>,
    pub ledger_current_index: Option<u32>,
    pub validated: Option<bool>,
}