bdk-cli 4.0.0

An experimental CLI wallet application and playground, powered by BDK
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

// Copyright (c) 2020-2026 Bitcoin Dev Kit Developers
//
// This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
// or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
// You may not use this file except in accordance with one or both of these
// licenses.

//! bdk-cli Integration Test Framework
//!
//! This module provides the necessary helper methods for tests
//!
use assert_cmd::Command;
use std::path::PathBuf;

/// The bdk-cli command struct
#[allow(dead_code)]
#[derive(Debug)]
pub struct BdkCli {
    pub network: String,
    pub datadir: Option<PathBuf>,
    pub recv_desc: Option<String>,
    pub change_desc: Option<String>,
    pub server_url: Option<String>,
}

impl BdkCli {
    /// Construct a new test environment configuration
    pub fn new(network: &str, datadir: Option<PathBuf>) -> Self {
        Self {
            network: network.to_string(),
            datadir,
            recv_desc: None,
            change_desc: None,
            server_url: None,
        }
    }

    /// Creates the base assert_cmd::Command with the global flags pre-loaded
    pub fn build_base_cmd(&self) -> Command {
        let mut cmd = Command::cargo_bin("bdk-cli").expect("bdk-cli binary must compile");

        cmd.arg("--network").arg(&self.network);

        if let Some(dir) = &self.datadir {
            cmd.arg("--datadir").arg(dir);
        }

        if let Some(url) = &self.server_url {
            cmd.arg("--server").arg(url);
        }

        cmd
    }

    /// Returns a pre-configured Command builder for any top-level subcommand
    pub fn cmd(&self, subcommand: &str, args: &[&str]) -> Command {
        let mut cmd = self.build_base_cmd();
        cmd.arg(subcommand);
        cmd.args(args);
        cmd
    }

    /// Returns a pre-configured Command builder for `key` operations
    pub fn key_cmd(&self, args: &[&str]) -> Command {
        let mut cmd = self.build_base_cmd();
        cmd.arg("key");
        cmd.args(args);
        cmd
    }

    /// Returns a pre-configured Command builder for `wallet` operations
    #[allow(unused)]
    pub fn wallet_cmd(&self, args: &[&str]) -> Command {
        let mut cmd = self.build_base_cmd();
        cmd.arg("wallet");

        // Automatically inject descriptors if they are set in the helper state
        if let Some(recv) = &self.recv_desc {
            cmd.arg("--descriptor").arg(recv);
        }

        cmd.args(args);
        cmd
    }
}