Renamed the interface WalletBalance, WalletMineBalance and WalletWatc…

…hOnlyBalance to WalletBalances, WalletMineBalances and WalletWatchOnlyBalances respectively.
DeFiCh · Jun 11, 2021 · 2edd638 · 2edd638
1 parent dd5b8fd
commit 2edd638
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 13 deletions.
diff --git a/packages/jellyfish-api-core/src/category/wallet.ts b/packages/jellyfish-api-core/src/category/wallet.ts
@@ -66,9 +66,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>}
+   * @return {Promise<WalletBalances>}
    */
-  async getBalances (withTokens = false): Promise<WalletBalance> {
+  async getBalances (withTokens = false): Promise<WalletBalances> {
     return await this.client.call('getbalances', [withTokens], 'bignumber')
   }
 
@@ -473,19 +473,19 @@ export interface InWalletTransactionDetail {
   abandoned: boolean
 }
 
-export interface WalletBalance {
-  mine: WalletMineBalance
-  watchonly?: WalletWatchOnlyBalance
+export interface WalletBalances {
+  mine: WalletMineBalances
+  watchonly?: WalletWatchOnlyBalances
 }
 
-export interface WalletMineBalance {
+export interface WalletMineBalances {
   trusted: BigNumber
   untrusted_pending: BigNumber
   immature: BigNumber
   used?: BigNumber
 }
 
-export interface WalletWatchOnlyBalance {
+export interface WalletWatchOnlyBalances {
   trusted: BigNumber
   untrusted_pending: BigNumber
   immature: BigNumber

diff --git a/website/docs/jellyfish/api/wallet.md b/website/docs/jellyfish/api/wallet.md
@@ -35,22 +35,22 @@ Returns an object with all balances.
 
 ```ts title="client.wallet.getBalances()"
 interface wallet {
-  getBalances(withTokens = false): Promise<WalletBalance>
+  getBalances(withTokens = false): Promise<WalletBalances>
 }
 
-interface WalletBalance {
-  mine: WalletMineBalance
-  watchonly?: WalletWatchOnlyBalance
+interface WalletBalances {
+  mine: WalletMineBalances
+  watchonly?: WalletWatchOnlyBalances
 }
 
-interface WalletMineBalance {
+interface WalletMineBalances {
   trusted: BigNumber
   untrusted_pending: BigNumber
   immature: BigNumber
   used?: BigNumber
 }
 
-interface WalletWatchOnlyBalance {
+interface WalletWatchOnlyBalances {
   trusted: BigNumber
   untrusted_pending: BigNumber
   immature: BigNumber