ic_query/ic/
mod.rs

1//! Official IC Dashboard API report models, adapters, builders, and renderers.
2
3#[cfg(feature = "host")]
4mod build;
5#[cfg(feature = "host")]
6mod live;
7mod model;
8#[cfg(feature = "host")]
9mod source;
10mod text;
11
12#[cfg(feature = "host")]
13pub use build::{
14    build_ic_boundary_node_data_centers_report,
15    build_ic_boundary_node_data_centers_report_with_source, build_ic_canister_count_report,
16    build_ic_canister_count_report_with_source, build_ic_canister_page_report,
17    build_ic_canister_page_report_with_source, build_ic_daily_stats_report,
18    build_ic_daily_stats_report_with_source, build_ic_metric_report,
19    build_ic_metric_report_with_source, build_icrc_indexed_count_report,
20    build_icrc_indexed_count_report_with_source, build_icrc_total_supply_report,
21    build_icrc_total_supply_report_with_source,
22};
23#[cfg(feature = "host")]
24pub use build::{build_ic_canister_report, build_ic_canister_report_with_source};
25#[cfg(feature = "host")]
26pub use live::LiveIcSource;
27pub use model::{
28    IcBoundaryNodeDataCenterRow, IcBoundaryNodeDataCentersReport, IcBoundaryNodeDataCentersRequest,
29    IcCanisterCountReport, IcCanisterCountRequest, IcCanisterFilters, IcCanisterPageController,
30    IcCanisterPageReport, IcCanisterPageRequest, IcCanisterPageRow, IcCanisterReport,
31    IcCanisterRequest, IcCanisterUpgrade, IcDailyStatsQuery, IcDailyStatsReport,
32    IcDailyStatsRequest, IcDailyStatsRow, IcDashboardReportProvenance, IcIcrcAnalyticsRequest,
33    IcIcrcIndexedCountKind, IcIcrcIndexedCountReport, IcIcrcIndexedCountRequest,
34    IcIcrcTotalSupplyObservation, IcIcrcTotalSupplyQuery, IcIcrcTotalSupplyReport,
35    IcIcrcTotalSupplyRequest, IcMetricKind, IcMetricObservation, IcMetricQuery, IcMetricReport,
36    IcMetricRequest, IcMetricSeries,
37};
38#[cfg(feature = "host")]
39pub use model::{
40    IcBoundaryNodeDataCentersSourceData, IcCanisterCountSourceData, IcCanisterPageSourceData,
41    IcCanisterSourceData, IcDailyStatsSourceData, IcHostError, IcIcrcIndexedCountSourceData,
42    IcIcrcTotalSupplySourceData, IcMetricSourceData, IcSourceRequest,
43};
44#[cfg(feature = "host")]
45pub use source::{
46    IcCanisterCollectionSource, IcCanisterSource, IcIcrcAnalyticsSource, IcMetricSource,
47    IcNetworkSource,
48};
49pub use text::{
50    ic_boundary_node_data_centers_report_text, ic_canister_count_report_text,
51    ic_canister_page_report_text, ic_canister_report_text, ic_daily_stats_report_text,
52    ic_metric_report_text, icrc_indexed_count_report_text, icrc_total_supply_report_text,
53};
54
55/// Default base endpoint for the official IC Dashboard API.
56pub const DEFAULT_IC_DASHBOARD_SOURCE_ENDPOINT: &str = "https://ic-api.internetcomputer.org/api/v3";
57
58/// Default base endpoint for official IC Dashboard canister collection queries.
59pub const DEFAULT_IC_DASHBOARD_CANISTER_COLLECTION_SOURCE_ENDPOINT: &str =
60    "https://ic-api.internetcomputer.org/api/v4";
61
62/// Default base endpoint for the official IC Dashboard Metrics API.
63pub const DEFAULT_IC_DASHBOARD_METRICS_SOURCE_ENDPOINT: &str =
64    "https://metrics-api.internetcomputer.org/api/v1";
65
66/// Default base endpoint for the official Dashboard ICRC analytics API.
67pub const DEFAULT_ICRC_ANALYTICS_SOURCE_ENDPOINT: &str =
68    "https://icrc-api.internetcomputer.org/api/v2";
69
70/// Default base endpoint for official boundary-node data-center queries.
71pub const DEFAULT_IC_BOUNDARY_NODE_DATA_CENTERS_SOURCE_ENDPOINT: &str =
72    "https://ic-api.internetcomputer.org/api/v4";
73
74/// Default row limit for one official Dashboard canister page.
75pub const DEFAULT_IC_CANISTER_PAGE_LIMIT: u16 = 50;
76
77/// Maximum row limit accepted for one official Dashboard canister page.
78pub const MAX_IC_CANISTER_PAGE_LIMIT: u16 = 100;
79
80/// Default relative window for one Dashboard metric query.
81pub const DEFAULT_IC_METRIC_WINDOW_SECS: u64 = 3_600;
82
83/// Default interval between requested Dashboard metric observations.
84pub const DEFAULT_IC_METRIC_STEP_SECS: u32 = 300;
85
86/// Earliest timestamp accepted by the official Dashboard Metrics API.
87pub const MIN_IC_METRIC_TIMESTAMP: u64 = 1_620_432_000;
88
89/// Largest step accepted by the official Dashboard Metrics API.
90pub const MAX_IC_METRIC_STEP_SECS: u32 = 259_200;
91
92/// Maximum requested observations accepted per metric series.
93pub const MAX_IC_METRIC_OBSERVATIONS_PER_SERIES: u64 = 1_000;
94
95/// Default relative window for one ICRC total-supply analytics query.
96pub const DEFAULT_ICRC_TOTAL_SUPPLY_WINDOW_SECS: u64 = 30 * 24 * 60 * 60;
97
98/// Default interval between ICRC total-supply observations.
99pub const DEFAULT_ICRC_TOTAL_SUPPLY_STEP_SECS: u32 = 86_400;
100
101/// Earliest timestamp accepted by the official Dashboard ICRC analytics API.
102pub const MIN_ICRC_ANALYTICS_TIMESTAMP: u64 = 1_620_328_530;
103
104/// Maximum requested observations accepted for one ICRC analytics series.
105pub const MAX_ICRC_ANALYTICS_OBSERVATIONS: u64 = 1_000;
106
107/// Default relative window for one Dashboard daily-statistics query.
108pub const DEFAULT_IC_DAILY_STATS_WINDOW_SECS: u64 = 7 * 24 * 60 * 60;
109
110/// Earliest timestamp accepted by the official Dashboard daily-statistics API.
111pub const MIN_IC_DAILY_STATS_TIMESTAMP: u64 = 1_620_406_800;
112
113/// Largest time window accepted by one daily-statistics request.
114pub const MAX_IC_DAILY_STATS_WINDOW_SECS: u64 = 366 * 24 * 60 * 60;
115
116/// Maximum daily-statistics rows accepted from one source response.
117pub const MAX_IC_DAILY_STATS_ROWS: usize = 366;
118
119/// Maximum boundary-node data-center rows accepted from one source response.
120pub const MAX_IC_BOUNDARY_NODE_DATA_CENTERS: usize = 1_000;
121
122#[cfg(feature = "host")]
123const IC_DASHBOARD_REPORT_SCHEMA_VERSION: u32 = 1;
124#[cfg(feature = "host")]
125const IC_DASHBOARD_AUTHORITY: &str = "official_ic_dashboard_api";
126#[cfg(feature = "host")]
127const IC_DASHBOARD_NETWORK: &str = "ic";
128
129#[cfg(all(test, feature = "host"))]
130mod tests;
ic_query/ic/mod.rs

ic_query/ic/
mod.rs
