TurtlePay™ Blockchain Cache API
Master Build Status
Prerequisites
- MariaDB/MySQL with InnoDB support
- RabbitMQ
- TurtlePay: Blockchain Data Collection Agent
- TurtlePay: Blockchain Relay Agent
- Node.js LTS
Foreword
We know that this documentation needs cleaned up and made easier to read. We'll compile it as part of the full documentation as the project moves forward.
Setup
- Clone this repository to wherever you'd like the API to run:
git clone https://github.com/TurtlePay/blockchain-cache-api
- Install the required Node.js modules
cd blockchain-cache-api && npm install
- Use your favorite text editor to change the values as necessary in
config.json
Note: Make sure you use a read-only database user for security reasons
{
"bindIp": "0.0.0.0",
"httpPort": 80,
"corsHeader": "*"
}
- Fire up the script
export RABBIT_PUBLIC_SERVER=localhost
export RABBIT_PUBLIC_USERNAME=yourrabbitmqusername
export RABBIT_PUBLIC_PASSWORD=yourrabbitmqpassword
export MYSQL_HOST=localhost
export MYSQL_PORT=3306
export MYSQL_USERNAME=yourdbusername
export MYSQL_PASSWORD=yourdbpassword
export MYSQL_DATABASE=yourdbname
node index.js
- Optionally, install PM2 or another process manager to keep the service running.
npm install -g pm2@latest
pm2 startup
pm2 start index.js --name blockchain-cache-api -i max
pm2 save
API
See https://docs.turtlepay.io/blockapi/ for the full REST API provided by this package.