dexpaprika-cli 0.4.2

DexPaprika CLI — free DEX data from the terminal. Pools, tokens, on-chain trades across 33+ chains.
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

//! Pure helpers that normalize DexPaprika sort-field values for the unified
//! search endpoints.
//!
//! The `/networks/{network}/pools/search` and `/networks/{network}/tokens/search`
//! endpoints return HTTP 400 for the legacy sort-field names that the old
//! list/filter endpoints accepted. Every incoming sort field must therefore be
//! mapped to its canonical value before it is sent upstream. Unknown values fall
//! back to the default, "volume_usd_24h".

/// Default sort field shared by both pools and tokens search.
const DEFAULT_SORT_FIELD: &str = "volume_usd_24h";

/// Map a pool sort field (legacy or canonical) to the canonical value accepted
/// by `/networks/{network}/pools/search`.
pub fn map_pool_sort_field(field: &str) -> &'static str {
    match field {
        // Canonical values pass through unchanged.
        "volume_usd_24h" => "volume_usd_24h",
        "volume_usd_7d" => "volume_usd_7d",
        "volume_usd_30d" => "volume_usd_30d",
        "liquidity_usd" => "liquidity_usd",
        "txns_24h" => "txns_24h",
        "created_at" => "created_at",
        "price_usd" => "price_usd",
        "price_change_percentage_24h" => "price_change_percentage_24h",
        // Legacy aliases.
        "volume_usd" => "volume_usd_24h",
        "volume_24h" => "volume_usd_24h",
        "volume_7d" => "volume_usd_7d",
        "volume_30d" => "volume_usd_30d",
        "transactions" => "txns_24h",
        "last_price_change_usd_24h" => "price_change_percentage_24h",
        "liquidity" => "liquidity_usd",
        _ => DEFAULT_SORT_FIELD,
    }
}

/// Map a token sort field (legacy or canonical) to the canonical value accepted
/// by `/networks/{network}/tokens/search`. Note that tokens/search rejects price
/// ordering, so "price_usd" falls back to the volume default.
pub fn map_token_sort_field(field: &str) -> &'static str {
    match field {
        // Canonical values pass through unchanged.
        "volume_usd_24h" => "volume_usd_24h",
        "volume_usd_7d" => "volume_usd_7d",
        "volume_usd_30d" => "volume_usd_30d",
        "liquidity_usd" => "liquidity_usd",
        "txns_24h" => "txns_24h",
        "fdv_usd" => "fdv_usd",
        "created_at" => "created_at",
        "price_change_percentage_24h" => "price_change_percentage_24h",
        // Legacy aliases.
        "volume_24h" => "volume_usd_24h",
        "volume_7d" => "volume_usd_7d",
        "volume_30d" => "volume_usd_30d",
        "txns" => "txns_24h",
        "price_change" => "price_change_percentage_24h",
        "fdv" => "fdv_usd",
        // tokens/search 400s on price ordering: fall back to volume.
        "price_usd" => "volume_usd_24h",
        _ => DEFAULT_SORT_FIELD,
    }
}

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

    #[test]
    fn pool_legacy_values_map_to_canonical() {
        assert_eq!(map_pool_sort_field("volume_usd"), "volume_usd_24h");
        assert_eq!(map_pool_sort_field("volume_24h"), "volume_usd_24h");
        assert_eq!(map_pool_sort_field("volume_7d"), "volume_usd_7d");
        assert_eq!(map_pool_sort_field("volume_30d"), "volume_usd_30d");
        assert_eq!(map_pool_sort_field("transactions"), "txns_24h");
        assert_eq!(
            map_pool_sort_field("last_price_change_usd_24h"),
            "price_change_percentage_24h"
        );
        assert_eq!(map_pool_sort_field("liquidity"), "liquidity_usd");
    }

    #[test]
    fn pool_canonical_values_pass_through() {
        for v in [
            "volume_usd_24h",
            "volume_usd_7d",
            "volume_usd_30d",
            "liquidity_usd",
            "txns_24h",
            "created_at",
            "price_usd",
            "price_change_percentage_24h",
        ] {
            assert_eq!(map_pool_sort_field(v), v);
        }
    }

    #[test]
    fn pool_unknown_value_falls_back_to_default() {
        assert_eq!(map_pool_sort_field("nonsense"), "volume_usd_24h");
        assert_eq!(map_pool_sort_field(""), "volume_usd_24h");
    }

    #[test]
    fn token_legacy_values_map_to_canonical() {
        assert_eq!(map_token_sort_field("volume_24h"), "volume_usd_24h");
        assert_eq!(map_token_sort_field("volume_7d"), "volume_usd_7d");
        assert_eq!(map_token_sort_field("volume_30d"), "volume_usd_30d");
        assert_eq!(map_token_sort_field("txns"), "txns_24h");
        assert_eq!(
            map_token_sort_field("price_change"),
            "price_change_percentage_24h"
        );
        assert_eq!(map_token_sort_field("fdv"), "fdv_usd");
    }

    #[test]
    fn token_price_ordering_falls_back_to_volume() {
        assert_eq!(map_token_sort_field("price_usd"), "volume_usd_24h");
    }

    #[test]
    fn token_canonical_values_pass_through() {
        for v in [
            "volume_usd_24h",
            "volume_usd_7d",
            "volume_usd_30d",
            "liquidity_usd",
            "txns_24h",
            "fdv_usd",
            "created_at",
            "price_change_percentage_24h",
        ] {
            assert_eq!(map_token_sort_field(v), v);
        }
    }

    #[test]
    fn token_unknown_value_falls_back_to_default() {
        assert_eq!(map_token_sort_field("nonsense"), "volume_usd_24h");
        assert_eq!(map_token_sort_field(""), "volume_usd_24h");
    }
}