@dashevo/dapi-grpc 0.21.0-dev.8 → 0.21.4

package/CHANGELOG.md

@@ -1,3 +1,32 @@
+# [0.21.1](https://github.com/dashevo/dapi-grpc/compare/v0.20.0...v0.21.0) (2021-10-12)
+
+
+### Bug Fixes
+
+* cannot read properties of undefined (reading 'MethodInfo') ([#152](https://github.com/dashevo/dapi-grpc/pull/152))
+
+
+
+# [0.21.0](https://github.com/dashevo/dapi-grpc/compare/v0.20.0...v0.21.0) (2021-10-12)
+
+
+### Features
+
+* support returning of a multiproof ([#127](https://github.com/dashevo/dapi-grpc/issues/127))
+* implement getConsensusParams method ([#126](https://github.com/dashevo/dapi-grpc/issues/126), [#130](https://github.com/dashevo/dapi-grpc/issues/130), [#132](https://github.com/dashevo/dapi-grpc/issues/132), [#134](https://github.com/dashevo/dapi-grpc/issues/134))
+
+
+### Bug Fixes
+
+* height type was uint32 instead of int64 ([#123](https://github.com/dashevo/dapi-grpc/issues/123))
+
+
+### BREAKING CHANGES
+
+* `getStoreTreeProof` now returns `StoreTreeProof` message instead of `Buffer`
+
+
+
 # [0.20.0](https://github.com/dashevo/dapi-grpc/compare/v0.19.0...v0.20.0) (2021-07-08)
 
 

package/README.md

@@ -2,6 +2,8 @@
 
 [![Build Status](https://github.com/dashevo/dapi-grpc/actions/workflows/test_and_release.yml/badge.svg)](https://github.com/dashevo/dapi-grpc/actions/workflows/test_and_release.yml)
 [![NPM version](https://img.shields.io/npm/v/@dashevo/dapi-grpc.svg)](https://npmjs.org/package/@dashevo/dapi-grpc)
+[![Release Date](https://img.shields.io/github/release-date/dashevo/dapi-grpc)](https://github.com/dashevo/dapi-grpc/releases/latest)
+[![license](https://img.shields.io/github/license/dashevo/dapi-grpc.svg)](LICENSE)
 
 Decentralized API GRPC definition files and generated clients
 
@@ -14,12 +16,119 @@ Decentralized API GRPC definition files and generated clients
 
 ## Install
 
+Ensure you have the latest [NodeJS](https://nodejs.org/en/download/) installed.
+
+#### From repository
+
+Clone the repo:
+
+```shell
+git clone https://github.com/dashevo/dapi-grpc
+```
+
+Install npm packages:
+
+```shell
+npm install
+```
+
+#### From NPM
+
 ```sh
 npm install @dashevo/dapi-grpc
 ```
 
 ## Usage
 
+Node users are able to access exported elements by requiring them under v0 property.
+
+### Core Client
+
+Provide a client to perform core request.
+
+```js
+const {
+  v0: {
+    CorePromiseClient,
+  },
+} = require('@dashevo/dapi-grpc');
+
+const client = new CorePromiseClient(url);
+```
+
+Provided method allow to then perform the request, by passing a specific request parameter (see below example).
+All methods share the same API :
+- First parameter expect a specific request instance of a Request class (such as GetBlockRequest, GetTransactionRequest).
+- Second parameter is optional for metadata object.
+- Third parameter is optional for options.
+
+Here is a usage example for requesting a Block by its hash and handling its response :
+
+```js
+const {
+  v0: {
+    CorePromiseClient,
+    GetBlockRequest,
+    GetBlockResponse,
+  },
+} = require('@dashevo/dapi-grpc');
+
+const client = new CorePromiseClient(url);
+
+async function getBlockByHash(hash, options = {}) {
+  const getBlockRequest = new GetBlockRequest();
+  getBlockRequest.setHash(hash);
+
+  const response = await client.getBlock(
+    getBlockRequest,
+    {},
+    options,
+  );
+  const blockBinaryArray = response.getBlock();
+
+  return Buffer.from(blockBinaryArray);
+}
+```
+
+Available methods :
+
+- getStatus
+- getBlock
+- broadcastTransaction
+- getTransaction
+- getEstimatedTransactionFee
+- subscribeToBlockHeadersWithChainLocks
+- subscribeToTransactionsWithProofs
+
+For streams, such as subscribeToTransactionsWithProofs and subscribeToBlockHeadersWithChainLocks, a [grpc-web stream](https://github.com/grpc/grpc-web) will be returned.
+More info on their usage can be read over their repository.
+
+### Platform Client
+
+Provide a client to perform platform request.
+Method's API and usage is similar to CorePromiseClient.
+
+```js
+const {
+  v0: {
+    PlatformPromiseClient,
+  },
+} = require('@dashevo/dapi-grpc');
+
+const client = new PlatformPromiseClient(url);
+```
+
+Available methods :
+
+- broadcastStateTransition
+- getIdentity
+- getDataContract
+- getDocuments
+- getIdentitiesByPublicKeyHashes
+- getIdentityIdsByPublicKeyHashes
+- waitForStateTransitionResult
+- getConsensusParams
+- setProtocolVersion
 
 ## Maintainer
 

package/browser.js

@@ -2,9 +2,9 @@ const core = require('./clients/core/v0/web/core_grpc_web_pb');
 const platform = require('./clients/platform/v0/web/platform_grpc_web_pb');
 
 module.exports = {
-  v0: Object.assign(
-    { },
-    core,
-    platform,
-  ),
+  v0: {
+
+    ...core,
+    ...platform,
+  },
 };

package/clients/core/v0/nodejs/core_protoc.js

@@ -2,11 +2,14 @@
 /**
  * @fileoverview
  * @enhanceable
+ * @suppress {missingRequire} reports error on implicit type usages.
  * @suppress {messageConventions} JS Compiler reports an error if a variable or
  *     field starts with 'MSG_' and isn't a translatable message.
  * @public
  */
 // GENERATED CODE -- DO NOT EDIT!
+/* eslint-disable */
+// @ts-nocheck
 
 var jspb = require('google-protobuf');
 var goog = jspb;

package/clients/core/v0/web/core_pb.js

@@ -2,11 +2,14 @@
 /**
  * @fileoverview
  * @enhanceable
+ * @suppress {missingRequire} reports error on implicit type usages.
  * @suppress {messageConventions} JS Compiler reports an error if a variable or
  *     field starts with 'MSG_' and isn't a translatable message.
  * @public
  */
 // GENERATED CODE -- DO NOT EDIT!
+/* eslint-disable */
+// @ts-nocheck
 
 var jspb = require('google-protobuf');
 var goog = jspb;

package/clients/platform/v0/nodejs/platform_protoc.js

@@ -2,11 +2,14 @@
 /**
  * @fileoverview
  * @enhanceable
+ * @suppress {missingRequire} reports error on implicit type usages.
  * @suppress {messageConventions} JS Compiler reports an error if a variable or
  *     field starts with 'MSG_' and isn't a translatable message.
  * @public
  */
 // GENERATED CODE -- DO NOT EDIT!
+/* eslint-disable */
+// @ts-nocheck
 
 var jspb = require('google-protobuf');
 var goog = jspb;

package/clients/platform/v0/web/platform_pb.js

@@ -2,11 +2,14 @@
 /**
  * @fileoverview
  * @enhanceable
+ * @suppress {missingRequire} reports error on implicit type usages.
  * @suppress {messageConventions} JS Compiler reports an error if a variable or
  *     field starts with 'MSG_' and isn't a translatable message.
  * @public
  */
 // GENERATED CODE -- DO NOT EDIT!
+/* eslint-disable */
+// @ts-nocheck
 
 var jspb = require('google-protobuf');
 var goog = jspb;

package/node.js

@@ -34,13 +34,15 @@ const {
 module.exports = {
   getCoreDefinition,
   getPlatformDefinition,
-  v0: Object.assign({
+  v0: {
     CorePromiseClient,
     PlatformPromiseClient,
-    pbjs: Object.assign(
-      {},
-      pbjsCoreMessages,
-      pbjsPlatformMessages,
-    ),
-  }, protocCoreMessages, protocPlatformMessages),
+    pbjs: {
+
+      ...pbjsCoreMessages,
+      ...pbjsPlatformMessages,
+    },
+    ...protocCoreMessages,
+    ...protocPlatformMessages,
+  },
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dashevo/dapi-grpc",
-  "version": "0.21.0-dev.8",
+  "version": "0.21.4",
   "description": "DAPI GRPC definition file and generated clients",
   "browser": "browser.js",
   "main": "node.js",
@@ -33,22 +33,22 @@
   },
   "homepage": "https://github.com/dashevo/dapi-grpc#readme",
   "dependencies": {
-    "@dashevo/grpc-common": "^0.4.0",
-    "@grpc/grpc-js": "^1.3.6",
+    "@dashevo/grpc-common": "~0.21.4",
+    "@grpc/grpc-js": "^1.3.7",
     "google-protobuf": "^3.12.2",
-    "grpc-web": "^1.2.0",
+    "grpc-web": "1.2.1",
     "protobufjs": "github:jawid-h/protobuf.js#fix/buffer-conversion"
   },
   "devDependencies": {
-    "chai": "^4.2.0",
+    "chai": "^4.3.4",
     "chai-as-promised": "^7.1.1",
     "dirty-chai": "^2.0.1",
-    "eslint": "^5.16.0",
-    "eslint-config-airbnb-base": "^13.2.0",
-    "eslint-plugin-import": "^2.21.1",
-    "mocha": "^7.2.0",
+    "eslint": "^7.32.0",
+    "eslint-config-airbnb-base": "^14.2.1",
+    "eslint-plugin-import": "^2.24.2",
+    "mocha": "^9.1.2",
     "mocha-sinon": "^2.1.2",
-    "sinon": "^7.5.0",
-    "sinon-chai": "^3.5.0"
+    "sinon": "^11.1.2",
+    "sinon-chai": "^3.7.0"
   }
 }

package/scripts/build.sh

@@ -28,7 +28,7 @@ rm -rf "$CORE_WEB_OUT_PATH/*"
 docker run -v "$CORE_PROTO_PATH:$CORE_PROTO_PATH" \
            -v "$CORE_WEB_OUT_PATH:$CORE_WEB_OUT_PATH" \
            --rm \
-           grpcweb/common \
+           dashpay/grpc-web-common \
            protoc -I="$CORE_PROTO_PATH" "core.proto" \
                    --js_out="import_style=commonjs:$CORE_WEB_OUT_PATH" \
                    --grpc-web_out="import_style=commonjs,mode=grpcwebtext:$CORE_WEB_OUT_PATH"
@@ -43,7 +43,7 @@ rm -rf "$CORE_CLIENTS_PATH/nodejs/*_pbjs.js"
 cp "$CORE_WEB_OUT_PATH/core_pb.js" "$CORE_CLIENTS_PATH/nodejs/core_protoc.js"
 
 # Generate node message classes
-$PWD/node_modules/protobufjs/bin/pbjs \
+pbjs \
   -t static-module \
   -w commonjs \
   -r core_root \
@@ -59,7 +59,7 @@ rm -rf "$PLATFORM_WEB_OUT_PATH/*"
 docker run -v "$PLATFORM_PROTO_PATH:$PLATFORM_PROTO_PATH" \
            -v "$PLATFORM_WEB_OUT_PATH:$PLATFORM_WEB_OUT_PATH" \
            --rm \
-           grpcweb/common \
+           dashpay/grpc-web-common \
            protoc -I="$PLATFORM_PROTO_PATH" "platform.proto" \
                    --js_out="import_style=commonjs:$PLATFORM_WEB_OUT_PATH" \
                    --grpc-web_out="import_style=commonjs,mode=grpcwebtext:$PLATFORM_WEB_OUT_PATH"
@@ -73,7 +73,7 @@ rm -rf "$PLATFORM_CLIENTS_PATH/nodejs/*_pbjs.js"
 
 cp "$PLATFORM_WEB_OUT_PATH/platform_pb.js" "$PLATFORM_CLIENTS_PATH/nodejs/platform_protoc.js"
 
-$PWD/node_modules/protobufjs/bin/pbjs \
+pbjs \
   -t static-module \
   -w commonjs \
   -r platform_root \

package/test/unit/clients/core/v0/nodejs/CorePromiseClient.spec.js

@@ -1,4 +1,4 @@
-const { v0: { CorePromiseClient } } = require('../../../../../../');
+const { v0: { CorePromiseClient } } = require('../../../../../..');
 
 describe('CorePromiseClient', () => {
   let corePromiseClient;

package/test/unit/clients/platform/v0/nodejs/PlatformPromiseClient.spec.js

@@ -1,4 +1,4 @@
-const { v0: { PlatformPromiseClient } } = require('../../../../../../');
+const { v0: { PlatformPromiseClient } } = require('../../../../../..');
 
 describe('PlatformPromiseClient', () => {
   let platformPromiseClient;

package/.editorconfig

@@ -1,9 +0,0 @@
-root = true
-
-[*]
-indent_style = space
-indent_size = 2
-charset = utf-8
-trim_trailing_whitespace = true
-insert_final_newline = true
-end_of_line = lf

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,38 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: ''
-labels: 'bug'
-assignees: ''
-
----
-
-<!--- Provide a general summary of the issue in the Title above -->
-
-## Expected Behavior
-<!--- Tell us what should happen -->
-
-## Current Behavior
-<!--- Tell us what happens instead of the expected behavior -->
-
-## Possible Solution
-<!--- Not obligatory, but suggest a fix/reason for the bug -->
-
-## Steps to Reproduce (for bugs)
-<!--- Provide a link to a live example, or an unambiguous set of steps to -->
-<!--- reproduce this bug. Include code to reproduce, if relevant -->
-1.
-2.
-3.
-4.
-
-## Context
-<!--- How has this issue affected you? What are you trying to accomplish? -->
-<!--- Providing context helps us come up with a solution that is most useful in the real world -->
-
-## Your Environment
-<!--- Include as many relevant details about the environment you experienced the bug in -->
-* Version used:
-* Environment name and version (e.g. Chrome 39, node.js 5.4):
-* Operating System and version (desktop, server, or mobile):
-* Link to your project:

package/.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,27 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for this project
-title: ''
-labels: 'enhancement'
-assignees: ''
-
----
-
-<!--- Provide a general summary of the feature request in the Title above -->
-
-## Expected Behavior
-<!--- A clear and concise description of what you want to happen -->
-
-## Current Behavior
-<!--- Explain the difference from current behavior -->
-
-## Possible Solution
-<!--- Suggest ideas of how to implement the addition or change -->
-
-## Alternatives Considered
-<!--- A clear and concise description of any alternative solutions or features you've considered -->
-
-## Additional Context
-<!--- Add any other context or screenshots about the feature request here. -->
-
-

package/.github/PULL_REQUEST_TEMPLATE.md

@@ -1,32 +0,0 @@
-<!--- Provide a general summary of your changes in the Title above -->
-<!--- Pull request titles must use the [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) format -->
-
-## Issue being fixed or feature implemented
-<!--- Why is this change required? What problem does it solve? -->
-<!--- If it fixes an open issue, please link to the issue here. -->
-
-
-## What was done?
-<!--- Describe your changes in detail -->
-
-
-## How Has This Been Tested?
-<!--- Please describe in detail how you tested your changes. -->
-<!--- Include details of your testing environment, and the tests you ran to -->
-<!--- see how your change affects other areas of the code, etc. -->
-
-
-## Breaking Changes
-<!--- Please describe any breaking changes your code introduces and verify that -->
-<!--- the title includes "!" following the conventional commit type (e.g. "feat!: ..."-->
-
-
-## Checklist:
-<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
-- [ ] I have performed a self-review of my own code
-- [ ] I have commented my code, particularly in hard-to-understand areas
-- [ ] I have added or updated relevant unit/integration/functional/e2e tests
-- [ ] I have made corresponding changes to the documentation
-
-**For repository code-owners and collaborators only**
-- [ ] I have assigned this pull request to a milestone

package/.github/workflows/test_and_release.yml

@@ -1,91 +0,0 @@
-name: Test and Release
-
-on:
-  workflow_dispatch:
-  schedule:
-    - cron: '49 */160 * * *'
-  release:
-    types:
-      - published
-  pull_request:
-    branches:
-      - master
-      - v[0-9]+.[0-9]+-dev
-
-jobs:
-  test:
-    name: Run DAPI GRPC tests
-    runs-on: ubuntu-20.04
-    timeout-minutes: 10
-    steps:
-      - uses: actions/checkout@v2
-
-      - uses: actions/setup-node@v2
-        with:
-          node-version: '12'
-
-      - name: Enable NPM cache
-        uses: actions/cache@v2
-        with:
-          path: '~/.npm'
-          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.os }}-node-
-
-      - name: Check NPM package lock version is updated
-        uses: dashevo/gh-action-check-package-lock@v1
-
-      - name: Install NPM dependencies
-        run: npm ci
-
-      - name: Run build
-        run: npm run build
-
-      - name: Run ESLinter
-        run: npm run lint
-
-      - name: Run tests
-        run: npm run test
-
-  release:
-    name: Release NPM package
-    runs-on: ubuntu-20.04
-    needs: test
-    if: ${{ github.event_name == 'release' }}
-    steps:
-      - uses: actions/checkout@v2
-
-      - name: Check package version matches tag
-        uses: geritol/match-tag-to-package-version@0.1.0
-        env:
-          TAG_PREFIX: refs/tags/v
-
-      - name: Enable NPM cache
-        uses: actions/cache@v2
-        with:
-          path: '~/.npm'
-          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.os }}-node-
-
-      - name: Install NPM dependencies
-        run: npm ci
-
-      - name: Run build
-        run: npm run build
-
-      - name: Set release tag
-        uses: actions/github-script@v3
-        id: tag
-        with:
-          result-encoding: string
-          script: |
-            const tag = context.payload.release.tag_name;
-            const [, major, minor] = tag.match(/^v([0-9]+)\.([0-9]+)/);
-            return (tag.includes('dev') ? `${major}.${minor}-dev` : 'latest');
-
-      - name: Publish NPM package
-        uses: JS-DevTools/npm-publish@v1
-        with:
-          token: ${{ secrets.NPM_TOKEN }}
-          tag: ${{ steps.tag.outputs.result }}