Merge pull request #4826 from UdjinM6/de_generate

UdjinM6 · web-flow · commit a356832882de · 2022-05-02T22:05:53.000+03:00
backport 14468, 14631, 15492
diff --git a/doc/release-notes-14468.md b/doc/release-notes-14468.md
@@ -0,0 +1,15 @@
+Wallet `generate` RPC method deprecated
+---------------------------------------
+
+The wallet's `generate` RPC method has been deprecated and will be fully
+removed in v0.19.
+
+`generate` is only used for testing. The RPC call reaches across multiple
+subsystems (wallet and mining), so is deprecated to simplify the wallet-node
+interface. Projects that are using `generate` for testing purposes should
+transition to using the `generatetoaddress` call, which does not require or use
+the wallet component. Calling `generatetoaddress` with an address returned by
+`getnewaddress` gives the same functionality as the old `generate` method.
+
+To continue using `generate` in v0.18, restart bitcoind with the
+`-deprecatedrpc=generate` configuration.
diff --git a/doc/release-notes-15492.md b/doc/release-notes-15492.md
@@ -0,0 +1,11 @@
+Deprecated or removed RPCs
+--------------------------
+- The wallet's `generate` RPC method was deprecated in v0.18 and has now
+  been fully removed.  This RPC is only used for
+  testing, but its implementation reached across multiple subsystems
+  (wallet and mining), so it has been removed to simplify the
+  wallet-node interface.  Projects that are using `generate` for testing
+  purposes should transition to using the `generatetoaddress` RPC, which
+  does not require or use the wallet component. Calling
+  `generatetoaddress` with an address returned by the `getnewaddress`
+  RPC gives the same functionality as the old `generate` RPC.
diff --git a/src/rpc/client.cpp b/src/rpc/client.cpp
@@ -29,8 +29,6 @@ static const CRPCConvertParam vRPCConvertParams[] =
     { "setmocktime", 0, "timestamp" },
     { "mockscheduler", 0, "delta_time" },
 #if ENABLE_MINER
-    { "generate", 0, "nblocks" },
-    { "generate", 1, "maxtries" },
     { "generatetoaddress", 0, "nblocks" },
     { "generatetoaddress", 2, "maxtries" },
     { "generatetodescriptor", 0, "num_blocks" },
diff --git a/src/rpc/mining.cpp b/src/rpc/mining.cpp
@@ -263,6 +263,8 @@ static UniValue generatetoaddress(const JSONRPCRequest& request)
                 RPCExamples{
             "\nGenerate 11 blocks to myaddress\n"
             + HelpExampleCli("generatetoaddress", "11 \"myaddress\"")
+            + "If you are running the Dash Core wallet, you can get a new address to send the newly generated coins to with:\n"
+            + HelpExampleCli("getnewaddress", "")
                 },
             }.ToString());
 
diff --git a/src/wallet/rpcwallet.cpp b/src/wallet/rpcwallet.cpp
@@ -13,7 +13,6 @@
 #include <policy/feerate.h>
 #include <policy/fees.h>
 #include <rpc/blockchain.h>
-#include <rpc/mining.h>
 #include <rpc/rawtransaction_util.h>
 #include <rpc/server.h>
 #include <rpc/util.h>
@@ -3326,61 +3325,6 @@ UniValue signrawtransactionwithwallet(const JSONRPCRequest& request)
     return SignTransaction(mtx, request.params[1], pwallet, coins, false, request.params[2]);
 }
 
-#if ENABLE_MINER
-UniValue generate(const JSONRPCRequest& request)
-{
-    if (request.fHelp || request.params.size() < 1 || request.params.size() > 2) {
-        throw std::runtime_error(
-            RPCHelpMan{"generate",
-                "\nMine up to nblocks blocks immediately (before the RPC call returns) to an address in the wallet.\n",
-                {
-                    {"nblocks", RPCArg::Type::NUM, RPCArg::Optional::NO, "How many blocks are generated immediately."},
-                    {"maxtries", RPCArg::Type::NUM, /* default */ "1000000", "How many iterations to try."},
-                },
-                RPCResult{
-            "[ blockhashes ]     (json array) hashes of blocks generated\n"
-                },
-                RPCExamples{
-            "\nGenerate 11 blocks\n"
-            + HelpExampleCli("generate", "11")
-                },
-            }.ToString());
-    }
-
-    std::shared_ptr<CWallet> const wallet = GetWalletForJSONRPCRequest(request);
-    if (!wallet) return NullUniValue;
-    CWallet* const pwallet = wallet.get();
-
-    int num_generate = request.params[0].get_int();
-    uint64_t max_tries = 1000000;
-    if (!request.params[1].isNull()) {
-        max_tries = request.params[1].get_int();
-    }
-
-    std::shared_ptr<CReserveScript> coinbase_script;
-    pwallet->GetScriptForMining(coinbase_script);
-
-    // If the keypool is exhausted, no script is returned at all.  Catch this.
-    if (!coinbase_script) {
-        throw JSONRPCError(RPC_WALLET_KEYPOOL_RAN_OUT, "Error: Keypool ran out, please call keypoolrefill first");
-    }
-
-    //throw an error if no script was provided
-    if (coinbase_script->reserveScript.empty()) {
-        throw JSONRPCError(RPC_INTERNAL_ERROR, "No coinbase script available");
-    }
-
-    const CTxMemPool& mempool = EnsureMemPool();
-
-    return generateBlocks(mempool, coinbase_script, num_generate, max_tries, true);
-}
-#else
-UniValue generate(const JSONRPCRequest& request)
-{
-    throw JSONRPCError(RPC_METHOD_NOT_FOUND, "This call is not available because RPC miner isn't compiled");
-}
-#endif //ENABLE_MINING
-
 static UniValue rescanblockchain(const JSONRPCRequest& request)
 {
     if (request.fHelp || request.params.size() > 2) {
@@ -3984,11 +3928,6 @@ UniValue walletcreatefundedpsbt(const JSONRPCRequest& request)
 static const CRPCCommand commands[] =
 { //  category              name                        actor (function)           argNames
     //  --------------------- ------------------------    -----------------------    ----------
-#if ENABLE_MINER
-    { "generating",         "generate",                         &generate,                      {"nblocks","maxtries"} },
-#else
-    { "hidden",             "generate",                         &generate,                      {"nblocks","maxtries"} }, // Hidden as it isn't functional, just an error to let people know if miner isn't compiled
-#endif //ENABLE_MINER
     { "hidden",             "instantsendtoaddress",             &instantsendtoaddress,          {} },
     { "rawtransactions",    "fundrawtransaction",               &fundrawtransaction,            {"hexstring","options"} },
     { "wallet",             "abandontransaction",               &abandontransaction,            {"txid"} },
diff --git a/src/wallet/wallet.cpp b/src/wallet/wallet.cpp
@@ -4772,17 +4772,6 @@ void CWallet::MarkReserveKeysAsUsed(int64_t keypool_id)
     }
 }
 
-void CWallet::GetScriptForMining(std::shared_ptr<CReserveScript> &script)
-{
-    std::shared_ptr<CReserveKey> rKey = std::make_shared<CReserveKey>(this);
-    CPubKey pubkey;
-    if (!rKey->GetReservedKey(pubkey, false))
-        return;
-
-    script = rKey;
-    script->reserveScript = CScript() << ToByteVector(pubkey) << OP_CHECKSIG;
-}
-
 void CWallet::LockCoin(const COutPoint& output)
 {
     AssertLockHeld(cs_wallet);
diff --git a/src/wallet/wallet.h b/src/wallet/wallet.h
@@ -1177,8 +1177,6 @@ class CWallet final : public CCryptoKeyStore, private interfaces::Chain::Notific
 
     bool DelAddressBook(const CTxDestination& address);
 
-    void GetScriptForMining(std::shared_ptr<CReserveScript> &script);
-
     unsigned int GetKeyPoolSize() EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)
     {
         AssertLockHeld(cs_wallet);
diff --git a/test/functional/feature_addressindex.py b/test/functional/feature_addressindex.py
@@ -35,8 +35,8 @@ def setup_network(self):
         connect_nodes(self.nodes[0], 1)
         connect_nodes(self.nodes[0], 2)
         connect_nodes(self.nodes[0], 3)
-
         self.sync_all()
+        self.import_deterministic_coinbase_privkeys()
 
     def run_test(self):
         self.log.info("Test that settings can't be changed without -reindex...")
diff --git a/test/functional/feature_dbcrash.py b/test/functional/feature_dbcrash.py
@@ -74,6 +74,7 @@ def skip_test_if_missing_module(self):
     def setup_network(self):
         self.add_nodes(self.num_nodes, extra_args=self.extra_args)
         self.start_nodes()
+        self.import_deterministic_coinbase_privkeys()
         # Leave them unconnected, we'll use submitblock directly in this test
 
     def restart_node(self, node_index, expected_tip):
diff --git a/test/functional/feature_dip3_deterministicmns.py b/test/functional/feature_dip3_deterministicmns.py
@@ -35,6 +35,7 @@ def setup_network(self):
         self.disable_mocktime()
         self.add_nodes(1)
         self.start_controller_node()
+        self.import_deterministic_coinbase_privkeys()
 
     def start_controller_node(self):
         self.log.info("starting controller node")
diff --git a/test/functional/feature_fee_estimation.py b/test/functional/feature_fee_estimation.py
@@ -147,6 +147,9 @@ def setup_network(self):
         # (17k is room enough for 110 or so transactions)
         # Node2 is a stingy miner, that
         # produces too small blocks (room for only 55 or so transactions)
+        self.start_nodes()
+        self.import_deterministic_coinbase_privkeys()
+        self.stop_nodes()
 
     def transact_and_mine(self, numblocks, mining_node):
         min_fee = Decimal("0.0001")
@@ -174,11 +177,6 @@ def transact_and_mine(self, numblocks, mining_node):
                     newmem.append(utx)
             self.memutxo = newmem
 
-    def import_deterministic_coinbase_privkeys(self):
-        self.start_nodes()
-        super().import_deterministic_coinbase_privkeys()
-        self.stop_nodes()
-
     def run_test(self):
         self.log.info("This test is time consuming, please be patient")
         self.log.info("Splitting inputs so we can generate tx's")
diff --git a/test/functional/feature_pruning.py b/test/functional/feature_pruning.py
@@ -105,6 +105,8 @@ def setup_network(self):
     def setup_nodes(self):
         self.add_nodes(self.num_nodes, self.extra_args)
         self.start_nodes()
+        for n in self.nodes:
+            n.importprivkey(privkey=n.get_deterministic_priv_key().key, label='coinbase', rescan=False)
 
     def create_big_chain(self):
         # Start by creating some coinbases we can spend later
diff --git a/test/functional/feature_spentindex.py b/test/functional/feature_spentindex.py
@@ -37,8 +37,8 @@ def setup_network(self):
         connect_nodes(self.nodes[0], 1)
         connect_nodes(self.nodes[0], 2)
         connect_nodes(self.nodes[0], 3)
-
         self.sync_all()
+        self.import_deterministic_coinbase_privkeys()
 
     def run_test(self):
         self.log.info("Test that settings can't be changed without -reindex...")
diff --git a/test/functional/feature_txindex.py b/test/functional/feature_txindex.py
@@ -35,8 +35,8 @@ def setup_network(self):
         connect_nodes(self.nodes[0], 1)
         connect_nodes(self.nodes[0], 2)
         connect_nodes(self.nodes[0], 3)
-
         self.sync_all()
+        self.import_deterministic_coinbase_privkeys()
 
     def run_test(self):
         self.log.info("Mining blocks...")
diff --git a/test/functional/interface_zmq.py b/test/functional/interface_zmq.py
@@ -73,6 +73,7 @@ def setup_nodes(self):
         ]
         self.add_nodes(self.num_nodes, self.extra_args)
         self.start_nodes()
+        self.import_deterministic_coinbase_privkeys()
 
     def run_test(self):
         try:
diff --git a/test/functional/p2p_node_network_limited.py b/test/functional/p2p_node_network_limited.py
@@ -43,8 +43,8 @@ def disconnect_all(self):
         disconnect_nodes(self.nodes[1], 2)
 
     def setup_network(self):
-        super(NodeNetworkLimitedTest, self).setup_network()
-        self.disconnect_all()
+        self.add_nodes(self.num_nodes, self.extra_args)
+        self.start_nodes()
 
     def run_test(self):
         node = self.nodes[0].add_p2p_connection(P2PIgnoreInv())
diff --git a/test/functional/rpc_deprecated.py b/test/functional/rpc_deprecated.py
@@ -4,21 +4,26 @@
 # file COPYING or http://www.opensource.org/licenses/mit-license.php.
 """Test deprecation of RPC calls."""
 from test_framework.test_framework import BitcoinTestFramework
+# from test_framework.util import assert_raises_rpc_error
 
 class DeprecatedRpcTest(BitcoinTestFramework):
     def set_test_params(self):
         self.num_nodes = 2
         self.setup_clean_chain = True
-        self.extra_args = [[], ["-deprecatedrpc=validateaddress"]]
+        self.extra_args = [[], []]
 
     def run_test(self):
         # This test should be used to verify correct behaviour of deprecated
         # RPC methods with and without the -deprecatedrpc flags. For example:
         #
-        # self.log.info("Make sure that -deprecatedrpc=createmultisig allows it to take addresses")
-        # assert_raises_rpc_error(-5, "Invalid public key", self.nodes[0].createmultisig, 1, [self.nodes[0].getnewaddress()])
-        # self.nodes[1].createmultisig(1, [self.nodes[1].getnewaddress()])
-        pass
+        # In set_test_params:
+        # self.extra_args = [[], ["-deprecatedrpc=generate"]]
+        #
+        # In run_test:
+        # self.log.info("Test generate RPC")
+        # assert_raises_rpc_error(-32, 'The wallet generate rpc method is deprecated', self.nodes[0].rpc.generate, 1)
+        # self.nodes[1].generate(1)
+        self.log.info("No tested deprecated RPC methods")
 
 if __name__ == '__main__':
     DeprecatedRpcTest().main()
diff --git a/test/functional/test_framework/test_framework.py b/test/functional/test_framework/test_framework.py
@@ -230,7 +230,6 @@ def main(self):
             self.skip_test_if_missing_module()
             self.setup_chain()
             self.setup_network()
-            self.import_deterministic_coinbase_privkeys()
             self.run_test()
             success = TestStatus.PASSED
         except JSONRPCException:
@@ -353,19 +352,17 @@ def setup_nodes(self):
             extra_args = self.extra_args
         self.add_nodes(self.num_nodes, extra_args)
         self.start_nodes()
+        self.import_deterministic_coinbase_privkeys()
 
     def import_deterministic_coinbase_privkeys(self):
-        if self.setup_clean_chain:
-            return
-
         for n in self.nodes:
             try:
                 n.getwalletinfo()
             except JSONRPCException as e:
                 assert str(e).startswith('Method not found')
                 continue
 
-            n.importprivkey(n.get_deterministic_priv_key().key)
+            n.importprivkey(privkey=n.get_deterministic_priv_key().key, label='coinbase')
 
     def run_test(self):
         """Tests must override this method to define test logic"""
@@ -925,6 +922,7 @@ def setup_network(self):
         self.log.info("Creating and starting controller node")
         self.add_nodes(1, extra_args=[self.extra_args[0]])
         self.start_node(0)
+        self.import_deterministic_coinbase_privkeys()
         required_balance = MASTERNODE_COLLATERAL * self.mn_count + 1
         self.log.info("Generating %d coins" % required_balance)
         while self.nodes[0].getbalance() < required_balance:
@@ -945,6 +943,7 @@ def setup_network(self):
         self.prepare_masternodes()
         self.prepare_datadirs()
         self.start_masternodes()
+        self.import_deterministic_coinbase_privkeys()
 
         # non-masternodes where disconnected from the control node during prepare_datadirs,
         # let's reconnect them back to make sure they receive updates
diff --git a/test/functional/test_framework/test_node.py b/test/functional/test_framework/test_node.py
@@ -264,6 +264,10 @@ def wait_for_rpc_connection(self):
             time.sleep(1.0 / poll_per_s)
         self._raise_assertion_error("Unable to connect to dashd")
 
+    def generate(self, nblocks, maxtries=1000000):
+        self.log.debug("TestNode.generate() dispatches `generate` call to `generatetoaddress`")
+        return self.generatetoaddress(nblocks=nblocks, address=self.get_deterministic_priv_key().address, maxtries=maxtries)
+
     def get_wallet_rpc(self, wallet_name):
         if self.use_cli:
             return self.cli("-rpcwallet={}".format(wallet_name))
diff --git a/test/functional/tool_wallet.py b/test/functional/tool_wallet.py
@@ -99,7 +99,7 @@ def test_tool_wallet_info(self):
             HD (hd seed available): no
             Keypool Size: 1
             Transactions: 0
-            Address Book: 0
+            Address Book: 1
         ''')
         self.assert_tool_output(out, '-wallet=wallet.dat', 'info')
 
@@ -114,7 +114,7 @@ def test_tool_wallet_info(self):
             HD (hd seed available): yes
             Keypool Size: 2
             Transactions: 0
-            Address Book: 0
+            Address Book: 1
         ''')
         self.assert_tool_output(out, '-wallet=wallet.dat', 'info')
         timestamp_after = self.wallet_timestamp()
@@ -151,9 +151,9 @@ def test_tool_wallet_info_after_transaction(self):
             ===========
             Encrypted: no
             HD (hd seed available): yes
-            Keypool Size: 1
+            Keypool Size: 2
             Transactions: 1
-            Address Book: 0
+            Address Book: 1
         ''')
         self.assert_tool_output(out, '-wallet=wallet.dat', 'info')
         shasum_after = self.wallet_shasum()
diff --git a/test/functional/wallet_basic.py b/test/functional/wallet_basic.py
@@ -31,10 +31,9 @@ def skip_test_if_missing_module(self):
         self.skip_if_no_wallet()
 
     def setup_network(self):
-        self.add_nodes(4, self.extra_args)
-        self.start_node(0)
-        self.start_node(1)
-        self.start_node(2)
+        self.setup_nodes()
+        # Only need nodes 0-2 running at start of test
+        self.stop_node(3)
         connect_nodes(self.nodes[0], 1)
         connect_nodes(self.nodes[1], 2)
         connect_nodes(self.nodes[0], 2)
diff --git a/test/functional/wallet_hd.py b/test/functional/wallet_hd.py
@@ -22,6 +22,7 @@ def set_test_params(self):
     def setup_network(self):
         self.add_nodes(self.num_nodes, self.extra_args)
         self.start_nodes()
+        self.import_deterministic_coinbase_privkeys()
 
     def skip_test_if_missing_module(self):
         self.skip_if_no_wallet()
diff --git a/test/functional/wallet_import_rescan.py b/test/functional/wallet_import_rescan.py
diff --git a/test/functional/wallet_keypool.py b/test/functional/wallet_keypool.py
diff --git a/test/functional/wallet_keypool_hd.py b/test/functional/wallet_keypool_hd.py
diff --git a/test/functional/wallet_labels.py b/test/functional/wallet_labels.py
diff --git a/test/functional/wallet_listreceivedby.py b/test/functional/wallet_listreceivedby.py
diff --git a/test/functional/wallet_multiwallet.py b/test/functional/wallet_multiwallet.py
diff --git a/test/functional/wallet_upgradetohd.py b/test/functional/wallet_upgradetohd.py

Original file line number	Diff line number	Diff line change
`@@ -4772,17 +4772,6 @@ void CWallet::MarkReserveKeysAsUsed(int64_t keypool_id)`
`4772`	`4772`	`}`
`4773`	`4773`	`}`
`4774`	`4774`
`4775`		`-void CWallet::GetScriptForMining(std::shared_ptr<CReserveScript> &script)`
`4776`		`-{`
`4777`		`- std::shared_ptr<CReserveKey> rKey = std::make_shared<CReserveKey>(this);`
`4778`		`- CPubKey pubkey;`
`4779`		`- if (!rKey->GetReservedKey(pubkey, false))`
`4780`		`- return;`
`4781`		`-`
`4782`		`- script = rKey;`
`4783`		`- script->reserveScript = CScript() << ToByteVector(pubkey) << OP_CHECKSIG;`
`4784`		`-}`
`4785`		`-`
`4786`	`4775`	`void CWallet::LockCoin(const COutPoint& output)`
`4787`	`4776`	`{`
`4788`	`4777`	`AssertLockHeld(cs_wallet);`
Original file line number	Diff line number	Diff line change
`@@ -1177,8 +1177,6 @@ class CWallet final : public CCryptoKeyStore, private interfaces::Chain::Notific`
`1177`	`1177`
`1178`	`1178`	`bool DelAddressBook(const CTxDestination& address);`
`1179`	`1179`
`1180`		`- void GetScriptForMining(std::shared_ptr<CReserveScript> &script);`
`1181`		`-`
`1182`	`1180`	`unsigned int GetKeyPoolSize() EXCLUSIVE_LOCKS_REQUIRED(cs_wallet)`
`1183`	`1181`	`{`
`1184`	`1182`	`AssertLockHeld(cs_wallet);`