@dashevo/dapi-client 0.21.2 → 0.21.6

package/CHANGELOG.md

@@ -0,0 +1,366 @@
+## [0.21.2](https://github.com/dashevo/dapi-client/compare/v0.21.1...v0.21.2) (2021-10-22)
+
+
+### Features
+
+* DAPI addresses white list must not be applied in Regtest mode ([#289](https://github.com/dashevo/js-dapi-client/pull/289))
+
+
+## [0.21.1](https://github.com/dashevo/dapi-client/compare/v0.21.0...v0.21.1) (2021-10-21)
+
+
+### Features
+
+* DAPI addresses white list ([#288](https://github.com/dashevo/dapi-client/issues/288))
+
+
+
+# [0.21.0](https://github.com/dashevo/dapi-client/compare/v0.20.0...v0.21.0) (2021-10-12)
+
+
+### Features
+
+* improve error handling ([#268](https://github.com/dashevo/dapi-client/issues/268))
+* convenient response errors ([#272](https://github.com/dashevo/dapi-client/issues/272), [#280](https://github.com/dashevo/dapi-client/issues/280), [#282](https://github.com/dashevo/dapi-client/issues/282), [#284](https://github.com/dashevo/dapi-client/issues/284), [#286](https://github.com/dashevo/dapi-client/issues/286))
+* implement getConsensusParams method ([#261](https://github.com/dashevo/dapi-client/issues/261))
+* support returning of a multiproof ([#257](https://github.com/dashevo/dapi-client/issues/257))
+
+
+### BREAKING CHANGES
+
+* `getBlockByHash` and `getBlockByHeight` will throw `NotFoundError` instead of `null` result
+
+
+
+## [0.20.1](https://github.com/dashevo/dapi-client/compare/v0.20.0...v0.20.1) (2021-05-26)
+
+
+### Bug Fixes
+
+* crash when connecting to an older version of dapi ([#252](https://github.com/dashevo/dapi-client/issues/252), [#253](https://github.com/dashevo/dapi-client/issues/253))
+
+
+
+# [0.20.0](https://github.com/dashevo/dapi-client/compare/v0.19.3...v0.20.0) (2021-07-09)
+
+
+### Features
+
+* provide metadata in responses ([#243](https://github.com/dashevo/dapi-client/issues/243), [#246](https://github.com/dashevo/dapi-client/issues/246))
+* throw `NotFoundError` if data is not found ([#247](https://github.com/dashevo/dapi-client/issues/247))
+
+
+### BREAKING CHANGES
+
+* platform methods respond with response classes instead of plain data
+* Core method `getTransaction` responds with response class instead of plain data
+* `getTransaction`, `getDataContract` and `getIdentity` methods throw `NotFoundError` if no data was found
+
+
+
+## [0.19.3](https://github.com/dashevo/dapi-client/compare/v0.19.2...v0.19.3) (2021-05-26)
+
+
+### Bug Fixes
+
+* update cbor to fix serialization of queries with buffers ([178943b](https://github.com/dashevo/dapi-client/commit/178943b465b30ed838cb03a5a10c6f939db92a39))
+
+
+
+## [0.19.2](https://github.com/dashevo/dapi-client/compare/v0.19.1...v0.19.2) (2021-05-20)
+
+
+### Chores
+
+* Update DPP to a 0.19.2 ([#237](https://github.com/dashevo/dapi-client/issues/237))
+
+
+
+## [0.19.1](https://github.com/dashevo/dapi-client/compare/v0.19.0...v0.19.1) (2021-05-04)
+
+
+### Bug Fixes
+
+* `getStatus` reponse was returning buffers as Base64 encoded strings ([#235](https://github.com/dashevo/dapi-client/issues/235))
+
+
+
+# [0.19.0](https://github.com/dashevo/dapi-client/compare/v0.18.0...v0.19.0) (2021-05-03)
+
+
+### Features
+
+* `getStatus` method handler response updated ([#229](https://github.com/dashevo/dapi-client/issues/229), [#230](https://github.com/dashevo/dapi-client/issues/230))
+
+
+### Bug Fixes
+
+* critical security vulnerability in axios@0.19.2 ([#233](https://github.com/dashevo/dapi-client/issues/233))
+
+
+### BREAKING CHANGES
+
+* `getStatus` method handler response have changed
+
+
+
+# [0.18.0](https://github.com/dashevo/dapi-client/compare/v0.17.2...v0.18.0) (2021-03-03)
+
+
+### Bug Fixes
+
+* BLS was throwing an error inside `uncaughtException` handler ([#226](https://github.com/dashevo/dapi-client/issues/226))
+
+
+### Features
+
+
+* `waitForStateTransitionResult` method ([#221](https://github.com/dashevo/dapi-client/issues/221), ([#223](https://github.com/dashevo/dapi-client/issues/223))
+
+
+### Chores
+
+* remove temporary `timeout` option from `broadcastStateTransition` ([2abdf5](https://github.com/dashevo/js-dapi-client/commit/2abdf5dc45859bc142dd0f293d9f071190f2a59d))
+
+
+
+## [0.17.2](https://github.com/dashevo/dapi-client/compare/v0.17.1...v0.17.2) (2020-12-30)
+
+
+### Bug Fixes
+
+* broadcastStateTransitions is timing out on testnet ([#219](https://github.com/dashevo/dapi-client/issues/219))
+
+
+
+## [0.17.1](https://github.com/dashevo/dapi-client/compare/v0.17.0...v0.17.1) (2020-12-30)
+
+
+### Bug Fixes
+
+* merkleRootQuorums from the diff doesn’t match calculated quorum root after diff is applied ([#217](https://github.com/dashevo/dapi-client/issues/217))
+
+
+
+# [0.17.0](https://github.com/dashevo/dapi-client/compare/v0.16.0...v0.17.0) (2020-12-29)
+
+
+### Features
+
+* introduce testnet network ([#214](https://github.com/dashevo/dapi-client/issues/214))
+* update `dpp` and `dashcore-lib` ([#207](https://github.com/dashevo/dapi-client/issues/207), [#210](https://github.com/dashevo/dapi-client/issues/210), [#211](https://github.com/dashevo/dapi-client/issues/211), [#212](https://github.com/dashevo/dapi-client/issues/212))
+
+
+### Bug Fixes
+
+* SML unhandled error on blockchain reorg ([#215](https://github.com/dashevo/dapi-client/issues/215))
+
+
+### BREAKING CHANGES
+
+* DAPI client is now connecting to a testnet by default
+
+
+
+# [0.16.0](https://github.com/dashevo/dapi-client/compare/v0.15.0...v0.16.0) (2020-10-27)
+
+
+### Features
+
+* `getIdentitiesByPublicKeyHashes` and `getIdentityIdsByPublicKeyHashes` methods ([#191](https://github.com/dashevo/dapi-client/issues/191), [#196](https://github.com/dashevo/dapi-client/issues/196), [#205](https://github.com/dashevo/dapi-client/issues/205))
+* `getDataContract`, `getDocuments`, `getIdentity` accept `Buffer` ([#201](https://github.com/dashevo/dapi-client/issues/201))
+
+
+### Documentation
+
+* fix URLs in README ([#193](https://github.com/dashevo/dapi-client/issues/193))
+
+
+### BREAKING CHANGES
+
+* `getIdentityByFirstPublicKey` and `getIdentityIdByFirstPublicKey` removed
+* `getDataContract`, `getDocuments`, `getIdentity` accept `Buffer` or `TypedArray`
+
+
+
+# [0.15.0](https://github.com/dashevo/dapi-client/compare/v0.14.0...v0.15.0) (2020-09-04)
+
+
+### Bug Fixes
+
+* internal error when submitting `fromBlockHeight` as `0` to `subscribeToTransactionsWithProofs` ([#174](https://github.com/dashevo/js-dapi-client/pull/174))
+
+
+### Features
+
+* retry request on `UNIMPLEMENTED` error ([#185](https://github.com/dashevo/dapi-client/issues/185))
+* update DAPI gRPC to 0.15 ([#179](https://github.com/dashevo/dapi-client/issues/179), [#186](https://github.com/dashevo/dapi-client/issues/186))
+* remove `getUTXO` and `getAddressSummary` core methods ([#178](https://github.com/dashevo/js-dapi-client/pull/178))
+* rename `sendTransaction` and `applyStateTransition` ([#175](https://github.com/dashevo/js-dapi-client/pull/175))
+
+
+### BREAKING CHANGES
+
+* `broadcastTransaction` and `broadcastStatTransition` gRPC method names are using instead of `sendTransaction` and `applyStateTransition`
+* `getUTXO` and `getAddressSummary` core methods are removed
+* see [DAPI gRPC breaking changes](https://github.com/dashevo/dapi-grpc/releases/tag/v0.15.0)
+
+
+
+# [0.14.0](https://github.com/dashevo/dapi-client/compare/v0.13.6...v0.14.0) (2020-07-23)
+
+We completely rewrote DAPI Client to improve code quality, usability, and testability.
+
+In the new version, you can specify not just seeds to connect but also specific DAPI addresses
+and even inject own logic to obtain/select nodes. API methods accept the same options
+as the `DAPIClient` constructor so you can specify different behavior for each API call.
+
+Previously, faulty nodes were excluded for a specific API call. Now they are banning
+for a period of time, and this time increments exponentially in the event of repeated faults.
+
+
+### Bug Fixes
+
+* cannot read property 'getHttpPort' of undefined ([#173](https://github.com/dashevo/dapi-client/issues/173))
+* internal error when submitting `fromBlockHeight` as 0 to `subscribeToTransactionsWithProofs` ([#174](https://github.com/dashevo/dapi-client/issues/174))
+* ambiguity in `addresses` option ([#170](https://github.com/dashevo/dapi-client/issues/170))
+* JSON RPC does not retry on `ETIMEDOUT` ([#156](https://github.com/dashevo/dapi-client/issues/156))
+* 2 seconds timeout not enough for some requests ([#151](https://github.com/dashevo/dapi-client/issues/151))
+* construct DAPIClient with network option didn't work properly ([#150](https://github.com/dashevo/dapi-client/issues/150))
+* global default timeout applies for streams ([#152](https://github.com/dashevo/dapi-client/issues/152))
+
+
+### Features
+
+* add ports to string representation of DAPIAddress ([#171](https://github.com/dashevo/dapi-client/issues/171)) ([1f4ffb7](https://github.com/dashevo/dapi-client/commit/1f4ffb7ed2cd8079eccf938ede2d43f37a5f80d3))
+* allow to specify network with other connection options ([#160](https://github.com/dashevo/dapi-client/issues/160)) ([cfbc5cd](https://github.com/dashevo/dapi-client/commit/cfbc5cd649358420df99f76f1ca84b8c7ae826a4))
+* update DAPI gRPC to 0.14.0-dev.1 ([#149](https://github.com/dashevo/dapi-client/issues/149)) ([4598def](https://github.com/dashevo/dapi-client/commit/4598def13dbdba9c9c1392c65e2c97ceb322c34c))
+* timeout options for gRPC requests and simplified URL for gRPC client ([#146](https://github.com/dashevo/dapi-client/issues/146)) ([35685b9](https://github.com/dashevo/dapi-client/commit/35685b98fa05fc4436630f165113419b3f48833f))
+
+
+### Documentation
+
+* readme standard updates ([#167](https://github.com/dashevo/dapi-client/issues/147))
+
+
+### Code Refactoring
+
+* rewrite DAPI Client from scratch ([#140](https://github.com/dashevo/dapi-client/issues/140))
+
+
+### BREAKING CHANGES
+
+* DAPI Client options [are changed](https://github.com/dashevo/dapi-client/blob/1ec21652f1615ba95ea537c38632692f81deefa3/lib/DAPIClient.js#L42-L51)
+* Core and Platform methods moved to specific namespaces (ie. `client.platform.getIdentity()`, `client.core.getStatus()`)
+
+
+
+## [0.13.6](https://github.com/dashevo/dapi-client/compare/v0.13.5...v0.13.6) (2020-06-30)
+
+
+### Features
+
+* update dapi-client to `0.18.11` ([#163](https://github.com/dashevo/dapi-client/issues/163))
+
+
+
+## [0.13.5](https://github.com/dashevo/dapi-client/compare/v0.13.4...v0.13.5) (2020-06-30)
+
+
+### Features
+
+* update `dashcore-lib` to `0.18.10` ([#162](https://github.com/dashevo/dapi-client/issues/162))
+
+
+
+## [0.13.4](https://github.com/dashevo/dapi-client/compare/v0.13.3...v0.13.4) (2020-06-30)
+
+
+### Bug Fixes
+
+* network is not set to `SimplifiedMNListDiff` ([#161](https://github.com/dashevo/dapi-client/issues/161))
+
+
+
+## [0.13.3](https://github.com/dashevo/dapi-client/compare/v0.13.2...v0.13.3) (2020-06-18)
+
+
+### Bug Fixes
+
+* calling method `getIp` of `undefined` ([#159](https://github.com/dashevo/dapi-client/issues/159))
+
+
+
+## [0.13.2](https://github.com/dashevo/dapi-client/compare/v0.13.1...v0.13.2) (2020-06-11)
+
+
+### Bug Fixes
+
+* retries don't work for MN discovery ([#157](https://github.com/dashevo/dapi-client/issues/157))
+
+
+
+## [0.13.1](https://github.com/dashevo/dapi-client/compare/v0.13.0...v0.13.1) (2020-06-11)
+
+
+### Bug Fixes
+
+* JSON RPC doesn't retry on `ETIMEDOUT ([#155](https://github.com/dashevo/dapi-client/issues/155))
+
+
+
+# [0.13.0](https://github.com/dashevo/dapi-client/compare/v0.12.0...v0.13.0) (2020-06-08)
+
+
+### Bug Fixes
+
+* missed grpc-common peer dependency caused error ([#135](https://github.com/dashevo/dapi-client/pull/135))
+
+
+## Features
+
+* implement transports with retries ([#130](https://github.com/dashevo/dapi-client/pull/130), [#141](https://github.com/dashevo/dapi-client/pull/141))
+* get identity by public key endpoints ([#133](https://github.com/dashevo/dapi-client/pull/133))
+
+
+### Documentation
+
+* add typing ([#143](https://github.com/dashevo/dapi-client/pull/143))
+* JSDoc formatting ([#132](https://github.com/dashevo/dapi-client/pull/132))
+* `subscribeToTransactionsWithProofs` ([#137](https://github.com/dashevo/dapi-client/pull/137))
+
+
+
+# [0.12.0](https://github.com/dashevo/dapi-client/compare/v0.11.0...v0.12.0) (2020-04-20)
+
+
+### Code Refactoring
+
+* remove `forceJsonRpc` option ([#126](https://github.com/dashevo/dapi-client/issues/126))
+
+
+### BREAKING CHANGES
+
+* platform methods no longer available through JSON RPC
+
+
+# [0.11.0](https://github.com/dashevo/dapi-client/compare/v0.8.0...v0.11.0) (2020-03-01)
+
+### Bug Fixes
+
+* return null if get "Not Found" gRPC error ([86af3f7](https://github.com/dashevo/dapi-client/commit/86af3f78d26e45dbe9ae1d49b6c215f5af9d0cba))
+* gRPC web connection url should contain protocol ([0c7ad1f](https://github.com/dashevo/dapi-client/commit/0c7ad1f13ac1ec75a319c97514f19671f48c2b66))
+
+
+### Features
+
+* introduce `generateToAddress` endpoint ([f8b446b](https://github.com/dashevo/dapi-client/commit/f8b446ba41b0794b2d2007b0ad79e29f4a561b8e))
+* bring back `getAddressSummary` endpoint ([d6de22c](https://github.com/dashevo/dapi-client/commit/d6de22cf8cbeb0ac7bb55ec5ae9e09f9900e3028))
+* implement basic Core gRPC endpoints ([6fe4d4a](https://github.com/dashevo/dapi-client/commit/6fe4d4a79bce750210672ee7f2df9cc14d4437fd))
+* remove obsolete API endpoints and code ([982a514](https://github.com/dashevo/dapi-client/commit/982a51437b94b3cb6ae0ba1b9031daef0a468940))
+
+
+### BREAKING CHANGES
+
+* Removed unsupported `generate` endpoint
+* Removed insecure endpoints

package/lib/transport/JsonRpcTransport/createJsonTransportError.js

@@ -13,7 +13,7 @@ const RetriableResponseError = require('../errors/response/RetriableResponseErro
 function createJsonTransportError(error, dapiAddress) {
   if (error instanceof WrongHttpCodeError) {
     return new ServerError(
-      error.statusCode,
+      error.getCode(),
       error.message,
       {},
       dapiAddress,

package/lib/transport/JsonRpcTransport/errors/WrongHttpCodeError.js

@@ -16,7 +16,7 @@ class WrongHttpCodeError extends DAPIClientError {
     super(`DAPI JSON RPC wrong http code: ${statusMessage}`);
 
     this.requestInfo = requestInfo;
-    this.statusCode = statusCode;
+    this.code = statusCode;
   }
 
   /**
@@ -30,8 +30,8 @@ class WrongHttpCodeError extends DAPIClientError {
    *
    * @returns {number}
    */
-  getStatusCode() {
-    return this.statusCode;
+  getCode() {
+    return this.code;
   }
 }
 

package/lib/transport/JsonRpcTransport/requestJsonRpc.js

@@ -29,12 +29,6 @@ async function requestJsonRpc(host, port, method, params, options = {}) {
     postOptions.timeout = options.timeout;
   }
 
-  const response = await axios.post(
-    url,
-    payload,
-    { timeout: options.timeout },
-  );
-
   const requestInfo = {
     host,
     port,
@@ -43,6 +37,22 @@ async function requestJsonRpc(host, port, method, params, options = {}) {
     options,
   };
 
+  let response;
+
+  try {
+    response = await axios.post(
+      url,
+      payload,
+      { timeout: options.timeout },
+    );
+  } catch (error) {
+    if (error.response && error.response.status >= 500) {
+      throw new WrongHttpCodeError(requestInfo, error.response.status, error.response.statusText);
+    }
+
+    throw error;
+  }
+
   if (response.status !== 200) {
     throw new WrongHttpCodeError(requestInfo, response.status, response.statusMessage);
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dashevo/dapi-client",
-  "version": "0.21.2",
+  "version": "0.21.6",
   "description": "Client library used to access Dash DAPI endpoints",
   "main": "lib/DAPIClient.js",
   "contributors": [
@@ -26,31 +26,33 @@
     }
   ],
   "dependencies": {
-    "@dashevo/dapi-grpc": "~0.21.0",
-    "@dashevo/dashcore-lib": "~0.19.26",
-    "@dashevo/dpp": "~0.21.0",
-    "@dashevo/grpc-common": "~0.5.4",
+    "@dashevo/dapi-grpc": "~0.21.6",
+    "@dashevo/dashcore-lib": "~0.19.28",
+    "@dashevo/dpp": "~0.21.6",
+    "@dashevo/grpc-common": "~0.21.6",
     "@grpc/grpc-js": "^1.3.7",
     "axios": "^0.21.1",
     "bs58": "^4.0.1",
-    "cbor": "^7.0.5",
+    "cbor": "^8.0.0",
     "lodash.sample": "^4.2.1",
-    "node-inspect-extracted": "^1.0.7"
+    "node-inspect-extracted": "^1.0.8"
   },
   "devDependencies": {
-    "@babel/core": "^7.10.2",
+    "@babel/core": "^7.15.5",
     "assert-browserify": "^2.0.0",
-    "babel-loader": "^8.0.6",
+    "babel-loader": "^8.2.2",
     "buffer": "^6.0.3",
-    "chai": "^4.2.0",
+    "chai": "^4.3.4",
     "chai-as-promised": "^7.1.1",
-    "core-js": "^3.6.4",
+    "comment-parser": "^0.7.6",
+    "core-js": "^3.17.2",
     "crypto-browserify": "^3.12.0",
     "dirty-chai": "^2.0.1",
-    "eslint": "^6.8.0",
-    "eslint-config-airbnb-base": "^14.1.0",
-    "eslint-plugin-import": "^2.20.2",
+    "eslint": "^7.32.0",
+    "eslint-config-airbnb-base": "^14.2.1",
+    "eslint-plugin-import": "^2.24.2",
     "eslint-plugin-jsdoc": "^27.0.0",
+    "events": "^3.3.0",
     "karma": "^6.3.4",
     "karma-chai": "^0.1.0",
     "karma-chrome-launcher": "^3.1.0",
@@ -58,31 +60,38 @@
     "karma-mocha": "^2.0.1",
     "karma-mocha-reporter": "^2.2.5",
     "karma-webpack": "^5.0.0",
-    "mocha": "^9.1.1",
+    "mocha": "^9.1.2",
     "nyc": "^15.1.0",
     "path-browserify": "^1.0.1",
     "process": "^0.11.10",
     "sinon": "^11.1.2",
     "sinon-chai": "^3.7.0",
     "stream-browserify": "^3.0.0",
+    "string_decoder": "^1.3.0",
     "url": "^0.11.0",
-    "webpack": "^5.52.1",
-    "webpack-cli": "^4.8.0"
+    "util": "^0.12.4",
+    "webpack": "^5.59.1",
+    "webpack-cli": "^4.9.1"
   },
   "files": [
     "docs",
     "lib"
   ],
   "scripts": {
-    "build": "webpack",
+    "build:web": "webpack",
     "lint": "eslint .",
-    "test": "npm run test:coverage && npm run test:browsers",
+    "test": "yarn run test:coverage && yarn run test:browsers",
     "test:unit": "mocha './test/unit/**/*.spec.js'",
     "test:integration": "mocha './test/integration/**/*.spec.js'",
     "test:node": "NODE_ENV=test mocha",
     "test:browsers": "karma start ./karma.conf.js --single-run",
-    "test:coverage": "NODE_ENV=test nyc --check-coverage --stmts=98 --branch=98 --funcs=98 --lines=95 mocha 'test/unit/**/*.spec.js' 'test/integration/**/*.spec.js'",
-    "prepublishOnly": "npm run build"
+    "test:coverage": "NODE_ENV=test nyc --check-coverage --stmts=98 --branch=98 --funcs=98 --lines=95 yarn run mocha 'test/unit/**/*.spec.js' 'test/integration/**/*.spec.js'",
+    "prepublishOnly": "yarn run build:web"
+  },
+  "ultra": {
+    "concurrent": [
+      "clean"
+    ]
   },
   "license": "MIT"
-}
+}