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
102
103
104
105
106
107
108
109
110
111
112

use crate::models::prelude::*;
use derive_getters::Getters;
use serde::{Deserialize, Serialize};

/// Represents the response for the 'all offers' query in the Horizon API.
///
/// This struct defines the overall structure of the response for an 'all offers' query.
/// It includes navigational links and embedded results.
///
#[derive(Debug, Clone, Serialize, Deserialize, Getters)]
#[serde(rename_all = "camelCase")]
pub struct AllOffersResponse {
    #[serde(rename = "_links")]
    pub links: ResponseLinks,
    #[serde(rename = "_embedded")]
    pub embedded: Embedded<OfferResponse>,
}

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

        Ok(response)
    }
}

/// Represents the asset to buy or to sell.
///
/// This struct details information about the asset to buy or to sell, including its type,
/// code (optional) and issuer (optional).
///
#[derive(Debug, Deserialize, Serialize, Clone, Getters)]
pub struct Transaction {
    /// The type of asset (e.g. "credit_alphanum4", "credit_alphanum12").
    asset_type: String,
    /// Optional. The code of the asset.
    asset_code: Option<String>,
    /// Optional. The public key of the issuer.
    asset_issuer: Option<String>,
}

/// Represents the precise buy and sell price of the assets on offer.
///
/// This struct contains a numenator and a denominator, so that the price ratio can be determined
/// in a precise manner.
///
#[derive(Debug, Deserialize, Serialize, Clone, Getters)]
pub struct PriceR {
    /// The numenator.
    #[serde(rename = "n")]
    numenator: u32,
    /// The denominator.
    #[serde(rename = "d")]
    denominator: u32,
}

/// Represents the navigational links in a single offer response from the Horizon API.
///
/// This struct includes various hyperlinks such as links to the offer itself
/// and the offer maker.
///
#[derive(Debug, Deserialize, Serialize, Clone, Getters)]
pub struct OfferResponseLinks {
    /// The link to the offer itself.
    #[serde(rename = "self")]
    self_link: Link,
    /// Link to the offer's maker.
    offer_maker: Link,
}

/// Represents the response for a single offer query in the Horizon API.
///
/// This struct defines the overall structure of the response for a single offer query.
/// It includes navigational links, offer identifiers, the seller, the assets to buy and sell,
/// the amount, the price and additional data.
///
#[derive(Debug, Deserialize, Serialize, Clone, Getters)]
pub struct OfferResponse {
    /// Navigational links related to the offer.
    #[serde(rename = "_links")]
    links: OfferResponseLinks,
    /// The unique identifier for the offer.
    id: String,
    /// A token used for paging through results.
    paging_token: String,
    /// The ID of the seller making the offer.
    seller: String,
    /// The asset the offer wants to sell.
    selling: Transaction,
    /// The asset the offer wants to buy.
    buying: Transaction,
    /// The amount of `selling` that the account making this offer is willing to sell.
    amount: String,
    /// A precise representation of the buy and sell price of the assets on offer.
    #[serde(rename = "price_r")]
    price_ratio: PriceR,
    /// A number representing the decimal form of `price_r`.
    #[serde(rename = "price")]
    price_decimal: String,
    /// The sequence number of the last ledger in which the offer was modified.
    last_modified_ledger: u32,
    /// The time at which the offer was last modified.
    last_modified_time: String,
    /// The account ID of the sponsor who is paying the reserves for this offer.
    sponsor: Option<String>,
}

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