🔀 Merge branch 'development' into release/0.8.0

.github/workflows/branch-coverage.yml

@@ -17,7 +17,7 @@ jobs:
       - name: Install dependencies
         run: make build-local
       - name: Check test coverage
-        run: npm run test:coverage
+        run: yarn run test:coverage
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v3
         with:

.github/workflows/pr-coverage.yml

@@ -13,7 +13,7 @@ jobs:
       - name: Install dependencies
         run: make build-local
       - name: Check test coverage
-        run: npm run test:coverage
+        run: yarn run test:coverage
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v3
         with:

Makefile

@@ -39,10 +39,10 @@ ready:
 test: test-functional
 
 test-functional:
-	$(compose) exec -T tests npm run test:functional
+	$(compose) exec -T tests yarn run test:functional
 
 test-integration:
-	$(compose) exec -T tests npm run test:integration:APIv3:SDKv6
+	$(compose) exec -T tests yarn run test:integration:APIv3:SDKv6
 
 cli: cli-gateway
 
@@ -108,20 +108,19 @@ build-tests:
 	cd ./tests && docker buildx build --tag=lisk/service_tests ./
 
 build-local:
-	npm ci
-	cd ./framework && npm ci
-	cd ./services/blockchain-app-registry && npm ci
-	cd ./services/blockchain-connector && npm ci
-	cd ./services/blockchain-coordinator && npm ci
-	cd ./services/blockchain-indexer && npm ci
-	cd ./services/transaction-statistics && npm ci
-	cd ./services/fee-estimator && npm ci
-	cd ./services/market && npm ci
-	cd ./services/gateway && npm ci
-	cd ./services/export && npm ci
-	cd ./services/template && npm ci
-	cd ./tests && npm ci
-
+	yarn install --frozen-lockfile
+	cd ./framework && yarn install --frozen-lockfile
+	cd ./services/blockchain-app-registry && yarn install --frozen-lockfile
+	cd ./services/blockchain-connector && yarn install --frozen-lockfile
+	cd ./services/blockchain-coordinator && yarn install --frozen-lockfile
+	cd ./services/blockchain-indexer && yarn install --frozen-lockfile
+	cd ./services/transaction-statistics && yarn install --frozen-lockfile
+	cd ./services/fee-estimator && yarn install --frozen-lockfile
+	cd ./services/market && yarn install --frozen-lockfile
+	cd ./services/gateway && yarn install --frozen-lockfile
+	cd ./services/export && yarn install --frozen-lockfile
+	cd ./services/template && yarn install --frozen-lockfile
+	cd ./tests && yarn install --frozen-lockfile
 clean: clean-local clean-images
 
 clean-local:
@@ -153,54 +152,54 @@ clean-images:
 	lisk/service_tests; :
 
 audit:
-	npm audit; :
-	cd ./framework && npm audit; :
-	cd ./services/blockchain-app-registry && npm audit; :
-	cd ./services/blockchain-connector && npm audit; :
-	cd ./services/blockchain-coordinator && npm audit; :
-	cd ./services/blockchain-indexer && npm audit; :
-	cd ./services/transaction-statistics && npm audit; :
-	cd ./services/fee-estimator && npm audit; :
-	cd ./services/market && npm audit; :
-	cd ./services/gateway && npm audit; :
-	cd ./services/export && npm audit; :
+	yarn audit; :
+	cd ./framework && yarn audit; :
+	cd ./services/blockchain-app-registry && yarn audit; :
+	cd ./services/blockchain-connector && yarn audit; :
+	cd ./services/blockchain-coordinator && yarn audit; :
+	cd ./services/blockchain-indexer && yarn audit; :
+	cd ./services/transaction-statistics && yarn audit; :
+	cd ./services/fee-estimator && yarn audit; :
+	cd ./services/market && yarn audit; :
+	cd ./services/gateway && yarn audit; :
+	cd ./services/export && yarn audit; :
 
 audit-fix:
-	npm audit fix; :
-	cd ./framework && npm audit fix; :
-	cd ./services/blockchain-app-registry && npm audit fix; :
-	cd ./services/blockchain-connector && npm audit fix; :
-	cd ./services/blockchain-coordinator && npm audit fix; :
-	cd ./services/blockchain-indexer && npm audit fix; :
-	cd ./services/transaction-statistics && npm audit fix; :
-	cd ./services/fee-estimator && npm audit fix; :
-	cd ./services/market && npm audit fix; :
-	cd ./services/gateway && npm audit fix; :
-	cd ./services/export && npm audit fix; :
+	yarn audit fix; :
+	cd ./framework && yarn audit fix; :
+	cd ./services/blockchain-app-registry && yarn audit fix; :
+	cd ./services/blockchain-connector && yarn audit fix; :
+	cd ./services/blockchain-coordinator && yarn audit fix; :
+	cd ./services/blockchain-indexer && yarn audit fix; :
+	cd ./services/transaction-statistics && yarn audit fix; :
+	cd ./services/fee-estimator && yarn audit fix; :
+	cd ./services/market && yarn audit fix; :
+	cd ./services/gateway && yarn audit fix; :
+	cd ./services/export && yarn audit fix; :
 
 tag-%:
-	npm version --no-git-tag-version --allow-same-version $*
-	cd services/gateway && npm version --no-git-tag-version --allow-same-version $*
-	cd services/blockchain-app-registry && npm version --no-git-tag-version --allow-same-version $*
-	cd services/blockchain-connector && npm version --no-git-tag-version --allow-same-version $*
-	cd services/blockchain-coordinator && npm version --no-git-tag-version --allow-same-version $*
-	cd services/blockchain-indexer && npm version --no-git-tag-version --allow-same-version $*
-	cd services/transaction-statistics && npm version --no-git-tag-version --allow-same-version $*
-	cd services/fee-estimator && npm version --no-git-tag-version --allow-same-version $*
-	cd services/market && npm version --no-git-tag-version --allow-same-version $*
-	cd services/export && npm version --no-git-tag-version --allow-same-version $*
-	cd services/template && npm version --no-git-tag-version --allow-same-version $*
-	git add ./services/gateway/package*.json
-	git add ./services/blockchain-app-registry/package*.json
-	git add ./services/blockchain-connector/package*.json
-	git add ./services/blockchain-coordinator/package*.json
-	git add ./services/blockchain-indexer/package*.json
-	git add ./services/transaction-statistics/package*.json
-	git add ./services/fee-estimator/package*.json
-	git add ./services/market/package*.json
-	git add ./services/export/package*.json
-	git add ./services/template/package*.json
-	git add ./package*.json
+	yarn version --no-git-tag-version --new-version $*
+	cd services/gateway && yarn version --no-git-tag-version --new-version $*
+	cd services/blockchain-app-registry && yarn version --no-git-tag-version --new-version $*
+	cd services/blockchain-connector && yarn version --no-git-tag-version --new-version $*
+	cd services/blockchain-coordinator && yarn version --no-git-tag-version --new-version $*
+	cd services/blockchain-indexer && yarn version --no-git-tag-version --new-version $*
+	cd services/transaction-statistics && yarn version --no-git-tag-version --new-version $*
+	cd services/fee-estimator && yarn version --no-git-tag-version --new-version $*
+	cd services/market && yarn version --no-git-tag-version --new-version $*
+	cd services/export && yarn version --no-git-tag-version --new-version $*
+	cd services/template && yarn version --no-git-tag-version --new-version $*
+	git add ./services/gateway/package.json
+	git add ./services/blockchain-app-registry/package.json
+	git add ./services/blockchain-connector/package.json
+	git add ./services/blockchain-coordinator/package.json
+	git add ./services/blockchain-indexer/package.json
+	git add ./services/transaction-statistics/package.json
+	git add ./services/fee-estimator/package.json
+	git add ./services/market/package.json
+	git add ./services/export/package.json
+	git add ./services/template/package.json
+	git add ./package.json
 	git commit -S -m ":arrow_up: Version bump to $*"
 	git tag v$*
 

README.md

@@ -41,6 +41,7 @@ Every microservice is independently managed and placed in a separate directory u
 - The default installation method is based on Docker.
 - Some token conversion rates in the Market service require their API keys.
 - For the events information to be always available in the API, please set `system.keepEventsForHeights: -1` in the Lisk application node config.
+- It is highly recommended to *NOT* enable any plugins on the Lisk application node when running Lisk Service against it.
 
 ## Architecture Diagram
 
@@ -99,6 +100,19 @@ make build
 
 > This step is only necessary if you wish to build a custom or pre-release version of Lisk Service that does not have a pre-built Docker image published on the Docker Hub. The installation script chooses the last available stable version on Docker Hub, **unless** there is no local image. If you are unsure about any local builds, use the `make clean` command to remove all locally built docker images.
 
+### System requirements
+
+The following system requirements are recommended to start Lisk Service:
+
+#### Memory
+
+- Machines with a minimum of 8 GB RAM for the Mainnet.
+- Machines with a minimum of 8 GB RAM for the Testnet.
+
+#### Storage
+
+- Machines with a minimum of 40 GB HDD.
+
 ## Configuration
 
 The default configuration is sufficient to run Lisk Service against the local node.
@@ -151,7 +165,7 @@ Assuming lisk-service is running on the `127.0.0.1:9901`, and you are in the roo
 
 ```bash
 cd tests
-LISK_SERVICE_URL=http://127.0.0.1:9901 npm run benchmark
+LISK_SERVICE_URL=http://127.0.0.1:9901 yarn run benchmark
 ```
 
 ## Further development

docker/example.env

@@ -42,8 +42,6 @@
 
 # Lisk ecosystem configuration
 LISK_APP_WS=ws://host.docker.internal:7887
-# USE_LISK_IPC_CLIENT=false
-# LISK_APP_DATA_PATH='~/.lisk/lisk-core'
 
 # Lisk Service geolocation backend (empty = disabled)
 GEOIP_JSON='https://geoip.lisk.com/json'

docs/CONTRIBUTING.md

@@ -10,18 +10,19 @@ propose changes to this document in a pull request.
 #### Table Of Contents
 
 1. [Code of Conduct](#code-of-conduct)
-
-1. [Help! I don’t want to read this whole thing, I just have one question. :mag_right:](#help!-i-dont-want-to-read-this-whole-thing-i-just-have-a-question)
-
-1. [How Can I Contribute?](#how-can-i-contribute)
-
-	1. [Reporting Bugs](#reporting-bugs)
-	1. [Suggesting Enhancements](#suggesting-enhancements)
-	1. [Pull Requests](#pull-requests)
-
-1. [Styleguides](#styleguides)
-	1. [Git Commit Messages](#git-commit-messages)
-	1. [JavaScript Styleguide](#javascript-styleguide)
+2. [Project License](#project-license)
+3. [Help! I don’t want to read this whole thing, I just have a question. :mag_right:](#help-i-dont-want-to-read-this-whole-thing-i-just-have-a-question-mag_right)
+4. [How Can I Contribute?](#how-can-i-contribute)
+    1. [Pull Requests](#pull-requests)
+    2. [Reporting Bugs](#reporting-bugs)
+       1. [Before Submitting A Bug Report](#before-submitting-a-bug-report)
+       2. [How Do I Submit A (Good) Bug Report?](#how-do-i-submit-a-good-bug-report)
+    3. [Suggesting Enhancements](#suggesting-enhancements)
+       1. [How Do I Submit A (Good) Enhancement Suggestion?](#how-do-i-submit-a-good-enhancement-suggestion)
+5. [Styleguides](#styleguides)
+    1. [Git Commit Messages](#git-commit-messages)
+    2. [JavaScript Styleguide](#javascript-styleguide)
+    3. [Code Documentation Styleguide](#code-documentation-styleguide)
 
 ## Code of Conduct
 
@@ -89,8 +90,8 @@ _Before_ submitting a pull request, please make sure the following is done:
 	changes that adhere to your new code.
 1. Format your code using [Prettier](https://prettier.io/). This should be done
 	for you automatically when you commit files, but can be performed manually
-	with `npm run format`.
-1. Ensure the test and linting suite passes (`npm run prepush` runs both).
+	with `yarn run format`.
+1. Ensure the test and linting suite passes (`yarn run prepush` runs both).
 	Follow the [JavaScript](https://github.com/airbnb/javascript) styleguide from
 	Airbnb with the
 	[lisk extension](https://github.com/LiskHQ/eslint-config-lisk-base).

docs/antora/modules/ROOT/pages/configuration/source.adoc

@@ -38,7 +38,7 @@ Once customized, you can start Lisk Service with the custom ecosystem file by ex
 pm2 start ecosystem.custom.config.js
 ----
 
-Finally, if you want to use `npm start` and `npm stop` to start and stop Lisk Service with the custom configuration, don't forget to update the `scripts` in `package.json`:
+Finally, if you want to use `yarn start` and `yarn stop` to start and stop Lisk Service with the custom configuration, don't forget to update the `scripts` in `package.json`:
 
 .Working directory: ./lisk-service/
 [source,json]

docs/antora/modules/ROOT/pages/index.adoc

@@ -358,8 +358,8 @@ Lisk Testnet::
 // ----
 // node --version
 // # v16.20.0
-// npm i socket.io-client #<1>
-// npm i jsome #<2>
+// yarn i socket.io-client #<1>
+// yarn i jsome #<2>
 // ----
 
 // <1> Use the {url_npm_socketio_client}[socket.io-client^] to connect to the RPC API.
@@ -424,7 +424,7 @@ Lisk Testnet::
 
 // [source,bash]
 // ----
-// npm i socket.io-client
+// yarn i socket.io-client
 
 // ----
 

docs/antora/modules/ROOT/pages/management/source.adoc

@@ -306,7 +306,7 @@ To reset the database of Lisk Service, drop the respective MySQL and Redis datab
 . Stop Lisk Service
 +
 ----
-npm stop
+yarn stop
 ----
 
 . Login to MySQL with the `lisk` user.

docs/antora/modules/ROOT/pages/setup/source.adoc

@@ -338,7 +338,7 @@ Now it is possible to start Lisk Service.
 
 .Start Lisk Service from Source code
 ----
-npm run start
+yarn run start
 ----
 
 The default configuration in `ecosystem.config.js` should suffice in most of the cases. If necessary, please modify the file to configure the necessary environment variables for each microservice as per your requirements.