added estimateSmartFee rpc

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

@@ -37,8 +37,20 @@ 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 = 'CONSERVATIVE'): Promise<SmartFeeEstimation> {
+    return await this.client.call('estimatesmartfee', [confirmationTarget, estimateMode], 'number')
+  }
 }
 
+export type EstimateMode = 'UNSET' | 'ECONOMICAL' | 'CONSERVATIVE'
+
 /**
  * Minting related information
  */
@@ -86,3 +98,12 @@ export interface MasternodeInfo {
   mintedblocks?: number
   lastblockcreationattempt?: string
 }
+
+/**
+ * @description return type of rpc `estimatesmartfee`
+ */
+export interface SmartFeeEstimation {
+  feerate?: number
+  errors?: string[]
+  blocks: number
+}

website/docs/jellyfish/api/mining.md

@@ -91,3 +91,21 @@ 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
+}
+
+type EstimateMode = 'UNSET' | 'ECONOMICAL' | 'CONSERVATIVE';
+```