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

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

/// Represents the response for a payment paths query.
///
/// This struct defines the overall structure of the response for a query
/// that retrieves payment paths. It includes the embedded results which
/// consist of the details of each payment path.
///
#[derive(Debug, Clone, Serialize, Deserialize, Getters)]
pub struct PathsResponse {
    #[serde(rename = "_embedded")]
    embedded: Embedded<Path>,
}

/// Represents a single payment path.
///
/// This struct details a specific payment path including information about
/// the source and destination assets, their amounts, and the sequence of assets
/// that form the path.
///
#[derive(Debug, Clone, Serialize, Deserialize, Getters)]
pub struct Path {
    /// The type of the source asset.
    source_asset_type: String,
    /// The code of the source asset. Optional.
    source_asset_code: Option<String>,
    /// The issuer of the source asset. Optional.
    source_asset_issuer: Option<String>,
    /// The amount of the source asset.
    source_amount: String,
    /// The type of the destination asset.
    destination_asset_type: String,
    /// The code of the destination asset. Optional.
    destination_asset_code: Option<String>,
    /// The issuer of the destination asset. Optional.
    destination_asset_issuer: Option<String>,
    /// The amount of the destination asset.
    destination_amount: String,
    /// A vector of assets forming the path.
    path: Vec<Asset>,
}

/// Represents a single asset used in the payment path.
///
/// This struct details the information about an asset including its type,
/// code, and issuer.
///
#[derive(Debug, Clone, Serialize, Deserialize, Getters)]
pub struct Asset {
    asset_type: String,
    asset_code: Option<String>,
    asset_issuer: Option<String>,
}

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