@dashevo/dapi-client 1.1.1 → 1.2.0

package/docs/_sidebar.md

@@ -18,6 +18,7 @@
                 - [.subscribeToMasternodeList()](usage/application/core/subscribeToMasternodeList.md)
             - Platform 
                 - [.broadcastStateTransition()](usage/application/platform/broadcastStateTransition.md)
+                - [.getStatus()](usage/application/platform/getStatus.md)
                 - [.getDataContract()](usage/application/platform/getDataContract.md)
                 - [.getDocuments()](usage/application/platform/getDocuments.md)
                 - [.getIdentityByFirstPublicKey()](usage/application/platform/getIdentityByFirstPublicKey.md)

package/docs/usage/application/platform/getStatus.md

@@ -0,0 +1,4 @@
+**Usage**: `async client.platform.getStatus(options)`
+**Description**: Get platform status
+
+Returns : Promise<!GetStatusResponse>

package/lib/methods/platform/PlatformMethodsFacade.js

@@ -14,6 +14,7 @@ const getIdentityContractNonceFactory = require('./getIdentityContractNonce/getI
 const getIdentityNonceFactory = require('./getIdentityNonce/getIdentityNonceFactory');
 const getIdentityKeysFactory = require('./getIdentityKeys/getIdentityKeysFactory');
 const getTotalCreditsInPlatformFactory = require('./getTotalCreditsInPlatform/getTotalCreditsInPlatformFactory');
+const getStatusFactory = require('./getStatus/getStatusFactory');
 
 class PlatformMethodsFacade {
   /**
@@ -38,6 +39,7 @@ class PlatformMethodsFacade {
     this.getIdentityNonce = getIdentityNonceFactory(grpcTransport);
     this.getIdentityKeys = getIdentityKeysFactory(grpcTransport);
     this.getTotalCreditsInPlatform = getTotalCreditsInPlatformFactory(grpcTransport);
+    this.getStatus = getStatusFactory(grpcTransport);
   }
 }
 

package/lib/methods/platform/getStatus/getStatusFactory.js

@@ -0,0 +1,66 @@
+const {
+  v0: {
+    PlatformPromiseClient,
+    GetStatusRequest,
+  },
+} = require('@dashevo/dapi-grpc');
+
+const InvalidResponseError = require('../response/errors/InvalidResponseError');
+
+/**
+ * @param {GrpcTransport} grpcTransport
+ * @returns {getIdentity}
+ */
+function getStatusFactory(grpcTransport) {
+  /**
+   * Fetch the identity by id
+   * @typedef {getIdentity}
+   * @param {Buffer} id
+   * @param {DAPIClientOptions & {prove: boolean}} [options]
+   * @returns {Promise<GetIdentityResponse>}
+   */
+  async function getStatus(options = {}) {
+    const { GetStatusRequestV0 } = GetStatusRequest;
+    const getStatusRequest = new GetStatusRequest();
+
+    getStatusRequest.setV0(
+      new GetStatusRequestV0(),
+    );
+
+    let lastError;
+
+    // TODO: simple retry before the dapi versioning is properly implemented
+    for (let i = 0; i < 3; i += 1) {
+      try {
+        // eslint-disable-next-line no-await-in-loop
+        const getStatusResponse = await grpcTransport.request(
+          PlatformPromiseClient,
+          'getStatus',
+          getStatusRequest,
+          options,
+        );
+
+        if (getStatusResponse.getV0() === undefined) {
+          // noinspection ExceptionCaughtLocallyJS
+          throw new InvalidResponseError('GetStatusResponseV0 is not defined');
+        }
+
+        return getStatusResponse.getV0().toObject();
+      } catch (e) {
+        if (e instanceof InvalidResponseError) {
+          lastError = e;
+        } else {
+          throw e;
+        }
+      }
+    }
+
+    // If we made it past the cycle it means that the retry didn't work,
+    // and we're throwing the last error encountered
+    throw lastError;
+  }
+
+  return getStatus;
+}
+
+module.exports = getStatusFactory;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dashevo/dapi-client",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "description": "Client library used to access Dash DAPI endpoints",
   "main": "lib/index.js",
   "contributors": [
@@ -26,11 +26,11 @@
     }
   ],
   "dependencies": {
-    "@dashevo/dapi-grpc": "1.1.1",
-    "@dashevo/dash-spv": "2.1.1",
+    "@dashevo/dapi-grpc": "1.2.0",
+    "@dashevo/dash-spv": "2.2.0",
     "@dashevo/dashcore-lib": "~0.21.3",
-    "@dashevo/grpc-common": "1.1.1",
-    "@dashevo/wasm-dpp": "1.1.1",
+    "@dashevo/grpc-common": "1.2.0",
+    "@dashevo/wasm-dpp": "1.2.0",
     "bs58": "^4.0.1",
     "cbor": "^8.0.0",
     "google-protobuf": "^3.12.2",
@@ -76,7 +76,7 @@
     "string_decoder": "^1.3.0",
     "url": "^0.11.3",
     "util": "^0.12.4",
-    "webpack": "^5.76.1",
+    "webpack": "^5.94.0",
     "webpack-cli": "^4.9.1"
   },
   "files": [
@@ -92,7 +92,7 @@
     "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=90 yarn run mocha 'test/unit/**/*.spec.js' 'test/integration/**/*.spec.js'",
+    "test:coverage": "NODE_ENV=test nyc --check-coverage --stmts=98 --branch=98 --funcs=98 --lines=89 yarn run mocha 'test/unit/**/*.spec.js' 'test/integration/**/*.spec.js'",
     "prepublishOnly": "yarn run build:web"
   },
   "ultra": {