lisk/service_transaction_statistics repository overview

⁠Lisk Service Transaction Statistics

The Transaction Statistics service, as the name suggests, is primarily responsible to compute v arious transaction statistics to offer users various near real-time network activity insights.

⁠Installation

⁠Prerequisites

Please refer to the README⁠ in the project root directory.

⁠Installation

Clone the Lisk Service Repository:

git clone https://github.com/LiskHQ/lisk-service.git # clone repository
cd lisk-service/services/transaction-statistics # move into the transaction-statistics microser
vice directory
npm ci # install required Node.js dependencies

⁠Configuration

To configure the different microservices, there are several environment variables the user can define to customize the configurations.

A list of the most commonly used environment variables is presented below:

• SERVICE_BROKER: URL of the microservice message broker (NATS or Redis).
• SERVICE_STATISTICS_MYSQL: Connection string of the MySQL instance that the microservice con nects to.
• SERVICE_STATISTICS_REDIS: URL of the cache storage (Redis).
• TRANSACTION_STATS_HISTORY_LENGTH_DAYS: The number of days for which the transaction statist ics need to be built in retrospect to the application init.

⁠Management

⁠Start

cd lisk-service/services/transaction-statistics # move into the root directory of the transacti
on-statistics microservice
npm start # start the microservice with running nodes locally

Use the framework/bin/moleculer_client.js and framework/bin/moleculer_subscribe.js clients to test particular service endpoints.

If you want to run a production variant of the service, use Docker or PM2. This will automa tically recover the process when it fails.

⁠Stop

Press Ctrl+C in the terminal to stop the process.

⁠Contributors

https://github.com/LiskHQ/lisk-service/graphs/contributors⁠

⁠License

Copyright 2016-2023 Lisk Foundation

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0⁠

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.