Added listCommunityBalances RPC

packages/jellyfish-api-core/__tests__/category/account/listCommunityBalances.test.ts

@@ -0,0 +1,30 @@
+import { MasterNodeRegTestContainer } from '@defichain/testcontainers'
+import { ContainerAdapterClient } from '../../container_adapter_client'
+import { BigNumber } from '@defichain/jellyfish-json'
+
+describe('Account', () => {
+  const container = new MasterNodeRegTestContainer()
+  const client = new ContainerAdapterClient(container)
+
+  beforeAll(async () => {
+    await container.start()
+    await container.waitForReady()
+  })
+
+  afterAll(async () => {
+    await container.stop()
+  })
+
+  it('should listCommunityBalances', async () => {
+    const data = await client.account.listCommunityBalances()
+
+    expect(data.AnchorReward instanceof BigNumber).toStrictEqual(true)
+    expect(data.IncentiveFunding instanceof BigNumber).toStrictEqual(true)
+    expect(data.Burnt instanceof BigNumber).toStrictEqual(true)
+    expect(data.Swap).toBeUndefined()
+    expect(data.Futures).toBeUndefined()
+    expect(data.Options).toBeUndefined()
+    expect(data.Unallocated).toBeUndefined()
+    expect(data.Unknown).toBeUndefined()
+  })
+})

packages/jellyfish-api-core/src/category/account.ts

@@ -12,7 +12,7 @@ export enum OwnerType {
 }
 
 export enum DfTxType {
-  MINT_TOKEN ='M',
+  MINT_TOKEN = 'M',
   POOL_SWAP = 's',
   ADD_POOL_LIQUIDITY = 'l',
   REMOVE_POOL_LIQUIDITY = 'r',
@@ -73,7 +73,7 @@ export class Account {
    * @param {boolean} [options.isMineOnly=false] get balances about all accounts belonging to the wallet
    * @return {Promise<Array<AccountResult<string, string>>>}
    */
-  listAccounts (pagination: AccountPagination, verbose: false, options: {indexedAmounts: false, isMineOnly: boolean}): Promise<Array<AccountResult<string, string>>>
+  listAccounts (pagination: AccountPagination, verbose: false, options: { indexedAmounts: false, isMineOnly: boolean }): Promise<Array<AccountResult<string, string>>>
 
   /**
    * Get information about all accounts on chain
@@ -89,7 +89,7 @@ export class Account {
    * @param {boolean} [options.isMineOnly=false] get balances about all accounts belonging to the wallet
    * @return {Promise<Array<AccountResult<AccountOwner, AccountAmount>>>}
    */
-  listAccounts (pagination: AccountPagination, verbose: true, options: {indexedAmounts: true, isMineOnly: boolean}): Promise<Array<AccountResult<AccountOwner, AccountAmount>>>
+  listAccounts (pagination: AccountPagination, verbose: true, options: { indexedAmounts: true, isMineOnly: boolean }): Promise<Array<AccountResult<AccountOwner, AccountAmount>>>
 
   /**
    * Get information about all accounts on chain
@@ -105,7 +105,7 @@ export class Account {
    * @param {boolean} [options.isMineOnly=false] get balances about all accounts belonging to the wallet
    * @return {Promise<Array<AccountResult<string, AccountAmount>>>}
    */
-  listAccounts (pagination: AccountPagination, verbose: false, options: {indexedAmounts: true, isMineOnly: boolean}): Promise<Array<AccountResult<string, AccountAmount>>>
+  listAccounts (pagination: AccountPagination, verbose: false, options: { indexedAmounts: true, isMineOnly: boolean }): Promise<Array<AccountResult<string, AccountAmount>>>
 
   async listAccounts<T, U> (
     pagination: AccountPagination = { limit: 100 },
@@ -311,6 +311,15 @@ export class Account {
   ): Promise<number> {
     return await this.client.call('accounthistorycount', [owner, options], 'number')
   }
+
+  /**
+   * Returns information about current anchor bonus, incentive funding, burnt token(s)
+   *
+   * @return {Promise<CommunityBalanceData>}
+   */
+  async listCommunityBalances (): Promise<CommunityBalanceData> {
+    return await this.client.call('listcommunitybalances', [], 'bignumber')
+  }
 }
 
 export interface AccountPagination {
@@ -387,3 +396,14 @@ export interface AccountHistoryCountOptions {
   txtype?: DfTxType
   no_rewards?: boolean
 }
+
+export interface CommunityBalanceData {
+  AnchorReward: BigNumber
+  IncentiveFunding?: BigNumber
+  Burnt: BigNumber
+  Swap?: BigNumber
+  Futures?: BigNumber
+  Options?: BigNumber
+  Unallocated?: BigNumber
+  Unknown?: BigNumber
+}

website/docs/jellyfish/api/account.md

@@ -283,3 +283,24 @@ interface AccountHistoryCountOptions {
   no_rewards?: boolean
 }
 ```
+
+## listCommunityBalances
+
+Returns information about current anchor bonus, incentive funding, burnt token(s)
+
+```ts title="client.account.listCommunityBalances()"
+interface account {
+  listCommunityBalances (): Promise<CommunityBalanceData>
+}
+
+interface CommunityBalanceData {
+  AnchorReward: BigNumber
+  IncentiveFunding?: BigNumber
+  Burnt: BigNumber
+  Swap?: BigNumber
+  Futures?: BigNumber
+  Options?: BigNumber
+  Unallocated?: BigNumber
+  Unknown?: BigNumber
+}
+```