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

//! Module: icrc
//!
//! Responsibility: expose generic ICRC ledger request and report APIs.
//! Does not own: SNS lookup, NNS registry cache behavior, or release flow.
//! Boundary: exposes live read-only token metadata, account balance, allowance,
//! index discovery, account and ledger transaction history, block type, and archive reports.

#[cfg(feature = "icrc-host")]
mod account_transaction_cache;
#[cfg(any(feature = "icrc-host", feature = "sns-host"))]
pub(crate) mod ledger;
#[cfg(feature = "icrc-host")]
mod live;
mod model;

pub const DEFAULT_ICRC_SOURCE_ENDPOINT: &str = "https://icp-api.io";

#[cfg(feature = "icrc-host")]
pub use account_transaction_cache::{
    build_icrc_account_transaction_cache_status_report, build_icrc_account_transaction_list_report,
    icrc_account_transaction_cache_path, icrc_account_transaction_refresh_attempt_path,
    icrc_account_transaction_refresh_lock_path, load_cached_icrc_account_transactions,
    load_or_refresh_missing_icrc_account_transactions,
    load_or_refresh_missing_icrc_account_transactions_with_source,
    load_or_refresh_stale_icrc_account_transactions,
    load_or_refresh_stale_icrc_account_transactions_with_source,
    refresh_icrc_account_transaction_cache, refresh_icrc_account_transaction_cache_with_progress,
    refresh_icrc_account_transaction_cache_with_source,
};
#[cfg(feature = "icrc-host")]
pub use live::{
    ICRC_ACCOUNT_TRANSACTION_MAX_PAGE_SIZE,
    build::{
        build_icrc_account_transaction_page_report,
        build_icrc_account_transaction_page_report_with_source, build_icrc_allowance_report,
        build_icrc_allowance_report_with_source, build_icrc_archives_report,
        build_icrc_archives_report_with_source, build_icrc_balance_report,
        build_icrc_balance_report_with_source, build_icrc_block_types_report,
        build_icrc_block_types_report_with_source, build_icrc_capabilities_report,
        build_icrc_capabilities_report_with_source, build_icrc_index_report,
        build_icrc_index_report_with_source, build_icrc_tip_certificate_report,
        build_icrc_tip_certificate_report_with_source, build_icrc_token_report,
        build_icrc_token_report_with_source, build_icrc_transactions_report,
        build_icrc_transactions_report_with_source,
    },
    source::{
        IcrcAccountTransactionCollectionSource, IcrcAccountTransactionPageSource,
        IcrcAllowanceSource, IcrcArchivesSource, IcrcBalanceSource, IcrcBlockTypesSource,
        IcrcCapabilitiesSource, IcrcIndexSource, IcrcTipCertificateSource, IcrcTokenSource,
        IcrcTransactionsSource, LiveIcrcSource,
    },
};
pub use model::normalize_subaccount_hex;
#[cfg(feature = "icrc-host")]
pub use model::{
    CachedIcrcAccountTransactionSnapshot, IcrcAccountTransactionCollectionData,
    IcrcCapabilitiesData,
};
pub use model::{
    IcrcAccountRow, IcrcAccountTransactionCacheRequest, IcrcAccountTransactionCacheStatusReport,
    IcrcAccountTransactionCacheSummary, IcrcAccountTransactionContext, IcrcAccountTransactionError,
    IcrcAccountTransactionListReport, IcrcAccountTransactionListRequest,
    IcrcAccountTransactionPageData, IcrcAccountTransactionPageReport,
    IcrcAccountTransactionPageRequest, IcrcAccountTransactionRefreshAttemptStatus,
    IcrcAccountTransactionRefreshReport, IcrcAccountTransactionRefreshRequest,
    IcrcAccountTransactionRow, IcrcAccountTransactionSnapshot, IcrcAccountTransactionSort,
    IcrcAccountTransactionValidCacheSummary, IcrcAllowanceData, IcrcAllowanceReport,
    IcrcAllowanceRequest, IcrcArchiveFollowErrorRow, IcrcArchiveRow, IcrcArchivedBlocksRow,
    IcrcArchivedRangeRow, IcrcArchivesReport, IcrcArchivesRequest, IcrcBalanceData,
    IcrcBalanceReport, IcrcBalanceRequest, IcrcBlockTypeRow, IcrcBlockTypesReport,
    IcrcCapabilitiesReport, IcrcCapabilityRow, IcrcCapabilityStatus, IcrcError,
    IcrcFollowedArchiveBlockRow, IcrcIndexData, IcrcIndexReport, IcrcLedgerRequest,
    IcrcMetadataValueKind, IcrcReportProvenance, IcrcTipCertificateEvidence,
    IcrcTipCertificateReport, IcrcTokenData, IcrcTokenMetadataRow, IcrcTokenReport,
    IcrcTokenStandardRow, IcrcTransactionBlockRow, IcrcTransactionsData, IcrcTransactionsReport,
    IcrcTransactionsRequest,
};

#[cfg(all(test, feature = "icrc-host"))]
mod tests;