added estimateSmartFee rpc

packages/jellyfish-api-core/__tests__/category/mining.test.ts

@@ -1,6 +1,8 @@
 import { RegTestContainer, MasterNodeRegTestContainer } from '@defichain/testcontainers'
 import { ContainerAdapterClient } from '../container_adapter_client'
 import waitForExpect from 'wait-for-expect'
+import { wallet } from '../../src'
+import { EstimateMode } from '../../src/category/mining'
 
 describe('non masternode', () => {
   const container = new RegTestContainer()
@@ -31,6 +33,14 @@ describe('non masternode', () => {
     const result = await client.mining.getNetworkHashPerSecond()
     expect(result).toBe(0)
   })
+
+  it('should have an error with estimateSmartFee', async () => {
+    const result = await client.mining.estimateSmartFee(6)
+    const errors = (result.errors != null) ? result.errors : []
+    expect(errors.length).toBeGreaterThan(0)
+    expect(errors[0]).toEqual('Insufficient data or no feerate found')
+    expect(result.feerate).toBeUndefined()
+  })
 })
 
 describe('masternode', () => {
@@ -111,3 +121,34 @@ describe('masternode', () => {
     expect(info.warnings).toBe('')
   })
 })
+
+describe('estimatesmartfees', () => {
+  const container = new MasterNodeRegTestContainer()
+  const client = new ContainerAdapterClient(container)
+
+  beforeAll(async () => {
+    await container.start()
+    await container.waitForReady()
+    await container.waitForWalletCoinbaseMaturity()
+    await container.waitForWalletBalanceGTE(10)
+    await client.wallet.setWalletFlag(wallet.WalletFlag.AVOID_REUSE)
+  })
+
+  afterAll(async () => {
+    await container.stop()
+  })
+
+  it('should have estimated smart fees', async () => {
+    await waitForExpect(async () => {
+      for (let x = 0; x < 200; x++) {
+        const address = await client.wallet.getNewAddress()
+        await client.wallet.sendToAddress(address, 0.0001)
+      }
+    })
+
+    const result = await client.mining.estimateSmartFee(6, EstimateMode.ECONOMICAL)
+    expect(result.errors).toBeUndefined()
+    expect(result.blocks).toBeGreaterThan(0)
+    expect(result.feerate).toBeGreaterThan(0)
+  })
+})

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

@@ -1,5 +1,11 @@
 import { ApiClient } from '../.'
 
+export enum EstimateMode {
+  UNSET = 'UNSET',
+  ECONOMICAL = 'ECONOMICAL',
+  CONSERVATIVE = 'CONSERVATIVE'
+}
+
 /**
  * Mining RPCs for DeFi Blockchain
  */
@@ -37,6 +43,16 @@ export class Mining {
   async getMiningInfo (): Promise<MiningInfo> {
     return await this.client.call('getmininginfo', [], 'number')
   }
+
+  /**
+   *
+   * @param {number} confirmationTarget in blocks (1 - 1008)
+   * @param {EstimateMode} [estimateMode='CONSERVATIVE'] estimateMode of fees.
+   * @returns {Promise<SmartFeeEstimation>}
+   */
+  async estimateSmartFee (confirmationTarget: number, estimateMode: EstimateMode = EstimateMode.CONSERVATIVE): Promise<SmartFeeEstimation> {
+    return await this.client.call('estimatesmartfee', [confirmationTarget, estimateMode], 'number')
+  }
 }
 
 /**
@@ -86,3 +102,9 @@ export interface MasternodeInfo {
   mintedblocks?: number
   lastblockcreationattempt?: string
 }
+
+export interface SmartFeeEstimation {
+  feerate?: number
+  errors?: string[]
+  blocks: number
+}

website/docs/jellyfish/api/mining.md

@@ -91,3 +91,25 @@ interface MasternodeInfo {
   lastblockcreationattempt?: string
 }
 ```
+
+## estimateSmartFee
+
+Estimates the approximate fee per kilobyte needed for a transaction
+
+```ts title="client.mining.estimateSmartFee()"
+interface mining {
+  estimateSmartFee (confirmationTarget: number, estimateMode: EstimateMode = 'CONSERVATIVE'): Promise<SmartFeeEstimation>
+}
+
+interface SmartFeeEstimation {
+  feerate?: number
+  errors?: string[]
+  blocks: number
+}
+
+enum EstimateMode {
+  UNSET = 'UNSET',
+  ECONOMICAL = 'ECONOMICAL',
+  CONSERVATIVE = 'CONSERVATIVE'
+}
+```