md-cli 0.6.0

CLI for the Mnemonic Descriptor (MD) engravable BIP 388 wallet policy backup format
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
97
98
99
100
101
102
103
104
105

use crate::error::CliError;
use crate::parse::keys::{ParsedFingerprint, parse_fingerprint, parse_key};
use crate::parse::template::{ctx_for_template, parse_template};
use md_codec::chunk::reassemble;
use md_codec::decode::decode_md1_string;
use md_codec::encode::Descriptor;

pub struct AddressArgs<'a> {
    pub phrases: &'a [String],
    pub template: Option<&'a str>,
    pub keys: &'a [String],
    pub fingerprints: &'a [String],
    pub network: bitcoin::Network,
    pub network_str: &'static str,
    pub chain: u32,
    pub index: u32,
    pub count: u32,
    pub json: bool,
}

pub fn run(args: AddressArgs<'_>) -> Result<u8, CliError> {
    let descriptor = build_descriptor(&args)?;
    if !descriptor.is_wallet_policy() {
        return Err(CliError::BadArg(
            "address requires wallet-policy mode (Pubkeys TLV); supply --key @i=XPUB or use a wallet-policy-mode phrase".into(),
        ));
    }

    // Collect (chain, index, address) tuples first; then emit text or JSON.
    let mut rows: Vec<(u32, u32, String)> = Vec::with_capacity(args.count as usize);
    for k in 0..args.count {
        let i = args.index.checked_add(k).ok_or_else(|| {
            CliError::BadArg(format!(
                "--index + --count overflows u32: {} + {}",
                args.index, args.count
            ))
        })?;
        let addr = descriptor
            .derive_address(args.chain, i, args.network)?
            .assume_checked();
        rows.push((args.chain, i, addr.to_string()));
    }

    #[cfg(feature = "json")]
    if args.json {
        use crate::format::json::SCHEMA;
        let addresses: Vec<serde_json::Value> = rows
            .iter()
            .map(|(c, i, a)| serde_json::json!({ "chain": c, "index": i, "address": a }))
            .collect();
        let v = serde_json::json!({
            "schema": SCHEMA,
            "network": args.network_str,
            "addresses": addresses,
        });
        println!("{}", serde_json::to_string_pretty(&v).unwrap());
        return Ok(0);
    }
    let _ = args.json;
    let _ = args.network_str;

    for (_, _, addr) in &rows {
        println!("{addr}");
    }
    Ok(0)
}

fn build_descriptor(args: &AddressArgs<'_>) -> Result<Descriptor, CliError> {
    // Defense in depth — clap's ArgGroup::required(true) is the primary
    // guard; this catches the case where it ever fails (clap regression,
    // custom invocation bypassing the parser, etc.) and routes the user
    // to a clean exit-2 BadArg instead of a confusing exit-1 from
    // reassemble(&[]).
    if args.phrases.is_empty() && args.template.is_none() {
        return Err(CliError::BadArg(
            "address requires either positional <STRING>... or --template <T> --key @i=<XPUB>; clap should have caught this — please report a bug".into(),
        ));
    }
    if let Some(template) = args.template {
        if args.keys.is_empty() {
            return Err(CliError::BadArg(
                "--key @i=<XPUB> required when --template is supplied".into(),
            ));
        }
        let ctx = ctx_for_template(template);
        let parsed_keys = args
            .keys
            .iter()
            .map(|k| parse_key(k, ctx, args.network))
            .collect::<Result<Vec<_>, _>>()?;
        let parsed_fps: Vec<ParsedFingerprint> = args
            .fingerprints
            .iter()
            .map(|s| parse_fingerprint(s))
            .collect::<Result<Vec<_>, _>>()?;
        return parse_template(template, &parsed_keys, &parsed_fps);
    }
    // Phrase path
    if args.phrases.len() == 1 {
        Ok(decode_md1_string(&args.phrases[0])?)
    } else {
        let refs: Vec<&str> = args.phrases.iter().map(String::as_str).collect();
        Ok(reassemble(&refs)?)
    }
}