ic-query 0.1.16

Internet Computer query CLI for NNS, SNS, and related 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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139

pub mod report;

use super::{
    NnsCommandError,
    leaf::{self, NnsLeafCommandSpec},
};
use crate::nns::node_operator::report::{
    DEFAULT_NNS_NODE_OPERATOR_SOURCE_ENDPOINT, NnsNodeOperatorCacheRequest,
    NnsNodeOperatorHostError, NnsNodeOperatorInfoReport, NnsNodeOperatorInfoRequest,
    NnsNodeOperatorListReport, NnsNodeOperatorListRequest, NnsNodeOperatorRefreshReport,
    NnsNodeOperatorRefreshRequest, build_nns_node_operator_info_report,
    build_nns_node_operator_list_report, nns_node_operator_info_report_text,
    nns_node_operator_list_report_text, nns_node_operator_list_report_verbose_text,
    nns_node_operator_refresh_report_text, refresh_nns_node_operator_report,
};
use std::ffi::OsString;

const NODE_OPERATOR_LIST_HELP_AFTER: &str = "\
Examples:
  icq nns node-operator list
  icq nns node-operator list --verbose
  icq --network ic nns node-operator list --format json

Force-refresh cached native NNS data:
  icq nns node-operator refresh";
const NODE_OPERATOR_INFO_HELP_AFTER: &str = "\
Examples:
  icq nns node-operator info <node-operator>
  icq nns node-operator info <node-operator-prefix>
  icq --network ic nns node-operator info <node-operator> --format json

Force-refresh cached native NNS data:
  icq nns node-operator refresh";
const NODE_OPERATOR_REFRESH_HELP_AFTER: &str = "\
Examples:
  icq nns node-operator refresh
  icq --network ic nns node-operator refresh --format json
  icq nns node-operator refresh --dry-run --output .icq/node-operator/ic/operators.preview.json";

const NODE_OPERATOR_SPEC: NnsLeafCommandSpec = NnsLeafCommandSpec {
    command_name: "node-operator",
    bin_name: "icq nns node-operator",
    about: "Inspect NNS node-operator metadata",
    list_about: "List cached mainnet NNS node operators",
    info_about: "Show one cached mainnet NNS node operator",
    refresh_about: "Force-refresh and cache NNS node-operator metadata",
    list_help_after: NODE_OPERATOR_LIST_HELP_AFTER,
    info_help_after: NODE_OPERATOR_INFO_HELP_AFTER,
    refresh_help_after: NODE_OPERATOR_REFRESH_HELP_AFTER,
    input_value_name: "node-operator|node-operator-prefix",
    input_help: "Node-operator principal or unique node-operator principal prefix",
    list_source_help: "IC API endpoint used if the node-operator cache is missing",
    info_source_help: "IC API endpoint used if the node-operator cache is missing",
    refresh_source_help: "IC API endpoint used for native NNS registry queries",
    verbose_help: "Show full node-operator principals and registry metadata in text output",
    dry_run_help: "Fetch and validate without replacing the cached node-operator report",
    output_help: "Also write the fetched node-operator JSON to this path",
};

struct NnsNodeOperatorReports;

impl leaf::NnsLeafReports for NnsNodeOperatorReports {
    type Cache = NnsNodeOperatorCacheRequest;
    type ListRequest = NnsNodeOperatorListRequest;
    type InfoRequest = NnsNodeOperatorInfoRequest;
    type RefreshRequest = NnsNodeOperatorRefreshRequest;
    type ListReport = NnsNodeOperatorListReport;
    type InfoReport = NnsNodeOperatorInfoReport;
    type RefreshReport = NnsNodeOperatorRefreshReport;
    type HostError = NnsNodeOperatorHostError;

    fn build_list_report(
        &self,
        request: &Self::ListRequest,
    ) -> Result<Self::ListReport, Self::HostError> {
        build_nns_node_operator_list_report(request)
    }

    fn build_info_report(
        &self,
        request: &Self::InfoRequest,
    ) -> Result<Self::InfoReport, Self::HostError> {
        build_nns_node_operator_info_report(request)
    }

    fn refresh_report(
        &self,
        request: &Self::RefreshRequest,
    ) -> Result<Self::RefreshReport, Self::HostError> {
        refresh_nns_node_operator_report(request)
    }

    fn list_report_text(&self, report: &Self::ListReport) -> String {
        nns_node_operator_list_report_text(report)
    }

    fn list_report_verbose_text(&self, report: &Self::ListReport) -> String {
        nns_node_operator_list_report_verbose_text(report)
    }

    fn info_report_text(&self, report: &Self::InfoReport) -> String {
        nns_node_operator_info_report_text(report)
    }

    fn refresh_report_text(&self, report: &Self::RefreshReport) -> String {
        nns_node_operator_refresh_report_text(report)
    }
}

pub(super) fn run<I>(args: I) -> Result<(), NnsCommandError>
where
    I: IntoIterator<Item = OsString>,
{
    leaf::run_cached_leaf(
        args,
        &NODE_OPERATOR_SPEC,
        DEFAULT_NNS_NODE_OPERATOR_SOURCE_ENDPOINT,
        NnsNodeOperatorReports,
    )
}

impl_cached_leaf_requests!(
    NnsNodeOperatorCacheRequest,
    NnsNodeOperatorListRequest,
    NnsNodeOperatorInfoRequest,
    NnsNodeOperatorRefreshRequest
);

impl_leaf_test_helpers!(
    node_operator_list_options,
    node_operator_info_options,
    node_operator_refresh_options,
    node_operator_usage,
    node_operator_list_usage,
    node_operator_info_usage,
    node_operator_refresh_usage,
    NODE_OPERATOR_SPEC,
    DEFAULT_NNS_NODE_OPERATOR_SOURCE_ENDPOINT
);