fyuz-sdk 0.1.1

Async Rust client for the Fyuz public REST API — bonding-curve token market data on BNB Smart Chain.
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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154

//! Token analytics, wallet performance and portfolios.
//!
//! Everything in this module is a server-side aggregate and arrives as JSON
//! numbers, so `f64` is the faithful model here — unlike balances, which stay
//! decimal strings.

use serde::Deserialize;

/// Holder concentration and flow analytics for one token.
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct TokenAnalytics {
    /// Token contract address.
    pub token_address: String,
    /// Chain slug.
    pub network: String,
    /// Number of addresses with a positive balance.
    pub holder_count: i64,
    /// Share of supply held by the top 10 holders.
    pub top10_pct: f64,
    /// Share of supply held by the creator.
    pub creator_pct: f64,
    /// Lifetime buy count.
    pub buys: i64,
    /// Lifetime sell count.
    pub sells: i64,
    /// Lifetime USD volume.
    pub volume_usd: f64,
    /// Progress toward the $30,000 graduation target, 0-100.
    pub graduation_pct: f64,
    /// `true` once graduated to a DEX pair.
    pub launched: bool,
    /// Addresses that bought in the launch block.
    pub bundle_buyers: i64,
    /// `true` when the launch-block buying pattern looks like a bundle.
    pub bundle_flag: bool,
}

/// One of a token's most profitable traders.
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct TopTrader {
    /// Wallet address.
    pub address: String,
    /// Display name, when set.
    #[serde(default)]
    pub username: Option<String>,
    /// Avatar URL, when set.
    #[serde(default)]
    pub avatar: Option<String>,
    /// Realised PnL in USD.
    pub realized_pnl_usd: f64,
    /// Unrealised PnL in USD on the still-held position.
    pub unrealized_pnl_usd: f64,
    /// Realised plus unrealised PnL in USD.
    pub total_pnl_usd: f64,
    /// USD volume traded in this token.
    pub volume_usd: f64,
    /// `true` when this wallet launched the token.
    pub is_creator: bool,
}

/// Average-cost performance for a wallet, rolled up across every token traded.
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct WalletStats {
    /// Wallet address.
    pub address: String,
    /// Display name, when set.
    #[serde(default)]
    pub username: Option<String>,
    /// Avatar URL, when set.
    #[serde(default)]
    pub avatar: Option<String>,
    /// Lifetime USD volume.
    pub volume_usd: f64,
    /// Realised PnL in USD.
    pub realized_pnl_usd: f64,
    /// Unrealised PnL in USD.
    pub unrealized_pnl_usd: f64,
    /// Realised plus unrealised PnL in USD.
    pub total_pnl_usd: f64,
    /// Return on invested capital, percent.
    pub roi_pct: f64,
    /// Share of traded tokens that are net profitable, 0-1.
    pub win_rate: f64,
    /// Distinct tokens traded.
    pub tokens_traded: i64,
    /// Lifetime trade count.
    pub trade_count: i64,
    /// USD value of everything still held.
    pub holding_value_usd: f64,
}

/// One token still held by an address.
///
/// Average-cost basis. Dust positions (balance <= 1e-6) are omitted by the
/// server.
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct PortfolioPosition {
    /// Token contract address.
    pub token_address: String,
    /// Token name.
    pub name: String,
    /// Token ticker.
    pub symbol: String,
    /// Token image URL.
    #[serde(default)]
    pub image: Option<String>,
    /// Chain slug.
    pub network: String,
    /// Net tokens held (buys minus sells), in whole tokens.
    pub balance: f64,
    /// Current token price in USD.
    pub current_price_usd: f64,
    /// Current position value in USD.
    pub value_usd: f64,
    /// Cost basis of the position in USD.
    pub cost_usd: f64,
    /// Average buy price in USD.
    pub avg_buy_price_usd: f64,
    /// Unrealised PnL in USD.
    pub unrealized_pnl_usd: f64,
    /// Unrealised PnL, percent of cost.
    pub unrealized_pnl_pct: f64,
    /// Realised PnL in USD on this token.
    pub realized_pnl_usd: f64,
}

/// Live average-cost PnL for an address.
///
/// An address with no trades returns zeroed totals and an empty
/// [`positions`](Self::positions) array rather than a 404.
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Portfolio {
    /// Wallet address.
    pub address: String,
    /// USD value of everything held.
    pub total_value_usd: f64,
    /// USD cost basis of everything held.
    pub total_cost_usd: f64,
    /// Unrealised PnL in USD.
    pub unrealized_pnl_usd: f64,
    /// Realised PnL in USD.
    pub realized_pnl_usd: f64,
    /// Realised plus unrealised PnL in USD.
    pub total_pnl_usd: f64,
    /// Return on invested capital, percent.
    pub roi_pct: f64,
    /// Open positions, highest value first.
    pub positions: Vec<PortfolioPosition>,
}