ic-query 0.40.1

Internet Computer query library for CloudEngine, NNS, SNS, ICRC, system canisters, and public network metadata
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83

//! Module: nns::neuron::report
//!
//! Responsibility: build direct NNS Governance neuron reports.
//! Does not own: Dashboard analytics, authenticated neuron management, or process output.
//! Boundary: preserves the public `NeuronInfo` view and its Governance provenance.

#[cfg(feature = "nns-host")]
mod cache;
mod classification;
mod collection;
mod distribution;
mod error;
mod model;
mod source;
mod text;
#[cfg(any(
    feature = "nns-host",
    all(feature = "canister", target_arch = "wasm32"),
    test
))]
mod wire;

#[cfg(feature = "nns-host")]
pub use cache::{
    DEFAULT_NNS_NEURON_REFRESH_LOCK_STALE_SECONDS, NnsNeuronCacheStatusReport,
    NnsNeuronCacheSummary, NnsNeuronRefreshReport, build_nns_neuron_cache_status_report,
    build_nns_neuron_info_report_from_cache, build_nns_neuron_list_report_from_cache,
    nns_neuron_cache_path, nns_neuron_refresh_attempt_path, nns_neuron_refresh_lock_path,
    refresh_nns_neuron_cache, refresh_nns_neuron_cache_with_progress,
    refresh_nns_neuron_cache_with_source,
};
pub use classification::{NnsNeuronState, NnsNeuronType, NnsNeuronVisibility, NnsNeuronVote};
#[cfg(feature = "nns-host")]
pub use collection::advance_nns_neuron_collection;
pub use collection::{
    NNS_NEURON_COLLECTION_STATE_SCHEMA_VERSION, NnsNeuronCollectionState,
    NnsNeuronCollectionStatus, NnsNeuronCollectionStep, advance_nns_neuron_collection_with_source,
};
pub use distribution::{
    NNS_NEURON_DISTRIBUTION_REPORT_SCHEMA_VERSION, NnsNeuronDistributionError,
    NnsNeuronDistributionReport, NnsNeuronDistributionValidationError, NnsNeuronStateDistribution,
    NnsNeuronTypeDistribution, NnsNeuronVisibilityDistribution,
    build_nns_neuron_distribution_report, validate_nns_neuron_distribution_report,
};
pub use error::NnsNeuronError;
#[cfg(feature = "nns-host")]
pub use error::NnsNeuronHostError;
pub use model::{
    NnsKnownNeuronData, NnsNeuronBallotRow, NnsNeuronInfoReport, NnsNeuronInfoRequest,
    NnsNeuronListReport, NnsNeuronListRequest, NnsNeuronRow,
};
pub use source::{
    NnsNeuronPage, NnsNeuronSource, NnsNeuronSourceFuture,
    build_nns_neuron_info_report_with_source, build_nns_neuron_list_report_with_source,
};
#[cfg(feature = "nns-host")]
pub use source::{build_nns_neuron_info_report, build_nns_neuron_list_report};
#[cfg(feature = "nns-host")]
pub use text::{nns_neuron_cache_status_report_text, nns_neuron_refresh_report_text};
pub use text::{
    nns_neuron_distribution_report_text, nns_neuron_info_report_text, nns_neuron_list_report_text,
};

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

/// Default replica endpoint used for direct NNS Governance neuron queries.
pub const DEFAULT_NNS_NEURON_SOURCE_ENDPOINT: &str = "https://icp-api.io";

/// Largest page size accepted by the public Governance neuron index.
pub const NNS_NEURON_MAX_PAGE_SIZE: u32 = 300;

const NNS_NEURON_INFO_REPORT_SCHEMA_VERSION: u32 = 1;
const NNS_NEURON_LIST_REPORT_SCHEMA_VERSION: u32 = 1;
#[cfg(feature = "nns-host")]
const NNS_NEURON_FETCHED_BY: &str = "ic-query";

#[cfg(feature = "nns-host")]
fn enforce_mainnet_network(network: &str) -> Result<(), NnsNeuronHostError> {
    crate::nns::governance::enforce_governance_mainnet_network(network)
        .map_err(NnsNeuronError::from)
        .map_err(NnsNeuronHostError::from)
}