ic_query/ic/
mod.rs

1//! Certified IC state and official Dashboard report models, adapters, builders, and renderers.
2
3mod api_boundary_node;
4#[cfg(feature = "dashboard-host")]
5mod build;
6#[cfg(feature = "dashboard-host")]
7mod live;
8mod model;
9mod node_status;
10#[cfg(feature = "dashboard-host")]
11mod source;
12mod text;
13
14pub use api_boundary_node::{
15    DEFAULT_IC_STATE_SOURCE_ENDPOINT, IC_API_BOUNDARY_NODE_REPORT_SCHEMA_VERSION,
16    IcApiBoundaryNodeReport, IcApiBoundaryNodeRequest, IcApiBoundaryNodeRow,
17    IcCertifiedStateProvenance, MAX_IC_API_BOUNDARY_NODE_ROWS, ic_api_boundary_node_report_text,
18};
19#[cfg(feature = "ic-state-host")]
20pub use api_boundary_node::{
21    IcApiBoundaryNodeHostError, IcApiBoundaryNodeSource, IcApiBoundaryNodeSourceData,
22    IcApiBoundaryNodeSourceRequest, LiveIcStateSource, build_ic_api_boundary_node_report,
23    build_ic_api_boundary_node_report_with_source,
24};
25#[cfg(feature = "dashboard-host")]
26pub use build::{
27    build_ic_boundary_node_data_centers_report,
28    build_ic_boundary_node_data_centers_report_with_source, build_ic_canister_count_report,
29    build_ic_canister_count_report_with_source, build_ic_canister_page_report,
30    build_ic_canister_page_report_with_source, build_ic_daily_stats_report,
31    build_ic_daily_stats_report_with_source, build_ic_metric_report,
32    build_ic_metric_report_with_source, build_ic_node_provider_reward_history_report,
33    build_ic_node_provider_reward_history_report_with_source,
34    build_ic_node_provider_reward_info_report,
35    build_ic_node_provider_reward_info_report_with_source,
36    build_ic_node_provider_reward_list_report,
37    build_ic_node_provider_reward_list_report_with_source, build_ic_node_status_snapshot,
38    build_ic_node_status_snapshot_with_source, build_ic_replica_version_info_report,
39    build_ic_replica_version_info_report_with_source, build_ic_replica_version_list_report,
40    build_ic_replica_version_list_report_with_source, build_icrc_indexed_count_report,
41    build_icrc_indexed_count_report_with_source, build_icrc_token_value_report,
42    build_icrc_token_value_report_with_source, build_icrc_total_supply_report,
43    build_icrc_total_supply_report_with_source,
44};
45#[cfg(feature = "dashboard-host")]
46pub use build::{build_ic_canister_report, build_ic_canister_report_with_source};
47#[cfg(feature = "dashboard-host")]
48pub use live::LiveIcSource;
49pub use model::{
50    IcBoundaryNodeDataCenterRow, IcBoundaryNodeDataCentersReport, IcBoundaryNodeDataCentersRequest,
51    IcCanisterCountReport, IcCanisterCountRequest, IcCanisterFilters, IcCanisterPageController,
52    IcCanisterPageReport, IcCanisterPageRequest, IcCanisterPageRow, IcCanisterReport,
53    IcCanisterRequest, IcCanisterUpgrade, IcDailyStatsQuery, IcDailyStatsReport,
54    IcDailyStatsRequest, IcDailyStatsRow, IcDashboardReportProvenance, IcIcrcAnalyticsRequest,
55    IcIcrcIndexedCountKind, IcIcrcIndexedCountReport, IcIcrcIndexedCountRequest,
56    IcIcrcTokenValueQuery, IcIcrcTokenValueReport, IcIcrcTokenValueRequest, IcIcrcTokenValueRow,
57    IcIcrcTotalSupplyObservation, IcIcrcTotalSupplyQuery, IcIcrcTotalSupplyReport,
58    IcIcrcTotalSupplyRequest, IcMetricKind, IcMetricObservation, IcMetricQuery, IcMetricReport,
59    IcMetricRequest, IcMetricSeries, IcNodeProviderRewardHistoryObservation,
60    IcNodeProviderRewardHistoryQuery, IcNodeProviderRewardHistoryReport,
61    IcNodeProviderRewardHistoryRequest, IcNodeProviderRewardInfoReport,
62    IcNodeProviderRewardInfoRequest, IcNodeProviderRewardListQuery, IcNodeProviderRewardListReport,
63    IcNodeProviderRewardListRequest, IcNodeProviderRewardRow,
64    IcNodeProviderRewardXdrConversionRate, IcReplicaVersionInfoReport, IcReplicaVersionInfoRequest,
65    IcReplicaVersionListQuery, IcReplicaVersionListReport, IcReplicaVersionListRequest,
66    IcReplicaVersionListRow, IcReplicaVersionStatus, IcReplicaVersionSubnetRollout,
67};
68#[cfg(feature = "dashboard-host")]
69pub use model::{
70    IcBoundaryNodeDataCentersSourceData, IcCanisterCountSourceData, IcCanisterPageSourceData,
71    IcCanisterSourceData, IcDailyStatsSourceData, IcHostError, IcIcrcIndexedCountSourceData,
72    IcIcrcTokenValueSourceData, IcIcrcTokenValueSourceRow, IcIcrcTotalSupplySourceData,
73    IcMetricSourceData, IcNodeProviderRewardHistorySourceData, IcNodeProviderRewardInfoSourceData,
74    IcNodeProviderRewardListSourceData, IcReplicaVersionInfoSourceData,
75    IcReplicaVersionListSourceData, IcSourceRequest,
76};
77#[cfg(feature = "dashboard-host")]
78pub(crate) use node_status::canonicalize_node_status_rows_with_policy;
79#[cfg(feature = "dashboard-host")]
80pub(crate) use node_status::node_status_counts;
81pub use node_status::{
82    DEFAULT_IC_NODE_STATUS_REFRESH_LOCK_STALE_SECONDS, DEFAULT_IC_NODE_STATUS_STALE_AFTER_SECONDS,
83    IC_NODE_STATUS_SCHEMA_VERSION, IcNodeAssignmentStatusCounts, IcNodeCountComparison,
84    IcNodeCountComparisonCounts, IcNodeOperationalStatus, IcNodeProviderStatusReport,
85    IcNodeProviderStatusRow, IcNodeStatusCacheEvidence, IcNodeStatusCounts,
86    IcNodeStatusGroupCounts, IcNodeStatusObservation, IcNodeStatusProjectionError,
87    IcNodeStatusReport, IcNodeStatusRow, IcNodeStatusScope, IcNodeStatusSnapshot,
88    IcNodeStatusSnapshotRequest, IcNodeStatusView, IcSubnetStatusReport, IcSubnetStatusRow,
89    MAX_IC_NODE_STATUS_ROWS, ic_node_provider_status_report_from_snapshot,
90    ic_node_provider_status_report_text, ic_node_status_report_from_snapshot,
91    ic_node_status_report_text, ic_subnet_status_report_from_snapshot,
92    ic_subnet_status_report_text,
93};
94#[cfg(feature = "dashboard-host")]
95pub use node_status::{
96    IcNodeStatusCacheRequest, IcNodeStatusHostError, IcNodeStatusReadRequest,
97    IcNodeStatusRefreshReport, IcNodeStatusRefreshRequest, IcNodeStatusSourceData,
98    build_ic_node_provider_status_report, build_ic_node_provider_status_report_with_source,
99    build_ic_node_status_report, build_ic_node_status_report_with_source,
100    build_ic_subnet_status_report, build_ic_subnet_status_report_with_source,
101    ic_node_status_cache_path, ic_node_status_refresh_lock_path,
102    ic_node_status_refresh_report_text, load_cached_ic_node_status_snapshot,
103    load_or_refresh_missing_ic_node_status_snapshot,
104    load_or_refresh_missing_ic_node_status_snapshot_with_source,
105    load_or_refresh_stale_ic_node_status_snapshot,
106    load_or_refresh_stale_ic_node_status_snapshot_with_source, refresh_ic_node_status_snapshot,
107    refresh_ic_node_status_snapshot_with_source,
108};
109#[cfg(feature = "dashboard-host")]
110pub use source::{
111    IcCanisterCollectionSource, IcCanisterSource, IcIcrcAnalyticsSource, IcMetricSource,
112    IcNetworkSource, IcNodeProviderRewardSource, IcNodeStatusSource, IcReplicaVersionSource,
113};
114pub use text::{
115    ic_boundary_node_data_centers_report_text, ic_canister_count_report_text,
116    ic_canister_page_report_text, ic_canister_report_text, ic_daily_stats_report_text,
117    ic_metric_report_text, ic_node_provider_reward_history_report_text,
118    ic_node_provider_reward_info_report_text, ic_node_provider_reward_list_report_text,
119    ic_replica_version_info_report_text, ic_replica_version_list_report_text,
120    icrc_indexed_count_report_text, icrc_token_value_report_text, icrc_total_supply_report_text,
121};
122
123/// Default base endpoint for the official IC Dashboard API.
124pub const DEFAULT_IC_DASHBOARD_SOURCE_ENDPOINT: &str = "https://ic-api.internetcomputer.org/api/v3";
125
126/// Default base endpoint for official IC Dashboard canister collection queries.
127pub const DEFAULT_IC_DASHBOARD_CANISTER_COLLECTION_SOURCE_ENDPOINT: &str =
128    "https://ic-api.internetcomputer.org/api/v4";
129
130/// Default base endpoint for the official IC Dashboard Metrics API.
131pub const DEFAULT_IC_DASHBOARD_METRICS_SOURCE_ENDPOINT: &str =
132    "https://metrics-api.internetcomputer.org/api/v1";
133
134/// Default base endpoint for the official Dashboard ICRC analytics API.
135pub const DEFAULT_ICRC_ANALYTICS_SOURCE_ENDPOINT: &str =
136    "https://icrc-api.internetcomputer.org/api/v2";
137
138/// Default base endpoint for official boundary-node data-center queries.
139pub const DEFAULT_IC_BOUNDARY_NODE_DATA_CENTERS_SOURCE_ENDPOINT: &str =
140    "https://ic-api.internetcomputer.org/api/v4";
141
142/// Maximum response-body size accepted from an official Dashboard HTTP endpoint.
143pub const MAX_IC_DASHBOARD_RESPONSE_BYTES: u64 = 8 * 1024 * 1024;
144
145/// Default row limit for one official Dashboard canister page.
146pub const DEFAULT_IC_CANISTER_PAGE_LIMIT: u16 = 50;
147
148/// Maximum row limit accepted for one official Dashboard canister page.
149pub const MAX_IC_CANISTER_PAGE_LIMIT: u16 = 100;
150
151/// Default relative window for one Dashboard metric query.
152pub const DEFAULT_IC_METRIC_WINDOW_SECS: u64 = 3_600;
153
154/// Default interval between requested Dashboard metric observations.
155pub const DEFAULT_IC_METRIC_STEP_SECS: u32 = 300;
156
157/// Earliest timestamp accepted by the official Dashboard Metrics API.
158pub const MIN_IC_METRIC_TIMESTAMP: u64 = 1_620_432_000;
159
160/// Largest step accepted by the official Dashboard Metrics API.
161pub const MAX_IC_METRIC_STEP_SECS: u32 = 259_200;
162
163/// Maximum requested observations accepted per metric series.
164pub const MAX_IC_METRIC_OBSERVATIONS_PER_SERIES: u64 = 1_000;
165
166/// Default relative window for one ICRC total-supply analytics query.
167pub const DEFAULT_ICRC_TOTAL_SUPPLY_WINDOW_SECS: u64 = 30 * 24 * 60 * 60;
168
169/// Default interval between ICRC total-supply observations.
170pub const DEFAULT_ICRC_TOTAL_SUPPLY_STEP_SECS: u32 = 86_400;
171
172/// Earliest timestamp accepted by the official Dashboard ICRC analytics API.
173pub const MIN_ICRC_ANALYTICS_TIMESTAMP: u64 = 1_620_328_530;
174
175/// Maximum requested observations accepted for one ICRC analytics series.
176pub const MAX_ICRC_ANALYTICS_OBSERVATIONS: u64 = 1_000;
177
178/// Default relative window for one ICRC token-value analytics query.
179pub const DEFAULT_ICRC_TOKEN_VALUE_WINDOW_SECS: u64 = 24 * 60 * 60;
180
181/// Default row limit for one ICRC token-value analytics query.
182pub const DEFAULT_ICRC_TOKEN_VALUE_LIMIT: u16 = 1_000;
183
184/// Largest time window accepted for one ICRC token-value query.
185pub const MAX_ICRC_TOKEN_VALUE_WINDOW_SECS: u64 = 90 * 24 * 60 * 60;
186
187/// Maximum token-value rows requested or accepted by one report.
188pub const MAX_ICRC_TOKEN_VALUE_ROWS: u16 = 1_000;
189
190/// Default relative window for one Dashboard daily-statistics query.
191pub const DEFAULT_IC_DAILY_STATS_WINDOW_SECS: u64 = 7 * 24 * 60 * 60;
192
193/// Earliest timestamp accepted by the official Dashboard daily-statistics API.
194pub const MIN_IC_DAILY_STATS_TIMESTAMP: u64 = 1_620_406_800;
195
196/// Largest time window accepted by one daily-statistics request.
197pub const MAX_IC_DAILY_STATS_WINDOW_SECS: u64 = 366 * 24 * 60 * 60;
198
199/// Maximum daily-statistics rows accepted from one source response.
200pub const MAX_IC_DAILY_STATS_ROWS: usize = 366;
201
202/// Maximum boundary-node data-center rows accepted from one source response.
203pub const MAX_IC_BOUNDARY_NODE_DATA_CENTERS: usize = 1_000;
204
205/// Default row limit for one official Dashboard replica-version page.
206pub const DEFAULT_IC_REPLICA_VERSION_PAGE_LIMIT: u16 = 50;
207
208/// Maximum row limit accepted for one official Dashboard replica-version page.
209pub const MAX_IC_REPLICA_VERSION_PAGE_LIMIT: u16 = 100;
210
211/// Default row limit for one official Dashboard node-provider reward page.
212pub const DEFAULT_IC_NODE_PROVIDER_REWARD_PAGE_LIMIT: u16 = 50;
213
214/// Maximum row limit accepted for one official Dashboard node-provider reward page.
215pub const MAX_IC_NODE_PROVIDER_REWARD_PAGE_LIMIT: u16 = 100;
216
217/// Default relative window for one node-provider reward history query.
218pub const DEFAULT_IC_NODE_PROVIDER_REWARD_HISTORY_WINDOW_SECS: u64 = 365 * 24 * 60 * 60;
219
220/// Default interval between node-provider reward history observations.
221pub const DEFAULT_IC_NODE_PROVIDER_REWARD_HISTORY_STEP_SECS: u32 = 86_400;
222
223/// Smallest step accepted by the official node-provider reward history API.
224pub const MIN_IC_NODE_PROVIDER_REWARD_HISTORY_STEP_SECS: u32 = 60;
225
226/// Largest step accepted by the official node-provider reward history API.
227pub const MAX_IC_NODE_PROVIDER_REWARD_HISTORY_STEP_SECS: u32 = 259_200;
228
229/// Maximum requested observations accepted for one node-provider reward history report.
230pub const MAX_IC_NODE_PROVIDER_REWARD_HISTORY_OBSERVATIONS: u64 = 1_000;
231
232#[cfg(feature = "dashboard-host")]
233pub(crate) const IC_DASHBOARD_REPORT_SCHEMA_VERSION: u32 = 1;
234#[cfg(feature = "dashboard-host")]
235pub(crate) const IC_DASHBOARD_AUTHORITY: &str = "official_ic_dashboard_api";
236#[cfg(feature = "dashboard-host")]
237pub(crate) const IC_DASHBOARD_NETWORK: &str = "ic";
238
239#[cfg(all(test, feature = "dashboard-host"))]
240mod tests;
ic_query/ic/mod.rs

ic_query/ic/
mod.rs
