Updated the documentation for getBalances.

DeFiCh · Jun 11, 2021 · dd5b8fd · dd5b8fd
1 parent ce8d998
commit dd5b8fd
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 0 deletions.
diff --git a/packages/jellyfish-api-core/src/category/wallet.ts b/packages/jellyfish-api-core/src/category/wallet.ts
@@ -64,6 +64,9 @@ export class Wallet {
 
   /**
    * Returns an object with all balances
+   *
+   * @param {boolean} withTokens = false, Include tokens balances; Default is 'false' for backward compatibility.
+   * @return {Promise<WalletBalance>}
    */
   async getBalances (withTokens = false): Promise<WalletBalance> {
     return await this.client.call('getbalances', [withTokens], 'bignumber')

diff --git a/website/docs/jellyfish/api/wallet.md b/website/docs/jellyfish/api/wallet.md
@@ -29,6 +29,34 @@ interface wallet {
 }
 ```
 
+## getBalances
+
+Returns an object with all balances.
+
+```ts title="client.wallet.getBalances()"
+interface wallet {
+  getBalances(withTokens = false): Promise<WalletBalance>
+}
+
+interface WalletBalance {
+  mine: WalletMineBalance
+  watchonly?: WalletWatchOnlyBalance
+}
+
+interface WalletMineBalance {
+  trusted: BigNumber
+  untrusted_pending: BigNumber
+  immature: BigNumber
+  used?: BigNumber
+}
+
+interface WalletWatchOnlyBalance {
+  trusted: BigNumber
+  untrusted_pending: BigNumber
+  immature: BigNumber
+}
+```
+
 ## listUnspent
 
 Get list of UTXOs in wallet.