Merge #13058: [wallet] createwallet RPC - create new wallet at runtime

Summary:
f7e153e95 [wallets] [docs] Add release notes for createwallet RPC. (John Newbery)
32167e830 [wallet] [tests] Add tests for `createwallet` RPC. (John Newbery)
942131774 [wallet] [rpc] Add `createwallet` RPC (John Newbery)

Pull request description:

  Adds a `createwallet` RPC to dynamically create a new wallet at runtime.

  Includes tests and release notes.

Tree-SHA512: e0d89e3ae498234e9db5b827c56804cbab64f18a1875e2b5e676172c110278ea1b9e93a8a61b8dd80e2f2a691490bf229e923e4ccb284a1d3e420b8317815866

Backport of Core PR13058
bitcoin/bitcoin#13058

Test Plan:
  make check
  test_runner.py

Reviewers: deadalnix, Fabien, jasonbcox, O1 Bitcoin ABC, #bitcoin_abc, fpelliccioni

Reviewed By: deadalnix, O1 Bitcoin ABC, #bitcoin_abc

Subscribers: fpelliccioni

Differential Revision: https://reviews.bitcoinabc.org/D4220

Author: jonasschnelli

doc/release-notes.md

@@ -1,8 +1,21 @@
-This release includes the following features and fixes since 1.1.3 release:
+This release includes the following features and fixes since 1.1.4 release:
 
-Miscellaneous changes
-CMake build updates
-Speed up unit test builds
+This release includes the following features and fixes:
+ - Minor bug fixes and improvements.
+ - New `fees` field introduced in `getrawmempool`, `getmempoolancestors`,
+   `getmempooldescendants` and  `getmempoolentry` when verbosity is set to
+   `true` with sub-fields `ancestor`, `base`, `modified` and `descendant`
+   denominated in BCH. This new field deprecates previous fee fields, such a
+   `fee`, `modifiedfee`, `ancestorfee` and `descendantfee`.
 
-About 100 upstream bitcoin-abc updates
+Dynamic creation of wallets
+---------------------------------------
+  - Previously, wallets could only be loaded or created at startup, by
+    specifying `-wallet` parameters on the command line or in the bitcoin.conf
+    file. It is now possible to create wallets dynamically at runtime:
 
+  - New wallets can be created (and loaded) by calling the `createwallet` RPC.
+    The provided name must not match a wallet file in the `walletdir` directory
+    or the name of a wallet that is currently loaded.
+
+  - This feature is currently only available through the RPC interface.

src/wallet/rpcwallet.cpp

@@ -3459,6 +3459,68 @@ UniValue loadwallet(const Config &config, const JSONRPCRequest &request) {
     return obj;
 }
 
+UniValue createwallet(const Config &config, const JSONRPCRequest &request) {
+    if (request.fHelp || request.params.size() != 1) {
+        throw std::runtime_error(
+            "createwallet \"wallet_name\"\n"
+            "\nCreates and loads a new wallet.\n"
+            "\nArguments:\n"
+            "1. \"wallet_name\"    (string, required) The name for the new wallet. "
+            "If this is a path, the wallet will be created at the path location.\n"
+            "2. \"password\"    (string, optional) The password for the encrypted wallet or blank if empty. "
+            "\nResult:\n"
+            "{\n"
+            "  \"name\" :    <wallet_name>,        (string) The wallet name if "
+            "created successfully. If the wallet was created using a full "
+            "path, the wallet_name will be the full path.\n"
+            "  \"warning\" : <warning>,            (string) Warning message if "
+            "wallet was not loaded cleanly.\n"
+            "}\n"
+            "\nExamples:\n" +
+            HelpExampleCli("createwallet", "\"testwallet\"") +
+            HelpExampleRpc("createwallet", "\"testwallet\""));
+    }
+
+    const CChainParams &chainParams = config.GetChainParams();
+
+    std::string wallet_name = request.params[0].get_str();
+    std::string password = request.params[1].get_str();
+    std::string error;
+    std::string warning;
+
+    WalletLocation location(wallet_name);
+
+    if (location.Exists()) {
+        throw JSONRPCError(RPC_WALLET_ERROR,
+                           "Wallet " + wallet_name + " already exists.");
+    }
+
+    // Wallet::Verify will check if we're trying to create a wallet with a
+    // duplicate name.
+    if (!CWallet::Verify(chainParams, location, false, error, warning)) {
+        throw JSONRPCError(RPC_WALLET_ERROR,
+                           "Wallet file verification failed: " + error);
+    }
+
+    std::vector<std::string> words;
+    bool use_bls = false;
+    SecureString passphrase(password);
+    std::shared_ptr<CWallet> const wallet = CWallet::CreateWalletFromFile(
+                                                                          chainParams, location, passphrase, words, use_bls);
+    if (!wallet) {
+        throw JSONRPCError(RPC_WALLET_ERROR, "Wallet creation failed.");
+    }
+    AddWallet(wallet);
+
+    wallet->postInitProcess();
+
+    UniValue obj(UniValue::VOBJ);
+    obj.pushKV("name", wallet->GetName());
+    obj.pushKV("warning", warning);
+
+    return obj;
+}
+
 static UniValue resendwallettransactions(const Config &config,
                                          const JSONRPCRequest &request) {
     std::shared_ptr<CWallet> const wallet = GetWalletForJSONRPCRequest(request);
@@ -4250,6 +4312,7 @@ static const ContextFreeRPCCommand commands[] = {
     { "wallet",             "abandontransaction",           abandontransaction,           {"txid"} },
     { "wallet",             "addmultisigaddress",           addmultisigaddress,           {"nrequired","keys","label|account"} },
     { "wallet",             "backupwallet",                 backupwallet,                 {"destination"} },
+    { "wallet",             "createwallet",                 createwallet,                 {"wallet_name"} },
     { "wallet",             "getlabeladdress",              getlabeladdress,              {"label"} },
     { "wallet",             "getaddressesbylabels",         getaddressesbylabels,         {} },
     { "wallet",             "getbalance",                   getbalance,                   {"account","minconf","include_watchonly"} },

test/functional/wallet_multiwallet.py

@@ -220,11 +220,6 @@ def wallet(name): return node.get_wallet_rpc(name)
         assert_raises_rpc_error(-4, "Wallet file verification failed: Invalid -wallet path 'w8_symlink'",
                                 self.nodes[0].loadwallet, 'w8_symlink')
 
-        # Fail to load if a directory is specified that doesn't contain a wallet
-        os.mkdir(wallet_dir('empty_wallet_dir'))
-        assert_raises_rpc_error(-18, "Directory empty_wallet_dir does not contain a wallet.dat file",
-                                self.nodes[0].loadwallet, 'empty_wallet_dir')
-
         self.log.info("Test dynamic wallet creation.")
 
         # Fail to create a wallet if it already exists.
@@ -249,66 +244,6 @@ def wallet(name): return node.get_wallet_rpc(name)
 
         assert new_wallet_name in self.nodes[0].listwallets()
 
-        self.log.info("Test dynamic wallet unloading")
-
-        # Test `unloadwallet` errors
-        assert_raises_rpc_error(-1, "JSON value is not a string as expected",
-                                self.nodes[0].unloadwallet)
-        assert_raises_rpc_error(-18, "Requested wallet does not exist or is not loaded",
-                                self.nodes[0].unloadwallet, "dummy")
-        assert_raises_rpc_error(-18, "Requested wallet does not exist or is not loaded",
-                                node.get_wallet_rpc("dummy").unloadwallet)
-        assert_raises_rpc_error(-8, "Cannot unload the requested wallet",
-                                w1.unloadwallet, "w2"),
-
-        # Successfully unload the specified wallet name
-        self.nodes[0].unloadwallet("w1")
-        assert 'w1' not in self.nodes[0].listwallets()
-
-        # Successfully unload the wallet referenced by the request endpoint
-        w2.unloadwallet()
-        assert 'w2' not in self.nodes[0].listwallets()
-
-        # Successfully unload all wallets
-        for wallet_name in self.nodes[0].listwallets():
-            self.nodes[0].unloadwallet(wallet_name)
-        assert_equal(self.nodes[0].listwallets(), [])
-        assert_raises_rpc_error(-32601, "Method not found (wallet method is disabled because no wallet is loaded)",
-                                self.nodes[0].getwalletinfo)
-
-        # Successfully load a previously unloaded wallet
-        self.nodes[0].loadwallet('w1')
-        assert_equal(self.nodes[0].listwallets(), ['w1'])
-        assert_equal(w1.getwalletinfo()['walletname'], 'w1')
-
-        # Test backing up and restoring wallets
-        self.log.info("Test wallet backup")
-        self.restart_node(0, ['-nowallet'])
-        for wallet_name in wallet_names:
-            self.nodes[0].loadwallet(wallet_name)
-        for wallet_name in wallet_names:
-            rpc = self.nodes[0].get_wallet_rpc(wallet_name)
-            addr = rpc.getnewaddress()
-            backup = os.path.join(self.options.tmpdir, 'backup.dat')
-            rpc.backupwallet(backup)
-            self.nodes[0].unloadwallet(wallet_name)
-            shutil.copyfile(empty_wallet, wallet_file(wallet_name))
-            self.nodes[0].loadwallet(wallet_name)
-            assert_equal(rpc.getaddressinfo(addr)['ismine'], False)
-            self.nodes[0].unloadwallet(wallet_name)
-            shutil.copyfile(backup, wallet_file(wallet_name))
-            self.nodes[0].loadwallet(wallet_name)
-            assert_equal(rpc.getaddressinfo(addr)['ismine'], True)
-
-        # Test .walletlock file is closed
-        self.start_node(1)
-        wallet = os.path.join(self.options.tmpdir, 'my_wallet')
-        self.nodes[0].createwallet(wallet)
-        assert_raises_rpc_error(-4, "Error initializing wallet database environment",
-                                self.nodes[1].loadwallet, wallet)
-        self.nodes[0].unloadwallet(wallet)
-        self.nodes[1].loadwallet(wallet)
-
 
 if __name__ == '__main__':
     MultiWalletTest().main()