Simple, backwards compatible RPC multiwallet support.

ryanofsky · ryanofsky · commit 21eeaa43d415 · 2017-07-04T12:05:18.000-04:00
This change allows existing RPCs to work on multiple wallets by calling those
RPCs with a wallet=filename named argument. Example usage:

    bitcoind -regtest -wallet=w1.dat -wallet=w2.dat
    bitcoin-cli -regtest -named getwalletinfo wallet=w1.dat
    bitcoin-cli -regtest -named getwalletinfo wallet=w2.dat
    bitcoin-cli -regtest -named getbalance wallet=w2.dat

Individual RPCs can override handling of the wallet named argument, but if they
don't, the `GetWalletForJSONRPCRequest` function will automatically chose the
right wallet based on the argument value.

This change only allows JSON-RPC calls made with named arguments to access
multiple wallets. JSON-RPC calls made with positional arguments will still
continue to access the default wallet as before.

Multiwallet python test based on code originally written by
Jonas Schnelli &lt;dev@jonasschnelli.ch&gt;
diff --git a/src/rpc/server.cpp b/src/rpc/server.cpp
@@ -213,6 +213,12 @@ std::string CRPCTable::help(const std::string& strCommand, const JSONRPCRequest&
                     std::string firstLetter = category.substr(0,1);
                     boost::to_upper(firstLetter);
                     strRet += "== " + firstLetter + category.substr(1) + " ==\n";
+                    if (category == "wallet") {
+                        strRet += "\nWhen more than one wallet is loaded (multiple -`wallet=filename` options passed\n"
+                                  "to bitcoind), wallet RPCs must be called with an extra named JSON-RPC `wallet`\n"
+                                  "parameter containing the wallet filename to disambiguate which wallet file the\n"
+                                  "RPC is intended for. Failure to specify will result in method disabled errors.\n\n";
+                    }
                 }
             }
             strRet += strHelp + "\n";
@@ -472,6 +478,11 @@ static inline JSONRPCRequest transformNamedArguments(const JSONRPCRequest& in, c
             hole += 1;
         }
     }
+    auto wallet = argsIn.find("wallet");
+    if (wallet != argsIn.end() && wallet->second->isStr()) {
+        out.wallet = wallet->second->getValStr();
+        argsIn.erase(wallet);
+    }
     // If there are still arguments in the argsIn map, this is an error.
     if (!argsIn.empty()) {
         throw JSONRPCError(RPC_INVALID_PARAMETER, "Unknown named parameter " + argsIn.begin()->first);
diff --git a/src/rpc/server.h b/src/rpc/server.h
@@ -42,11 +42,25 @@ class JSONRPCRequest
 public:
     UniValue id;
     std::string strMethod;
+    /**
+     * Parameters from JSON-RPC request.
+     * This will be either an object or an array when the JSONRPCRequest object is
+     * originally created and parsed. But it will be transformed into an
+     * array before being passed to the RPC method implementation (using the
+     * list of named arguments provided by the implementation).
+     */
     UniValue params;
     bool fHelp;
     std::string URI;
     std::string authUser;
 
+    /**
+     * Optional wallet name, set for backwards compatibility if the RPC method
+     * was called with a named "wallet" parameter and the RPC method
+     * implementation doesn't handle it itself.
+     */
+    std::string wallet;
+
     JSONRPCRequest() : id(NullUniValue), params(NullUniValue), fHelp(false) {}
     void parse(const UniValue& valRequest);
 };
diff --git a/src/wallet/rpcwallet.cpp b/src/wallet/rpcwallet.cpp
@@ -32,8 +32,15 @@
 
 CWallet *GetWalletForJSONRPCRequest(const JSONRPCRequest& request)
 {
-    // TODO: Some way to access secondary wallets
-    return vpwallets.empty() ? nullptr : vpwallets[0];
+    if (!request.wallet.empty()) {
+        for (const auto& wallet : ::vpwallets) {
+            if (request.wallet == wallet->GetName()) {
+                return wallet;
+            }
+        }
+        throw JSONRPCError(RPC_INVALID_PARAMETER, "Requested wallet does not exist or is not loaded");
+    }
+    return ::vpwallets.size() == 1 || (request.fHelp && ::vpwallets.size() > 0) ? ::vpwallets[0] : nullptr;
 }
 
 std::string HelpRequiringPassphrase(CWallet * const pwallet)
diff --git a/test/functional/multiwallet.py b/test/functional/multiwallet.py
@@ -0,0 +1,45 @@
+#!/usr/bin/env python3
+# Copyright (c) 2017 The Bitcoin Core developers
+# Distributed under the MIT software license, see the accompanying
+# file COPYING or http://www.opensource.org/licenses/mit-license.php.
+"""Test the wallet."""
+from test_framework.test_framework import BitcoinTestFramework
+from test_framework.util import *
+
+class MultiWalletTest(BitcoinTestFramework):
+
+    def __init__(self):
+        super().__init__()
+        self.setup_clean_chain = True
+        self.num_nodes = 1
+        self.extra_args = [['-wallet=w1', '-wallet=w2','-wallet=w3']]
+
+    def setup_network(self):
+        self.nodes = self.start_nodes(1, self.options.tmpdir, self.extra_args[:1])
+
+    def run_test(self):
+        self.nodes[0].generate(nblocks=1, wallet="w1")
+
+        #check default wallet balance
+        assert_raises_jsonrpc(-32601, "Method not found (disabled)", self.nodes[0].getwalletinfo)
+
+        #check w1 wallet balance
+        walletinfo = self.nodes[0].getwalletinfo(wallet="w1")
+        assert_equal(walletinfo['immature_balance'], 50)
+
+        #check w1 wallet balance
+        walletinfo = self.nodes[0].getwalletinfo(wallet="w2")
+        assert_equal(walletinfo['immature_balance'], 0)
+
+        self.nodes[0].generate(nblocks=101, wallet="w1")
+        assert_equal(self.nodes[0].getbalance(wallet="w1"), 100)
+        assert_equal(self.nodes[0].getbalance(wallet="w2"), 0)
+        assert_equal(self.nodes[0].getbalance(wallet="w3"), 0)
+
+        huh=self.nodes[0].getnewaddress(wallet="w2")
+        self.nodes[0].sendtoaddress(address=huh, amount=1, wallet="w1")
+        self.nodes[0].generate(nblocks=1, wallet="w1")
+        assert_equal(self.nodes[0].getbalance(wallet="w2"), 1)
+
+if __name__ == '__main__':
+    MultiWalletTest().main()
diff --git a/test/functional/test_runner.py b/test/functional/test_runner.py
@@ -63,6 +63,7 @@
     'segwit.py',
     # vv Tests less than 2m vv
     'wallet.py',
+    'multiwallet.py',
     'wallet-accounts.py',
     'p2p-segwit.py',
     'wallet-dump.py',

Original file line number	Diff line number	Diff line change
`@@ -213,6 +213,12 @@ std::string CRPCTable::help(const std::string& strCommand, const JSONRPCRequest&`
`213`	`213`	`std::string firstLetter = category.substr(0,1);`
`214`	`214`	`boost::to_upper(firstLetter);`
`215`	`215`	`strRet += "== " + firstLetter + category.substr(1) + " ==\n";`
	`216`	`+ if (category == "wallet") {`
	`217`	+ strRet += "\nWhen more than one wallet is loaded (multiple -`wallet=filename` options passed\n"
	`218`	+ "to bitcoind), wallet RPCs must be called with an extra named JSON-RPC `wallet`\n"
	`219`	`+ "parameter containing the wallet filename to disambiguate which wallet file the\n"`
	`220`	`+ "RPC is intended for. Failure to specify will result in method disabled errors.\n\n";`
	`221`	`+ }`
`216`	`222`	`}`
`217`	`223`	`}`
`218`	`224`	`strRet += strHelp + "\n";`
`@@ -472,6 +478,11 @@ static inline JSONRPCRequest transformNamedArguments(const JSONRPCRequest& in, c`
`472`	`478`	`hole += 1;`
`473`	`479`	`}`
`474`	`480`	`}`
	`481`	`+ auto wallet = argsIn.find("wallet");`
	`482`	`+ if (wallet != argsIn.end() && wallet->second->isStr()) {`
	`483`	`+ out.wallet = wallet->second->getValStr();`
	`484`	`+ argsIn.erase(wallet);`
	`485`	`+ }`
`475`	`486`	`// If there are still arguments in the argsIn map, this is an error.`
`476`	`487`	`if (!argsIn.empty()) {`
`477`	`488`	`throw JSONRPCError(RPC_INVALID_PARAMETER, "Unknown named parameter " + argsIn.begin()->first);`