ic-query 0.37.1

//! Certified IC state and official Dashboard report models, adapters, builders, and renderers.

mod api_boundary_node;
#[cfg(feature = "dashboard-host")]
mod build;
#[cfg(feature = "dashboard-host")]
mod live;
mod model;
mod node_status;
#[cfg(feature = "dashboard-host")]
mod source;
mod text;

pub use api_boundary_node::{
    DEFAULT_IC_STATE_SOURCE_ENDPOINT, IC_API_BOUNDARY_NODE_REPORT_SCHEMA_VERSION,
    IcApiBoundaryNodeReport, IcApiBoundaryNodeRequest, IcApiBoundaryNodeRow,
    IcCertifiedStateProvenance, MAX_IC_API_BOUNDARY_NODE_ROWS, ic_api_boundary_node_report_text,
};
#[cfg(feature = "ic-state-host")]
pub use api_boundary_node::{
    IcApiBoundaryNodeHostError, IcApiBoundaryNodeSource, IcApiBoundaryNodeSourceData,
    IcApiBoundaryNodeSourceRequest, LiveIcStateSource, build_ic_api_boundary_node_report,
    build_ic_api_boundary_node_report_with_source,
};
#[cfg(feature = "dashboard-host")]
pub use build::{
    build_ic_boundary_node_data_centers_report,
    build_ic_boundary_node_data_centers_report_with_source, build_ic_canister_count_report,
    build_ic_canister_count_report_with_source, build_ic_canister_page_report,
    build_ic_canister_page_report_with_source, build_ic_daily_stats_report,
    build_ic_daily_stats_report_with_source, build_ic_metric_report,
    build_ic_metric_report_with_source, build_ic_node_provider_reward_history_report,
    build_ic_node_provider_reward_history_report_with_source,
    build_ic_node_provider_reward_info_report,
    build_ic_node_provider_reward_info_report_with_source,
    build_ic_node_provider_reward_list_report,
    build_ic_node_provider_reward_list_report_with_source, build_ic_node_status_snapshot,
    build_ic_node_status_snapshot_with_source, build_ic_replica_version_info_report,
    build_ic_replica_version_info_report_with_source, build_ic_replica_version_list_report,
    build_ic_replica_version_list_report_with_source, build_icrc_account_info_report,
    build_icrc_account_info_report_with_source, build_icrc_account_list_report,
    build_icrc_account_list_report_with_source, build_icrc_holder_list_report,
    build_icrc_holder_list_report_with_source, build_icrc_indexed_count_report,
    build_icrc_indexed_count_report_with_source, build_icrc_token_value_report,
    build_icrc_token_value_report_with_source, build_icrc_total_supply_report,
    build_icrc_total_supply_report_with_source,
};
#[cfg(feature = "dashboard-host")]
pub use build::{build_ic_canister_report, build_ic_canister_report_with_source};
#[cfg(feature = "dashboard-host")]
pub use live::LiveIcSource;
pub use model::{
    IcBoundaryNodeDataCenterRow, IcBoundaryNodeDataCentersReport, IcBoundaryNodeDataCentersRequest,
    IcCanisterCountReport, IcCanisterCountRequest, IcCanisterFilters, IcCanisterPageController,
    IcCanisterPageReport, IcCanisterPageRequest, IcCanisterPageRow, IcCanisterReport,
    IcCanisterRequest, IcCanisterUpgrade, IcDailyStatsQuery, IcDailyStatsReport,
    IcDailyStatsRequest, IcDailyStatsRow, IcDashboardReportProvenance, IcIcrcAccountInfoReport,
    IcIcrcAccountInfoRequest, IcIcrcAccountListQuery, IcIcrcAccountListReport,
    IcIcrcAccountListRequest, IcIcrcAccountRow, IcIcrcAccountSort, IcIcrcAnalyticsRequest,
    IcIcrcHolderListQuery, IcIcrcHolderListReport, IcIcrcHolderListRequest, IcIcrcHolderRow,
    IcIcrcHolderSort, IcIcrcIndexedCountKind, IcIcrcIndexedCountReport, IcIcrcIndexedCountRequest,
    IcIcrcTokenValueQuery, IcIcrcTokenValueReport, IcIcrcTokenValueRequest, IcIcrcTokenValueRow,
    IcIcrcTotalSupplyObservation, IcIcrcTotalSupplyQuery, IcIcrcTotalSupplyReport,
    IcIcrcTotalSupplyRequest, IcMetricKind, IcMetricObservation, IcMetricQuery, IcMetricReport,
    IcMetricRequest, IcMetricSeries, IcNodeProviderRewardHistoryObservation,
    IcNodeProviderRewardHistoryQuery, IcNodeProviderRewardHistoryReport,
    IcNodeProviderRewardHistoryRequest, IcNodeProviderRewardInfoReport,
    IcNodeProviderRewardInfoRequest, IcNodeProviderRewardListQuery, IcNodeProviderRewardListReport,
    IcNodeProviderRewardListRequest, IcNodeProviderRewardRow,
    IcNodeProviderRewardXdrConversionRate, IcReplicaVersionInfoReport, IcReplicaVersionInfoRequest,
    IcReplicaVersionListQuery, IcReplicaVersionListReport, IcReplicaVersionListRequest,
    IcReplicaVersionListRow, IcReplicaVersionStatus, IcReplicaVersionSubnetRollout,
};
#[cfg(feature = "dashboard-host")]
pub use model::{
    IcBoundaryNodeDataCentersSourceData, IcCanisterCountSourceData, IcCanisterPageSourceData,
    IcCanisterSourceData, IcDailyStatsSourceData, IcHostError, IcIcrcAccountInfoSourceData,
    IcIcrcAccountListSourceData, IcIcrcAccountSourceRow, IcIcrcHolderListSourceData,
    IcIcrcHolderSourceRow, IcIcrcIndexedCountSourceData, IcIcrcTokenValueSourceData,
    IcIcrcTokenValueSourceRow, IcIcrcTotalSupplySourceData, IcMetricSourceData,
    IcNodeProviderRewardHistorySourceData, IcNodeProviderRewardInfoSourceData,
    IcNodeProviderRewardListSourceData, IcReplicaVersionInfoSourceData,
    IcReplicaVersionListSourceData, IcSourceRequest,
};
#[cfg(feature = "dashboard-host")]
pub(crate) use node_status::canonicalize_node_status_rows_with_policy;
#[cfg(feature = "dashboard-host")]
pub(crate) use node_status::node_status_counts;
pub use node_status::{
    DEFAULT_IC_NODE_STATUS_REFRESH_LOCK_STALE_SECONDS, DEFAULT_IC_NODE_STATUS_STALE_AFTER_SECONDS,
    IC_NODE_STATUS_SCHEMA_VERSION, IcNodeAssignmentStatusCounts, IcNodeCountComparison,
    IcNodeCountComparisonCounts, IcNodeOperationalStatus, IcNodeProviderStatusReport,
    IcNodeProviderStatusRow, IcNodeStatusCacheEvidence, IcNodeStatusCounts,
    IcNodeStatusGroupCounts, IcNodeStatusObservation, IcNodeStatusProjectionError,
    IcNodeStatusReport, IcNodeStatusRow, IcNodeStatusScope, IcNodeStatusSnapshot,
    IcNodeStatusSnapshotRequest, IcNodeStatusView, IcSubnetStatusReport, IcSubnetStatusRow,
    MAX_IC_NODE_STATUS_ROWS, ic_node_provider_status_report_from_snapshot,
    ic_node_provider_status_report_text, ic_node_status_report_from_snapshot,
    ic_node_status_report_text, ic_subnet_status_report_from_snapshot,
    ic_subnet_status_report_text,
};
#[cfg(feature = "dashboard-host")]
pub use node_status::{
    IcNodeStatusCacheRequest, IcNodeStatusHostError, IcNodeStatusReadRequest,
    IcNodeStatusRefreshReport, IcNodeStatusRefreshRequest, IcNodeStatusSourceData,
    build_ic_node_provider_status_report, build_ic_node_provider_status_report_with_source,
    build_ic_node_status_report, build_ic_node_status_report_with_source,
    build_ic_subnet_status_report, build_ic_subnet_status_report_with_source,
    ic_node_status_cache_path, ic_node_status_refresh_lock_path,
    ic_node_status_refresh_report_text, load_cached_ic_node_status_snapshot,
    load_or_refresh_missing_ic_node_status_snapshot,
    load_or_refresh_missing_ic_node_status_snapshot_with_source,
    load_or_refresh_stale_ic_node_status_snapshot,
    load_or_refresh_stale_ic_node_status_snapshot_with_source, refresh_ic_node_status_snapshot,
    refresh_ic_node_status_snapshot_with_source,
};
#[cfg(feature = "dashboard-host")]
pub use source::{
    IcCanisterCollectionSource, IcCanisterSource, IcIcrcAnalyticsSource, IcIcrcIndexSource,
    IcMetricSource, IcNetworkSource, IcNodeProviderRewardSource, IcNodeStatusSource,
    IcReplicaVersionSource,
};
#[cfg(feature = "dashboard-host")]
pub(crate) use source::{
    canonical_request_principal, dashboard_source_request, invalid_source, invalid_source_value,
    report_provenance, validate_canonical_principal, validate_dashboard_network,
    validate_provenance,
};
pub(crate) use text::dashboard_provenance_lines;
pub use text::{
    ic_boundary_node_data_centers_report_text, ic_canister_count_report_text,
    ic_canister_page_report_text, ic_canister_report_text, ic_daily_stats_report_text,
    ic_metric_report_text, ic_node_provider_reward_history_report_text,
    ic_node_provider_reward_info_report_text, ic_node_provider_reward_list_report_text,
    ic_replica_version_info_report_text, ic_replica_version_list_report_text,
    icrc_account_info_report_text, icrc_account_list_report_text, icrc_holder_list_report_text,
    icrc_indexed_count_report_text, icrc_token_value_report_text, icrc_total_supply_report_text,
};

/// Default base endpoint for the official IC Dashboard API.
pub const DEFAULT_IC_DASHBOARD_SOURCE_ENDPOINT: &str = "https://ic-api.internetcomputer.org/api/v3";

/// Default base endpoint for official IC Dashboard canister collection queries.
pub const DEFAULT_IC_DASHBOARD_CANISTER_COLLECTION_SOURCE_ENDPOINT: &str =
    "https://ic-api.internetcomputer.org/api/v4";

/// Default base endpoint for the official IC Dashboard Metrics API.
pub const DEFAULT_IC_DASHBOARD_METRICS_SOURCE_ENDPOINT: &str =
    "https://metrics-api.internetcomputer.org/api/v1";

/// Default base endpoint for the official Dashboard ICRC analytics API.
pub const DEFAULT_ICRC_ANALYTICS_SOURCE_ENDPOINT: &str =
    "https://icrc-api.internetcomputer.org/api/v2";

/// Default base endpoint for exact official Dashboard ICRC account queries.
pub const DEFAULT_ICRC_ACCOUNT_INFO_SOURCE_ENDPOINT: &str =
    "https://icrc-api.internetcomputer.org/api/v1";

/// Default base endpoint for official boundary-node data-center queries.
pub const DEFAULT_IC_BOUNDARY_NODE_DATA_CENTERS_SOURCE_ENDPOINT: &str =
    "https://ic-api.internetcomputer.org/api/v4";

/// Maximum response-body size accepted from an official Dashboard HTTP endpoint.
pub const MAX_IC_DASHBOARD_RESPONSE_BYTES: u64 = 8 * 1024 * 1024;

/// Default row limit for one official Dashboard canister page.
pub const DEFAULT_IC_CANISTER_PAGE_LIMIT: u16 = 50;

/// Maximum row limit accepted for one official Dashboard canister page.
pub const MAX_IC_CANISTER_PAGE_LIMIT: u16 = 100;

/// Default relative window for one Dashboard metric query.
pub const DEFAULT_IC_METRIC_WINDOW_SECS: u64 = 3_600;

/// Default interval between requested Dashboard metric observations.
pub const DEFAULT_IC_METRIC_STEP_SECS: u32 = 300;

/// Earliest timestamp accepted by the official Dashboard Metrics API.
pub const MIN_IC_METRIC_TIMESTAMP: u64 = 1_620_432_000;

/// Largest step accepted by the official Dashboard Metrics API.
pub const MAX_IC_METRIC_STEP_SECS: u32 = 259_200;

/// Maximum requested observations accepted per metric series.
pub const MAX_IC_METRIC_OBSERVATIONS_PER_SERIES: u64 = 1_000;

/// Default relative window for one ICRC total-supply analytics query.
pub const DEFAULT_ICRC_TOTAL_SUPPLY_WINDOW_SECS: u64 = 30 * 24 * 60 * 60;

/// Default interval between ICRC total-supply observations.
pub const DEFAULT_ICRC_TOTAL_SUPPLY_STEP_SECS: u32 = 86_400;

/// Earliest timestamp accepted by the official Dashboard ICRC analytics API.
pub const MIN_ICRC_ANALYTICS_TIMESTAMP: u64 = 1_620_328_530;

/// Maximum requested observations accepted for one ICRC analytics series.
pub const MAX_ICRC_ANALYTICS_OBSERVATIONS: u64 = 1_000;

/// Default relative window for one ICRC token-value analytics query.
pub const DEFAULT_ICRC_TOKEN_VALUE_WINDOW_SECS: u64 = 24 * 60 * 60;

/// Default row limit for one ICRC token-value analytics query.
pub const DEFAULT_ICRC_TOKEN_VALUE_LIMIT: u16 = 1_000;

/// Largest time window accepted for one ICRC token-value query.
pub const MAX_ICRC_TOKEN_VALUE_WINDOW_SECS: u64 = 90 * 24 * 60 * 60;

/// Maximum token-value rows requested or accepted by one report.
pub const MAX_ICRC_TOKEN_VALUE_ROWS: u16 = 1_000;

/// Maximum rows accepted for one official ICRC account or holder index page.
pub const MAX_ICRC_INDEX_PAGE_ROWS: u16 = 100;

/// Maximum characters accepted for an opaque official ICRC index cursor or account id.
pub const MAX_ICRC_INDEX_CURSOR_CHARS: usize = 512;

/// Default relative window for one Dashboard daily-statistics query.
pub const DEFAULT_IC_DAILY_STATS_WINDOW_SECS: u64 = 7 * 24 * 60 * 60;

/// Earliest timestamp accepted by the official Dashboard daily-statistics API.
pub const MIN_IC_DAILY_STATS_TIMESTAMP: u64 = 1_620_406_800;

/// Largest time window accepted by one daily-statistics request.
pub const MAX_IC_DAILY_STATS_WINDOW_SECS: u64 = 366 * 24 * 60 * 60;

/// Maximum daily-statistics rows accepted from one source response.
pub const MAX_IC_DAILY_STATS_ROWS: usize = 366;

/// Maximum boundary-node data-center rows accepted from one source response.
pub const MAX_IC_BOUNDARY_NODE_DATA_CENTERS: usize = 1_000;

/// Default row limit for one official Dashboard replica-version page.
pub const DEFAULT_IC_REPLICA_VERSION_PAGE_LIMIT: u16 = 50;

/// Maximum row limit accepted for one official Dashboard replica-version page.
pub const MAX_IC_REPLICA_VERSION_PAGE_LIMIT: u16 = 100;

/// Default row limit for one official Dashboard node-provider reward page.
pub const DEFAULT_IC_NODE_PROVIDER_REWARD_PAGE_LIMIT: u16 = 50;

/// Maximum row limit accepted for one official Dashboard node-provider reward page.
pub const MAX_IC_NODE_PROVIDER_REWARD_PAGE_LIMIT: u16 = 100;

/// Default relative window for one node-provider reward history query.
pub const DEFAULT_IC_NODE_PROVIDER_REWARD_HISTORY_WINDOW_SECS: u64 = 365 * 24 * 60 * 60;

/// Default interval between node-provider reward history observations.
pub const DEFAULT_IC_NODE_PROVIDER_REWARD_HISTORY_STEP_SECS: u32 = 86_400;

/// Smallest step accepted by the official node-provider reward history API.
pub const MIN_IC_NODE_PROVIDER_REWARD_HISTORY_STEP_SECS: u32 = 60;

/// Largest step accepted by the official node-provider reward history API.
pub const MAX_IC_NODE_PROVIDER_REWARD_HISTORY_STEP_SECS: u32 = 259_200;

/// Maximum requested observations accepted for one node-provider reward history report.
pub const MAX_IC_NODE_PROVIDER_REWARD_HISTORY_OBSERVATIONS: u64 = 1_000;

#[cfg(feature = "dashboard-host")]
pub(crate) const IC_DASHBOARD_REPORT_SCHEMA_VERSION: u32 = 1;
#[cfg(feature = "dashboard-host")]
pub(crate) const IC_DASHBOARD_AUTHORITY: &str = "official_ic_dashboard_api";
#[cfg(feature = "dashboard-host")]
pub(crate) const IC_DASHBOARD_NETWORK: &str = "ic";

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