ic-query 0.1.15

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::data_center::report::{
    DEFAULT_NNS_DATA_CENTER_SOURCE_ENDPOINT, NnsDataCenterCacheRequest, NnsDataCenterHostError,
    NnsDataCenterInfoReport, NnsDataCenterInfoRequest, NnsDataCenterListReport,
    NnsDataCenterListRequest, NnsDataCenterRefreshReport, NnsDataCenterRefreshRequest,
    build_nns_data_center_info_report, build_nns_data_center_list_report,
    nns_data_center_info_report_text, nns_data_center_list_report_text,
    nns_data_center_list_report_verbose_text, nns_data_center_refresh_report_text,
    refresh_nns_data_center_report,
};
use std::ffi::OsString;

const DATA_CENTER_LIST_HELP_AFTER: &str = "\
Examples:
  icq nns data-center list
  icq nns data-center list --verbose
  icq --network ic nns data-center list --format json

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

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

const DATA_CENTER_SPEC: NnsLeafCommandSpec = NnsLeafCommandSpec {
    command_name: "data-center",
    bin_name: "icq nns data-center",
    about: "Inspect NNS data-center metadata",
    list_about: "List cached mainnet NNS data centers",
    info_about: "Show one cached mainnet NNS data center",
    refresh_about: "Force-refresh and cache NNS data-center metadata",
    list_help_after: DATA_CENTER_LIST_HELP_AFTER,
    info_help_after: DATA_CENTER_INFO_HELP_AFTER,
    refresh_help_after: DATA_CENTER_REFRESH_HELP_AFTER,
    input_value_name: "data-center|data-center-prefix",
    input_help: "Data-center id or unique data-center id prefix",
    list_source_help: "IC API endpoint used if the data-center cache is missing",
    info_source_help: "IC API endpoint used if the data-center cache is missing",
    refresh_source_help: "IC API endpoint used for native NNS registry queries",
    verbose_help: "Show GPS coordinates and registry metadata in text output",
    dry_run_help: "Fetch and validate without replacing the cached data-center report",
    output_help: "Also write the fetched data-center JSON to this path",
};

struct NnsDataCenterReports;

impl leaf::NnsLeafReports for NnsDataCenterReports {
    type Cache = NnsDataCenterCacheRequest;
    type ListRequest = NnsDataCenterListRequest;
    type InfoRequest = NnsDataCenterInfoRequest;
    type RefreshRequest = NnsDataCenterRefreshRequest;
    type ListReport = NnsDataCenterListReport;
    type InfoReport = NnsDataCenterInfoReport;
    type RefreshReport = NnsDataCenterRefreshReport;
    type HostError = NnsDataCenterHostError;

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

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

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

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

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

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

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

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

impl_cached_leaf_requests!(
    NnsDataCenterCacheRequest,
    NnsDataCenterListRequest,
    NnsDataCenterInfoRequest,
    NnsDataCenterRefreshRequest
);

impl_leaf_test_helpers!(
    data_center_list_options,
    data_center_info_options,
    data_center_refresh_options,
    data_center_usage,
    data_center_list_usage,
    data_center_info_usage,
    data_center_refresh_usage,
    DATA_CENTER_SPEC,
    DEFAULT_NNS_DATA_CENTER_SOURCE_ENDPOINT
);