ic-query 0.87.0

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

//! Module: sns::report::model
//!
//! Responsibility: root SNS report model exports.
//! Does not own: command parsing, live source calls, cache IO, or text output.
//! Boundary: exposes report DTOs, request DTOs, errors, and selectors.

#[cfg(feature = "sns-host")]
mod errors;
mod identity;
pub(in crate::sns::report) mod reports;
mod requests;
mod sorts;

pub use identity::{MainnetSnsCanisters, SnsInstanceContext, SnsReportContext};

#[cfg(feature = "sns-host")]
pub use errors::SnsHostError;
pub use reports::{
    MainnetSnsCanisterInventory, SnsCanisterCallType, SnsCanisterCycleBalanceStatus,
    SnsCanisterGap, SnsCanisterGapKind, SnsCanisterHealthQueryGap, SnsCanisterMethod,
    SnsCanisterReport, SnsCanisterRole, SnsCanisterRow, SnsCanisterStatus,
    SnsCustomProposalCriticality, SnsDefaultFollowees, SnsDefaultFolloweesRow,
    SnsGovernanceParameters, SnsInfoReport, SnsLifecycleOutcome, SnsListReport, SnsListRow,
    SnsMaturityDisbursementRow, SnsMetricsReport, SnsNeuronAccount, SnsNeuronDetail,
    SnsNeuronDetailReport, SnsNeuronDissolveState, SnsNeuronFolloweeRow, SnsNeuronFolloweesRow,
    SnsNeuronPermissionList, SnsNeuronPermissionRow, SnsNeuronPermissionValue, SnsNeuronRow,
    SnsNeuronTopicFolloweesRow, SnsParamsReport, SnsPendingUpgrade, SnsPolicyObservationStatus,
    SnsProposalBallotRow, SnsProposalDecisionState, SnsProposalFailureReason, SnsProposalReport,
    SnsProposalRow, SnsProposalTally, SnsProposalsReport, SnsRewardAllocationStatus,
    SnsRewardCheckpointReport, SnsRewardCheckpointRow, SnsRewardCheckpointSummary,
    SnsRewardCheckpointValidationError, SnsRewardCollectionStatus, SnsRewardDiffCheckpointRef,
    SnsRewardDiffInvalidReason, SnsRewardDiffInvalidReasonKind, SnsRewardDiffNeuronEvidence,
    SnsRewardDiffReport, SnsRewardDiffRow, SnsRewardEvent, SnsRewardProposalId,
    SnsRunningVersionResponse, SnsSwapComponent, SnsSwapDerivedState, SnsSwapLifecycle,
    SnsSwapNeuronBasketConstructionParameters, SnsSwapQueryGap, SnsSwapReport,
    SnsSwapSaleParameters, SnsTokenReport, SnsTreasuryMetricRow, SnsUpgradeQueryGap,
    SnsUpgradeReport, SnsVersion, SnsVotingPowerMetrics, SnsVotingRewardsParameters,
    sns_neuron_permission_name, validate_sns_reward_checkpoint_report,
};
#[cfg(feature = "sns-host")]
pub use reports::{
    SnsCacheAdmission, SnsCacheListReport, SnsCacheStatusReport, SnsCacheSummary, SnsNeuronsReport,
    SnsRefreshAttemptStatus, SnsSnapshotRefreshReport, SnsValidCacheSummary,
};
pub use requests::{
    DEFAULT_SNS_METRICS_TIME_WINDOW_SECONDS, MAX_SNS_METRICS_TIME_WINDOW_SECONDS, SnsListRequest,
    SnsLookupError, SnsLookupRequest, SnsMetricsRequest, SnsProposalCollection, SnsProposalRequest,
    SnsProposalViewError, SnsProposalsRequest,
};
#[cfg(feature = "sns-host")]
pub use requests::{
    SnsCacheListRequest, SnsCacheStatusRequest, SnsNeuronCollection, SnsNeuronRequest,
    SnsNeuronsRequest, SnsRewardCheckpointRequest, SnsSnapshotRefreshRequest,
};
#[cfg(feature = "sns-host")]
pub(in crate::sns::report) use requests::{
    validate_sns_metrics_request, validate_sns_metrics_time_window,
};
#[cfg(feature = "sns-host")]
pub use sorts::SnsNeuronsCacheSort;
#[cfg(feature = "sns-host")]
pub(in crate::sns::report) use sorts::{
    SNS_PROPOSAL_STATUS_ADOPTED_CODE, SNS_PROPOSAL_STATUS_REJECTED_CODE,
};
#[cfg(all(test, feature = "sns-host"))]
pub(in crate::sns::report) use sorts::{
    SNS_PROPOSAL_STATUS_EXECUTED_CODE, SNS_PROPOSAL_STATUS_OPEN_CODE,
};
pub use sorts::{
    SnsListSort, SnsProposalEligibilityFilter, SnsProposalStatusFilter, SnsProposalTopicFilter,
    SnsProposalsSort,
};

pub use reports::MainnetSnsMetrics;

pub use reports::MainnetSnsSwap;

pub use reports::sns_proposal_action_label;