Bitcoin Core 29.99.0
P2P Digital Currency
bitcoin-wallet.cpp
Go to the documentation of this file.
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
27using util::Join;
28
30
31static void SetupWalletToolArgs(ArgsManager& argsman)
32{
33 SetupHelpOptions(argsman);
35
36 argsman.AddArg("-version", "Print version and exit", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
37 argsman.AddArg("-datadir=<dir>", "Specify data directory", ArgsManager::ALLOW_ANY | ArgsManager::DISALLOW_NEGATION, OptionsCategory::OPTIONS);
38 argsman.AddArg("-wallet=<wallet-name>", "Specify wallet name", ArgsManager::ALLOW_ANY | ArgsManager::NETWORK_ONLY, OptionsCategory::OPTIONS);
39 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 argsman.AddArg("-debug=<category>", "Output debugging information (default: 0).", ArgsManager::ALLOW_ANY, OptionsCategory::DEBUG_TEST);
41 argsman.AddArg("-printtoconsole", "Send trace/debug info to console (default: 1 when no -debug is true, 0 otherwise).", ArgsManager::ALLOW_ANY, OptionsCategory::DEBUG_TEST);
42
43 argsman.AddCommand("info", "Get wallet info");
44 argsman.AddCommand("create", "Create a new descriptor wallet file");
45 argsman.AddCommand("dump", "Print out all of the wallet key-value records");
46 argsman.AddCommand("createfromdump", "Create new wallet file from dumped records");
47}
48
49static std::optional<int> WalletAppInit(ArgsManager& args, int argc, char* argv[])
50{
52 std::string error_message;
53 if (!args.ParseParameters(argc, argv, error_message)) {
54 tfm::format(std::cerr, "Error parsing command line arguments: %s\n", error_message);
55 return EXIT_FAILURE;
56 }
57 const bool missing_args{argc < 2};
58 if (missing_args || HelpRequested(args) || args.GetBoolArg("-version", false)) {
59 std::string strUsage = strprintf("%s bitcoin-wallet utility version", CLIENT_NAME) + " " + FormatFullVersion() + "\n";
60
61 if (args.GetBoolArg("-version", false)) {
62 strUsage += FormatParagraph(LicenseInfo());
63 } else {
64 strUsage += "\n"
65 "bitcoin-wallet is an offline tool for creating and interacting with " CLIENT_NAME " wallet files.\n\n"
66 "By default bitcoin-wallet will act on wallets in the default mainnet wallet directory in the datadir.\n\n"
67 "To change the target wallet, use the -datadir, -wallet and (test)chain selection arguments.\n"
68 "\n"
69 "Usage: bitcoin-wallet [options] <command>\n"
70 "\n";
71 strUsage += "\n" + args.GetHelpMessage();
72 }
73 tfm::format(std::cout, "%s", strUsage);
74 if (missing_args) {
75 tfm::format(std::cerr, "Error: too few parameters\n");
76 return EXIT_FAILURE;
77 }
78 return EXIT_SUCCESS;
79 }
80
81 // check for printtoconsole, allow -debug
82 LogInstance().m_print_to_console = args.GetBoolArg("-printtoconsole", args.GetBoolArg("-debug", false));
83
85 tfm::format(std::cerr, "Error: Specified data directory \"%s\" does not exist.\n", args.GetArg("-datadir", ""));
86 return EXIT_FAILURE;
87 }
88 // Check for chain settings (Params() calls are only valid after this clause)
90
91 return std::nullopt;
92}
93
95{
97#ifdef WIN32
98 common::WinCmdLineArgs winArgs;
99 std::tie(argc, argv) = winArgs.get();
100#endif
101
103 std::unique_ptr<interfaces::Init> init = interfaces::MakeWalletInit(argc, argv, exit_status);
104 if (!init) {
105 return exit_status;
106 }
107
109 RandomInit();
110 try {
111 if (const auto maybe_exit{WalletAppInit(args, argc, argv)}) return *maybe_exit;
112 } catch (const std::exception& e) {
113 PrintExceptionContinue(&e, "WalletAppInit()");
114 return EXIT_FAILURE;
115 } catch (...) {
116 PrintExceptionContinue(nullptr, "WalletAppInit()");
117 return EXIT_FAILURE;
118 }
119
120 const auto command = args.GetCommand();
121 if (!command) {
122 tfm::format(std::cerr, "No method provided. Run `bitcoin-wallet -help` for valid methods.\n");
123 return EXIT_FAILURE;
124 }
125 if (command->args.size() != 0) {
126 tfm::format(std::cerr, "Error: Additional arguments provided (%s). Methods do not take arguments. Please refer to `-help`.\n", Join(command->args, ", "));
127 return EXIT_FAILURE;
128 }
129
132 return EXIT_FAILURE;
133 }
135}
bool HelpRequested(const ArgsManager &args)
Definition: args.cpp:684
void SetupHelpOptions(ArgsManager &args)
Add help options to the args manager.
Definition: args.cpp:689
bool CheckDataDirOption(const ArgsManager &args)
Definition: args.cpp:755
ArgsManager gArgs
Definition: args.cpp:42
int exit_status
return EXIT_SUCCESS
static std::optional< int > WalletAppInit(ArgsManager &args, int argc, char *argv[])
const auto command
RandomInit()
Definition: random.cpp:696
static void SetupWalletToolArgs(ArgsManager &argsman)
SetupEnvironment()
Definition: system.cpp:59
const TranslateFn G_TRANSLATION_FUN
Translate string to current locale using Qt.
ECC_Context ecc_context
MAIN_FUNCTION
ArgsManager & args
Definition: bitcoind.cpp:277
void SelectParams(const ChainType chain)
Sets the params returned by Params() to those for the given chain type.
void SetupChainParamsBaseOptions(ArgsManager &argsman)
Set the arguments for chainparams.
std::optional< const Command > GetCommand() const
Get the command and command args (returns std::nullopt if no command provided)
Definition: args.cpp:342
@ NETWORK_ONLY
Definition: args.h:120
@ ALLOW_ANY
disable validation
Definition: args.h:106
@ DISALLOW_NEGATION
disallow -nofoo syntax
Definition: args.h:111
ChainType GetChainType() const
Returns the appropriate chain type from the program arguments.
Definition: args.cpp:774
bool ParseParameters(int argc, const char *const argv[], std::string &error)
Definition: args.cpp:179
std::string GetHelpMessage() const
Get the help string.
Definition: args.cpp:609
void AddCommand(const std::string &cmd, const std::string &help)
Add subcommand.
Definition: args.cpp:552
std::string GetArg(const std::string &strArg, const std::string &strDefault) const
Return string argument or default value.
Definition: args.cpp:457
bool GetBoolArg(const std::string &strArg, bool fDefault) const
Return boolean argument or default value.
Definition: args.cpp:507
void AddArg(const std::string &name, const std::string &help, unsigned int flags, const OptionsCategory &cat)
Add argument.
Definition: args.cpp:564
bool m_print_to_console
Definition: logging.h:132
RAII class initializing and deinitializing global state for elliptic curve support.
Definition: key.h:322
std::string FormatFullVersion()
std::string LicenseInfo()
Returns licensing information (for -version)
void PrintExceptionContinue(const std::exception *pex, std::string_view thread_name)
Definition: exception.cpp:36
BCLog::Logger & LogInstance()
Definition: logging.cpp:24
std::unique_ptr< Init > MakeWalletInit(int argc, char *argv[], int &exit_status)
Return implementation of Init interface for the wallet process.
void format(std::ostream &out, FormatStringCheck< sizeof...(Args)> fmt, const Args &... args)
Format list of arguments to the stream according to given format string.
Definition: tinyformat.h:1079
auto Join(const C &container, const S &separator, UnaryOp unary_op)
Join all container items.
Definition: string.h:192
bool ExecuteWalletToolFunc(const ArgsManager &args, const std::string &command)
Definition: wallettool.cpp:109
#define strprintf
Format arguments and return the string or write to given std::ostream (see tinyformat::format doc for...
Definition: tinyformat.h:1172
std::function< std::string(const char *)> TranslateFn
Translate a message to the native language of the user.
Definition: translation.h:16
std::string FormatParagraph(std::string_view in, size_t width, size_t indent)
Format a paragraph of text to a fixed width, adding spaces for indentation to any added line.