subxt-cli 0.50.1

Command line utilities for working with subxt codegen
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

use clap::Args;
use color_eyre::eyre::eyre;
use indoc::{formatdoc, writedoc};
use scale_typegen_description::type_description;
use subxt::metadata::{ArcMetadata, PalletMetadata};

use crate::utils::{Indent, SyntaxHighlight, first_paragraph_of_docs, format_scale_value};

#[derive(Debug, Clone, Args)]
pub struct ConstantsSubcommand {
    constant: Option<String>,
}

pub fn explore_constants(
    command: ConstantsSubcommand,
    pallet_metadata: PalletMetadata,
    metadata: ArcMetadata,
    output: &mut impl std::io::Write,
) -> color_eyre::Result<()> {
    let pallet_name = pallet_metadata.name();

    let usage = || {
        let constants = constants_to_string(pallet_metadata, pallet_name);
        formatdoc! {"
        Usage:
            subxt explore pallet {pallet_name} constants <CONSTANT>
                explore a specific constant of this pallet

        {constants}
        "}
    };

    let Some(constant_name) = command.constant else {
        writeln!(output, "{}", usage())?;
        return Ok(());
    };

    // if specified constant is wrong, show user the constants to choose from (but this time as an error):
    let Some(constant) = pallet_metadata
        .constants()
        .find(|constant| constant.name().eq_ignore_ascii_case(&constant_name))
    else {
        let err = eyre!(
            "constant \"{constant_name}\" not found in \"{pallet_name}\" pallet!\n\n{}",
            usage()
        );
        return Err(err);
    };

    // docs
    let doc_string = first_paragraph_of_docs(constant.docs()).indent(4);
    if !doc_string.is_empty() {
        writedoc! {output, "
        Description:
        {doc_string}

        "}?;
    }

    // shape
    let type_description = type_description(constant.ty(), metadata.types(), true)
        .expect("No Type Description")
        .indent(4)
        .highlight();

    // value
    let value =
        scale_value::scale::decode_as_type(&mut constant.value(), constant.ty(), metadata.types())?;
    let value = format_scale_value(&value).indent(4);

    writedoc!(
        output,
        "
        The constant has the following shape:
        {type_description}

        The value of the constant is:
        {value}
        "
    )?;
    Ok(())
}

fn constants_to_string(pallet_metadata: PalletMetadata, pallet_name: &str) -> String {
    if pallet_metadata.constants().len() == 0 {
        return format!("No <CONSTANT>'s available in the \"{pallet_name}\" pallet.");
    }
    let mut output = format!("Available <CONSTANT>'s in the \"{pallet_name}\" pallet:");
    let mut strings: Vec<_> = pallet_metadata.constants().map(|c| c.name()).collect();
    strings.sort();
    for constant in strings {
        output.push_str("\n    ");
        output.push_str(constant);
    }
    output
}