added docs for getBlockchainInfo

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

@@ -11,7 +11,7 @@ export class Blockchain {
   }
 
   /**
-   * Returns an object containing various state info regarding blockchain processing.
+   * Get various state info regarding blockchain processing.
    * @return Promise<BlockchainInfo>
    */
   async getBlockchainInfo (): Promise<BlockchainInfo> {

website/docs/jellyfish/api/blockchain.md

@@ -0,0 +1,46 @@
+---
+id: blockchain
+title: Blockchain API
+sidebar_label: Blockchain API
+slug: /jellyfish/api/blockchain
+---
+
+```js
+import {Client} from '@defichain/jellyfish'
+const client = new Client()
+
+// Using client.blockchain.
+const something = await client.blockchain.method()
+```
+
+## getBlockchainInfo
+
+Get various state info regarding blockchain processing.
+
+```ts title="client.blockchain.getBlockchainInfo()"
+interface blockchain {
+  getBlockchainInfo (): Promise<BlockchainInfo>
+}
+
+interface BlockchainInfo {
+  chain: 'main' | 'test' | 'regtest' | string
+  blocks: number
+  headers: number
+  bestblockhash: string
+  difficulty: number
+  mediantime: number
+  verificationprogress: number
+  initialblockdownload: boolean
+  chainwork: string
+  size_on_disk: number
+  pruned: boolean
+  softforks: {
+    [id: string]: {
+      type: 'buried' | 'bip9'
+      active: boolean
+      height: number
+    }
+  }
+  warnings: string
+}
+```

website/sidebars.js

@@ -8,6 +8,7 @@ module.exports = {
       label: 'DeFi APIs',
       collapsed: false,
       items: [
+        'jellyfish/api/blockchain',
         'jellyfish/api/mining',
         'jellyfish/api/wallet'
       ]