casper-client 5.0.1

A client library and binary for interacting with the Casper 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
94

use std::str;

use async_trait::async_trait;
use clap::{Arg, ArgAction, ArgMatches, Command};

use casper_client::cli::CliError;

use crate::{
    command::ClientCommand,
    common::{self, transaction_hash},
    Success,
};

pub struct GetTransaction;

/// This struct defines the order in which the args are shown for this subcommand's help message.
enum DisplayOrder {
    Verbose,
    NodeAddress,
    RpcId,
    TransactionHash,
    FinalizedApprovals,
}

const ALIAS: &str = "get-txn";

/// Handles providing the arg for the retrieval of the finalized approvals.
mod finalized_approvals {
    use super::*;

    const ARG_NAME: &str = "get-finalized-approvals";
    const ARG_SHORT: char = 'a';
    const ARG_HELP: &str =
        "If passed, the returned transaction approvals are the ones finalized in the block.\
         Otherwise the approvals attached to the transaction when first received by the node \
         will be returned";

    pub(super) fn arg() -> Arg {
        Arg::new(ARG_NAME)
            .long(ARG_NAME)
            .short(ARG_SHORT)
            .required(false)
            .action(ArgAction::SetTrue)
            .help(ARG_HELP)
            .display_order(DisplayOrder::FinalizedApprovals as usize)
    }

    pub(super) fn get(matches: &ArgMatches) -> bool {
        matches
            .get_one::<bool>(ARG_NAME)
            .copied()
            .unwrap_or_default()
    }
}

#[async_trait]
impl ClientCommand for GetTransaction {
    const NAME: &'static str = "get-transaction";
    const ABOUT: &'static str = "Retrieve a transaction from the network";

    fn build(display_order: usize) -> Command {
        Command::new(Self::NAME)
            .alias(ALIAS)
            .about(Self::ABOUT)
            .display_order(display_order)
            .arg(common::verbose::arg(DisplayOrder::Verbose as usize))
            .arg(common::node_address::arg(
                DisplayOrder::NodeAddress as usize,
            ))
            .arg(common::rpc_id::arg(DisplayOrder::RpcId as usize))
            .arg(transaction_hash::arg(
                DisplayOrder::TransactionHash as usize,
            ))
            .arg(finalized_approvals::arg())
    }

    async fn run(matches: &ArgMatches) -> Result<Success, CliError> {
        let maybe_rpc_id = common::rpc_id::get(matches);
        let node_address = common::node_address::get(matches);
        let verbosity_level = common::verbose::get(matches);
        let transaction_hash = transaction_hash::get(matches);
        let finalized_approvals = finalized_approvals::get(matches);

        casper_client::cli::get_transaction(
            maybe_rpc_id,
            node_address,
            verbosity_level,
            transaction_hash,
            finalized_approvals,
        )
        .await
        .map(Success::from)
    }
}