stellar-rs 1.0.0

A Rust SDK for the Stellar network.
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 derive_getters::Getters;
use serde::{Deserialize, Serialize};

use crate::models::{
    prelude::{Embedded, Link, ResponseLinks, TemplateLink},
    Response,
};

/// Represents the response from the Horizon server when querying for all liquidity pools.
///
/// This struct represents the response from the Horizon server when querying for all liquidity pools.
/// It includes the links to the current, next, and previous pages of the response, as well as the
/// embedded records of liquidity pools.
#[derive(Default, Debug, Clone, Serialize, Deserialize, Getters)]
#[serde(rename_all = "camelCase")]
pub struct AllLiquidityPoolsResponse {
    /// The links to the current, next, and previous pages of the response.
    #[serde(rename = "_links")]
    pub links: ResponseLinks,
    /// The embedded records of liquidity pools.
    #[serde(rename = "_embedded")]
    pub embedded: Embedded<LiquidityPool>,
}

/// Represents a single liquidity pool record in the Horizon API response.
///
/// This struct encapsulates detailed information about a single liquidity pool, including its ID,
/// fee, type, reserves, and other relevant data.
#[derive(Default, Debug, Clone, Serialize, Deserialize, Getters)]
#[serde(rename_all = "camelCase")]
pub struct LiquidityPool {
    /// Navigational links related to the operation of the effect.
    #[serde(rename = "_links")]
    pub links: RecordLink,
    /// The unique identifier of the liquidity pool.
    pub id: String,
    /// A token used for paging through results.
    #[serde(rename = "paging_token")]
    pub paging_token: String,
    /// The fee in basis points.
    #[serde(rename = "fee_bp")]
    pub fee_bp: i64,
    /// The type of the liquidity pool.
    #[serde(rename = "type")]
    pub type_field: String,
    /// The total number of trustlines.
    #[serde(rename = "total_trustlines")]
    pub total_trustlines: String,
    /// The total number of shares.
    #[serde(rename = "total_shares")]
    pub total_shares: String,
    /// The reserves of the liquidity pool.
    pub reserves: Vec<Reserve>,
    /// The last modified ledger.
    #[serde(rename = "last_modified_ledger")]
    pub last_modified_ledger: i64,
    /// The last modified time.
    #[serde(rename = "last_modified_time")]
    pub last_modified_time: String,
}

/// Represents a reserve for a liquidity pool. This struct is used to specify the asset code and
/// issuer of the reserve.
#[derive(Default, Debug, Clone, Serialize, Deserialize, Getters)]
#[serde(rename_all = "camelCase")]
pub struct Reserve {
    /// The asset code of the reserve.
    pub asset: String,
    /// The asset issuer of the reserve.
    pub amount: String,
}

/// Represents the navigational links belonging to a liquidity pool from the Stellar Horizon API.
///
/// This struct includes links such as the self-link (current liquidity pool), transactions, and operations,
/// providing quick navigation across different pages of the liquidity pool.
#[derive(Default, Debug, Clone, Serialize, Deserialize, Getters)]
#[serde(rename_all = "camelCase")]
pub struct RecordLink {
    /// The link to the current liquidity pool.
    #[serde(rename = "self")]
    pub self_field: Option<Link>,
    /// The link to the transactions of the liquidity pool.
    pub transactions: TemplateLink,
    /// The link to the operations of the liquidity pool.
    pub operations: TemplateLink,
}

impl Response for AllLiquidityPoolsResponse {
    fn from_json(json: String) -> Result<Self, String> {
        serde_json::from_str(&json).map_err(|e| e.to_string())
    }
}

impl Response for LiquidityPool {
    fn from_json(json: String) -> Result<Self, String> {
        let ledger_record = serde_json::from_str(&json).map_err(|e| e.to_string())?;

        Ok(ledger_record)
    }
}