LCOV - code coverage report
Current view: top level - src/wallet - wallettool.cpp (source / functions) Coverage Total Hit
Test: total_coverage.info Lines: 87.7 % 106 93
Test Date: 2026-03-01 05:36:21 Functions: 100.0 % 5 5
Branches: 53.5 % 202 108

             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 <wallet/wallettool.h>
       6                 :             : 
       7                 :             : #include <common/args.h>
       8                 :             : #include <util/check.h>
       9                 :             : #include <util/fs.h>
      10                 :             : #include <util/translation.h>
      11                 :             : #include <wallet/dump.h>
      12                 :             : #include <wallet/wallet.h>
      13                 :             : #include <wallet/walletutil.h>
      14                 :             : 
      15                 :             : namespace wallet {
      16                 :             : namespace WalletTool {
      17                 :             : 
      18                 :             : // The standard wallet deleter function blocks on the validation interface
      19                 :             : // queue, which doesn't exist for the bitcoin-wallet. Define our own
      20                 :             : // deleter here.
      21                 :           4 : static void WalletToolReleaseWallet(CWallet* wallet)
      22                 :             : {
      23                 :           4 :     wallet->WalletLogPrintf("Releasing wallet\n");
      24                 :           4 :     wallet->Close();
      25         [ +  - ]:           4 :     delete wallet;
      26                 :           4 : }
      27                 :             : 
      28                 :           1 : static void WalletCreate(CWallet* wallet_instance, uint64_t wallet_creation_flags)
      29                 :             : {
      30                 :           1 :     LOCK(wallet_instance->cs_wallet);
      31                 :             : 
      32         [ +  - ]:           1 :     wallet_instance->InitWalletFlags(wallet_creation_flags);
      33                 :             : 
      34   [ +  -  -  + ]:           1 :     Assert(wallet_instance->IsWalletFlagSet(WALLET_FLAG_DESCRIPTORS));
      35         [ +  - ]:           1 :     wallet_instance->SetupDescriptorScriptPubKeyMans();
      36                 :             : 
      37         [ +  - ]:           1 :     tfm::format(std::cout, "Topping up keypool...\n");
      38         [ +  - ]:           1 :     wallet_instance->TopUpKeyPool();
      39                 :           1 : }
      40                 :             : 
      41                 :           6 : static std::shared_ptr<CWallet> MakeWallet(const std::string& name, const fs::path& path, DatabaseOptions options)
      42                 :             : {
      43                 :           6 :     DatabaseStatus status;
      44         [ +  - ]:           6 :     bilingual_str error;
      45                 :           6 :     std::vector<bilingual_str> warnings;
      46         [ +  - ]:           6 :     std::unique_ptr<WalletDatabase> database = MakeDatabase(path, options, status, error);
      47         [ +  + ]:           6 :     if (!database) {
      48         [ +  - ]:           2 :         tfm::format(std::cerr, "%s\n", error.original);
      49                 :           2 :         return nullptr;
      50                 :             :     }
      51                 :             : 
      52                 :             :     // dummy chain interface
      53   [ +  -  +  -  :           8 :     std::shared_ptr<CWallet> wallet_instance{new CWallet(/*chain=*/nullptr, name, std::move(database)), WalletToolReleaseWallet};
             +  -  -  - ]
      54                 :           4 :     DBErrors load_wallet_ret;
      55                 :           4 :     try {
      56         [ +  - ]:           4 :         load_wallet_ret = wallet_instance->PopulateWalletFromDB(error, warnings);
      57         [ -  - ]:           0 :     } catch (const std::runtime_error&) {
      58         [ -  - ]:           0 :         tfm::format(std::cerr, "Error loading %s. Is wallet being used by another process?\n", name);
      59                 :           0 :         return nullptr;
      60                 :           0 :     }
      61                 :             : 
      62         [ -  + ]:           4 :     if (!error.empty()) {
      63         [ #  # ]:           0 :         tfm::format(std::cerr, "%s", error.original);
      64                 :             :     }
      65                 :             : 
      66         [ -  + ]:           4 :     for (const auto &warning : warnings) {
      67         [ #  # ]:           0 :         tfm::format(std::cerr, "%s", warning.original);
      68                 :             :     }
      69                 :             : 
      70   [ -  +  -  - ]:           4 :     if (load_wallet_ret != DBErrors::LOAD_OK && load_wallet_ret != DBErrors::NONCRITICAL_ERROR && load_wallet_ret != DBErrors::NEED_RESCAN) {
      71                 :           0 :         return nullptr;
      72                 :             :     }
      73                 :             : 
      74   [ +  +  +  - ]:           4 :     if (options.require_create) WalletCreate(wallet_instance.get(), options.create_flags);
      75                 :             : 
      76                 :           4 :     return wallet_instance;
      77                 :          12 : }
      78                 :             : 
      79                 :           4 : static void WalletShowInfo(CWallet* wallet_instance)
      80                 :             : {
      81                 :           4 :     LOCK(wallet_instance->cs_wallet);
      82                 :             : 
      83         [ +  - ]:           4 :     tfm::format(std::cout, "Wallet info\n===========\n");
      84         [ +  - ]:           4 :     tfm::format(std::cout, "Name: %s\n", wallet_instance->GetName());
      85   [ +  -  +  - ]:           4 :     tfm::format(std::cout, "Format: %s\n", wallet_instance->GetDatabase().Format());
      86   [ +  -  -  +  :           4 :     tfm::format(std::cout, "Descriptors: %s\n", wallet_instance->IsWalletFlagSet(WALLET_FLAG_DESCRIPTORS) ? "yes" : "no");
                   +  - ]
      87   [ +  -  +  -  :           8 :     tfm::format(std::cout, "Encrypted: %s\n", wallet_instance->HasEncryptionKeys() ? "yes" : "no");
                   +  - ]
      88   [ +  -  -  +  :           4 :     tfm::format(std::cout, "HD (hd seed available): %s\n", wallet_instance->IsHDEnabled() ? "yes" : "no");
                   +  - ]
      89   [ +  -  +  - ]:           4 :     tfm::format(std::cout, "Keypool Size: %u\n", wallet_instance->GetKeyPoolSize());
      90         [ +  - ]:           4 :     tfm::format(std::cout, "Transactions: %zu\n", wallet_instance->mapWallet.size());
      91         [ +  - ]:           4 :     tfm::format(std::cout, "Address Book: %zu\n", wallet_instance->m_address_book.size());
      92                 :           4 : }
      93                 :             : 
      94                 :          29 : bool ExecuteWalletToolFunc(const ArgsManager& args, const std::string& command)
      95                 :             : {
      96   [ +  -  +  +  :          58 :     if (args.IsArgSet("-dumpfile") && command != "dump" && command != "createfromdump") {
          +  +  +  -  -  
                      + ]
      97                 :           0 :         tfm::format(std::cerr, "The -dumpfile option can only be used with the \"dump\" and \"createfromdump\" commands.\n");
      98                 :           0 :         return false;
      99                 :             :     }
     100   [ +  +  +  +  :          46 :     if ((command == "create" || command == "createfromdump") && !args.IsArgSet("-wallet")) {
          +  -  +  +  +  
                      + ]
     101                 :           2 :         tfm::format(std::cerr, "Wallet name must be provided when creating a new wallet.\n");
     102                 :           2 :         return false;
     103                 :             :     }
     104   [ +  -  +  - ]:          54 :     const std::string name = args.GetArg("-wallet", "");
     105   [ +  -  +  -  :          54 :     const fs::path path = fsbridge::AbsPathJoin(GetWalletDir(), fs::PathFromString(name));
                   +  - ]
     106                 :             : 
     107         [ +  + ]:          27 :     if (command == "create") {
     108         [ +  + ]:           2 :         if (name.empty()) {
     109         [ +  - ]:           1 :             tfm::format(std::cerr, "Wallet name cannot be empty\n");
     110                 :             :             return false;
     111                 :             :         }
     112         [ +  - ]:           1 :         DatabaseOptions options;
     113         [ +  - ]:           1 :         ReadDatabaseArgs(args, options);
     114                 :           1 :         options.require_create = true;
     115                 :           1 :         options.create_flags |= WALLET_FLAG_DESCRIPTORS;
     116                 :           1 :         options.require_format = DatabaseFormat::SQLITE;
     117                 :             : 
     118   [ +  -  +  - ]:           1 :         const std::shared_ptr<CWallet> wallet_instance = MakeWallet(name, path, options);
     119         [ +  - ]:           1 :         if (wallet_instance) {
     120         [ +  - ]:           1 :             WalletShowInfo(wallet_instance.get());
     121         [ +  - ]:           1 :             wallet_instance->Close();
     122                 :             :         }
     123         [ +  + ]:          26 :     } else if (command == "info") {
     124         [ +  - ]:           5 :         DatabaseOptions options;
     125         [ +  - ]:           5 :         ReadDatabaseArgs(args, options);
     126                 :           5 :         options.require_existing = true;
     127   [ +  -  +  - ]:           5 :         const std::shared_ptr<CWallet> wallet_instance = MakeWallet(name, path, options);
     128   [ +  +  -  + ]:           5 :         if (!wallet_instance) return false;
     129         [ +  - ]:           3 :         WalletShowInfo(wallet_instance.get());
     130         [ +  - ]:           3 :         wallet_instance->Close();
     131         [ +  + ]:          25 :     } else if (command == "dump") {
     132         [ +  - ]:           7 :         DatabaseOptions options;
     133         [ +  - ]:           7 :         ReadDatabaseArgs(args, options);
     134                 :           7 :         options.require_existing = true;
     135                 :           7 :         DatabaseStatus status;
     136                 :             : 
     137   [ +  -  +  -  :          14 :         if (IsBDBFile(BDBDataFile(path))) {
                   -  + ]
     138                 :           0 :             options.require_format = DatabaseFormat::BERKELEY_RO;
     139                 :             :         }
     140                 :             : 
     141         [ +  - ]:           7 :         bilingual_str error;
     142         [ +  - ]:           7 :         std::unique_ptr<WalletDatabase> database = MakeDatabase(path, options, status, error);
     143         [ -  + ]:           7 :         if (!database) {
     144         [ #  # ]:           0 :             tfm::format(std::cerr, "%s\n", error.original);
     145                 :             :             return false;
     146                 :             :         }
     147                 :             : 
     148         [ +  - ]:           7 :         bool ret = DumpWallet(args, *database, error);
     149   [ +  +  -  + ]:           7 :         if (!ret && !error.empty()) {
     150         [ +  - ]:           2 :             tfm::format(std::cerr, "%s\n", error.original);
     151                 :             :             return ret;
     152                 :             :         }
     153         [ +  - ]:           5 :         tfm::format(std::cout, "The dumpfile may contain private keys. To ensure the safety of your Bitcoin, do not share the dumpfile.\n");
     154                 :             :         return ret;
     155         [ +  - ]:          27 :     } else if (command == "createfromdump") {
     156         [ +  - ]:          13 :         bilingual_str error;
     157                 :          13 :         std::vector<bilingual_str> warnings;
     158         [ +  - ]:          13 :         bool ret = CreateFromDump(args, name, path, error, warnings);
     159         [ -  + ]:          13 :         for (const auto& warning : warnings) {
     160         [ #  # ]:           0 :             tfm::format(std::cout, "%s\n", warning.original);
     161                 :             :         }
     162   [ +  +  +  + ]:          13 :         if (!ret && !error.empty()) {
     163         [ +  - ]:          10 :             tfm::format(std::cerr, "%s\n", error.original);
     164                 :             :         }
     165                 :          13 :         return ret;
     166                 :          26 :     } else {
     167         [ #  # ]:           0 :         tfm::format(std::cerr, "Invalid command: %s\n", command);
     168                 :             :         return false;
     169                 :             :     }
     170                 :             : 
     171                 :             :     return true;
     172                 :          27 : }
     173                 :             : } // namespace WalletTool
     174                 :             : } // namespace wallet
        

Generated by: LCOV version 2.0-1