BPL Explorer version 0.2.0 works in conjunction with the BPL Core API. It uses Redis for caching data and Freegeoip to parse IP geo-location data.
These programs and resources are required to install and run BPL Explorer
-
Nodejs v6.9.2 or higher (https://nodejs.org/) -- Nodejs serves as the underlying engine for code execution.
curl -sL https://deb.nodesource.com/setup_6.x | sudo -E bash - sudo apt-get install -y nodejs -
Redis (http://redis.io) -- Redis is used for caching parsed exchange data.
sudo apt-get install -y redis-server -
Freegeoip (https://github.com/fiorix/freegeoip) -- Freegeoip is used by the Network Monitor for IP address geo-location.
wget https://github.com/fiorix/freegeoip/releases/download/v3.1.5/freegeoip-3.1.5-linux-amd64.tar.gz tar -zxf freegeoip-3.1.5-linux-amd64.tar.gz ln -s freegeoip-3.1.5-linux-amd64 freegeoip nohup ./freegeoip/freegeoip > ./freegeoip/freegeoip.log 2>&1 & -
Bower (http://bower.io/) -- Bower helps to install required JavaScript dependencies.
sudo npm install -g bower -
Grunt.js (http://gruntjs.com/) -- Grunt is used to compile the frontend code and serves other functions.
sudo npm install -g grunt -
Forever (https://github.com/foreverjs/forever) -- Forever manages the node processes for BPL Explorer
sudo npm install -g forever -
Git (https://github.com/git/git) -- Used for cloning and updating BPL Explorer
sudo apt-get install -y git -
Tool chain components -- Used for compiling dependencies
sudo apt-get install -y python build-essential automake autoconf libtool
Clone the BPL Explorer Repository:
git clone https://github.com/blockpool-io/BPL-explorer.git
cd BPL-explorer
npm install
bower install
The frontend must be built with Grunt before starting BPL Explorer. Run the following command to compile the frontend components:
grunt compile
Candlestick data needs to be initialized prior to starting BPL Explorer. During runtime candlestick data is updated automatically.
To build candlestick data for each exchange run:
grunt candles:build
To update candlestick data manually run after initialization:
grunt candles:update
The default config.js file contains all of the configuration settings for BPL Explorer. These options can be modified according to comments included in configuration file.
To enable Top Accounts functionality, start your bpl node (not the explorer) using the following command:
TOP=true node app.js
To test that BPL Explorer is configured correctly, run the following command:
node app.js
Open: http://localhost:6040, or if its running on a remote system, switch localhost for the external IP Address of the machine.
Once the process is verified as running correctly, CTRL+C and start the process with forever. This will fork the process into the background and automatically recover the process if it fails.
forever start app.js
After the process is started its runtime status and log location can be found by issuing this statement:
forever list
To stop Explorer after it has been started with forever, issue the following command:
forever stop app.js
Before running any tests, please ensure BPL Explorer and BPL Client are configured to run on the BPL Testnet.
Replace config.js with config.test file from the test directory:
cp test/config.test ./config.js
Replace the config.json for the BPL Client the corresponding file under the test directory:
cp test/config_bpl.json /PATH_TO_BPL_DIR/config.json
Then restart the BPL Client (example):
bash /PATH_TO_BPL_DIR/BPL.sh reload
Launch BPL Explorer (runs on port 6040):
forever start app.js
Run the test suite:
npm test
Run individual tests:
npm test -- test/api/accounts.js
npm test -- test/api/transactions.js
- Raj Singh rsinhg@blockpool.io
- Brandon Cook bcook@blockpool.io
- Guillaume Verbal doweig@ark.io
- Mariusz Serek mariusz@serek.net
- Isabella Dell isabella@lightcurve.io
- Oliver Beddows oliver@lightcurve.io
- Boris Povod boris@crypti.me
The MIT License (MIT)
Copyright © 2017 BlockPool Copyright © 2017 Ark Copyright © 2016-2017 Lisk Foundation Copyright © 2015 Crypti
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.