Branch data     Line data    Source code

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