ic-query 0.64.0

Internet Computer query library for CloudEngine, NNS, SNS, ICRC, system canisters, and public network metadata
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

//! Module: icrc::model::contracts::reports::account
//!
//! Responsibility: serialized ICRC balance and allowance report contracts.
//! Does not own: account history, ledger-wide reports, live transport, or rendering.
//! Boundary: preserves raw account and allowance result fields.

use serde::Serialize;

///
/// IcrcBalanceData
///
/// Raw balance result shared by sources and reports plus enough token metadata for display.
///

#[derive(Clone, Debug, Eq, PartialEq, Serialize)]
pub struct IcrcBalanceData {
    /// Ledger token symbol.
    pub token_symbol: String,
    /// Ledger token decimal places.
    pub decimals: u8,
    /// Balance in raw decimal base units.
    pub balance: String,
}

///
/// IcrcAllowanceData
///
/// Raw allowance result shared by sources and reports plus enough token metadata for display.
///

#[derive(Clone, Debug, Eq, PartialEq, Serialize)]
pub struct IcrcAllowanceData {
    /// Ledger token symbol.
    pub token_symbol: String,
    /// Ledger token decimal places.
    pub decimals: u8,
    /// Allowance in raw decimal base units.
    pub allowance: String,
    /// Optional expiry in raw decimal Unix nanoseconds.
    pub expires_at_unix_nanos: Option<String>,
}

///
/// IcrcBalanceReport
///
/// Serializable report for one generic ICRC account balance lookup.
///

#[derive(Clone, Debug, Eq, PartialEq, Serialize)]
pub struct IcrcBalanceReport {
    pub schema_version: u32,
    pub ledger_canister_id: String,
    pub account_owner: String,
    pub subaccount_hex: Option<String>,
    pub fetched_at: String,
    pub source_endpoint: String,
    pub fetched_by: String,
    /// Raw balance and token display metadata.
    #[serde(flatten)]
    pub value: IcrcBalanceData,
}

///
/// IcrcAllowanceReport
///
/// Serializable report for one generic ICRC allowance lookup.
///

#[derive(Clone, Debug, Eq, PartialEq, Serialize)]
pub struct IcrcAllowanceReport {
    pub schema_version: u32,
    pub ledger_canister_id: String,
    pub account_owner: String,
    pub account_subaccount_hex: Option<String>,
    pub spender_owner: String,
    pub spender_subaccount_hex: Option<String>,
    pub fetched_at: String,
    pub source_endpoint: String,
    pub fetched_by: String,
    /// Raw allowance, expiry and token display metadata.
    #[serde(flatten)]
    pub value: IcrcAllowanceData,
}