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

ic_query/ic/
mod.rs
