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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123

pub mod config;
pub mod descriptor;
#[cfg(feature = "dns_payment")]
pub mod dns;
pub mod key;
pub mod offline;
pub mod online;
#[cfg(any(
    feature = "electrum",
    feature = "esplora",
    feature = "cbf",
    feature = "rpc"
))]
pub mod payjoin;
pub mod repl;

#[cfg(any(
    feature = "electrum",
    feature = "esplora",
    feature = "rpc",
    feature = "cbf"
))]
use crate::client::BlockchainClient;
use std::path::PathBuf;

use crate::{error::BDKCliError as Error, utils::output::FormatOutput};
use bdk_wallet::{Wallet, bitcoin::Network};

// The state for no wallet, no client.
pub struct Init;

/// Offline wallet operations.
/// Requires only a wallet.
pub struct OfflineOperations<'a> {
    pub wallet: &'a mut Wallet,
}

#[cfg(any(
    feature = "electrum",
    feature = "esplora",
    feature = "rpc",
    feature = "cbf"
))]
/// Online wallet operations.
/// Requires a wallet and a client.
pub struct OnlineOperations<'a> {
    pub wallet: &'a mut Wallet,
    pub client: &'a BlockchainClient,
    pub wallet_name: String,
}

/// The generic context
pub struct AppContext<S> {
    pub network: Network,
    pub datadir: PathBuf,
    pub state: S,
}

/// Construct for a specific state.
impl AppContext<Init> {
    pub fn new(network: Network, datadir: PathBuf) -> Self {
        Self {
            network,
            datadir,
            state: Init,
        }
    }
}

impl<'a> AppContext<OfflineOperations<'a>> {
    pub fn new_offline_wallet(network: Network, datadir: PathBuf, wallet: &'a mut Wallet) -> Self {
        Self {
            network,
            datadir,
            state: OfflineOperations { wallet },
        }
    }
}

#[cfg(any(
    feature = "electrum",
    feature = "esplora",
    feature = "rpc",
    feature = "cbf"
))]
impl<'a> AppContext<OnlineOperations<'a>> {
    pub fn new_online_wallet(
        network: Network,
        datadir: PathBuf,
        wallet: &'a mut Wallet,
        client: &'a BlockchainClient,
        wallet_name: String,
    ) -> Self {
        Self {
            network,
            datadir,
            state: OnlineOperations {
                wallet,
                client,
                wallet_name,
            },
        }
    }
}

pub trait AppCommand<C> {
    type Output: FormatOutput;

    fn execute(&self, ctx: &mut C) -> Result<Self::Output, Error>;
}

#[cfg(any(
    feature = "electrum",
    feature = "esplora",
    feature = "rpc",
    feature = "cbf",
    feature = "dns_payment"
))]
pub trait AsyncAppCommand<C> {
    type Output: FormatOutput;

    async fn execute(&self, ctx: &mut C) -> Result<Self::Output, Error>;
}