lnm-sdk 0.4.2

Rust SDK for interacting with LN Markets.
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

use std::fmt;

use chrono::{DateTime, Utc, serde::ts_milliseconds};
use serde::Deserialize;

use crate::shared::models::price::Price;

/// A historical price entry from the LN Markets futures API.
///
/// This type represents a single price observation at a specific point in time,
/// as returned by the price history endpoint. Each entry contains a timestamp
/// and the corresponding Bitcoin price in USD.
///
/// # Examples
///
/// ```no_run
/// # #[allow(deprecated)]
/// # async fn example(rest: lnm_sdk::api_v2::RestClient) -> Result<(), Box<dyn std::error::Error>> {
/// use lnm_sdk::api_v2::models::PriceEntry;
///
/// let price_history: Vec<PriceEntry> = rest
///     .futures
///     .price_history(None, None, None)
///     .await?;
///
/// for entry in price_history {
///     println!("Price at {}: {}", entry.time(), entry.value());
/// }
/// # Ok(())
/// # }
/// ```
#[derive(Debug, Clone, Deserialize)]
pub struct PriceEntry {
    #[serde(with = "ts_milliseconds")]
    time: DateTime<Utc>,
    value: Price,
}

impl PriceEntry {
    /// Returns the timestamp when this price was observed.
    ///
    /// # Examples
    ///
    /// ```no_run
    /// # #[allow(deprecated)]
    /// # async fn example(rest: lnm_sdk::api_v2::RestClient) -> Result<(), Box<dyn std::error::Error>> {
    /// # use lnm_sdk::api_v2::models::PriceEntry;
    /// let price_history: Vec<PriceEntry> = rest
    ///     .futures
    ///     .price_history(None, None, None)
    ///     .await?;
    ///
    /// if let Some(entry) = price_history.first() {
    ///     let timestamp = entry.time();
    ///     println!("Price observed at: {}", timestamp);
    /// }
    /// # Ok(())
    /// # }
    /// ```
    pub fn time(&self) -> DateTime<Utc> {
        self.time
    }

    /// Returns the Bitcoin price in USD for this entry.
    ///
    /// # Examples
    ///
    /// ```no_run
    /// # #[allow(deprecated)]
    /// # async fn example(rest: lnm_sdk::api_v2::RestClient) -> Result<(), Box<dyn std::error::Error>> {
    /// # use lnm_sdk::api_v2::models::PriceEntry;
    /// let price_history: Vec<PriceEntry> = rest
    ///     .futures
    ///     .price_history(None, None, None)
    ///     .await?;
    ///
    /// if let Some(entry) = price_history.first() {
    ///     let price = entry.value();
    ///     println!("Bitcoin price: ${}", price.as_f64());
    /// }
    /// # Ok(())
    /// # }
    /// ```
    pub fn value(&self) -> Price {
        self.value
    }

    pub fn as_data_str(&self) -> String {
        format!("time: {}\nvalue: {}", self.time.to_rfc3339(), self.value)
    }
}

impl fmt::Display for PriceEntry {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "Price Entry:")?;
        for line in self.as_data_str().lines() {
            write!(f, "\n  {line}")?;
        }
        Ok(())
    }
}