ic-query-cli 0.17.1

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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149

//! Clap specifications for direct NNS Governance reports.

use crate::{
    cli::{
        clap::{passthrough_subcommand, render_help},
        common::{COLLECTION_MODE_LIVE, collection_help},
    },
    nns::leaf,
};
use clap::Command as ClapCommand;
use ic_query::nns::governance::DEFAULT_NNS_GOVERNANCE_SOURCE_ENDPOINT;

const GOVERNANCE_HELP_AFTER: &str = "\
Examples:
  icq nns governance economics
  icq nns governance metrics
  icq nns governance reward-event
  icq nns governance maturity-modulation";

const ECONOMICS_HELP_AFTER: &str = "\
Examples:
  icq nns governance economics
  icq nns governance economics --format json";

const METRICS_HELP_AFTER: &str = "\
Examples:
  icq nns governance metrics
  icq nns governance metrics --format json";

const REWARD_EVENT_HELP_AFTER: &str = "\
Examples:
  icq nns governance reward-event
  icq nns governance reward-event --format json";

const MATURITY_MODULATION_HELP_AFTER: &str = "\
Examples:
  icq nns governance maturity-modulation
  icq nns governance maturity-modulation --format json";

pub(super) fn governance_command() -> ClapCommand {
    ClapCommand::new("governance")
        .bin_name("icq nns governance")
        .about("Inspect NNS Governance economics, metrics, and rewards")
        .disable_help_flag(true)
        .subcommand(passthrough_subcommand(
            ClapCommand::new("economics").about("Show network economics parameters"),
        ))
        .subcommand(passthrough_subcommand(
            ClapCommand::new("metrics").about("Show cached Governance metrics"),
        ))
        .subcommand(passthrough_subcommand(
            ClapCommand::new("reward-event").about("Show the latest voting reward event"),
        ))
        .subcommand(passthrough_subcommand(
            ClapCommand::new("maturity-modulation").about("Show current maturity modulation"),
        ))
        .after_help(GOVERNANCE_HELP_AFTER)
}

pub(in crate::nns) fn governance_economics_command() -> ClapCommand {
    report_command(
        "economics",
        "Show NNS Governance network economics parameters",
        ECONOMICS_HELP_AFTER,
    )
}

pub(in crate::nns) fn governance_metrics_command() -> ClapCommand {
    report_command(
        "metrics",
        "Show cached NNS Governance metrics",
        METRICS_HELP_AFTER,
    )
}

pub(in crate::nns) fn governance_reward_event_command() -> ClapCommand {
    report_command(
        "reward-event",
        "Show the latest NNS Governance voting reward event",
        REWARD_EVENT_HELP_AFTER,
    )
}

pub(in crate::nns) fn governance_maturity_modulation_command() -> ClapCommand {
    report_command(
        "maturity-modulation",
        "Show current NNS Governance maturity modulation",
        MATURITY_MODULATION_HELP_AFTER,
    )
}

fn report_command(name: &'static str, about: &'static str, examples: &'static str) -> ClapCommand {
    ClapCommand::new(name)
        .bin_name(format!("icq nns governance {name}"))
        .about(about)
        .disable_help_flag(true)
        .arg(leaf::format_arg())
        .arg(
            leaf::source_endpoint_arg(DEFAULT_NNS_GOVERNANCE_SOURCE_ENDPOINT)
                .help("IC API endpoint used for the native NNS Governance query"),
        )
        .arg(leaf::network_arg())
        .after_help(collection_help(COLLECTION_MODE_LIVE, examples))
}

#[cfg(test)]
pub(in crate::nns) fn governance_usage() -> String {
    render_help(governance_command())
}

pub(super) fn governance_usage_for_error() -> String {
    render_help(governance_command())
}

#[cfg(test)]
pub(in crate::nns) fn governance_economics_usage() -> String {
    render_help(governance_economics_command())
}

pub(super) fn governance_economics_usage_for_error() -> String {
    render_help(governance_economics_command())
}

#[cfg(test)]
pub(in crate::nns) fn governance_metrics_usage() -> String {
    render_help(governance_metrics_command())
}

pub(super) fn governance_metrics_usage_for_error() -> String {
    render_help(governance_metrics_command())
}

#[cfg(test)]
pub(in crate::nns) fn governance_reward_event_usage() -> String {
    render_help(governance_reward_event_command())
}

pub(super) fn governance_reward_event_usage_for_error() -> String {
    render_help(governance_reward_event_command())
}

#[cfg(test)]
pub(in crate::nns) fn governance_maturity_modulation_usage() -> String {
    render_help(governance_maturity_modulation_command())
}

pub(super) fn governance_maturity_modulation_usage_for_error() -> String {
    render_help(governance_maturity_modulation_command())
}