solana_clap_utils/
offline.rs

1use {
2    crate::{input_validators::*, ArgConstant},
3    clap::{App, Arg},
4};
5
6pub const BLOCKHASH_ARG: ArgConstant<'static> = ArgConstant {
7    name: "blockhash",
8    long: "blockhash",
9    help: "Use the supplied blockhash",
10};
11
12pub const SIGN_ONLY_ARG: ArgConstant<'static> = ArgConstant {
13    name: "sign_only",
14    long: "sign-only",
15    help: "Sign the transaction offline",
16};
17
18pub const SIGNER_ARG: ArgConstant<'static> = ArgConstant {
19    name: "signer",
20    long: "signer",
21    help: "Provide a public-key/signature pair for the transaction",
22};
23
24pub const DUMP_TRANSACTION_MESSAGE: ArgConstant<'static> = ArgConstant {
25    name: "dump_transaction_message",
26    long: "dump-transaction-message",
27    help: "Display the base64 encoded binary transaction message in sign-only mode",
28};
29
30pub fn blockhash_arg<'a, 'b>() -> Arg<'a, 'b> {
31    Arg::with_name(BLOCKHASH_ARG.name)
32        .long(BLOCKHASH_ARG.long)
33        .takes_value(true)
34        .value_name("BLOCKHASH")
35        .validator(is_hash)
36        .help(BLOCKHASH_ARG.help)
37}
38
39pub fn sign_only_arg<'a, 'b>() -> Arg<'a, 'b> {
40    Arg::with_name(SIGN_ONLY_ARG.name)
41        .long(SIGN_ONLY_ARG.long)
42        .takes_value(false)
43        .requires(BLOCKHASH_ARG.name)
44        .help(SIGN_ONLY_ARG.help)
45}
46
47fn signer_arg<'a, 'b>() -> Arg<'a, 'b> {
48    Arg::with_name(SIGNER_ARG.name)
49        .long(SIGNER_ARG.long)
50        .takes_value(true)
51        .value_name("PUBKEY=SIGNATURE")
52        .validator(is_pubkey_sig)
53        .requires(BLOCKHASH_ARG.name)
54        .multiple(true)
55        .number_of_values(1)
56        .help(SIGNER_ARG.help)
57}
58
59pub fn dump_transaction_message<'a, 'b>() -> Arg<'a, 'b> {
60    Arg::with_name(DUMP_TRANSACTION_MESSAGE.name)
61        .long(DUMP_TRANSACTION_MESSAGE.long)
62        .takes_value(false)
63        .requires(SIGN_ONLY_ARG.name)
64        .help(DUMP_TRANSACTION_MESSAGE.help)
65}
66
67pub trait ArgsConfig {
68    fn blockhash_arg<'a, 'b>(&self, arg: Arg<'a, 'b>) -> Arg<'a, 'b> {
69        arg
70    }
71    fn sign_only_arg<'a, 'b>(&self, arg: Arg<'a, 'b>) -> Arg<'a, 'b> {
72        arg
73    }
74    fn signer_arg<'a, 'b>(&self, arg: Arg<'a, 'b>) -> Arg<'a, 'b> {
75        arg
76    }
77    fn dump_transaction_message_arg<'a, 'b>(&self, arg: Arg<'a, 'b>) -> Arg<'a, 'b> {
78        arg
79    }
80}
81
82pub trait OfflineArgs {
83    fn offline_args(self) -> Self;
84    fn offline_args_config(self, config: &dyn ArgsConfig) -> Self;
85}
86
87impl OfflineArgs for App<'_, '_> {
88    fn offline_args_config(self, config: &dyn ArgsConfig) -> Self {
89        self.arg(config.blockhash_arg(blockhash_arg()))
90            .arg(config.sign_only_arg(sign_only_arg()))
91            .arg(config.signer_arg(signer_arg()))
92            .arg(config.dump_transaction_message_arg(dump_transaction_message()))
93    }
94    fn offline_args(self) -> Self {
95        struct NullArgsConfig {}
96        impl ArgsConfig for NullArgsConfig {}
97        self.offline_args_config(&NullArgsConfig {})
98    }
99}
solana_clap_utils/offline.rs

solana_clap_utils/
offline.rs
