firma-cli 0.20.0

firma-cli is a command line interface tool to create bitcoin multisig wallets with private keys stored on offline devices.
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

use firma::log::debug;
use firma::online::{ConnectOptions, PathOptions, WalletNameOptions};
use firma::serde_json::Value;
use firma::*;
use std::convert::TryInto;
use structopt::StructOpt;
use FirmaOnlineSubcommands::*;

/// firma-online is an helper tool to use with bitcoin core, it allows to:
/// create a watch-only multisig wallet,
/// create a funded PSBT tx without signatures and
/// combine PSBT to create and broadcast a full tx
#[derive(StructOpt, Debug)]
#[structopt(name = "firma-online")]
struct FirmaOnlineCommands {
    #[structopt(flatten)]
    context: OnlineContext,

    #[structopt(subcommand)]
    subcommand: FirmaOnlineSubcommands,

    /// Flag to indicate usage of encryption/decryption when using CLI
    /// when true, reading from stdin is expected and blocking
    #[structopt(short, long)]
    encrypt: bool,
}

#[derive(StructOpt, Debug)]
enum FirmaOnlineSubcommands {
    /// Connect a bitcoin node
    Connect(ConnectOptions),

    /// Create a new watch-only wallet
    CreateWallet(firma::online::create_wallet::CreateWalletOptions),

    /// Rescan the blockchain, useful when importing an existing wallet
    Rescan(firma::online::rescan::RescanOptions),

    /// Get a new address for given wallet
    GetAddress(firma::online::get_address::GetAddressOptions),

    /// Create a new transaction as unsigned PSBT
    CreateTx(firma::online::create_tx::CreateTxOptions),

    /// Combine signed PSBT from offline signers and send the resulting tx
    SendTx(firma::online::send_tx::SendTxOptions),

    /// View wallet balance
    Balance(WalletNameOptions),

    /// View wallet coins
    ListCoins(WalletNameOptions),

    /// Import the file containing a firma json object
    Import(PathOptions),
}

fn main() -> Result<()> {
    let output = match start() {
        Ok(output) => output,
        Err(e) => e.to_json(),
    };

    println!("{}", serde_json::to_string_pretty(&output)?);
    Ok(())
}

fn start() -> Result<Value> {
    init_logger();
    debug!("firma-online start");
    let FirmaOnlineCommands {
        mut context,
        subcommand,
        encrypt,
    } = FirmaOnlineCommands::from_args();

    if encrypt {
        context.read_encryption_key()?;
    }

    debug!(
        "firma-online context:{:?} encrypt:{} subcommand:{:?}",
        context, encrypt, subcommand
    );

    match subcommand {
        Connect(opt) => {
            let _ = opt.daemon_opts.make_client(None, context.network)?;
            context.write_daemon_opts(opt.daemon_opts)?.try_into()
        }
        CreateWallet(opt) => context.create_wallet(&opt)?.try_into(),
        GetAddress(opt) => context.get_address(&opt)?.try_into(),
        CreateTx(opt) => context.create_tx(&opt)?.try_into(),
        SendTx(opt) => context.send_tx(&opt)?.try_into(),
        Balance(opt) => context.balance(&opt)?.try_into(),
        Rescan(opt) => Ok(context.rescan(&opt)?),
        ListCoins(opt) => context.list_coins(&opt)?.try_into(),
        Import(opt) => context.import(&opt),
    }
}