Inside Bitcoin

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/license_info.h>
12#include <common/system.h>
13#include <compat/compat.h>
14#include <crypto/sha256.h>
15#include <interfaces/init.h>
16#include <key.h>
17#include <logging.h>
18#include <pubkey.h>
19#include <tinyformat.h>
20#include <util/exception.h>
21#include <util/translation.h>
22#include <wallet/wallettool.h>
23
24#include <exception>
25#include <functional>
26#include <string>
27#include <tuple>
28
29using util::Join;
30
31const TranslateFn G_TRANSLATION_FUN{nullptr};
32
33static void SetupWalletToolArgs(ArgsManager& argsman)
34{
35    SetupHelpOptions(argsman);
36    SetupChainParamsBaseOptions(argsman);
37
38    argsman.AddArg("-version", "Print version and exit", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
39    argsman.AddArg("-datadir=<dir>", "Specify data directory", ArgsManager::ALLOW_ANY | ArgsManager::DISALLOW_NEGATION, OptionsCategory::OPTIONS);
40    argsman.AddArg("-wallet=<wallet-name>", "Specify wallet name", ArgsManager::ALLOW_ANY | ArgsManager::NETWORK_ONLY, OptionsCategory::OPTIONS);
41    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::COMMAND_OPTIONS);
42    argsman.AddArg("-debug=<category>", "Output debugging information (default: 0).", ArgsManager::ALLOW_ANY, OptionsCategory::DEBUG_TEST);
43    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
45    argsman.AddCommand("info", "Get wallet info");
46    argsman.AddCommand("create", "Create a new descriptor wallet file");
47    argsman.AddCommand("dump", "Print out all of the wallet key-value records", {"-dumpfile"});
48    argsman.AddCommand("createfromdump", "Create new wallet file from dumped records", {"-dumpfile"});
49}
50
51static std::optional<int> WalletAppInit(ArgsManager& args, int argc, char* argv[])
52{
53    SetupWalletToolArgs(args);
54    std::string error_message;
55    if (!args.ParseParameters(argc, argv, error_message)) {
56        tfm::format(std::cerr, "Error parsing command line arguments: %s\n", error_message);
57        return EXIT_FAILURE;
58    }
59    const bool missing_args{argc < 2};
60    if (missing_args || HelpRequested(args) || args.GetBoolArg("-version", false)) {
61        std::string strUsage = strprintf("%s bitcoin-wallet utility version", CLIENT_NAME) + " " + FormatFullVersion() + "\n";
62
63        if (args.GetBoolArg("-version", false)) {
64            strUsage += FormatParagraph(LicenseInfo());
65        } else {
66            strUsage += "\n"
67                "bitcoin-wallet is an offline tool for creating and interacting with " CLIENT_NAME " wallet files.\n\n"
68                "By default bitcoin-wallet will act on wallets in the default mainnet wallet directory in the datadir.\n\n"
69                "To change the target wallet, use the -datadir, -wallet and (test)chain selection arguments.\n"
70                "\n"
71                "Usage: bitcoin-wallet [options] <command>\n"
72                "\n";
73            strUsage += "\n" + args.GetHelpMessage();
74        }
75        tfm::format(std::cout, "%s", strUsage);
76        if (missing_args) {
77            tfm::format(std::cerr, "Error: too few parameters\n");
78            return EXIT_FAILURE;
79        }
80        return EXIT_SUCCESS;
81    }
82
83    // check for printtoconsole, allow -debug
84    LogInstance().m_print_to_console = args.GetBoolArg("-printtoconsole", args.GetBoolArg("-debug", false));
85
86    if (!CheckDataDirOption(args)) {
87        tfm::format(std::cerr, "Error: Specified data directory \"%s\" does not exist.\n", args.GetArg("-datadir", ""));
88        return EXIT_FAILURE;
89    }
90    // Check for chain settings (Params() calls are only valid after this clause)
91    SelectParams(args.GetChainType());
92
93    return std::nullopt;
94}
95
96MAIN_FUNCTION
97{
98    ArgsManager& args = gArgs;
99
100    int exit_status;
101    std::unique_ptr<interfaces::Init> init = interfaces::MakeWalletInit(argc, argv, exit_status);
102    if (!init) {
103        return exit_status;
104    }
105
106    SetupEnvironment();
107    SHA256AutoDetect();
108    RandomInit();
109    try {
110        if (const auto maybe_exit{WalletAppInit(args, argc, argv)}) return *maybe_exit;
111    } catch (const std::exception& e) {
112        PrintExceptionContinue(&e, "WalletAppInit()");
113        return EXIT_FAILURE;
114    } catch (...) {
115        PrintExceptionContinue(nullptr, "WalletAppInit()");
116        return EXIT_FAILURE;
117    }
118
119    const auto command = args.GetCommand();
120    if (!command) {
121        tfm::format(std::cerr, "No method provided. Run `bitcoin-wallet -help` for valid methods.\n");
122        return EXIT_FAILURE;
123    }
124    if (command->args.size() != 0) {
125        tfm::format(std::cerr, "Error: Additional arguments provided (%s). Methods do not take arguments. Please refer to `-help`.\n", Join(command->args, ", "));
126        return EXIT_FAILURE;
127    }
128
129    ECC_Context ecc_context{};
130    if (!wallet::WalletTool::ExecuteWalletToolFunc(args, command->command)) {
131        return EXIT_FAILURE;
132    }
133    return EXIT_SUCCESS;
134}
135