lighter-sdk 0.1.1

Rust SDK for interacting with the Lighter exchange over REST, WebSocket, and signer-backed transaction flows.
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

use crate::error::Result;
use crate::models::account::*;
use crate::rest::client::LighterRestClient;

impl LighterRestClient {
    /// Look up accounts by a given field (`"l1_address"`, `"index"`, etc.).
    pub async fn get_account(&self, by: &str, value: &str) -> Result<Accounts> {
        self.get_with_query("/api/v1/account", &[("by", by), ("value", value)])
            .await
    }

    /// Look up account by numeric account index.
    pub async fn get_account_by_index(&self, account_index: i64) -> Result<Accounts> {
        let account_index = account_index.to_string();
        self.get_account("index", account_index.as_str()).await
    }

    /// Look up accounts with an auth header (returns positions, PnL, etc.).
    pub async fn get_detailed_account(
        &self,
        by: &str,
        value: &str,
        auth: &str,
    ) -> Result<DetailedAccounts> {
        self.get_with_auth("/api/v1/account", &[("by", by), ("value", value)], auth)
            .await
    }

    /// Look up account details by numeric account index.
    pub async fn get_detailed_account_by_index(
        &self,
        account_index: i64,
        auth: &str,
    ) -> Result<DetailedAccounts> {
        let account_index = account_index.to_string();
        self.get_detailed_account("index", account_index.as_str(), auth)
            .await
    }

    pub async fn get_account_api_keys(
        &self,
        account_index: i64,
        auth: &str,
    ) -> Result<AccountApiKeys> {
        let account_index = account_index.to_string();
        self.get_with_auth(
            "/api/v1/apikeys",
            &[("account_index", account_index.as_str())],
            auth,
        )
        .await
    }

    pub async fn get_account_limits(
        &self,
        account_index: i64,
        auth: &str,
    ) -> Result<AccountLimits> {
        let account_index = account_index.to_string();
        self.get_with_auth(
            "/api/v1/accountLimits",
            &[("account_index", account_index.as_str())],
            auth,
        )
        .await
    }

    pub async fn get_account_metadata(
        &self,
        by: &str,
        value: &str,
        auth: &str,
    ) -> Result<AccountMetadatas> {
        self.get_with_auth(
            "/api/v1/accountMetadata",
            &[("by", by), ("value", value)],
            auth,
        )
        .await
    }

    pub async fn get_account_metadata_by_index(
        &self,
        account_index: i64,
        auth: &str,
    ) -> Result<AccountMetadatas> {
        let account_index = account_index.to_string();
        self.get_account_metadata("index", account_index.as_str(), auth)
            .await
    }

    #[allow(clippy::too_many_arguments)]
    pub async fn get_account_pnl(
        &self,
        account_index: i64,
        resolution: &str,
        start_timestamp: i64,
        end_timestamp: i64,
        count_back: i64,
        ignore_transfers: bool,
        auth: &str,
    ) -> Result<AccountPnl> {
        let account_index = account_index.to_string();
        let start_timestamp = start_timestamp.to_string();
        let end_timestamp = end_timestamp.to_string();
        let count_back = count_back.to_string();
        let mut query = vec![
            ("by", "index"),
            ("value", account_index.as_str()),
            ("resolution", resolution),
            ("start_timestamp", start_timestamp.as_str()),
            ("end_timestamp", end_timestamp.as_str()),
            ("count_back", count_back.as_str()),
        ];
        if ignore_transfers {
            query.push(("ignore_transfers", "true"));
        }
        self.get_with_auth("/api/v1/pnl", &query, auth).await
    }

    pub async fn get_sub_accounts(&self, l1_address: &str) -> Result<SubAccounts> {
        self.get_with_query("/api/v1/accountsByL1Address", &[("l1_address", l1_address)])
            .await
    }

    /// Change the account tier (e.g. "standard" -> "premium").
    pub async fn change_account_tier(
        &self,
        account_index: i64,
        new_tier: &str,
        auth: &str,
    ) -> Result<ChangeAccountTierResponse> {
        let account_index = account_index.to_string();
        self.post_form_with_auth(
            "/api/v1/changeAccountTier",
            &[
                ("account_index", account_index.as_str()),
                ("new_tier", new_tier),
            ],
            auth,
        )
        .await
    }
}