Merge pull request #241 from blockfrost/feat/mempool

chore: add methods for mempool endpoint, refactor types with @blockfrost/openapi

packages/blockfrost-js/CHANGELOG.MD

@@ -10,6 +10,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - `BlockfrostServerError` now includes `body` property in cases where the error was not formatted by Blockfrost Backend (eg. various nginx errors)
+- `mempool`, `mempoolAll`, `mempoolTx` methods for [Blockfrost Mempool](https://docs.blockfrost.io/#tag/Cardano-Mempool)
+- use `@blockfrost/openapi` for type definitions
 
 ## [5.0.0]
 

packages/blockfrost-js/package.json

@@ -20,7 +20,6 @@
     "build": "yarn clean && tsc",
     "type-check": "tsc --project ./tsconfig.types.json",
     "clean": "rimraf lib",
-    "generate-types": "openapi-typescript https://raw.githubusercontent.com/blockfrost/openapi/master/openapi.yaml --output ./src/types/OpenApi.ts",
     "lint": "eslint ./src/**/*.ts",
     "prepublishOnly": "yarn build",
     "test": "yarn run-s 'test:*'",
@@ -29,6 +28,7 @@
     "docs": "yarn typedoc ./src/index.ts --theme ./node_modules/typedoc-github-wiki-theme/dist"
   },
   "dependencies": {
+    "@blockfrost/openapi": "^0.1.44",
     "@emurgo/cardano-serialization-lib-nodejs": "^10.2.0",
     "@emurgo/cip14-js": "3.0.1",
     "bottleneck": "^2.19.5",
@@ -44,7 +44,6 @@
     "jest-extended": "^3.0.2",
     "make-coverage-badge": "^1.2.0",
     "nock": "^13.2.9",
-    "openapi-typescript": "^5.4.1",
     "prettier": "2.7.1",
     "rimraf": "^3.0.2",
     "serialize-error": "^11.0.0",

packages/blockfrost-js/src/BlockFrostAPI.ts

@@ -99,6 +99,8 @@ import {
   metadataTxsLabels,
 } from './endpoints/api/metadata';
 
+import { mempool, mempoolAll, mempoolTx } from './endpoints/api/mempool';
+
 import { health, healthClock } from './endpoints/api/health';
 import { metrics, metricsEndpoints } from './endpoints/api/metrics';
 import {
@@ -703,6 +705,9 @@ class BlockFrostAPI {
    */
   genesis = genesis;
 
+  mempool = mempool;
+  mempoolAll = mempoolAll;
+  mempoolTx = mempoolTx;
   /**
    * metadataTxsLabel
    *

packages/blockfrost-js/src/endpoints/api/accounts/index.ts

@@ -1,6 +1,6 @@
+import { components } from '@blockfrost/openapi';
 import { BlockFrostAPI } from '../../../index';
 import { AllMethodOptions, PaginationOptions } from '../../../types';
-import { components } from '../../../types/OpenApi';
 import { getPaginationOptions, paginateMethod } from '../../../utils';
 import { handleError } from '../../../utils/errors';
 

packages/blockfrost-js/src/endpoints/api/addresses/index.ts

@@ -3,7 +3,7 @@ import {
   getPaginationOptions,
   paginateMethod,
 } from '../../../utils';
-import { components } from '../../../types/OpenApi';
+import { components } from '@blockfrost/openapi';
 import { BlockFrostAPI } from '../../../index';
 import { handleError } from '../../../utils/errors';
 import {

packages/blockfrost-js/src/endpoints/api/assets/index.ts

@@ -1,6 +1,6 @@
 import { getPaginationOptions, paginateMethod } from '../../../utils';
 import { handleError } from '../../../utils/errors';
-import { components } from '../../../types/OpenApi';
+import { components } from '@blockfrost/openapi';
 import { AllMethodOptions, PaginationOptions } from '../../../types';
 import { BlockFrostAPI } from '../../../index';
 

packages/blockfrost-js/src/endpoints/api/blocks/index.ts

@@ -5,7 +5,7 @@ import {
   HashOrNumber,
   PaginationOptions,
 } from '../../../types';
-import { components } from '../../../types/OpenApi';
+import { components } from '@blockfrost/openapi';
 import { BlockFrostAPI } from '../../../index';
 
 export async function blocks(

packages/blockfrost-js/src/endpoints/api/epochs/index.ts

@@ -1,6 +1,6 @@
 import { getPaginationOptions, paginateMethod } from '../../../utils';
 import { AllMethodOptions, PaginationOptions } from '../../../types';
-import { components } from '../../../types/OpenApi';
+import { components } from '@blockfrost/openapi';
 import { BlockFrostAPI } from '../../../index';
 import { handleError } from '../../../utils/errors';
 

packages/blockfrost-js/src/endpoints/api/ledger/index.ts

@@ -1,5 +1,5 @@
 import { handleError } from '../../../utils/errors';
-import { components } from '../../../types/OpenApi';
+import { components } from '@blockfrost/openapi';
 import { BlockFrostAPI } from '../../../index';
 
 export function genesis(

packages/blockfrost-js/src/endpoints/api/mempool/index.ts

@@ -0,0 +1,55 @@
+import { getPaginationOptions, paginateMethod } from '../../../utils';
+import { components } from '@blockfrost/openapi';
+import { BlockFrostAPI } from '../../../index';
+import { AllMethodOptions, PaginationOptions } from '../../../types';
+import { handleError } from '../../../utils/errors';
+
+export async function mempool(
+  this: BlockFrostAPI,
+  pagination?: PaginationOptions,
+): Promise<components['schemas']['mempool_content']> {
+  const paginationOptions = getPaginationOptions(pagination);
+
+  return new Promise((resolve, reject) => {
+    this.instance<components['schemas']['mempool_content']>(`mempool`, {
+      searchParams: {
+        page: paginationOptions.page,
+        count: paginationOptions.count,
+        order: paginationOptions.order,
+      },
+    })
+      .then(resp => {
+        resolve(resp.body);
+      })
+      .catch(err => {
+        reject(handleError(err));
+      });
+  });
+}
+
+export async function mempoolAll(
+  this: BlockFrostAPI,
+  allMethodOptions?: AllMethodOptions,
+): Promise<components['schemas']['mempool_content']> {
+  return paginateMethod(
+    pagination => this.mempool(pagination),
+    allMethodOptions,
+  );
+}
+
+export async function mempoolTx(
+  this: BlockFrostAPI,
+  hash: string,
+): Promise<components['schemas']['mempool_tx_content']> {
+  return new Promise((resolve, reject) => {
+    this.instance<components['schemas']['mempool_tx_content']>(
+      `mempool/${hash}`,
+    )
+      .then(resp => {
+        resolve(resp.body);
+      })
+      .catch(err => {
+        reject(handleError(err));
+      });
+  });
+}

packages/blockfrost-js/src/endpoints/api/metadata/index.ts

@@ -1,5 +1,5 @@
 import { getPaginationOptions } from '../../../utils';
-import { components } from '../../../types/OpenApi';
+import { components } from '@blockfrost/openapi';
 import { handleError } from '../../../utils/errors';
 import { PaginationOptions } from '../../../types';
 import { BlockFrostAPI } from '../../../index';

packages/blockfrost-js/src/endpoints/api/metrics/index.ts

@@ -1,5 +1,5 @@
 import { handleError } from '../../../utils/errors';
-import { components } from '../../../types/OpenApi';
+import { components } from '@blockfrost/openapi';
 import { BlockFrostAPI } from '../../../index';
 
 export async function metrics(

packages/blockfrost-js/src/endpoints/api/network/index.ts

@@ -1,6 +1,6 @@
 import { handleError } from '../../../utils/errors';
 import { BlockFrostAPI } from '../../../index';
-import { components } from '../../../types/OpenApi';
+import { components } from '@blockfrost/openapi';
 
 export async function network(
   this: BlockFrostAPI,

packages/blockfrost-js/src/endpoints/api/nutlink/index.ts

@@ -1,6 +1,6 @@
 import { getPaginationOptions, paginateMethod } from '../../../utils';
 import { handleError } from '../../../utils/errors';
-import { components } from '../../../types/OpenApi';
+import { components } from '@blockfrost/openapi';
 import { AllMethodOptions, PaginationOptions } from '../../../types';
 import { BlockFrostAPI } from '../../../index';
 

packages/blockfrost-js/src/endpoints/api/pools/index.ts

@@ -1,5 +1,5 @@
 import { getPaginationOptions, paginateMethod } from '../../../utils';
-import { components } from '../../../types/OpenApi';
+import { components } from '@blockfrost/openapi';
 import { BlockFrostAPI } from '../../../index';
 import { AllMethodOptions, PaginationOptions } from '../../../types';
 import { handleError } from '../../../utils/errors';

packages/blockfrost-js/src/endpoints/api/scripts/index.ts

@@ -1,5 +1,5 @@
 import { getPaginationOptions } from '../../../utils';
-import { components } from '../../../types/OpenApi';
+import { components } from '@blockfrost/openapi';
 import { handleError } from '../../../utils/errors';
 import { PaginationOptions } from '../../../types';
 import { BlockFrostAPI } from '../../../index';

packages/blockfrost-js/src/endpoints/api/txs/index.ts

@@ -1,5 +1,5 @@
 import { handleError } from '../../../utils/errors';
-import { components } from '../../../types/OpenApi';
+import { components } from '@blockfrost/openapi';
 import { BlockFrostAPI } from '../../../index';
 
 export async function txs(

packages/blockfrost-js/src/index.ts

@@ -1,4 +1,4 @@
-import { components } from './types/OpenApi';
+import { components } from '@blockfrost/openapi';
 import { BlockFrostAPI } from './BlockFrostAPI';
 import { BlockFrostIPFS } from './BlockFrostIPFS';
 import {