miden-client-cli 0.14.5

The official command line client for interacting with the Miden network
Documentation 
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

use std::fs;

use miden_client::Client;
use miden_client::account::AccountId;
use miden_client::block::BlockNumber;
use miden_client::keystore::Keystore;
use miden_client::rpc::{GrpcClient, RpcStatusInfo};
use miden_client::store::NoteFilter;

use super::config::CliConfig;
use crate::commands::account::DEFAULT_ACCOUNT_ID_KEY;
use crate::errors::CliError;

pub async fn print_client_info<AUTH: Keystore + Sync + 'static>(
    client: &Client<AUTH>,
    show_rpc_status: bool,
) -> Result<(), CliError> {
    let config = CliConfig::load()?;

    println!("Client version: {}", env!("CARGO_PKG_VERSION"));

    if let Some(config_dir) = &config.config_dir {
        println!("Config directory: {config_dir}");
    }

    // Get and display local genesis commitment
    if let Ok(Some((genesis_header, _))) =
        client.get_block_header_by_num(BlockNumber::GENESIS).await
    {
        println!("Genesis commitment: {}", genesis_header.commitment().to_hex());
    }

    print_config_stats(&config)?;
    print_client_stats(client).await?;

    if show_rpc_status {
        print_rpc_status(&config).await?;
    }

    Ok(())
}

// HELPERS
// ================================================================================================
async fn print_client_stats<AUTH: Keystore + Sync + 'static>(
    client: &Client<AUTH>,
) -> Result<(), CliError> {
    println!("Block number: {}", client.get_sync_height().await?);
    println!("Tracked accounts: {}", client.get_account_headers().await?.len());
    println!("Expected notes: {}", client.get_input_notes(NoteFilter::Expected).await?.len());
    println!(
        "Default account: {}",
        client
            .get_setting(DEFAULT_ACCOUNT_ID_KEY.to_string())
            .await?
            .map_or("-".to_string(), AccountId::to_hex)
    );
    Ok(())
}

fn print_config_stats(config: &CliConfig) -> Result<(), CliError> {
    println!("Node address: {}", config.rpc.endpoint.0.host());
    let store_len = fs::metadata(config.store_filepath.clone())?.len();
    println!("Store size: {} kB", store_len / 1024);
    Ok(())
}

async fn print_rpc_status(config: &CliConfig) -> Result<(), CliError> {
    println!("\n--- RPC Node Status ---");
    let rpc_client = GrpcClient::new(&config.rpc.endpoint.clone().into(), config.rpc.timeout_ms);
    match rpc_client.get_status_unversioned().await {
        Ok(status) => {
            print_status_info(&status);
        },
        Err(e) => {
            println!("Failed to fetch RPC status: {e}");
        },
    }
    Ok(())
}

fn print_status_info(status: &RpcStatusInfo) {
    println!("Node version: {}", status.version);
    if let Some(genesis) = status.genesis_commitment {
        println!("Node genesis: {}", genesis.to_hex());
    }
    if let Some(ref store) = status.store {
        println!("Store: {} (chain tip: {})", store.status, store.chain_tip);
    }
    if let Some(ref bp) = status.block_producer {
        println!("Block producer: {} (chain tip: {})", bp.status, bp.chain_tip);
    }
}