zenith-openrpc.json

@@ -194,7 +194,7 @@
         {
           "name": "ListAddresses example",
           "summary": "Get list of addresses",
-          "description": "Get the list of addresses available in Zenith for the given wallet ID",
+          "description": "Get the list of addresses available in Zenith for the given account ID",
           "params": [
             {
               "name": "accountId", 
@@ -248,13 +248,21 @@
       "summary": "Get the balance of the given account",
       "description": "Get the balance of the given account, including any unconfirmed balance.",
       "tags": [{"$ref": "#/components/tags/draft"},{"$ref": "#/components/tags/wip"}],
-      "params": [],
+      "params": [{ "$ref": "#/components/contentDescriptors/AccountId"}],
       "result": {
         "name": "Balance",
         "schema": {
+          "type": "object",
+          "properties": {
+            "confirmed": {"$ref": "#/components/schemas/Balance" },
+            "unconfirmed": {"$ref": "#/components/schemas/Balance" }
           }
         }
       },
+      "errors": [
+        { "$ref": "#/components/errors/InvalidAccount" }
+      ]
+    },
     {
       "name": "listreceived",
       "summary": "List received transactions",
@@ -456,6 +464,14 @@
           "outindex": { "type": "integer", "description": "The Sapling output index, or the Orchard action index"},
           "change": { "type": "boolean", "description": "True if this output was received by a change address"}
         }
+      },
+      "Balance": {
+        "type": "object",
+        "properties": {
+              "transparent": { "type": "integer", "description": "Confirmed transparent balance in zats." },
+              "sapling": { "type": "integer", "description": "Confirmed Sapling balance in zats." },
+              "orchard": { "type": "integer", "description": "Confirmed Orchard balance in zats." }
+        }
       }
     },
 	  "examples": {},
@@ -487,8 +503,11 @@
       "InvalidAddress": {
         "code": -32005,
         "message": "Unable to parse address"
-      }
-
+      },
+      "InvalidAccount": {
+        "code": -32006,
+        "message": "Account does not exist."
+      }
     }
   }
 }