added getBurnInfo RPC

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

@@ -0,0 +1,44 @@
+import BigNumber from 'bignumber.js'
+import { MasterNodeRegTestContainer } from '@defichain/testcontainers'
+import { createToken } from '@defichain/testing'
+import { ContainerAdapterClient } from '../../container_adapter_client'
+
+const container = new MasterNodeRegTestContainer()
+const client = new ContainerAdapterClient(container)
+const burnAddress = 'mfburnZSAM7Gs1hpDeNaMotJXSGA7edosG'
+
+beforeAll(async () => {
+  await container.start()
+  await container.waitForWalletCoinbaseMaturity()
+
+  // Masternode
+  await client.masternode.createMasternode(await container.getNewAddress('', 'legacy'))
+  await container.generate(1)
+
+  // burn gold token
+  const fundedAddress = await container.getNewAddress()
+  await createToken(container, 'GOLD', { collateralAddress: fundedAddress })
+  await client.token.mintTokens('100@GOLD')
+  await container.generate(1)
+  await client.account.sendTokensToAddress({}, { [burnAddress]: ['50@GOLD'] })
+
+  // send utxo to burn address
+  await client.wallet.sendToAddress(burnAddress, 10)
+  await container.generate(1)
+})
+
+afterAll(async () => {
+  await container.stop()
+})
+
+it('should getBurnInfo', async () => {
+  const info = await client.account.getBurnInfo()
+
+  expect(info).toStrictEqual({
+    address: burnAddress,
+    amount: new BigNumber('10'),
+    tokens: ['50.00000000@GOLD'],
+    feeburn: new BigNumber('2'),
+    emissionburn: new BigNumber('6274')
+  })
+})

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

@@ -363,6 +363,16 @@ export class Account {
   ): Promise<BurnHistory[]> {
     return await this.client.call('listburnhistory', [options], 'number')
   }
+
+  /**
+   * Returns burn address and burnt coin and token information.
+   * Requires full acindex for correct amount, tokens and feeburn values.
+   *
+   * @return {Promise<BurnInfo>}
+   */
+  async getBurnInfo (): Promise<BurnInfo> {
+    return await this.client.call('getburninfo', [], 'bignumber')
+  }
 }
 
 export interface AccountPagination {
@@ -477,3 +487,23 @@ export interface BurnHistory {
   txid: string
   amounts: string[]
 }
+
+export interface BurnInfo {
+  address: string
+  /**
+   * Amount send to burn address
+   */
+  amount: BigNumber
+  /**
+   * Token amount send to burn address
+   */
+  tokens: Array<{ name: string, amount: BigNumber }>
+  /**
+   * Amount collected via fee burn
+   */
+  feeburn: BigNumber
+  /**
+   * Amount collected via emission burn
+   */
+  emissionburn: BigNumber
+}

website/docs/jellyfish/api/account.md

@@ -388,3 +388,34 @@ interface BurnHistory {
   amounts: string[]
 }
 ```
+
+## getBurnInfo
+
+Returns burn address and burnt coin and token information.
+Requires full acindex for correct amount, tokens and feeburn values.
+
+```ts title="client.account.getBurnInfo()"
+interface account {
+  getBurnInfo (): Promise<BurnInfo>
+}
+
+export interface BurnInfo {
+  address: string
+  /**
+   * Amount send to burn address
+   */
+  amount: BigNumber
+  /**
+   * Token amount send to burn address
+   */
+  tokens: Array<{ name: string, amount: BigNumber }>
+  /**
+   * Amount collected via fee burn
+   */
+  feeburn: BigNumber
+  /**
+   * Amount collected via emission burn
+   */
+  emissionburn: BigNumber
+}
+```