Add getDifficulty rpc (#285)

BirthdayResearch · May 25, 2021 · 454cd1f · 454cd1f
1 parent 241f390
commit 454cd1f
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 0 deletions.
diff --git a/packages/jellyfish-api-core/__tests__/category/blockchain.test.ts b/packages/jellyfish-api-core/__tests__/category/blockchain.test.ts
@@ -249,6 +249,13 @@ describe('masternode', () => {
     })
   })
 
+  describe('getdifficulty', () => {
+    it('should getDifficulty', async () => {
+      const difficulty = await client.blockchain.getDifficulty()
+      expect(difficulty).toBeGreaterThanOrEqual(0)
+    })
+  })
+
   describe('getRawMempool', () => {
     beforeAll(async () => {
       await client.wallet.setWalletFlag(wallet.WalletFlag.AVOID_REUSE)

diff --git a/packages/jellyfish-api-core/src/category/blockchain.ts b/packages/jellyfish-api-core/src/category/blockchain.ts
@@ -110,6 +110,15 @@ export class Blockchain {
     return await this.client.call('getchaintips', [], 'number')
   }
 
+  /**
+   * Get the proof-of-work difficulty as a multiple of the minimum difficulty.
+   *
+   * @return {Promise<number>}
+   */
+  async getDifficulty (): Promise<number> {
+    return await this.client.call('getdifficulty', [], 'number')
+  }
+
   /**
    * Get details of unspent transaction output (UTXO).
    *

diff --git a/website/docs/jellyfish/api/blockchain.md b/website/docs/jellyfish/api/blockchain.md
@@ -189,6 +189,16 @@ interface ChainTip {
 }
 ```
 
+## getDifficulty
+
+Return the proof-of-work difficulty as a multiple of the minimum difficulty.
+
+```ts tile="client.blockchain.getDifficulty()"
+interface blockchain {
+    getDifficulty (): Promise<number>
+}
+```
+
 ## getTxOut
 
 Get details of unspent transaction output (UTXO).