cdk-cli 0.17.0

Cashu cli wallet built on CDK
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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
//! CDK CLI

use std::fs;
use std::path::PathBuf;
use std::str::FromStr;
use std::sync::Arc;

use anyhow::{bail, Result};
use bip39::rand::{thread_rng, Rng};
use bip39::Mnemonic;
use cdk::cdk_database;
use cdk::cdk_database::WalletDatabase;
use cdk::nuts::CurrencyUnit;
#[cfg(feature = "redb")]
use cdk_redb::WalletRedbDatabase;
use cdk_sqlite::WalletSqliteDatabase;
#[cfg(all(feature = "tor", not(target_arch = "wasm32")))]
use clap::ValueEnum;
use clap::{Parser, Subcommand};
use tracing::Level;
use tracing_subscriber::EnvFilter;
use url::Url;

mod nostr_storage;
mod sub_commands;
mod token_storage;
mod utils;

const DEFAULT_WORK_DIR: &str = ".cdk-cli";
const CARGO_PKG_VERSION: Option<&'static str> = option_env!("CARGO_PKG_VERSION");

/// Simple CLI application to interact with cashu
#[cfg(all(feature = "tor", not(target_arch = "wasm32")))]
#[derive(Copy, Clone, Debug, ValueEnum)]
enum TorToggle {
    On,
    Off,
}

#[derive(Parser)]
#[command(name = "cdk-cli", author = "thesimplekid <tsk@thesimplekid.com>", version = CARGO_PKG_VERSION.unwrap_or("Unknown"), about, long_about = None)]
struct Cli {
    /// Database engine to use (sqlite/redb)
    #[arg(short, long, default_value = "sqlite")]
    engine: String,
    /// Database password for sqlcipher
    #[cfg(feature = "sqlcipher")]
    #[arg(long)]
    password: Option<String>,
    /// Path to working dir
    #[arg(short, long)]
    work_dir: Option<PathBuf>,
    /// Logging level
    #[arg(short, long, default_value = "error")]
    log_level: Level,
    /// NWS Proxy
    #[arg(short, long)]
    proxy: Option<Url>,
    /// Disable TLS certificate verification for proxied HTTPS requests. This permits MITM.
    #[arg(long)]
    danger_accept_invalid_certs: bool,
    /// Currency unit to use for the wallet
    #[arg(short, long, global = true)]
    unit: Option<String>,
    /// Disable all interactive prompts; commands must provide required arguments.
    #[arg(short, long)]
    non_interactive: bool,
    /// NpubCash API URL
    #[cfg(feature = "npubcash")]
    #[arg(long, default_value = "https://npubx.cash")]
    npubcash_url: String,
    /// Use Tor transport (only when built with --features tor). Defaults to 'on' when feature is enabled.
    #[cfg(all(feature = "tor", not(target_arch = "wasm32")))]
    #[arg(long = "tor", value_enum, default_value_t = TorToggle::On)]
    transport: TorToggle,
    /// Subcommand to run
    #[command(subcommand)]
    command: Commands,
}

#[derive(Subcommand)]
enum Commands {
    /// Decode a token
    DecodeToken(sub_commands::decode_token::DecodeTokenSubCommand),
    /// Balance
    Balance,
    /// Pay bolt11 invoice
    Melt(sub_commands::melt::MeltSubCommand),
    /// Claim pending mint quotes that have been paid
    MintPending,
    /// Receive token
    Receive(sub_commands::receive::ReceiveSubCommand),
    /// Send
    Send(sub_commands::send::SendSubCommand),
    /// Transfer tokens between mints
    Transfer(sub_commands::transfer::TransferSubCommand),
    /// Reclaim pending proofs that are no longer pending
    CheckPending,
    /// Check incoming payments for stored payment requests.
    CheckRequests,
    /// View mint info
    MintInfo(sub_commands::mint_info::MintInfoSubcommand),
    /// Mint proofs via bolt11
    Mint(sub_commands::mint::MintSubCommand),
    /// Mint proofs for multiple existing quotes in one request
    MintBatch(sub_commands::mint_batch::MintBatchSubCommand),
    /// Burn Spent tokens
    Burn(sub_commands::burn::BurnSubCommand),
    /// Restore proofs from seed
    Restore(sub_commands::restore::RestoreSubCommand),
    /// Update Mint Url
    UpdateMintUrl(sub_commands::update_mint_url::UpdateMintUrlSubCommand),
    /// Get proofs from mint.
    ListMintProofs,
    /// Decode a payment request
    DecodeRequest(sub_commands::decode_request::DecodePaymentRequestSubCommand),
    /// Pay a payment request
    PayRequest(sub_commands::pay_request::PayRequestSubCommand),
    /// Resolve a BIP353 address and inspect available payment methods
    Resolve(sub_commands::resolve::ResolveSubCommand),
    /// Create Payment request
    CreateRequest(sub_commands::create_request::CreateRequestSubCommand),
    /// Mint blind auth proofs
    MintBlindAuth(sub_commands::mint_blind_auth::MintBlindAuthSubCommand),
    /// Cat login with username/password
    CatLogin(sub_commands::cat_login::CatLoginSubCommand),
    /// Cat login with device code flow
    CatDeviceLogin(sub_commands::cat_device_login::CatDeviceLoginSubCommand),
    /// NpubCash integration commands
    #[cfg(feature = "npubcash")]
    NpubCash {
        /// Mint URL to use for npubcash operations
        #[arg(short, long)]
        mint_url: String,
        #[command(subcommand)]
        command: sub_commands::npubcash::NpubCashSubCommand,
    },
    /// Generate a public key
    GeneratePublicKey(sub_commands::generate_public_key::GeneratePublicKeySubCommand),
    /// Get public keys
    GetPublicKeys(sub_commands::get_public_keys::GetPublicKeysSubCommand),
}

#[tokio::main]
async fn main() -> Result<()> {
    let args: Cli = Cli::parse();
    utils::set_non_interactive(args.non_interactive);
    let default_filter = args.log_level;

    let filter = "rustls=warn,hyper_util=warn,reqwest=warn";

    let env_filter = EnvFilter::new(format!("{default_filter},{filter}"));

    // Parse input
    tracing_subscriber::fmt()
        .with_env_filter(env_filter)
        .with_ansi(false)
        .init();

    let work_dir = match &args.work_dir {
        Some(work_dir) => work_dir.clone(),
        None => {
            let home_dir = home::home_dir()
                .ok_or_else(|| anyhow::anyhow!("Could not determine home directory"))?;
            home_dir.join(DEFAULT_WORK_DIR)
        }
    };

    // Create work directory if it doesn't exist
    if !work_dir.exists() {
        fs::create_dir_all(&work_dir)?;
    }

    let localstore: Arc<dyn WalletDatabase<cdk_database::Error> + Send + Sync> =
        match args.engine.as_str() {
            "sqlite" => {
                let sql_path = work_dir.join("cdk-cli.sqlite");
                #[cfg(not(feature = "sqlcipher"))]
                let sql = WalletSqliteDatabase::new(&sql_path).await?;
                #[cfg(feature = "sqlcipher")]
                let sql = {
                    match args.password {
                        Some(pass) => WalletSqliteDatabase::new((sql_path, pass)).await?,
                        None => bail!("Missing database password"),
                    }
                };

                Arc::new(sql)
            }
            "redb" => {
                #[cfg(feature = "redb")]
                {
                    let redb_path = work_dir.join("cdk-cli.redb");
                    Arc::new(WalletRedbDatabase::new(&redb_path)?)
                }
                #[cfg(not(feature = "redb"))]
                {
                    bail!("redb feature not enabled");
                }
            }
            _ => bail!("Unknown DB engine"),
        };

    let seed_path = work_dir.join("seed");

    let mnemonic = match fs::metadata(seed_path.clone()) {
        Ok(_) => {
            let contents = fs::read_to_string(seed_path.clone())?;
            Mnemonic::from_str(&contents)?
        }
        Err(_e) => {
            let mut rng = thread_rng();
            let random_bytes: [u8; 32] = rng.gen();

            let mnemonic = Mnemonic::from_entropy(&random_bytes)?;
            tracing::info!("Creating new seed");

            fs::write(seed_path, mnemonic.to_string())?;

            mnemonic
        }
    };
    let seed = mnemonic.to_seed_normalized("");

    // Parse currency unit from args
    let currency_unit = match args.unit {
        Some(unit) => match unit.to_lowercase().as_str() {
            "" => bail!("Currency unit cannot be empty. Omit the flag to use the default 'sat'."),
            _ => Some(CurrencyUnit::from_str(&unit).unwrap_or(CurrencyUnit::Custom(unit))),
        },
        None => None,
    };
    let default_unit = currency_unit.clone().unwrap_or(CurrencyUnit::Sat);

    // Create WalletRepository using builder pattern
    let wallet_repository = {
        let mut builder = cdk::wallet::WalletRepositoryBuilder::new()
            .localstore(localstore.clone())
            .seed(seed);

        if let Some(proxy_url) = &args.proxy {
            builder = builder.proxy_url(proxy_url.clone());
            if args.danger_accept_invalid_certs {
                tracing::warn!(
                    "--danger-accept-invalid-certs disables TLS certificate verification"
                );
                builder = builder.danger_accept_invalid_certs(true);
            }
        }

        #[cfg(all(feature = "tor", not(target_arch = "wasm32")))]
        if matches!(args.transport, TorToggle::On) {
            builder = builder.tor();
        }

        builder.build().await?
    };

    let wallets = wallet_repository.get_wallets().await;

    for wallet in wallets {
        // Recover from incomplete operations (required after wallet creation)
        let recovery = wallet.recover_incomplete_sagas().await?;
        if !recovery.is_empty() {
            println!(
                "Recovered {} operations, {} compensated, {} skipped, {} failed",
                recovery.recovered, recovery.compensated, recovery.skipped, recovery.failed
            );
        }
    }

    match &args.command {
        Commands::DecodeToken(sub_command_args) => {
            sub_commands::decode_token::decode_token(sub_command_args)
        }
        Commands::Balance => {
            sub_commands::balance::balance(&wallet_repository, currency_unit.as_ref()).await
        }
        Commands::Melt(sub_command_args) => {
            sub_commands::melt::pay(&wallet_repository, sub_command_args, &default_unit).await
        }
        Commands::Receive(sub_command_args) => {
            sub_commands::receive::receive(
                &wallet_repository,
                sub_command_args,
                &work_dir,
                &default_unit,
            )
            .await
        }
        Commands::Send(sub_command_args) => {
            sub_commands::send::send(&wallet_repository, sub_command_args, &default_unit).await
        }
        Commands::Transfer(sub_command_args) => {
            sub_commands::transfer::transfer(&wallet_repository, sub_command_args, &default_unit)
                .await
        }
        Commands::CheckPending => {
            sub_commands::check_pending::check_pending(&wallet_repository).await
        }
        Commands::CheckRequests => {
            sub_commands::check_requests::check_requests(&wallet_repository).await
        }
        Commands::MintInfo(sub_command_args) => {
            sub_commands::mint_info::mint_info(
                args.proxy,
                args.danger_accept_invalid_certs,
                sub_command_args,
            )
            .await
        }
        Commands::Mint(sub_command_args) => {
            sub_commands::mint::mint(&wallet_repository, sub_command_args, &default_unit).await
        }
        Commands::MintBatch(sub_command_args) => {
            sub_commands::mint_batch::mint_batch(
                &wallet_repository,
                sub_command_args,
                &default_unit,
            )
            .await
        }
        Commands::MintPending => {
            sub_commands::pending_mints::mint_pending(&wallet_repository).await
        }
        Commands::Burn(sub_command_args) => {
            sub_commands::burn::burn(&wallet_repository, sub_command_args).await
        }
        Commands::Restore(sub_command_args) => {
            sub_commands::restore::restore(&wallet_repository, sub_command_args, &default_unit)
                .await
        }
        Commands::UpdateMintUrl(sub_command_args) => {
            sub_commands::update_mint_url::update_mint_url(
                &wallet_repository,
                sub_command_args,
                &default_unit,
            )
            .await
        }
        Commands::ListMintProofs => {
            sub_commands::list_mint_proofs::proofs(&wallet_repository).await
        }
        Commands::DecodeRequest(sub_command_args) => {
            sub_commands::decode_request::decode_payment_request(sub_command_args)
        }
        Commands::PayRequest(sub_command_args) => {
            sub_commands::pay_request::pay_request(&wallet_repository, sub_command_args).await
        }
        Commands::Resolve(sub_command_args) => {
            sub_commands::resolve::resolve(&wallet_repository, sub_command_args, &default_unit)
                .await
        }
        Commands::CreateRequest(sub_command_args) => {
            sub_commands::create_request::create_request(
                &wallet_repository,
                sub_command_args,
                &default_unit,
            )
            .await
        }
        Commands::MintBlindAuth(sub_command_args) => {
            sub_commands::mint_blind_auth::mint_blind_auth(
                &wallet_repository,
                sub_command_args,
                &work_dir,
                &default_unit,
            )
            .await
        }
        Commands::CatLogin(sub_command_args) => {
            sub_commands::cat_login::cat_login(&wallet_repository, sub_command_args, &work_dir)
                .await
        }
        Commands::CatDeviceLogin(sub_command_args) => {
            sub_commands::cat_device_login::cat_device_login(
                &wallet_repository,
                sub_command_args,
                &work_dir,
            )
            .await
        }
        #[cfg(feature = "npubcash")]
        Commands::NpubCash { mint_url, command } => {
            sub_commands::npubcash::npubcash(
                &wallet_repository,
                mint_url,
                command,
                Some(args.npubcash_url.clone()),
            )
            .await
        }
        Commands::GeneratePublicKey(sub_command_args) => {
            sub_commands::generate_public_key::generate_public_key(
                &wallet_repository,
                sub_command_args,
                &default_unit,
            )
            .await
        }
        Commands::GetPublicKeys(sub_command_args) => {
            sub_commands::get_public_keys::get_public_keys(
                &wallet_repository,
                sub_command_args,
                &default_unit,
            )
            .await
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn danger_accept_invalid_certs_defaults_to_false() {
        let cli = Cli::parse_from(["cdk-cli", "mint-info", "https://mint.example.com"]);

        assert!(!cli.danger_accept_invalid_certs);
    }

    #[test]
    fn parses_danger_accept_invalid_certs_flag() {
        let cli = Cli::parse_from([
            "cdk-cli",
            "--proxy",
            "http://127.0.0.1:8080",
            "--danger-accept-invalid-certs",
            "mint-info",
            "https://mint.example.com",
        ]);

        assert!(cli.danger_accept_invalid_certs);
        assert_eq!(
            cli.proxy.as_ref().map(url::Url::as_str),
            Some("http://127.0.0.1:8080/")
        );
    }
}