ykong 0.1.3

Rust client for Yearn's Kong GraphQL API
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

//! TVL (Total Value Locked) queries from Kong API

use crate::client::Client;
use crate::error::Result;
use crate::types::Tvl;
use serde::Deserialize;

/// TVL period for historical queries
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum TvlPeriod {
    /// Daily data points
    Day,
    /// Weekly data points
    Week,
    /// Monthly data points
    Month,
}

impl TvlPeriod {
    fn as_str(&self) -> &'static str {
        match self {
            TvlPeriod::Day => "day",
            TvlPeriod::Week => "week",
            TvlPeriod::Month => "month",
        }
    }
}

/// TVLs API
pub struct TvlsApi<'a> {
    client: &'a Client,
}

impl<'a> TvlsApi<'a> {
    /// Create a new TVLs API instance
    #[must_use]
    pub fn new(client: &'a Client) -> Self {
        Self { client }
    }

    /// Get TVL history for a vault or strategy
    ///
    /// # Example
    ///
    /// ```no_run
    /// # async fn example() -> ykong::error::Result<()> {
    /// use ykong::{Client, TvlPeriod};
    ///
    /// let client = Client::new()?;
    /// let tvls = client.tvls().history(1, "0x...", TvlPeriod::Day, 30).await?;
    /// for tvl in tvls {
    ///     println!("TVL: ${:.2}", tvl.value);
    /// }
    /// # Ok(())
    /// # }
    /// ```
    pub async fn history(
        &self,
        chain_id: u64,
        address: &str,
        period: TvlPeriod,
        limit: u32,
    ) -> Result<Vec<Tvl>> {
        let query = format!(
            r#"{{
                tvls(chainId: {}, address: "{}", period: "{}", limit: {}) {{
                    chainId
                    address
                    value
                    priceUsd
                    priceSource
                    period
                    blockNumber
                    time
                }}
            }}"#,
            chain_id,
            address,
            period.as_str(),
            limit
        );

        #[derive(Deserialize)]
        struct Response {
            tvls: Vec<Tvl>,
        }

        let response: Response = self.client.query(&query).await?;
        Ok(response.tvls)
    }

    /// Get TVL history starting from a specific timestamp
    pub async fn history_from(
        &self,
        chain_id: u64,
        address: &str,
        period: TvlPeriod,
        limit: u32,
        timestamp: u64,
    ) -> Result<Vec<Tvl>> {
        let query = format!(
            r#"{{
                tvls(chainId: {}, address: "{}", period: "{}", limit: {}, timestamp: {}) {{
                    chainId
                    address
                    value
                    priceUsd
                    priceSource
                    period
                    blockNumber
                    time
                }}
            }}"#,
            chain_id,
            address,
            period.as_str(),
            limit,
            timestamp
        );

        #[derive(Deserialize)]
        struct Response {
            tvls: Vec<Tvl>,
        }

        let response: Response = self.client.query(&query).await?;
        Ok(response.tvls)
    }

    /// Get daily TVL history (convenience method)
    pub async fn daily(&self, chain_id: u64, address: &str, days: u32) -> Result<Vec<Tvl>> {
        self.history(chain_id, address, TvlPeriod::Day, days).await
    }

    /// Get weekly TVL history (convenience method)
    pub async fn weekly(&self, chain_id: u64, address: &str, weeks: u32) -> Result<Vec<Tvl>> {
        self.history(chain_id, address, TvlPeriod::Week, weeks)
            .await
    }

    /// Get monthly TVL history (convenience method)
    pub async fn monthly(&self, chain_id: u64, address: &str, months: u32) -> Result<Vec<Tvl>> {
        self.history(chain_id, address, TvlPeriod::Month, months)
            .await
    }

    /// Get the latest TVL value
    pub async fn current(&self, chain_id: u64, address: &str) -> Result<Option<Tvl>> {
        let tvls = self.history(chain_id, address, TvlPeriod::Day, 1).await?;
        Ok(tvls.into_iter().next())
    }
}