mk-cli 0.4.1

Standalone CLI for mk1 (mnemonic-key) plate handling — encode, decode, inspect, verify, vectors, gui-schema.
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

//! `mk inspect` — decode + structural commentary.
//!
//! Realizes SPEC §3.5.3. v0.2 inspect output is intentionally less rich
//! than md-cli's: mk-codec's bytecode-layer surface isn't public yet
//! (see plan §3.7 — `bytecode` subcommand deferred to v0.3 alongside
//! the public-bytecode-API decision). Future enhancement opportunity.

use bitcoin::bip32::ChildNumber;
use clap::Args;
use mk_codec::KeyCard;
use serde_json::json;

use crate::cmd::{classify_code_variant, fmt_fingerprint, fmt_stub, read_mk1_strings};
use crate::error::{CliError, Result};

/// `mk inspect` arguments.
#[derive(Args, Debug)]
pub struct InspectArgs {
    /// One or more mk1 strings. Use `-` to read one string per line from stdin.
    pub mk1_strings: Vec<String>,

    /// Emit structured JSON on stdout instead of multi-line text.
    #[arg(long)]
    pub json: bool,
}

/// Run `mk inspect`.
pub fn run(args: InspectArgs) -> Result<u8> {
    let strings = read_mk1_strings(&args.mk1_strings)?;
    let refs: Vec<&str> = strings.iter().map(|s| s.as_str()).collect();
    let card = mk_codec::decode(&refs)?;

    let per_chunk_variants: Vec<&str> = strings.iter().map(|s| classify_code_variant(s)).collect();

    if args.json {
        emit_json(&card, &strings, &per_chunk_variants)?;
    } else {
        emit_text(&card, &strings, &per_chunk_variants);
    }
    Ok(0)
}

fn xpub_fingerprint_hex(card: &KeyCard) -> String {
    fmt_fingerprint(&card.xpub.fingerprint())
}

fn path_components_text(card: &KeyCard) -> Vec<String> {
    card.origin_path
        .into_iter()
        .map(|c| match c {
            ChildNumber::Hardened { index } => format!("{index}h (hardened)"),
            ChildNumber::Normal { index } => format!("{index} (normal)"),
        })
        .collect()
}

fn emit_text(card: &KeyCard, strings: &[String], variants: &[&str]) {
    println!("xpub:                {}", card.xpub);
    match &card.origin_fingerprint {
        Some(fp) => println!("origin_fingerprint:  {}", fmt_fingerprint(fp)),
        None => println!("origin_fingerprint:  (omitted, privacy-preserving mode)"),
    }
    println!("xpub_fingerprint:    {}", xpub_fingerprint_hex(card));
    println!("origin_path:         {}", card.origin_path);
    for (i, comp) in path_components_text(card).into_iter().enumerate() {
        println!("  component[{i}]:       {comp}");
    }
    let stubs: Vec<String> = card.policy_id_stubs.iter().map(fmt_stub).collect();
    println!("policy_id_stubs:     {}", stubs.join(", "));
    println!("chunks:              {}", strings.len());
    for (i, v) in variants.iter().enumerate() {
        println!("  chunk[{i}]:           {v} (BCH variant)");
    }
}

fn emit_json(card: &KeyCard, strings: &[String], variants: &[&str]) -> Result<()> {
    let stubs: Vec<String> = card.policy_id_stubs.iter().map(fmt_stub).collect();
    let path_components = path_components_text(card);
    let envelope = json!({
        "schema_version": 1,
        "xpub": card.xpub.to_string(),
        "xpub_fingerprint": xpub_fingerprint_hex(card),
        "origin_fingerprint": card.origin_fingerprint.as_ref().map(fmt_fingerprint),
        "origin_path": card.origin_path.to_string(),
        "origin_path_components": path_components,
        "policy_id_stubs": stubs,
        "chunks": strings.len(),
        "chunk_variants": variants,
    });
    let s = serde_json::to_string(&envelope)
        .map_err(|e| CliError::UsageError(format!("json serialization: {e}")))?;
    println!("{s}");
    Ok(())
}