Skip to main content

Module ic

Module ic 

Source
Expand description

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

Structs§

IcApiBoundaryNodeReport
IcApiBoundaryNodeReport
IcApiBoundaryNodeRequest
IcApiBoundaryNodeRequest
IcApiBoundaryNodeRow
IcApiBoundaryNodeRow
IcBoundaryNodeDataCenterRow
IcBoundaryNodeDataCenterRow
IcBoundaryNodeDataCentersReport
IcBoundaryNodeDataCentersReport
IcBoundaryNodeDataCentersRequest
IcBoundaryNodeDataCentersRequest
IcCanisterCountReport
IcCanisterCountReport
IcCanisterCountRequest
IcCanisterCountRequest
IcCanisterFilters
IcCanisterFilters
IcCanisterPageController
IcCanisterPageController
IcCanisterPageReport
IcCanisterPageReport
IcCanisterPageRequest
IcCanisterPageRequest
IcCanisterPageRow
IcCanisterPageRow
IcCanisterReport
IcCanisterReport
IcCanisterRequest
IcCanisterRequest
IcCanisterUpgrade
IcCanisterUpgrade
IcCertifiedStateProvenance
IcCertifiedStateProvenance
IcDailyStatsQuery
IcDailyStatsQuery
IcDailyStatsReport
IcDailyStatsReport
IcDailyStatsRequest
IcDailyStatsRequest
IcDailyStatsRow
IcDailyStatsRow
IcDashboardReportProvenance
IcDashboardReportProvenance
IcIcrcAccountInfoReport
IcIcrcAccountInfoReport
IcIcrcAccountInfoRequest
IcIcrcAccountInfoRequest
IcIcrcAccountListQuery
IcIcrcAccountListQuery
IcIcrcAccountListReport
IcIcrcAccountListReport
IcIcrcAccountListRequest
IcIcrcAccountListRequest
IcIcrcAccountRow
IcIcrcAccountRow
IcIcrcAnalyticsRequest
IcIcrcAnalyticsRequest
IcIcrcHolderListQuery
IcIcrcHolderListQuery
IcIcrcHolderListReport
IcIcrcHolderListReport
IcIcrcHolderListRequest
IcIcrcHolderListRequest
IcIcrcHolderRow
IcIcrcHolderRow
IcIcrcIndexedCountReport
IcIcrcIndexedCountReport
IcIcrcIndexedCountRequest
IcIcrcIndexedCountRequest
IcIcrcTokenValueQuery
IcIcrcTokenValueQuery
IcIcrcTokenValueReport
IcIcrcTokenValueReport
IcIcrcTokenValueRequest
IcIcrcTokenValueRequest
IcIcrcTokenValueRow
IcIcrcTokenValueRow
IcIcrcTotalSupplyObservation
IcIcrcTotalSupplyObservation
IcIcrcTotalSupplyQuery
IcIcrcTotalSupplyQuery
IcIcrcTotalSupplyReport
IcIcrcTotalSupplyReport
IcIcrcTotalSupplyRequest
IcIcrcTotalSupplyRequest
IcMetricObservation
IcMetricObservation
IcMetricQuery
IcMetricQuery
IcMetricReport
IcMetricReport
IcMetricRequest
IcMetricRequest
IcMetricSeries
IcMetricSeries
IcNodeAssignmentStatusCounts
IcNodeAssignmentStatusCounts
IcNodeCountComparisonCounts
IcNodeCountComparisonCounts
IcNodeProviderRewardHistoryObservation
IcNodeProviderRewardHistoryObservation
IcNodeProviderRewardHistoryQuery
IcNodeProviderRewardHistoryQuery
IcNodeProviderRewardHistoryReport
IcNodeProviderRewardHistoryReport
IcNodeProviderRewardHistoryRequest
IcNodeProviderRewardHistoryRequest
IcNodeProviderRewardInfoReport
IcNodeProviderRewardInfoReport
IcNodeProviderRewardInfoRequest
IcNodeProviderRewardInfoRequest
IcNodeProviderRewardListQuery
IcNodeProviderRewardListQuery
IcNodeProviderRewardListReport
IcNodeProviderRewardListReport
IcNodeProviderRewardListRequest
IcNodeProviderRewardListRequest
IcNodeProviderRewardRow
IcNodeProviderRewardRow
IcNodeProviderRewardXdrConversionRate
IcNodeProviderRewardXdrConversionRate
IcNodeProviderStatusReport
IcNodeProviderStatusReport
IcNodeProviderStatusRow
IcNodeProviderStatusRow
IcNodeStatusCacheEvidence
IcNodeStatusCacheEvidence
IcNodeStatusCounts
IcNodeStatusCounts
IcNodeStatusGroupCounts
IcNodeStatusGroupCounts
IcNodeStatusObservation
IcNodeStatusObservation
IcNodeStatusReport
IcNodeStatusReport
IcNodeStatusRow
IcNodeStatusRow
IcNodeStatusSnapshot
IcNodeStatusSnapshot
IcNodeStatusSnapshotRequest
IcNodeStatusSnapshotRequest
IcNodeStatusView
IcNodeStatusView
IcReplicaVersionInfoReport
IcReplicaVersionInfoReport
IcReplicaVersionInfoRequest
IcReplicaVersionInfoRequest
IcReplicaVersionListQuery
IcReplicaVersionListQuery
IcReplicaVersionListReport
IcReplicaVersionListReport
IcReplicaVersionListRequest
IcReplicaVersionListRequest
IcReplicaVersionListRow
IcReplicaVersionListRow
IcReplicaVersionSubnetRollout
IcReplicaVersionSubnetRollout
IcSubnetStatusReport
IcSubnetStatusReport
IcSubnetStatusRow
IcSubnetStatusRow

Enums§

IcIcrcAccountSort
IcIcrcAccountSort
IcIcrcHolderSort
IcIcrcHolderSort
IcIcrcIndexedCountKind
IcIcrcIndexedCountKind
IcMetricKind
IcMetricKind
IcNodeCountComparison
IcNodeCountComparison
IcNodeOperationalStatus
IcNodeOperationalStatus
IcNodeStatusProjectionError
IcNodeStatusProjectionError
IcNodeStatusScope
IcNodeStatusScope
IcReplicaVersionStatus
IcReplicaVersionStatus

Constants§

DEFAULT_ICRC_ACCOUNT_INFO_SOURCE_ENDPOINT
Default base endpoint for exact official Dashboard ICRC account queries.
DEFAULT_ICRC_ANALYTICS_SOURCE_ENDPOINT
Default base endpoint for the official Dashboard ICRC analytics API.
DEFAULT_ICRC_TOKEN_VALUE_LIMIT
Default row limit for one ICRC token-value analytics query.
DEFAULT_ICRC_TOKEN_VALUE_WINDOW_SECS
Default relative window for one ICRC token-value analytics query.
DEFAULT_ICRC_TOTAL_SUPPLY_STEP_SECS
Default interval between ICRC total-supply observations.
DEFAULT_ICRC_TOTAL_SUPPLY_WINDOW_SECS
Default relative window for one ICRC total-supply analytics query.
DEFAULT_IC_BOUNDARY_NODE_DATA_CENTERS_SOURCE_ENDPOINT
Default base endpoint for official boundary-node data-center queries.
DEFAULT_IC_CANISTER_PAGE_LIMIT
Default row limit for one official Dashboard canister page.
DEFAULT_IC_DAILY_STATS_WINDOW_SECS
Default relative window for one Dashboard daily-statistics query.
DEFAULT_IC_DASHBOARD_CANISTER_COLLECTION_SOURCE_ENDPOINT
Default base endpoint for official IC Dashboard canister collection queries.
DEFAULT_IC_DASHBOARD_METRICS_SOURCE_ENDPOINT
Default base endpoint for the official IC Dashboard Metrics API.
DEFAULT_IC_DASHBOARD_SOURCE_ENDPOINT
Default base endpoint for the official IC Dashboard API.
DEFAULT_IC_METRIC_STEP_SECS
Default interval between requested Dashboard metric observations.
DEFAULT_IC_METRIC_WINDOW_SECS
Default relative window for one Dashboard metric query.
DEFAULT_IC_NODE_PROVIDER_REWARD_HISTORY_STEP_SECS
Default interval between node-provider reward history observations.
DEFAULT_IC_NODE_PROVIDER_REWARD_HISTORY_WINDOW_SECS
Default relative window for one node-provider reward history query.
DEFAULT_IC_NODE_PROVIDER_REWARD_PAGE_LIMIT
Default row limit for one official Dashboard node-provider reward page.
DEFAULT_IC_NODE_STATUS_REFRESH_LOCK_STALE_SECONDS
Age after which an abandoned node-status refresh lock is stale.
DEFAULT_IC_NODE_STATUS_STALE_AFTER_SECONDS
Age after which an observed node-status cache refreshes automatically.
DEFAULT_IC_REPLICA_VERSION_PAGE_LIMIT
Default row limit for one official Dashboard replica-version page.
DEFAULT_IC_STATE_SOURCE_ENDPOINT
Default mainnet IC API endpoint for certified state-tree reports.
IC_API_BOUNDARY_NODE_REPORT_SCHEMA_VERSION
Current schema version for certified API boundary-node reports.
IC_NODE_STATUS_SCHEMA_VERSION
Current schema version for observed node-status reports and caches.
MAX_ICRC_ANALYTICS_OBSERVATIONS
Maximum requested observations accepted for one ICRC analytics series.
MAX_ICRC_INDEX_CURSOR_CHARS
Maximum characters accepted for an opaque official ICRC index cursor or account id.
MAX_ICRC_INDEX_PAGE_ROWS
Maximum rows accepted for one official ICRC account or holder index page.
MAX_ICRC_TOKEN_VALUE_ROWS
Maximum token-value rows requested or accepted by one report.
MAX_ICRC_TOKEN_VALUE_WINDOW_SECS
Largest time window accepted for one ICRC token-value query.
MAX_IC_API_BOUNDARY_NODE_ROWS
Maximum API boundary-node rows accepted from one certified state tree.
MAX_IC_BOUNDARY_NODE_DATA_CENTERS
Maximum boundary-node data-center rows accepted from one source response.
MAX_IC_CANISTER_PAGE_LIMIT
Maximum row limit accepted for one official Dashboard canister page.
MAX_IC_DAILY_STATS_ROWS
Maximum daily-statistics rows accepted from one source response.
MAX_IC_DAILY_STATS_WINDOW_SECS
Largest time window accepted by one daily-statistics request.
MAX_IC_DASHBOARD_RESPONSE_BYTES
Maximum response-body size accepted from an official Dashboard HTTP endpoint.
MAX_IC_METRIC_OBSERVATIONS_PER_SERIES
Maximum requested observations accepted per metric series.
MAX_IC_METRIC_STEP_SECS
Largest step accepted by the official Dashboard Metrics API.
MAX_IC_NODE_PROVIDER_REWARD_HISTORY_OBSERVATIONS
Maximum requested observations accepted for one node-provider reward history report.
MAX_IC_NODE_PROVIDER_REWARD_HISTORY_STEP_SECS
Largest step accepted by the official node-provider reward history API.
MAX_IC_NODE_PROVIDER_REWARD_PAGE_LIMIT
Maximum row limit accepted for one official Dashboard node-provider reward page.
MAX_IC_NODE_STATUS_ROWS
Maximum rows accepted from the finite Dashboard node resource.
MAX_IC_REPLICA_VERSION_PAGE_LIMIT
Maximum row limit accepted for one official Dashboard replica-version page.
MIN_ICRC_ANALYTICS_TIMESTAMP
Earliest timestamp accepted by the official Dashboard ICRC analytics API.
MIN_IC_DAILY_STATS_TIMESTAMP
Earliest timestamp accepted by the official Dashboard daily-statistics API.
MIN_IC_METRIC_TIMESTAMP
Earliest timestamp accepted by the official Dashboard Metrics API.
MIN_IC_NODE_PROVIDER_REWARD_HISTORY_STEP_SECS
Smallest step accepted by the official node-provider reward history API.

Functions§

ic_api_boundary_node_report_text
Render one complete certified API boundary-node report as human-facing text.
ic_boundary_node_data_centers_report_text
Render one official boundary-node data-center report as human-facing text.
ic_canister_count_report_text
Render one official Dashboard canister-count report as human-facing text.
ic_canister_page_report_text
Render one bounded official Dashboard canister page as human-facing text.
ic_canister_report_text
Render one official Dashboard canister report as human-facing text.
ic_daily_stats_report_text
Render one bounded official Dashboard daily-statistics report as human-facing text.
ic_metric_report_text
Render one bounded official Dashboard metric report as human-facing text.
ic_node_provider_reward_history_report_text
Render one bounded official Dashboard node-provider reward history as human-facing text.
ic_node_provider_reward_info_report_text
Render one exact official Dashboard node-provider reward report as human-facing text.
ic_node_provider_reward_list_report_text
Render one bounded official Dashboard node-provider reward page as human-facing text.
ic_node_provider_status_report_from_snapshot
Project a node-provider status report from one complete observed snapshot.
ic_node_provider_status_report_text
Render a human-readable node-provider operational status report.
ic_node_status_report_from_snapshot
Project a node-level status report from one complete observed snapshot.
ic_node_status_report_text
Render a human-readable node-level operational status report.
ic_replica_version_info_report_text
Render one exact official Dashboard replica-version report as human-facing text.
ic_replica_version_list_report_text
Render one bounded official Dashboard replica-version page as human-facing text.
ic_subnet_status_report_from_snapshot
Project a Subnet-level status report from one complete observed snapshot.
ic_subnet_status_report_text
Render a human-readable Subnet operational status report.
icrc_account_info_report_text
Render one exact official ICRC account record as human-facing text.
icrc_account_list_report_text
Render one bounded official ICRC account-index page as human-facing text.
icrc_holder_list_report_text
Render one bounded official ICRC holder-index page as human-facing text.
icrc_indexed_count_report_text
Render one official ICRC indexed-count report as human-facing text.
icrc_token_value_report_text
Render one bounded official ICRC token-value series as human-facing text.
icrc_total_supply_report_text
Render one bounded official ICRC total-supply series as human-facing text.