Merge #1285: Fix rpc balance

75a93df fix available_balance (Adam Gibson)
ea6c34d update yaml for new available_balance fields (Adam Gibson)
08581f8 Fixes json serialization of wallet display (Adam Gibson)

docs/api/wallet-rpc.yaml

@@ -773,6 +773,8 @@ components:
               type: string
             total_balance: 
               type: string
+            available_balance:
+              type: string
             accounts: 
               type: array
               items: 
@@ -782,6 +784,8 @@ components:
                     type: string
                   account_balance: 
                     type: string
+                  available_balance:
+                    type: string
                   branches: 
                     type: array
                     items: 
@@ -791,6 +795,8 @@ components:
                           type: string
                         balance: 
                           type: string
+                        available_balance:
+                          type: string
                         entries: 
                           type: array
                           items: 
@@ -802,6 +808,8 @@ components:
                                 type: string
                               amount: 
                                 type: string
+                              available_balance:
+                                type: string
                               status:
                                 type: string
                               label:

jmclient/jmclient/wallet_utils.py

@@ -145,15 +145,26 @@ class WalletViewBase(object):
     def get_available_balance(self):
         return sum([x.get_available_balance() for x in self.children])
 
+    def get_balances(self, include_unconf=True):
+        return (self.get_balance(include_unconf=include_unconf),
+                self.get_available_balance())
+
     def get_fmt_balance(self, include_unconf=True):
-        available_balance = self.get_available_balance()
+        total_balance, available_balance = self.get_balances(
-        total_balance = self.get_balance(include_unconf)
+            include_unconf=include_unconf)
         if available_balance != total_balance:
             return "{0:.08f} ({1:.08f})".format(available_balance, total_balance)
         else:
             return "{0:.08f}".format(total_balance)
 
+    def get_fmt_balance_json(self, include_unconf=True):
+        total_balance, available_balance = self.get_balances(
+            include_unconf=include_unconf)
+        return {self.balance_key_name: "{0:.08f}".format(total_balance),
+                "available_balance": "{0:.08f}".format(available_balance)}
+
 class WalletViewEntry(WalletViewBase):
+    balance_key_name = "amount"
     def __init__(self, wallet_path_repr, account, address_type, aindex, addr, amounts,
                  status = 'new', serclass=str, priv=None, custom_separator=None,
                  label=None):
@@ -201,12 +212,13 @@ class WalletViewEntry(WalletViewBase):
             left, addr, amounts, status, label, extradata]))
 
     def serialize_json(self):
-        return {"hd_path": self.wallet_path_repr,
+        json_serialized = {"hd_path": self.wallet_path_repr,
                 "address": self.serialize_address(),
-                "amount": self.serialize_amounts(),
                 "status": self.serialize_status(),
                 "label": self.serialize_label(),
                 "extradata": self.serialize_extra_data()}
+        json_serialized.update(self.get_fmt_balance_json())
+        return json_serialized
 
     def serialize_wallet_position(self):
         return self.wallet_path_repr.ljust(20)
@@ -244,6 +256,7 @@ class WalletViewEntryBurnOutput(WalletViewEntry):
         return 0
 
 class WalletViewBranch(WalletViewBase):
+    balance_key_name = "balance"
     def __init__(self, wallet_path_repr, account, address_type, branchentries=None,
                  xpub=None, serclass=str, custom_separator=None):
         super().__init__(wallet_path_repr, children=branchentries,
@@ -271,9 +284,10 @@ class WalletViewBranch(WalletViewBase):
     def serialize_json(self, summarize=False):
         if summarize:
             return {}
-        return {"branch": self.serialize_branch_header(),
+        json_serialized = {"branch": self.serialize_branch_header(),
-                "balance": self.get_fmt_balance(),
          "entries": [x.serialize_json() for x in self.branchentries]}
+        json_serialized.update(self.get_fmt_balance_json())
+        return json_serialized
 
     def serialize_branch_header(self):
         start = "external addresses" if self.address_type == 0 else "internal addresses"
@@ -283,6 +297,7 @@ class WalletViewBranch(WalletViewBase):
                                                   self.xpub]))
 
 class WalletViewAccount(WalletViewBase):
+    balance_key_name = "account_balance"
     def __init__(self, wallet_path_repr, account, branches=None, account_name="mixdepth",
                  serclass=str, custom_separator=None, xpub=None):
         super().__init__(wallet_path_repr, children=branches, serclass=serclass,
@@ -310,14 +325,15 @@ class WalletViewAccount(WalletViewBase):
                 x.serialize(entryseparator) for x in self.branches] + [footer]))
 
     def serialize_json(self, summarize=False):
-        result = {"account": str(self.account),
+        json_serialized = {"account": str(self.account)}
-                    "account_balance": self.get_fmt_balance()}
+        json_serialized.update(self.get_fmt_balance_json())
         if summarize:
-            return result
+            return json_serialized
-        result["branches"] = [x.serialize_json() for x in self.branches]
+        json_serialized["branches"] = [x.serialize_json() for x in self.branches]
-        return result
+        return json_serialized
 
 class WalletView(WalletViewBase):
+    balance_key_name = "total_balance"
     def __init__(self, wallet_path_repr, accounts, wallet_name="JM wallet",
                  serclass=str, custom_separator=None):
         super().__init__(wallet_path_repr, children=accounts, serclass=serclass,
@@ -341,9 +357,10 @@ class WalletView(WalletViewBase):
                 x.serialize(entryseparator, summarize=False) for x in self.accounts] + [footer]))
 
     def serialize_json(self, summarize=False):
-        return {"wallet_name": self.wallet_name,
+        json_serialized = {"wallet_name": self.wallet_name,
-                "total_balance": self.get_fmt_balance(),
                 "accounts": [x.serialize_json(summarize=summarize) for x in self.accounts]}
+        json_serialized.update(self.get_fmt_balance_json())
+        return json_serialized
 
 def get_tx_info(txid, tx_cache=None):
     """

jmclient/test/test_wallet_rpc.py

@@ -342,6 +342,13 @@ class TrialTestWRPC_DisplayWallet(WalletRPCTestBase, unittest.TestCase):
         assert wia[0]["branches"][0]["entries"][0]["hd_path"] == "m/84'/1'/0'/0/0"
         assert wia[1]["branches"][0]["entries"][1]["status"] == "used"
         assert wia[1]["branches"][0]["entries"][1]["extradata"] == ""
+        # currently this test only produces output with available_balance = balance,
+        # at every level in the tree (no freeze here), but could add TODO
+        assert wi["available_balance"] == wi["total_balance"]
+        assert all([wia[i]["account_balance"] == wia[i][
+            "available_balance"] for i in range(len(wia))])
+        assert all([x["balance"] == x["available_balance"] for x in wia[
+            0]["branches"]])
 
     @defer.inlineCallbacks
     def test_getaddress(self):