Merge pull request #118 from blockfrost/network

feat: network endpoint

CHANGELOG.MD

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.1.0]
+
+### Added
+
+- `network` endpoint
+
 ## [1.0.2]
 
 ### Fixed

examples/api.ts

@@ -7,13 +7,15 @@ async function run() {
 
   try {
     const latestBlock = await API.blocksLatest();
+    const networkInfo = await API.network();
     const latestEpoch = await API.epochsLatest();
     const health = await API.health();
     const address = await API.addresses(
       'addr1qxqs59lphg8g6qndelq8xwqn60ag3aeyfcp33c2kdp46a09re5df3pzwwmyq946axfcejy5n4x0y99wqpgtp2gd0k09qsgy6pz',
     );
 
     console.log('address', address);
+    console.log('networkInfo', networkInfo);
     console.log('latestEpoch', latestEpoch);
     console.log('latestBlock', latestBlock);
     console.log('health', health);

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@blockfrost/blockfrost-js",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "description": "A JavaScript/TypeScript SDK for interacting with the https://blockfrost.io API",
   "keywords": [
     "blockfrost",

src/BlockFrostAPI.ts

@@ -108,6 +108,8 @@ import {
   nutlinkTickersAll,
 } from './endpoints/api/nutlink';
 
+import { network } from './endpoints/api/network';
+
 import { Options, ValidatedOptions } from './types';
 import join from 'url-join';
 import { validateOptions } from './utils';
@@ -868,6 +870,14 @@ class BlockFrostAPI {
    *
    */
   getAccount = getAccount;
+
+  /**
+   * network
+   *
+   * @returns Detailed network information.
+   *
+   */
+  network = network;
 }
 
 export { BlockFrostAPI };

src/endpoints/api/network/index.ts

@@ -0,0 +1,17 @@
+import { handleError } from '../../../utils';
+import { BlockFrostAPI } from '../../../index';
+import { components } from '../../../types/OpenApi';
+
+export async function network(
+  this: BlockFrostAPI,
+): Promise<components['schemas']['network']> {
+  return new Promise((resolve, reject) => {
+    this.axiosInstance(`${this.apiUrl}/network`)
+      .then(resp => {
+        resolve(resp.data);
+      })
+      .catch(err => {
+        reject(handleError(err));
+      });
+  });
+}

test/fixtures/endpoints/network.ts

@@ -0,0 +1,18 @@
+import { BlockFrostAPI } from '../../../src';
+
+export default [
+  {
+    command: (SDK: BlockFrostAPI) => SDK.network(),
+    response: {
+      supply: {
+        max: expect.any(String),
+        total: expect.any(String),
+        circulating: expect.any(String),
+      },
+      stake: {
+        live: expect.any(String),
+        active: expect.any(String),
+      },
+    },
+  },
+] as const;