Branch data Line data Source code
1 : : // Copyright (c) 2016-present The Bitcoin Core developers
2 : : // Distributed under the MIT software license, see the accompanying
3 : : // file COPYING or http://www.opensource.org/licenses/mit-license.php.
4 : :
5 : : #include <bitcoin-build-config.h> // IWYU pragma: keep
6 : :
7 : : #include <chainparams.h>
8 : : #include <chainparamsbase.h>
9 : : #include <clientversion.h>
10 : : #include <common/args.h>
11 : : #include <common/system.h>
12 : : #include <compat/compat.h>
13 : : #include <interfaces/init.h>
14 : : #include <key.h>
15 : : #include <logging.h>
16 : : #include <pubkey.h>
17 : : #include <tinyformat.h>
18 : : #include <util/exception.h>
19 : : #include <util/translation.h>
20 : : #include <wallet/wallettool.h>
21 : :
22 : : #include <exception>
23 : : #include <functional>
24 : : #include <string>
25 : : #include <tuple>
26 : :
27 : : using util::Join;
28 : :
29 : : const TranslateFn G_TRANSLATION_FUN{nullptr};
30 : :
31 : 0 : static void SetupWalletToolArgs(ArgsManager& argsman)
32 : : {
33 : 0 : SetupHelpOptions(argsman);
34 : 0 : SetupChainParamsBaseOptions(argsman);
35 : :
36 [ # # # # ]: 0 : argsman.AddArg("-version", "Print version and exit", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
37 [ # # # # ]: 0 : argsman.AddArg("-datadir=<dir>", "Specify data directory", ArgsManager::ALLOW_ANY | ArgsManager::DISALLOW_NEGATION, OptionsCategory::OPTIONS);
38 [ # # # # ]: 0 : argsman.AddArg("-wallet=<wallet-name>", "Specify wallet name", ArgsManager::ALLOW_ANY | ArgsManager::NETWORK_ONLY, OptionsCategory::OPTIONS);
39 [ # # # # ]: 0 : argsman.AddArg("-dumpfile=<file name>", "When used with 'dump', writes out the records to this file. When used with 'createfromdump', loads the records into a new wallet.", ArgsManager::ALLOW_ANY | ArgsManager::DISALLOW_NEGATION, OptionsCategory::OPTIONS);
40 [ # # # # ]: 0 : argsman.AddArg("-debug=<category>", "Output debugging information (default: 0).", ArgsManager::ALLOW_ANY, OptionsCategory::DEBUG_TEST);
41 [ # # # # ]: 0 : argsman.AddArg("-descriptors", "Create descriptors wallet. Only for 'create'", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
42 [ # # # # ]: 0 : argsman.AddArg("-legacy", "Create legacy wallet. Only for 'create'", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
43 [ # # # # ]: 0 : argsman.AddArg("-printtoconsole", "Send trace/debug info to console (default: 1 when no -debug is true, 0 otherwise).", ArgsManager::ALLOW_ANY, OptionsCategory::DEBUG_TEST);
44 [ # # # # ]: 0 : argsman.AddArg("-withinternalbdb", "Use the internal Berkeley DB parser when dumping a Berkeley DB wallet file (default: false)", ArgsManager::ALLOW_ANY, OptionsCategory::DEBUG_TEST);
45 : :
46 [ # # # # ]: 0 : argsman.AddCommand("info", "Get wallet info");
47 [ # # # # ]: 0 : argsman.AddCommand("create", "Create new wallet file");
48 [ # # # # ]: 0 : argsman.AddCommand("dump", "Print out all of the wallet key-value records");
49 [ # # # # ]: 0 : argsman.AddCommand("createfromdump", "Create new wallet file from dumped records");
50 : 0 : }
51 : :
52 : 0 : static std::optional<int> WalletAppInit(ArgsManager& args, int argc, char* argv[])
53 : : {
54 : 0 : SetupWalletToolArgs(args);
55 [ # # ]: 0 : std::string error_message;
56 [ # # # # ]: 0 : if (!args.ParseParameters(argc, argv, error_message)) {
57 [ # # ]: 0 : tfm::format(std::cerr, "Error parsing command line arguments: %s\n", error_message);
58 : 0 : return EXIT_FAILURE;
59 : : }
60 : 0 : const bool missing_args{argc < 2};
61 [ # # # # : 0 : if (missing_args || HelpRequested(args) || args.GetBoolArg("-version", false)) {
# # # # #
# # # #
# ]
62 [ # # # # : 0 : std::string strUsage = strprintf("%s bitcoin-wallet utility version", CLIENT_NAME) + " " + FormatFullVersion() + "\n";
# # ]
63 : :
64 [ # # # # : 0 : if (args.GetBoolArg("-version", false)) {
# # ]
65 [ # # # # ]: 0 : strUsage += FormatParagraph(LicenseInfo());
66 : : } else {
67 [ # # ]: 0 : strUsage += "\n"
68 : : "bitcoin-wallet is an offline tool for creating and interacting with " CLIENT_NAME " wallet files.\n\n"
69 : : "By default bitcoin-wallet will act on wallets in the default mainnet wallet directory in the datadir.\n\n"
70 : : "To change the target wallet, use the -datadir, -wallet and (test)chain selection arguments.\n"
71 : : "\n"
72 : : "Usage: bitcoin-wallet [options] <command>\n"
73 : 0 : "\n";
74 [ # # # # ]: 0 : strUsage += "\n" + args.GetHelpMessage();
75 : : }
76 [ # # ]: 0 : tfm::format(std::cout, "%s", strUsage);
77 [ # # ]: 0 : if (missing_args) {
78 [ # # ]: 0 : tfm::format(std::cerr, "Error: too few parameters\n");
79 : 0 : return EXIT_FAILURE;
80 : : }
81 : 0 : return EXIT_SUCCESS;
82 : 0 : }
83 : :
84 : : // check for printtoconsole, allow -debug
85 [ # # # # : 0 : LogInstance().m_print_to_console = args.GetBoolArg("-printtoconsole", args.GetBoolArg("-debug", false));
# # # # #
# ]
86 : :
87 [ # # # # ]: 0 : if (!CheckDataDirOption(args)) {
88 [ # # # # : 0 : tfm::format(std::cerr, "Error: Specified data directory \"%s\" does not exist.\n", args.GetArg("-datadir", ""));
# # # # ]
89 : 0 : return EXIT_FAILURE;
90 : : }
91 : : // Check for chain settings (Params() calls are only valid after this clause)
92 [ # # # # ]: 0 : SelectParams(args.GetChainType());
93 : :
94 : 0 : return std::nullopt;
95 : 0 : }
96 : :
97 : 0 : MAIN_FUNCTION
98 : : {
99 : 0 : ArgsManager& args = gArgs;
100 : : #ifdef WIN32
101 : : common::WinCmdLineArgs winArgs;
102 : : std::tie(argc, argv) = winArgs.get();
103 : : #endif
104 : :
105 : 0 : int exit_status;
106 : 0 : std::unique_ptr<interfaces::Init> init = interfaces::MakeWalletInit(argc, argv, exit_status);
107 [ # # ]: 0 : if (!init) {
108 : 0 : return exit_status;
109 : : }
110 : :
111 [ # # ]: 0 : SetupEnvironment();
112 [ # # ]: 0 : RandomInit();
113 : 0 : try {
114 [ # # # # ]: 0 : if (const auto maybe_exit{WalletAppInit(args, argc, argv)}) return *maybe_exit;
115 [ - - ]: 0 : } catch (const std::exception& e) {
116 [ - - ]: 0 : PrintExceptionContinue(&e, "WalletAppInit()");
117 : 0 : return EXIT_FAILURE;
118 : 0 : } catch (...) {
119 [ - - ]: 0 : PrintExceptionContinue(nullptr, "WalletAppInit()");
120 : 0 : return EXIT_FAILURE;
121 [ - - ]: 0 : }
122 : :
123 [ # # ]: 0 : const auto command = args.GetCommand();
124 [ # # ]: 0 : if (!command) {
125 [ # # ]: 0 : tfm::format(std::cerr, "No method provided. Run `bitcoin-wallet -help` for valid methods.\n");
126 : : return EXIT_FAILURE;
127 : : }
128 [ # # ]: 0 : if (command->args.size() != 0) {
129 [ # # # # ]: 0 : tfm::format(std::cerr, "Error: Additional arguments provided (%s). Methods do not take arguments. Please refer to `-help`.\n", Join(command->args, ", "));
130 : 0 : return EXIT_FAILURE;
131 : : }
132 : :
133 [ # # ]: 0 : ECC_Context ecc_context{};
134 [ # # # # ]: 0 : if (!wallet::WalletTool::ExecuteWalletToolFunc(args, command->command)) {
135 : 0 : return EXIT_FAILURE;
136 : : }
137 : : return EXIT_SUCCESS;
138 : 0 : }
|
