ic-query-cli 0.22.3

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

//! Module: sns::commands::run::neurons
//!
//! Responsibility: run SNS neuron list, refresh, and cache subcommands.
//! Does not own: neuron cache mechanics, live governance calls, or rendering.
//! Boundary: chooses live versus cache-capable request setup from CLI options.

mod cache;
mod refresh;

use crate::{
    cli::common::write_text_or_json,
    sns::commands::{
        SnsCommandError,
        options::SnsNeuronsOptions,
        run::common::{command_cache_root, lookup_command_parts},
        spec::SnsNeuronsSortArg,
    },
};
use clap::ArgMatches;
use ic_query::sns::{
    SnsNeuronsRequest, SnsNeuronsSort, build_sns_neurons_report, sns_neurons_report_text,
};
use std::path::PathBuf;

pub(super) fn run_sns_neuron(matches: &ArgMatches, network: &str) -> Result<(), SnsCommandError> {
    match matches.subcommand() {
        Some(("list", matches)) => run_sns_neuron_list(matches, network),
        Some(("refresh", matches)) => refresh::run_sns_neuron_refresh(matches, network),
        Some(("cache", matches)) => cache::run_sns_neuron_cache(matches, network),
        _ => unreachable!("clap requires a known SNS neuron subcommand"),
    }
}

fn run_sns_neuron_list(matches: &ArgMatches, network: &str) -> Result<(), SnsCommandError> {
    let options = SnsNeuronsOptions::from_matches(matches, network)?;
    let parts = lookup_command_parts(options.lookup)?;
    let format = parts.format;
    let cache_root = cache_root_for_sort(options.sort)?;
    let request = SnsNeuronsRequest {
        network: parts.network,
        source_endpoint: parts.source_endpoint,
        now_unix_secs: parts.now_unix_secs,
        input: parts.input,
        limit: options.limit,
        owner_principal_id: options.owner_principal_id,
        sort: options.sort.into(),
        cache_root,
        verbose: options.verbose,
    };
    let report = build_sns_neurons_report(&request)?;
    write_text_or_json(format, &report, sns_neurons_report_text)
}

fn cache_root_for_sort(sort: SnsNeuronsSortArg) -> Result<Option<PathBuf>, SnsCommandError> {
    if SnsNeuronsSort::from(sort).uses_cache() {
        return Ok(Some(command_cache_root()?));
    }
    Ok(None)
}