ic-query-cli 0.22.2

Command-line wrapper for read-only Internet Computer metadata queries
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

//! NNS command-line parsing and dispatch.

#[macro_use]
mod macros;
mod data_center;
mod governance;
mod leaf;
mod neuron;
mod node;
mod node_operator;
mod node_provider;
mod proposals;
mod registry;
mod subnet;
#[cfg(test)]
mod tests;
mod topology;

#[cfg(test)]
use crate::cli::clap::render_help;
use crate::{
    cli::common::{CurrentUnixSecsError, OutputFormat, current_unix_secs, write_text_or_json},
    storage::cache_root,
};
use clap::{ArgMatches, Command as ClapCommand};
use ic_query::{
    nns::{
        data_center::NnsDataCenterHostError, governance::NnsGovernanceHostError,
        neuron::NnsNeuronHostError, node::NnsNodeHostError,
        node_operator::NnsNodeOperatorHostError, node_provider::NnsNodeProviderHostError,
        proposals::NnsProposalHostError, registry::NnsRegistryHostError,
        topology::NnsTopologyHostError,
    },
    subnet_catalog::SubnetCatalogHostError,
};
#[cfg(test)]
use std::ffi::OsString;
use std::{io, path::PathBuf};
use thiserror::Error as ThisError;

///
/// NnsCommandError
///
/// Errors surfaced while parsing or running an NNS command.
///

#[derive(Debug, ThisError)]
pub enum NnsCommandError {
    #[error("{0}")]
    Usage(String),
    #[error(transparent)]
    SubnetHost(#[from] SubnetCatalogHostError),
    #[error(transparent)]
    DataCenterHost(#[from] NnsDataCenterHostError),
    #[error(transparent)]
    GovernanceHost(#[from] NnsGovernanceHostError),
    #[error(transparent)]
    NodeHost(#[from] NnsNodeHostError),
    #[error(transparent)]
    NeuronHost(#[from] NnsNeuronHostError),
    #[error(transparent)]
    NodeProviderHost(#[from] NnsNodeProviderHostError),
    #[error(transparent)]
    NodeOperatorHost(#[from] NnsNodeOperatorHostError),
    #[error(transparent)]
    ProposalHost(#[from] NnsProposalHostError),
    #[error(transparent)]
    RegistryHost(#[from] NnsRegistryHostError),
    #[error(transparent)]
    TopologyHost(#[from] NnsTopologyHostError),
    #[error(transparent)]
    Clock(#[from] CurrentUnixSecsError),
    #[error(transparent)]
    Io(#[from] io::Error),
    #[error(transparent)]
    Json(#[from] serde_json::Error),
}

pub fn run_matches(matches: &ArgMatches, network: &str) -> Result<(), NnsCommandError> {
    match matches.subcommand() {
        Some(("subnet", matches)) => subnet::run(matches, network),
        Some(("data-center", matches)) => data_center::run(matches, network),
        Some(("governance", matches)) => governance::run(matches, network),
        Some(("node", matches)) => node::run(matches, network),
        Some(("neuron", matches)) => neuron::run(matches, network),
        Some(("node-provider", matches)) => node_provider::run(matches, network),
        Some(("node-operator", matches)) => node_operator::run(matches, network),
        Some(("proposal", matches)) => proposals::run(matches, network),
        Some(("registry", matches)) => registry::run(matches, network),
        Some(("topology", matches)) => topology::run(matches, network),
        _ => unreachable!("clap requires a known NNS subcommand"),
    }
}

#[cfg(test)]
pub(in crate::nns) fn parse_nns_matches<I>(
    command: ClapCommand,
    args: I,
) -> Result<ArgMatches, NnsCommandError>
where
    I: IntoIterator<Item = OsString>,
{
    crate::cli::clap::parse_matches_or_usage(command, args).map_err(NnsCommandError::Usage)
}

fn now_unix_secs() -> Result<u64, NnsCommandError> {
    Ok(current_unix_secs()?)
}
fn command_cache_root() -> Result<PathBuf, NnsCommandError> {
    cache_root().map_err(|err| NnsCommandError::Usage(err.to_string()))
}

pub fn command() -> ClapCommand {
    ClapCommand::new("nns")
        .bin_name("icq nns")
        .about("Inspect NNS metadata")
        .subcommand_required(true)
        .subcommand(subnet::command())
        .subcommand(data_center::command())
        .subcommand(governance::command())
        .subcommand(node::command())
        .subcommand(neuron::command())
        .subcommand(node_provider::command())
        .subcommand(node_operator::command())
        .subcommand(proposals::command())
        .subcommand(registry::command())
        .subcommand(topology::command())
}

#[cfg(test)]
fn usage() -> String {
    render_help(command())
}