ic-query 0.81.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

//! Module: icrc::model::contracts::reports
//!
//! Responsibility: expose public serializable ICRC report and row contracts.
//! Does not own: requests, source data, errors, live transport, caching, or rendering.
//! Boundary: preserves one explicit report facade across cohesive capability families.

mod account;
mod account_history;
mod ledger;

pub use account::{IcrcAllowanceData, IcrcAllowanceReport, IcrcBalanceData, IcrcBalanceReport};
pub use account_history::{
    IcrcAccountRow, IcrcAccountTransactionCacheStatusReport, IcrcAccountTransactionCacheSummary,
    IcrcAccountTransactionListReport, IcrcAccountTransactionPageData,
    IcrcAccountTransactionPageReport, IcrcAccountTransactionRefreshAttemptStatus,
    IcrcAccountTransactionRefreshReport, IcrcAccountTransactionRow, IcrcAccountTransactionSnapshot,
};
pub use ledger::{
    IcrcArchiveFollowErrorRow, IcrcArchiveRow, IcrcArchivedBlocksRow, IcrcArchivedRangeRow,
    IcrcArchivesReport, IcrcBlockTypeRow, IcrcBlockTypesReport, IcrcCapabilitiesReport,
    IcrcCapabilityRow, IcrcCapabilityStatus, IcrcFollowedArchiveBlockRow, IcrcIndexReport,
    IcrcTipCertificateReport, IcrcTokenReport, IcrcTransactionBlockRow, IcrcTransactionsData,
    IcrcTransactionsReport,
};

///
/// IcrcReportProvenance
///
/// Ledger identity and acquisition provenance shared by live ICRC reports.
///

#[derive(Clone, Debug, Eq, PartialEq, serde::Serialize)]
pub struct IcrcReportProvenance {
    /// Schema identifier of the containing report.
    pub schema_version: u32,
    /// Ledger canister queried by the caller.
    pub ledger_canister_id: String,
    /// UTC acquisition timestamp.
    pub fetched_at: String,
    /// Explicit IC API endpoint.
    pub source_endpoint: String,
    /// Collector identity.
    pub fetched_by: String,
}

#[cfg(feature = "icrc-host")]
impl IcrcReportProvenance {
    pub(in crate::icrc) fn from_request(
        request: &crate::icrc::IcrcLedgerRequest,
        schema_version: u32,
    ) -> Self {
        Self {
            schema_version,
            ledger_canister_id: request.ledger_canister_id.clone(),
            fetched_at: ic_host_text::timestamp::format_utc_timestamp_secs(request.now_unix_secs),
            source_endpoint: request.source_endpoint.clone(),
            fetched_by: crate::icrc::live::ICRC_FETCHED_BY.to_string(),
        }
    }
}