near-cli-rs 0.26.2

human-friendly console utility that helps to interact with NEAR Protocol from command line.
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
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

use crate::js_command_match::constants::{
    DEFAULT_SEED_PHRASE_PATH, LEDGER_PATH_ALIASES, NETWORK_ID_ALIASES, SIGN_WITH_LEDGER_ALIASES,
};

#[derive(Debug, Clone, clap::Parser)]
pub struct SendArgs {
    pub sender: String,
    pub receiver: String,
    pub amount: String,
    #[arg(long, aliases = SIGN_WITH_LEDGER_ALIASES, default_value_t = false)]
    sign_with_ledger: bool,
    #[arg(long, aliases = LEDGER_PATH_ALIASES, default_value = DEFAULT_SEED_PHRASE_PATH)]
    ledger_path: String,
    #[arg(long, aliases = NETWORK_ID_ALIASES)]
    pub network_id: Option<String>,
}

impl SendArgs {
    pub fn to_cli_args(&self, network_config: String) -> Vec<String> {
        let network_id = self.network_id.clone().unwrap_or(network_config);

        let mut command = vec![
            "tokens".to_string(),
            self.sender.to_owned(),
            "send-near".to_string(),
            self.receiver.to_owned(),
            format!("{} NEAR", self.amount),
            "network-config".to_string(),
            network_id,
        ];

        if self.sign_with_ledger {
            command.push("sign-with-ledger".to_string());
            command.push("--seed-phrase-hd-path".to_string());
            command.push(self.ledger_path.to_owned());
        } else {
            command.push("sign-with-keychain".to_string());
        }

        command.push("send".to_string());
        command
    }
}

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

    #[test]
    fn send() {
        for (input, expected_output) in [
            (
                format!(
                    "near send bob.testnet alice.testnet 1 --{}",
                    SIGN_WITH_LEDGER_ALIASES[0]
                ),
                "tokens bob.testnet send-near alice.testnet '1 NEAR' network-config testnet sign-with-ledger --seed-phrase-hd-path '44'\\''/397'\\''/0'\\''/0'\\''/1'\\''' send",
            ),
            (
                format!(
                    "near send-near bob.testnet alice.testnet 1 --{}",
                    SIGN_WITH_LEDGER_ALIASES[0]
                ),
                "tokens bob.testnet send-near alice.testnet '1 NEAR' network-config testnet sign-with-ledger --seed-phrase-hd-path '44'\\''/397'\\''/0'\\''/0'\\''/1'\\''' send",
            ),
            (
                format!(
                    "near send-near bob.testnet alice.testnet 1 --{}",
                    SIGN_WITH_LEDGER_ALIASES[1]
                ),
                "tokens bob.testnet send-near alice.testnet '1 NEAR' network-config testnet sign-with-ledger --seed-phrase-hd-path '44'\\''/397'\\''/0'\\''/0'\\''/1'\\''' send",
            ),
            (
                format!(
                    "near send-near bob.testnet alice.testnet 1 --{}",
                    SIGN_WITH_LEDGER_ALIASES[2]
                ),
                "tokens bob.testnet send-near alice.testnet '1 NEAR' network-config testnet sign-with-ledger --seed-phrase-hd-path '44'\\''/397'\\''/0'\\''/0'\\''/1'\\''' send",
            ),
            (
                format!(
                    "near send-near bob.testnet alice.testnet 1 --{}",
                    SIGN_WITH_LEDGER_ALIASES[3]
                ),
                "tokens bob.testnet send-near alice.testnet '1 NEAR' network-config testnet sign-with-ledger --seed-phrase-hd-path '44'\\''/397'\\''/0'\\''/0'\\''/1'\\''' send",
            ),
            (
                format!(
                    "near send-near bob.testnet alice.testnet 1 --signWithLedger --{} \"44'/397'/0'/0'/2'\"",
                    LEDGER_PATH_ALIASES[0]
                ),
                "tokens bob.testnet send-near alice.testnet '1 NEAR' network-config testnet sign-with-ledger --seed-phrase-hd-path '44'\\''/397'\\''/0'\\''/0'\\''/2'\\''' send",
            ),
            (
                format!(
                    "near send-near bob.testnet alice.testnet 1 --signWithLedger --{} \"44'/397'/0'/0'/2'\"",
                    LEDGER_PATH_ALIASES[1]
                ),
                "tokens bob.testnet send-near alice.testnet '1 NEAR' network-config testnet sign-with-ledger --seed-phrase-hd-path '44'\\''/397'\\''/0'\\''/0'\\''/2'\\''' send",
            ),
            (
                format!(
                    "near send-near bob.testnet alice.testnet 1 --{} testnet",
                    NETWORK_ID_ALIASES[0]
                ),
                "tokens bob.testnet send-near alice.testnet '1 NEAR' network-config testnet sign-with-keychain send",
            ),
            (
                format!(
                    "near send-near bob.testnet alice.testnet 1 --{} mainnet",
                    NETWORK_ID_ALIASES[1]
                ),
                "tokens bob.testnet send-near alice.testnet '1 NEAR' network-config mainnet sign-with-keychain send",
            ),
        ] {
            let input_cmd =
                shell_words::split(&input).expect("Input command must be a valid shell command");
            let JsCmd::Send(send_args) = JsCmd::parse_from(&input_cmd) else {
                panic!("Send command was expected, but something else was parsed out from {input}");
            };
            assert_eq!(
                shell_words::join(SendArgs::to_cli_args(&send_args, "testnet".to_string())),
                expected_output
            );
        }
    }
}