canic-cdk 0.25.9

Canic — a canister orchestration and management toolkit for the Internet Computer
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

use crate::spec::prelude::*;

//
// AssetClass
// XRC asset class discriminator.
//

#[derive(CandidType, Clone, Copy, Debug, Deserialize, Eq, PartialEq)]
pub enum AssetClass {
    Cryptocurrency,
    FiatCurrency,
}

//
// Asset
// XRC asset descriptor used in exchange rate queries.
//

#[derive(CandidType, Clone, Debug, Deserialize)]
pub struct Asset {
    pub symbol: String,
    pub class: AssetClass,
}

//
// GetExchangeRateRequest
// Request payload for XRC `get_exchange_rate`.
//

#[derive(CandidType, Clone, Debug, Deserialize)]
pub struct GetExchangeRateRequest {
    pub base_asset: Asset,
    pub quote_asset: Asset,
    pub timestamp: Option<u64>,
}

//
// ExchangeRateMetadata
// Metadata attached to a returned exchange rate.
//

#[derive(CandidType, Clone, Debug, Deserialize)]
pub struct ExchangeRateMetadata {
    pub decimals: u32,
    pub base_asset_num_queried_sources: u32,
    pub base_asset_num_received_rates: u32,
    pub quote_asset_num_queried_sources: u32,
    pub quote_asset_num_received_rates: u32,
    pub standard_deviation: u64,
    pub forex_timestamp: Option<u64>,
}

//
// ExchangeRate
// Returned exchange rate record.
//

#[derive(CandidType, Clone, Debug, Deserialize)]
pub struct ExchangeRate {
    pub rate: u64,
    pub metadata: ExchangeRateMetadata,
}

//
// ExchangeRateError
// Error variants returned by XRC.
//

#[derive(CandidType, Clone, Debug, Deserialize)]
pub enum ExchangeRateError {
    AnonymousPrincipalNotAllowed,
    CryptoQuoteAssetNotFound,
    FailedToAcceptCycles,
    ForexBaseAssetNotFound,
    CryptoBaseAssetNotFound,
    StablecoinRateTooFewRates,
    ForexAssetsNotFound,
    InconsistentRatesReceived,
    RateLimited,
    StablecoinRateZeroRate,
    Other(String),
    NotEnoughCycles,
    ForexInvalidTimestamp,
    NotEnoughRates,
    ForexQuoteAssetNotFound,
    StablecoinRateNotFound,
}

//
// GetExchangeRateResult
// Result envelope for XRC `get_exchange_rate`.
//

#[derive(CandidType, Clone, Debug, Deserialize)]
pub enum GetExchangeRateResult {
    Ok(ExchangeRate),
    Err(ExchangeRateError),
}