palem1988 / blockchain-data-collection-agent

TurtlePay™ Blockchain Data Collection Agent (BDCA)

TurtlePay™ Blockchain Data Collection Agent

Master Build Status

Collects TurtleCoin™ blockchain data into a SQL backend that serving and using the data a breeze.

Prerequisites

• TurtleCoin >= 0.12.0
• node >=6
• MariaDB/MySQL with InnoDB support

Hardware Requirements

For the best performance when using this package (as of June 30, 2019), your Database server must have a minimum of the following:

• 32GB RAM
  • 30GB dedicated to MariaDB/MySQL
• 2 CPU Cores (4 Recommended)
• SSD Storage

Warning: Running the DB on system(s) with less than the minimum hardware requirements above will cause performance issues. If you are experiencing issues please verify that the system you are using meets the minimum requirements above. We cannot assist with performance issues with implementations that do not meet the above minimum requirements.

Recommended Reading

The help tune your selected DBMS, we recommend that you read the following documents, at a minimum, to tune your DBMS installation for the dataset this package manages.

This list is by no means comprehensive nor do we guarantee the information or suggestions provided in the articles below are accurate. These links are provided solely as a jumping off point to get you started.

• MySQL 5.7 Performance Tuning After Installation
• InnoDB Performance Optimization Basics
• Optimizing InnoDB Disk I/O
• Optimizing InnoDB Configuration Variables
• 15 Useful MySQL/MariaDB Performance Tuning and Optimization Tips
• InnoDB Performance Optimisation

Install

npm install

Usage

1. Set your environment variables and start the service up

export MYSQL_HOST=localhost
export MYSQL_PORT=3306
export MYSQL_USERNAME=yourdbusername
export MYSQL_PASSWORD=yourdbpassword
export MYSQL_DATABASE=yourdbname
export NODE_HOST=localhost
export NODE_PORT=11898
npm start

Run tests

npm test

Author

👤 TurtlePay™ Development Team

• Twitter: @TurtlePay
• Github: @TurtlePay

🤝 Contributing

Contributions, issues and feature requests are welcome!

Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2018-2019 TurtlePay™ Development Team.

This project is AGPL-3.0 licensed.

---

This README was generated with ❤️ by readme-md-generator