Merge #11055: [wallet] [rpc] getreceivedbyaddress should return error if called with address not owned by the wallet

5e0ba8f8c [wallet] getreceivedbyaddress should return error if address is not mine (John Newbery)
ea0cd24f7 [tests] Tidy up receivedby.py (John Newbery)

Pull request description:

  Two commits:

  - First commit tidies up the `receivedby.py` test (and speeds it up by factor of two)
  - Second commit changes getreceivedbyaddress to return error if the address is not found in wallet, and adds test to `receivedby.py`

Tree-SHA512: e41342dcbd037a6b440cbe4ecd3b8ed589e18e477333f0d866f3564e948e0f5231e497d5ffb66da4e6680eb772d9f0cf839125098bb68b92d04a5ee35c6c0a81

src/wallet/rpcwallet.cpp

@@ -654,7 +654,7 @@ UniValue getreceivedbyaddress(const JSONRPCRequest& request)
     }
     CScript scriptPubKey = GetScriptForDestination(dest);
     if (!IsMine(*pwallet, scriptPubKey)) {
-        return ValueFromAmount(0);
+        throw JSONRPCError(RPC_WALLET_ERROR, "Address not found in wallet");
     }
 
     // Minimum confirmations

test/functional/receivedby.py

@@ -3,97 +3,83 @@
 # Distributed under the MIT software license, see the accompanying
 # file COPYING or http://www.opensource.org/licenses/mit-license.php.
 """Test the listreceivedbyaddress RPC."""
+from decimal import Decimal
 
 from test_framework.test_framework import BitcoinTestFramework
-from test_framework.util import *
+from test_framework.util import (assert_array_result,
-
+                                 assert_equal,
-def get_sub_array_from_array(object_array, to_match):
+                                 assert_raises_rpc_error,
-    '''
+                                 )
-        Finds and returns a sub array from an array of arrays.
-        to_match should be a unique idetifier of a sub array
-    '''
-    for item in object_array:
-        all_match = True
-        for key,value in to_match.items():
-            if item[key] != value:
-                all_match = False
-        if not all_match:
-            continue
-        return item
-    return []
 
 class ReceivedByTest(BitcoinTestFramework):
     def set_test_params(self):
         self.num_nodes = 2
-        self.enable_mocktime()
 
     def run_test(self):
-        '''
+        # Generate block to get out of IBD
-        listreceivedbyaddress Test
+        self.nodes[0].generate(1)
-        '''
+
+        self.log.info("listreceivedbyaddress Test")
+
         # Send from node 0 to 1
         addr = self.nodes[1].getnewaddress()
         txid = self.nodes[0].sendtoaddress(addr, 0.1)
         self.sync_all()
 
-        #Check not listed in listreceivedbyaddress because has 0 confirmations
+        # Check not listed in listreceivedbyaddress because has 0 confirmations
         assert_array_result(self.nodes[1].listreceivedbyaddress(),
-                           {"address":addr},
+                            {"address": addr},
-                           { },
+                            {},
-                           True)
+                            True)
-        #Bury Tx under 10 block so it will be returned by listreceivedbyaddress
+        # Bury Tx under 10 block so it will be returned by listreceivedbyaddress
         self.nodes[1].generate(10)
         self.sync_all()
         assert_array_result(self.nodes[1].listreceivedbyaddress(),
-                           {"address":addr},
+                            {"address": addr},
-                           {"address":addr, "account":"", "amount":Decimal("0.1"), "confirmations":10, "txids":[txid,]})
+                            {"address": addr, "account": "", "amount": Decimal("0.1"), "confirmations": 10, "txids": [txid, ]})
-        #With min confidence < 10
+        # With min confidence < 10
         assert_array_result(self.nodes[1].listreceivedbyaddress(5),
-                           {"address":addr},
+                            {"address": addr},
-                           {"address":addr, "account":"", "amount":Decimal("0.1"), "confirmations":10, "txids":[txid,]})
+                            {"address": addr, "account": "", "amount": Decimal("0.1"), "confirmations": 10, "txids": [txid, ]})
-        #With min confidence > 10, should not find Tx
+        # With min confidence > 10, should not find Tx
-        assert_array_result(self.nodes[1].listreceivedbyaddress(11),{"address":addr},{ },True)
+        assert_array_result(self.nodes[1].listreceivedbyaddress(11), {"address": addr}, {}, True)
 
-        #Empty Tx
+        # Empty Tx
         addr = self.nodes[1].getnewaddress()
-        assert_array_result(self.nodes[1].listreceivedbyaddress(0,True),
+        assert_array_result(self.nodes[1].listreceivedbyaddress(0, True),
-                           {"address":addr},
+                            {"address": addr},
-                           {"address":addr, "account":"", "amount":0, "confirmations":0, "txids":[]})
+                            {"address": addr, "account": "", "amount": 0, "confirmations": 0, "txids": []})
+
+        self.log.info("getreceivedbyaddress Test")
 
-        '''
-            getreceivedbyaddress Test
-        '''
         # Send from node 0 to 1
         addr = self.nodes[1].getnewaddress()
         txid = self.nodes[0].sendtoaddress(addr, 0.1)
         self.sync_all()
 
-        #Check balance is 0 because of 0 confirmations
+        # Check balance is 0 because of 0 confirmations
         balance = self.nodes[1].getreceivedbyaddress(addr)
-        if balance != Decimal("0.0"):
+        assert_equal(balance, Decimal("0.0"))
-            raise AssertionError("Wrong balance returned by getreceivedbyaddress, %0.2f"%(balance))
 
-        #Check balance is 0.1
+        # Check balance is 0.1
-        balance = self.nodes[1].getreceivedbyaddress(addr,0)
+        balance = self.nodes[1].getreceivedbyaddress(addr, 0)
-        if balance != Decimal("0.1"):
+        assert_equal(balance, Decimal("0.1"))
-            raise AssertionError("Wrong balance returned by getreceivedbyaddress, %0.2f"%(balance))
 
-        #Bury Tx under 10 block so it will be returned by the default getreceivedbyaddress
+        # Bury Tx under 10 block so it will be returned by the default getreceivedbyaddress
         self.nodes[1].generate(10)
         self.sync_all()
         balance = self.nodes[1].getreceivedbyaddress(addr)
-        if balance != Decimal("0.1"):
+        assert_equal(balance, Decimal("0.1"))
-            raise AssertionError("Wrong balance returned by getreceivedbyaddress, %0.2f"%(balance))
 
-        '''
+        # Trying to getreceivedby for an address the wallet doesn't own should return an error
-            listreceivedbyaccount + getreceivedbyaccount Test
+        assert_raises_rpc_error(-4, "Address not found in wallet", self.nodes[0].getreceivedbyaddress, addr)
-        '''
+
-        #set pre-state
+        self.log.info("listreceivedbyaccount + getreceivedbyaccount Test")
+
+        # set pre-state
         addrArr = self.nodes[1].getnewaddress()
         account = self.nodes[1].getaccount(addrArr)
-        received_by_account_json = get_sub_array_from_array(self.nodes[1].listreceivedbyaccount(),{"account":account})
+        received_by_account_json = [r for r in self.nodes[1].listreceivedbyaccount() if r["account"] == account][0]
-        if len(received_by_account_json) == 0:
-            raise AssertionError("No accounts found in node")
         balance_by_account = self.nodes[1].getreceivedbyaccount(account)
 
         txid = self.nodes[0].sendtoaddress(addr, 0.1)
@@ -101,40 +87,34 @@ class ReceivedByTest(BitcoinTestFramework):
 
         # listreceivedbyaccount should return received_by_account_json because of 0 confirmations
         assert_array_result(self.nodes[1].listreceivedbyaccount(),
-                           {"account":account},
+                            {"account": account},
-                           received_by_account_json)
+                            received_by_account_json)
 
         # getreceivedbyaddress should return same balance because of 0 confirmations
         balance = self.nodes[1].getreceivedbyaccount(account)
-        if balance != balance_by_account:
+        assert_equal(balance, balance_by_account)
-            raise AssertionError("Wrong balance returned by getreceivedbyaccount, %0.2f"%(balance))
 
         self.nodes[1].generate(10)
         self.sync_all()
         # listreceivedbyaccount should return updated account balance
         assert_array_result(self.nodes[1].listreceivedbyaccount(),
-                           {"account":account},
+                            {"account": account},
-                           {"account":received_by_account_json["account"], "amount":(received_by_account_json["amount"] + Decimal("0.1"))})
+                            {"account": received_by_account_json["account"], "amount": (received_by_account_json["amount"] + Decimal("0.1"))})
 
         # getreceivedbyaddress should return updates balance
         balance = self.nodes[1].getreceivedbyaccount(account)
-        if balance != balance_by_account + Decimal("0.1"):
+        assert_equal(balance, balance_by_account + Decimal("0.1"))
-            raise AssertionError("Wrong balance returned by getreceivedbyaccount, %0.2f"%(balance))
 
-        #Create a new account named "mynewaccount" that has a 0 balance
+        # Create a new account named "mynewaccount" that has a 0 balance
         self.nodes[1].getaccountaddress("mynewaccount")
-        received_by_account_json = get_sub_array_from_array(self.nodes[1].listreceivedbyaccount(0,True),{"account":"mynewaccount"})
+        received_by_account_json = [r for r in self.nodes[1].listreceivedbyaccount(0, True) if r["account"] == "mynewaccount"][0]
-        if len(received_by_account_json) == 0:
-            raise AssertionError("No accounts found in node")
 
         # Test includeempty of listreceivedbyaccount
-        if received_by_account_json["amount"] != Decimal("0.0"):
+        assert_equal(received_by_account_json["amount"], Decimal("0.0"))
-            raise AssertionError("Wrong balance returned by listreceivedbyaccount, %0.2f"%(received_by_account_json["amount"]))
 
         # Test getreceivedbyaccount for 0 amount accounts
         balance = self.nodes[1].getreceivedbyaccount("mynewaccount")
-        if balance != Decimal("0.0"):
+        assert_equal(balance, Decimal("0.0"))
-            raise AssertionError("Wrong balance returned by getreceivedbyaccount, %0.2f"%(balance))
 
 if __name__ == '__main__':
     ReceivedByTest().main()