koios-sdk 0.1.1

A Rust SDK for the Koios Cardano API
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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145

use serde::{Deserialize, Serialize};

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct AccountList {
    pub stake_address: String,
    pub stake_address_hex: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub script_hash: Option<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct AccountInfo {
    pub stake_address: String,
    pub status: AccountStatus,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub delegated_drep: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub delegated_pool: Option<String>,
    pub total_balance: String,
    pub utxo: String,
    pub rewards: String,
    pub withdrawals: String,
    pub rewards_available: String,
    pub deposit: String,
    pub reserves: String,
    pub treasury: String,
}

#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq)]
#[serde(rename_all = "snake_case")]
pub enum AccountStatus {
    Registered,
    NotRegistered,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct AccountRewards {
    pub stake_address: String,
    pub rewards: Vec<RewardInfo>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct RewardInfo {
    pub earned_epoch: u64,
    pub spendable_epoch: u64,
    pub amount: String,
    #[serde(rename = "type")]
    pub reward_type: RewardType,
    pub pool_id: Option<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Copy, PartialEq)]
#[serde(rename_all = "lowercase")]
pub enum RewardType {
    Member,
    Leader,
    Treasury,
    Reserves,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct AccountUpdates {
    pub stake_address: String,
    pub updates: Vec<AccountUpdate>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct AccountUpdate {
    pub action_type: AccountActionType,
    pub tx_hash: String,
    pub epoch_no: u64,
    pub epoch_slot: u64,
    pub absolute_slot: u64,
    pub block_time: u64,
}

#[derive(Debug, Clone, Serialize, Deserialize, Copy, PartialEq)]
#[serde(rename_all = "lowercase")]
pub enum AccountActionType {
    Registration,
    Delegation,
    Withdrawal,
    Deregistration,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct AccountAddresses {
    pub stake_address: String,
    pub addresses: Vec<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct AccountAssets {
    pub stake_address: String,
    pub policy_id: String,
    pub asset_name: String,
    pub fingerprint: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub decimals: Option<u64>,
    pub quantity: String,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct AccountHistory {
    pub stake_address: String,
    pub history: Vec<AccountHistoryEntry>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct AccountHistoryEntry {
    pub pool_id: String,
    pub epoch_no: u64,
    pub active_stake: String,
}

// Implementation blocks
impl AccountInfo {
    pub fn new(
        stake_address: String,
        status: AccountStatus,
        total_balance: String,
        utxo: String,
        rewards: String,
        withdrawals: String,
        rewards_available: String,
        deposit: String,
        reserves: String,
        treasury: String,
    ) -> Self {
        Self {
            stake_address,
            status,
            delegated_drep: None,
            delegated_pool: None,
            total_balance,
            utxo,
            rewards,
            withdrawals,
            rewards_available,
            deposit,
            reserves,
            treasury,
        }
    }
}