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

use clap::Args;
use color_eyre::eyre::eyre;
use indoc::{formatdoc, writedoc};
use scale_info::{Variant, form::PortableForm};
use subxt::metadata::{ArcMetadata, PalletMetadata};

use crate::utils::{Indent, fields_description, first_paragraph_of_docs};

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

pub fn explore_events(
    command: EventsSubcommand,
    pallet_metadata: PalletMetadata,
    metadata: ArcMetadata,
    output: &mut impl std::io::Write,
) -> color_eyre::Result<()> {
    let pallet_name = pallet_metadata.name();
    let event_variants = pallet_metadata.event_variants().unwrap_or(&[]);

    let usage = || {
        let events = events_to_string(event_variants, pallet_name);
        formatdoc! {"
        Usage:
            subxt explore pallet {pallet_name} events <EVENT>
                explore a specific event of this pallet
        
        {events}
        "}
    };

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

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

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

        "}?;
    }

    let fields: Vec<(Option<&str>, u32)> = event
        .fields
        .iter()
        .map(|f| (f.name.as_deref(), f.ty.id))
        .collect();
    let type_description = fields_description(&fields, &event.name, metadata.types()).indent(4);
    writedoc!(
        output,
        "
        The event has the following shape:
        {type_description}
        "
    )?;
    Ok(())
}

fn events_to_string(event_variants: &[Variant<PortableForm>], pallet_name: &str) -> String {
    if event_variants.is_empty() {
        return format!("No <EVENT>'s available in the \"{pallet_name}\" pallet.");
    }
    let mut output = format!("Available <EVENT>'s in the \"{pallet_name}\" pallet:");
    let mut strings: Vec<_> = event_variants.iter().map(|c| &c.name).collect();
    strings.sort();
    for event in strings {
        output.push_str("\n    ");
        output.push_str(event);
    }
    output
}