ftx_async 0.0.4

Unofficial asynchronous Rust library for the FTX crypto exchange Websocket and REST API. The websocket interface fully abstracts the connection to FTX by publishing messages onto a MPSC channel and managing authentication, reconnections and keep-alives in the background.
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

#![warn(rustdoc::missing_crate_level_docs)]
//! Provides access to the FTX REST API and web socket interfaces.
//!

/// Serde-enabled structure definitions for FTX API calls and response payloads..
pub mod interface;
/// Asynchronous interface to call the ['FTX REST API'](https://docs.ftx.com/reference/rest-api).
/// 
/// The module makes use of ['reqwest'](https://docs.rs/reqwest/latest/reqwest/) as an HTTP client and ['serde'](https://serde.rs/) for marshalling data in and out of the socket.
pub mod rest;
/// The ws module enables connections to the ['FTX websocket API'](https://docs.ftx.com/reference/websocket-overview). 
///
/// The websocket manager provides complete management of the websocket, including authentication, reconnection and keep-alives.
/// 
/// The module depends on ['tokio-tungstenite'](https://docs.rs/tokio-tungstenite/latest/tokio_tungstenite/) for low-level management of the websocket and ['serde'](https://serde.rs/) for marshalling data in and out of the socket.
pub mod ws;

/// Integration tests and test helper functions.
pub mod tests {
    use std::env;

    pub fn get_test_credentials() -> (String, String) {
        let api_key =
            env::var("FTX_API_KEY").expect("Could not find FTX_API_KEY environment variable.");
        let secret =
            env::var("FTX_SECRET").expect("Could not find FTX_SECRET environment variable.");
        (api_key, secret)
    }
}