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

//! Runtime dispatch for direct NNS Governance reports.

use super::{
    commands::{
        governance_command, governance_economics_command, governance_economics_usage_for_error,
        governance_maturity_modulation_command, governance_maturity_modulation_usage_for_error,
        governance_metrics_command, governance_metrics_usage_for_error,
        governance_reward_event_command, governance_reward_event_usage_for_error,
        governance_usage_for_error,
    },
    options::NnsGovernanceOptions,
};
use crate::nns::{
    NnsCommandError, command_args, now_unix_secs, parse_nns_required_subcommand, write_text_or_json,
};
use clap::Command as ClapCommand;
use ic_query::nns::{
    NnsSourceRequest,
    governance::{
        NnsGovernanceHostError, build_nns_governance_economics_report,
        build_nns_governance_maturity_modulation_report, build_nns_governance_metrics_report,
        build_nns_governance_reward_event_report, nns_governance_economics_report_text,
        nns_governance_maturity_modulation_report_text, nns_governance_metrics_report_text,
        nns_governance_reward_event_report_text,
    },
};
use serde::Serialize;
use std::ffi::OsString;

pub(in crate::nns) fn run<I>(args: I) -> Result<(), NnsCommandError>
where
    I: IntoIterator<Item = OsString>,
{
    let Some(args) = command_args(args, governance_usage_for_error) else {
        return Ok(());
    };
    let (command, args) =
        parse_nns_required_subcommand(governance_command(), args, governance_usage_for_error)?;
    match command.as_str() {
        "economics" => run_report(
            args,
            governance_economics_command(),
            governance_economics_usage_for_error,
            build_nns_governance_economics_report,
            nns_governance_economics_report_text,
        ),
        "metrics" => run_report(
            args,
            governance_metrics_command(),
            governance_metrics_usage_for_error,
            build_nns_governance_metrics_report,
            nns_governance_metrics_report_text,
        ),
        "reward-event" => run_report(
            args,
            governance_reward_event_command(),
            governance_reward_event_usage_for_error,
            build_nns_governance_reward_event_report,
            nns_governance_reward_event_report_text,
        ),
        "maturity-modulation" => run_report(
            args,
            governance_maturity_modulation_command(),
            governance_maturity_modulation_usage_for_error,
            build_nns_governance_maturity_modulation_report,
            nns_governance_maturity_modulation_report_text,
        ),
        _ => unreachable!("nns governance dispatch only defines known commands"),
    }
}

fn run_report<I, Report>(
    args: I,
    command: ClapCommand,
    usage: fn() -> String,
    build: fn(&NnsSourceRequest) -> Result<Report, NnsGovernanceHostError>,
    render_text: fn(&Report) -> String,
) -> Result<(), NnsCommandError>
where
    I: IntoIterator<Item = OsString>,
    Report: Serialize,
{
    let Some(args) = command_args(args, usage) else {
        return Ok(());
    };
    let options = NnsGovernanceOptions::parse(args, command, usage)?;
    let request = NnsSourceRequest::from_unix_secs(
        options.network,
        options.source_endpoint,
        now_unix_secs()?,
        "ic-query",
    );
    let report = build(&request)?;
    write_text_or_json(options.format, &report, render_text)
}